@commercetools/tools-core 0.0.1 → 0.0.4

package/package.json

@@ -1,32 +1,37 @@
 {
   "name": "@commercetools/tools-core",
   "description": "commercetools tool system core",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
-  "packageManager": "yarn@4.9.2",
+  "packageManager": "yarn@4.9.1",
   "engines": {
     "node": ">=18"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "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"
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs.js"
+    }
   },
-  "files": [
-    "dist",
-    "README.md"
-  ],
   "scripts": {
     "clean": "rm -rf dist",
-    "build": "yarn clean;tsc && node esbuild.cjs",
+    "build": "yarn clean;tsup",
     "typecheck": "tsc --noEmit",
     "test": "jest --config jest.config.cjs --runInBand"
   }

package/dist/decorators/test/tool.decorator.test.d.ts

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

package/dist/decorators/tool.decorator.d.ts

@@ -1,26 +0,0 @@
-import { type IConstructor, type Configuration } from '../shared';
-import { type BaseResourceHandler } from '../handlers/base.handler';
-/**
- * Decorator to automatically register a tool handler
- *
- * Usage:
- * ```typescript
- * @ToolHandler()
- * export class CustomerHandler extends BaseResourceHandler {
- *   // ...
- * }
- * ```
- *
- * The handler will be automatically discovered and registered
- * when the module is loaded.
- */
-export declare function ToolHandler(): <T extends IConstructor<BaseResourceHandler<Configuration>>>(constructor: T) => T;
-/**
- * Get all handlers registered via decorator
- * This is called by ToolDiscovery to register all decorated handlers
- */
-export declare function getDecoratorRegisteredHandlers(): BaseResourceHandler<Configuration>[];
-/**
- * Clear the decorator registry (mainly for testing)
- */
-export declare function clearDecoratorRegistry(): void;

package/dist/handlers/base.handler.d.ts

@@ -1,34 +0,0 @@
-import { ToolExecutionContext, ResourceMetadata, ToolHandler, ToolOperation } from '../shared';
-/**
- * Generic base handler - NO API client logic
- * Only handles tool routing, validation, and naming
- */
-export declare abstract class BaseResourceHandler<TConfig = unknown> implements ToolHandler<TConfig> {
-    protected abstract readonly metadata: ResourceMetadata;
-    abstract read(context: ToolExecutionContext<TConfig>): Promise<unknown>;
-    abstract create(context: ToolExecutionContext<TConfig>): Promise<unknown>;
-    abstract update(context: ToolExecutionContext<TConfig>): Promise<unknown>;
-    abstract delete(context: ToolExecutionContext<TConfig>): Promise<unknown>;
-    protected getToolName(operation: ToolOperation): string;
-    protected getOperation(toolName: string): ToolOperation | null;
-    execute(context: ToolExecutionContext<TConfig>): Promise<unknown>;
-    getAllToolNames(): string[];
-    getToolDefinition(operation: ToolOperation): {
-        name: string;
-        description: string;
-        inputSchema: import("zod").ZodObject<Record<string, import("zod").ZodTypeAny>, import("zod").UnknownKeysParam, import("zod").ZodTypeAny, {
-            [x: string]: any;
-        }, {
-            [x: string]: any;
-        }>;
-    };
-    getAllToolDefinitions(): {
-        name: string;
-        description: string;
-        inputSchema: import("zod").ZodObject<Record<string, import("zod").ZodTypeAny>, import("zod").UnknownKeysParam, import("zod").ZodTypeAny, {
-            [x: string]: any;
-        }, {
-            [x: string]: any;
-        }>;
-    }[];
-}

package/dist/handlers/commercetools.handler.d.ts

@@ -1,16 +0,0 @@
-import { ApiRoot } from '@commercetools/platform-sdk';
-import { type Configuration, type IApiClientFactory, type ToolExecutionContext } from '../shared';
-import { BaseResourceHandler } from './base.handler';
-/**
- * Commercetools-specific resource handler
- * Extends BaseResourceHandler with commercetools API client functionality
- * This is an abstract class - subclasses must implement the CRUD methods
- */
-export declare abstract class CommercetoolsResourceHandler extends BaseResourceHandler<Configuration> {
-    protected apiClientFactory: IApiClientFactory<Configuration>;
-    constructor(apiClientFactory?: IApiClientFactory<Configuration>);
-    /**
-     * Get the API root instance for commercetools
-     */
-    protected getApiRoot(context: ToolExecutionContext<Configuration>): ApiRoot;
-}

