wiil-core-js 0.0.82

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WIIL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,174 @@
+# Wiil Core JS
+
+Public schema definitions for WIIL Platform REST API resources and SDKs.
+
+This package exposes Zod schemas, inferred TypeScript types, and request utility
+models used by WIIL services and generated client SDKs. The source of truth lives
+under `src/core`; the public API examples and resource guides live under
+`documentation`.
+
+## Package
+
+- Package name: `wiil-core-js`
+- Runtime format: CommonJS
+- Validation library: `zod`
+- Main entrypoint: `dist/index.js`
+- Type declarations: `dist/index.d.ts`
+
+## What This Package Contains
+
+### Core Schemas
+
+`src/core` is the central schema surface.
+
+| Area | Purpose |
+| --- | --- |
+| `account` | Organizations, projects, and supported business verticals |
+| `assistant-setups` | Assistant setup definitions |
+| `business-mgt` | Business catalog, customer, order, booking, reservation, and pricing resources |
+| `conversation` | Conversation configs, messages, translation, outbound calls, email, SMS, and templates |
+| `service-configuration` | Agent, instruction, deployment, channel, voice, telephony, knowledge, and dynamic setup schemas |
+| `type-definitions` | Shared enums, dynamic field definitions, and reusable type primitives |
+| `validators` | Shared validation helpers |
+| `base.schema.ts` | Base model, address, phone number, and language code schemas |
+
+The root package exports `src/core` and `src/request`.
+
+```ts
+import {
+  BusinessLocationSchema,
+  CreateCustomerGroupSchema,
+  DeploymentConfigurationSchema,
+} from "wiil-core-js";
+```
+
+## Business Management Domains
+
+The `business-mgt` module exports shared business resources and domain-specific
+catalog models.
+
+| Domain | Examples |
+| --- | --- |
+| Shared business resources | Business locations, tax rules, discount rules, orders, pricing rules, booking primitives |
+| Customer management | Customers, customer groups, shipping addresses |
+| Service management | Service categories, service configs, providers, appointments, slot queries, pricing rules |
+| Reservation management | Resource catalogs, floor plans, sections, table/room/rental reservations, assignments, settings, slot queries |
+| Menu management | Menu categories, menu items, variants, modifiers, menu sets, menu pricing rules, menu orders |
+| Product management | Product categories, products, variants, axes, product sets, pricing rules, product orders |
+| Property management | Property catalog resources |
+
+## Documentation
+
+The `documentation` folder contains the public REST and SDK-facing resource
+guides. Request and response examples in these files are represented as JSON,
+not TypeScript implementation snippets.
+
+| Documentation Area | Files |
+| --- | --- |
+| Catalog overview | `documentation/catalog/*.md` |
+| Business locations | `documentation/catalog/business-location.md` |
+| Customer management | `documentation/catalog/customer-management.md` |
+| Menu ordering | `documentation/catalog/menu-order-management/*.md` |
+| Product ordering | `documentation/catalog/product-order-management/*.md` |
+| Reservation management | `documentation/catalog/reservation-management/*.md` |
+| Service appointments | `documentation/catalog/service-appointment-management/*.md` |
+| Service configuration | `documentation/service-configuration/*.md` |
+| Conversation and communication | `documentation/service-conversation.md`, `documentation/communication-request.md`, `documentation/translation-*.md` |
+| Shared pricing resources | `documentation/tax-rule.md`, `documentation/discount-rule.md` |
+
+## Runtime JSON Payloads
+
+API payloads are plain JSON. The schemas in this package validate those payloads
+and provide SDK type inference.
+
+```json
+{
+  "name": "Downtown Branch",
+  "code": "DTWN",
+  "status": "ACTIVE",
+  "isPrimary": true,
+  "timezone": "America/New_York",
+  "businessHours": {
+    "1": {
+      "isOpen": true,
+      "startTime": "09:00",
+      "endTime": "17:00"
+    }
+  },
+  "phoneNumber": "+15551234567",
+  "email": "downtown@example.com",
+  "coordinates": {
+    "latitude": 39.7817,
+    "longitude": -89.6501
+  }
+}
+```
+
+## TypeScript Consumers
+
+Consumers can parse, validate, and infer types from the exported schemas.
+
+```ts
+import { BusinessLocationSchema, type BusinessLocation } from "wiil-core-js";
+
+const result = BusinessLocationSchema.safeParse({
+  id: "loc_downtown",
+  name: "Downtown Branch",
+  status: "ACTIVE",
+  isPrimary: true,
+  businessHours: {
+    "1": {
+      isOpen: true,
+      startTime: "09:00",
+      endTime: "17:00",
+    },
+  },
+});
+
+if (result.success) {
+  const location: BusinessLocation = result.data;
+}
+```
+
+## Schema Conventions
+
+- Complete resource schemas generally extend `BaseModelSchema`, which provides
+  `id`, `createdAt`, and `updatedAt`.
+- Create schemas omit system-managed fields.
+- Update schemas are partial create schemas with a required `id`.
+- Public documentation examples use JSON request and response payloads.
+- Type definitions should be read from the source schemas rather than assumed.
+
+## Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Build the package:
+
+```bash
+npm run build
+```
+
+Generate API reference documentation:
+
+```bash
+npm run docs
+```
+
+There is no application server required for this package. It is a schema and
+type-definition library.
+
+## Repository Map
+
+```text
+src/
+  index.ts                  Package entrypoint
+  core/                     Public schema definitions
+  request/                  Request and pagination utility models
+documentation/              Public JSON examples and resource guides
+docs/                       Generated TypeDoc output
+```

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

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Central export point for all account management schemas.
+ * @module account
+ */
+export * from './organization.schema';
+export * from './project.schema';
+export * from './supported-business-verticals';

