@objectstack/spec 0.3.2 → 0.4.1

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

@@ -1 +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"}
+{"version":3,"file":"object.zod.d.ts","sourceRoot":"","sources":["../../src/data/object.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;IAC7B,4CAA4C;;IAG5C,oCAAoC;;IAGpC,qCAAqC;;IAGrC;;;OAGG;;IAaH,+CAA+C;;IAG/C,8DAA8D;;IAG9D,gEAAgE;;IAGhE,uCAAuC;;IAGvC,wCAAwC;;IAGxC,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;EAE5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;EAKtB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAC;AAEH;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB;IACpB;;OAEG;;;;;;IAOH;;OAEG;;;;;IAMH;;OAEG;;;IAIH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIH;;;OAGG;;IAGH;;OAEG;;;IAIH;;OAEG;;;;;;;;;;;;;;IAGH;;OAEG;;QAvHH,4CAA4C;;QAG5C,oCAAoC;;QAGpC,qCAAqC;;QAGrC;;;WAGG;;QAaH,+CAA+C;;QAG/C,8DAA8D;;QAG9D,gEAAgE;;QAGhE,uCAAuC;;QAGvC,wCAAwC;;QAGxC,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiF5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;IAvDvB;;OAEG;;;;;;IAOH;;OAEG;;;;;IAMH;;OAEG;;;IAIH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIH;;;OAGG;;IAGH;;OAEG;;;IAIH;;OAEG;;;;;;;;;;;;;;IAGH;;OAEG;;QAvHH,4CAA4C;;QAG5C,oCAAoC;;QAGpC,qCAAqC;;QAGrC;;;WAGG;;QAaH,+CAA+C;;QAG/C,8DAA8D;;QAG9D,gEAAgE;;QAGhE,uCAAuC;;QAGvC,wCAAwC;;QAGxC,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAuFnB,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;AAC7D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACpE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/data/object.zod.js

@@ -1,43 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectSchema = exports.IndexSchema = exports.ObjectCapabilities = void 0;
+exports.ObjectSchema = exports.SearchConfigSchema = exports.IndexSchema = exports.ObjectCapabilities = void 0;
 const zod_1 = require("zod");
 const field_zod_1 = require("./field.zod");
+const validation_zod_1 = require("./validation.zod");
 /**
  * Capability Flags
  * Defines what system features are enabled for this object.
+ *
+ * Optimized based on industry standards (Salesforce, ServiceNow):
+ * - Added `activities` (Tasks/Events)
+ * - Added `mru` (Recent Items)
+ * - Added `feeds` (Social/Chatter)
+ * - Grouped API permissions
  */
 exports.ObjectCapabilities = zod_1.z.object({
     /** Enable history tracking (Audit Trail) */
-    trackHistory: zod_1.z.boolean().default(false),
+    trackHistory: zod_1.z.boolean().default(false).describe('Enable field history tracking for audit compliance'),
     /** Enable global search indexing */
-    searchable: zod_1.z.boolean().default(true),
+    searchable: zod_1.z.boolean().default(true).describe('Index records for global search'),
     /** Enable REST/GraphQL API access */
-    apiEnabled: zod_1.z.boolean().default(true),
+    apiEnabled: zod_1.z.boolean().default(true).describe('Expose object via automatic APIs'),
     /**
      * API Supported Operations
-     * Explicitly whitelist allowed operations.
-     * If not defined, all standard operations are allowed (if apiEnabled=true).
+     * Granular control over API exposure.
      */
     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),
+        'get', 'list', // Read
+        'create', 'update', 'delete', // Write
+        'upsert', // Idempotent Write
+        'bulk', // Batch operations
+        'aggregate', // Analytics (count, sum)
+        'history', // Audit access
+        'search', // Search access
+        'restore', 'purge', // Trash management
+        'import', 'export', // Data portability
+    ])).optional().describe('Whitelist of allowed API operations'),
+    /** Enable standard attachments/files engine */
+    files: zod_1.z.boolean().default(false).describe('Enable file attachments and document management'),
+    /** Enable social collaboration (Comments, Mentions, Feeds) */
+    feeds: zod_1.z.boolean().default(false).describe('Enable social feed, comments, and mentions (Chatter-like)'),
+    /** Enable standard Activity suite (Tasks, Calendars, Events) */
+    activities: zod_1.z.boolean().default(false).describe('Enable standard tasks and events tracking'),
+    /** Enable Recycle Bin / Soft Delete */
+    trash: zod_1.z.boolean().default(true).describe('Enable soft-delete with restore capability'),
+    /** Enable "Recently Viewed" tracking */
+    mru: zod_1.z.boolean().default(true).describe('Track Most Recently Used (MRU) list for users'),
+    /** Allow cloning records */
+    clone: zod_1.z.boolean().default(true).describe('Allow record deep cloning'),
 });
 /**
  * Schema for database indexes.
@@ -46,32 +56,67 @@ 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'),
+    type: zod_1.z.enum(['btree', 'hash', 'gin', 'gist']).optional().describe('Index type (default: btree)'),
+});
+/**
+ * Search Configuration
+ * Defines how this object behaves in search results.
+ */
+exports.SearchConfigSchema = zod_1.z.object({
+    fields: zod_1.z.array(zod_1.z.string()).describe('Fields to index for full-text search weighting'),
+    displayFields: zod_1.z.array(zod_1.z.string()).optional().describe('Fields to display in search result cards'),
+    filters: zod_1.z.array(zod_1.z.string()).optional().describe('Default filters for search results'),
 });
 /**
  * Base Object Schema Definition
+ *
+ * The Blueprint of a Business Object.
+ * Represents a table, a collection, or a virtual entity.
  */
 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.