package/dist/handlers/test/base.handler.test.d.ts

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

package/dist/handlers/test/commercetools.handler.test.d.ts

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

package/dist/handlers/test/fixtures.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="jest" />
-import { ApiRoot } from '@commercetools/platform-sdk';
-import { ResourceMetadata, ToolExecutionContext } from '../../shared';
-import { type Configuration, type IApiClientFactory } from '../../shared';
-import { CommercetoolsResourceHandler } from '../../handlers/commercetools.handler';
-import { BaseResourceHandler } from '../..';
-export declare class TestHandler extends BaseResourceHandler {
-    protected readonly metadata: ResourceMetadata;
-    read(_context: ToolExecutionContext): Promise<unknown>;
-    create(_context: ToolExecutionContext): Promise<unknown>;
-    update(_context: ToolExecutionContext): Promise<unknown>;
-    delete(_context: ToolExecutionContext): Promise<unknown>;
-}
-export declare const mockApiRoot: ApiRoot;
-export declare class MockApiClientFactory implements IApiClientFactory<Configuration> {
-    createApiClient: jest.Mock<ApiRoot, [_config: Configuration, _token: string], any>;
-}
-export declare class TestCommercetoolsHandler extends CommercetoolsResourceHandler {
-    protected readonly metadata: ResourceMetadata;
-    read(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    create(_context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    update(_context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    delete(_context: ToolExecutionContext<Configuration>): Promise<unknown>;
-}

package/dist/resources/customer/customer.handler.d.ts

@@ -1,22 +0,0 @@
-import { z } from 'zod';
-import { type Customer, type CustomerPagedQueryResponse, type ByProjectKeyRequestBuilder } from '@commercetools/platform-sdk';
-import { IApiClientFactory, type ResourceMetadata, type ToolExecutionContext, type Configuration } from '../../shared';
-import { CommercetoolsResourceHandler } from '../../handlers/commercetools.handler';
-export declare class CustomerHandler extends CommercetoolsResourceHandler {
-    protected readonly metadata: ResourceMetadata;
-    constructor(apiClientFactory?: IApiClientFactory<Configuration>);
-    getToolDefinition(operation: 'read' | 'create' | 'update' | 'delete'): {
-        name: string;
-        description: string;
-        inputSchema: z.ZodObject<Record<string, z.ZodTypeAny>, z.UnknownKeysParam, z.ZodTypeAny, {
-            [x: string]: any;
-        }, {
-            [x: string]: any;
-        }>;
-    };
-    protected getCustomersApi(api: ByProjectKeyRequestBuilder, storeKey?: string): import("@commercetools/platform-sdk").ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder | import("@commercetools/platform-sdk").ByProjectKeyCustomersRequestBuilder;
-    read(context: ToolExecutionContext<Configuration>): Promise<Customer | CustomerPagedQueryResponse>;
-    create(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    update(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    delete(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-}

package/dist/resources/customer/customer.prompt.d.ts

@@ -1,4 +0,0 @@
-export declare const readCustomerPrompt = "\nThis tool will fetch a Customer by ID (ID or key if provided) from commercetools or a specific store in commercetools or query all available customers in a commercetools project if no arquments or parameters are provided.\n\nIt takes these optional arguments:\n- id (string, optional): The ID of the customer to fetch.\n- storeKey (string, optional): The key of the store to fetch the customer from.\n- where (array of strings, optional): Query predicates specified as strings. Example: [\"email = \\\"customer@example.com\\\"\"]\n- sort (array of strings, optional): Sort criteria for the results. Example: [\"firstName asc\", \"createdAt desc\"]\n- limit (integer, optional): A limit on the number of objects to be returned. Limit can range between 1 and 500, and the default is 10.\n- offset (integer, optional): The number of items to skip before starting to collect the result set.\n- expand (array of strings, optional): Fields to expand. Example: [\"customerGroup\"]\n";
-export declare const createCustomerPrompt = "\nThis tool will create a new Customer in commercetools or a specific store in commercetools.\n\nIt takes these required arguments:\n- email (string): Customer email address.\n- password (string): Customer password.\n\nIt takes these optional arguments:\n- storeKey (string, optional): The key of the store to create the customer in.\n- firstName (string, optional): Customer first name.\n- lastName (string, optional): Customer last name.\n- middleName (string, optional): Customer middle name.\n- title (string, optional): Customer title (e.g., Mr., Mrs., Dr.).\n- dateOfBirth (string, optional): Customer date of birth in ISO 8601 format (YYYY-MM-DD).\n- companyName (string, optional): Customer company name.\n- vatId (string, optional): Customer VAT identification number.\n- addresses (array, optional): An array of customer addresses.\n- defaultShippingAddress (integer, optional): Index of default shipping address in the addresses array.\n- defaultBillingAddress (integer, optional): Index of default billing address in the addresses array.\n- shippingAddresses (array of integers, optional): Indices of shipping addresses in the addresses array.\n- billingAddresses (array of integers, optional): Indices of billing addresses in the addresses array.\n- isEmailVerified (boolean, optional): Whether the customer email is verified.\n- externalId (string, optional): Customer external ID.\n- customerGroup (object, optional): Customer group reference.\n- custom (object, optional): Custom fields.\n- locale (string, optional): Customer locale.\n- salutation (string, optional): Customer salutation.\n- key (string, optional): Customer key.\n";
-export declare const updateCustomerPrompt = "\nThis tool will update a Customer in commercetools using update actions from the commercetools API.\n\nIt takes these required arguments:\n- id (string): The ID of the customer to update.\n- version (integer): The current version of the customer.\n- actions (array): An array of update actions to perform on the customer. Each action should have an \"action\" field indicating the action type.\n\nExample actions from commercetools API include:\n- addAddress\n- addBillingAddressId\n- addShippingAddressId\n- changeAddress\n- changeEmail\n- removeAddress\n- removeBillingAddressId\n- removeShippingAddressId\n- setCompanyName\n- setCustomField\n- setCustomType\n- setDateOfBirth\n- setDefaultBillingAddress\n- setDefaultShippingAddress\n- setFirstName\n- setLastName\n- setLocale\n- setMiddleName\n- setSalutation\n- setTitle\n- setVatId\n\nEach action type requires specific fields according to the commercetools API.\n";
-export declare const deleteCustomerPrompt = "\nThis tool will delete a Customer from commercetools.\n\nIt takes these required arguments:\n- id (string): The ID of the customer to delete.\n- version (integer): The current version of the customer (for optimistic locking).\n\nIt takes these optional arguments:\n- dataErasure (boolean, optional): Delete personal data.\n";

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

@@ -1,281 +0,0 @@
-import { z } from 'zod';
-export declare const readCustomerParameters: z.ZodObject<{
-    id: z.ZodOptional<z.ZodString>;
-    key: z.ZodOptional<z.ZodString>;
-    storeKey: z.ZodOptional<z.ZodString>;
-    where: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    sort: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    limit: z.ZodOptional<z.ZodNumber>;
-    offset: z.ZodOptional<z.ZodNumber>;
-    expand: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodTypeAny, {
-    sort?: string[];
-    id?: string;
-    key?: string;
-    storeKey?: string;
-    where?: string[];
-    limit?: number;
-    offset?: number;
-    expand?: string[];
-}, {
-    sort?: string[];
-    id?: string;
-    key?: string;
-    storeKey?: string;
-    where?: string[];
-    limit?: number;
-    offset?: number;
-    expand?: string[];
-}>;
-export declare const createCustomerParameters: z.ZodObject<{
-    email: z.ZodString;
-    storeKey: z.ZodOptional<z.ZodString>;
-    password: z.ZodString;
-    firstName: z.ZodOptional<z.ZodString>;
-    lastName: z.ZodOptional<z.ZodString>;
-    middleName: z.ZodOptional<z.ZodString>;
-    title: z.ZodOptional<z.ZodString>;
-    dateOfBirth: z.ZodOptional<z.ZodString>;
-    companyName: z.ZodOptional<z.ZodString>;
-    vatId: z.ZodOptional<z.ZodString>;
-    addresses: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        streetName: z.ZodString;
-        streetNumber: z.ZodOptional<z.ZodString>;
-        additionalStreetInfo: z.ZodOptional<z.ZodString>;
-        postalCode: z.ZodString;
-        city: z.ZodString;
-        region: z.ZodOptional<z.ZodString>;
-        state: z.ZodOptional<z.ZodString>;
-        country: z.ZodString;
-        company: z.ZodOptional<z.ZodString>;
-        department: z.ZodOptional<z.ZodString>;
-        building: z.ZodOptional<z.ZodString>;
-        apartment: z.ZodOptional<z.ZodString>;
-        pOBox: z.ZodOptional<z.ZodString>;
-        phone: z.ZodOptional<z.ZodString>;
-        mobile: z.ZodOptional<z.ZodString>;
-        email: z.ZodOptional<z.ZodString>;
-        fax: z.ZodOptional<z.ZodString>;
-        additionalAddressInfo: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        email?: string;
-        streetName?: string;
-        streetNumber?: string;
-        additionalStreetInfo?: string;
-        postalCode?: string;
-        city?: string;
-        region?: string;
-        state?: string;
-        country?: string;
-        company?: string;
-        department?: string;
-        building?: string;
-        apartment?: string;
-        pOBox?: string;
-        phone?: string;
-        mobile?: string;
-        fax?: string;
-        additionalAddressInfo?: string;
-    }, {
-        email?: string;
-        streetName?: string;
-        streetNumber?: string;
-        additionalStreetInfo?: string;
-        postalCode?: string;
-        city?: string;
-        region?: string;
-        state?: string;
-        country?: string;
-        company?: string;
-        department?: string;
-        building?: string;
-        apartment?: string;
-        pOBox?: string;
-        phone?: string;
-        mobile?: string;
-        fax?: string;
-        additionalAddressInfo?: string;
-    }>, "many">>;
-    defaultShippingAddress: z.ZodOptional<z.ZodNumber>;
-    defaultBillingAddress: z.ZodOptional<z.ZodNumber>;
-    shippingAddresses: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
-    billingAddresses: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
-    isEmailVerified: z.ZodOptional<z.ZodBoolean>;
-    externalId: z.ZodOptional<z.ZodString>;
-    customerGroup: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        typeId: z.ZodLiteral<"customer-group">;
-    }, "strip", z.ZodTypeAny, {
-        id?: string;
-        typeId?: "customer-group";
-    }, {
-        id?: string;
-        typeId?: "customer-group";
-    }>>;
-    custom: z.ZodOptional<z.ZodObject<{
-        type: z.ZodObject<{
-            id: z.ZodString;
-            typeId: z.ZodLiteral<"type">;
-        }, "strip", z.ZodTypeAny, {
-            id?: string;
-            typeId?: "type";
-        }, {
-            id?: string;
-            typeId?: "type";
-        }>;
-        fields: z.ZodRecord<z.ZodString, z.ZodAny>;
-    }, "strip", z.ZodTypeAny, {
-        type?: {
-            id?: string;
-            typeId?: "type";
-        };
-        fields?: Record<string, any>;
-    }, {
-        type?: {
-            id?: string;
-            typeId?: "type";
-        };
-        fields?: Record<string, any>;
-    }>>;
-    locale: z.ZodOptional<z.ZodString>;
-    salutation: z.ZodOptional<z.ZodString>;
-    key: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    key?: string;
-    storeKey?: string;
-    email?: string;
-    password?: string;
-    firstName?: string;
-    lastName?: string;
-    middleName?: string;
-    title?: string;
-    dateOfBirth?: string;
-    companyName?: string;
-    vatId?: string;
-    custom?: {
-        type?: {
-            id?: string;
-            typeId?: "type";
-        };
-        fields?: Record<string, any>;
-    };
-    addresses?: {
-        email?: string;
-        streetName?: string;
-        streetNumber?: string;
-        additionalStreetInfo?: string;
-        postalCode?: string;
-        city?: string;
-        region?: string;
-        state?: string;
-        country?: string;
-        company?: string;
-        department?: string;
-        building?: string;
-        apartment?: string;
-        pOBox?: string;
-        phone?: string;
-        mobile?: string;
-        fax?: string;
-        additionalAddressInfo?: string;
-    }[];
-    defaultShippingAddress?: number;
-    defaultBillingAddress?: number;
-    shippingAddresses?: number[];
-    billingAddresses?: number[];
-    isEmailVerified?: boolean;
-    externalId?: string;
-    customerGroup?: {
-        id?: string;
-        typeId?: "customer-group";
-    };
-    locale?: string;
-    salutation?: string;
-}, {
-    key?: string;
-    storeKey?: string;
-    email?: string;
-    password?: string;
-    firstName?: string;
-    lastName?: string;
-    middleName?: string;
-    title?: string;
-    dateOfBirth?: string;
-    companyName?: string;
-    vatId?: string;
-    custom?: {
-        type?: {
-            id?: string;
-            typeId?: "type";
-        };
-        fields?: Record<string, any>;
-    };
-    addresses?: {
-        email?: string;
-        streetName?: string;
-        streetNumber?: string;
-        additionalStreetInfo?: string;
-        postalCode?: string;
-        city?: string;
-        region?: string;
-        state?: string;
-        country?: string;
-        company?: string;
-        department?: string;
-        building?: string;
-        apartment?: string;
-        pOBox?: string;
-        phone?: string;
-        mobile?: string;
-        fax?: string;
-        additionalAddressInfo?: string;
-    }[];
-    defaultShippingAddress?: number;
-    defaultBillingAddress?: number;
-    shippingAddresses?: number[];
-    billingAddresses?: number[];
-    isEmailVerified?: boolean;
-    externalId?: string;
-    customerGroup?: {
-        id?: string;
-        typeId?: "customer-group";
-    };
-    locale?: string;
-    salutation?: string;
-}>;
-export declare const updateCustomerParameters: z.ZodObject<{
-    id: z.ZodString;
-    version: z.ZodNumber;
-    actions: z.ZodArray<z.ZodIntersection<z.ZodObject<{
-        action: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        action?: string;
-    }, {
-        action?: string;
-    }>, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>, "many">;
-}, "strip", z.ZodTypeAny, {
-    id?: string;
-    version?: number;
-    actions?: ({
-        action?: string;
-    } & Record<string, any>)[];
-}, {
-    id?: string;
-    version?: number;
-    actions?: ({
-        action?: string;
-    } & Record<string, any>)[];
-}>;
-export declare const deleteCustomerParameters: z.ZodObject<{
-    id: z.ZodString;
-    version: z.ZodNumber;
-    dataErasure: z.ZodOptional<z.ZodBoolean>;
-}, "strip", z.ZodTypeAny, {
-    id?: string;
-    version?: number;
-    dataErasure?: boolean;
-}, {
-    id?: string;
-    version?: number;
-    dataErasure?: boolean;
-}>;

package/dist/resources/customer/test/customer.hander.test.d.ts

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

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

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

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

@@ -1,26 +0,0 @@
-import { z } from 'zod';
-import { type Configuration, type IApiClientFactory, type ResourceMetadata, type ToolExecutionContext } from '../../shared';
-import { CommercetoolsResourceHandler } from '../../handlers/commercetools.handler';
-/**
- * Project Resource Handler
- * Handles project read and update operations
- *
- * Automatically discovered via @ToolHandler() decorator
- */
-export declare class ProjectHandler extends CommercetoolsResourceHandler {
-    protected readonly metadata: ResourceMetadata;
-    constructor(apiClientFactory?: IApiClientFactory);
-    getToolDefinition(operation: 'read' | 'update'): {
-        name: string;
-        description: string;
-        inputSchema: z.ZodObject<Record<string, z.ZodTypeAny>, z.UnknownKeysParam, z.ZodTypeAny, {
-            [x: string]: any;
-        }, {
-            [x: string]: any;
-        }>;
-    };
-    read(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    update(context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    create(_context: ToolExecutionContext<Configuration>): Promise<unknown>;
-    delete(_context: ToolExecutionContext<Configuration>): Promise<unknown>;
-}

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

@@ -1,2 +0,0 @@
-export declare const readProjectPrompt = "\nThis tool will fetch information about a commercetools project.\n\nIt takes these optional arguments:\n- projectKey (string, optional): The key of the project to read. If not provided, the current projectKey from the configuration will be used.\n\nThe response will contain detailed information about the project including countries, currencies, languages, and more.\n";
-export declare const updateProjectPrompt = "\nThis tool will update settings for a commercetools project. This is an admin-only operation.\n\nIt takes these arguments:\n- version (number, optional): The current version of the project. If not provided, the current version will be fetched automatically.\n- actions (array, required): The list of update actions to apply to the project.\n- projectKey (string, optional): The key of the project to update. If not provided, the current project will be used.\n\nAvailable update actions include:\n- changeName: Update the project name\n- changeCountries: Update the list of countries\n- changeCurrencies: Update the list of currencies\n- changeLanguages: Update the list of languages\n- changeMessagesConfiguration: Update the Messages Query feature configuration\n- changeCartsConfiguration: Update the Carts feature configuration\n- changeCountryTaxRateFallbackEnabled: Change the country tax rate fallback setting\n- changeShoppingListsConfiguration: Update the Shopping Lists feature configuration\n- setShippingRateInputType: Set the shipping rate input type\n- setExternalOAuth: Configure an external OAuth provider\n- changeProductSearchIndexingEnabled: Enable/disable product search indexing\n- changeOrderSearchStatus: Change the Order Search status\n- changeCustomerSearchStatus: Change the Customer Search status\n- changeBusinessUnitSearchStatus: Change the Business Unit Search status\n- and more\n\nThe response will contain the updated project information.\n";