@open-loyalty/mcp-server 1.5.3 → 1.7.0

package/dist/tools/import.js

@@ -1,143 +0,0 @@
-import { z } from "zod";
-import { apiGet } from "../client/http.js";
-import { formatApiError } from "../utils/errors.js";
-import { getConfig, getStoreCode } from "../config.js";
-import axios from "axios";
-import FormDataNode from "form-data";
-// Input Schemas
-export const ImportCreateInputSchema = {
-    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."),
-    type: z.enum([
-        "member",
-        "groupValue",
-        "segmentMembers",
-        "unitTransferAdding",
-        "unitTransferSpending",
-        "transaction",
-        "campaignCode",
-        "rewardCoupon",
-    ]).describe("Import type. Options: member, groupValue, segmentMembers, unitTransferAdding, unitTransferSpending, transaction, campaignCode, rewardCoupon."),
-    fileContent: z.string().describe("File content as plain text (not base64 encoded). Accepts CSV (comma-separated rows) or XML format. " +
-        "For member imports, XML is the standard format. Auto-detected based on content or fileName extension."),
-    fileName: z.string().optional().describe("Optional file name for the import (default: import.xml). Use .xml extension for XML content, .csv for CSV content."),
-};
-export const ImportListInputSchema = {
-    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: 25)."),
-    importId: z.string().optional().describe("Filter by import ID."),
-    type: z.enum([
-        "member",
-        "groupValue",
-        "segmentMembers",
-        "unitTransferAdding",
-        "unitTransferSpending",
-        "transaction",
-        "campaignCode",
-        "rewardCoupon",
-    ]).optional().describe("Filter by import type."),
-};
-export const ImportGetInputSchema = {
-    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."),
-    importId: z.string().describe("The import ID (UUID) to retrieve."),
-    page: z.number().optional().describe("Page number for import items (default: 1)."),
-    perPage: z.number().optional().describe("Items per page for import items (default: 25)."),
-};
-// Handler functions
-export async function importCreate(input) {
-    const config = getConfig();
-    const storeCode = getStoreCode(input.storeCode);
-    // Determine file extension and content type
-    // API accepts: application/xml, text/xml for member imports; text/csv for others
-    const fileName = input.fileName || "import.xml";
-    const isXml = fileName.endsWith('.xml') || input.fileContent.trim().startsWith('<?xml') || input.fileContent.trim().startsWith('<');
-    const contentType = isXml ? "application/xml" : "text/csv";
-    // Create form data for multipart upload using Node.js form-data package
-    // API expects field name "import[file]" per documentation
-    const formData = new FormDataNode();
-    formData.append("import[file]", Buffer.from(input.fileContent), {
-        filename: fileName,
-        contentType: contentType,
-    });
-    try {
-        const response = await axios.post(`${config.apiUrl}/${storeCode}/import/${input.type}`, formData, {
-            headers: {
-                "X-AUTH-TOKEN": config.apiToken,
-                ...formData.getHeaders(),
-            },
-        });
-        return response.data;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_import_create");
-    }
-}
-export async function importList(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.importId)
-        params.append("importId", input.importId);
-    if (input.type)
-        params.append("type", input.type);
-    const queryString = params.toString();
-    const url = `/${storeCode}/import${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_import_list");
-    }
-}
-export async function importGet(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));
-    const queryString = params.toString();
-    const url = `/${storeCode}/import/${input.importId}${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_import_get");
-    }
-}
-// Tool definitions
-export const importToolDefinitions = [
-    {
-        name: "ol_import_create",
-        title: "Create Bulk Import",
-        description: "Create a new bulk import from file content (CSV or XML). Returns importId for async tracking. " +
-            "Import types: member (member data - typically XML), groupValue (group values), segmentMembers (segment membership), " +
-            "unitTransferAdding (add points), unitTransferSpending (spend points), transaction (transactions), " +
-            "campaignCode (campaign codes), rewardCoupon (reward coupons). " +
-            "Provide plain text file content (CSV or XML). Format is auto-detected from content or fileName extension.",
-        readOnly: false,
-        inputSchema: ImportCreateInputSchema,
-        handler: importCreate,
-    },
-    {
-        name: "ol_import_list",
-        title: "List Imports",
-        description: "List imports with optional filtering. Returns paginated list of imports with importId, type, uploadedDate, fileName, and status information.",
-        readOnly: true,
-        inputSchema: ImportListInputSchema,
-        handler: importList,
-    },
-    {
-        name: "ol_import_get",
-        title: "Get Import Details",
-        description: "Get import details and individual item statuses. Returns paginated list of import items with their success/failure status and error messages.",
-        readOnly: true,
-        inputSchema: ImportGetInputSchema,
-        handler: importGet,
-    },
-];

