@open-loyalty/mcp-server 1.0.0

package/dist/types/schemas/achievement.js

@@ -0,0 +1,172 @@
+import { z } from "zod";
+import { TranslationsSchema } from "./common.js";
+/**
+ * Achievement Trigger Enum.
+ * Defines what events can trigger progress on an achievement.
+ */
+export const AchievementTriggerEnum = z.enum([
+    "transaction",
+    "custom_event",
+    "points_transfer",
+    "reward_redemption",
+    "referral",
+    "achievement",
+    "tier_change",
+    "registration",
+    "profile_update",
+    "login",
+]);
+/**
+ * Achievement Period Type Enum.
+ * Defines the time period for achievement completion rules.
+ */
+export const AchievementPeriodTypeEnum = z.enum([
+    "day",
+    "week",
+    "month",
+    "year",
+    "forever",
+    "calendarDays",
+    "calendarWeeks",
+    "calendarMonths",
+    "calendarYears",
+]);
+/**
+ * Achievement Period Schema.
+ * Defines the period for tracking achievement progress.
+ */
+export const AchievementPeriodSchema = z.object({
+    consecutive: z.number().optional().describe("Number of consecutive periods required."),
+    value: z.number().optional().describe("Period value (e.g., 30 for 30 days)."),
+});
+/**
+ * Achievement Complete Rule Schema.
+ * Defines when an achievement is considered complete.
+ */
+export const AchievementCompleteRuleSchema = z.object({
+    periodGoal: z.union([z.number(), z.string()]).describe("Goal value to reach within the period."),
+    period: AchievementPeriodSchema.optional().describe("Period configuration."),
+    uniqueAttribute: z.string().optional().describe("Attribute for unique counting (e.g., count unique SKUs)."),
+});
+/**
+ * Achievement Aggregation Schema.
+ * Defines how to aggregate values for achievement progress.
+ */
+export const AchievementAggregationSchema = z.object({
+    rule: z.string().optional().describe("Aggregation rule expression."),
+});
+/**
+ * Achievement Limit Interval Schema.
+ * Defines the time interval for achievement limits.
+ */
+export const AchievementLimitIntervalSchema = z.object({
+    type: z.string().describe("Interval type (e.g., 'calendarYears', 'days')."),
+    value: z.number().optional().describe("Interval value."),
+});
+/**
+ * Achievement Limit Schema.
+ * Defines limits on achievement completions.
+ */
+export const AchievementLimitSchema = z.object({
+    value: z.number().optional().describe("Maximum completions."),
+    interval: AchievementLimitIntervalSchema.optional().describe("Time interval for the limit."),
+});
+/**
+ * Achievement Rule Schema.
+ * Defines a rule for how to track and complete an achievement.
+ */
+export const AchievementRuleSchema = z.object({
+    achievementRuleId: z.string().optional().describe("Rule ID (generated on creation)."),
+    translations: TranslationsSchema.optional().describe("Rule name and description translations."),
+    trigger: z.string().optional().describe("Event type that triggers rule progress."),
+    type: z.string().optional().describe("Rule type."),
+    event: z.string().optional().describe("Custom event code for custom_event trigger."),
+    completeRule: AchievementCompleteRuleSchema.describe("Completion goal configuration."),
+    aggregation: AchievementAggregationSchema.optional().describe("Value aggregation configuration."),
+    conditions: z.array(z.record(z.unknown())).optional().describe("Conditions that must be met."),
+    limit: AchievementLimitSchema.optional().describe("Per-rule limit configuration."),
+    uniqueReferee: z.boolean().optional().describe("Whether referee must be unique for referral achievements."),
+});
+/**
+ * Achievement Activity Schema.
+ * Defines when an achievement is active.
+ */
+export const AchievementActivitySchema = z.object({
+    startsAt: z.string().optional().describe("ISO datetime when achievement becomes active."),
+    endsAt: z.string().optional().describe("ISO datetime when achievement ends."),
+    data: z.string().optional().describe("Activity data for condition-based activity."),
+    operator: z.string().optional().describe("Operator for activity condition (is_greater, is_before, etc.)."),
+});
+/**
+ * Main Achievement Schema.
+ * Represents a complete achievement with all configuration.
+ */
+export const AchievementSchema = z.object({
+    achievementId: z.string().describe("Achievement ID (UUID)."),
+    translations: TranslationsSchema.describe("Achievement name and description translations."),
+    active: z.boolean().describe("Whether achievement is active."),
+    activity: AchievementActivitySchema.optional().describe("Time period when achievement is active."),
+    limit: AchievementLimitSchema.optional().describe("Overall achievement limit configuration."),
+    rules: z.array(AchievementRuleSchema).describe("Achievement rules defining completion criteria."),
+    badgeTypeId: z.string().optional().describe("Badge type awarded upon completion."),
+    createdAt: z.string().optional().describe("Creation timestamp."),
+    completionsCount: z.number().optional().describe("Number of completions across all members."),
+});
+/**
+ * Achievement List Item Schema.
+ * Simplified representation for list responses.
+ */
+export const AchievementListItemSchema = z.object({
+    achievementId: z.string(),
+    name: z.string().optional(),
+    active: z.boolean(),
+    createdAt: z.string().optional(),
+    badgeTypeId: z.string().optional(),
+});
+/**
+ * Achievement Create Input Schema.
+ * Matches the POST /api/{storeCode}/achievement body structure.
+ * IMPORTANT: Request must be wrapped as { achievement: {...} }
+ */
+export const AchievementCreateInputSchema = z.object({
+    translations: TranslationsSchema.describe("Achievement name and description (at least 'en' required)."),
+    active: z.boolean().optional().describe("Whether achievement is active (default: false)."),
+    activity: AchievementActivitySchema.optional().describe("Time period configuration."),
+    limit: AchievementLimitSchema.optional().describe("Limit configuration."),
+    rules: z.array(AchievementRuleSchema).describe("Achievement rules."),
+    badgeTypeId: z.string().optional().describe("Badge type to award."),
+});
+/**
+ * Achievement Rule Progress Schema.
+ * Tracks a member's progress on a single rule.
+ */
+export const AchievementRuleProgressSchema = z.object({
+    achievementRuleId: z.string().describe("Rule ID."),
+    periodGoal: z.number().describe("Goal value for the period."),
+    currentPeriodValue: z.number().describe("Current progress value."),
+    consecutivePeriods: z.number().optional().describe("Required consecutive periods."),
+    completedConsecutivePeriods: z.number().optional().describe("Completed consecutive periods."),
+    periodType: z.string().optional().describe("Period type."),
+    type: z.string().optional().describe("Rule type."),
+    trigger: z.string().optional().describe("Trigger type."),
+    periodValue: z.number().optional().describe("Period value."),
+});
+/**
+ * Achievement Member Progress Schema.
+ * Tracks a member's overall progress on an achievement.
+ */
+export const AchievementMemberProgressSchema = z.object({
+    completedCount: z.number().describe("Number of times completed."),
+    rules: z.array(AchievementRuleProgressSchema).describe("Progress on each rule."),
+});
+/**
+ * Achievement Progress Schema.
+ * Complete progress data for a member's achievement.
+ */
+export const AchievementProgressSchema = z.object({
+    achievementId: z.string().describe("Achievement ID."),
+    achievementName: z.string().optional().describe("Achievement name."),
+    achievementDescription: z.string().optional().describe("Achievement description."),
+    limitReached: z.boolean().optional().describe("Whether member has reached the limit."),
+    memberProgress: AchievementMemberProgressSchema.describe("Member's progress details."),
+});

