wiil-core-js 0.0.82

package/dist/core/type-definitions/service-config.definitions.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentCapabilities = exports.AgentRoleTemplateIdentifier = exports.LLMRequestType = exports.SupportedLLMKit = exports.SupportedProprietor = exports.LLMType = exports.AssistantType = exports.DeploymentProvisioningType = exports.OttCommunicationType = exports.MobilePlatform = exports.PhoneNumberType = exports.PhoneStatus = exports.PhonePurchaseStatus = exports.EmailProviderType = exports.ProviderType = exports.DeploymentStatus = exports.DeploymentType = void 0;
+const account_definitions_1 = require("./account-definitions");
+// Enums
+var DeploymentType;
+(function (DeploymentType) {
+    DeploymentType["CALLS"] = "calls";
+    DeploymentType["SMS"] = "sms";
+    DeploymentType["WEB"] = "web";
+    DeploymentType["MOBILE"] = "mobile-app";
+    DeploymentType["WHATSAPP"] = "whatsapp";
+    DeploymentType["EMAIL"] = "email";
+})(DeploymentType || (exports.DeploymentType = DeploymentType = {}));
+var DeploymentStatus;
+(function (DeploymentStatus) {
+    DeploymentStatus["PENDING"] = "pending";
+    DeploymentStatus["ACTIVE"] = "active";
+    DeploymentStatus["PAUSED"] = "paused";
+    DeploymentStatus["ARCHIVED"] = "archived";
+})(DeploymentStatus || (exports.DeploymentStatus = DeploymentStatus = {}));
+var ProviderType;
+(function (ProviderType) {
+    ProviderType["TWILIO"] = "twilio";
+    ProviderType["SIGNALWIRE"] = "signal-wire";
+    ProviderType["TELNYX"] = "telnyx";
+    ProviderType["MESSAGEBIRD"] = "messagebird";
+    ProviderType["SNS"] = "sns";
+})(ProviderType || (exports.ProviderType = ProviderType = {}));
+var EmailProviderType;
+(function (EmailProviderType) {
+    EmailProviderType["GOOGLE"] = "google";
+    EmailProviderType["OUTLOOK"] = "outlook";
+    EmailProviderType["SENDGRID"] = "sendgrid";
+    EmailProviderType["SES"] = "ses";
+    EmailProviderType["MAILGUN"] = "mailgun";
+    EmailProviderType["POSTMARK"] = "postmark";
+    EmailProviderType["SMTP"] = "smtp";
+})(EmailProviderType || (exports.EmailProviderType = EmailProviderType = {}));
+var PhonePurchaseStatus;
+(function (PhonePurchaseStatus) {
+    PhonePurchaseStatus["PENDING"] = "pending";
+    PhonePurchaseStatus["COMPLETED"] = "completed";
+    PhonePurchaseStatus["FAILED"] = "failed";
+    PhonePurchaseStatus["CANCELLED"] = "cancelled";
+})(PhonePurchaseStatus || (exports.PhonePurchaseStatus = PhonePurchaseStatus = {}));
+var PhoneStatus;
+(function (PhoneStatus) {
+    PhoneStatus["ACTIVE"] = "ACTIVE";
+    PhoneStatus["INACTIVE"] = "INACTIVE";
+    PhoneStatus["SMS_ACTIVE"] = "SMS_ACTIVE";
+    PhoneStatus["CALL_ACTIVE"] = "CALL_ACTIVE";
+})(PhoneStatus || (exports.PhoneStatus = PhoneStatus = {}));
+var PhoneNumberType;
+(function (PhoneNumberType) {
+    PhoneNumberType["LOCAL"] = "local";
+    PhoneNumberType["TOLL_FREE"] = "toll-free";
+})(PhoneNumberType || (exports.PhoneNumberType = PhoneNumberType = {}));
+var MobilePlatform;
+(function (MobilePlatform) {
+    MobilePlatform["IOS"] = "ios";
+    MobilePlatform["ANDROID"] = "android";
+    // WEB = 'web',
+})(MobilePlatform || (exports.MobilePlatform = MobilePlatform = {}));
+// Communication types enum
+var OttCommunicationType;
+(function (OttCommunicationType) {
+    OttCommunicationType["TEXT"] = "text";
+    OttCommunicationType["VOICE"] = "voice";
+    OttCommunicationType["UNIFIED"] = "unified";
+})(OttCommunicationType || (exports.OttCommunicationType = OttCommunicationType = {}));
+var DeploymentProvisioningType;
+(function (DeploymentProvisioningType) {
+    DeploymentProvisioningType["DIRECT"] = "direct";
+    DeploymentProvisioningType["CHAINED"] = "chained";
+})(DeploymentProvisioningType || (exports.DeploymentProvisioningType = DeploymentProvisioningType = {}));
+var AssistantType;
+(function (AssistantType) {
+    AssistantType["PHONE"] = "phone";
+    AssistantType["WEB"] = "web";
+    AssistantType["EMAIL"] = "email";
+    AssistantType["GENERAL"] = "general";
+})(AssistantType || (exports.AssistantType = AssistantType = {}));
+var LLMType;
+(function (LLMType) {
+    LLMType["STS"] = "sts";
+    LLMType["TTS"] = "tts";
+    LLMType["STT"] = "stt";
+    LLMType["TRANSCRIBE"] = "transcribe";
+    LLMType["TEXT_PROCESSING"] = "text";
+    // IMAGE = 'image',
+    // VIDEO = 'video',
+    LLMType["MULTI_MODE"] = "multi_mode";
+})(LLMType || (exports.LLMType = LLMType = {}));
+var SupportedProprietor;
+(function (SupportedProprietor) {
+    SupportedProprietor["OPENAI"] = "OpenAI";
+    SupportedProprietor["GOOGLE"] = "Google";
+    SupportedProprietor["ANTHROPIC"] = "Anthropic";
+    SupportedProprietor["GROQ"] = "Groq";
+    SupportedProprietor["XAI"] = "xAI";
+    SupportedProprietor["DEEPGRAM"] = "Deepgram";
+    SupportedProprietor["ELEVENLABS"] = "ElevenLabs";
+    SupportedProprietor["DEEPSEEK"] = "DeepSeek";
+    SupportedProprietor["CARTESIA"] = "Cartesia";
+})(SupportedProprietor || (exports.SupportedProprietor = SupportedProprietor = {}));
+var SupportedLLMKit;
+(function (SupportedLLMKit) {
+    SupportedLLMKit["OPEN_AI"] = "openai-kit";
+    SupportedLLMKit["GOOGLE"] = "google-kit";
+    SupportedLLMKit["ANTHROPIC"] = "anthropic-kit";
+    SupportedLLMKit["GROQ"] = "groq-kit";
+    SupportedLLMKit["XAI"] = "xai-kit";
+    SupportedLLMKit["DEEPGRAM"] = "deepgram-kit";
+    SupportedLLMKit["ELEVENLABS"] = "elevenlabs-kit";
+    SupportedLLMKit["DEEPSEEK"] = "deepseek-kit";
+    SupportedLLMKit["CARTESIA"] = "cartesia-kit";
+})(SupportedLLMKit || (exports.SupportedLLMKit = SupportedLLMKit = {}));
+var LLMRequestType;
+(function (LLMRequestType) {
+    LLMRequestType["TEXT"] = "text";
+    LLMRequestType["AUDIO"] = "audio";
+    LLMRequestType["IMAGE"] = "image";
+    LLMRequestType["VIDEO"] = "video";
+    LLMRequestType["MULTIMODAL"] = "multimodal";
+})(LLMRequestType || (exports.LLMRequestType = LLMRequestType = {}));
+var AgentRoleTemplateIdentifier;
+(function (AgentRoleTemplateIdentifier) {
+    AgentRoleTemplateIdentifier["CUSTOMER_SUPPORT_GENERAL"] = "customer-support-general";
+    AgentRoleTemplateIdentifier["TECHNICAL_SUPPORT_SPECIALIST"] = "technical-support-specialist";
+    AgentRoleTemplateIdentifier["SALES_REPRESENTATIVE"] = "sales-representative";
+    AgentRoleTemplateIdentifier["ONBOARDING_SPECIALIST"] = "onboarding-specialist";
+    AgentRoleTemplateIdentifier["BILLING_SUPPORT_SPECIALIST"] = "billing-support-specialist";
+})(AgentRoleTemplateIdentifier || (exports.AgentRoleTemplateIdentifier = AgentRoleTemplateIdentifier = {}));
+exports.AgentCapabilities = account_definitions_1.BusinessSupportServices;

