@eide/uniformgen 0.1.0

package/dist/schema/define-entity-model.d.ts

@@ -0,0 +1,122 @@
+import type { FieldSchema, ValidationRule } from '../fetcher/fetch-schemas.js';
+/**
+ * Entity model definition for code-first schema management
+ */
+export interface EntityModelDefinition {
+    /** Unique key for the model (e.g., 'article', 'hero-banner') */
+    key: string;
+    /** Display name */
+    name: string;
+    /** Plural display name (optional) */
+    pluralName?: string;
+    /** Description of the model */
+    description?: string;
+    /** Tier: 1=singleton, 2=no variants, 3=with variants */
+    tier: 1 | 2 | 3;
+    /** Editor mode: 'flat' or 'tree' */
+    editorMode?: 'flat' | 'tree';
+    /** Model modes */
+    modes: {
+        /** Can create standalone records (CRUD via API) */
+        records: boolean;
+        /** Can be used as a field type in other models */
+        inline: boolean;
+    };
+    /** Field definitions */
+    fields: FieldDefinitionInput[];
+    /** Lifecycle hooks configuration */
+    hooks?: {
+        onCreate?: HookDefinition[];
+        onUpdate?: HookDefinition[];
+        onDelete?: HookDefinition[];
+        onPublish?: HookDefinition[];
+        onUnpublish?: HookDefinition[];
+    };
+    /** Pages configuration - enables web page generation for records */
+    pages?: {
+        /** Whether pages are enabled for this entity type */
+        enabled?: boolean;
+        /** Sitemap configuration */
+        sitemap?: {
+            changefreq?: string;
+            priority?: number;
+        };
+        /** Default template reference */
+        defaultTemplate?: {
+            modelKey: string;
+            naturalKey: string;
+        };
+        /** Parent model relationships */
+        parentModels?: Array<{
+            modelKey: string;
+            cascadeDelete?: boolean;
+        }>;
+    };
+}
+/**
+ * Field definition input for schema definition
+ */
+export interface FieldDefinitionInput {
+    /** Field key (must be unique within model) */
+    key: string;
+    /** Field type (text, number, image, etc. or another entity model key) */
+    type: string;
+    /** Display label */
+    label: string;
+    /** Whether field is required */
+    required?: boolean;
+    /** Help text shown to editors */
+    helpText?: string;
+    /** Placeholder text */
+    placeholder?: string;
+    /** Default value */
+    defaultValue?: any;
+    /** Type-specific options */
+    options?: Record<string, any>;
+    /** Validation rules */
+    validation?: ValidationRule[];
+}
+/**
+ * Hook definition for lifecycle events
+ */
+export interface HookDefinition {
+    type: 'webhook' | 'expression';
+    /** For webhook type */
+    url?: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    headers?: Record<string, string>;
+    async?: boolean;
+    additionalData?: Record<string, any>;
+    /** For expression type */
+    description?: string;
+    expression?: any;
+    hooks?: HookDefinition[];
+}
+/**
+ * Define an entity model for code-first schema management
+ *
+ * @example
+ * ```typescript
+ * // schemas/article.schema.ts
+ * import { defineEntityModel } from '@eide/uniformgen';
+ *
+ * export default defineEntityModel({
+ *   key: 'article',
+ *   name: 'Article',
+ *   pluralName: 'Articles',
+ *   tier: 3,
+ *   modes: { records: true, inline: false },
+ *   fields: [
+ *     { key: 'title', type: 'text', label: 'Title', required: true },
+ *     { key: 'slug', type: 'text', label: 'Slug', required: true },
+ *     { key: 'content', type: 'richtext', label: 'Content' },
+ *   ],
+ * });
+ * ```
+ */
+export declare function defineEntityModel(definition: EntityModelDefinition): EntityModelDefinition;
+/**
+ * Convert entity model definition to API field schema format
+ */
+export declare function toFieldSchema(field: FieldDefinitionInput): FieldSchema;
+//# sourceMappingURL=define-entity-model.d.ts.map

package/dist/schema/define-entity-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-entity-model.d.ts","sourceRoot":"","sources":["../../src/schema/define-entity-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,kBAAkB;IAClB,KAAK,EAAE;QACL,mDAAmD;QACnD,OAAO,EAAE,OAAO,CAAC;QACjB,kDAAkD;QAClD,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,wBAAwB;IACxB,MAAM,EAAE,oBAAoB,EAAE,CAAC;IAC/B,oCAAoC;IACpC,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;QAC5B,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;QAC5B,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;QAC5B,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;QAC7B,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;KAChC,CAAC;IACF,oEAAoE;IACpE,KAAK,CAAC,EAAE;QACN,qDAAqD;QACrD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,4BAA4B;QAC5B,OAAO,CAAC,EAAE;YACR,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;QACF,iCAAiC;QACjC,eAAe,CAAC,EAAE;YAChB,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,iCAAiC;QACjC,YAAY,CAAC,EAAE,KAAK,CAAC;YACnB,QAAQ,EAAE,MAAM,CAAC;YACjB,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,CAAC,CAAC;KACJ,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,uBAAuB;IACvB,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC;IAC/B,uBAAuB;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,qBAAqB,GAChC,qBAAqB,CAqBvB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,oBAAoB,GAAG,WAAW,CAYtE"}