package/dist/core/account/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @fileoverview Central export point for all account management schemas.
+ * @module account
+ */
+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("./organization.schema"), exports);
+__exportStar(require("./project.schema"), exports);
+__exportStar(require("./supported-business-verticals"), exports);

package/dist/core/account/organization.schema.d.ts

@@ -0,0 +1,118 @@
+import { z } from 'zod';
+import { ServiceStatus, ServiceSuspensionType } from '../type-definitions';
+/**
+ * @fileoverview Organization schema definitions for account management.
+ * @module account/organization
+ */
+/**
+ * Zod schema for organization service status history records.
+ *
+ * Tracks all status changes for an organization over time, providing
+ * an audit trail of service state transitions.
+ *
+ * @typedef {Object} OrganizationServiceStatusRecordProperties
+ * @property {string} id - Unique identifier for the status record
+ * @property {ServiceStatus} status - Current status at the time of this record
+ * @property {ServiceStatus | null} previousStatus - Previous status before this change
+ * @property {ServiceSuspensionType | null} suspensionType - Type of suspension if status is SUSPENDED
+ * @property {number} timestamp - Unix timestamp when the status change occurred
+ * @property {string} reason - Explanation for the status change
+ * @property {string} changedBy - User ID who initiated the status change
+ * @property {boolean} isCurrent - Whether this is the current active status record (default: true)
+ * @property {number} [createdAt] - Timestamp when the record was created
+ * @property {number} [updatedAt] - Timestamp when the record was last updated
+ *
+ * @example
+ * ```typescript
+ * const statusRecord: OrganizationServiceStatusRecord = {
+ *   id: '123*',
+ *   status: ServiceStatus.SUSPENDED,
+ *   previousStatus: ServiceStatus.ACTIVE,
+ *   suspensionType: ServiceSuspensionType.QUOTA_EXCEEDED,
+ *   timestamp: Date.now(),
+ *   reason: 'Monthly usage quota exceeded',
+ *   changedBy: 'system',
+ *   isCurrent: true,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const OrganizationServiceStatusRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    status: z.ZodEnum<typeof ServiceStatus>;
+    previousStatus: z.ZodNullable<z.ZodEnum<typeof ServiceStatus>>;
+    suspensionType: z.ZodNullable<z.ZodEnum<typeof ServiceSuspensionType>>;
+    timestamp: z.ZodNumber;
+    reason: z.ZodString;
+    changedBy: z.ZodString;
+    isCurrent: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type OrganizationServiceStatusRecord = z.infer<typeof OrganizationServiceStatusRecordSchema>;
+/**
+ * Zod schema for organization entity.
+ *
+ * Represents a complete organization (company/business account) within the platform,
+ * including service status tracking and configuration.
+ *
+ * @typedef {Object} OrganizationProperties
+ * @property {string} id - Unique identifier for the organization
+ * @property {string} companyName - Organization's company name (minimum 2 characters)
+ * @property {SupportedBusinessVerticalId | null} [businessVerticalId] - Business industry vertical classification ID
+ * @property {Record<string, any>} [metadata] - Additional custom metadata for the organization
+ * @property {ServiceStatus} serviceStatus - Current service status (default: ACTIVE)
+ * @property {number | null} [lastServiceStatusChanged] - Timestamp of last service status change
+ * @property {OrganizationServiceStatusRecord[] | null} [serviceStatusHistory] - Complete history of service status changes
+ * @property {string | null} [platformEmail] - Organization's platform contact email
+ * @property {string | null} [primarySlug] - Primary URL slug identifier for the organization
+ * @property {string | null} [primaryWiilUrl] - Primary Wiil URL for the organization
+ * @property {string | null} [transactionsCurrency] - Default currency for transactions
+ * @property {string | null} [businessInformation] - Brief business description (max 160 characters)
+ * @property {string | null} [detailedBusinessInformation] - Detailed business description (max 1000 characters)
+ * @property {number} [createdAt] - Timestamp when the organization was created
+ * @property {number} [updatedAt] - Timestamp when the organization was last updated
+ */
+export declare const OrganizationSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    companyName: z.ZodString;
+    businessVerticalId: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        retail: "retail";
+        healthcare: "healthcare";
+        "health-wellness": "health-wellness";
+        finance: "finance";
+        "real-estate": "real-estate";
+        technology: "technology";
+        education: "education";
+        legal: "legal";
+        automotive: "automotive";
+        hospitality: "hospitality";
+        professional: "professional";
+        others: "others";
+    }>>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    serviceStatus: z.ZodDefault<z.ZodEnum<typeof ServiceStatus>>;
+    lastServiceStatusChanged: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    serviceStatusHistory: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        createdAt: z.ZodOptional<z.ZodNumber>;
+        updatedAt: z.ZodOptional<z.ZodNumber>;
+        status: z.ZodEnum<typeof ServiceStatus>;
+        previousStatus: z.ZodNullable<z.ZodEnum<typeof ServiceStatus>>;
+        suspensionType: z.ZodNullable<z.ZodEnum<typeof ServiceSuspensionType>>;
+        timestamp: z.ZodNumber;
+        reason: z.ZodString;
+        changedBy: z.ZodString;
+        isCurrent: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>>;
+    platformEmail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    primarySlug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    primaryWiilUrl: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
+    transactionsCurrency: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    businessInformation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    detailedBusinessInformation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type Organization = z.infer<typeof OrganizationSchema>;