package/dist/tools/role.d.ts

@@ -1,180 +0,0 @@
-import { z } from "zod";
-import { Role, RoleListItem, ACLResource } from "../types/schemas/role.js";
-interface RolePermissionInput {
-    resource: string;
-    access: string;
-    filterQuery?: string;
-}
-export declare const RoleListInputSchema: {
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    name: z.ZodOptional<z.ZodString>;
-    master: z.ZodOptional<z.ZodBoolean>;
-    default: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const RoleCreateInputSchema: {
-    name: z.ZodString;
-    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        resource: z.ZodString;
-        access: z.ZodString;
-        filterQuery: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        resource: string;
-        access: string;
-        filterQuery?: string | undefined;
-    }, {
-        resource: string;
-        access: string;
-        filterQuery?: string | undefined;
-    }>, "many">>;
-    stores: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    default: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const RoleGetInputSchema: {
-    roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-};
-export declare const RoleUpdateInputSchema: {
-    roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-    name: z.ZodOptional<z.ZodString>;
-    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        resource: z.ZodString;
-        access: z.ZodString;
-        filterQuery: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        resource: string;
-        access: string;
-        filterQuery?: string | undefined;
-    }, {
-        resource: string;
-        access: string;
-        filterQuery?: string | undefined;
-    }>, "many">>;
-    stores: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    default: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const RoleDeleteInputSchema: {
-    roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-};
-export declare function roleList(input: {
-    page?: number;
-    perPage?: number;
-    name?: string;
-    master?: boolean;
-    default?: boolean;
-}): Promise<{
-    items: RoleListItem[];
-    total?: Record<string, unknown>;
-}>;
-export declare function roleCreate(input: {
-    name: string;
-    permissions?: RolePermissionInput[];
-    stores?: string[];
-    default?: boolean;
-}): Promise<void>;
-export declare function roleGet(input: {
-    roleId: string | number;
-}): Promise<Role>;
-export declare function roleUpdate(input: {
-    roleId: string | number;
-    name?: string;
-    permissions?: RolePermissionInput[];
-    stores?: string[];
-    default?: boolean;
-}): Promise<void>;
-export declare function roleDelete(input: {
-    roleId: string | number;
-}): Promise<void>;
-export declare function aclGetResources(): Promise<{
-    items: ACLResource[];
-    total?: Record<string, unknown>;
-}>;
-export declare const roleToolDefinitions: readonly [{
-    readonly name: "ol_role_list";
-    readonly title: "List Roles";
-    readonly description: "List all roles with optional filtering. Returns paginated list of roles with id, name, permissions, master status, and default status.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        name: z.ZodOptional<z.ZodString>;
-        master: z.ZodOptional<z.ZodBoolean>;
-        default: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof roleList;
-}, {
-    readonly name: "ol_role_create";
-    readonly title: "Create Role";
-    readonly description: "Create a new role with permissions. Requires name. Optionally specify permissions (array of {resource, access, filterQuery}) and stores. Returns void on success (201 Created).";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        name: z.ZodString;
-        permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            resource: z.ZodString;
-            access: z.ZodString;
-            filterQuery: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            resource: string;
-            access: string;
-            filterQuery?: string | undefined;
-        }, {
-            resource: string;
-            access: string;
-            filterQuery?: string | undefined;
-        }>, "many">>;
-        stores: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        default: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof roleCreate;
-}, {
-    readonly name: "ol_role_get";
-    readonly title: "Get Role Details";
-    readonly description: "Get full role details by ID. Returns role with name, permissions array, master status, default status, and stores.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-    };
-    readonly handler: typeof roleGet;
-}, {
-    readonly name: "ol_role_update";
-    readonly title: "Update Role";
-    readonly description: "Update a role's name, permissions, or stores. Returns void on success (204 No Content).";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-        name: z.ZodOptional<z.ZodString>;
-        permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            resource: z.ZodString;
-            access: z.ZodString;
-            filterQuery: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            resource: string;
-            access: string;
-            filterQuery?: string | undefined;
-        }, {
-            resource: string;
-            access: string;
-            filterQuery?: string | undefined;
-        }>, "many">>;
-        stores: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        default: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof roleUpdate;
-}, {
-    readonly name: "ol_role_delete";
-    readonly title: "Delete Role (Permanent)";
-    readonly description: "Delete a role by ID. Returns void on success (204 No Content). Cannot delete roles that are assigned to admin users.";
-    readonly readOnly: false;
-    readonly destructive: true;
-    readonly inputSchema: {
-        roleId: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-    };
-    readonly handler: typeof roleDelete;
-}, {
-    readonly name: "ol_acl_get_resources";
-    readonly title: "Get ACL Resources";
-    readonly description: "Get list of available ACL resources. Returns items with code and name for each resource type. Use this to discover available permissions before creating roles.";
-    readonly readOnly: true;
-    readonly inputSchema: {};
-    readonly handler: typeof aclGetResources;
-}];
-export {};

