@commercetools/tools-core 0.0.1

package/dist/resources/project/project.schema.d.ts

@@ -0,0 +1,454 @@
+import { z } from 'zod';
+export declare const readProjectParameters: z.ZodObject<{
+    projectKey: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    projectKey?: string;
+}, {
+    projectKey?: string;
+}>;
+export declare const updateProjectParameters: z.ZodObject<{
+    version: z.ZodNumber;
+    actions: z.ZodArray<z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
+        action: z.ZodLiteral<"changeName">;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeName";
+        name?: string;
+    }, {
+        action?: "changeName";
+        name?: string;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeCountries">;
+        countries: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeCountries";
+        countries?: string[];
+    }, {
+        action?: "changeCountries";
+        countries?: string[];
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeCurrencies">;
+        currencies: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeCurrencies";
+        currencies?: string[];
+    }, {
+        action?: "changeCurrencies";
+        currencies?: string[];
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeLanguages">;
+        languages: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeLanguages";
+        languages?: string[];
+    }, {
+        action?: "changeLanguages";
+        languages?: string[];
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeMessagesConfiguration">;
+        messagesConfiguration: z.ZodObject<{
+            enabled: z.ZodBoolean;
+            deleteDaysAfterCreation: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        }, {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeMessagesConfiguration";
+        messagesConfiguration?: {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        };
+    }, {
+        action?: "changeMessagesConfiguration";
+        messagesConfiguration?: {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeCartsConfiguration">;
+        cartsConfiguration: z.ZodObject<{
+            deleteDaysAfterLastModification: z.ZodOptional<z.ZodNumber>;
+            countryTaxRateFallbackEnabled: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        }, {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeCartsConfiguration";
+        cartsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        };
+    }, {
+        action?: "changeCartsConfiguration";
+        cartsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeCountryTaxRateFallbackEnabled">;
+        countryTaxRateFallbackEnabled: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeCountryTaxRateFallbackEnabled";
+        countryTaxRateFallbackEnabled?: boolean;
+    }, {
+        action?: "changeCountryTaxRateFallbackEnabled";
+        countryTaxRateFallbackEnabled?: boolean;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeShoppingListsConfiguration">;
+        shoppingListsConfiguration: z.ZodObject<{
+            deleteDaysAfterLastModification: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            deleteDaysAfterLastModification?: number;
+        }, {
+            deleteDaysAfterLastModification?: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeShoppingListsConfiguration";
+        shoppingListsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+        };
+    }, {
+        action?: "changeShoppingListsConfiguration";
+        shoppingListsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeMyBusinessUnitStatusOnCreation">;
+        status: z.ZodEnum<["Active", "Inactive", "Verification"]>;
+    }, "strip", z.ZodTypeAny, {
+        status?: "Active" | "Inactive" | "Verification";
+        action?: "changeMyBusinessUnitStatusOnCreation";
+    }, {
+        status?: "Active" | "Inactive" | "Verification";
+        action?: "changeMyBusinessUnitStatusOnCreation";
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"setMyBusinessUnitAssociateRoleOnCreation">;
+        associateRole: z.ZodObject<{
+            typeId: z.ZodLiteral<"associate-role">;
+            id: z.ZodOptional<z.ZodString>;
+            key: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        }, {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "setMyBusinessUnitAssociateRoleOnCreation";
+        associateRole?: {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        };
+    }, {
+        action?: "setMyBusinessUnitAssociateRoleOnCreation";
+        associateRole?: {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"setShippingRateInputType">;
+        shippingRateInputType: z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"CartValue">;
+        }, "strip", z.ZodTypeAny, {
+            type?: "CartValue";
+        }, {
+            type?: "CartValue";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"CartClassification">;
+            values: z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                label: z.ZodRecord<z.ZodString, z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                key?: string;
+                label?: Record<string, string>;
+            }, {
+                key?: string;
+                label?: Record<string, string>;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        }, {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"CartScore">;
+            score: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            type?: "CartScore";
+            score?: number;
+        }, {
+            type?: "CartScore";
+            score?: number;
+        }>]>>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "setShippingRateInputType";
+        shippingRateInputType?: {
+            type?: "CartValue";
+        } | {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        } | {
+            type?: "CartScore";
+            score?: number;
+        };
+    }, {
+        action?: "setShippingRateInputType";
+        shippingRateInputType?: {
+            type?: "CartValue";
+        } | {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        } | {
+            type?: "CartScore";
+            score?: number;
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"setExternalOAuth">;
+        externalOAuth: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            authorizationHeader: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            url?: string;
+            authorizationHeader?: string;
+        }, {
+            url?: string;
+            authorizationHeader?: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "setExternalOAuth";
+        externalOAuth?: {
+            url?: string;
+            authorizationHeader?: string;
+        };
+    }, {
+        action?: "setExternalOAuth";
+        externalOAuth?: {
+            url?: string;
+            authorizationHeader?: string;
+        };
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeProductSearchIndexingEnabled">;
+        enabled: z.ZodBoolean;
+        mode: z.ZodOptional<z.ZodEnum<["ProductProjectionsSearch", "ProductsSearch"]>>;
+    }, "strip", z.ZodTypeAny, {
+        action?: "changeProductSearchIndexingEnabled";
+        enabled?: boolean;
+        mode?: "ProductProjectionsSearch" | "ProductsSearch";
+    }, {
+        action?: "changeProductSearchIndexingEnabled";
+        enabled?: boolean;
+        mode?: "ProductProjectionsSearch" | "ProductsSearch";
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeOrderSearchStatus">;
+        status: z.ZodEnum<["Activated", "Deactivated"]>;
+    }, "strip", z.ZodTypeAny, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeOrderSearchStatus";
+    }, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeOrderSearchStatus";
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeCustomerSearchStatus">;
+        status: z.ZodEnum<["Activated", "Deactivated"]>;
+    }, "strip", z.ZodTypeAny, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeCustomerSearchStatus";
+    }, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeCustomerSearchStatus";
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"changeBusinessUnitSearchStatus">;
+        status: z.ZodEnum<["Activated", "Deactivated"]>;
+    }, "strip", z.ZodTypeAny, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeBusinessUnitSearchStatus";
+    }, {
+        status?: "Activated" | "Deactivated";
+        action?: "changeBusinessUnitSearchStatus";
+    }>]>, "many">;
+    projectKey: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    version?: number;
+    actions?: ({
+        action?: "changeName";
+        name?: string;
+    } | {
+        action?: "changeCountries";
+        countries?: string[];
+    } | {
+        action?: "changeCurrencies";
+        currencies?: string[];
+    } | {
+        action?: "changeLanguages";
+        languages?: string[];
+    } | {
+        action?: "changeMessagesConfiguration";
+        messagesConfiguration?: {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        };
+    } | {
+        action?: "changeCartsConfiguration";
+        cartsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        };
+    } | {
+        action?: "changeCountryTaxRateFallbackEnabled";
+        countryTaxRateFallbackEnabled?: boolean;
+    } | {
+        action?: "changeShoppingListsConfiguration";
+        shoppingListsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+        };
+    } | {
+        status?: "Active" | "Inactive" | "Verification";
+        action?: "changeMyBusinessUnitStatusOnCreation";
+    } | {
+        action?: "setMyBusinessUnitAssociateRoleOnCreation";
+        associateRole?: {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        };
+    } | {
+        action?: "setShippingRateInputType";
+        shippingRateInputType?: {
+            type?: "CartValue";
+        } | {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        } | {
+            type?: "CartScore";
+            score?: number;
+        };
+    } | {
+        action?: "setExternalOAuth";
+        externalOAuth?: {
+            url?: string;
+            authorizationHeader?: string;
+        };
+    } | {
+        action?: "changeProductSearchIndexingEnabled";
+        enabled?: boolean;
+        mode?: "ProductProjectionsSearch" | "ProductsSearch";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeOrderSearchStatus";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeCustomerSearchStatus";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeBusinessUnitSearchStatus";
+    })[];
+    projectKey?: string;
+}, {
+    version?: number;
+    actions?: ({
+        action?: "changeName";
+        name?: string;
+    } | {
+        action?: "changeCountries";
+        countries?: string[];
+    } | {
+        action?: "changeCurrencies";
+        currencies?: string[];
+    } | {
+        action?: "changeLanguages";
+        languages?: string[];
+    } | {
+        action?: "changeMessagesConfiguration";
+        messagesConfiguration?: {
+            enabled?: boolean;
+            deleteDaysAfterCreation?: number;
+        };
+    } | {
+        action?: "changeCartsConfiguration";
+        cartsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+            countryTaxRateFallbackEnabled?: boolean;
+        };
+    } | {
+        action?: "changeCountryTaxRateFallbackEnabled";
+        countryTaxRateFallbackEnabled?: boolean;
+    } | {
+        action?: "changeShoppingListsConfiguration";
+        shoppingListsConfiguration?: {
+            deleteDaysAfterLastModification?: number;
+        };
+    } | {
+        status?: "Active" | "Inactive" | "Verification";
+        action?: "changeMyBusinessUnitStatusOnCreation";
+    } | {
+        action?: "setMyBusinessUnitAssociateRoleOnCreation";
+        associateRole?: {
+            id?: string;
+            key?: string;
+            typeId?: "associate-role";
+        };
+    } | {
+        action?: "setShippingRateInputType";
+        shippingRateInputType?: {
+            type?: "CartValue";
+        } | {
+            type?: "CartClassification";
+            values?: {
+                key?: string;
+                label?: Record<string, string>;
+            }[];
+        } | {
+            type?: "CartScore";
+            score?: number;
+        };
+    } | {
+        action?: "setExternalOAuth";
+        externalOAuth?: {
+            url?: string;
+            authorizationHeader?: string;
+        };
+    } | {
+        action?: "changeProductSearchIndexingEnabled";
+        enabled?: boolean;
+        mode?: "ProductProjectionsSearch" | "ProductsSearch";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeOrderSearchStatus";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeCustomerSearchStatus";
+    } | {
+        status?: "Activated" | "Deactivated";
+        action?: "changeBusinessUnitSearchStatus";
+    })[];
+    projectKey?: string;
+}>;

