@objectstack/spec 0.1.0 → 0.1.2

package/dist/system/license.zod.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LicenseSchema = exports.PlanSchema = exports.FeatureSchema = exports.MetricType = void 0;
+const zod_1 = require("zod");
+/**
+ * Metric Type Classification
+ */
+exports.MetricType = zod_1.z.enum([
+    'boolean', // Feature Flag (Enabled/Disabled)
+    'counter', // Usage Count (e.g. API Calls, Records Created) - Accumulates
+    'gauge', // Current Level (e.g. Storage Used, Users Active) - Point in time
+]);
+/**
+ * Feature/Limit Definition Schema
+ * Defines a controllable capability of the system.
+ */
+exports.FeatureSchema = zod_1.z.object({
+    code: zod_1.z.string().regex(/^[a-z_][a-z0-9_.]*$/).describe('Feature code (e.g. core.api_access)'),
+    label: zod_1.z.string(),
+    description: zod_1.z.string().optional(),
+    type: exports.MetricType.default('boolean'),
+    /** For counters/gauges */
+    unit: zod_1.z.enum(['count', 'bytes', 'seconds', 'percent']).optional(),
+    /** Dependencies (e.g. 'audit_log' requires 'enterprise_tier') */
+    requires: zod_1.z.array(zod_1.z.string()).optional(),
+});
+/**
+ * Subscription Plan Schema
+ * Defines a tier of service (e.g. "Free", "Pro", "Enterprise").
+ */
+exports.PlanSchema = zod_1.z.object({
+    code: zod_1.z.string().describe('Plan code (e.g. pro_v1)'),
+    label: zod_1.z.string(),
+    active: zod_1.z.boolean().default(true),
+    /** Feature Entitlements */
+    features: zod_1.z.array(zod_1.z.string()).describe('List of enabled boolean features'),
+    /** Limit Quotas */
+    limits: zod_1.z.record(zod_1.z.number()).describe('Map of metric codes to limit values (e.g. { storage_gb: 10 })'),
+    /** Pricing (Optional Metadata) */
+    currency: zod_1.z.string().default('USD').optional(),
+    priceMonthly: zod_1.z.number().optional(),
+    priceYearly: zod_1.z.number().optional(),
+});
+/**
+ * License Schema
+ * The actual entitlement object assigned to a Tenant.
+ * Often signed as a JWT.
+ */
+exports.LicenseSchema = zod_1.z.object({
+    /** Identity */
+    tenantId: zod_1.z.string(),
+    planCode: zod_1.z.string(),
+    /** Validity */
+    issuedAt: zod_1.z.string().datetime(),
+    expiresAt: zod_1.z.string().datetime().optional(), // Null = Perpetual
+    /** Status */
+    status: zod_1.z.enum(['active', 'expired', 'suspended', 'trial']),
+    /** Overrides (Specific to this tenant, exceeding the plan) */
+    customFeatures: zod_1.z.array(zod_1.z.string()).optional(),
+    customLimits: zod_1.z.record(zod_1.z.number()).optional(),
+    /** Signature */
+    signature: zod_1.z.string().optional().describe('Cryptographic signature of the license'),
+});

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

@@ -0,0 +1,397 @@
+import { z } from 'zod';
+/**
+ * Schema for the ObjectStack Manifest.
+ * This defines the structure of a package configuration in the ObjectStack ecosystem.
+ * All packages (apps, plugins, drivers, modules) must conform to this schema.
+ */
+export declare const ManifestSchema: z.ZodObject<{
+    /**
+     * Unique package identifier using reverse domain notation.
+     * Example: "com.example.crm"
+     */
+    id: z.ZodString;
+    /**
+     * Package version following semantic versioning (major.minor.patch).
+     * Example: "1.0.0"
+     */
+    version: z.ZodString;
+    /**
+     * Type of the package in the ObjectStack ecosystem.
+     * - app: Standalone application
+     * - plugin: Extension to ObjectOS
+     * - driver: Low-level integration driver
+     * - module: Reusable code module
+     */
+    type: z.ZodEnum<["app", "plugin", "driver", "module"]>;
+    /**
+     * Human-readable name of the package.
+     */
+    name: z.ZodString;
+    /**
+     * Brief description of the package functionality.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * Array of permission strings that the package requires.
+     * Example: ["system.user.read", "system.data.write"]
+     */
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /**
+     * 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.
+     */
+    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, {
+        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;
+    }, {
+        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;
+    }>>;
+    /**
+     * Contribution Points (VS Code Style).
+     * formalized way to extend the platform capabilities.
+     */
+    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.
+     */
+    extensions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    type: "app" | "plugin" | "driver" | "module";
+    name: string;
+    id: string;
+    version: string;
+    description?: string | undefined;
+    objects?: 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";
+    name: string;
+    id: string;
+    version: string;
+    description?: string | undefined;
+    objects?: 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;
+}>;
+/**
+ * TypeScript type inferred from the ManifestSchema.
+ * Use this type for type-safe manifest handling in TypeScript code.
+ */
+export type ObjectStackManifest = z.infer<typeof ManifestSchema>;
+//# sourceMappingURL=manifest.zod.d.ts.map

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

@@ -0,0 +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;;;;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

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Schema for the ObjectStack Manifest.
+ * This defines the structure of a package configuration in the ObjectStack ecosystem.
+ * All packages (apps, plugins, drivers, modules) must conform to this schema.
+ */
+exports.ManifestSchema = zod_1.z.object({
+    /**
+     * Unique package identifier using reverse domain notation.
+     * Example: "com.example.crm"
+     */
+    id: zod_1.z.string().describe('Unique package identifier (reverse domain style)'),
+    /**
+     * Package version following semantic versioning (major.minor.patch).
+     * Example: "1.0.0"
+     */
+    version: zod_1.z.string().regex(/^\d+\.\d+\.\d+$/).describe('Package version (semantic versioning)'),
+    /**
+     * Type of the package in the ObjectStack ecosystem.
+     * - app: Standalone application
+     * - plugin: Extension to ObjectOS
+     * - driver: Low-level integration driver
+     * - module: Reusable code module
+     */
+    type: zod_1.z.enum(['app', 'plugin', 'driver', 'module']).describe('Type of package'),
+    /**
+     * Human-readable name of the package.
+     */
+    name: zod_1.z.string().describe('Human-readable package name'),
+    /**
+     * Brief description of the package functionality.
+     */
+    description: zod_1.z.string().optional().describe('Package description'),
+    /**
+     * Array of permission strings that the package requires.
+     * Example: ["system.user.read", "system.data.write"]
+     */
+    permissions: zod_1.z.array(zod_1.z.string()).optional().describe('Array of required permission strings'),
+    /**
+     * 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.
+     */
+    extensions: zod_1.z.record(zod_1.z.any()).optional().describe('Extension points and contributions'),
+});