wiil-core-js 0.0.82

package/dist/core/business-mgt/service-management/appointment-additional-info.schema.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateAppointmentAdditionalInfoSchema = exports.CreateAppointmentAdditionalInfoSchema = exports.AppointmentAdditionalInfoSchema = exports.DynamicFieldValueSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../../base.schema");
+/**
+ * @fileoverview Appointment Additional Info schema for storing dynamic field values.
+ * @module business-mgt/appointment-additional-info
+ *
+ * This schema represents the **Appointment Level** in the dynamic fields hierarchy:
+ *
+ * ```
+ * Organization Level (AppointmentFieldConfigSchema)
+ *         │
+ *         ▼ inherits via appointmentFieldConfigId
+ * Service Level (ServiceAppointmentFieldConfigSchema)
+ *         │
+ *         ▼ stores values
+ * Appointment Level (AppointmentAdditionalInfoSchema) ← THIS SCHEMA
+ * ```
+ *
+ * Stores the actual captured field values for a specific appointment instance.
+ * The `data` property contains key-value pairs where keys correspond to `fieldKey`
+ * values defined in the organization and service-level field configurations.
+ *
+ * @see AppointmentFieldConfigSchema - Organization-level field definitions
+ * @see ServiceAppointmentFieldConfigSchema - Service-level field customization
+ */
+// ============================================================================
+// DYNAMIC FIELD VALUE SCHEMA
+// ============================================================================
+/**
+ * Schema for dynamic field value types.
+ * Accepts any value type to support the various DynamicFieldType values
+ * (text, number, boolean, date, select options, etc.)
+ */
+exports.DynamicFieldValueSchema = zod_1.default.any().describe("Dynamic field value supporting various types");
+// ============================================================================
+// APPOINTMENT ADDITIONAL INFO SCHEMA
+// ============================================================================
+/**
+ * Appointment Additional Info schema.
+ * Stores dynamic field values captured during appointment booking.
+ *
+ * @typedef {Object} AppointmentAdditionalInfo
+ * @property {string} businessServiceId - Reference to the business service
+ * @property {string} appointmentId - Reference to the appointment instance
+ * @property {string} customerId - Reference to the customer who provided info
+ * @property {Object} data - Key-value store of captured field values
+ */
+exports.AppointmentAdditionalInfoSchema = base_schema_1.BaseModelSchema.safeExtend({
+    businessServiceId: zod_1.default.string().describe("Reference to the business service for this appointment. The service's ServiceAppointmentFieldConfigSchema determines which fields were presented to the customer."),
+    appointmentId: zod_1.default.string().describe("Reference to the appointment instance these field values belong to. Creates a 1:1 relationship between appointment and its additional info."),
+    customerId: zod_1.default.string().describe("Reference to the customer who provided this information. When reuseDetails is enabled, this allows pre-populating fields for returning customers."),
+    data: zod_1.default.record(zod_1.default.string(), exports.DynamicFieldValueSchema).default({}).describe("Key-value store of captured field values. Keys correspond to fieldKey from FieldDefinitionSchema. Values are typed according to the field's DynamicFieldType."),
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating appointment additional info.
+ * Omits auto-generated fields.
+ */
+exports.CreateAppointmentAdditionalInfoSchema = exports.AppointmentAdditionalInfoSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating appointment additional info.
+ * All fields optional except id (required).
+ */
+exports.UpdateAppointmentAdditionalInfoSchema = exports.CreateAppointmentAdditionalInfoSchema.partial().safeExtend({
+    id: zod_1.default.string().describe("Unique identifier of the AppointmentAdditionalInfo to update"),
+});

package/dist/core/business-mgt/service-management/appointment-field-config.schema.d.ts

@@ -0,0 +1,304 @@
+import z from "zod";
+import { BusinessSupportServices } from "../../type-definitions/account-definitions";
+/**
+ * @fileoverview Organization-level appointment field configuration schema.
+ * @module business-mgt/appointment-field-config
+ *
+ * This schema represents the **Organization Level** in the dynamic fields hierarchy:
+ *
+ * ```
+ * Organization Level (AppointmentFieldConfigSchema) ← THIS SCHEMA
+ *         │
+ *         ▼ inherits via appointmentFieldConfigId
+ * Service Level (ServiceAppointmentFieldConfigSchema)
+ *         │
+ *         ▼ stores values
+ * Appointment Level (AppointmentAdditionalInfoSchema)
+ * ```
+ *
+ * Defines the base field library that can be reused across multiple services
+ * within an organization. Services can inherit fields from this configuration
+ * and optionally override specific properties or add service-specific fields.
+ *
+ * @see ServiceAppointmentFieldConfigSchema - Service-level field customization
+ * @see AppointmentAdditionalInfoSchema - Stores captured field values
+ */
+/**
+ * Appointment Field Config schema.
+ * Organization-level field library for appointment booking forms.
+ *
+ * @typedef {Object} AppointmentFieldConfig
+ * @property {Array} fields - Field definitions available at organization level
+ * @property {Array} groups - Logical groupings for organizing fields
+ * @property {boolean} reuseDetails - Whether to reuse data for returning customers
+ * @property {boolean} ensureEmail - Ensure email field is always included
+ * @property {boolean} ensurePhone - Ensure phone field is always included
+ * @property {BusinessSupportServices} [supportService] - Business support service this field configuration applies to
+ */
+export declare const AppointmentFieldConfigSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        fieldKey: z.ZodString;
+        fieldType: z.ZodEnum<{
+            text: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXT;
+            textarea: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXTAREA;
+            number: import("../../type-definitions/dynamic-fields").DynamicFieldType.NUMBER;
+            boolean: import("../../type-definitions/dynamic-fields").DynamicFieldType.BOOLEAN;
+            date: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATE;
+            time: import("../../type-definitions/dynamic-fields").DynamicFieldType.TIME;
+            datetime: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATETIME;
+            email: import("../../type-definitions/dynamic-fields").DynamicFieldType.EMAIL;
+            phone: import("../../type-definitions/dynamic-fields").DynamicFieldType.PHONE;
+            select: import("../../type-definitions/dynamic-fields").DynamicFieldType.SELECT;
+            multiselect: import("../../type-definitions/dynamic-fields").DynamicFieldType.MULTISELECT;
+        }>;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        validation: z.ZodOptional<z.ZodObject<{
+            required: z.ZodOptional<z.ZodBoolean>;
+            minLength: z.ZodOptional<z.ZodNumber>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            pattern: z.ZodOptional<z.ZodString>;
+            patternMessage: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        uiHints: z.ZodOptional<z.ZodObject<{
+            placeholder: z.ZodOptional<z.ZodString>;
+            helpText: z.ZodOptional<z.ZodString>;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+            width: z.ZodOptional<z.ZodEnum<{
+                full: "full";
+                half: "half";
+                third: "third";
+            }>>;
+        }, z.core.$strip>>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        defaultValue: z.ZodOptional<z.ZodAny>;
+        isActive: z.ZodOptional<z.ZodBoolean>;
+        condition: z.ZodOptional<z.ZodObject<{
+            dependsOn: z.ZodString;
+            operator: z.ZodEnum<{
+                equals: "equals";
+                notEquals: "notEquals";
+                contains: "contains";
+                isEmpty: "isEmpty";
+                isNotEmpty: "isNotEmpty";
+                greaterThan: "greaterThan";
+                lessThan: "lessThan";
+            }>;
+            value: z.ZodOptional<z.ZodAny>;
+        }, z.core.$strip>>;
+        groupKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    groups: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        groupKey: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        displayOrder: z.ZodOptional<z.ZodNumber>;
+        collapsible: z.ZodOptional<z.ZodBoolean>;
+        defaultCollapsed: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    reuseDetails: z.ZodDefault<z.ZodBoolean>;
+    ensureEmail: z.ZodDefault<z.ZodBoolean>;
+    ensurePhone: z.ZodDefault<z.ZodBoolean>;
+    supportService: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof BusinessSupportServices>>>;
+}, z.core.$strip>;
+/**
+ * Schema for creating an appointment field config.
+ * Omits auto-generated fields.
+ */
+export declare const CreateAppointmentFieldConfigSchema: z.ZodObject<{
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        fieldKey: z.ZodString;
+        fieldType: z.ZodEnum<{
+            text: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXT;
+            textarea: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXTAREA;
+            number: import("../../type-definitions/dynamic-fields").DynamicFieldType.NUMBER;
+            boolean: import("../../type-definitions/dynamic-fields").DynamicFieldType.BOOLEAN;
+            date: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATE;
+            time: import("../../type-definitions/dynamic-fields").DynamicFieldType.TIME;
+            datetime: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATETIME;
+            email: import("../../type-definitions/dynamic-fields").DynamicFieldType.EMAIL;
+            phone: import("../../type-definitions/dynamic-fields").DynamicFieldType.PHONE;
+            select: import("../../type-definitions/dynamic-fields").DynamicFieldType.SELECT;
+            multiselect: import("../../type-definitions/dynamic-fields").DynamicFieldType.MULTISELECT;
+        }>;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        validation: z.ZodOptional<z.ZodObject<{
+            required: z.ZodOptional<z.ZodBoolean>;
+            minLength: z.ZodOptional<z.ZodNumber>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            pattern: z.ZodOptional<z.ZodString>;
+            patternMessage: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        uiHints: z.ZodOptional<z.ZodObject<{
+            placeholder: z.ZodOptional<z.ZodString>;
+            helpText: z.ZodOptional<z.ZodString>;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+            width: z.ZodOptional<z.ZodEnum<{
+                full: "full";
+                half: "half";
+                third: "third";
+            }>>;
+        }, z.core.$strip>>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        defaultValue: z.ZodOptional<z.ZodAny>;
+        isActive: z.ZodOptional<z.ZodBoolean>;
+        condition: z.ZodOptional<z.ZodObject<{
+            dependsOn: z.ZodString;
+            operator: z.ZodEnum<{
+                equals: "equals";
+                notEquals: "notEquals";
+                contains: "contains";
+                isEmpty: "isEmpty";
+                isNotEmpty: "isNotEmpty";
+                greaterThan: "greaterThan";
+                lessThan: "lessThan";
+            }>;
+            value: z.ZodOptional<z.ZodAny>;
+        }, z.core.$strip>>;
+        groupKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    groups: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        groupKey: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        displayOrder: z.ZodOptional<z.ZodNumber>;
+        collapsible: z.ZodOptional<z.ZodBoolean>;
+        defaultCollapsed: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    reuseDetails: z.ZodDefault<z.ZodBoolean>;
+    ensureEmail: z.ZodDefault<z.ZodBoolean>;
+    ensurePhone: z.ZodDefault<z.ZodBoolean>;
+    supportService: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof BusinessSupportServices>>>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an appointment field config.
+ * All fields optional except id (required).
+ */
+export declare const UpdateAppointmentFieldConfigSchema: z.ZodObject<{
+    fields: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        fieldKey: z.ZodString;
+        fieldType: z.ZodEnum<{
+            text: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXT;
+            textarea: import("../../type-definitions/dynamic-fields").DynamicFieldType.TEXTAREA;
+            number: import("../../type-definitions/dynamic-fields").DynamicFieldType.NUMBER;
+            boolean: import("../../type-definitions/dynamic-fields").DynamicFieldType.BOOLEAN;
+            date: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATE;
+            time: import("../../type-definitions/dynamic-fields").DynamicFieldType.TIME;
+            datetime: import("../../type-definitions/dynamic-fields").DynamicFieldType.DATETIME;
+            email: import("../../type-definitions/dynamic-fields").DynamicFieldType.EMAIL;
+            phone: import("../../type-definitions/dynamic-fields").DynamicFieldType.PHONE;
+            select: import("../../type-definitions/dynamic-fields").DynamicFieldType.SELECT;
+            multiselect: import("../../type-definitions/dynamic-fields").DynamicFieldType.MULTISELECT;
+        }>;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        validation: z.ZodOptional<z.ZodObject<{
+            required: z.ZodOptional<z.ZodBoolean>;
+            minLength: z.ZodOptional<z.ZodNumber>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            pattern: z.ZodOptional<z.ZodString>;
+            patternMessage: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        uiHints: z.ZodOptional<z.ZodObject<{
+            placeholder: z.ZodOptional<z.ZodString>;
+            helpText: z.ZodOptional<z.ZodString>;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+            width: z.ZodOptional<z.ZodEnum<{
+                full: "full";
+                half: "half";
+                third: "third";
+            }>>;
+        }, z.core.$strip>>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+            displayOrder: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+        defaultValue: z.ZodOptional<z.ZodAny>;
+        isActive: z.ZodOptional<z.ZodBoolean>;
+        condition: z.ZodOptional<z.ZodObject<{
+            dependsOn: z.ZodString;
+            operator: z.ZodEnum<{
+                equals: "equals";
+                notEquals: "notEquals";
+                contains: "contains";
+                isEmpty: "isEmpty";
+                isNotEmpty: "isNotEmpty";
+                greaterThan: "greaterThan";
+                lessThan: "lessThan";
+            }>;
+            value: z.ZodOptional<z.ZodAny>;
+        }, z.core.$strip>>;
+        groupKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>>;
+    groups: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        groupKey: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        displayOrder: z.ZodOptional<z.ZodNumber>;
+        collapsible: z.ZodOptional<z.ZodBoolean>;
+        defaultCollapsed: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>>;
+    reuseDetails: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    ensureEmail: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    ensurePhone: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    supportService: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof BusinessSupportServices>>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type AppointmentFieldConfig = z.infer<typeof AppointmentFieldConfigSchema>;
+export type CreateAppointmentFieldConfig = z.infer<typeof CreateAppointmentFieldConfigSchema>;
+export type UpdateAppointmentFieldConfig = z.infer<typeof UpdateAppointmentFieldConfigSchema>;
+/**
+ * Appointment field config filter options.
+ * @interface AppointmentFieldConfigFilters
+ */
+export interface AppointmentFieldConfigFilters {
+    /** Filter by reuseDetails setting */
+    reuseDetails?: boolean;
+    /** Filter by ensureEmail setting */
+    ensureEmail?: boolean;
+    /** Filter by ensurePhone setting */
+    ensurePhone?: boolean;
+}
+/**
+ * Appointment field config sorting options.
+ * @interface AppointmentFieldConfigSorting
+ */
+export interface AppointmentFieldConfigSorting {
+    /** Field to sort by */
+    field: "createdAt" | "updatedAt";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/**
+ * Appointment field config query options.
+ * @interface AppointmentFieldConfigQueryOptions
+ */
+export interface AppointmentFieldConfigQueryOptions {
+    /** Page number (1-indexed) */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Optional filters */
+    filters?: AppointmentFieldConfigFilters;
+    /** Optional sorting */
+    sorting?: AppointmentFieldConfigSorting;
+}

package/dist/core/business-mgt/service-management/appointment-field-config.schema.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateAppointmentFieldConfigSchema = exports.CreateAppointmentFieldConfigSchema = exports.AppointmentFieldConfigSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../../base.schema");
+const dynamic_fields_1 = require("../../type-definitions/dynamic-fields");
+const account_definitions_1 = require("../../type-definitions/account-definitions");
+/**
+ * @fileoverview Organization-level appointment field configuration schema.
+ * @module business-mgt/appointment-field-config
+ *
+ * This schema represents the **Organization Level** in the dynamic fields hierarchy:
+ *
+ * ```
+ * Organization Level (AppointmentFieldConfigSchema) ← THIS SCHEMA
+ *         │
+ *         ▼ inherits via appointmentFieldConfigId
+ * Service Level (ServiceAppointmentFieldConfigSchema)
+ *         │
+ *         ▼ stores values
+ * Appointment Level (AppointmentAdditionalInfoSchema)
+ * ```
+ *
+ * Defines the base field library that can be reused across multiple services
+ * within an organization. Services can inherit fields from this configuration
+ * and optionally override specific properties or add service-specific fields.
+ *
+ * @see ServiceAppointmentFieldConfigSchema - Service-level field customization
+ * @see AppointmentAdditionalInfoSchema - Stores captured field values
+ */
+// ============================================================================
+// APPOINTMENT FIELD CONFIG SCHEMA
+// ============================================================================
+/**
+ * Appointment Field Config schema.
+ * Organization-level field library for appointment booking forms.
+ *
+ * @typedef {Object} AppointmentFieldConfig
+ * @property {Array} fields - Field definitions available at organization level
+ * @property {Array} groups - Logical groupings for organizing fields
+ * @property {boolean} reuseDetails - Whether to reuse data for returning customers
+ * @property {boolean} ensureEmail - Ensure email field is always included
+ * @property {boolean} ensurePhone - Ensure phone field is always included
+ * @property {BusinessSupportServices} [supportService] - Business support service this field configuration applies to
+ */
+exports.AppointmentFieldConfigSchema = base_schema_1.BaseModelSchema.safeExtend({
+    fields: zod_1.default.array(dynamic_fields_1.FieldDefinitionSchema).default([]).describe("Array of field definitions available at the organization level. Each field has a unique fieldKey, fieldType, label, and optional validation/UI hints."),
+    groups: zod_1.default.array(dynamic_fields_1.FieldGroupSchema).default([]).describe("Logical groupings for organizing fields into sections (e.g., 'Contact Information', 'Medical History'). Each group has a groupKey, label, and optional display settings."),
+    reuseDetails: zod_1.default.boolean().default(false).describe("When true, captured field data can be reused across appointments for the same customer."),
+    ensureEmail: zod_1.default.boolean().default(false).describe("When true, ensures an email field is always included in the field configuration."),
+    ensurePhone: zod_1.default.boolean().default(false).describe("When true, ensures a phone field is always included in the field configuration."),
+    supportService: zod_1.default.enum(account_definitions_1.BusinessSupportServices).nullable().optional().describe("Business support service this field configuration applies to (e.g., appointment management)."),
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating an appointment field config.
+ * Omits auto-generated fields.
+ */
+exports.CreateAppointmentFieldConfigSchema = exports.AppointmentFieldConfigSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating an appointment field config.
+ * All fields optional except id (required).
+ */
+exports.UpdateAppointmentFieldConfigSchema = exports.CreateAppointmentFieldConfigSchema.partial().safeExtend({
+    id: zod_1.default.string().describe("Unique identifier of the AppointmentFieldConfig to update"),
+});