@objectstack/spec 0.3.3 → 0.4.2

package/dist/shared/identifiers.zod.d.ts

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+/**
+ * System Identifier Schema
+ *
+ * Universal naming convention for all machine identifiers (API Names) in ObjectStack.
+ * Enforces lowercase with underscores or dots to ensure:
+ * - Cross-platform compatibility (case-insensitive filesystems)
+ * - URL-friendliness (no encoding needed)
+ * - Database consistency (no collation issues)
+ * - Security (no case-sensitivity bugs in permission checks)
+ *
+ * **Applies to all metadata that acts as a machine identifier:**
+ * - Object names (tables/collections)
+ * - Field names
+ * - Role names
+ * - Permission set names
+ * - Action/trigger names
+ * - Event keys
+ * - App IDs
+ * - Menu/page IDs
+ * - Select option values
+ * - Workflow names
+ * - Webhook names
+ *
+ * **Naming Convention Summary:**
+ * | Type | Pattern | Example |
+ * |------|---------|---------|
+ * | Machine ID | snake_case | `crm_account`, `btn_submit`, `role_admin` |
+ * | Event keys | dot.notation | `user.login`, `order.created` |
+ * | Labels | Any case | `Client Account`, `Submit Form` |
+ *
+ * @example Valid identifiers
+ * - 'account'
+ * - 'crm_account'
+ * - 'user_profile'
+ * - 'order.created' (for events)
+ * - 'api_v2_endpoint'
+ *
+ * @example Invalid identifiers (will be rejected)
+ * - 'Account' (uppercase)
+ * - 'CrmAccount' (camelCase)
+ * - 'crm-account' (kebab-case - use underscore instead)
+ * - 'user profile' (spaces)
+ */
+export declare const SystemIdentifierSchema: z.ZodString;
+/**
+ * Strict Snake Case Identifier
+ *
+ * More restrictive than SystemIdentifierSchema - only allows underscores (no dots).
+ * Use this for identifiers that should NOT contain dots (e.g., database table/column names).
+ *
+ * @example Valid
+ * - 'account'
+ * - 'crm_account'
+ * - 'user_profile'
+ *
+ * @example Invalid
+ * - 'user.profile' (dots not allowed)
+ * - 'UserProfile' (uppercase)
+ */
+export declare const SnakeCaseIdentifierSchema: z.ZodString;
+/**
+ * Event Name Identifier
+ *
+ * Specialized identifier for event names that encourages dot notation.
+ * Used in event-driven systems, message queues, and webhooks.
+ *
+ * Pattern: `namespace.action` or `entity.event_type`
+ *
+ * @example Valid
+ * - 'user.created'
+ * - 'order.paid'
+ * - 'user.login_success'
+ * - 'alarm.high_cpu'
+ *
+ * @example Invalid
+ * - 'UserCreated' (camelCase)
+ * - 'user_created' (should use dots for namespacing)
+ */
+export declare const EventNameSchema: z.ZodString;
+/**
+ * Type Exports
+ */
+export type SystemIdentifier = z.infer<typeof SystemIdentifierSchema>;
+export type SnakeCaseIdentifier = z.infer<typeof SnakeCaseIdentifierSchema>;
+export type EventName = z.infer<typeof EventNameSchema>;
+//# sourceMappingURL=identifiers.zod.d.ts.map