package/dist/core/validators/channel-validation.d.ts

@@ -0,0 +1,19 @@
+import { DeploymentChannelType } from "../service-configuration/interaction-channels.schema";
+import { DeploymentType } from "../type-definitions";
+/**
+ * Helper function for runtime type checking.
+ *
+ * Returns the deployment type of a channel.
+ *
+ * @param channel - The deployment channel to check
+ * @returns The deployment type
+ */
+export declare function getDeploymentChannelType(channel: DeploymentChannelType): DeploymentType;
+/**
+ * Validation helper that provides better error messages.
+ *
+ * @param data - The data to validate as a deployment channel
+ * @returns Validated deployment channel
+ * @throws Error with specific message for validation failures
+ */
+export declare function validateDeploymentChannel(data: unknown): DeploymentChannelType;

package/dist/core/validators/channel-validation.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeploymentChannelType = getDeploymentChannelType;
+exports.validateDeploymentChannel = validateDeploymentChannel;
+const zod_1 = __importDefault(require("zod"));
+const interaction_channels_schema_1 = require("../service-configuration/interaction-channels.schema");
+/**
+ * Helper function for runtime type checking.
+ *
+ * Returns the deployment type of a channel.
+ *
+ * @param channel - The deployment channel to check
+ * @returns The deployment type
+ */
+function getDeploymentChannelType(channel) {
+    return channel.deploymentType;
+}
+/**
+ * Validation helper that provides better error messages.
+ *
+ * @param data - The data to validate as a deployment channel
+ * @returns Validated deployment channel
+ * @throws Error with specific message for validation failures
+ */
+function validateDeploymentChannel(data) {
+    try {
+        return interaction_channels_schema_1.DeploymentChannelSchema.parse(data);
+    }
+    catch (error) {
+        if (error instanceof zod_1.default.ZodError) {
+            const deploymentType = data?.deploymentType;
+            console.error(`Validation failed for deployment type: ${deploymentType}`, error.issues);
+            throw new Error(`Invalid deployment channel configuration for type: ${deploymentType}`);
+        }
+        throw error;
+    }
+}

