@objectstack/spec 0.1.0 → 0.1.2

package/dist/data/object.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.zod.d.ts","sourceRoot":"","sources":["../../src/data/object.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAC7B,4CAA4C;;IAG5C,oCAAoC;;IAGpC,qCAAqC;;IAGrC;;;;OAIG;;IAeH,+BAA+B;;IAG/B,iCAAiC;;IAGjC,mCAAmC;;;;;;;;;;;;;;;;;;EAEnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;EAItB,CAAC;AAEH;;GAEG;AACH,QAAA,MAAM,gBAAgB;IACpB,eAAe;;;;;;IAOf;;;OAGG;;;;IAKH,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGxB,cAAc;;;;;;;;;;;;;;IAGd,iBAAiB;;IAGjB,8BAA8B;;QA3E9B,4CAA4C;;QAG5C,oCAAoC;;QAGpC,qCAAqC;;QAGrC;;;;WAIG;;QAeH,+BAA+B;;QAG/B,iCAAiC;;QAGjC,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2CnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;IA/BvB,eAAe;;;;;;IAOf;;;OAGG;;;;IAKH,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGxB,cAAc;;;;;;;;;;;;;;IAGd,iBAAiB;;IAGjB,8BAA8B;;QA3E9B,4CAA4C;;QAG5C,oCAAoC;;QAGpC,qCAAqC;;QAGrC;;;;WAIG;;QAeH,+BAA+B;;QAG/B,iCAAiC;;QAGjC,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAiD1B,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC;CAC9D,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/data/object.zod.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectSchema = exports.IndexSchema = exports.ObjectCapabilities = void 0;
+const zod_1 = require("zod");
+const field_zod_1 = require("./field.zod");
+/**
+ * Capability Flags
+ * Defines what system features are enabled for this object.
+ */
+exports.ObjectCapabilities = zod_1.z.object({
+    /** Enable history tracking (Audit Trail) */
+    trackHistory: zod_1.z.boolean().default(false),
+    /** Enable global search indexing */
+    searchable: zod_1.z.boolean().default(true),
+    /** Enable REST/GraphQL API access */
+    apiEnabled: zod_1.z.boolean().default(true),
+    /**
+     * API Supported Operations
+     * Explicitly whitelist allowed operations.
+     * If not defined, all standard operations are allowed (if apiEnabled=true).
+     */
+    apiMethods: zod_1.z.array(zod_1.z.enum([
+        'get', 'list',
+        'create', 'update', 'delete',
+        'upsert',
+        'bulkCreate', 'bulkUpdate', 'bulkDelete', 'bulkUpsert',
+        'aggregate', // count, sum, group by
+        'history', // audit trail access
+        'search', // full text search
+        'restore', // undelete from trash
+        'purge', // hard delete
+        'import', // data import
+        'export', // data export
+    ])).optional().describe('Allowed API operations'),
+    /** Enable attachments/files */
+    files: zod_1.z.boolean().default(false),
+    /** Enable discussions/chatter */
+    feedEnabled: zod_1.z.boolean().default(false),
+    /** Enable Recycle Bin mechanics */
+    trash: zod_1.z.boolean().default(true),
+});
+/**
+ * Schema for database indexes.
+ */
+exports.IndexSchema = zod_1.z.object({
+    name: zod_1.z.string().optional().describe('Index name'),
+    fields: zod_1.z.array(zod_1.z.string()).describe('Fields included in the index'),
+    unique: zod_1.z.boolean().optional().describe('Whether the index is unique'),
+});
+/**
+ * Base Object Schema Definition
+ */
+const ObjectSchemaBase = zod_1.z.object({
+    /** Identify */
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Machine name (snake_case)'),
+    label: zod_1.z.string().optional().describe('Singular Label (e.g. "Account")'),
+    pluralLabel: zod_1.z.string().optional().describe('Plural Label (e.g. "Accounts")'),
+    description: zod_1.z.string().optional().describe('Internal description'),
+    icon: zod_1.z.string().optional().describe('Lucide icon name'),
+    /**
+     * Storage / Virtualization Config
+     * Defines where the data actually lives.
+     */
+    datasource: zod_1.z.string().default('default').describe('Target Datasource ID (e.g. "postgres", "salesforce"). references sys_datasource.'),
+    tableName: zod_1.z.string().optional().describe('Physical table/collection name in the target datasource'),
+    isSystem: zod_1.z.boolean().default(false).describe('Is system object (protected)'),
+    /** Fields Definition */
+    fields: zod_1.z.record(field_zod_1.FieldSchema).describe('Map of field definitions'),
+    /** Indexes */
+    indexes: zod_1.z.array(exports.IndexSchema).optional().describe('Database indexes definition'),
+    /** Key Fields */
+    nameField: zod_1.z.string().optional().describe('Which field represents the record name/title (usually "name")'),
+    /** Features & Capabilities */
+    enable: exports.ObjectCapabilities.optional().describe('Enabled system capabilities'),
+});
+/**
+ * Enhanced ObjectSchema with Factory
+ */
+exports.ObjectSchema = Object.assign(ObjectSchemaBase, {
+    create: (config) => config,
+});