package/dist/shared/identifiers.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifiers.zod.d.ts","sourceRoot":"","sources":["../../src/shared/identifiers.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,sBAAsB,aAOkC,CAAC;AAEtE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,yBAAyB,aAOgC,CAAC;AAEvE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,eAAe,aAO2C,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/shared/identifiers.zod.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventNameSchema = exports.SnakeCaseIdentifierSchema = exports.SystemIdentifierSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * System Identifier Schema
+ *
+ * Universal naming convention for all machine identifiers (API Names) in ObjectStack.
+ * Enforces lowercase with underscores or dots to ensure:
+ * - Cross-platform compatibility (case-insensitive filesystems)
+ * - URL-friendliness (no encoding needed)
+ * - Database consistency (no collation issues)
+ * - Security (no case-sensitivity bugs in permission checks)
+ *
+ * **Applies to all metadata that acts as a machine identifier:**
+ * - Object names (tables/collections)
+ * - Field names
+ * - Role names
+ * - Permission set names
+ * - Action/trigger names
+ * - Event keys
+ * - App IDs
+ * - Menu/page IDs
+ * - Select option values
+ * - Workflow names
+ * - Webhook names
+ *
+ * **Naming Convention Summary:**
+ * | Type | Pattern | Example |
+ * |------|---------|---------|
+ * | Machine ID | snake_case | `crm_account`, `btn_submit`, `role_admin` |
+ * | Event keys | dot.notation | `user.login`, `order.created` |
+ * | Labels | Any case | `Client Account`, `Submit Form` |
+ *
+ * @example Valid identifiers
+ * - 'account'
+ * - 'crm_account'
+ * - 'user_profile'
+ * - 'order.created' (for events)
+ * - 'api_v2_endpoint'
+ *
+ * @example Invalid identifiers (will be rejected)
+ * - 'Account' (uppercase)
+ * - 'CrmAccount' (camelCase)
+ * - 'crm-account' (kebab-case - use underscore instead)
+ * - 'user profile' (spaces)
+ */
+exports.SystemIdentifierSchema = zod_1.z
+    .string()
+    .min(2, { message: 'System identifier must be at least 2 characters' })
+    .regex(/^[a-z][a-z0-9_.]*$/, {
+    message: 'System identifier must be lowercase, starting with a letter, and may contain letters, numbers, underscores, or dots (e.g., "user_profile" or "order.created")',
+})
+    .describe('System identifier (lowercase with underscores or dots)');
+/**
+ * Strict Snake Case Identifier
+ *
+ * More restrictive than SystemIdentifierSchema - only allows underscores (no dots).
+ * Use this for identifiers that should NOT contain dots (e.g., database table/column names).
+ *
+ * @example Valid
+ * - 'account'
+ * - 'crm_account'
+ * - 'user_profile'
+ *
+ * @example Invalid
+ * - 'user.profile' (dots not allowed)
+ * - 'UserProfile' (uppercase)
+ */
+exports.SnakeCaseIdentifierSchema = zod_1.z
+    .string()
+    .min(2, { message: 'Identifier must be at least 2 characters' })
+    .regex(/^[a-z][a-z0-9_]*$/, {
+    message: 'Identifier must be lowercase snake_case, starting with a letter, and may contain only letters, numbers, and underscores (e.g., "user_profile")',
+})
+    .describe('Snake case identifier (lowercase with underscores only)');
+/**
+ * Event Name Identifier
+ *
+ * Specialized identifier for event names that encourages dot notation.
+ * Used in event-driven systems, message queues, and webhooks.
+ *
+ * Pattern: `namespace.action` or `entity.event_type`
+ *
+ * @example Valid
+ * - 'user.created'
+ * - 'order.paid'
+ * - 'user.login_success'
+ * - 'alarm.high_cpu'
+ *
+ * @example Invalid
+ * - 'UserCreated' (camelCase)
+ * - 'user_created' (should use dots for namespacing)
+ */
+exports.EventNameSchema = zod_1.z
+    .string()
+    .min(3, { message: 'Event name must be at least 3 characters' })
+    .regex(/^[a-z][a-z0-9_.]*$/, {
+    message: 'Event name must be lowercase with dots for namespacing (e.g., "user.created", "order.paid")',
+})
+    .describe('Event name (lowercase with dot notation for namespacing)');

package/dist/shared/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Shared Schemas and Utilities
+ * Common schemas used across multiple modules
+ */
+export * from './identifiers.zod';
+//# sourceMappingURL=index.d.ts.map

package/dist/shared/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,mBAAmB,CAAC"}

package/dist/{driver → shared}/index.js

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * Shared Schemas and Utilities
+ * Common schemas used across multiple modules
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,7 +18,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./driver.zod"), exports);
-__exportStar(require("./datasource.zod"), exports);
-__exportStar(require("./mongo.zod"), exports);
-__exportStar(require("./postgres.zod"), exports);
+__exportStar(require("./identifiers.zod"), exports);