@objectstack/spec 0.1.1 → 0.1.2

package/dist/system/manifest.zod.d.ts

@@ -1,24 +1,4 @@
 import { z } from 'zod';
-/**
- * Schema for menu items in ObjectStack packages.
- * Defines navigation structure that can be injected into the UI.
- */
-export declare const MenuItemSchema: z.ZodObject<{
-    /** Display label for the menu item */
-    label: z.ZodString;
-    /** Navigation path (route) for the menu item */
-    path: z.ZodString;
-    /** Optional icon identifier for the menu item */
-    icon: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    path: string;
-    label: string;
-    icon?: string | undefined;
-}, {
-    path: string;
-    label: string;
-    icon?: string | undefined;
-}>;
 /**
  * Schema for the ObjectStack Manifest.
  * This defines the structure of a package configuration in the ObjectStack ecosystem.
@@ -57,29 +37,240 @@ export declare const ManifestSchema: z.ZodObject<{
      */
     permissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     /**
-     * Navigation menu structure that the package contributes to the UI.
+     * Glob patterns specifying ObjectQL schemas files (typically *.object.yml or *.object.ts).
+     * Example: `["./src/objects/*.object.yml"]`
+     */
+    objects: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /**
+     * Defines system level DataSources.
+     */
+    datasources: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /**
+     * Package Dependencies.
+     * Map of package IDs to version requirements.
      */
-    menus: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        /** Display label for the menu item */
-        label: z.ZodString;
-        /** Navigation path (route) for the menu item */
-        path: z.ZodString;
-        /** Optional icon identifier for the menu item */
-        icon: z.ZodOptional<z.ZodString>;
+    dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    /**
+     * Plugin Configuration Schema.
+     * Defines the settings this plugin exposes to the user.
+     * Uses a simplified JSON Schema format.
+     */
+    configuration: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        properties: z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<["string", "number", "boolean", "array", "object"]>;
+            default: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            secret: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }>>;
     }, "strip", z.ZodTypeAny, {
-        path: string;
-        label: string;
-        icon?: string | undefined;
+        properties: Record<string, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }>;
+        title?: string | undefined;
     }, {
-        path: string;
-        label: string;
-        icon?: string | undefined;
-    }>, "many">>;
+        properties: Record<string, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }>;
+        title?: string | undefined;
+    }>>;
     /**
-     * Glob patterns specifying ObjectQL schemas files (typically *.object.yml or *.object.ts).
-     * Example: `["./src/objects/*.object.yml"]`
+     * Contribution Points (VS Code Style).
+     * formalized way to extend the platform capabilities.
      */