package/dist/data/permission.zod.d.ts

@@ -0,0 +1,163 @@
+import { z } from 'zod';
+/**
+ * Entity (Object) Level Permissions
+ * Defines CRUD + VAMA (View All / Modify All) access.
+ */
+export declare const ObjectPermissionSchema: z.ZodObject<{
+    /** C: Create */
+    allowCreate: z.ZodDefault<z.ZodBoolean>;
+    /** R: Read (Owned records or Shared records) */
+    allowRead: z.ZodDefault<z.ZodBoolean>;
+    /** U: Edit (Owned records or Shared records) */
+    allowEdit: z.ZodDefault<z.ZodBoolean>;
+    /** D: Delete (Owned records or Shared records) */
+    allowDelete: z.ZodDefault<z.ZodBoolean>;
+    /**
+     * View All Records: Super-user read access.
+     * Bypasses Sharing Rules and Ownership checks.
+     * Equivalent to Microsoft Dataverse "Organization" level read access.
+     */
+    viewAllRecords: z.ZodDefault<z.ZodBoolean>;
+    /**
+     * Modify All Records: Super-user write access.
+     * Bypasses Sharing Rules and Ownership checks.
+     * Equivalent to Microsoft Dataverse "Organization" level write access.
+     */
+    modifyAllRecords: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    allowCreate: boolean;
+    allowRead: boolean;
+    allowEdit: boolean;
+    allowDelete: boolean;
+    viewAllRecords: boolean;
+    modifyAllRecords: boolean;
+}, {
+    allowCreate?: boolean | undefined;
+    allowRead?: boolean | undefined;
+    allowEdit?: boolean | undefined;
+    allowDelete?: boolean | undefined;
+    viewAllRecords?: boolean | undefined;
+    modifyAllRecords?: boolean | undefined;
+}>;
+/**
+ * Field Level Security (FLS)
+ */
+export declare const FieldPermissionSchema: z.ZodObject<{
+    /** Can see this field */
+    readable: z.ZodDefault<z.ZodBoolean>;
+    /** Can edit this field */
+    editable: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    readable: boolean;
+    editable: boolean;
+}, {
+    readable?: boolean | undefined;
+    editable?: boolean | undefined;
+}>;
+/**
+ * Permission Set Schema
+ * Defines a collection of permissions that can be assigned to users.
+ *
+ * DIFFERENTIATION:
+ * - Profile: The ONE primary functional definition of a user (e.g. Standard User).
+ * - Permission Set: Add-on capabilities assigned to users (e.g. Export Reports).
+ * - Role: (Defined in src/system/role.zod.ts) Defines data visibility hierarchy.
+ */
+export declare const PermissionSetSchema: z.ZodObject<{
+    /** Unique permission set name */
+    name: z.ZodString;
+    /** Display label */
+    label: z.ZodOptional<z.ZodString>;
+    /** Is this a Profile? (Base set for a user) */
+    isProfile: z.ZodDefault<z.ZodBoolean>;
+    /** Object Permissions Map: <entity_name> -> permissions */
+    objects: z.ZodRecord<z.ZodString, z.ZodObject<{
+        /** C: Create */
+        allowCreate: z.ZodDefault<z.ZodBoolean>;
+        /** R: Read (Owned records or Shared records) */
+        allowRead: z.ZodDefault<z.ZodBoolean>;
+        /** U: Edit (Owned records or Shared records) */
+        allowEdit: z.ZodDefault<z.ZodBoolean>;
+        /** D: Delete (Owned records or Shared records) */
+        allowDelete: z.ZodDefault<z.ZodBoolean>;
+        /**
+         * View All Records: Super-user read access.
+         * Bypasses Sharing Rules and Ownership checks.
+         * Equivalent to Microsoft Dataverse "Organization" level read access.
+         */
+        viewAllRecords: z.ZodDefault<z.ZodBoolean>;
+        /**
+         * Modify All Records: Super-user write access.
+         * Bypasses Sharing Rules and Ownership checks.
+         * Equivalent to Microsoft Dataverse "Organization" level write access.
+         */
+        modifyAllRecords: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        allowCreate: boolean;
+        allowRead: boolean;
+        allowEdit: boolean;
+        allowDelete: boolean;
+        viewAllRecords: boolean;
+        modifyAllRecords: boolean;
+    }, {
+        allowCreate?: boolean | undefined;
+        allowRead?: boolean | undefined;
+        allowEdit?: boolean | undefined;
+        allowDelete?: boolean | undefined;
+        viewAllRecords?: boolean | undefined;
+        modifyAllRecords?: boolean | undefined;
+    }>>;
+    /** Field Permissions Map: <entity_name>.<field_name> -> permissions */
+    fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        /** Can see this field */
+        readable: z.ZodDefault<z.ZodBoolean>;
+        /** Can edit this field */
+        editable: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        readable: boolean;
+        editable: boolean;
+    }, {
+        readable?: boolean | undefined;
+        editable?: boolean | undefined;
+    }>>>;
+    /** System permissions (e.g., "manage_users") */
+    systemPermissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    isProfile: boolean;
+    objects: Record<string, {
+        allowCreate: boolean;
+        allowRead: boolean;
+        allowEdit: boolean;
+        allowDelete: boolean;
+        viewAllRecords: boolean;
+        modifyAllRecords: boolean;
+    }>;
+    label?: string | undefined;
+    fields?: Record<string, {
+        readable: boolean;
+        editable: boolean;
+    }> | undefined;
+    systemPermissions?: string[] | undefined;
+}, {
+    name: string;
+    objects: Record<string, {
+        allowCreate?: boolean | undefined;
+        allowRead?: boolean | undefined;
+        allowEdit?: boolean | undefined;
+        allowDelete?: boolean | undefined;
+        viewAllRecords?: boolean | undefined;
+        modifyAllRecords?: boolean | undefined;
+    }>;
+    label?: string | undefined;
+    fields?: Record<string, {
+        readable?: boolean | undefined;
+        editable?: boolean | undefined;
+    }> | undefined;
+    isProfile?: boolean | undefined;
+    systemPermissions?: string[] | undefined;
+}>;
+export type PermissionSet = z.infer<typeof PermissionSetSchema>;
+export type ObjectPermission = z.infer<typeof ObjectPermissionSchema>;
+export type FieldPermission = z.infer<typeof FieldPermissionSchema>;
+//# sourceMappingURL=permission.zod.d.ts.map