package/dist/core/validators/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @fileoverview Central export point for validation utilities.
+ * @module validators
+ */
+export * from './channel-validation';

package/dist/core/validators/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * @fileoverview Central export point for validation utilities.
+ * @module validators
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./channel-validation"), exports);

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @fileoverview Main entry point for the Wiil Platform Data Model Definitions.
+ * @module wiil-core-js
+ */
+export * from './core';
+export * from './request';

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * @fileoverview Main entry point for the Wiil Platform Data Model Definitions.
+ * @module wiil-core-js
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Core schemas and types
+__exportStar(require("./core"), exports);
+// Request schemas and utilities
+__exportStar(require("./request"), exports);

package/dist/request/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @fileoverview Central export point for request schemas and utilities.
+ * @module request
+ */
+export * from './models';

package/dist/request/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * @fileoverview Central export point for request schemas and utilities.
+ * @module request
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models"), exports);

package/dist/request/models/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @fileoverview Central export point for request model schemas.
+ * @module request/models
+ */
+export * from './paginated-quest.schema';
+export * from './paginated-result.schema';

package/dist/request/models/index.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * @fileoverview Central export point for request model schemas.
+ * @module request/models
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./paginated-quest.schema"), exports);
+__exportStar(require("./paginated-result.schema"), exports);

package/dist/request/models/paginated-quest.schema.d.ts

