@open-loyalty/mcp-server 1.5.3 → 1.7.0

package/dist/tools/badge.d.ts

@@ -1,143 +0,0 @@
-import { z } from "zod";
-import { BadgeTypeListItem, MemberBadge } from "../types/schemas/badge.js";
-export declare const BadgeListInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    name: z.ZodOptional<z.ZodString>;
-    badgeTypeId: z.ZodOptional<z.ZodString>;
-};
-export declare const BadgeGetInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    badgeTypeId: z.ZodString;
-};
-export declare const BadgeUpdateInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    badgeTypeId: z.ZodString;
-    name: z.ZodString;
-    translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-        name: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        description?: string | undefined;
-    }, {
-        name: string;
-        description?: string | undefined;
-    }>>>;
-    imageUrl: z.ZodOptional<z.ZodString>;
-    active: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const BadgeGetMemberBadgesInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    memberId: z.ZodString;
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    name: z.ZodOptional<z.ZodString>;
-    badgeTypeId: z.ZodOptional<z.ZodString>;
-};
-export declare function badgeList(input: {
-    storeCode?: string;
-    page?: number;
-    perPage?: number;
-    name?: string;
-    badgeTypeId?: string;
-}): Promise<{
-    badges: BadgeTypeListItem[];
-    total: {
-        all?: number;
-        filtered?: number;
-    };
-}>;
-export declare function badgeGet(input: {
-    storeCode?: string;
-    badgeTypeId: string;
-}): Promise<Record<string, unknown>>;
-interface BadgeUpdateInput {
-    storeCode?: string;
-    badgeTypeId: string;
-    name?: string;
-    translations?: Record<string, {
-        name: string;
-        description?: string;
-    }>;
-    imageUrl?: string;
-    active?: boolean;
-}
-export declare function badgeUpdate(input: BadgeUpdateInput): Promise<void>;
-export declare function badgeGetMemberBadges(input: {
-    storeCode?: string;
-    memberId: string;
-    page?: number;
-    perPage?: number;
-    name?: string;
-    badgeTypeId?: string;
-}): Promise<{
-    badges: MemberBadge[];
-    total: {
-        all?: number;
-        filtered?: number;
-    };
-}>;
-export declare const badgeToolDefinitions: readonly [{
-    readonly name: "ol_badge_list";
-    readonly title: "List Badges";
-    readonly description: "List badge types. Badges are visual rewards linked to achievements. When a member completes an achievement with a badgeTypeId, they earn that badge. Use for displaying available badges.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodOptional<z.ZodString>;
-        badgeTypeId: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof badgeList;
-}, {
-    readonly name: "ol_badge_get";
-    readonly title: "Get Badge Details";
-    readonly description: "Get badge type details including name, image URL, and linked achievements count.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        badgeTypeId: z.ZodString;
-    };
-    readonly handler: typeof badgeGet;
-}, {
-    readonly name: "ol_badge_update";
-    readonly title: "Update Badge";
-    readonly description: "Update badge type configuration. Badge types are created automatically when referenced by achievements. Use this to update name, image, or translations.";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        badgeTypeId: z.ZodString;
-        name: z.ZodString;
-        translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            name: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            name: string;
-            description?: string | undefined;
-        }, {
-            name: string;
-            description?: string | undefined;
-        }>>>;
-        imageUrl: z.ZodOptional<z.ZodString>;
-        active: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof badgeUpdate;
-}, {
-    readonly name: "ol_badge_get_member_badges";
-    readonly title: "Get Member Badges";
-    readonly description: "Get badges earned by a member. Returns each badge with completedCount showing how many times it was earned. Use for displaying member's badge collection.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        memberId: z.ZodString;
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodOptional<z.ZodString>;
-        badgeTypeId: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof badgeGetMemberBadges;
-}];
-export {};

package/dist/tools/badge.js