package/dist/tools/role.js

@@ -1,173 +0,0 @@
-import { z } from "zod";
-import { apiGet, apiPost, apiPut, apiDelete } from "../client/http.js";
-import { formatApiError } from "../utils/errors.js";
-// Input Schemas
-export const RoleListInputSchema = {
-    page: z.number().optional().describe("Page number (default: 1)."),
-    perPage: z.number().optional().describe("Items per page (default: 25)."),
-    name: z.string().optional().describe("Filter by role name."),
-    master: z.boolean().optional().describe("Filter by master role status."),
-    default: z.boolean().optional().describe("Filter by default role status."),
-};
-export const RoleCreateInputSchema = {
-    name: z.string().describe("Role name (required)."),
-    permissions: z.array(z.object({
-        resource: z.string().describe("Resource name (e.g., ANALYTICS, EVENTS)."),
-        access: z.string().describe("Access level (e.g., VIEW, MODIFY)."),
-        filterQuery: z.string().optional().describe("Optional filter query."),
-    })).optional().describe("Array of permission definitions."),
-    stores: z.array(z.string()).optional().describe("Store codes to assign access (e.g., ['DEFAULT'])."),
-    default: z.boolean().optional().describe("Whether this is a default role for new admins."),
-};
-export const RoleGetInputSchema = {
-    roleId: z.union([z.string(), z.number()]).describe("The role ID to retrieve."),
-};
-export const RoleUpdateInputSchema = {
-    roleId: z.union([z.string(), z.number()]).describe("The role ID to update."),
-    name: z.string().optional().describe("Role name."),
-    permissions: z.array(z.object({
-        resource: z.string().describe("Resource name."),
-        access: z.string().describe("Access level."),
-        filterQuery: z.string().optional().describe("Optional filter query."),
-    })).optional().describe("Array of permission definitions."),
-    stores: z.array(z.string()).optional().describe("Store codes to assign access."),
-    default: z.boolean().optional().describe("Whether this is a default role."),
-};
-export const RoleDeleteInputSchema = {
-    roleId: z.union([z.string(), z.number()]).describe("The role ID to delete."),
-};
-// Handler functions
-export async function roleList(input) {
-    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.master !== undefined)
-        params.append("master", String(input.master));
-    if (input.default !== undefined)
-        params.append("default", String(input.default));
-    const queryString = params.toString();
-    const url = `/acl/role${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_role_list");
-    }
-}
-export async function roleCreate(input) {
-    const payload = {
-        name: input.name,
-    };
-    if (input.permissions)
-        payload.permissions = input.permissions;
-    if (input.stores)
-        payload.stores = input.stores;
-    if (input.default !== undefined)
-        payload.default = input.default;
-    try {
-        await apiPost("/acl/role", { role: payload });
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_role_create");
-    }
-}
-export async function roleGet(input) {
-    try {
-        const response = await apiGet(`/acl/role/${input.roleId}`);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_role_get");
-    }
-}
-export async function roleUpdate(input) {
-    const payload = {};
-    if (input.name)
-        payload.name = input.name;
-    if (input.permissions)
-        payload.permissions = input.permissions;
-    if (input.stores)
-        payload.stores = input.stores;
-    if (input.default !== undefined)
-        payload.default = input.default;
-    try {
-        await apiPut(`/acl/role/${input.roleId}`, { role: payload });
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_role_update");
-    }
-}
-export async function roleDelete(input) {
-    try {
-        await apiDelete(`/acl/role/${input.roleId}`);
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_role_delete");
-    }
-}
-export async function aclGetResources() {
-    try {
-        const response = await apiGet("/acl/resources");
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_acl_get_resources");
-    }
-}
-// Tool definitions
-export const roleToolDefinitions = [
-    {
-        name: "ol_role_list",
-        title: "List Roles",
-        description: "List all roles with optional filtering. Returns paginated list of roles with id, name, permissions, master status, and default status.",
-        readOnly: true,
-        inputSchema: RoleListInputSchema,
-        handler: roleList,
-    },
-    {
-        name: "ol_role_create",
-        title: "Create Role",
-        description: "Create a new role with permissions. Requires name. Optionally specify permissions (array of {resource, access, filterQuery}) and stores. Returns void on success (201 Created).",
-        readOnly: false,
-        inputSchema: RoleCreateInputSchema,
-        handler: roleCreate,
-    },
-    {
-        name: "ol_role_get",
-        title: "Get Role Details",
-        description: "Get full role details by ID. Returns role with name, permissions array, master status, default status, and stores.",
-        readOnly: true,
-        inputSchema: RoleGetInputSchema,
-        handler: roleGet,
-    },
-    {
-        name: "ol_role_update",
-        title: "Update Role",
-        description: "Update a role's name, permissions, or stores. Returns void on success (204 No Content).",
-        readOnly: false,
-        inputSchema: RoleUpdateInputSchema,
-        handler: roleUpdate,
-    },
-    {
-        name: "ol_role_delete",
-        title: "Delete Role (Permanent)",
-        description: "Delete a role by ID. Returns void on success (204 No Content). Cannot delete roles that are assigned to admin users.",
-        readOnly: false,
-        destructive: true,
-        inputSchema: RoleDeleteInputSchema,
-        handler: roleDelete,
-    },
-    {
-        name: "ol_acl_get_resources",
-        title: "Get ACL Resources",
-        description: "Get list of available ACL resources. Returns items with code and name for each resource type. Use this to discover available permissions before creating roles.",
-        readOnly: true,
-        inputSchema: {},
-        handler: aclGetResources,
-    },
-];

package/dist/tools/store.d.ts

@@ -1,109 +0,0 @@
-import { z } from "zod";
-export interface Store {
-    storeId: string;
-    code: string;
-    currency: string;
-    name: string;
-    active: boolean;
-    createdBy?: string;
-    createdAt?: string;
-    updatedBy?: string;
-    updatedAt?: string;
-}
-export interface StoreListResponse {
-    items: Store[];
-    total?: Record<string, unknown>;
-}
-export declare const StoreListInputSchema: {
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    active: z.ZodOptional<z.ZodBoolean>;
-    name: z.ZodOptional<z.ZodString>;
-    code: z.ZodOptional<z.ZodString>;
-};
-export declare const StoreCreateInputSchema: {
-    code: z.ZodString;
-    name: z.ZodString;
-    currency: z.ZodOptional<z.ZodString>;
-    active: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const StoreGetInputSchema: {
-    storeId: z.ZodString;
-};
-export declare const StoreUpdateInputSchema: {
-    storeId: z.ZodString;
-    name: z.ZodOptional<z.ZodString>;
-    active: z.ZodOptional<z.ZodBoolean>;
-    currency: z.ZodOptional<z.ZodString>;
-};
-export declare function storeList(input: {
-    page?: number;
-    perPage?: number;
-    active?: boolean;
-    name?: string;
-    code?: string;
-}): Promise<StoreListResponse>;
-export declare function storeCreate(input: {
-    code: string;
-    name: string;
-    currency?: string;
-    active?: boolean;
-}): Promise<{
-    storeId: string;
-}>;
-export declare function storeGet(input: {
-    storeId: string;
-}): Promise<Store>;
-export declare function storeUpdate(input: {
-    storeId: string;
-    name?: string;
-    active?: boolean;
-    currency?: string;
-}): Promise<void>;
-export declare const storeToolDefinitions: readonly [{
-    readonly name: "ol_store_list";
-    readonly title: "List Stores";
-    readonly description: "List all stores with optional filtering. Returns paginated list of stores with storeId, code, name, currency, and active status. Stores enable multi-tenant loyalty programs. Each store has independent members, campaigns, and settings.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        active: z.ZodOptional<z.ZodBoolean>;
-        name: z.ZodOptional<z.ZodString>;
-        code: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof storeList;
-}, {
-    readonly name: "ol_store_create";
-    readonly title: "Create Store";
-    readonly description: "Create a new store for multi-tenant setup. Requires unique code and name. Returns storeId on success.";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        code: z.ZodString;
-        name: z.ZodString;
-        currency: z.ZodOptional<z.ZodString>;
-        active: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof storeCreate;
-}, {
-    readonly name: "ol_store_get";
-    readonly title: "Get Store Details";
-    readonly description: "Get full store configuration by ID. Returns storeId, code, name, currency, active status, and timestamps.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeId: z.ZodString;
-    };
-    readonly handler: typeof storeGet;
-}, {
-    readonly name: "ol_store_update";
-    readonly title: "Update Store";
-    readonly description: "Update store configuration. Can update name, currency, and active status. Returns void on success (204 No Content).";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        storeId: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        active: z.ZodOptional<z.ZodBoolean>;
-        currency: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof storeUpdate;
-}];