-    objects: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    contributes: z.ZodOptional<z.ZodObject<{
+        /**
+         * Register new Metadata Kinds (CRDs).
+         * Enables the system to parse and validate new file types.
+         * Example: Registering a BI plugin to handle *.report.ts
+         */
+        kinds: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            globs: z.ZodArray<z.ZodString, "many">;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }, {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }>, "many">>;
+        /**
+         * Register System Hooks.
+         * Declares that this plugin listens to specific system events.
+         */
+        events: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Register UI Menus.
+         */
+        menus: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            command: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }>, "many">>>;
+        /**
+         * Register Custom Themes.
+         */
+        themes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            label: string;
+            id: string;
+        }, {
+            path: string;
+            label: string;
+            id: string;
+        }>, "many">>;
+        /**
+         * Register Translations.
+         * Path to translation files (e.g. "locales/en.json").
+         */
+        translations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            locale: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            locale: string;
+        }, {
+            path: string;
+            locale: string;
+        }>, "many">>;
+        /**
+         * Register Server Actions.
+         * Invocable functions exposed to Flows or API.
+         */
+        actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            input: z.ZodOptional<z.ZodAny>;
+            output: z.ZodOptional<z.ZodAny>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }, {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        actions?: {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }[] | undefined;
+        kinds?: {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }[] | undefined;
+        events?: string[] | undefined;
+        menus?: Record<string, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }[]> | undefined;
+        themes?: {
+            path: string;
+            label: string;
+            id: string;
+        }[] | undefined;
+        translations?: {
+            path: string;
+            locale: string;
+        }[] | undefined;
+    }, {
+        actions?: {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }[] | undefined;
+        kinds?: {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }[] | undefined;
+        events?: string[] | undefined;
+        menus?: Record<string, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }[]> | undefined;
+        themes?: {
+            path: string;
+            label: string;
+            id: string;
+        }[] | undefined;
+        translations?: {
+            path: string;
+            locale: string;
+        }[] | undefined;
+    }>>;
+    /**
+     * Initial data seeding configuration.
+     * Defines default records to be inserted when the package is installed.
+     */
+    data: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        object: z.ZodString;
+        records: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>, "many">;
+        mode: z.ZodDefault<z.ZodEnum<["upsert", "insert", "ignore"]>>;
+    }, "strip", z.ZodTypeAny, {
+        object: string;
+        mode: "upsert" | "insert" | "ignore";
+        records: Record<string, any>[];
+    }, {
+        object: string;
+        records: Record<string, any>[];
+        mode?: "upsert" | "insert" | "ignore" | undefined;
+    }>, "many">>;
     /**
      * Extension points contributed by this package.
      * Allows packages to extend UI components, add functionality, etc.
@@ -92,12 +283,54 @@ export declare const ManifestSchema: z.ZodObject<{
     version: string;
     description?: string | undefined;
     objects?: string[] | undefined;
-    permissions?: string[] | undefined;
-    menus?: {
-        path: string;
-        label: string;
-        icon?: string | undefined;
+    data?: {
+        object: string;
+        mode: "upsert" | "insert" | "ignore";
+        records: Record<string, any>[];
     }[] | undefined;
+    permissions?: string[] | undefined;
+    datasources?: string[] | undefined;
+    dependencies?: Record<string, string> | undefined;
+    configuration?: {
+        properties: Record<string, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }>;
+        title?: string | undefined;
+    } | undefined;
+    contributes?: {
+        actions?: {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }[] | undefined;
+        kinds?: {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }[] | undefined;
+        events?: string[] | undefined;
+        menus?: Record<string, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }[]> | undefined;
+        themes?: {
+            path: string;
+            label: string;
+            id: string;
+        }[] | undefined;
+        translations?: {
+            path: string;
+            locale: string;
+        }[] | undefined;
+    } | undefined;
     extensions?: Record<string, any> | undefined;
 }, {
     type: "app" | "plugin" | "driver" | "module";
@@ -106,12 +339,54 @@ export declare const ManifestSchema: z.ZodObject<{
     version: string;
     description?: string | undefined;
     objects?: string[] | undefined;
-    permissions?: string[] | undefined;
-    menus?: {
-        path: string;
-        label: string;
-        icon?: string | undefined;
+    data?: {
+        object: string;
+        records: Record<string, any>[];
+        mode?: "upsert" | "insert" | "ignore" | undefined;
     }[] | undefined;
+    permissions?: string[] | undefined;
+    datasources?: string[] | undefined;
+    dependencies?: Record<string, string> | undefined;
+    configuration?: {
+        properties: Record<string, {
+            type: "string" | "number" | "boolean" | "object" | "array";
+            default?: any;
+            description?: string | undefined;
+            required?: boolean | undefined;
+            secret?: boolean | undefined;
+            enum?: string[] | undefined;
+        }>;
+        title?: string | undefined;
+    } | undefined;
+    contributes?: {
+        actions?: {
+            name: string;
+            label?: string | undefined;
+            description?: string | undefined;
+            input?: any;
+            output?: any;
+        }[] | undefined;
+        kinds?: {
+            id: string;
+            globs: string[];
+            description?: string | undefined;
+        }[] | undefined;
+        events?: string[] | undefined;
+        menus?: Record<string, {
+            label: string;
+            id: string;
+            command?: string | undefined;
+        }[]> | undefined;
+        themes?: {
+            path: string;
+            label: string;
+            id: string;
+        }[] | undefined;
+        translations?: {
+            path: string;
+            locale: string;
+        }[] | undefined;
+    } | undefined;
     extensions?: Record<string, any> | undefined;
 }>;
 /**
@@ -119,8 +394,4 @@ export declare const ManifestSchema: z.ZodObject<{
  * Use this type for type-safe manifest handling in TypeScript code.
  */
 export type ObjectStackManifest = z.infer<typeof ManifestSchema>;
