merchisdk / sdk

libraries in different languages for talking to api.merchi.co

merchisdk

libraries in different languages for talking to api.merchi.co

Documentation can be found here.

Merchi SDK JS has been moved here. Merchi SDK TS has been moved here.

sdk's Issues

maybe should declare strict types in all PHP files

need documentation

add python unittests

dynamic import seems still have problems with backref.

backrefed models sometimes can not find backref attributes which points to the original attributes.

bank.php should be spelt banks.php

Sweep: refactor getQueryStringValue so it would not crash in nodejs runtime

in sdk/javascript/merchi.js (788:41) there is a function getQueryStringValue, call this function in nodejs runtime will cause error "TypeError: Cannot read properties of undefined (reading 'search')", refactor this function so it can be run in the node js runtime with no error return "undefined"

Checklist

• sdk/javascript/merchi.js ✅ Commit b8e2293

• Add a check at the start of the `getQueryStringValue` function to see if the `window` object is defined. You can do this with an `if` statement like so: `if (typeof window === 'undefined')`. • If the `window` object is not defined, return `undefined` immediately. This will prevent the rest of the function from executing and trying to access `window.location.search`.

misconfigured eslint in travis ci

currently:
./node_modules/eslint/bin/eslint.js 'src/**.ts'

suppose to be:
./node_modules/eslint/bin/eslint.js 'src/*/**.ts'

notice this when I was working on #252

import the javascript parts

Sweep: change colour internal tags from number to string

the colour attribute of internal tags in python, typescript and javasript sdk are miss assigned to integer, change them into string

Checklist

• Modify python/internal_tags.py ✓ 149c1d1
• Modify javascript/internal_tag.js ! No changes made
• Modify typescript/src/entities/internal_tag.ts ✓ 9745494

Sweep: add new domain type "RESERVED" equals to 9 to domain types constant

domain types constant defined in
sdk/python/util
sdk/javascript/
sdk/typescript/src/contants

add a new RESERVED type equals to number 9

automatic json name

related to #238, user do not need to manually type json name

Sweep: write JS sdk documentation Job entity

Please write SDK documentation for the invoice, job, user entities inside the javascript sdk; please explain the get, create, save and delete methods.

Checklist

• javascript/invoice.js ✅ Commit be2957f

• At the top of the file, add a comment explaining the purpose of the invoice entity. • Before the get method, add a comment explaining what the method does, the parameters it accepts, and the value it returns. • Repeat the above step for the create, save, and delete methods. • Consider providing examples of how to use the methods.

• javascript/job.js ❌ Failed

• At the top of the file, add a comment explaining the purpose of the job entity. • Before the get method, add a comment explaining what the method does, the parameters it accepts, and the value it returns. • Repeat the above step for the create, save, and delete methods. • Consider providing examples of how to use the methods.

• javascript/user.js ❌ Failed

• At the top of the file, add a comment explaining the purpose of the user entity. • Before the get method, add a comment explaining what the method does, the parameters it accepts, and the value it returns. • Repeat the above step for the create, save, and delete methods. • Consider providing examples of how to use the methods.

fileIndex is not correct if relationship is an array

add more description later

typescript SDK patch entity with multiple files fileIndex remains 0

tested this out on job.clientFiles:
create 2 new Merchi files and add them to the job.clientFiles.
Do job.save; the first file will be created and linked with the job twice.
This is because the fileIndex in ./typescript/src/entity.ts on line 598 isn't being incremented.

syntax checks runs too slow.

I need the syntax check be as fast as possible currently took more than 5 min to run syntax check on my computer. needs to be less than at maximum 30 seconds

design:type will be misleading is null is a optional type

#274

is the pr that will demonstrate the problem.

the cause of this problem is due to

suggest to put type defination as property params like arrayType.

I can do this but looking @DanielCollins's opionion properly he would have better idea.

withRights might not be defaulting corretly to false

reported by @Amtron

python: investigate moving assignments model to its own file.

inconsistent json name

ProductComment.json_name = "production_comment"
ComponentTag.json_name = "ComponentTag"

ProductComments.json_name = "productionComments"
PhoneNumbers.json_name = "phone_numbers"

I start to suspect if python sdk is working at all.

typescript sdk will not serialise count 0 if user clear the entities in array.

some of the PHP codesniffer warnings are ignored are useful

ignored a bunch of them all at once for expediency when importing this stuff, but we probably do want some of the ignored ones.

reduce the code for "not embed check"

I see something like

if (this.featureImage === undefined) {
throw new Error("featureImage is undefined, did you forget to embed it?");
}
if (this.images === undefined) {
throw new Error("images is undefined, did you forget to embed it?");
}

Hope we can reduce some code for this.

Sweep: refactor getQueryStringValue so it would not crash in nodejs runtime

in javascript/merchi.js (788:41) there is a function getQueryStringValue, call this function in nodejs runtime will cause error "TypeError: Cannot read properties of undefined (reading 'search')", refactor this function so it can be run in the node js runtime with no error return "undefined"

notice some 'unused import' in some files

eg
in sdk/python/draft_comments.py
I saw "import sdk.python.users", I did not see any real usage of this import.
Is there any purpose on that or it is just a purely mistake.

Sweep: unify json_name to camel case for python entities

in sdk/python in some of entities the json_name is lower case like "lower_case" but we want them all camel case like "camelCase"
eg. in sdk/python/payment_devices.py the json_name of PaymentDevice entity is 'paymentDevice' which is correct, however, in sdk/python/email_addresses.py the json name of EmailAddress is lower name.

Now I want you to read all the files in sdk/python if you find json_name of a entity is given as lower case, convert it to camel case.

Checklist

• python/email_addresses.py ✅ Commit 810a5a2

• Change the `json_name` attribute of the `EmailAddress` class to 'emailAddress'.

• python/payment_devices.py ❌ Failed

• No changes needed as the `json_name` attribute of the `PaymentDevice` class is already in camel case.

• python/payments.py ❌ Failed

• Change the `json_name` attribute of the `Payment` class to 'payment'.

• python/addresses.py ❌ Failed

• Change the `json_name` attribute of the `Address` class to 'address'.

• python/util/name_protocol.py ❌ Failed

• No changes needed as this file contains utility functions and does not define any entities.

replace ignored types with real type annotations

letsencrypt breaks limit rate

similar errors happens both on staging and production

acme.messages.Error: urn:ietf:params:acme:error:rateLimited :: There were too many requests of a given type :: Error creating new order :: too many certificates already issued for exact set of domains: *.staging.merchi.co,staging.merchi.co: see https://letsencrypt.org/docs/rate-limits/

enable pylint

disinfect python of references to frontend/ and backend/ packages

dynamic import should raise a error, if relation does not exisits

TS SDK delete method breaks job.

If you try to delete a job it breaks because there is no response to serialise.

In the case of the job, it would help if the job was returned in the response.

bump up eslint version

I notice a issue, where my editor always tried to convert '' to "", which does not follow the eslint rules.

after debug it a little bit I notice it is because global eslint failed as "ESLint configuration of global 'global' in .eslintrc.js is invalid" due to we are using an outdated eslint while my editor are running. a more update eslint.

So for only the 'prettier' was used.

this bug does not influence #252 as it is done by run eslint in node modules