skedyul 0.1.39 → 0.1.41

package/dist/.build-stamp

@@ -1 +1 @@
-1768452178260
+1768542541896

package/dist/config.d.ts

@@ -242,6 +242,60 @@ export interface ModelDefinition {
     /** Model-level dependencies - other models this model requires to be provisioned */
     requires?: ResourceDependency[];
 }
+/** Relationship cardinality */
+export type RelationshipCardinality = 'ONE_TO_ONE' | 'ONE_TO_MANY' | 'MANY_TO_ONE' | 'MANY_TO_MANY';
+/** On-delete behavior for relationships */
+export type OnDeleteBehavior = 'NONE' | 'CASCADE' | 'RESTRICT';
+/** One side of a relationship */
+export interface RelationshipLink {
+    /** Model handle for this side */
+    model: string;
+    /** Field handle on this model */
+    field: string;
+    /** Field label for display */
+    label: string;
+    /** Cardinality from this side */
+    cardinality: RelationshipCardinality;
+    /** On-delete behavior */
+    onDelete?: OnDeleteBehavior;
+}
+/** Bidirectional relationship definition between two models */
+export interface RelationshipDefinition {
+    /** Source side of the relationship */
+    source: RelationshipLink;
+    /** Target side of the relationship */
+    target: RelationshipLink;
+}
+/** Page type: INSTANCE shows single record, LIST shows multiple records */
+export type PageType = 'INSTANCE' | 'LIST';
+/** Block types available for pages */
+export type PageBlockType = 'form' | 'spreadsheet' | 'kanban' | 'calendar' | 'link';
+/** Block definition within a page */
+export interface PageBlockDefinition {
+    /** Block type determines the UI component */
+    type: PageBlockType;
+    /** Block title displayed in UI */
+    title?: string;
+    /** Field handles to include in this block */
+    fields?: string[];
+    /** Whether the block is read-only (no editing) */
+    readonly?: boolean;
+}
+/** Page definition for internal model display */
+export interface PageDefinition {
+    /** Unique handle for the page */
+    handle: string;
+    /** Model handle this page displays */
+    model: string;
+    /** Page type: INSTANCE (single record) or LIST (multiple records) */
+    type: PageType;
+    /** Page title displayed in UI */
+    title: string;
+    /** Optional custom path for navigation */
+    path?: string;
+    /** Blocks that compose this page */
+    blocks: PageBlockDefinition[];
+}
 export type ChannelIdentifierType = 'DEDICATED_PHONE' | 'TEXT' | 'EMAIL';
 export interface ChannelIdentifierValue {
     /** Type of identifier */
@@ -450,6 +504,64 @@ export interface SkedyulConfig {
      * ```
      */
     models?: ModelDefinition[];
+    /**
+     * Relationships between models.
+     * Defines bidirectional links between INTERNAL models.
+     * Creates relationship fields on both sides automatically.
+     *
+     * @example
+     * ```typescript
+     * relationships: [
+     *   {
+     *     source: {
+     *       model: 'phone_number',
+     *       field: 'compliance_record',
+     *       label: 'Compliance Record',
+     *       cardinality: 'MANY_TO_ONE',
+     *       onDelete: 'RESTRICT',
+     *     },
+     *     target: {
+     *       model: 'compliance_record',
+     *       field: 'phone_numbers',
+     *       label: 'Phone Numbers',
+     *       cardinality: 'ONE_TO_MANY',
+     *       onDelete: 'NONE',
+     *     },
+     *   },
+     * ]
+     * ```
+     */
+    relationships?: RelationshipDefinition[];
+    /**
+     * Pages for internal models.
+     * Defines how internal models are displayed in the post-install UI.
+     * Each page references a model by handle and can have multiple pages per model.
+     *
+     * @example
+     * ```typescript
+     * pages: [
+     *   {
+     *     handle: 'compliance_submission',
+     *     model: 'compliance_record',
+     *     type: 'INSTANCE',
+     *     title: 'Submit Compliance Record',
+     *     blocks: [
+     *       { type: 'form', title: 'Business Registration', fields: ['file'] },
+     *     ],
+     *   },
+     *   {
+     *     handle: 'phone_numbers_list',
+     *     model: 'phone_number',
+     *     type: 'LIST',
+     *     title: 'Phone Numbers',
+     *     blocks: [
+     *       { type: 'spreadsheet', fields: ['phone', 'forwarding_phone_number'] },
+     *     ],
+     *   },
+     * ]
+     * ```
+     */
+    pages?: PageDefinition[];
     /**
      * Communication channels this app provides (new syntax).
      * Uses typed `requires` for dependencies.
@@ -504,6 +616,8 @@ export interface SerializableSkedyulConfig {
     postInstall?: PostInstallConfig;
     /** Unified model definitions (INTERNAL + SHARED) */
     models?: ModelDefinition[];
+    /** Pages for internal model display */
+    pages?: PageDefinition[];
     /** Communication channels (new syntax) */
     channels?: ChannelDefinition[];
     /** Communication channels (legacy) @deprecated */

package/dist/schemas.d.ts

@@ -361,6 +361,143 @@ export declare const FieldOptionSchema: z.ZodObject<{
     value: z.ZodString;
     color: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Schema for relationship cardinality.
+ * Defines how many records can be linked on each side.
+ */
+export declare const RelationshipCardinalitySchema: z.ZodEnum<{
+    ONE_TO_ONE: "ONE_TO_ONE";
+    ONE_TO_MANY: "ONE_TO_MANY";
+    MANY_TO_ONE: "MANY_TO_ONE";
+    MANY_TO_MANY: "MANY_TO_MANY";
+}>;
+/**
+ * Schema for on-delete behavior in relationships.
+ */
+export declare const OnDeleteBehaviorSchema: z.ZodEnum<{
+    NONE: "NONE";
+    CASCADE: "CASCADE";
+    RESTRICT: "RESTRICT";
+}>;
+/**
+ * Schema for a relationship link (one side of a relationship).
+ */
+export declare const RelationshipLinkSchema: z.ZodObject<{
+    model: z.ZodString;
+    field: z.ZodString;
+    label: z.ZodString;
+    cardinality: z.ZodEnum<{
+        ONE_TO_ONE: "ONE_TO_ONE";
+        ONE_TO_MANY: "ONE_TO_MANY";
+        MANY_TO_ONE: "MANY_TO_ONE";
+        MANY_TO_MANY: "MANY_TO_MANY";
+    }>;
+    onDelete: z.ZodDefault<z.ZodEnum<{
+        NONE: "NONE";
+        CASCADE: "CASCADE";
+        RESTRICT: "RESTRICT";
+    }>>;
+}, z.core.$strip>;
+/**
+ * Schema for a relationship definition.
+ * Relationships are bidirectional - they define links from both sides.
+ */
+export declare const RelationshipDefinitionSchema: z.ZodObject<{
+    source: z.ZodObject<{
+        model: z.ZodString;
+        field: z.ZodString;
+        label: z.ZodString;
+        cardinality: z.ZodEnum<{
+            ONE_TO_ONE: "ONE_TO_ONE";
+            ONE_TO_MANY: "ONE_TO_MANY";
+            MANY_TO_ONE: "MANY_TO_ONE";
+            MANY_TO_MANY: "MANY_TO_MANY";
+        }>;
+        onDelete: z.ZodDefault<z.ZodEnum<{
+            NONE: "NONE";
+            CASCADE: "CASCADE";
+            RESTRICT: "RESTRICT";
+        }>>;
+    }, z.core.$strip>;
+    target: z.ZodObject<{
+        model: z.ZodString;
+        field: z.ZodString;
+        label: z.ZodString;
+        cardinality: z.ZodEnum<{
+            ONE_TO_ONE: "ONE_TO_ONE";
+            ONE_TO_MANY: "ONE_TO_MANY";
+            MANY_TO_ONE: "MANY_TO_ONE";
+            MANY_TO_MANY: "MANY_TO_MANY";
+        }>;
+        onDelete: z.ZodDefault<z.ZodEnum<{
+            NONE: "NONE";
+            CASCADE: "CASCADE";
+            RESTRICT: "RESTRICT";
+        }>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Schema for page type.
+ * INSTANCE: Shows a single record (form-like)
+ * LIST: Shows multiple records (spreadsheet/table)
+ */
+export declare const PageTypeSchema: z.ZodEnum<{
+    INSTANCE: "INSTANCE";
+    LIST: "LIST";
+}>;
+/**
+ * Schema for block type in a page.
+ * Matches existing block types in the system.
+ */
+export declare const PageBlockTypeSchema: z.ZodEnum<{
+    form: "form";
+    spreadsheet: "spreadsheet";
+    kanban: "kanban";
+    calendar: "calendar";
+    link: "link";
+}>;
+/**
+ * Schema for a block definition within a page.
+ * Blocks define the UI components that render model data.
+ */
+export declare const PageBlockDefinitionSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        form: "form";
+        spreadsheet: "spreadsheet";
+        kanban: "kanban";
+        calendar: "calendar";
+        link: "link";
+    }>;
+    title: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for a page definition.
+ * Pages define how internal models are displayed in the post-install UI.
+ */
+export declare const PageDefinitionSchema: z.ZodObject<{
+    handle: z.ZodString;
+    model: z.ZodString;
+    type: z.ZodEnum<{
+        INSTANCE: "INSTANCE";
+        LIST: "LIST";
+    }>;
+    title: z.ZodString;
+    path: z.ZodOptional<z.ZodString>;
+    blocks: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            form: "form";
+            spreadsheet: "spreadsheet";
+            kanban: "kanban";
+            calendar: "calendar";
+            link: "link";
+        }>;
+        title: z.ZodOptional<z.ZodString>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        readonly: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 /**
  * Schema for inline field definition (constraints, options, etc.)
  * This allows defining field behavior without referencing a metafield definition.
@@ -376,7 +513,6 @@ export declare const InlineFieldDefinitionSchema: z.ZodObject<{
     maxLength: z.ZodOptional<z.ZodNumber>;
     min: z.ZodOptional<z.ZodNumber>;
     max: z.ZodOptional<z.ZodNumber>;
-    relatedModel: z.ZodOptional<z.ZodString>;
     pattern: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
@@ -411,7 +547,6 @@ export declare const ModelFieldDefinitionSchema: z.ZodObject<{
         maxLength: z.ZodOptional<z.ZodNumber>;
         min: z.ZodOptional<z.ZodNumber>;
         max: z.ZodOptional<z.ZodNumber>;
-        relatedModel: z.ZodOptional<z.ZodString>;
         pattern: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     required: z.ZodOptional<z.ZodBoolean>;
@@ -475,7 +610,6 @@ export declare const ModelDefinitionSchema: z.ZodObject<{
             maxLength: z.ZodOptional<z.ZodNumber>;
             min: z.ZodOptional<z.ZodNumber>;
             max: z.ZodOptional<z.ZodNumber>;
-            relatedModel: z.ZodOptional<z.ZodString>;
             pattern: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
         required: z.ZodOptional<z.ZodBoolean>;
@@ -700,7 +834,6 @@ export declare const SkedyulConfigSchema: z.ZodObject<{
                 maxLength: z.ZodOptional<z.ZodNumber>;
                 min: z.ZodOptional<z.ZodNumber>;
                 max: z.ZodOptional<z.ZodNumber>;
-                relatedModel: z.ZodOptional<z.ZodString>;
                 pattern: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>;
             required: z.ZodOptional<z.ZodBoolean>;
@@ -732,6 +865,62 @@ export declare const SkedyulConfigSchema: z.ZodObject<{
             workflow: z.ZodString;
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>>;
+    relationships: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        source: z.ZodObject<{
+            model: z.ZodString;
+            field: z.ZodString;
+            label: z.ZodString;
+            cardinality: z.ZodEnum<{
+                ONE_TO_ONE: "ONE_TO_ONE";
+                ONE_TO_MANY: "ONE_TO_MANY";
+                MANY_TO_ONE: "MANY_TO_ONE";
+                MANY_TO_MANY: "MANY_TO_MANY";
+            }>;
+            onDelete: z.ZodDefault<z.ZodEnum<{
+                NONE: "NONE";
+                CASCADE: "CASCADE";
+                RESTRICT: "RESTRICT";
+            }>>;
+        }, z.core.$strip>;
+        target: z.ZodObject<{
+            model: z.ZodString;
+            field: z.ZodString;
+            label: z.ZodString;
+            cardinality: z.ZodEnum<{
+                ONE_TO_ONE: "ONE_TO_ONE";
+                ONE_TO_MANY: "ONE_TO_MANY";
+                MANY_TO_ONE: "MANY_TO_ONE";
+                MANY_TO_MANY: "MANY_TO_MANY";
+            }>;
+            onDelete: z.ZodDefault<z.ZodEnum<{
+                NONE: "NONE";
+                CASCADE: "CASCADE";
+                RESTRICT: "RESTRICT";
+            }>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>>;
+    pages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        model: z.ZodString;
+        type: z.ZodEnum<{
+            INSTANCE: "INSTANCE";
+            LIST: "LIST";
+        }>;
+        title: z.ZodString;
+        path: z.ZodOptional<z.ZodString>;
+        blocks: z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<{
+                form: "form";
+                spreadsheet: "spreadsheet";
+                kanban: "kanban";
+                calendar: "calendar";
+                link: "link";
+            }>;
+            title: z.ZodOptional<z.ZodString>;
+            fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            readonly: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
     channels: z.ZodOptional<z.ZodArray<z.ZodObject<{
         handle: z.ZodString;
         name: z.ZodString;
@@ -900,6 +1089,22 @@ export type StructuredFilter = z.infer<typeof StructuredFilterSchema>;
 export type FieldOption = z.infer<typeof FieldOptionSchema>;
 /** Inline field definition (constraints, options, etc.) */
 export type InlineFieldDefinition = z.infer<typeof InlineFieldDefinitionSchema>;
+/** Relationship cardinality type */
+export type RelationshipCardinality = z.infer<typeof RelationshipCardinalitySchema>;
+/** On-delete behavior type */
+export type OnDeleteBehavior = z.infer<typeof OnDeleteBehaviorSchema>;
+/** Relationship link (one side of a relationship) */
+export type RelationshipLink = z.infer<typeof RelationshipLinkSchema>;
+/** Relationship definition */
+export type RelationshipDefinition = z.infer<typeof RelationshipDefinitionSchema>;
+/** Page type */
+export type PageType = z.infer<typeof PageTypeSchema>;
+/** Page block type */
+export type PageBlockType = z.infer<typeof PageBlockTypeSchema>;
+/** Page block definition */
+export type PageBlockDefinition = z.infer<typeof PageBlockDefinitionSchema>;
+/** Page definition */
+export type PageDefinition = z.infer<typeof PageDefinitionSchema>;
 /** Model dependency reference */
 export type ModelDependency = z.infer<typeof ModelDependencySchema>;
 /** Channel dependency reference */

package/dist/schemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SkedyulConfigSchema = exports.InternalModelDefinitionSchema = exports.InternalFieldDefinitionSchema = exports.InternalFieldDataTypeSchema = exports.ModelDefinitionSchema = exports.ModelFieldDefinitionSchema = exports.InlineFieldDefinitionSchema = exports.FieldOptionSchema = exports.FieldDataTypeSchema = exports.ComputeLayerTypeSchema = exports.WorkflowDefinitionSchema = exports.WorkflowActionSchema = exports.WorkflowActionInputSchema = exports.ChannelDefinitionSchema = exports.CommunicationChannelDefinitionSchema = exports.ResourceDependencySchema = exports.WorkflowDependencySchema = exports.ChannelDependencySchema = exports.ModelDependencySchema = exports.StructuredFilterSchema = exports.FieldOwnerSchema = exports.ResourceScopeSchema = exports.ChannelIdentifierValueSchema = exports.ChannelIdentifierTypeSchema = exports.ChannelToolBindingsSchema = exports.AppFieldDefinitionSchema = exports.AppFieldVisibilitySchema = exports.InstallConfigSchema = exports.AppModelDefinitionSchema = exports.EnvSchemaSchema = exports.EnvVariableDefinitionSchema = exports.EnvVisibilitySchema = void 0;
+exports.SkedyulConfigSchema = exports.InternalModelDefinitionSchema = exports.InternalFieldDefinitionSchema = exports.InternalFieldDataTypeSchema = exports.ModelDefinitionSchema = exports.ModelFieldDefinitionSchema = exports.InlineFieldDefinitionSchema = exports.PageDefinitionSchema = exports.PageBlockDefinitionSchema = exports.PageBlockTypeSchema = exports.PageTypeSchema = exports.RelationshipDefinitionSchema = exports.RelationshipLinkSchema = exports.OnDeleteBehaviorSchema = exports.RelationshipCardinalitySchema = exports.FieldOptionSchema = exports.FieldDataTypeSchema = exports.ComputeLayerTypeSchema = exports.WorkflowDefinitionSchema = exports.WorkflowActionSchema = exports.WorkflowActionInputSchema = exports.ChannelDefinitionSchema = exports.CommunicationChannelDefinitionSchema = exports.ResourceDependencySchema = exports.WorkflowDependencySchema = exports.ChannelDependencySchema = exports.ModelDependencySchema = exports.StructuredFilterSchema = exports.FieldOwnerSchema = exports.ResourceScopeSchema = exports.ChannelIdentifierValueSchema = exports.ChannelIdentifierTypeSchema = exports.ChannelToolBindingsSchema = exports.AppFieldDefinitionSchema = exports.AppFieldVisibilitySchema = exports.InstallConfigSchema = exports.AppModelDefinitionSchema = exports.EnvSchemaSchema = exports.EnvVariableDefinitionSchema = exports.EnvVisibilitySchema = void 0;
 exports.safeParseConfig = safeParseConfig;
 exports.isModelDependency = isModelDependency;
 exports.isChannelDependency = isChannelDependency;
@@ -245,6 +245,101 @@ exports.FieldOptionSchema = zod_1.z.object({
     /** Optional color for UI display */
     color: zod_1.z.string().optional(),
 });
+/**
+ * Schema for relationship cardinality.
+ * Defines how many records can be linked on each side.
+ */
+exports.RelationshipCardinalitySchema = zod_1.z.enum([
+    'ONE_TO_ONE',
+    'ONE_TO_MANY',
+    'MANY_TO_ONE',
+    'MANY_TO_MANY',
+]);
+/**
+ * Schema for on-delete behavior in relationships.
+ */
+exports.OnDeleteBehaviorSchema = zod_1.z.enum([
+    'NONE', // No action
+    'CASCADE', // Delete related records
+    'RESTRICT', // Prevent deletion
+]);
+/**
+ * Schema for a relationship link (one side of a relationship).
+ */
+exports.RelationshipLinkSchema = zod_1.z.object({
+    /** Model handle for this side of the relationship */
+    model: zod_1.z.string(),
+    /** Field handle on this model */
+    field: zod_1.z.string(),
+    /** Field label for display */
+    label: zod_1.z.string(),
+    /** Cardinality from this side */
+    cardinality: exports.RelationshipCardinalitySchema,
+    /** On-delete behavior */
+    onDelete: exports.OnDeleteBehaviorSchema.default('NONE'),
+});
+/**
+ * Schema for a relationship definition.
+ * Relationships are bidirectional - they define links from both sides.
+ */
+exports.RelationshipDefinitionSchema = zod_1.z.object({
+    /** Source side of the relationship */
+    source: exports.RelationshipLinkSchema,
+    /** Target side of the relationship */
+    target: exports.RelationshipLinkSchema,
+});
+// ─────────────────────────────────────────────────────────────────────────────
+// Page and Block Schemas
+// ─────────────────────────────────────────────────────────────────────────────
+/**
+ * Schema for page type.
+ * INSTANCE: Shows a single record (form-like)
+ * LIST: Shows multiple records (spreadsheet/table)
+ */
+exports.PageTypeSchema = zod_1.z.enum(['INSTANCE', 'LIST']);
+/**
+ * Schema for block type in a page.
+ * Matches existing block types in the system.
+ */
+exports.PageBlockTypeSchema = zod_1.z.enum([
+    'form',
+    'spreadsheet',
+    'kanban',
+    'calendar',
+    'link',
+]);
+/**
+ * Schema for a block definition within a page.
+ * Blocks define the UI components that render model data.
+ */
+exports.PageBlockDefinitionSchema = zod_1.z.object({
+    /** Block type determines the UI component */
+    type: exports.PageBlockTypeSchema,
+    /** Block title displayed in UI */
+    title: zod_1.z.string().optional(),
+    /** Field handles to include in this block */
+    fields: zod_1.z.array(zod_1.z.string()).optional(),
+    /** Whether the block is read-only (no editing) */
+    readonly: zod_1.z.boolean().optional(),
+});
+/**
+ * Schema for a page definition.
+ * Pages define how internal models are displayed in the post-install UI.
+ */
+exports.PageDefinitionSchema = zod_1.z.object({
+    /** Unique handle for the page */
+    handle: zod_1.z.string(),
+    /** Model handle this page displays */
+    model: zod_1.z.string(),
+    /** Page type: INSTANCE (single record) or LIST (multiple records) */
+    type: exports.PageTypeSchema,
+    /** Page title displayed in UI */
+    title: zod_1.z.string(),
+    /** Optional custom path for navigation */
+    path: zod_1.z.string().optional(),
+    /** Blocks that compose this page */
+    blocks: zod_1.z.array(exports.PageBlockDefinitionSchema),
+});
 /**
  * Schema for inline field definition (constraints, options, etc.)
  * This allows defining field behavior without referencing a metafield definition.
@@ -262,8 +357,6 @@ exports.InlineFieldDefinitionSchema = zod_1.z.object({
     min: zod_1.z.number().optional(),
     /** For number fields: max value */
     max: zod_1.z.number().optional(),
-    /** For relation fields: target model handle */
-    relatedModel: zod_1.z.string().optional(),
     /** Validation regex pattern */
     pattern: zod_1.z.string().optional(),
 });
@@ -385,6 +478,10 @@ exports.SkedyulConfigSchema = zod_1.z.object({
         .optional(),
     // New unified model definitions (INTERNAL + SHARED)
     models: zod_1.z.array(exports.ModelDefinitionSchema).optional(),
+    // Relationships between models
+    relationships: zod_1.z.array(exports.RelationshipDefinitionSchema).optional(),
+    // Pages for internal models (displayed in post-install UI)
+    pages: zod_1.z.array(exports.PageDefinitionSchema).optional(),
     // New channel syntax (alias for communicationChannels)
     channels: zod_1.z.array(exports.ChannelDefinitionSchema).optional(),
     // Legacy: communication channels (deprecated - use channels)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.1.39",
+  "version": "0.1.41",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",