package/dist/schema/define-entity-model.js

@@ -0,0 +1,59 @@
+/**
+ * Define an entity model for code-first schema management
+ *
+ * @example
+ * ```typescript
+ * // schemas/article.schema.ts
+ * import { defineEntityModel } from '@eide/uniformgen';
+ *
+ * export default defineEntityModel({
+ *   key: 'article',
+ *   name: 'Article',
+ *   pluralName: 'Articles',
+ *   tier: 3,
+ *   modes: { records: true, inline: false },
+ *   fields: [
+ *     { key: 'title', type: 'text', label: 'Title', required: true },
+ *     { key: 'slug', type: 'text', label: 'Slug', required: true },
+ *     { key: 'content', type: 'richtext', label: 'Content' },
+ *   ],
+ * });
+ * ```
+ */
+export function defineEntityModel(definition) {
+    // Validate required fields
+    if (!definition.key) {
+        throw new Error('Entity model key is required');
+    }
+    if (!definition.name) {
+        throw new Error('Entity model name is required');
+    }
+    if (!definition.fields || definition.fields.length === 0) {
+        throw new Error('Entity model must have at least one field');
+    }
+    if (definition.modes.records === undefined && definition.modes.inline === undefined) {
+        throw new Error('Entity model must specify at least one mode (records or inline)');
+    }
+    // Set defaults
+    return {
+        ...definition,
+        editorMode: definition.editorMode ?? 'flat',
+        pluralName: definition.pluralName ?? `${definition.name}s`,
+    };
+}
+/**
+ * Convert entity model definition to API field schema format
+ */
+export function toFieldSchema(field) {
+    return {
+        key: field.key,
+        type: field.type,
+        label: field.label,
+        required: field.required,
+        helpText: field.helpText,
+        placeholder: field.placeholder,
+        defaultValue: field.defaultValue,
+        options: field.options,
+        validation: field.validation,
+    };
+}

package/dist/schema/schema-loader.d.ts

@@ -0,0 +1,10 @@
+import type { EntityModelDefinition } from './define-entity-model.js';
+/**
+ * Load entity model schemas from a directory
+ */
+export declare function loadSchemas(directory: string, pattern?: string): Promise<EntityModelDefinition[]>;
+/**
+ * Generate schema file content from an entity model
+ */
+export declare function generateSchemaFile(model: EntityModelDefinition): string;
+//# sourceMappingURL=schema-loader.d.ts.map

package/dist/schema/schema-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-loader.d.ts","sourceRoot":"","sources":["../../src/schema/schema-loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEtE;;GAEG;AACH,wBAAsB,WAAW,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAAyB,GACjC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CA2ClC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,qBAAqB,GAAG,MAAM,CA4CvE"}

package/dist/schema/schema-loader.js