package/dist/resources/project/test/fixtures.d.ts

@@ -0,0 +1,2 @@
+import { ApiRoot } from '@commercetools/platform-sdk';
+export declare const mockApiRoot: ApiRoot;

package/dist/resources/project/test/project.handler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/shared/client/client.base.d.ts

@@ -0,0 +1,9 @@
+import { type Configuration, type IApiClientFactory } from '../types/interface';
+import { CommercetoolsAPIClient } from './sdk.commercetools';
+/**
+ * Default implementation of API client factory
+ */
+export declare class ApiClientFactory implements IApiClientFactory<Configuration> {
+    createApiClient(configuration: Configuration, authToken: string): import("@commercetools/platform-sdk").ApiRoot;
+    getApiRoot(configuration: Configuration, authToken: string): CommercetoolsAPIClient;
+}

package/dist/shared/client/sdk.commercetools.d.ts

@@ -0,0 +1,31 @@
+import { type Client } from '@commercetools/ts-client';
+import { type ApiRoot } from '@commercetools/platform-sdk';
+import { type Configuration } from '../types/interface';
+import { type ApiRootFn } from '../types/types';
+/**
+ * Commercetools API Client
+ * Creates and manages commercetools SDK client instances
+ */
+export declare class CommercetoolsAPIClient {
+    private client;
+    private apiRoot;
+    private configuration;
+    private authToken?;
+    constructor(configuration: Configuration, authToken?: string);
+    /**
+     * Get the API root instance
+     */
+    getApiRoot(fn?: ApiRootFn, baseUri?: string): ApiRoot;
+    /**
+     * Get the client instance
+     */
+    getClient(): Client;
+    /**
+     * Construct an apiRoot
+     */
+    contructApiRoot(client: Client, fn: (client: Client, baseUri?: string) => ApiRoot, baseUri?: string): ApiRoot;
+    /**
+     * Create commercetools client
+     */
+    private createClient;
+}