+     * Identity & Metadata
+     */
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Machine unique key (snake_case). Immutable.'),
+    label: zod_1.z.string().optional().describe('Human readable singular label (e.g. "Account")'),
+    pluralLabel: zod_1.z.string().optional().describe('Human readable plural label (e.g. "Accounts")'),
+    description: zod_1.z.string().optional().describe('Developer documentation / description'),
+    icon: zod_1.z.string().optional().describe('Icon name (Lucide/Material) for UI representation'),
+    /**
+     * Taxonomy & Organization
      */
-    datasource: zod_1.z.string().default('default').describe('Target Datasource ID (e.g. "postgres", "salesforce"). references sys_datasource.'),
+    tags: zod_1.z.array(zod_1.z.string()).optional().describe('Categorization tags (e.g. "sales", "system", "reference")'),
+    active: zod_1.z.boolean().optional().default(true).describe('Is the object active and usable'),
+    isSystem: zod_1.z.boolean().optional().default(false).describe('Is system object (protected from deletion)'),
+    abstract: zod_1.z.boolean().optional().default(false).describe('Is abstract base object (cannot be instantiated)'),
+    /**
+     * Storage & Virtualization
+     */
+    datasource: zod_1.z.string().optional().default('default').describe('Target Datasource ID. "default" is the primary DB.'),
     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'),
+    /**
+     * Data Model
+     */
+    fields: zod_1.z.record(field_zod_1.FieldSchema).describe('Field definitions map'),
+    indexes: zod_1.z.array(exports.IndexSchema).optional().describe('Database performance indexes'),
+    /**
+     * Logic & Validation (Co-located)
+     * Best Practice: Define rules close to data.
+     */
+    validations: zod_1.z.array(validation_zod_1.ValidationRuleSchema).optional().describe('Object-level validation rules'),
+    /**
+     * Display & UI Hints (Data-Layer)
+     */
+    titleFormat: zod_1.z.string().optional().describe('Title expression (e.g. "{name} - {code}"). Overrides nameField.'),
+    compactLayout: zod_1.z.array(zod_1.z.string()).optional().describe('Primary fields for hover/cards/lookups'),
+    /**
+     * Search Engine Config
+     */
+    search: exports.SearchConfigSchema.optional().describe('Search engine configuration'),
+    /**
+     * System Capabilities
+     */
+    enable: exports.ObjectCapabilities.optional().describe('Enabled system features modules'),
 });
 /**
  * Enhanced ObjectSchema with Factory