@@ -1,174 +0,0 @@
-import { z } from "zod";
-import { apiGet, apiPut } from "../client/http.js";
-import { formatApiError } from "../utils/errors.js";
-import { getStoreCode } from "../config.js";
-// Input Schemas
-export const BadgeListInputSchema = {
-    storeCode: z.string().optional().describe("INTERNAL: Auto-configured from server settings. NEVER ask the user for this value. Only set if the user explicitly requests a different store."),
-    page: z.number().optional().describe("Page number (default: 1)."),
-    perPage: z.number().optional().describe("Items per page (default: 10)."),
-    name: z.string().optional().describe("Filter by badge name."),
-    badgeTypeId: z.string().optional().describe("Filter by specific badge type ID."),
-};
-export const BadgeGetInputSchema = {
-    storeCode: z.string().optional().describe("INTERNAL: Auto-configured from server settings. NEVER ask the user for this value. Only set if the user explicitly requests a different store."),
-    badgeTypeId: z.string().describe("The badge type ID (UUID) to retrieve."),
-};
-export const BadgeUpdateInputSchema = {
-    storeCode: z.string().optional().describe("INTERNAL: Auto-configured from server settings. NEVER ask the user for this value. Only set if the user explicitly requests a different store."),
-    badgeTypeId: z.string().describe("The badge type ID (UUID) to update."),
-    name: z.string().describe("Badge name (REQUIRED). API requires name as a direct field."),
-    translations: z.record(z.string(), z.object({
-        name: z.string(),
-        description: z.string().optional(),
-    })).optional().describe("Badge translations (for convenience - will extract name from translations.en.name if name not provided directly)."),
-    imageUrl: z.string().optional().describe("URL to badge image."),
-    active: z.boolean().optional().describe("Whether badge type is active."),
-};
-export const BadgeGetMemberBadgesInputSchema = {
-    storeCode: z.string().optional().describe("INTERNAL: Auto-configured from server settings. NEVER ask the user for this value. Only set if the user explicitly requests a different store."),
-    memberId: z.string().describe("The member ID (UUID)."),
-    page: z.number().optional().describe("Page number (default: 1)."),
-    perPage: z.number().optional().describe("Items per page (default: 10)."),
-    name: z.string().optional().describe("Filter by badge name."),
-    badgeTypeId: z.string().optional().describe("Filter by specific badge type ID."),
-};
-// Handler functions
-export async function badgeList(input) {
-    const storeCode = getStoreCode(input.storeCode);
-    const params = new URLSearchParams();
-    if (input.page)
-        params.append("_page", String(input.page));
-    if (input.perPage)
-        params.append("_itemsOnPage", String(input.perPage));
-    if (input.name)
-        params.append("name", input.name);
-    if (input.badgeTypeId)
-        params.append("badgeTypeId", input.badgeTypeId);
-    const queryString = params.toString();
-    const url = `/${storeCode}/badge-type${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        const badges = (response.items || []).map((item) => ({
-            badgeTypeId: item.badgeTypeId,
-            name: item.name,
-            createdAt: item.createdAt,
-            updatedAt: item.updatedAt,
-        }));
-        const total = response.total || {};
-        return {
-            badges,
-            total: {
-                all: typeof total.all === "number" ? total.all : undefined,
-                filtered: typeof total.filtered === "number" ? total.filtered : undefined,
-            },
-        };
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_badge_list");
-    }
-}
-export async function badgeGet(input) {
-    const storeCode = getStoreCode(input.storeCode);
-    try {
-        const response = await apiGet(`/${storeCode}/badge-type/${input.badgeTypeId}`);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_badge_get");
-    }
-}
-export async function badgeUpdate(input) {
-    const storeCode = getStoreCode(input.storeCode);
-    const badgePayload = {};
-    // API requires name as direct field, not nested in translations
-    // Extract from translations.en.name if name not provided directly
-    let badgeName = input.name;
-    if (!badgeName && input.translations?.en?.name) {
-        badgeName = input.translations.en.name;
-    }
-    if (badgeName !== undefined)
-        badgePayload.name = badgeName;
-    // Note: API does not accept nested translations - only direct fields
-    if (input.imageUrl !== undefined)
-        badgePayload.imageUrl = input.imageUrl;
-    if (input.active !== undefined)
-        badgePayload.active = input.active;
-    try {
-        // CRITICAL: Wrap body as { badgeType: {...} }
-        await apiPut(`/${storeCode}/badge-type/${input.badgeTypeId}`, { badgeType: badgePayload });
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_badge_update");
-    }
-}
-export async function badgeGetMemberBadges(input) {
-    const storeCode = getStoreCode(input.storeCode);
-    const params = new URLSearchParams();
-    if (input.page)
-        params.append("_page", String(input.page));
-    if (input.perPage)
-        params.append("_itemsOnPage", String(input.perPage));
-    if (input.name)
-        params.append("name", input.name);
-    if (input.badgeTypeId)
-        params.append("badgeTypeId", input.badgeTypeId);
-    const queryString = params.toString();
-    const url = `/${storeCode}/member/${input.memberId}/badge${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        const badges = (response.items || []).map((item) => ({
-            badgeTypeId: item.badgeTypeId,
-            name: item.name,
-            completedCount: item.completedCount,
-            createdAt: item.createdAt,
-            updatedAt: item.updatedAt,
-        }));
-        const total = response.total || {};
-        return {
-            badges,
-            total: {
-                all: typeof total.all === "number" ? total.all : undefined,
-                filtered: typeof total.filtered === "number" ? total.filtered : undefined,
-            },
-        };
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_badge_get_member_badges");
-    }
-}
-// Tool definitions
-export const badgeToolDefinitions = [
-    {
-        name: "ol_badge_list",
-        title: "List Badges",
-        description: "List badge types. Badges are visual rewards linked to achievements. When a member completes an achievement with a badgeTypeId, they earn that badge. Use for displaying available badges.",
-        readOnly: true,
-        inputSchema: BadgeListInputSchema,
-        handler: badgeList,
-    },
-    {
-        name: "ol_badge_get",
-        title: "Get Badge Details",
-        description: "Get badge type details including name, image URL, and linked achievements count.",
-        readOnly: true,
-        inputSchema: BadgeGetInputSchema,
-        handler: badgeGet,
-    },
-    {
-        name: "ol_badge_update",
-        title: "Update Badge",
-        description: "Update badge type configuration. Badge types are created automatically when referenced by achievements. Use this to update name, image, or translations.",
-        readOnly: false,
-        inputSchema: BadgeUpdateInputSchema,
-        handler: badgeUpdate,
-    },
-    {
-        name: "ol_badge_get_member_badges",
-        title: "Get Member Badges",
-        description: "Get badges earned by a member. Returns each badge with completedCount showing how many times it was earned. Use for displaying member's badge collection.",
-        readOnly: true,
-        inputSchema: BadgeGetMemberBadgesInputSchema,
-        handler: badgeGetMemberBadges,
-    },
-];

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

@@ -1,315 +0,0 @@
-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 {};