-/**
- * TypeScript type for menu items.
- */
-export type MenuItem = z.infer<typeof MenuItemSchema>;
 //# sourceMappingURL=manifest.zod.d.ts.map

package/dist/system/manifest.zod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest.zod.d.ts","sourceRoot":"","sources":["../../src/system/manifest.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,cAAc;IACzB,sCAAsC;;IAEtC,gDAAgD;;IAEhD,iDAAiD;;;;;;;;;;EAEjD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,cAAc;IACzB;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;QArDH,sCAAsC;;QAEtC,gDAAgD;;QAEhD,iDAAiD;;;;;;;;;;;IAoDjD;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}
+{"version":3,"file":"manifest.zod.d.ts","sourceRoot":"","sources":["../../src/system/manifest.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,cAAc;IACzB;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;OAGG;;QAED;;;;WAIG;;;;;;;;;;;;;;QAOH;;;WAGG;;QAGH;;WAEG;;;;;;;;;;;;;;QAOH;;WAEG;;;;;;;;;;;;;;QAOH;;;WAGG;;;;;;;;;;;QAMH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAUL;;;OAGG;;;;;;;;;;;;;;IAOH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/system/manifest.zod.js

@@ -1,19 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManifestSchema = exports.MenuItemSchema = void 0;
+exports.ManifestSchema = void 0;
 const zod_1 = require("zod");
-/**
- * Schema for menu items in ObjectStack packages.
- * Defines navigation structure that can be injected into the UI.
- */
-exports.MenuItemSchema = zod_1.z.object({
-    /** Display label for the menu item */
-    label: zod_1.z.string().describe('Display label for the menu item'),
-    /** Navigation path (route) for the menu item */
-    path: zod_1.z.string().describe('Navigation path (route) for the menu item'),
-    /** Optional icon identifier for the menu item */
-    icon: zod_1.z.string().optional().describe('Optional icon identifier for the menu item'),
-});
 /**
  * Schema for the ObjectStack Manifest.
  * This defines the structure of a package configuration in the ObjectStack ecosystem.
@@ -51,15 +39,101 @@ exports.ManifestSchema = zod_1.z.object({
      * Example: ["system.user.read", "system.data.write"]
      */
     permissions: zod_1.z.array(zod_1.z.string()).optional().describe('Array of required permission strings'),
-    /**
-     * Navigation menu structure that the package contributes to the UI.
-     */
-    menus: zod_1.z.array(exports.MenuItemSchema).optional().describe('Navigation menu structure'),
     /**
      * Glob patterns specifying ObjectQL schemas files (typically *.object.yml or *.object.ts).
      * Example: `["./src/objects/*.object.yml"]`
      */
     objects: zod_1.z.array(zod_1.z.string()).optional().describe('Glob patterns for ObjectQL schemas files'),
+    /**
+     * Defines system level DataSources.
+     */
+    datasources: zod_1.z.array(zod_1.z.string()).optional().describe('Glob patterns for Datasource definitions'),
+    /**
+     * Package Dependencies.
+     * Map of package IDs to version requirements.
+     */
+    dependencies: zod_1.z.record(zod_1.z.string()).optional().describe('Package dependencies'),
+    /**
+     * Plugin Configuration Schema.
+     * Defines the settings this plugin exposes to the user.
+     * Uses a simplified JSON Schema format.
+     */
+    configuration: zod_1.z.object({
+        title: zod_1.z.string().optional(),
+        properties: zod_1.z.record(zod_1.z.object({
+            type: zod_1.z.enum(['string', 'number', 'boolean', 'array', 'object']).describe('Data type of the setting'),
+            default: zod_1.z.any().optional().describe('Default value'),
+            description: zod_1.z.string().optional().describe('Tooltip description'),
+            required: zod_1.z.boolean().optional().describe('Is this setting required?'),
+            secret: zod_1.z.boolean().optional().describe('If true, value is encrypted/masked (e.g. API Keys)'),
+            enum: zod_1.z.array(zod_1.z.string()).optional().describe('Allowed values for select inputs'),
+        })).describe('Map of configuration keys to their definitions')
+    }).optional().describe('Plugin configuration settings'),
+    /**
+     * Contribution Points (VS Code Style).
+     * formalized way to extend the platform capabilities.
+     */
+    contributes: zod_1.z.object({
+        /**
+         * Register new Metadata Kinds (CRDs).
+         * Enables the system to parse and validate new file types.
+         * Example: Registering a BI plugin to handle *.report.ts
+         */
+        kinds: zod_1.z.array(zod_1.z.object({
+            id: zod_1.z.string().describe('The generic identifier of the kind (e.g., "sys.bi.report")'),
+            globs: zod_1.z.array(zod_1.z.string()).describe('File patterns to watch (e.g., ["**/*.report.ts"])'),
+            description: zod_1.z.string().optional().describe('Description of what this kind represents'),
+        })).optional().describe('New Metadata Types to recognize'),
+        /**
+         * Register System Hooks.
+         * Declares that this plugin listens to specific system events.
+         */
+        events: zod_1.z.array(zod_1.z.string()).optional().describe('Events this plugin listens to'),
+        /**
+         * Register UI Menus.
+         */
+        menus: zod_1.z.record(zod_1.z.array(zod_1.z.object({
+            id: zod_1.z.string(),
+            label: zod_1.z.string(),
+            command: zod_1.z.string().optional(),
+        }))).optional().describe('UI Menu contributions'),
+        /**
+         * Register Custom Themes.
+         */
+        themes: zod_1.z.array(zod_1.z.object({
+            id: zod_1.z.string(),
+            label: zod_1.z.string(),
+            path: zod_1.z.string(),
+        })).optional().describe('Theme contributions'),
+        /**
+         * Register Translations.
+         * Path to translation files (e.g. "locales/en.json").
+         */
+        translations: zod_1.z.array(zod_1.z.object({
+            locale: zod_1.z.string(),
+            path: zod_1.z.string(),
+        })).optional().describe('Translation resources'),
+        /**
+         * Register Server Actions.
+         * Invocable functions exposed to Flows or API.
+         */
+        actions: zod_1.z.array(zod_1.z.object({
+            name: zod_1.z.string().describe('Unique action name'),
+            label: zod_1.z.string().optional(),
+            description: zod_1.z.string().optional(),
+            input: zod_1.z.any().optional().describe('Input validation schema'),
+            output: zod_1.z.any().optional().describe('Output schema'),
+        })).optional().describe('Exposed server actions'),
+    }).optional().describe('Platform contributions'),
+    /**
+     * Initial data seeding configuration.
+     * Defines default records to be inserted when the package is installed.
+     */
+    data: zod_1.z.array(zod_1.z.object({
+        object: zod_1.z.string().describe('Target Object Name'),
+        records: zod_1.z.array(zod_1.z.record(zod_1.z.any())).describe('List of records to insert'),
+        mode: zod_1.z.enum(['upsert', 'insert', 'ignore']).default('upsert').describe('Seeding mode')
+    })).optional().describe('Initial seed data'),
     /**
      * Extension points contributed by this package.
      * Allows packages to extend UI components, add functionality, etc.