package/dist/shared/errors/tool.error.d.ts

@@ -0,0 +1,34 @@
+import { type Configuration, type ToolExecutionContext } from '../types/interface';
+/**
+ * Structured error for tool execution failures
+ * Provides context and debugging information
+ */
+export declare class ToolExecutionError extends Error {
+    readonly toolName: string;
+    readonly operation: string;
+    readonly projectKey: string;
+    readonly sessionId?: string;
+    readonly parameters: Record<string, unknown>;
+    readonly originalError: unknown;
+    readonly timestamp: Date;
+    constructor(message: string, context: ToolExecutionContext<Configuration>, originalError?: unknown);
+    /**
+     * Extract operation from tool name
+     */
+    private extractOperation;
+    /**
+     * Get error details for logging/debugging
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        toolName: string;
+        operation: string;
+        projectKey: string;
+        sessionId: string;
+        parameters: Record<string, unknown>;
+        timestamp: string;
+        originalError: unknown;
+        stack: string;
+    };
+}

package/dist/shared/index.d.ts

@@ -0,0 +1,5 @@
+export * from './types/interface';
+export * from './types/types';
+export * from './errors/tool.error';
+export * from './client/client.base';
+export * from './client/sdk.commercetools';

package/dist/shared/types/interface.d.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+import { ApiRoot } from '@commercetools/platform-sdk';
+export interface ResourceSchema {
+    read: z.ZodObject<Record<string, z.ZodTypeAny>>;
+    create: z.ZodObject<Record<string, z.ZodTypeAny>>;
+    update: z.ZodObject<Record<string, z.ZodTypeAny>>;
+    delete: z.ZodObject<Record<string, z.ZodTypeAny>>;
+}
+export interface ResourceMetadata {
+    namespace: string;
+    description: string;
+    toolNamePrefix?: string;
+    schemas: ResourceSchema;
+}
+export interface ToolExecutionContext<TConfig = unknown> {
+    authToken: string;
+    configuration: TConfig;
+    toolName: string;
+    parameters: Record<string, unknown>;
+    sessionId?: string;
+}
+export interface ToolHandler<TConfig> {
+    execute(context: ToolExecutionContext<TConfig>): Promise<unknown>;
+}
+/**
+ * Factory interface for creating API clients
+ * Allows dependency injection and testing
+ */
+export interface IApiClientFactory<TConfig = unknown> {
+    createApiClient(configuration: TConfig, authToken: string): ApiRoot;
+}
+export interface Configuration {
+    projectKey: string;
+    allowedTools: string[];
+    metadata?: {
+        toolDescriptions?: Record<string, string>;
+        responseTransformations?: Record<string, unknown>;
+        rateLimits?: {
+            requestsPerMinute?: number;
+        };
+        customFields?: Record<string, unknown>;
+        apiUrl?: string;
+        authUrl?: string;
+        clientId?: string;
+        clientSecret?: string;
+    };
+}
+/**
+ * Constructor type
+ * Note: BaseResourceHandler is defined in @core package to avoid circular dependencies
+ */
+export interface IConstructor<T = unknown> {
+    new (...args: IApiClientFactory<Configuration>[]): T;
+}
+export interface IErrorConstructor extends ErrorConstructor {
+    captureStackTrace: (...args: unknown[]) => void;
+}

package/dist/shared/types/types.d.ts

@@ -0,0 +1,4 @@
+import { type Client } from '@commercetools/ts-client';
+import { type ApiRoot } from '@commercetools/platform-sdk';
+export type ToolOperation = 'read' | 'create' | 'update' | 'delete';
+export type ApiRootFn = (client: Client, baseUri?: string) => ApiRoot;

package/dist/utils/constants.d.ts

@@ -0,0 +1 @@
+export declare const OPERATIONS: string[];

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@commercetools/tools-core",
+  "description": "commercetools tool system core",
+  "version": "0.0.1",
+  "license": "UNLICENSED",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "packageManager": "yarn@4.9.2",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@commercetools/platform-sdk": "^8.23.0",
+    "@commercetools/ts-client": "^4.8.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "esbuild": "^0.27.2",
+    "typescript": "^4.6.2"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn clean;tsc && node esbuild.cjs",
+    "typecheck": "tsc --noEmit",
+    "test": "jest --config jest.config.cjs --runInBand"
+  }
+}