wiil-core-js 0.0.82

package/dist/core/service-configuration/voice-language.schema.d.ts

@@ -0,0 +1,200 @@
+import { z } from 'zod';
+/**
+ * @fileoverview Voice and language configuration schema definitions.
+ *
+ * Voice and language configurations define the supported voices and languages for text-to-speech
+ * synthesis and speech-to-text recognition. These configurations are referenced by support models
+ * and provisioning chains for voice-based interactions.
+ *
+ * @module service-configuration/voice-language
+ */
+/**
+ * Enum schema for voice gender classification.
+ *
+ * Categorizes synthetic voices by gender characteristics for user preference and selection.
+ *
+ * @example
+ * ```typescript
+ * const gender: VoiceGender = 'female';
+ * ```
+ */
+declare const VoiceGender: z.ZodEnum<{
+    neutral: "neutral";
+    male: "male";
+    female: "female";
+}>;
+/**
+ * Type definition for voice gender.
+ */
+export type VoiceGender = z.infer<typeof VoiceGender>;
+/**
+ * Zod schema for voice configuration.
+ *
+ * Represents a synthetic voice option available for text-to-speech (TTS) synthesis. Voices are
+ * associated with TTS models in the Wiil support registry and selected in provisioning chains
+ * for voice-based deployments.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: WiilSupportModel (supportedVoices array for TTS models)
+ * - **Referenced In**: TtsModelConfig (voiceId selection) and ProvisioningConfigChain
+ * - **Purpose**: Defines available voice options for agent speech synthesis
+ *
+ * **Voice Characteristics:**
+ * - **Identity**: Unique ID and human-readable name
+ * - **Gender**: Male, female, or neutral classification
+ * - **Language**: Optimal language for the voice
+ * - **Default**: Flag for platform default selection
+ *
+ * @typedef {Object} VoiceProperties
+ * @property {string} voiceId - Unique identifier for the voice used in configurations (e.g., 'adam', 'rachel', 'en-us-standard-a')
+ * @property {string} name - Human-readable name of the voice for display in UI (e.g., 'Adam', 'Rachel', 'Google Standard A')
+ * @property {string} description - Description of the voice characteristics including tone, accent, and use cases (e.g., 'Deep, authoritative male voice', 'Warm, friendly female voice')
+ * @property {VoiceGender} gender - Gender classification of the voice (male, female, or neutral) for user preference filtering
+ * @property {string | null} [language] - Language code this voice is optimized for (e.g., 'en-US', 'es-ES', 'fr-FR'), null if multi-language
+ * @property {boolean} isDefault - Whether this is the default voice for its language or model (default: false)
+ *
+ * @example
+ * ```typescript
+ * const voice: Voice = {
+ *   voiceId: 'adam',
+ *   name: 'Adam',
+ *   description: 'Deep, authoritative male voice',
+ *   gender: 'male',
+ *   language: 'en-US',
+ *   isDefault: true
+ * };
+ * ```
+ */
+declare const VoiceSchema: z.ZodObject<{
+    voiceId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    gender: z.ZodEnum<{
+        neutral: "neutral";
+        male: "male";
+        female: "female";
+    }>;
+    language: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    isDefault: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Type definition for voice configuration.
+ */
+export type Voice = z.infer<typeof VoiceSchema>;
+/**
+ * Zod schema for language configuration.
+ *
+ * Represents a language supported by the platform for speech processing (STT/TTS). Languages are
+ * associated with models in the Wiil support registry and selected in provisioning chains
+ * for voice-based and text-based interactions.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: WiilSupportModel (supportLanguages array)
+ * - **Referenced In**: SttModelConfig and TtsModelConfig (defaultLanguage selection)
+ * - **Purpose**: Defines supported languages for speech recognition and synthesis
+ *
+ * **Language Support Levels:**
+ * - **Production**: Fully supported, tested languages (isExperimental: false)
+ * - **Experimental**: Beta or limited support languages (isExperimental: true)
+ * - **Default**: Platform default for automatic selection (isDefault: true)
+ *
+ * @typedef {Object} LanguageProperties
+ * @property {string} languageId - Unique identifier for the language (e.g., 'en-us', 'es-es', 'fr-fr')
+ * @property {string} name - Human-readable name of the language for display (e.g., 'English (United States)', 'Spanish (Spain)')
+ * @property {string} code - Standard language code in ISO 639-1 format with optional region (e.g., 'en-US', 'es-ES', 'fr-FR')
+ * @property {boolean} [isDefault=false] - Whether this is the default language for the platform or model, used for automatic language selection
+ * @property {boolean} [isExperimental=false] - Whether this language is in experimental/beta support with potentially limited accuracy or features
+ *
+ * @example
+ * ```typescript
+ * const language: Language = {
+ *   languageId: 'en-us',
+ *   name: 'English (United States)',
+ *   code: 'en-US',
+ *   isDefault: true,
+ *   isExperimental: false
+ * };
+ * ```
+ */
+export declare const LanguageSchema: z.ZodObject<{
+    languageId: z.ZodString;
+    name: z.ZodString;
+    code: z.ZodString;
+    isDefault: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    isExperimental: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+/**
+ * Type definition for language configuration.
+ */
+export type Language = z.infer<typeof LanguageSchema>;
+/**
+ * Zod schema for an array of supported voices.
+ *
+ * Requires at least one voice to be provided.
+ */
+declare const SupportedVoicesSchema: z.ZodArray<z.ZodObject<{
+    voiceId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    gender: z.ZodEnum<{
+        neutral: "neutral";
+        male: "male";
+        female: "female";
+    }>;
+    language: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    isDefault: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>>;
+/**
+ * Type definition for supported voices array.
+ */
+export type SupportedVoices = z.infer<typeof SupportedVoicesSchema>;
+/**
+ * Zod schema for an array of supported languages.
+ *
+ * Requires at least one language to be provided.
+ */
+export declare const SupportedLanguagesSchema: z.ZodArray<z.ZodObject<{
+    languageId: z.ZodString;
+    name: z.ZodString;
+    code: z.ZodString;
+    isDefault: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    isExperimental: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>>;
+/**
+ * Type definition for supported languages array.
+ */
+export type SupportedLanguages = z.infer<typeof SupportedLanguagesSchema>;
+/**
+ * Validation function for supported voices.
+ *
+ * Parses and validates an array of voices, throwing an error if validation fails.
+ *
+ * @param voices - Unknown input to validate as supported voices
+ * @returns Validated array of voices
+ * @throws {ZodError} If validation fails
+ *
+ * @example
+ * ```typescript
+ * const voices = validateSupportedVoices([
+ *   { voiceId: 'adam', name: 'Adam', description: 'Male voice', gender: 'male', isDefault: true }
+ * ]);
+ * ```
+ */
+export declare const validateSupportedVoices: (voices: unknown) => SupportedVoices;
+/**
+ * Type guard function to check if an object is a valid Voice.
+ *
+ * @param voice - Unknown input to check
+ * @returns True if the input is a valid Voice, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isValidVoice(data)) {
+ *   console.log(data.voiceId); // TypeScript knows data is a Voice
+ * }
+ * ```
+ */
+export declare const isValidVoice: (voice: unknown) => voice is Voice;
+export { VoiceSchema, VoiceGender, SupportedVoicesSchema };

package/dist/core/service-configuration/voice-language.schema.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportedVoicesSchema = exports.VoiceGender = exports.VoiceSchema = exports.isValidVoice = exports.validateSupportedVoices = exports.SupportedLanguagesSchema = exports.LanguageSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * @fileoverview Voice and language configuration schema definitions.
+ *
+ * Voice and language configurations define the supported voices and languages for text-to-speech
+ * synthesis and speech-to-text recognition. These configurations are referenced by support models
+ * and provisioning chains for voice-based interactions.
+ *
+ * @module service-configuration/voice-language
+ */
+/**
+ * Enum schema for voice gender classification.
+ *
+ * Categorizes synthetic voices by gender characteristics for user preference and selection.
+ *
+ * @example
+ * ```typescript
+ * const gender: VoiceGender = 'female';
+ * ```
+ */
+const VoiceGender = zod_1.z.enum(['male', 'female', 'neutral']);
+exports.VoiceGender = VoiceGender;
+/**
+ * Zod schema for voice configuration.
+ *
+ * Represents a synthetic voice option available for text-to-speech (TTS) synthesis. Voices are
+ * associated with TTS models in the Wiil support registry and selected in provisioning chains
+ * for voice-based deployments.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: WiilSupportModel (supportedVoices array for TTS models)
+ * - **Referenced In**: TtsModelConfig (voiceId selection) and ProvisioningConfigChain
+ * - **Purpose**: Defines available voice options for agent speech synthesis
+ *
+ * **Voice Characteristics:**
+ * - **Identity**: Unique ID and human-readable name
+ * - **Gender**: Male, female, or neutral classification
+ * - **Language**: Optimal language for the voice
+ * - **Default**: Flag for platform default selection
+ *
+ * @typedef {Object} VoiceProperties
+ * @property {string} voiceId - Unique identifier for the voice used in configurations (e.g., 'adam', 'rachel', 'en-us-standard-a')
+ * @property {string} name - Human-readable name of the voice for display in UI (e.g., 'Adam', 'Rachel', 'Google Standard A')
+ * @property {string} description - Description of the voice characteristics including tone, accent, and use cases (e.g., 'Deep, authoritative male voice', 'Warm, friendly female voice')
+ * @property {VoiceGender} gender - Gender classification of the voice (male, female, or neutral) for user preference filtering
+ * @property {string | null} [language] - Language code this voice is optimized for (e.g., 'en-US', 'es-ES', 'fr-FR'), null if multi-language
+ * @property {boolean} isDefault - Whether this is the default voice for its language or model (default: false)
+ *
+ * @example
+ * ```typescript
+ * const voice: Voice = {
+ *   voiceId: 'adam',
+ *   name: 'Adam',
+ *   description: 'Deep, authoritative male voice',
+ *   gender: 'male',
+ *   language: 'en-US',
+ *   isDefault: true
+ * };
+ * ```
+ */
+const VoiceSchema = zod_1.z.object({
+    voiceId: zod_1.z.string().min(1, 'Voice ID is required').describe("Unique identifier for the voice used in TTS configurations (e.g., 'adam', 'rachel', 'en-us-neural-female')"),
+    name: zod_1.z.string().min(1, 'Voice name is required').describe("Human-readable name of the voice displayed in user interfaces (e.g., 'Adam', 'Rachel', 'Google Neural Female')"),
+    description: zod_1.z.string().min(1, 'Voice description is required').describe("Description of the voice characteristics including tone, accent, pitch, and recommended use cases (e.g., 'Deep, authoritative male voice suitable for professional announcements')"),
+    gender: VoiceGender.describe("Gender classification of the voice (male, female, or neutral) used for filtering and user preference matching"),
+    language: zod_1.z.string().optional().nullable().describe("Language code this voice is optimized for in ISO 639-1 format with optional region (e.g., 'en-US', 'es-ES', 'fr-FR'), null if the voice supports multiple languages"),
+    isDefault: zod_1.z.boolean().default(false).describe("Whether this is the default voice selection for its language or TTS model, used for automatic voice assignment"),
+});
+exports.VoiceSchema = VoiceSchema;
+/**
+ * Zod schema for language configuration.
+ *
+ * Represents a language supported by the platform for speech processing (STT/TTS). Languages are
+ * associated with models in the Wiil support registry and selected in provisioning chains
+ * for voice-based and text-based interactions.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Used By**: WiilSupportModel (supportLanguages array)
+ * - **Referenced In**: SttModelConfig and TtsModelConfig (defaultLanguage selection)
+ * - **Purpose**: Defines supported languages for speech recognition and synthesis
+ *
+ * **Language Support Levels:**
+ * - **Production**: Fully supported, tested languages (isExperimental: false)
+ * - **Experimental**: Beta or limited support languages (isExperimental: true)
+ * - **Default**: Platform default for automatic selection (isDefault: true)
+ *
+ * @typedef {Object} LanguageProperties
+ * @property {string} languageId - Unique identifier for the language (e.g., 'en-us', 'es-es', 'fr-fr')
+ * @property {string} name - Human-readable name of the language for display (e.g., 'English (United States)', 'Spanish (Spain)')
+ * @property {string} code - Standard language code in ISO 639-1 format with optional region (e.g., 'en-US', 'es-ES', 'fr-FR')
+ * @property {boolean} [isDefault=false] - Whether this is the default language for the platform or model, used for automatic language selection
+ * @property {boolean} [isExperimental=false] - Whether this language is in experimental/beta support with potentially limited accuracy or features
+ *
+ * @example
+ * ```typescript
+ * const language: Language = {
+ *   languageId: 'en-us',
+ *   name: 'English (United States)',
+ *   code: 'en-US',
+ *   isDefault: true,
+ *   isExperimental: false
+ * };
+ * ```
+ */
+exports.LanguageSchema = zod_1.z.object({
+    languageId: zod_1.z.string().min(1, 'Language ID is required').describe("Unique identifier for the language, typically lowercase with region (e.g., 'en-us', 'es-mx', 'fr-ca')"),
+    name: zod_1.z.string().min(1, 'Language name is required').describe("Human-readable name of the language with region specification for user interfaces (e.g., 'English (United States)', 'Spanish (Mexico)', 'French (Canada)')"),
+    code: zod_1.z.string().describe("Standard language code in ISO 639-1 format with optional ISO 3166-1 region code (e.g., 'en-US', 'es-ES', 'zh-CN'), used for API requests and language detection"),
+    isDefault: zod_1.z.boolean().optional().default(false).describe("Whether this is the default language for the platform or model, used when no language is explicitly specified by the user"),
+    isExperimental: zod_1.z.boolean().optional().default(false).describe("Whether this language is in experimental or beta support status, potentially with limited accuracy, features, or voice options"),
+});
+/**
+ * Zod schema for an array of supported voices.
+ *
+ * Requires at least one voice to be provided.
+ */
+const SupportedVoicesSchema = zod_1.z.array(VoiceSchema).min(1, 'At least one voice must be supported');
+exports.SupportedVoicesSchema = SupportedVoicesSchema;
+/**
+ * Zod schema for an array of supported languages.
+ *
+ * Requires at least one language to be provided.
+ */
+exports.SupportedLanguagesSchema = zod_1.z.array(exports.LanguageSchema).min(1, 'At least one language must be supported');
+/**
+ * Validation function for supported voices.
+ *
+ * Parses and validates an array of voices, throwing an error if validation fails.
+ *
+ * @param voices - Unknown input to validate as supported voices
+ * @returns Validated array of voices
+ * @throws {ZodError} If validation fails
+ *
+ * @example
+ * ```typescript
+ * const voices = validateSupportedVoices([
+ *   { voiceId: 'adam', name: 'Adam', description: 'Male voice', gender: 'male', isDefault: true }
+ * ]);
+ * ```
+ */
+const validateSupportedVoices = (voices) => {
+    return SupportedVoicesSchema.parse(voices);
+};
+exports.validateSupportedVoices = validateSupportedVoices;
+/**
+ * Type guard function to check if an object is a valid Voice.
+ *
+ * @param voice - Unknown input to check
+ * @returns True if the input is a valid Voice, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isValidVoice(data)) {
+ *   console.log(data.voiceId); // TypeScript knows data is a Voice
+ * }
+ * ```
+ */
+const isValidVoice = (voice) => {
+    return VoiceSchema.safeParse(voice).success;
+};
+exports.isValidVoice = isValidVoice;

package/dist/core/type-definitions/account-definitions.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @fileoverview Account-related type definitions and enumerations.
+ * @module account/definitions
+ */
+/**
+ * Service status enumeration for organizations and projects.
+ *
+ * Defines the operational state of a service within the platform.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const orgStatus: ServiceStatus = ServiceStatus.ACTIVE;
+ * ```
+ */
+export declare enum ServiceStatus {
+    /** Service is operational and available */
+    ACTIVE = "active",
+    /** Service is not currently in use but can be reactivated */
+    INACTIVE = "inactive",
+    /** Service is temporarily suspended and requires intervention to resume */
+    SUSPENDED = "suspended"
+}
+/**
+ * Service suspension type enumeration.
+ *
+ * Indicates the reason or trigger for a service suspension.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const suspensionReason: ServiceSuspensionType = ServiceSuspensionType.QUOTA_EXCEEDED;
+ * ```
+ */
+export declare enum ServiceSuspensionType {
+    /** Service was manually suspended by an administrator or user */
+    MANUAL = "manual",
+    /** Service was automatically suspended by the system */
+    AUTOMATIC = "automatic",
+    /** Service was suspended due to subscription quota limits being exceeded */
+    SUBSCRIPTION_QUOTA_EXCEEDED = "subscription_quota_exceeded",
+    /** Service was suspended due to usage quota limits being exceeded */
+    QUOTA_EXCEEDED = "quota_exceeded",
+    /** Service was suspended due to failed payment transaction */
+    PAYMENT_FAILED = "payment_failed"
+}
+/**
+ * Business support services enumeration.
+ *
+ * Defines the types of business support services available in the platform
+ * for organizations to enable specific industry-focused features.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const enabledServices: BusinessSupportServices[] = [
+ *   BusinessSupportServices.APPOINTMENT_MANAGEMENT
+ * ];
+ * ```
+ */
+export declare enum BusinessSupportServices {
+    /** Appointment scheduling and management functionality */
+    APPOINTMENT_MANAGEMENT = "appointment_management",
+    /** Restaurant menu and food order management functionality */
+    MENU_ORDER_MANAGEMENT = "menu_order_management",
+    /** E-commerce product order management functionality */
+    PRODUCT_ORDER_MANAGEMENT = "product_order_management",
+    /** Table and venue reservation management functionality */
+    RESERVATION_MANAGEMENT = "reservation_management",
+    /** Property listing and rental management functionality */
+    PROPERTY_MANAGEMENT = "property_management",
+    /** Membership and subscription management functionality */
+    MEMBERSHIP_MANAGEMENT = "membership_management",
+    /** No business support services enabled */
+    NONE = "none"
+}

package/dist/core/type-definitions/account-definitions.js

@@ -0,0 +1,88 @@
+"use strict";
+/**
+ * @fileoverview Account-related type definitions and enumerations.
+ * @module account/definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BusinessSupportServices = exports.ServiceSuspensionType = exports.ServiceStatus = void 0;
+/**
+ * Service status enumeration for organizations and projects.
+ *
+ * Defines the operational state of a service within the platform.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const orgStatus: ServiceStatus = ServiceStatus.ACTIVE;
+ * ```
+ */
+var ServiceStatus;
+(function (ServiceStatus) {
+    /** Service is operational and available */
+    ServiceStatus["ACTIVE"] = "active";
+    /** Service is not currently in use but can be reactivated */
+    ServiceStatus["INACTIVE"] = "inactive";
+    /** Service is temporarily suspended and requires intervention to resume */
+    ServiceStatus["SUSPENDED"] = "suspended";
+})(ServiceStatus || (exports.ServiceStatus = ServiceStatus = {}));
+/**
+ * Service suspension type enumeration.
+ *
+ * Indicates the reason or trigger for a service suspension.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const suspensionReason: ServiceSuspensionType = ServiceSuspensionType.QUOTA_EXCEEDED;
+ * ```
+ */
+var ServiceSuspensionType;
+(function (ServiceSuspensionType) {
+    /** Service was manually suspended by an administrator or user */
+    ServiceSuspensionType["MANUAL"] = "manual";
+    /** Service was automatically suspended by the system */
+    ServiceSuspensionType["AUTOMATIC"] = "automatic";
+    /** Service was suspended due to subscription quota limits being exceeded */
+    ServiceSuspensionType["SUBSCRIPTION_QUOTA_EXCEEDED"] = "subscription_quota_exceeded";
+    /** Service was suspended due to usage quota limits being exceeded */
+    ServiceSuspensionType["QUOTA_EXCEEDED"] = "quota_exceeded";
+    /** Service was suspended due to failed payment transaction */
+    ServiceSuspensionType["PAYMENT_FAILED"] = "payment_failed";
+})(ServiceSuspensionType || (exports.ServiceSuspensionType = ServiceSuspensionType = {}));
+/**
+ * Business support services enumeration.
+ *
+ * Defines the types of business support services available in the platform
+ * for organizations to enable specific industry-focused features.
+ *
+ * @enum {string}
+ * @readonly
+ *
+ * @example
+ * ```typescript
+ * const enabledServices: BusinessSupportServices[] = [
+ *   BusinessSupportServices.APPOINTMENT_MANAGEMENT
+ * ];
+ * ```
+ */
+var BusinessSupportServices;
+(function (BusinessSupportServices) {
+    /** Appointment scheduling and management functionality */
+    BusinessSupportServices["APPOINTMENT_MANAGEMENT"] = "appointment_management";
+    /** Restaurant menu and food order management functionality */
+    BusinessSupportServices["MENU_ORDER_MANAGEMENT"] = "menu_order_management";
+    /** E-commerce product order management functionality */
+    BusinessSupportServices["PRODUCT_ORDER_MANAGEMENT"] = "product_order_management";
+    /** Table and venue reservation management functionality */
+    BusinessSupportServices["RESERVATION_MANAGEMENT"] = "reservation_management";
+    /** Property listing and rental management functionality */
+    BusinessSupportServices["PROPERTY_MANAGEMENT"] = "property_management";
+    /** Membership and subscription management functionality */
+    BusinessSupportServices["MEMBERSHIP_MANAGEMENT"] = "membership_management";
+    /** No business support services enabled */
+    BusinessSupportServices["NONE"] = "none";
+})(BusinessSupportServices || (exports.BusinessSupportServices = BusinessSupportServices = {}));