package/dist/types/schemas/admin.d.ts

@@ -0,0 +1,263 @@
+import { z } from "zod";
+/**
+ * Admin Role Schema.
+ * Represents a role assigned to an admin user.
+ */
+export declare const AdminRoleSchema: z.ZodObject<{
+    role: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    name: z.ZodOptional<z.ZodString>;
+    master: z.ZodOptional<z.ZodBoolean>;
+    default: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    id?: string | number | undefined;
+    role?: string | undefined;
+    master?: boolean | undefined;
+    default?: boolean | undefined;
+}, {
+    name?: string | undefined;
+    id?: string | number | undefined;
+    role?: string | undefined;
+    master?: boolean | undefined;
+    default?: boolean | undefined;
+}>;
+export type AdminRole = z.infer<typeof AdminRoleSchema>;
+/**
+ * Admin Settings Schema.
+ * User-specific settings for an admin.
+ */
+export declare const AdminSettingsSchema: z.ZodObject<{
+    notificationsEnabled: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
+}, "strip", z.ZodTypeAny, {
+    notificationsEnabled?: string | boolean | undefined;
+}, {
+    notificationsEnabled?: string | boolean | undefined;
+}>;
+export type AdminSettings = z.infer<typeof AdminSettingsSchema>;
+/**
+ * Admin User Schema.
+ * Full admin user profile from GET /api/admin/data/{adminId}
+ */
+export declare const AdminUserSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    adminId: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    firstName: z.ZodOptional<z.ZodString>;
+    lastName: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+    external: z.ZodOptional<z.ZodBoolean>;
+    canChangePassword: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        role: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+        name: z.ZodOptional<z.ZodString>;
+        master: z.ZodOptional<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        id?: string | number | undefined;
+        role?: string | undefined;
+        master?: boolean | undefined;
+        default?: boolean | undefined;
+    }, {
+        name?: string | undefined;
+        id?: string | number | undefined;
+        role?: string | undefined;
+        master?: boolean | undefined;
+        default?: boolean | undefined;
+    }>, "many">>;
+    settings: z.ZodOptional<z.ZodObject<{
+        notificationsEnabled: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
+    }, "strip", z.ZodTypeAny, {
+        notificationsEnabled?: string | boolean | undefined;
+    }, {
+        notificationsEnabled?: string | boolean | undefined;
+    }>>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    dtype: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    createdAt?: string | undefined;
+    id?: string | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    adminId?: string | undefined;
+    username?: string | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    canChangePassword?: boolean | undefined;
+    roles?: {
+        name?: string | undefined;
+        id?: string | number | undefined;
+        role?: string | undefined;
+        master?: boolean | undefined;
+        default?: boolean | undefined;
+    }[] | undefined;
+    settings?: {
+        notificationsEnabled?: string | boolean | undefined;
+    } | undefined;
+    dtype?: string | undefined;
+}, {
+    createdAt?: string | undefined;
+    id?: string | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    adminId?: string | undefined;
+    username?: string | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    canChangePassword?: boolean | undefined;
+    roles?: {
+        name?: string | undefined;
+        id?: string | number | undefined;
+        role?: string | undefined;
+        master?: boolean | undefined;
+        default?: boolean | undefined;
+    }[] | undefined;
+    settings?: {
+        notificationsEnabled?: string | boolean | undefined;
+    } | undefined;
+    dtype?: string | undefined;
+}>;
+export type AdminUser = z.infer<typeof AdminUserSchema>;
+/**
+ * Admin User List Item Schema.
+ * Simplified representation for list responses.
+ */
+export declare const AdminUserListItemSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    firstName: z.ZodOptional<z.ZodString>;
+    lastName: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+    createdAt: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    createdAt?: string | undefined;
+    id?: string | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    username?: string | undefined;
+    isActive?: boolean | undefined;
+}, {
+    createdAt?: string | undefined;
+    id?: string | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    username?: string | undefined;
+    isActive?: boolean | undefined;
+}>;
+export type AdminUserListItem = z.infer<typeof AdminUserListItemSchema>;
+/**
+ * Admin User Create Input Schema.
+ * Input for POST /api/admin/data - uses { admin: {...} } wrapper
+ */
+export declare const AdminUserCreateInputSchema: z.ZodObject<{
+    email: z.ZodString;
+    plainPassword: 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>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    plainPassword: string;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    notificationsEnabled?: boolean | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    roles?: (string | number)[] | undefined;
+}, {
+    email: string;
+    plainPassword: string;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    notificationsEnabled?: boolean | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    roles?: (string | number)[] | undefined;
+}>;
+export type AdminUserCreateInput = z.infer<typeof AdminUserCreateInputSchema>;
+/**
+ * Admin User Update Input Schema.
+ * Input for PUT /api/admin/data/{adminId} - uses { admin: {...} } wrapper
+ */
+export declare const AdminUserUpdateInputSchema: z.ZodObject<{
+    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>;
+    plainPassword: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    notificationsEnabled?: boolean | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    roles?: (string | number)[] | undefined;
+    plainPassword?: string | undefined;
+}, {
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+    notificationsEnabled?: boolean | undefined;
+    isActive?: boolean | undefined;
+    external?: boolean | undefined;
+    roles?: (string | number)[] | undefined;
+    plainPassword?: string | undefined;
+}>;
+export type AdminUserUpdateInput = z.infer<typeof AdminUserUpdateInputSchema>;
+/**
+ * Admin Permission Schema.
+ * Represents admin permissions.
+ */
+export declare const AdminPermissionSchema: z.ZodObject<{
+    superAdmin: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    roles?: string[] | undefined;
+    superAdmin?: boolean | undefined;
+    permissions?: string[] | undefined;
+}, {
+    roles?: string[] | undefined;
+    superAdmin?: boolean | undefined;
+    permissions?: string[] | undefined;
+}>;
+export type AdminPermission = z.infer<typeof AdminPermissionSchema>;
+/**
+ * Change Password Input Schema.
+ * Input for PUT /api/admin/password
+ */
+export declare const ChangePasswordInputSchema: z.ZodObject<{
+    currentPassword: z.ZodString;
+    plainPassword: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    plainPassword: string;
+    currentPassword: string;
+}, {
+    plainPassword: string;
+    currentPassword: string;
+}>;
+export type ChangePasswordInput = z.infer<typeof ChangePasswordInputSchema>;

