@open-loyalty/mcp-server 1.0.3 → 1.3.1

package/dist/tools/campaign.js

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { apiGet, apiPost, apiPut, apiPatch, apiDelete } from "../client/http.js";
 import { CampaignTypeEnum, CampaignTriggerEnum, } from "../types/schemas/campaign.js";
 import { formatApiError } from "../utils/errors.js";
-import { getConfig } from "../config.js";
+import { getStoreCode } from "../config.js";
 // Input Schemas
 export const CampaignListInputSchema = {
     storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
@@ -252,8 +252,7 @@ export const CampaignCreateInputSchema = {
 };
 // Handler functions
 export async function campaignList(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.page)
         params.append("_page", String(input.page));
@@ -307,8 +306,7 @@ export async function campaignList(input) {
     }
 }
 export async function campaignGet(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         const response = await apiGet(`/${storeCode}/campaign/${input.campaignId}`);
         return response;
@@ -318,8 +316,7 @@ export async function campaignGet(input) {
     }
 }
 export async function campaignUpdate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const campaignId = input.campaignId;
     // Build campaign payload excluding storeCode and campaignId
     const { storeCode: _sc, campaignId: _cid, ...campaignPayload } = input;
@@ -332,8 +329,7 @@ export async function campaignUpdate(input) {
     }
 }
 export async function campaignPatch(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const patchPayload = {};
     if (input.active !== undefined)
         patchPayload.active = input.active;
@@ -347,8 +343,7 @@ export async function campaignPatch(input) {
     }
 }
 export async function campaignDelete(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         await apiDelete(`/${storeCode}/campaign/${input.campaignId}`);
     }
@@ -357,8 +352,7 @@ export async function campaignDelete(input) {
     }
 }
 export async function campaignSimulate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     // Build the simulate payload
     const simulatePayload = {
         trigger: input.trigger,
@@ -453,8 +447,7 @@ export async function campaignSimulate(input) {
     }
 }
 export async function campaignGenerateCodes(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         // Body wrapped as { generate: { numberOfCodes } }
         await apiPost(`/${storeCode}/campaign/${input.campaignId}/codes/generate`, { generate: { numberOfCodes: input.quantity } });
@@ -466,8 +459,7 @@ export async function campaignGenerateCodes(input) {
     }
 }
 export async function campaignListCodes(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.page)
         params.append("_page", String(input.page));
@@ -503,8 +495,7 @@ export async function campaignListCodes(input) {
     }
 }
 export async function campaignGetAvailable(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.page)
         params.append("_page", String(input.page));
@@ -541,8 +532,7 @@ export async function campaignGetAvailable(input) {
     }
 }
 export async function campaignGetVisible(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.page)
         params.append("_page", String(input.page));
@@ -576,8 +566,7 @@ export async function campaignGetVisible(input) {
     }
 }
 export async function campaignGetLeaderboard(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.type)
         params.append("type", input.type);