@@ -0,0 +1,33 @@
+import z from "zod";
+/**
+ * @fileoverview Timestamp-based query schema definitions for filtering records.
+ * @module request/models/paginated-quest
+ */
+/**
+ * Schema for queries based on a specific timestamp.
+ *
+ * @typedef {Object} TimestampQuery
+ * @property {number} fromTimestamp - Unix timestamp to filter records (e.g., for fetching updates since this time)
+ * @property {number} [toTimestamp] - Optional end Unix timestamp to filter records up to this time
+ */
+export declare const TimestampQuerySchema: z.ZodObject<{
+    fromTimestamp: z.ZodNumber;
+    toTimestamp: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type TimestampQuery = z.infer<typeof TimestampQuerySchema>;
+/**
+ * Schema for paginated queries based on a specific timestamp.
+ *
+ * @typedef {Object} AccountPaginatedTimestampQuery
+ * @property {number} fromTimestamp - Unix timestamp to filter records
+ * @property {number} [toTimestamp] - Optional end Unix timestamp
+ * @property {number} page - Page number for pagination, starting from 1
+ * @property {number} pageSize - Number of records per page, max 100
+ */
+export declare const AccountPaginatedTimestampQuerySchema: z.ZodObject<{
+    fromTimestamp: z.ZodNumber;
+    toTimestamp: z.ZodOptional<z.ZodNumber>;
+    page: z.ZodDefault<z.ZodNumber>;
+    pageSize: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type AccountPaginatedTimestampQuery = z.infer<typeof AccountPaginatedTimestampQuerySchema>;

package/dist/request/models/paginated-quest.schema.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountPaginatedTimestampQuerySchema = exports.TimestampQuerySchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+/**
+ * @fileoverview Timestamp-based query schema definitions for filtering records.
+ * @module request/models/paginated-quest
+ */
+/**
+ * Schema for queries based on a specific timestamp.
+ *
+ * @typedef {Object} TimestampQuery
+ * @property {number} fromTimestamp - Unix timestamp to filter records (e.g., for fetching updates since this time)
+ * @property {number} [toTimestamp] - Optional end Unix timestamp to filter records up to this time
+ */
+exports.TimestampQuerySchema = zod_1.default.object({
+    fromTimestamp: zod_1.default.number(),
+    toTimestamp: zod_1.default.number().optional(),
+});
+/**
+ * Schema for paginated queries based on a specific timestamp.
+ *
+ * @typedef {Object} AccountPaginatedTimestampQuery
+ * @property {number} fromTimestamp - Unix timestamp to filter records
+ * @property {number} [toTimestamp] - Optional end Unix timestamp
+ * @property {number} page - Page number for pagination, starting from 1
+ * @property {number} pageSize - Number of records per page, max 100
+ */
+exports.AccountPaginatedTimestampQuerySchema = exports.TimestampQuerySchema.safeExtend({
+    page: zod_1.default.number().min(1).default(1),
+    pageSize: zod_1.default.number().min(1).max(100).default(20),
+});

package/dist/request/models/paginated-result.schema.d.ts

@@ -0,0 +1,124 @@
+import { z } from 'zod';
+/**
+ * @fileoverview Pagination schema definitions for paginated API responses.
+ * @module request/models/paginated-result
+ */
+/**
+ * Pagination metadata schema.
+ *
+ * @typedef {Object} PaginationMeta
+ * @property {number} page - Current page number (1-based indexing)
+ * @property {number} pageSize - Number of items per page - limited to 1000 for performance
+ * @property {number} totalCount - Total number of items across all pages
+ * @property {number} totalPages - Total number of pages available
+ * @property {boolean} hasNextPage - Whether there is a next page available for navigation
+ * @property {boolean} hasPreviousPage - Whether there is a previous page available for navigation
+ */
+export declare const PaginationMetaSchema: z.ZodObject<{
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalCount: z.ZodNumber;
+    totalPages: z.ZodNumber;
+    hasNextPage: z.ZodBoolean;
+    hasPreviousPage: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Generic function to create a paginated result schema.
+ * Use this with any data schema to create typed paginated responses.
+ *
+ * @example
+ * const PaginatedCustomers = createPaginatedResultSchema(CustomerSchema);
+ */
+export declare const createPaginatedResultSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+    meta: z.ZodObject<{
+        page: z.ZodNumber;
+        pageSize: z.ZodNumber;
+        totalCount: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNextPage: z.ZodBoolean;
+        hasPreviousPage: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Basic paginated result schema for any data type.
+ * Use this when you need a flexible paginated result without specific data typing.
+ *
+ * @typedef {Object} BasePaginatedResult
+ * @property {Array} data - Array of data items for the current page
+ * @property {Object} meta - Pagination metadata including page info and navigation flags
+ */
+export declare const BasePaginatedResultSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodAny>;
+    meta: z.ZodObject<{
+        page: z.ZodNumber;
+        pageSize: z.ZodNumber;
+        totalCount: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNextPage: z.ZodBoolean;
+        hasPreviousPage: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Schema for paginated account requests.
+ *
+ * @typedef {Object} PaginatedAccountRequest
+ * @property {number} page - Page number to retrieve (1-based)
+ * @property {number} pageSize - Number of items per page (max 1000)
+ */
+export declare const PaginatedAccountRequestSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    pageSize: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Generic pagination request schema.
+ *
+ * @typedef {Object} PaginationRequest
+ * @property {number} page - Page number to retrieve (1-based)
+ * @property {number} pageSize - Number of items per page (max 1000)
+ * @property {string} [sortBy] - Field name to sort by
+ * @property {string} sortDirection - Sort direction - ascending or descending
+ */
+export declare const PaginationRequestSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    pageSize: z.ZodDefault<z.ZodNumber>;
+    sortBy: z.ZodOptional<z.ZodString>;
+    sortDirection: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strip>;
+/**
+ * Schema for search-enabled pagination requests.
+ *
+ * @typedef {Object} SearchablePaginationRequest
+ * @property {number} page - Page number to retrieve
+ * @property {number} pageSize - Number of items per page
+ * @property {string} [sortBy] - Field name to sort by
+ * @property {string} sortDirection - Sort direction
+ * @property {string} [search] - Search query to filter results
+ * @property {string[]} [searchFields] - Specific fields to search within
+ */
+export declare const SearchablePaginationRequestSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    pageSize: z.ZodDefault<z.ZodNumber>;
+    sortBy: z.ZodOptional<z.ZodString>;
+    sortDirection: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    search: z.ZodOptional<z.ZodString>;
+    searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type PaginationMetaType = z.infer<typeof PaginationMetaSchema>;
+export type BasePaginatedResult = z.infer<typeof BasePaginatedResultSchema>;
+export type PaginatedAccountRequest = z.infer<typeof PaginatedAccountRequestSchema>;
+export type PaginationRequest = z.infer<typeof PaginationRequestSchema>;
+export type SearchablePaginationRequest = z.infer<typeof SearchablePaginationRequestSchema>;
+/**
+ * Helper type for creating typed paginated results.
+ */
+export type PaginatedResultType<T> = {
+    data: T[];
+    meta: PaginationMetaType;
+};

package/dist/request/models/paginated-result.schema.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchablePaginationRequestSchema = exports.PaginationRequestSchema = exports.PaginatedAccountRequestSchema = exports.BasePaginatedResultSchema = exports.createPaginatedResultSchema = exports.PaginationMetaSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * @fileoverview Pagination schema definitions for paginated API responses.
+ * @module request/models/paginated-result
+ */
+/**
+ * Pagination metadata schema.
+ *
+ * @typedef {Object} PaginationMeta
+ * @property {number} page - Current page number (1-based indexing)
+ * @property {number} pageSize - Number of items per page - limited to 1000 for performance
+ * @property {number} totalCount - Total number of items across all pages
+ * @property {number} totalPages - Total number of pages available
+ * @property {boolean} hasNextPage - Whether there is a next page available for navigation
+ * @property {boolean} hasPreviousPage - Whether there is a previous page available for navigation
+ */
+exports.PaginationMetaSchema = zod_1.z.object({
+    page: zod_1.z.number().int().positive(),
+    pageSize: zod_1.z.number().int().positive().max(1000),
+    totalCount: zod_1.z.number().int().nonnegative(),
+    totalPages: zod_1.z.number().int().nonnegative(),
+    hasNextPage: zod_1.z.boolean(),
+    hasPreviousPage: zod_1.z.boolean(),
+});
+/**
+ * Generic function to create a paginated result schema.
+ * Use this with any data schema to create typed paginated responses.
+ *
+ * @example
+ * const PaginatedCustomers = createPaginatedResultSchema(CustomerSchema);
+ */
+const createPaginatedResultSchema = (dataSchema) => {
+    return zod_1.z.object({
+        data: zod_1.z.array(dataSchema),
+        meta: exports.PaginationMetaSchema,
+    });
+};
+exports.createPaginatedResultSchema = createPaginatedResultSchema;
+/**
+ * Basic paginated result schema for any data type.
+ * Use this when you need a flexible paginated result without specific data typing.
+ *
+ * @typedef {Object} BasePaginatedResult
+ * @property {Array} data - Array of data items for the current page
+ * @property {Object} meta - Pagination metadata including page info and navigation flags
+ */
+exports.BasePaginatedResultSchema = zod_1.z.object({
+    data: zod_1.z.array(zod_1.z.any()),
+    meta: exports.PaginationMetaSchema,
+});
+/**
+ * Schema for paginated account requests.
+ *
+ * @typedef {Object} PaginatedAccountRequest
+ * @property {number} page - Page number to retrieve (1-based)
+ * @property {number} pageSize - Number of items per page (max 1000)
+ */
+exports.PaginatedAccountRequestSchema = zod_1.z.object({
+    page: zod_1.z.number().int().positive().default(1),
+    pageSize: zod_1.z.number().int().positive().max(1000).default(20),
+});
+/**
+ * Generic pagination request schema.
+ *
+ * @typedef {Object} PaginationRequest
+ * @property {number} page - Page number to retrieve (1-based)
+ * @property {number} pageSize - Number of items per page (max 1000)
+ * @property {string} [sortBy] - Field name to sort by
+ * @property {string} sortDirection - Sort direction - ascending or descending
+ */
+exports.PaginationRequestSchema = zod_1.z.object({
+    page: zod_1.z.number().int().positive().default(1),
+    pageSize: zod_1.z.number().int().positive().max(1000).default(20),
+    sortBy: zod_1.z.string().optional(),
+    sortDirection: zod_1.z.enum(['asc', 'desc']).default('asc'),
+});
+/**
+ * Schema for search-enabled pagination requests.
+ *
+ * @typedef {Object} SearchablePaginationRequest
+ * @property {number} page - Page number to retrieve
+ * @property {number} pageSize - Number of items per page
+ * @property {string} [sortBy] - Field name to sort by
+ * @property {string} sortDirection - Sort direction
+ * @property {string} [search] - Search query to filter results
+ * @property {string[]} [searchFields] - Specific fields to search within
+ */
+exports.SearchablePaginationRequestSchema = exports.PaginationRequestSchema.safeExtend({
+    search: zod_1.z.string().optional(),
+    searchFields: zod_1.z.array(zod_1.z.string()).optional(),
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "wiil-core-js",
+  "version": "0.0.82",
+  "license": "MIT",
+  "author": "WIIL",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wiil-io/core-js.git"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch",
+    "tag:bash": "bash ./scripts/tag-script.sh",
+    "git:commit": "bash ./scripts/commit-script.sh",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "wiil",
+    "data defintions",
+    "data models",
+    "dtos",
+    "schemas"
+  ],
+  "description": "Wiil Platform JavaScript Data Model Definitions. Core schemas for the wiil platform, providing TypeScript types and validation schemas using Zod.",
+  "devDependencies": {
+    "@types/node": "^22.13.14",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-zod": "^1.4.3",
+    "typescript": "^5.8.2"
+  },
+  "dependencies": {
+    "zod": "4.1.12"
+  }
+}