@open-loyalty/mcp-server 1.1.0 → 1.3.3

package/dist/tools/apikey.d.ts

@@ -44,7 +44,7 @@ export declare function apiKeyDelete(input: {
     apiKeyId: string;
 }): Promise<void>;
 export declare const apiKeyToolDefinitions: readonly [{
-    readonly name: "openloyalty_apikey_create";
+    readonly name: "ol_apikey_create";
     readonly title: "Create API Key";
     readonly description: "Create a new API key for an admin user. CRITICAL: The API token is ONLY returned at creation time. Store it securely immediately - it cannot be retrieved later. Returns apiKeyId, token, adminId, name, and expirationDate.";
     readonly readOnly: false;
@@ -55,7 +55,7 @@ export declare const apiKeyToolDefinitions: readonly [{
     };
     readonly handler: typeof apiKeyCreate;
 }, {
-    readonly name: "openloyalty_apikey_list";
+    readonly name: "ol_apikey_list";
     readonly title: "List API Keys";
     readonly description: "List API keys for an admin user. Returns list of API keys with apiKeyId, adminId, name, and expirationDate. Note: tokens are not returned in list responses for security.";
     readonly readOnly: true;
@@ -66,7 +66,7 @@ export declare const apiKeyToolDefinitions: readonly [{
     };
     readonly handler: typeof apiKeyList;
 }, {
-    readonly name: "openloyalty_apikey_delete";
+    readonly name: "ol_apikey_delete";
     readonly title: "Delete API Key (Permanent)";
     readonly description: "Delete an API key. Returns void on success (204 No Content). The API key will be immediately invalidated.";
     readonly readOnly: false;

package/dist/tools/apikey.js

@@ -28,7 +28,7 @@ export async function apiKeyCreate(input) {
         return response;
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_apikey_create");
+        throw formatApiError(error, "ol_apikey_create");
     }
 }
 export async function apiKeyList(input) {
@@ -44,7 +44,7 @@ export async function apiKeyList(input) {
         return response;
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_apikey_list");
+        throw formatApiError(error, "ol_apikey_list");
     }
 }
 export async function apiKeyDelete(input) {
@@ -52,13 +52,13 @@ export async function apiKeyDelete(input) {
         await apiDelete(`/admin/${input.adminId}/api-key/${input.apiKeyId}`);
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_apikey_delete");
+        throw formatApiError(error, "ol_apikey_delete");
     }
 }
 // Tool definitions
 export const apiKeyToolDefinitions = [
     {
-        name: "openloyalty_apikey_create",
+        name: "ol_apikey_create",
         title: "Create API Key",
         description: "Create a new API key for an admin user. CRITICAL: The API token is ONLY returned at creation time. Store it securely immediately - it cannot be retrieved later. Returns apiKeyId, token, adminId, name, and expirationDate.",
         readOnly: false,
@@ -66,7 +66,7 @@ export const apiKeyToolDefinitions = [
         handler: apiKeyCreate,
     },
     {
-        name: "openloyalty_apikey_list",
+        name: "ol_apikey_list",
         title: "List API Keys",
         description: "List API keys for an admin user. Returns list of API keys with apiKeyId, adminId, name, and expirationDate. Note: tokens are not returned in list responses for security.",
         readOnly: true,
@@ -74,7 +74,7 @@ export const apiKeyToolDefinitions = [
         handler: apiKeyList,
     },
     {
-        name: "openloyalty_apikey_delete",
+        name: "ol_apikey_delete",
         title: "Delete API Key (Permanent)",
         description: "Delete an API key. Returns void on success (204 No Content). The API key will be immediately invalidated.",
         readOnly: false,

package/dist/tools/audit.d.ts

@@ -80,7 +80,7 @@ export declare function auditExport(input: {
     exportId: string;
 }>;
 export declare const auditToolDefinitions: readonly [{
-    readonly name: "openloyalty_audit_list";
+    readonly name: "ol_audit_list";
     readonly title: "List Audit Logs";
     readonly description: "List audit log entries with optional filtering. Returns paginated list of audit entries with auditLogId, eventType, entityType, entityId, username, timestamp, and details. Audit logs track all administrative actions. Use for compliance and troubleshooting.";
     readonly readOnly: true;
@@ -97,7 +97,7 @@ export declare const auditToolDefinitions: readonly [{
     };
     readonly handler: typeof auditList;
 }, {
-    readonly name: "openloyalty_audit_export";
+    readonly name: "ol_audit_export";
     readonly title: "Export Audit Logs";
     readonly description: "Create an export of system logs. Returns exportId that can be used to track export status. The export will be processed asynchronously. Use date filters to scope the export range.";
     readonly readOnly: false;

package/dist/tools/audit.js

@@ -47,7 +47,7 @@ export async function auditList(input) {
         return response;
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_audit_list");
+        throw formatApiError(error, "ol_audit_list");
     }
 }
 export async function auditExport(input) {
@@ -70,13 +70,13 @@ export async function auditExport(input) {
         return response;
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_audit_export");
+        throw formatApiError(error, "ol_audit_export");
     }
 }
 // Tool definitions
 export const auditToolDefinitions = [
     {
-        name: "openloyalty_audit_list",
+        name: "ol_audit_list",
         title: "List Audit Logs",
         description: "List audit log entries with optional filtering. Returns paginated list of audit entries with auditLogId, eventType, entityType, entityId, username, timestamp, and details. Audit logs track all administrative actions. Use for compliance and troubleshooting.",
         readOnly: true,
@@ -84,7 +84,7 @@ export const auditToolDefinitions = [
         handler: auditList,
     },
     {
-        name: "openloyalty_audit_export",
+        name: "ol_audit_export",
         title: "Export Audit Logs",
         description: "Create an export of system logs. Returns exportId that can be used to track export status. The export will be processed asynchronously. Use date filters to scope the export range.",
         readOnly: false,

package/dist/tools/badge.d.ts

@@ -14,7 +14,7 @@ export declare const BadgeGetInputSchema: {
 export declare const BadgeUpdateInputSchema: {
     storeCode: z.ZodOptional<z.ZodString>;
     badgeTypeId: z.ZodString;
-    name: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
     translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
@@ -80,7 +80,7 @@ export declare function badgeGetMemberBadges(input: {
     };
 }>;
 export declare const badgeToolDefinitions: readonly [{
-    readonly name: "openloyalty_badge_list";
+    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;
@@ -93,7 +93,7 @@ export declare const badgeToolDefinitions: readonly [{
     };
     readonly handler: typeof badgeList;
 }, {
-    readonly name: "openloyalty_badge_get";
+    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;
@@ -103,14 +103,14 @@ export declare const badgeToolDefinitions: readonly [{
     };
     readonly handler: typeof badgeGet;
 }, {
-    readonly name: "openloyalty_badge_update";
+    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.ZodOptional<z.ZodString>;
+        name: z.ZodString;
         translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
             name: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
@@ -126,7 +126,7 @@ export declare const badgeToolDefinitions: readonly [{
     };
     readonly handler: typeof badgeUpdate;
 }, {
-    readonly name: "openloyalty_badge_get_member_badges";
+    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;

package/dist/tools/badge.js

@@ -4,29 +4,29 @@ import { formatApiError } from "../utils/errors.js";
 import { getStoreCode } from "../config.js";
 // Input Schemas
 export const BadgeListInputSchema = {
-    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    storeCode: z.string().optional().describe("Store code for multi-tenant routing. DO NOT pass this parameter - the configured default will be used automatically. Only provide a value if the user explicitly asks to work with 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("Store code. If not provided, uses the default store code from configuration."),
+    storeCode: z.string().optional().describe("Store code for multi-tenant routing. DO NOT pass this parameter - the configured default will be used automatically. Only provide a value if the user explicitly asks to work with a different store."),
     badgeTypeId: z.string().describe("The badge type ID (UUID) to retrieve."),
 };
 export const BadgeUpdateInputSchema = {
-    storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
+    storeCode: z.string().optional().describe("Store code for multi-tenant routing. DO NOT pass this parameter - the configured default will be used automatically. Only provide a value if the user explicitly asks to work with a different store."),
     badgeTypeId: z.string().describe("The badge type ID (UUID) to update."),
-    name: z.string().optional().describe("Badge name."),
+    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."),
+    })).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("Store code. If not provided, uses the default store code from configuration."),
+    storeCode: z.string().optional().describe("Store code for multi-tenant routing. DO NOT pass this parameter - the configured default will be used automatically. Only provide a value if the user explicitly asks to work with 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)."),
@@ -65,7 +65,7 @@ export async function badgeList(input) {
         };
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_badge_list");
+        throw formatApiError(error, "ol_badge_list");
     }
 }
 export async function badgeGet(input) {
@@ -75,16 +75,21 @@ export async function badgeGet(input) {
         return response;
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_badge_get");
+        throw formatApiError(error, "ol_badge_get");
     }
 }
 export async function badgeUpdate(input) {
     const storeCode = getStoreCode(input.storeCode);
     const badgePayload = {};
-    if (input.name !== undefined)
-        badgePayload.name = input.name;
-    if (input.translations)
-        badgePayload.translations = input.translations;
+    // 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)
@@ -94,7 +99,7 @@ export async function badgeUpdate(input) {
         await apiPut(`/${storeCode}/badge-type/${input.badgeTypeId}`, { badgeType: badgePayload });
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_badge_update");
+        throw formatApiError(error, "ol_badge_update");
     }
 }
 export async function badgeGetMemberBadges(input) {
@@ -129,13 +134,13 @@ export async function badgeGetMemberBadges(input) {
         };
     }
     catch (error) {
-        throw formatApiError(error, "openloyalty_badge_get_member_badges");
+        throw formatApiError(error, "ol_badge_get_member_badges");
     }
 }
 // Tool definitions
 export const badgeToolDefinitions = [
     {
-        name: "openloyalty_badge_list",
+        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,
@@ -143,7 +148,7 @@ export const badgeToolDefinitions = [
         handler: badgeList,
     },
     {
-        name: "openloyalty_badge_get",
+        name: "ol_badge_get",
         title: "Get Badge Details",
         description: "Get badge type details including name, image URL, and linked achievements count.",
         readOnly: true,
@@ -151,7 +156,7 @@ export const badgeToolDefinitions = [
         handler: badgeGet,
     },
     {
-        name: "openloyalty_badge_update",
+        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,
@@ -159,7 +164,7 @@ export const badgeToolDefinitions = [
         handler: badgeUpdate,
     },
     {
-        name: "openloyalty_badge_get_member_badges",
+        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,

package/dist/tools/campaign/handlers.d.ts

@@ -0,0 +1,42 @@
+import { CampaignListItem } from "../../types/schemas/campaign.js";
+import { SimulatedEffect, CampaignSimulateInput, CampaignCreateInput } from "./types.js";
+export declare function campaignList(input: {
+    storeCode?: string;
+    page?: number;
+    perPage?: number;
+    active?: boolean;
+    type?: string;
+    trigger?: string;
+}): Promise<{
+    campaigns: CampaignListItem[];
+    total: {
+        all?: number;
+        filtered?: number;
+    };
+}>;
+export declare function campaignGet(input: {
+    storeCode?: string;
+    campaignId: string;
+}): Promise<Record<string, unknown>>;
+export declare function campaignCreate(input: CampaignCreateInput): Promise<{
+    campaignId: string;
+}>;
+export declare function campaignUpdate(input: Record<string, unknown>): Promise<void>;
+export declare function campaignPatch(input: {
+    storeCode?: string;
+    campaignId: string;
+    active?: boolean;
+    displayOrder?: number;
+}): Promise<void>;
+export declare function campaignDelete(input: {
+    storeCode?: string;
+    campaignId: string;
+}): Promise<void>;
+export declare function campaignSimulate(input: CampaignSimulateInput): Promise<{
+    simulatedEffects: SimulatedEffect[];
+    evaluationWarnings?: Array<{
+        campaignId: string;
+        message: string;
+    }>;
+    simulatedMember?: Record<string, unknown>;
+}>;

package/dist/tools/campaign/handlers.js

@@ -0,0 +1,223 @@
+import { apiGet, apiPost, apiPut, apiPatch, apiDelete } from "../../client/http.js";
+import { formatApiError } from "../../utils/errors.js";
+import { getStoreCode } from "../../config.js";
+// Core CRUD handlers
+export async function campaignList(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.active !== undefined)
+        params.append("active", String(input.active));
+    if (input.type)
+        params.append("type", input.type);
+    if (input.trigger)
+        params.append("trigger", input.trigger);
+    const queryString = params.toString();
+    const url = `/${storeCode}/campaign${queryString ? `?${queryString}` : ""}`;
+    try {
+        const response = await apiGet(url);
+        const campaigns = (response.items || []).map((item) => {
+            const campaign = item;
+            const translations = campaign.translations;
+            let name = "";
+            if (Array.isArray(translations)) {
+                const enTranslation = translations.find((t) => t.locale === "en" || t.locale?.startsWith("en"));
+                name = enTranslation?.name || translations[0]?.name || campaign.name || "";
+            }
+            else if (translations && typeof translations === "object") {
+                name = translations.en?.name || campaign.name || "";
+            }
+            else {
+                name = campaign.name || "";
+            }
+            return {
+                campaignId: campaign.campaignId,
+                name,
+                type: campaign.type,
+                trigger: campaign.trigger,
+                active: (campaign.active ?? false),
+                displayOrder: campaign.displayOrder,
+            };
+        });
+        const total = response.total || {};
+        return {
+            campaigns,
+            total: {
+                all: typeof total.all === "number" ? total.all : undefined,
+                filtered: typeof total.filtered === "number" ? total.filtered : undefined,
+            },
+        };
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_list");
+    }
+}
+export async function campaignGet(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    try {
+        const response = await apiGet(`/${storeCode}/campaign/${input.campaignId}`);
+        return response;
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_get");
+    }
+}
+export async function campaignCreate(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    const campaignPayload = {
+        type: input.type,
+        trigger: input.trigger,
+        translations: input.translations,
+        activity: input.activity,
+        rules: input.rules,
+    };
+    if (input.visibility)
+        campaignPayload.visibility = input.visibility;
+    if (input.audience)
+        campaignPayload.audience = input.audience;
+    if (input.limits)
+        campaignPayload.limits = input.limits;
+    if (input.active !== undefined)
+        campaignPayload.active = input.active;
+    if (input.displayOrder !== undefined)
+        campaignPayload.displayOrder = input.displayOrder;
+    if (input.labels)
+        campaignPayload.labels = input.labels;
+    if (input.event)
+        campaignPayload.event = input.event;
+    if (input.achievementId)
+        campaignPayload.achievementId = input.achievementId;
+    try {
+        const response = await apiPost(`/${storeCode}/campaign`, { campaign: campaignPayload });
+        return { campaignId: response.campaignId };
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_create");
+    }
+}
+export async function campaignUpdate(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    const campaignId = input.campaignId;
+    const { storeCode: _sc, campaignId: _cid, ...campaignPayload } = input;
+    try {
+        await apiPut(`/${storeCode}/campaign/${campaignId}`, { campaign: campaignPayload });
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_update");
+    }
+}
+export async function campaignPatch(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    const patchPayload = {};
+    if (input.active !== undefined)
+        patchPayload.active = input.active;
+    if (input.displayOrder !== undefined)
+        patchPayload.displayOrder = input.displayOrder;
+    try {
+        await apiPatch(`/${storeCode}/campaign/${input.campaignId}`, { campaign: patchPayload });
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_patch");
+    }
+}
+export async function campaignDelete(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    try {
+        await apiDelete(`/${storeCode}/campaign/${input.campaignId}`);
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_delete");
+    }
+}
+// Simulation handler
+export async function campaignSimulate(input) {
+    const storeCode = getStoreCode(input.storeCode);
+    const simulatePayload = {
+        trigger: input.trigger,
+        customer: {},
+    };
+    const customer = {};
+    if (input.customer.customerId)
+        customer.id = input.customer.customerId;
+    if (input.customer.id)
+        customer.id = input.customer.id;
+    if (input.customer.email)
+        customer.email = input.customer.email;
+    if (input.customer.loyaltyCardNumber)
+        customer.loyaltyCardNumber = input.customer.loyaltyCardNumber;
+    if (input.customer.phone)
+        customer.phone = input.customer.phone;
+    if (input.customer.firstName)
+        customer.firstName = input.customer.firstName;
+    if (input.customer.lastName)
+        customer.lastName = input.customer.lastName;
+    simulatePayload.customer = customer;
+    if (input.transaction) {
+        const transaction = {};
+        if (input.transaction.grossValue !== undefined)
+            transaction.grossValue = input.transaction.grossValue;
+        if (input.transaction.documentNumber)
+            transaction.documentNumber = input.transaction.documentNumber;
+        if (input.transaction.purchasedAt)
+            transaction.purchasedAt = input.transaction.purchasedAt;
+        if (input.transaction.documentType)
+            transaction.documentType = input.transaction.documentType;
+        if (input.transaction.purchasePlace)
+            transaction.purchasePlace = input.transaction.purchasePlace;
+        if (input.transaction.items)
+            transaction.items = input.transaction.items;
+        if (input.transaction.labels)
+            transaction.labels = input.transaction.labels;
+        simulatePayload.transaction = transaction;
+    }
+    if (input.customEvent) {
+        simulatePayload.event = input.customEvent.eventCode;
+        if (input.customEvent.attributes) {
+            simulatePayload.eventAttributes = input.customEvent.attributes;
+        }
+    }
+    if (input.referrer) {
+        const referrer = {};
+        if (input.referrer.id)
+            referrer.id = input.referrer.id;
+        if (input.referrer.email)
+            referrer.email = input.referrer.email;
+        if (input.referrer.loyaltyCardNumber)
+            referrer.loyaltyCardNumber = input.referrer.loyaltyCardNumber;
+        simulatePayload.referrer = referrer;
+    }
+    try {
+        const response = await apiPost(`/${storeCode}/campaign/simulate`, { simulate: simulatePayload });
+        const effectsByCampaign = new Map();
+        for (const effect of response.effects || []) {
+            const campaignId = effect.campaign?.campaignId || "unknown";
+            const campaignName = effect.campaign?.name || undefined;
+            if (!effectsByCampaign.has(campaignId)) {
+                effectsByCampaign.set(campaignId, {
+                    campaignId,
+                    campaignName,
+                    effects: [],
+                });
+            }
+            const campaignEffect = effectsByCampaign.get(campaignId);
+            campaignEffect.effects.push({
+                type: effect.type,
+                target: effect.target,
+                points: effect.points,
+                wallet: effect.wallet,
+                rewardId: effect.rewardId,
+            });
+        }
+        return {
+            simulatedEffects: Array.from(effectsByCampaign.values()),
+            evaluationWarnings: response.evaluationWarnings,
+            simulatedMember: response.simulatedMember,
+        };
+    }
+    catch (error) {
+        throw formatApiError(error, "ol_campaign_simulate");
+    }
+}