package/dist/types/schemas/admin.js

@@ -0,0 +1,99 @@
+import { z } from "zod";
+/**
+ * Admin Role Schema.
+ * Represents a role assigned to an admin user.
+ */
+export const AdminRoleSchema = z.object({
+    role: z.string().optional().describe("Role identifier."),
+    id: z.union([z.string(), z.number()]).optional().describe("Role ID."),
+    name: z.string().optional().describe("Role name."),
+    master: z.boolean().optional().describe("Whether this is a master/super role."),
+    default: z.boolean().optional().describe("Whether this is a default role."),
+});
+/**
+ * Admin Settings Schema.
+ * User-specific settings for an admin.
+ */
+export const AdminSettingsSchema = z.object({
+    notificationsEnabled: z.union([z.boolean(), z.string()]).optional().describe("Whether notifications are enabled."),
+});
+/**
+ * Admin User Schema.
+ * Full admin user profile from GET /api/admin/data/{adminId}
+ */
+export const AdminUserSchema = z.object({
+    id: z.string().optional().describe("Admin user ID (UUID)."),
+    adminId: z.string().optional().describe("Admin user ID (alternative key)."),
+    username: z.string().optional().describe("Admin username."),
+    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."),
+    isActive: z.boolean().optional().describe("Whether admin account is active."),
+    external: z.boolean().optional().describe("Whether admin is from external system."),
+    canChangePassword: z.boolean().optional().describe("Whether admin can change their password."),
+    roles: z.array(AdminRoleSchema).optional().describe("Roles assigned to admin."),
+    settings: AdminSettingsSchema.optional().describe("Admin-specific settings."),
+    createdAt: z.string().optional().describe("Account creation timestamp."),
+    dtype: z.string().optional().describe("Discriminator type."),
+});
+/**
+ * Admin User List Item Schema.
+ * Simplified representation for list responses.
+ */
+export const AdminUserListItemSchema = z.object({
+    id: z.string().optional().describe("Admin user ID."),
+    username: z.string().optional().describe("Admin username."),
+    email: z.string().optional().describe("Admin email address."),
+    firstName: z.string().optional().describe("Admin first name."),
+    lastName: z.string().optional().describe("Admin last name."),
+    isActive: z.boolean().optional().describe("Whether admin account is active."),
+    createdAt: z.string().optional().describe("Account creation timestamp."),
+});
+/**
+ * Admin User Create Input Schema.
+ * Input for POST /api/admin/data - uses { admin: {...} } wrapper
+ */
+export const AdminUserCreateInputSchema = z.object({
+    email: z.string().describe("Admin email address (required)."),
+    plainPassword: 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."),
+});
+/**
+ * Admin User Update Input Schema.
+ * Input for PUT /api/admin/data/{adminId} - uses { admin: {...} } wrapper
+ */
+export const AdminUserUpdateInputSchema = z.object({
+    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."),
+    plainPassword: z.string().optional().describe("New password (if changing)."),
+});
+/**
+ * Admin Permission Schema.
+ * Represents admin permissions.
+ */
+export const AdminPermissionSchema = z.object({
+    superAdmin: z.boolean().optional().describe("Whether user is a super admin."),
+    roles: z.array(z.string()).optional().describe("List of role names."),
+    permissions: z.array(z.string()).optional().describe("List of permission strings."),
+});
+/**
+ * Change Password Input Schema.
+ * Input for PUT /api/admin/password
+ */
+export const ChangePasswordInputSchema = z.object({
+    currentPassword: z.string().describe("Current password."),
+    plainPassword: z.string().describe("New password."),
+});