@open-loyalty/mcp-server 1.5.3 → 1.7.0

package/dist/tools/admin.d.ts

@@ -1,165 +0,0 @@
-import { z } from "zod";
-import { AdminUser, AdminUserListItem, AdminPermission } from "../types/schemas/admin.js";
-export declare const AdminListInputSchema: {
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    email: z.ZodOptional<z.ZodString>;
-    isActive: z.ZodOptional<z.ZodBoolean>;
-    firstName: z.ZodOptional<z.ZodString>;
-    lastName: z.ZodOptional<z.ZodString>;
-    role: z.ZodOptional<z.ZodString>;
-};
-export declare const AdminCreateInputSchema: {
-    email: z.ZodString;
-    password: z.ZodString;
-    firstName: z.ZodOptional<z.ZodString>;
-    lastName: z.ZodOptional<z.ZodString>;
-    phone: z.ZodOptional<z.ZodString>;
-    roles: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
-    isActive: z.ZodOptional<z.ZodBoolean>;
-    external: z.ZodOptional<z.ZodBoolean>;
-    notificationsEnabled: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const AdminGetInputSchema: {
-    adminId: z.ZodString;
-};
-export declare const AdminUpdateInputSchema: {
-    adminId: z.ZodString;
-    email: z.ZodOptional<z.ZodString>;
-    firstName: z.ZodOptional<z.ZodString>;
-    lastName: z.ZodOptional<z.ZodString>;
-    phone: z.ZodOptional<z.ZodString>;
-    roles: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
-    isActive: z.ZodOptional<z.ZodBoolean>;
-    external: z.ZodOptional<z.ZodBoolean>;
-    notificationsEnabled: z.ZodOptional<z.ZodBoolean>;
-    password: z.ZodOptional<z.ZodString>;
-};
-export declare const AdminChangePasswordInputSchema: {
-    currentPassword: z.ZodString;
-    newPassword: z.ZodString;
-};
-export declare function adminList(input: {
-    page?: number;
-    perPage?: number;
-    email?: string;
-    isActive?: boolean;
-    firstName?: string;
-    lastName?: string;
-    role?: string;
-}): Promise<{
-    items: AdminUserListItem[];
-    total?: number;
-}>;
-export declare function adminCreate(input: {
-    email: string;
-    password: string;
-    firstName?: string;
-    lastName?: string;
-    phone?: string;
-    roles?: (string | number)[];
-    isActive?: boolean;
-    external?: boolean;
-    notificationsEnabled?: boolean;
-}): Promise<{
-    adminId: string;
-}>;
-export declare function adminGet(input: {
-    adminId: string;
-}): Promise<AdminUser>;
-export declare function adminUpdate(input: {
-    adminId: string;
-    email?: string;
-    firstName?: string;
-    lastName?: string;
-    phone?: string;
-    roles?: (string | number)[];
-    isActive?: boolean;
-    external?: boolean;
-    notificationsEnabled?: boolean;
-    password?: string;
-}): Promise<{
-    adminId: string;
-}>;
-export declare function adminChangePassword(input: {
-    currentPassword: string;
-    newPassword: string;
-}): Promise<void>;
-export declare function adminGetPermissions(): Promise<AdminPermission>;
-export declare const adminToolDefinitions: readonly [{
-    readonly name: "ol_admin_list";
-    readonly title: "List Admin Users";
-    readonly description: "List admin users with optional filtering. Returns paginated list of admin users with id, email, firstName, lastName, isActive, createdAt.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        email: z.ZodOptional<z.ZodString>;
-        isActive: z.ZodOptional<z.ZodBoolean>;
-        firstName: z.ZodOptional<z.ZodString>;
-        lastName: z.ZodOptional<z.ZodString>;
-        role: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof adminList;
-}, {
-    readonly name: "ol_admin_create";
-    readonly title: "Create Admin User";
-    readonly description: "Create a new admin user. Requires email and password. Optionally assign roles, set active status, and configure notifications. Returns adminId.";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        email: z.ZodString;
-        password: z.ZodString;
-        firstName: z.ZodOptional<z.ZodString>;
-        lastName: z.ZodOptional<z.ZodString>;
-        phone: z.ZodOptional<z.ZodString>;
-        roles: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
-        isActive: z.ZodOptional<z.ZodBoolean>;
-        external: z.ZodOptional<z.ZodBoolean>;
-        notificationsEnabled: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof adminCreate;
-}, {
-    readonly name: "ol_admin_get";
-    readonly title: "Get Admin User Details";
-    readonly description: "Get full admin user details by ID. Returns profile including email, name, roles, settings, active status, and creation date.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        adminId: z.ZodString;
-    };
-    readonly handler: typeof adminGet;
-}, {
-    readonly name: "ol_admin_update";
-    readonly title: "Update Admin User";
-    readonly description: "Update admin user profile. Can update email, name, phone, roles, active status, and password. Returns adminId on success.";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        adminId: z.ZodString;
-        email: z.ZodOptional<z.ZodString>;
-        firstName: z.ZodOptional<z.ZodString>;
-        lastName: z.ZodOptional<z.ZodString>;
-        phone: z.ZodOptional<z.ZodString>;
-        roles: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
-        isActive: z.ZodOptional<z.ZodBoolean>;
-        external: z.ZodOptional<z.ZodBoolean>;
-        notificationsEnabled: z.ZodOptional<z.ZodBoolean>;
-        password: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof adminUpdate;
-}, {
-    readonly name: "ol_admin_change_password";
-    readonly title: "Change Admin Password";
-    readonly description: "Change the currently logged-in admin's password. Requires current password for verification. Returns void on success.";
-    readonly readOnly: false;
-    readonly inputSchema: {
-        currentPassword: z.ZodString;
-        newPassword: z.ZodString;
-    };
-    readonly handler: typeof adminChangePassword;
-}, {
-    readonly name: "ol_admin_get_permissions";
-    readonly title: "Get Admin Permissions";
-    readonly description: "Get the current admin user's permissions. Returns superAdmin flag, list of roles, and list of permission strings. Use to check what actions are available.";
-    readonly readOnly: true;
-    readonly inputSchema: {};
-    readonly handler: typeof adminGetPermissions;
-}];