@@ -0,0 +1,91 @@
+import { promises as fs } from 'fs';
+import { resolve, basename } from 'path';
+import { pathToFileURL } from 'url';
+import { glob } from 'glob';
+/**
+ * Load entity model schemas from a directory
+ */
+export async function loadSchemas(directory, pattern = '**/*.schema.ts') {
+    const absoluteDir = resolve(process.cwd(), directory);
+    // Check if directory exists
+    try {
+        await fs.access(absoluteDir);
+    }
+    catch {
+        throw new Error(`Schema directory not found: ${absoluteDir}`);
+    }
+    // Find schema files
+    const files = await glob(pattern, {
+        cwd: absoluteDir,
+        absolute: true,
+    });
+    if (files.length === 0) {
+        return [];
+    }
+    // Load each schema
+    const schemas = [];
+    for (const file of files) {
+        try {
+            const fileUrl = pathToFileURL(file).href;
+            const module = await import(fileUrl);
+            const schema = module.default || module;
+            if (!schema || !schema.key) {
+                console.warn(`Warning: ${basename(file)} does not export a valid entity model definition`);
+                continue;
+            }
+            schemas.push(schema);
+        }
+        catch (error) {
+            throw new Error(`Failed to load schema from ${file}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    return schemas;
+}
+/**
+ * Generate schema file content from an entity model
+ */
+export function generateSchemaFile(model) {
+    const fieldDefs = model.fields
+        .map((f) => {
+        const props = [
+            `key: '${f.key}'`,
+            `type: '${f.type}'`,
+            `label: '${f.label}'`,
+        ];
+        if (f.required)
+            props.push('required: true');
+        if (f.helpText)
+            props.push(`helpText: '${f.helpText}'`);
+        if (f.placeholder)
+            props.push(`placeholder: '${f.placeholder}'`);
+        if (f.defaultValue !== undefined) {
+            props.push(`defaultValue: ${JSON.stringify(f.defaultValue)}`);
+        }
+        if (f.options) {
+            props.push(`options: ${JSON.stringify(f.options)}`);
+        }
+        if (f.validation && f.validation.length > 0) {
+            props.push(`validation: ${JSON.stringify(f.validation)}`);
+        }
+        return `    { ${props.join(', ')} }`;
+    })
+        .join(',\n');
+    return `import { defineEntityModel } from '@eide/uniformgen';
+
+export default defineEntityModel({
+  key: '${model.key}',
+  name: '${model.name}',
+  ${model.pluralName ? `pluralName: '${model.pluralName}',` : ''}
+  ${model.description ? `description: '${model.description}',` : ''}
+  tier: ${model.tier},
+  ${model.editorMode ? `editorMode: '${model.editorMode}',` : ''}
+  modes: {
+    records: ${model.modes.records},
+    inline: ${model.modes.inline},
+  },
+  fields: [
+${fieldDefs}
+  ],
+});
+`;
+}

package/dist/utils/field-mapping.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Maps EIDE field types to TypeScript types
+ * Based on the field type mapping table in uniformgen-typesafe-entities.md
+ */
+export interface TypeMapping {
+    outputType: string;
+    inputType: string;
+    needsImport?: string;
+}
+/**
+ * Primitive field types that are built-in
+ * Based on the current field type registry in packages/platform/src/entities/field-types/registry.ts
+ */
+export declare const PRIMITIVE_FIELD_TYPES: Set<string>;
+/**
+ * Check if a field type is a primitive (built-in) type
+ */
+export declare function isPrimitiveFieldType(type: string): boolean;
+/**
+ * Field type to TypeScript type mapping
+ * Based on the current field type registry in packages/platform/src/entities/field-types/registry.ts
+ */
+export declare const FIELD_TYPE_MAPPING: Record<string, TypeMapping>;
+/**
+ * Get TypeScript type for a field
+ */
+export declare function getFieldType(field: {
+    type: string;
+    options?: any;
+}, mode?: 'output' | 'input'): string;
+/**
+ * Get all imports needed for a set of fields
+ */
+export declare function getRequiredImports(fields: Array<{
+    type: string;
+    options?: any;
+}>): Set<string>;
+/**
+ * Get all inline schema references from fields
+ * Returns the keys of entity models that are used as field types
+ */
+export declare function getInlineSchemaReferences(fields: Array<{
+    type: string;
+    options?: any;
+}>): Set<string>;
+/**
+ * Convert field ID to camelCase
+ */
+export declare function toCamelCase(str: string): string;
+/**
+ * Convert field ID to PascalCase
+ */
+export declare function toPascalCase(str: string): string;
+/**
+ * Sanitize field name for TypeScript
+ * Replaces special characters and spaces with underscores.
+ * Prefixes with underscore if name starts with a number.
+ */
+export declare function sanitizeFieldName(name: string): string;
+/**
+ * Field schema from the API (for type reference)
+ */
+export interface FieldSchemaForGen {
+    key: string;
+    type: string;
+    label: string;
+    required?: boolean;
+    helpText?: string;
+    placeholder?: string;
+    defaultValue?: any;
+    options?: any;
+    validation?: Array<{
+        type: string;
+        value: any;
+        message?: string;
+    }>;
+}
+/**
+ * Generate a strongly-typed field definition object string
+ * Returns a string that can be used in generated TypeScript code
+ */
+export declare function generateFieldDef(field: FieldSchemaForGen): string;
+//# sourceMappingURL=field-mapping.d.ts.map

package/dist/utils/field-mapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-mapping.d.ts","sourceRoot":"","sources":["../../src/utils/field-mapping.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,aA+BhC,CAAC;AAEH;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CA2G1D,CAAC;AAEF;;GAEG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,GAAG,CAAA;CAAE,EACtC,IAAI,GAAE,QAAQ,GAAG,OAAkB,GAClC,MAAM,CAgDR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC,GAC7C,GAAG,CAAC,MAAM,CAAC,CAmBb;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC,GAC7C,GAAG,CAAC,MAAM,CAAC,CAmBb;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGhD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUtD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,GAAG,MAAM,CA4EjE"}