@@ -614,8 +603,7 @@ export async function campaignGetLeaderboard(input) {
     }
 }
 export async function campaignCreate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     // Build the campaign payload
     const campaignPayload = {
         type: input.type,
@@ -651,73 +639,98 @@ export async function campaignCreate(input) {
 export const campaignToolDefinitions = [
     {
         name: "openloyalty_campaign_list",
+        title: "List Campaigns",
         description: "List all campaigns. Filter by type (direct/referral) or trigger (transaction/custom_event/time/etc). Use campaign_get for full configuration including rules and effects.",
+        readOnly: true,
         inputSchema: CampaignListInputSchema,
         handler: campaignList,
     },
     {
         name: "openloyalty_campaign_create",
+        title: "Create Campaign",
         description: "Create campaign to automate engagement. Triggers: transaction (purchase-based), custom_event (for custom actions), time (scheduled). Effects: give_points, give_reward, deduct_unit. Rules define when/what happens. Example - Double points: trigger=transaction, effect=give_points with pointsRule containing multiplier:2.",
+        readOnly: false,
         inputSchema: CampaignCreateInputSchema,
         handler: campaignCreate,
     },
     {
         name: "openloyalty_campaign_get",
+        title: "Get Campaign Details",
         description: "Get full campaign configuration including all rules, conditions, effects, and targeting.",
+        readOnly: true,
         inputSchema: CampaignGetInputSchema,
         handler: campaignGet,
     },
     {
         name: "openloyalty_campaign_update",
+        title: "Update Campaign",
         description: "Full update of campaign configuration. Requires all campaign fields. Use campaign_get first to retrieve current configuration, modify it, then send the complete object.",
+        readOnly: false,
         inputSchema: CampaignUpdateInputSchema,
         handler: campaignUpdate,
     },
     {
         name: "openloyalty_campaign_patch",
+        title: "Patch Campaign",
         description: "Partial update of campaign - only active status and displayOrder can be patched. For full updates, use campaign_update.",
+        readOnly: false,
         inputSchema: CampaignPatchInputSchema,
         handler: campaignPatch,
     },
     {
         name: "openloyalty_campaign_delete",
+        title: "Delete Campaign (Permanent)",
         description: "Permanently delete a campaign. This cannot be undone. Consider deactivating instead if you may need the campaign later.",
+        readOnly: false,
+        destructive: true,
         inputSchema: CampaignDeleteInputSchema,
         handler: campaignDelete,
     },
     {
         name: "openloyalty_campaign_simulate",
+        title: "Simulate Campaign Effects",
         description: "Simulate campaign effects without executing them. Use to preview what points/rewards a transaction would earn. Provide trigger type, transaction/event data, and customer. Returns simulated effects grouped by campaign.",
+        readOnly: true,
         inputSchema: CampaignSimulateInputSchema,
         handler: campaignSimulate,
     },
     {
         name: "openloyalty_campaign_generate_codes",
+        title: "Generate Campaign Codes",
         description: "Generate unique redemption codes for a campaign. Use for promotions requiring unique codes. Codes are auto-generated and can be retrieved with campaign_list_codes.",
+        readOnly: false,
         inputSchema: CampaignGenerateCodesInputSchema,
         handler: campaignGenerateCodes,
     },
     {
         name: "openloyalty_campaign_list_codes",
+        title: "List Campaign Codes",
         description: "List redemption codes for a campaign. Filter by status (active/used) or specific code. Returns code details including usage status.",
+        readOnly: true,
         inputSchema: CampaignListCodesInputSchema,
         handler: campaignListCodes,
     },
     {
         name: "openloyalty_campaign_get_available",
+        title: "Get Available Campaigns for Member",
         description: "Get campaigns available to a specific member. Returns campaigns the member can participate in based on their tier, segments, and campaign targeting rules. Includes limitReached indicator.",
+        readOnly: true,
         inputSchema: CampaignGetAvailableInputSchema,
         handler: campaignGetAvailable,
     },
     {
         name: "openloyalty_campaign_get_visible",
+        title: "Get Visible Campaigns for Member",
         description: "Get campaigns visible to a specific member. May include campaigns not yet available (e.g., upcoming campaigns or those requiring certain conditions). Use get_available for campaigns the member can currently participate in.",
+        readOnly: true,
         inputSchema: CampaignGetVisibleInputSchema,
         handler: campaignGetVisible,
     },
     {
         name: "openloyalty_campaign_get_leaderboard",
+        title: "Get Campaign Leaderboard",
         description: "Get leaderboard rankings for a campaign. Returns ranked list of members with scores and positions. Use for leaderboard-type campaigns to show competition standings.",
+        readOnly: true,
         inputSchema: CampaignGetLeaderboardInputSchema,
         handler: campaignGetLeaderboard,
     },

package/dist/tools/custom-event.d.ts

@@ -0,0 +1,315 @@
+import { z } from "zod";
+export declare const CustomEventSchemaListInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+    eventType: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodBoolean>;
+};
+export declare const CustomEventSchemaGetInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodString;
+};
+export declare const CustomEventSchemaCreateInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodString;
+    name: z.ZodString;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<["text", "number", "boolean", "datetime"]>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "number" | "boolean" | "text" | "datetime";
+        name: string;
+        description?: string | undefined;
+    }, {
+        type: "number" | "boolean" | "text" | "datetime";
+        name: string;
+        description?: string | undefined;
+    }>, "many">;
+    active: z.ZodOptional<z.ZodBoolean>;
+};
+export declare const CustomEventSchemaUpdateInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodString;
+    name: z.ZodString;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<["text", "number", "boolean", "datetime"]>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "number" | "boolean" | "text" | "datetime";
+        name: string;
+        description?: string | undefined;
+    }, {
+        type: "number" | "boolean" | "text" | "datetime";
+        name: string;
+        description?: string | undefined;
+    }>, "many">;
+    active: z.ZodOptional<z.ZodBoolean>;
+};
+export declare const CustomEventSchemaActivateInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodString;
+    active: z.ZodBoolean;
+};
+export declare const CustomEventSendInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    eventType: z.ZodString;
+    customerData: z.ZodObject<{
+        customerId: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+        loyaltyCardNumber: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        email?: string | undefined;
+        phone?: string | undefined;
+        loyaltyCardNumber?: string | undefined;
+        customerId?: string | undefined;
+    }, {
+        email?: string | undefined;
+        phone?: string | undefined;
+        loyaltyCardNumber?: string | undefined;
+        customerId?: string | undefined;
+    }>;
+    eventDate: z.ZodString;
+    body: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    eventId: z.ZodOptional<z.ZodString>;
+};
+export declare const CustomEventListInputSchema: {
+    storeCode: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodString>;
+    customerId: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+};
+interface CustomEventSchemaItem {
+    eventType: string;
+    name: string;
+    schema?: {
+        fields?: Array<{
+            name: string;
+            type: string;
+            description?: string;
+        }>;
+    };
+    active: boolean;
+    createdAt?: string;
+}
+export declare function customEventSchemaList(input: {
+    storeCode?: string;
+    page?: number;
+    perPage?: number;
+    eventType?: string;
+    name?: string;
+    active?: boolean;
+}): Promise<{
+    schemas: CustomEventSchemaItem[];
+    total: {
+        all?: number;
+        filtered?: number;
+    };
+}>;
+export declare function customEventSchemaGet(input: {
+    storeCode?: string;
+    eventType: string;
+}): Promise<CustomEventSchemaItem>;
+interface CustomEventSchemaCreateInput {
+    storeCode?: string;
+    eventType: string;
+    name: string;
+    fields: Array<{
+        name: string;
+        type: string;
+        description?: string;
+    }>;
+    active?: boolean;
+}
+export declare function customEventSchemaCreate(input: CustomEventSchemaCreateInput): Promise<void>;
+interface CustomEventSchemaUpdateInput {
+    storeCode?: string;
+    eventType: string;
+    name: string;
+    fields: Array<{
+        name: string;
+        type: string;
+        description?: string;
+    }>;
+    active?: boolean;
+}
+export declare function customEventSchemaUpdate(input: CustomEventSchemaUpdateInput): Promise<void>;
+export declare function customEventSchemaActivate(input: {
+    storeCode?: string;
+    eventType: string;
+    active: boolean;
+}): Promise<void>;
+interface CustomEventSendInput {
+    storeCode?: string;
+    eventType: string;
+    customerData: {
+        customerId?: string;
+        email?: string;
+        phone?: string;
+        loyaltyCardNumber?: string;
+    };
+    eventDate: string;
+    body?: Record<string, unknown>;
+    eventId?: string;
+}
+export declare function customEventSend(input: CustomEventSendInput): Promise<{
+    customEventId?: string;
+}>;
+interface CustomEventItem {
+    customEventId: string;
+    type: string;
+    customerId?: string;
+    eventDate?: string;
+    body?: Record<string, unknown>;
+    createdAt?: string;
+}
+export declare function customEventList(input: {
+    storeCode?: string;
+    page?: number;
+    perPage?: number;
+    type?: string;
+    customerId?: string;
+    email?: string;
+}): Promise<{
+    events: CustomEventItem[];
+    total: {
+        all?: number;
+        filtered?: number;
+    };
+}>;
+export declare const customEventToolDefinitions: readonly [{
+    readonly name: "ol_custom_event_schema_list";
+    readonly title: "List Custom Event Schemas";
+    readonly description: string;
+    readonly readOnly: true;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+        eventType: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodBoolean>;
+    };
+    readonly handler: typeof customEventSchemaList;
+}, {
+    readonly name: "ol_custom_event_schema_get";
+    readonly title: "Get Custom Event Schema";
+    readonly description: "Get details of a specific custom event schema including its fields.";
+    readonly readOnly: true;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodString;
+    };
+    readonly handler: typeof customEventSchemaGet;
+}, {
+    readonly name: "ol_custom_event_schema_create";
+    readonly title: "Create Custom Event Schema";
+    readonly description: string;
+    readonly readOnly: false;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodString;
+        name: z.ZodString;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodEnum<["text", "number", "boolean", "datetime"]>;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "number" | "boolean" | "text" | "datetime";
+            name: string;
+            description?: string | undefined;
+        }, {
+            type: "number" | "boolean" | "text" | "datetime";
+            name: string;
+            description?: string | undefined;
+        }>, "many">;
+        active: z.ZodOptional<z.ZodBoolean>;
+    };
+    readonly handler: typeof customEventSchemaCreate;
+}, {
+    readonly name: "ol_custom_event_schema_update";
+    readonly title: "Update Custom Event Schema";
+    readonly description: "Update an existing custom event schema (name, fields, active status).";
+    readonly readOnly: false;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodString;
+        name: z.ZodString;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodEnum<["text", "number", "boolean", "datetime"]>;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "number" | "boolean" | "text" | "datetime";
+            name: string;
+            description?: string | undefined;
+        }, {
+            type: "number" | "boolean" | "text" | "datetime";
+            name: string;
+            description?: string | undefined;
+        }>, "many">;
+        active: z.ZodOptional<z.ZodBoolean>;
+    };
+    readonly handler: typeof customEventSchemaUpdate;
+}, {
+    readonly name: "ol_custom_event_schema_activate";
+    readonly title: "Activate/Deactivate Custom Event Schema";
+    readonly description: "Activate or deactivate a custom event schema. Inactive schemas won't trigger campaigns/achievements.";
+    readonly readOnly: false;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodString;
+        active: z.ZodBoolean;
+    };
+    readonly handler: typeof customEventSchemaActivate;
+}, {
+    readonly name: "ol_custom_event_send";
+    readonly title: "Send Custom Event";
+    readonly description: string;
+    readonly readOnly: false;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        eventType: z.ZodString;
+        customerData: z.ZodObject<{
+            customerId: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            phone: z.ZodOptional<z.ZodString>;
+            loyaltyCardNumber: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            email?: string | undefined;
+            phone?: string | undefined;
+            loyaltyCardNumber?: string | undefined;
+            customerId?: string | undefined;
+        }, {
+            email?: string | undefined;
+            phone?: string | undefined;
+            loyaltyCardNumber?: string | undefined;
+            customerId?: string | undefined;
+        }>;
+        eventDate: z.ZodString;
+        body: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        eventId: z.ZodOptional<z.ZodString>;
+    };
+    readonly handler: typeof customEventSend;
+}, {
+    readonly name: "ol_custom_event_list";
+    readonly title: "List Custom Events";
+    readonly description: "List custom events that have been sent. Filter by event type or member to see event history.";
+    readonly readOnly: true;
+    readonly inputSchema: {
+        storeCode: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodOptional<z.ZodString>;
+        customerId: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+    };
+    readonly handler: typeof customEventList;
+}];
+export {};