package/dist/tools/admin.js

@@ -1,205 +0,0 @@
-import { z } from "zod";
-import { apiGet, apiPost, apiPut } from "../client/http.js";
-import { formatApiError } from "../utils/errors.js";
-// Input Schemas
-export const AdminListInputSchema = {
-    page: z.number().optional().describe("Page number (default: 1)."),
-    perPage: z.number().optional().describe("Items per page (default: 25)."),
-    email: z.string().optional().describe("Filter by email address."),
-    isActive: z.boolean().optional().describe("Filter by active status."),
-    firstName: z.string().optional().describe("Filter by first name."),
-    lastName: z.string().optional().describe("Filter by last name."),
-    role: z.string().optional().describe("Filter by role."),
-};
-export const AdminCreateInputSchema = {
-    email: z.string().describe("Admin email address (required)."),
-    password: z.string().describe("Admin password (required)."),
-    firstName: z.string().optional().describe("Admin first name."),
-    lastName: z.string().optional().describe("Admin last name."),
-    phone: z.string().optional().describe("Admin phone number."),
-    roles: z.array(z.union([z.string(), z.number()])).optional().describe("Role IDs to assign."),
-    isActive: z.boolean().optional().describe("Whether account is active (default: true)."),
-    external: z.boolean().optional().describe("Whether admin is external."),
-    notificationsEnabled: z.boolean().optional().describe("Whether notifications are enabled."),
-};
-export const AdminGetInputSchema = {
-    adminId: z.string().describe("The admin ID (UUID) to retrieve."),
-};
-export const AdminUpdateInputSchema = {
-    adminId: z.string().describe("The admin ID (UUID) to update."),
-    email: z.string().optional().describe("Admin email address."),
-    firstName: z.string().optional().describe("Admin first name."),
-    lastName: z.string().optional().describe("Admin last name."),
-    phone: z.string().optional().describe("Admin phone number."),
-    roles: z.array(z.union([z.string(), z.number()])).optional().describe("Role IDs to assign."),
-    isActive: z.boolean().optional().describe("Whether account is active."),
-    external: z.boolean().optional().describe("Whether admin is external."),
-    notificationsEnabled: z.boolean().optional().describe("Whether notifications are enabled."),
-    password: z.string().optional().describe("New password (if changing)."),
-};
-export const AdminChangePasswordInputSchema = {
-    currentPassword: z.string().describe("Current password."),
-    newPassword: z.string().describe("New password."),
-};
-// Handler functions
-export async function adminList(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.email)
-        params.append("email", input.email);
-    if (input.isActive !== undefined)
-        params.append("isActive", String(input.isActive));
-    if (input.firstName)
-        params.append("firstName", input.firstName);
-    if (input.lastName)
-        params.append("lastName", input.lastName);
-    if (input.role)
-        params.append("role", input.role);
-    const queryString = params.toString();
-    const url = `/admin${queryString ? `?${queryString}` : ""}`;
-    try {
-        const response = await apiGet(url);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_list");
-    }
-}
-export async function adminCreate(input) {
-    const payload = {
-        email: input.email,
-        plainPassword: input.password,
-    };
-    if (input.firstName)
-        payload.firstName = input.firstName;
-    if (input.lastName)
-        payload.lastName = input.lastName;
-    if (input.phone)
-        payload.phone = input.phone;
-    if (input.roles)
-        payload.roles = input.roles;
-    if (input.isActive !== undefined)
-        payload.isActive = input.isActive;
-    if (input.external !== undefined)
-        payload.external = input.external;
-    if (input.notificationsEnabled !== undefined)
-        payload.notificationsEnabled = input.notificationsEnabled;
-    try {
-        const response = await apiPost("/admin/data", { admin: payload });
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_create");
-    }
-}
-export async function adminGet(input) {
-    try {
-        const response = await apiGet(`/admin/data/${input.adminId}`);
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_get");
-    }
-}
-export async function adminUpdate(input) {
-    const payload = {};
-    if (input.email)
-        payload.email = input.email;
-    if (input.firstName)
-        payload.firstName = input.firstName;
-    if (input.lastName)
-        payload.lastName = input.lastName;
-    if (input.phone)
-        payload.phone = input.phone;
-    if (input.roles)
-        payload.roles = input.roles;
-    if (input.isActive !== undefined)
-        payload.isActive = input.isActive;
-    if (input.external !== undefined)
-        payload.external = input.external;
-    if (input.notificationsEnabled !== undefined)
-        payload.notificationsEnabled = input.notificationsEnabled;
-    if (input.password)
-        payload.plainPassword = input.password;
-    try {
-        const response = await apiPut(`/admin/data/${input.adminId}`, { admin: payload });
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_update");
-    }
-}
-export async function adminChangePassword(input) {
-    try {
-        await apiPut("/admin/password", {
-            currentPassword: input.currentPassword,
-            plainPassword: input.newPassword,
-        });
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_change_password");
-    }
-}
-export async function adminGetPermissions() {
-    try {
-        const response = await apiGet("/admin/permissions");
-        return response;
-    }
-    catch (error) {
-        throw formatApiError(error, "ol_admin_get_permissions");
-    }
-}
-// Tool definitions
-export const adminToolDefinitions = [
-    {
-        name: "ol_admin_list",
-        title: "List Admin Users",
-        description: "List admin users with optional filtering. Returns paginated list of admin users with id, email, firstName, lastName, isActive, createdAt.",
-        readOnly: true,
-        inputSchema: AdminListInputSchema,
-        handler: adminList,
-    },
-    {
-        name: "ol_admin_create",
-        title: "Create Admin User",
-        description: "Create a new admin user. Requires email and password. Optionally assign roles, set active status, and configure notifications. Returns adminId.",
-        readOnly: false,
-        inputSchema: AdminCreateInputSchema,
-        handler: adminCreate,
-    },
-    {
-        name: "ol_admin_get",
-        title: "Get Admin User Details",
-        description: "Get full admin user details by ID. Returns profile including email, name, roles, settings, active status, and creation date.",
-        readOnly: true,
-        inputSchema: AdminGetInputSchema,
-        handler: adminGet,
-    },
-    {
-        name: "ol_admin_update",
-        title: "Update Admin User",
-        description: "Update admin user profile. Can update email, name, phone, roles, active status, and password. Returns adminId on success.",
-        readOnly: false,
-        inputSchema: AdminUpdateInputSchema,
-        handler: adminUpdate,
-    },
-    {
-        name: "ol_admin_change_password",
-        title: "Change Admin Password",
-        description: "Change the currently logged-in admin's password. Requires current password for verification. Returns void on success.",
-        readOnly: false,
-        inputSchema: AdminChangePasswordInputSchema,
-        handler: adminChangePassword,
-    },
-    {
-        name: "ol_admin_get_permissions",
-        title: "Get Admin Permissions",
-        description: "Get the current admin user's permissions. Returns superAdmin flag, list of roles, and list of permission strings. Use to check what actions are available.",
-        readOnly: true,
-        inputSchema: {},
-        handler: adminGetPermissions,
-    },
-];