package/dist/core/account/organization.schema.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationSchema = exports.OrganizationServiceStatusRecordSchema = void 0;
+const zod_1 = require("zod");
+const type_definitions_1 = require("../type-definitions");
+const base_schema_1 = require("../base.schema");
+const supported_business_verticals_1 = require("./supported-business-verticals");
+/**
+ * @fileoverview Organization schema definitions for account management.
+ * @module account/organization
+ */
+/**
+ * Zod schema for organization service status history records.
+ *
+ * Tracks all status changes for an organization over time, providing
+ * an audit trail of service state transitions.
+ *
+ * @typedef {Object} OrganizationServiceStatusRecordProperties
+ * @property {string} id - Unique identifier for the status record
+ * @property {ServiceStatus} status - Current status at the time of this record
+ * @property {ServiceStatus | null} previousStatus - Previous status before this change
+ * @property {ServiceSuspensionType | null} suspensionType - Type of suspension if status is SUSPENDED
+ * @property {number} timestamp - Unix timestamp when the status change occurred
+ * @property {string} reason - Explanation for the status change
+ * @property {string} changedBy - User ID who initiated the status change
+ * @property {boolean} isCurrent - Whether this is the current active status record (default: true)
+ * @property {number} [createdAt] - Timestamp when the record was created
+ * @property {number} [updatedAt] - Timestamp when the record was last updated
+ *
+ * @example
+ * ```typescript
+ * const statusRecord: OrganizationServiceStatusRecord = {
+ *   id: '123*',
+ *   status: ServiceStatus.SUSPENDED,
+ *   previousStatus: ServiceStatus.ACTIVE,
+ *   suspensionType: ServiceSuspensionType.QUOTA_EXCEEDED,
+ *   timestamp: Date.now(),
+ *   reason: 'Monthly usage quota exceeded',
+ *   changedBy: 'system',
+ *   isCurrent: true,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+exports.OrganizationServiceStatusRecordSchema = base_schema_1.BaseModelSchema.safeExtend({
+    status: zod_1.z.enum(type_definitions_1.ServiceStatus).describe("Current status at the time of this record"),
+    previousStatus: zod_1.z.enum(type_definitions_1.ServiceStatus).nullable().describe("Previous status before this change"),
+    suspensionType: zod_1.z.enum(type_definitions_1.ServiceSuspensionType).nullable().describe("Type of suspension if status is SUSPENDED"),
+    timestamp: zod_1.z.number().describe("Unix timestamp when the status change occurred"),
+    reason: zod_1.z.string().describe("Explanation for the status change"),
+    changedBy: zod_1.z.string().describe("User ID who initiated the status change"),
+    isCurrent: zod_1.z.boolean().default(true).describe("Whether this is the current active status record"),
+});
+/**
+ * Zod schema for organization entity.
+ *
+ * Represents a complete organization (company/business account) within the platform,
+ * including service status tracking and configuration.
+ *
+ * @typedef {Object} OrganizationProperties
+ * @property {string} id - Unique identifier for the organization
+ * @property {string} companyName - Organization's company name (minimum 2 characters)
+ * @property {SupportedBusinessVerticalId | null} [businessVerticalId] - Business industry vertical classification ID
+ * @property {Record<string, any>} [metadata] - Additional custom metadata for the organization
+ * @property {ServiceStatus} serviceStatus - Current service status (default: ACTIVE)
+ * @property {number | null} [lastServiceStatusChanged] - Timestamp of last service status change
+ * @property {OrganizationServiceStatusRecord[] | null} [serviceStatusHistory] - Complete history of service status changes
+ * @property {string | null} [platformEmail] - Organization's platform contact email
+ * @property {string | null} [primarySlug] - Primary URL slug identifier for the organization
+ * @property {string | null} [primaryWiilUrl] - Primary Wiil URL for the organization
+ * @property {string | null} [transactionsCurrency] - Default currency for transactions
+ * @property {string | null} [businessInformation] - Brief business description (max 160 characters)
+ * @property {string | null} [detailedBusinessInformation] - Detailed business description (max 1000 characters)
+ * @property {number} [createdAt] - Timestamp when the organization was created
+ * @property {number} [updatedAt] - Timestamp when the organization was last updated
+ */
+exports.OrganizationSchema = base_schema_1.BaseModelSchema.safeExtend({
+    companyName: zod_1.z.string().min(2).describe("Organization's company name (minimum 2 characters)"),
+    businessVerticalId: zod_1.z.enum(supported_business_verticals_1.SUPPORTED_BUSINESS_VERTICALS).nullable().optional().describe("Business industry vertical classification ID (healthcare, retail, technology, etc.)"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional custom metadata for the organization"),
+    serviceStatus: zod_1.z.enum(type_definitions_1.ServiceStatus).default(type_definitions_1.ServiceStatus.ACTIVE).describe("Current service status of the organization"),
+    lastServiceStatusChanged: zod_1.z.number().nullable().optional().describe("Timestamp of last service status change"),
+    serviceStatusHistory: zod_1.z.array(exports.OrganizationServiceStatusRecordSchema).nullable().optional().describe("Complete history of service status changes"),
+    platformEmail: zod_1.z.string().nullable().optional().describe("Organization's platform contact email"),
+    primarySlug: zod_1.z.string().nullable().optional().describe("Primary URL slug identifier for the organization"),
+    primaryWiilUrl: zod_1.z.url().nullable().optional().describe("Primary Wiil URL for the organization"),
+    transactionsCurrency: zod_1.z.string().nullable().optional().describe("Default currency for transactions"),
+    businessInformation: zod_1.z.string().max(160).nullable().optional().describe("Brief business description (max 160 characters)"),
+    detailedBusinessInformation: zod_1.z.string().max(1000).nullable().optional().describe("Detailed business description (max 1000 characters)"),
+});

package/dist/core/account/project.schema.d.ts

@@ -0,0 +1,121 @@
+import { z } from 'zod';
+import { ServiceStatus } from '../type-definitions';
+/**
+ * @fileoverview Project schema definitions for account management.
+ * @module account/project
+ */
+/**
+ * Zod schema for project entity.
+ *
+ * Represents a project within an organization. Projects are used to organize
+ * resources, deployments, and configurations within an organizational context.
+ *
+ * @typedef {Object} ProjectProperties
+ * @property {string} id - Unique identifier for the project
+ * @property {string} name - Project name (minimum 2 characters)
+ * @property {string | undefined} [regionId] - Geographic region ID for this project (optional, can inherit from organization)
+ * @property {string} [description] - Optional description of the project's purpose
+ * @property {string[]} [compliance] - Optional array of compliance standards this project adheres to
+ * @property {boolean} isDefault - Whether this is the default project for the organization
+ * @property {ServiceStatus} serviceStatus - Current service status (default: ACTIVE)
+ * @property {Record<string, any>} [metadata] - Additional custom metadata for the project
+ * @property {number} [createdAt] - Timestamp when the project was created
+ * @property {number} [updatedAt] - Timestamp when the project was last updated
+ *
+ * @example
+ * ```typescript
+ * const project: Project = {
+ *   id: '123*',
+ *   name: 'Production Environment',
+ *   regionId: 'us-west-2',
+ *   description: 'Main production deployment project',
+ *   compliance: ['SOC2', 'HIPAA'],
+ *   isDefault: true,
+ *   serviceStatus: ServiceStatus.ACTIVE,
+ *   metadata: { environment: 'production' },
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const ProjectSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodString;
+    regionId: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    compliance: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isDefault: z.ZodBoolean;
+    serviceStatus: z.ZodDefault<z.ZodEnum<typeof ServiceStatus>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * Zod schema for creating a new project.
+ *
+ * Omits auto-generated fields (id, timestamps) and system-managed fields (isDefault)
+ * that are populated by the system.
+ *
+ * @remarks
+ * Use this schema when creating new projects within an organization.
+ * All required fields must be provided.
+ *
+ * @example
+ * ```typescript
+ * const newProject: CreateProject = {
+ *   name: 'Development Environment',
+ *   regionId: 'us-east-1',
+ *   description: 'Development and testing project',
+ *   compliance: ['SOC2'],
+ *   serviceStatus: ServiceStatus.ACTIVE,
+ *   metadata: { environment: 'development' }
+ * };
+ * ```
+ */
+export declare const CreateProjectSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    serviceStatus: z.ZodDefault<z.ZodEnum<typeof ServiceStatus>>;
+    name: z.ZodString;
+    regionId: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    compliance: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Zod schema for updating an existing project.
+ *
+ * All fields are optional (partial) except id, which is required to identify the project.
+ *
+ * @remarks
+ * Supports partial updates - only include the fields you want to modify.
+ *
+ * @example
+ * ```typescript
+ * const updateProject: UpdateProject = {
+ *   id: '123*',
+ *   name: 'Production Environment v2',
+ *   description: 'Updated production deployment',
+ *   hasRate: true
+ * };
+ * ```
+ */
+export declare const UpdateProjectSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    serviceStatus: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof ServiceStatus>>>;
+    name: z.ZodOptional<z.ZodString>;
+    regionId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    description: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    compliance: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Type definition for a complete project entity.
+ */
+export type Project = z.infer<typeof ProjectSchema>;
+/**
+ * Type definition for creating a new project.
+ */
+export type CreateProject = z.infer<typeof CreateProjectSchema>;
+/**
+ * Type definition for updating an existing project.
+ */
+export type UpdateProject = z.infer<typeof UpdateProjectSchema>;

package/dist/core/account/project.schema.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateProjectSchema = exports.CreateProjectSchema = exports.ProjectSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Project schema definitions for account management.
+ * @module account/project
+ */
+/**
+ * Zod schema for project entity.
+ *
+ * Represents a project within an organization. Projects are used to organize
+ * resources, deployments, and configurations within an organizational context.
+ *
+ * @typedef {Object} ProjectProperties
+ * @property {string} id - Unique identifier for the project
+ * @property {string} name - Project name (minimum 2 characters)
+ * @property {string | undefined} [regionId] - Geographic region ID for this project (optional, can inherit from organization)
+ * @property {string} [description] - Optional description of the project's purpose
+ * @property {string[]} [compliance] - Optional array of compliance standards this project adheres to
+ * @property {boolean} isDefault - Whether this is the default project for the organization
+ * @property {ServiceStatus} serviceStatus - Current service status (default: ACTIVE)
+ * @property {Record<string, any>} [metadata] - Additional custom metadata for the project
+ * @property {number} [createdAt] - Timestamp when the project was created
+ * @property {number} [updatedAt] - Timestamp when the project was last updated
+ *
+ * @example
+ * ```typescript
+ * const project: Project = {
+ *   id: '123*',
+ *   name: 'Production Environment',
+ *   regionId: 'us-west-2',
+ *   description: 'Main production deployment project',
+ *   compliance: ['SOC2', 'HIPAA'],
+ *   isDefault: true,
+ *   serviceStatus: ServiceStatus.ACTIVE,
+ *   metadata: { environment: 'production' },
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+exports.ProjectSchema = base_schema_1.BaseModelSchema.safeExtend({
+    name: zod_1.z.string().min(2).describe("Project name (minimum 2 characters)"),
+    regionId: zod_1.z.string().optional().describe("Geographic region ID for this project (optional, can inherit from organization)"),
+    description: zod_1.z.string().optional().describe("Optional description of the project's purpose"),
+    compliance: zod_1.z.string().array().optional().describe("Array of compliance standards this project adheres to (e.g., SOC2, HIPAA)"),
+    isDefault: zod_1.z.boolean().describe("Whether this is the default project for the organization (system-managed flag, set automatically on creation)"),
+    serviceStatus: zod_1.z.enum(type_definitions_1.ServiceStatus).default(type_definitions_1.ServiceStatus.ACTIVE).describe("Current service status of the project"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional custom metadata for the project"),
+});
+/**
+ * Zod schema for creating a new project.
+ *
+ * Omits auto-generated fields (id, timestamps) and system-managed fields (isDefault)
+ * that are populated by the system.
+ *
+ * @remarks
+ * Use this schema when creating new projects within an organization.
+ * All required fields must be provided.
+ *
+ * @example
+ * ```typescript
+ * const newProject: CreateProject = {
+ *   name: 'Development Environment',
+ *   regionId: 'us-east-1',
+ *   description: 'Development and testing project',
+ *   compliance: ['SOC2'],
+ *   serviceStatus: ServiceStatus.ACTIVE,
+ *   metadata: { environment: 'development' }
+ * };
+ * ```
+ */
+exports.CreateProjectSchema = exports.ProjectSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+    isDefault: true,
+});
+/**
+ * Zod schema for updating an existing project.
+ *
+ * All fields are optional (partial) except id, which is required to identify the project.
+ *
+ * @remarks
+ * Supports partial updates - only include the fields you want to modify.
+ *
+ * @example
+ * ```typescript
+ * const updateProject: UpdateProject = {
+ *   id: '123*',
+ *   name: 'Production Environment v2',
+ *   description: 'Updated production deployment',
+ *   hasRate: true
+ * };
+ * ```
+ */
+exports.UpdateProjectSchema = exports.CreateProjectSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});

package/dist/core/account/supported-business-verticals.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Supported Business Vertical IDs
+ *
+ * This file contains only the business vertical IDs extracted from
+ * business-verticals-definitions.ts for use in validation and type checking.
+ */
+export declare const SUPPORTED_BUSINESS_VERTICALS: readonly ["healthcare", "health-wellness", "retail", "finance", "real-estate", "technology", "education", "legal", "automotive", "hospitality", "professional", "others"];
+export type SupportedBusinessVerticalId = typeof SUPPORTED_BUSINESS_VERTICALS[number];