ekkolon/gelato-admin-node

Node.js API for Gelato's print-on-demand services.

gelato-admin-node's Issues

Improve README

Some paragraphs in the README file are either redundant or need semantic improvements.

[Bug] e2e test fail at `ordersAPI#getOrders`

Which gelato/* package(s) are the source of the bug?

orders

Is this a regression?

No

Description

All E2E test pass, except ordersAPI#getOrders.

Please provide a link to a minimal reproduction of the bug

No response

Please provide the exception or error you saw

`AxiosError: Request failed with status code 405`

Please provide the environment you discovered this bug in

Node: 18.16.1
Package Manager: yarn 1.22.19
OS: Debian (WSL)

Gelato SDK: 1.1.5

Anything else?

• In earlier versions test DID pass.
• A 405 http error code suggest, we are using an disallowed HTTP method.

Add Webhooks event handlers

Which Gelato package(s) are relevant/related to the feature request?

No response

Description

It would be great to provide a way to intercept the request/response cycle of http servers (express + fastify). The interceptor should provide a callable function signature users can import from the library.

Proposed solution

TBA

Alternatives considered

N/A

Add v3 legacy support

Which Gelato package(s) are relevant/related to the feature request?

orders

Description

The current release only targets the latest API version of Gelato's orders API (v4).
We can confidently assume that there are still many systems relying on the v3 legacy version.

There are two main reasons for providing legacy support:

1. Maintain compatibility: There may be existing applications that rely on the v3 functionality.
   In many cases it would be undesirable to force consumers of this library to migrate to v4.
2. Expand user base: By adding legacy support, we appeal to a broader range of users.

Proposed solution

Due to Gelato's API design, it makes sense to keep this libraries namespaces in sync with it.
For example, we can use gelato-admin/v3/orders as the go to namespace for the orders API.

In any case, besides some changes in the return types for endpoints targeting the orders API,
we must provide two additional endpoints:

1. Get shipping address
2. Update shipping address

This feature must not introduce any breaking changes, since it should use the same design patterns and parent container (GelatoClient) as the latest orders API version.

Alternatives considered

N/A

Unable to eslint workspace

Which gelato/* package(s) are the source of the bug?

orders, products, shipment

Is this a regression?

No

Description

yarn lint or yarn lint:fix fail to execute on Windows machines.

Please provide a link to a minimal reproduction of the bug

No response

Please provide the exception or error you saw

No files matching the pattern "'**/*.ts'" were found.
Please check for typing mistakes in the pattern.

Please provide the environment you discovered this bug in

Node: v18.16.1
Package Manager: yarn 1.22.19
OS: windows 11

Gelato SDK: 1.1.0
-------------------------------------------------------------
ESLint: 8.48.0

Anything else?

The issue comes from the following lines in the package.json file:

https://github.com/ekkolon/gelato-admin-node/blob/105008b114a98063bc10db45bad19904bae4b6c6/package.json#L14C1-L15C42

I suspect the error is caused by using single quotes instead of escaped double quotes.

---

The following changes should fix this issue:

BEFORE:

"lint": "eslint '**/*.ts'",
"lint:fix": "eslint --fix '**/*.ts'",

AFTER:

"lint": "eslint \"**/*.ts\""
"lint:fix": "eslint --fix \"**/*.ts\""

[Feature Request] Add support for new `Ecommerce` API feature

Which Gelato package(s) are relevant/related to the feature request?

No response

Description

Gelato added a new Ecommerce API feature that is currently missing in this repo.

Proposed solution

Add support for Ecommerce feature.

Alternatives considered

N/A