package/dist/tools/analytics.d.ts

@@ -1,180 +0,0 @@
-import { z } from "zod";
-import { TierAnalytics, MemberAnalytics, PointsAnalytics, TransactionAnalytics, ReferralAnalytics, CampaignAnalytics, DashboardOverview, UnitsOverview } from "../types/schemas/analytics.js";
-export declare const AnalyticsTiersInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsMembersInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    withTransaction: z.ZodOptional<z.ZodBoolean>;
-};
-export declare const AnalyticsPointsInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsTransactionsInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsReferralsInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsCampaignsInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    page: z.ZodOptional<z.ZodNumber>;
-    perPage: z.ZodOptional<z.ZodNumber>;
-    executedAt: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsDashboardInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    dataType: z.ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions"]>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
-    intervalStartDate: z.ZodOptional<z.ZodString>;
-    intervalEndDate: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsUnitsInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    walletTypeCode: z.ZodString;
-    dataType: z.ZodOptional<z.ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive"]>>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
-    intervalStartDate: z.ZodOptional<z.ZodString>;
-    intervalEndDate: z.ZodOptional<z.ZodString>;
-};
-export declare const AnalyticsCampaignDetailInputSchema: {
-    storeCode: z.ZodOptional<z.ZodString>;
-    campaignId: z.ZodString;
-};
-export declare function analyticsTiers(input: {
-    storeCode?: string;
-}): Promise<TierAnalytics>;
-export declare function analyticsMembers(input: {
-    storeCode?: string;
-    withTransaction?: boolean;
-}): Promise<MemberAnalytics>;
-export declare function analyticsPoints(input: {
-    storeCode?: string;
-}): Promise<PointsAnalytics>;
-export declare function analyticsTransactions(input: {
-    storeCode?: string;
-}): Promise<TransactionAnalytics>;
-export declare function analyticsReferrals(input: {
-    storeCode?: string;
-}): Promise<ReferralAnalytics>;
-export declare function analyticsCampaigns(input: {
-    storeCode?: string;
-    page?: number;
-    perPage?: number;
-    executedAt?: string;
-}): Promise<CampaignAnalytics>;
-export declare function analyticsDashboard(input: {
-    storeCode?: string;
-    dataType?: string;
-    aggregationType?: string;
-    intervalStartDate?: string;
-    intervalEndDate?: string;
-}): Promise<DashboardOverview>;
-export declare function analyticsUnits(input: {
-    storeCode?: string;
-    walletTypeCode: string;
-    dataType?: string;
-    aggregationType?: string;
-    intervalStartDate?: string;
-    intervalEndDate?: string;
-}): Promise<UnitsOverview>;
-export declare function analyticsCampaignDetail(input: {
-    storeCode?: string;
-    campaignId: string;
-}): Promise<Record<string, unknown>>;
-export declare const analyticsToolDefinitions: readonly [{
-    readonly name: "ol_analytics_tiers";
-    readonly title: "Get Tier Analytics";
-    readonly description: "Get tier (level) analytics showing member distribution across tiers. Returns tier IDs, names, and member counts for each tier level.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsTiers;
-}, {
-    readonly name: "ol_analytics_members";
-    readonly title: "Get Member Analytics";
-    readonly description: "Get member analytics showing registration trends. Returns member counts by time intervals (1 day, 7 days, 30 days, 365 days). Filter by transaction status to see engaged vs unengaged members.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        withTransaction: z.ZodOptional<z.ZodBoolean>;
-    };
-    readonly handler: typeof analyticsMembers;
-}, {
-    readonly name: "ol_analytics_points";
-    readonly title: "Get Points Analytics";
-    readonly description: "Get points analytics showing program health. Returns total active points, points spent, points issued, expired points, and pending points. Use to monitor points economy.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsPoints;
-}, {
-    readonly name: "ol_analytics_transactions";
-    readonly title: "Get Transaction Analytics";
-    readonly description: "Get transaction analytics showing purchase trends. Returns transaction counts by intervals, total count, total amount, and average values. Use to monitor sales performance.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsTransactions;
-}, {
-    readonly name: "ol_analytics_referrals";
-    readonly title: "Get Referral Analytics";
-    readonly description: "Get referral program analytics showing referral activity. Returns total referral count. Use to monitor referral program performance.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsReferrals;
-}, {
-    readonly name: "ol_analytics_campaigns";
-    readonly title: "Get Campaign Analytics";
-    readonly description: "Get campaign analytics showing execution counts per campaign. Returns list of campaigns with their execution counts. Use to identify most successful campaigns.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        page: z.ZodOptional<z.ZodNumber>;
-        perPage: z.ZodOptional<z.ZodNumber>;
-        executedAt: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsCampaigns;
-}, {
-    readonly name: "ol_analytics_dashboard";
-    readonly title: "Get Dashboard Overview";
-    readonly description: "Get dashboard overview metrics with time-series data. Returns key metrics (registered members, active members, revenue, avg spending, transactions) with optional date range and aggregation. Use for high-level program dashboards.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        dataType: z.ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions"]>;
-        aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
-        intervalStartDate: z.ZodOptional<z.ZodString>;
-        intervalEndDate: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsDashboard;
-}, {
-    readonly name: "ol_analytics_units";
-    readonly title: "Get Units Overview";
-    readonly description: "Get wallet-specific analytics (units overview). Returns units issued, spent, expired, pending, active, plus redemption and breakage rates. Requires walletTypeCode parameter. Use for detailed points economy analysis.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        walletTypeCode: z.ZodString;
-        dataType: z.ZodOptional<z.ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive"]>>;
-        aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
-        intervalStartDate: z.ZodOptional<z.ZodString>;
-        intervalEndDate: z.ZodOptional<z.ZodString>;
-    };
-    readonly handler: typeof analyticsUnits;
-}, {
-    readonly name: "ol_analytics_campaign_detail";
-    readonly title: "Get Campaign Detail Analytics";
-    readonly description: "Get detailed analytics for a specific campaign. Returns campaign-specific performance metrics. Use after analytics_campaigns to drill into individual campaign performance.";
-    readonly readOnly: true;
-    readonly inputSchema: {
-        storeCode: z.ZodOptional<z.ZodString>;
-        campaignId: z.ZodString;
-    };
-    readonly handler: typeof analyticsCampaignDetail;
-}];