package/dist/data/permission.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.zod.d.ts","sourceRoot":"","sources":["../../src/data/permission.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IACjC,gBAAgB;;IAEhB,gDAAgD;;IAEhD,gDAAgD;;IAEhD,kDAAkD;;IAGlD;;;;OAIG;;IAGH;;;;OAIG;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,qBAAqB;IAChC,yBAAyB;;IAEzB,0BAA0B;;;;;;;;EAE1B,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB;IAC9B,iCAAiC;;IAGjC,oBAAoB;;IAGpB,+CAA+C;;IAG/C,2DAA2D;;QArD3D,gBAAgB;;QAEhB,gDAAgD;;QAEhD,gDAAgD;;QAEhD,kDAAkD;;QAGlD;;;;WAIG;;QAGH;;;;WAIG;;;;;;;;;;;;;;;;;IAoCH,uEAAuE;;QA5BvE,yBAAyB;;QAEzB,0BAA0B;;;;;;;;;IA6B1B,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEhD,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/data/permission.zod.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionSetSchema = exports.FieldPermissionSchema = exports.ObjectPermissionSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Entity (Object) Level Permissions
+ * Defines CRUD + VAMA (View All / Modify All) access.
+ */
+exports.ObjectPermissionSchema = zod_1.z.object({
+    /** C: Create */
+    allowCreate: zod_1.z.boolean().default(false).describe('Create permission'),
+    /** R: Read (Owned records or Shared records) */
+    allowRead: zod_1.z.boolean().default(false).describe('Read permission'),
+    /** U: Edit (Owned records or Shared records) */
+    allowEdit: zod_1.z.boolean().default(false).describe('Edit permission'),
+    /** D: Delete (Owned records or Shared records) */
+    allowDelete: zod_1.z.boolean().default(false).describe('Delete permission'),
+    /**
+     * View All Records: Super-user read access.
+     * Bypasses Sharing Rules and Ownership checks.
+     * Equivalent to Microsoft Dataverse "Organization" level read access.
+     */
+    viewAllRecords: zod_1.z.boolean().default(false).describe('View All Data (Bypass Sharing)'),
+    /**
+     * Modify All Records: Super-user write access.
+     * Bypasses Sharing Rules and Ownership checks.
+     * Equivalent to Microsoft Dataverse "Organization" level write access.
+     */
+    modifyAllRecords: zod_1.z.boolean().default(false).describe('Modify All Data (Bypass Sharing)'),
+});
+/**
+ * Field Level Security (FLS)
+ */
+exports.FieldPermissionSchema = zod_1.z.object({
+    /** Can see this field */
+    readable: zod_1.z.boolean().default(true).describe('Field read access'),
+    /** Can edit this field */
+    editable: zod_1.z.boolean().default(false).describe('Field edit access'),
+});
+/**
+ * Permission Set Schema
+ * Defines a collection of permissions that can be assigned to users.
+ *
+ * DIFFERENTIATION:
+ * - Profile: The ONE primary functional definition of a user (e.g. Standard User).
+ * - Permission Set: Add-on capabilities assigned to users (e.g. Export Reports).
+ * - Role: (Defined in src/system/role.zod.ts) Defines data visibility hierarchy.
+ */
+exports.PermissionSetSchema = zod_1.z.object({
+    /** Unique permission set name */
+    name: zod_1.z.string().describe('Permission set unique name'),
+    /** Display label */
+    label: zod_1.z.string().optional().describe('Display label'),
+    /** Is this a Profile? (Base set for a user) */
+    isProfile: zod_1.z.boolean().default(false).describe('Whether this is a user profile'),
+    /** Object Permissions Map: <entity_name> -> permissions */
+    objects: zod_1.z.record(exports.ObjectPermissionSchema).describe('Entity permissions'),
+    /** Field Permissions Map: <entity_name>.<field_name> -> permissions */
+    fields: zod_1.z.record(exports.FieldPermissionSchema).optional().describe('Field level security'),
+    /** System permissions (e.g., "manage_users") */
+    systemPermissions: zod_1.z.array(zod_1.z.string()).optional().describe('System level capabilities'),
+});