feat(js-api-client): bring more subscription contracts stuff

Author: Plopix

README.md

@@ -10,8 +10,10 @@ So far, the available helpers are:
 -   Mass Call Client that relies on the Client for mass operations
 -   Catalogue Fetcher
 -   Searcher
--   Order Payment Updater
--   Order Pusher
+-   Order
+    -   Payment Updater
+    -   Pusher
+    -   Pipeline Stage Setter
 -   Product Hydrater
     -   Paths
     -   Skus
@@ -399,6 +401,15 @@ const result = await caller('xXxYyYZzZ', {
 });
 ```
 
+## Order Pipeline Stage Setter
+
+You can use the *CrystallizeCreateOrderPipelineStageSetter* to put an order into a specific pipeline stage.
+
+```javascript
+const caller = CrystallizeCreateOrderPipelineStageSetter;
+const result = await caller(orderId, pipelineId, stageId);
+```
+
 ## Searcher
 
 You can use the *CrystallizeSearcher* to search through the Search API in a more sophisticated way.
@@ -525,6 +536,13 @@ An Update method exists as well:
 await CrystallizeSubscriptionContractManager.update(contractId, cleanUpdateContract);
 ```
 
+There is also 3 other helpers that you will most likely use and that work the same as Order Fetcher:
+
+-   `CrystallizeSubscriptionContractManager.fetchById`,
+-   `CrystallizeSubscriptionContractManager.fetchByCustomerIdentifier`,
+-   `CrystallizeSubscriptionContractManager.getCurrentPhase`,
+-   `CrystallizeSubscriptionContractManager.getUsageForPeriod`
+
 ## Signature Verification
 
 The full documentation is here https://crystallize.com/learn/developer-guides/api-overview/signature-verification

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@crystallize/js-api-client",
     "license": "MIT",
-    "version": "3.3.0",
+    "version": "4.0.0",
     "type": "module",
     "author": "Crystallize <[email protected]> (https://crystallize.com)",
     "contributors": [
@@ -29,17 +29,17 @@
     "module": "./dist/index.mjs",
     "devDependencies": {
         "@tsconfig/node20": "^20.1.4",
-        "@types/node": "^20.17.6",
+        "@types/node": "^22.10.5",
         "tsup": "^8.3.5",
-        "typescript": "^5.6.3",
-        "vitest": "^1.6.0"
+        "typescript": "^5.7.2",
+        "vitest": "^2.1.8"
     },
     "dependencies": {
-        "dotenv": "^16.4.5",
+        "dotenv": "^16.4.7",
         "json-to-graphql-query": "^2.3.0",
         "mime-lite": "^1.0.3",
         "tiny-invariant": "^1.3.3",
-        "zod": "^3.23.8"
+        "zod": "^3.24.1"
     },
     "browser": {
         "fs": false,

src/core/client.ts

@@ -53,6 +53,7 @@ export type ApiCaller<T> = (query: string, variables?: VariablesType) => Promise
 
 export type ClientInterface = {
     catalogueApi: ApiCaller<any>;
+    discoveryApi: ApiCaller<any>;
     searchApi: ApiCaller<any>;
     orderApi: ApiCaller<any>;
     subscriptionApi: ApiCaller<any>;
@@ -360,6 +361,12 @@ export function createClient(configuration: ClientConfiguration, options?: Creat
         accessTokenSecret: configuration.accessTokenSecret,
     };
 
+    // nothing expect static auth token
+    const discoveryConfig: ClientConfiguration = {
+        ...commonConfig,
+        staticAuthToken: configuration.staticAuthToken,
+    };
+
     // sessionId and static auth token are excluded
     const tokenOnlyConfig: ClientConfiguration = {
         ...commonConfig,
@@ -369,6 +376,12 @@ export function createClient(configuration: ClientConfiguration, options?: Creat
 
     return {
         catalogueApi: createApiCaller(grab, apiHost(configuration)([identifier, 'catalogue']), catalogConfig, options),
+        discoveryApi: createApiCaller(
+            grab,
+            apiHost(configuration)([identifier, 'discovery']),
+            discoveryConfig,
+            options,
+        ),
         searchApi: createApiCaller(grab, apiHost(configuration)([identifier, 'search']), catalogConfig, options),
         orderApi: createApiCaller(grab, apiHost(configuration)([identifier, 'orders']), tokenOnlyConfig, options),
         subscriptionApi: createApiCaller(

src/core/massCallClient.ts

@@ -27,6 +27,7 @@ export type MassClientInterface = ClientInterface & {
     nextPimApi: ApiCaller<any>;
     enqueue: {
         catalogueApi: QueuedApiCaller;
+        discoveryApi: QueuedApiCaller;
         searchApi: QueuedApiCaller;
         orderApi: QueuedApiCaller;
         subscriptionApi: QueuedApiCaller;
@@ -187,6 +188,7 @@ export function createMassCallClient(
             return await execute();
         },
         catalogueApi: client.catalogueApi,
+        discoveryApi: client.discoveryApi,
         searchApi: client.searchApi,
         orderApi: client.orderApi,
         subscriptionApi: client.subscriptionApi,
@@ -201,6 +203,11 @@ export function createMassCallClient(
                 promises.push({ key, caller: client.catalogueApi, query, variables });
                 return key;
             },
+            discoveryApi: (query: string, variables?: VariablesType): string => {
+                const key = `discoveryApi-${counter++}`;
+                promises.push({ key, caller: client.discoveryApi, query, variables });
+                return key;
+            },
             searchApi: (query: string, variables?: VariablesType): string => {
                 const key = `searchApi-${counter++}`;
                 promises.push({ key, caller: client.searchApi, query, variables });

src/core/order.ts

@@ -180,6 +180,23 @@ function convertDates(intent: CreateOrderInputRequest | UpdateOrderInputRequest)
         }),
     };
 }
+export function createOrderPipelineStageSetter(apiClient: ClientInterface) {
+    return async function putInPipelineStage(id: string, pipelineId: string, stageId: string) {
+        const mutation = {
+            order: {
+                setPipelineStage: {
+                    __args: {
+                        orderId: id,
+                        pipelineId: pipelineId,
+                        stageId: stageId,
+                    },
+                    id: true,
+                },
+            },
+        };
+        await apiClient.pimApi(jsonToGraphQLQuery({ mutation }));
+    };
+}
 
 export function createOrderPusher(apiClient: ClientInterface) {
     return async function pushOrder(intentOrder: CreateOrderInputRequest): Promise<OrderCreatedConfirmation> {