@eide/foir-cli 0.1.2 → 0.1.4

package/dist/codegen/generators/field-types.js

@@ -0,0 +1,339 @@
+/**
+ * Generates the static field-types.ts file with value types, filter types, and field defs.
+ */
+export function generateFieldTypesFile() {
+    return `/**
+ * Field Types and Definitions
+ *
+ * Value types, filter types, and field definition types.
+ *
+ * @generated by foir — DO NOT EDIT MANUALLY
+ */
+
+// =============================================================================
+// VALUE TYPES
+// =============================================================================
+
+/** Rich text content (Lexical JSON format) */
+export type RichtextValue = unknown;
+
+/** Currency value with amount and ISO 4217 code */
+export interface CurrencyValue {
+  amount: number;
+  currency: string;
+}
+
+/** Image reference with metadata */
+export interface ImageValue {
+  id: string;
+  url: string;
+  alt?: string;
+  width?: number;
+  height?: number;
+}
+
+/** Video reference with metadata */
+export interface VideoValue {
+  id: string;
+  url: string;
+  thumbnail?: string;
+  duration?: number;
+}
+
+/** File reference with metadata */
+export interface FileValue {
+  id: string;
+  url: string;
+  name: string;
+  size: number;
+  mimeType: string;
+}
+
+/** Link value (internal reference or external URL) */
+export interface LinkValue {
+  type: 'entity' | 'url';
+  entity?: LinkEntityReference;
+  url?: string;
+  target?: '_self' | '_blank';
+}
+
+/** Entity reference for internal links */
+export interface LinkEntityReference {
+  modelKey: string;
+  naturalKey: string;
+}
+
+/** Entity reference value */
+export interface ReferenceValue {
+  _type: 'reference';
+  _schema: string;
+  naturalKey: string;
+  _preview?: Record<string, unknown>;
+}
+
+/** Composite/inline value */
+export interface CompositeValue {
+  _type: 'composite';
+  _schema: string;
+  fields: Record<string, unknown>;
+}
+
+/** A single item in a flexible field array */
+export interface FlexibleFieldItem {
+  _id: string;
+  _key: string;
+  _type: string;
+  _label: string;
+  _required?: boolean;
+  _helpText?: string;
+  _config?: Record<string, unknown>;
+  value: unknown;
+}
+
+// =============================================================================
+// FILTER TYPES
+// =============================================================================
+
+export interface TextFilter {
+  eq?: string;
+  ne?: string;
+  contains?: string;
+  startsWith?: string;
+  endsWith?: string;
+  in?: string[];
+  notIn?: string[];
+  isNull?: boolean;
+}
+
+export interface NumberFilter {
+  eq?: number;
+  ne?: number;
+  gt?: number;
+  gte?: number;
+  lt?: number;
+  lte?: number;
+  in?: number[];
+  notIn?: number[];
+  isNull?: boolean;
+}
+
+export interface BooleanFilter {
+  eq?: boolean;
+  ne?: boolean;
+  isNull?: boolean;
+}
+
+export interface DateFilter {
+  eq?: string;
+  ne?: string;
+  gt?: string;
+  gte?: string;
+  lt?: string;
+  lte?: string;
+  isNull?: boolean;
+}
+
+export interface SelectFilter<T extends string = string> {
+  eq?: T;
+  ne?: T;
+  in?: T[];
+  notIn?: T[];
+  isNull?: boolean;
+}
+
+export interface MultiselectFilter<T extends string = string> {
+  contains?: T;
+  containsAny?: T[];
+  containsAll?: T[];
+  isNull?: boolean;
+}
+
+export interface ReferenceFilter {
+  eq?: string;
+  ne?: string;
+  in?: string[];
+  notIn?: string[];
+  isNull?: boolean;
+}
+
+export interface FilterInput {
+  field: string;
+  operator: string;
+  value: unknown;
+}
+
+export interface SortInput {
+  field: string;
+  direction: 'ASC' | 'DESC';
+}
+
+// =============================================================================
+// RESOLVE TYPES
+// =============================================================================
+
+/** Variant context for record resolution */
+export interface VariantContext {
+  locale?: string;
+  device?: string;
+  region?: string;
+  contexts?: Record<string, unknown>;
+}
+
+/** Reference resolution options */
+export interface ReferenceResolutionOptions {
+  maxDepth?: number;
+  resolveMedia?: boolean;
+  resolveReferences?: boolean;
+}
+
+/** Resolved record metadata */
+export interface ResolvedRecord {
+  id: string;
+  modelKey: string;
+  naturalKey: string | null;
+  metadata?: Record<string, unknown>;
+}
+
+/** Resolved variant info */
+export interface ResolvedVariant {
+  id: string;
+  variantKey: string;
+}
+
+/** Resolved field with value */
+export interface ResolvedField {
+  key: string;
+  type: string;
+  label?: string;
+  required?: boolean;
+  value: unknown;
+}
+
+/** Resolved content */
+export interface ResolvedContent {
+  fields: ResolvedField[];
+}
+
+/** Resolution context output */
+export interface ResolutionContext {
+  locale: string;
+  contexts: Record<string, unknown>;
+}
+
+/** Base resolved record content */
+export interface ResolvedRecordContentBase {
+  record: ResolvedRecord;
+  variant: ResolvedVariant;
+  content: ResolvedContent;
+  resolvedWith: ResolutionContext;
+}
+
+// =============================================================================
+// FIELD DEFINITION TYPES
+// =============================================================================
+
+export interface BaseFieldDef {
+  key: string;
+  label: string;
+  required?: boolean;
+  helpText?: string;
+  defaultValue?: unknown;
+}
+
+export interface TextFieldDef extends BaseFieldDef {
+  type: 'text';
+  maxLength?: number;
+  minLength?: number;
+  pattern?: string;
+}
+
+export interface NumberFieldDef extends BaseFieldDef {
+  type: 'number';
+  min?: number;
+  max?: number;
+  step?: number;
+}
+
+export interface BooleanFieldDef extends BaseFieldDef {
+  type: 'boolean';
+}
+
+export interface DateFieldDef extends BaseFieldDef {
+  type: 'date';
+}
+
+export interface RichtextFieldDef extends BaseFieldDef {
+  type: 'richtext';
+}
+
+export interface ImageFieldDef extends BaseFieldDef {
+  type: 'image';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+export interface VideoFieldDef extends BaseFieldDef {
+  type: 'video';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+export interface FileFieldDef extends BaseFieldDef {
+  type: 'file';
+  allowedTypes?: string[];
+  maxSize?: number;
+}
+
+export interface SelectFieldDef extends BaseFieldDef {
+  type: 'select';
+  options: Array<{ label: string; value: string }>;
+}
+
+export interface MultiselectFieldDef extends BaseFieldDef {
+  type: 'multiselect';
+  options: Array<{ label: string; value: string }>;
+}
+
+export interface LinkFieldDef extends BaseFieldDef {
+  type: 'link';
+}
+
+export interface ReferenceFieldDef extends BaseFieldDef {
+  type: 'entity-reference' | 'reference';
+  referenceTypes?: string[];
+  multiple?: boolean;
+}
+
+export interface ListFieldDef extends BaseFieldDef {
+  type: 'list';
+  itemType?: string;
+  minItems?: number;
+  maxItems?: number;
+}
+
+export interface JsonFieldDef extends BaseFieldDef {
+  type: 'json';
+}
+
+export interface FlexibleFieldDef extends BaseFieldDef {
+  type: 'flexible';
+}
+
+export type FieldDef =
+  | TextFieldDef
+  | NumberFieldDef
+  | BooleanFieldDef
+  | DateFieldDef
+  | RichtextFieldDef
+  | ImageFieldDef
+  | VideoFieldDef
+  | FileFieldDef
+  | SelectFieldDef
+  | MultiselectFieldDef
+  | LinkFieldDef
+  | ReferenceFieldDef
+  | ListFieldDef
+  | JsonFieldDef
+  | FlexibleFieldDef;
+`;
+}

package/dist/codegen/generators/model-index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates the models/index.ts re-export file.
+ */
+import type { CodegenModel } from '../fetch-models.js';
+export declare function generateModelIndex(models: CodegenModel[]): string;
+//# sourceMappingURL=model-index.d.ts.map

package/dist/codegen/generators/model-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-index.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/model-index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOvD,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAoBjE"}

package/dist/codegen/generators/model-index.js

@@ -0,0 +1,26 @@
+/**
+ * Generates the models/index.ts re-export file.
+ */
+import { toPascalCase, toCamelCase } from '../field-mapping.js';
+function isInlineOnlyModel(model) {
+    return model.config.inline && !model.config.records;
+}
+export function generateModelIndex(models) {
+    let code = `/**
+ * Model Types and Configs — Generated re-exports
+ *
+ * @generated by foir — DO NOT EDIT MANUALLY
+ */\n\n`;
+    for (const model of models) {
+        const typeName = toPascalCase(model.key);
+        const configName = toCamelCase(model.key) + 'Config';
+        if (isInlineOnlyModel(model)) {
+            code += `export type { ${typeName} } from './${model.key}.js';\n`;
+        }
+        else {
+            code += `export { ${configName} } from './${model.key}.js';\n`;
+            code += `export type { ${typeName}Data } from './${model.key}.js';\n`;
+        }
+    }
+    return code;
+}

package/dist/codegen/generators/model-types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generates per-model TypeScript files with config object + data interface.
+ */
+import type { CodegenModel } from '../fetch-models.js';
+/**
+ * Generate TypeScript code for a single model.
+ *
+ * - Inline-only models: data interface only (no config)
+ * - Models with records: config object + data interface
+ */
+export declare function generateModelTypes(model: CodegenModel, allModels: CodegenModel[]): string;
+//# sourceMappingURL=model-types.d.ts.map

package/dist/codegen/generators/model-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-types.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/model-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAgBvD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,YAAY,EAAE,GACxB,MAAM,CAoBR"}

package/dist/codegen/generators/model-types.js

@@ -0,0 +1,150 @@
+/**
+ * Generates per-model TypeScript files with config object + data interface.
+ */
+import { getFieldType, getInlineSchemaReferences, generateFieldDef, sanitizeFieldName, toPascalCase, toCamelCase, FIELD_TYPE_MAPPING, } from '../field-mapping.js';
+function isInlineOnlyModel(model) {
+    return model.config.inline && !model.config.records;
+}
+/**
+ * Generate TypeScript code for a single model.
+ *
+ * - Inline-only models: data interface only (no config)
+ * - Models with records: config object + data interface
+ */
+export function generateModelTypes(model, allModels) {
+    const typeName = toPascalCase(model.key);
+    const configName = toCamelCase(model.key) + 'Config';
+    const fields = model.fields ?? [];
+    const fieldTypeImports = getFieldTypeImportsForFields(fields);
+    const inlineSchemaRefs = getInlineSchemaReferences(fields);
+    let code = buildImportStatements(model, fieldTypeImports, inlineSchemaRefs, allModels);
+    if (isInlineOnlyModel(model)) {
+        code += generateDataInterface(model, fields, typeName, allModels);
+        return code;
+    }
+    code += generateConfigObject(model, fields, configName);
+    code += '\n';
+    code += generateDataInterface(model, fields, typeName + 'Data', allModels);
+    return code;
+}
+function buildImportStatements(model, fieldTypeImports, inlineSchemaRefs, allModels) {
+    const imports = [];
+    if (!isInlineOnlyModel(model)) {
+        imports.push("import type { ModelConfig } from '../config.js';");
+    }
+    if (fieldTypeImports.size > 0) {
+        const types = Array.from(fieldTypeImports).sort().join(', ');
+        imports.push(`import type { ${types} } from '../field-types.js';`);
+    }
+    for (const refKey of inlineSchemaRefs) {
+        const refModel = allModels.find((m) => m.key === refKey);
+        if (refModel) {
+            const refTypeName = isInlineOnlyModel(refModel)
+                ? toPascalCase(refKey)
+                : toPascalCase(refKey) + 'Data';
+            imports.push(`import type { ${refTypeName} } from './${refKey}.js';`);
+        }
+    }
+    return imports.length > 0 ? imports.join('\n') + '\n\n' : '';
+}
+function generateConfigObject(model, fields, configName) {
+    const lines = [];
+    lines.push('/**');
+    lines.push(` * ${model.name} Configuration`);
+    if (model.description)
+        lines.push(` * ${model.description}`);
+    lines.push(` *`);
+    lines.push(` * @generated from model '${model.key}'`);
+    lines.push(' */');
+    const escapedName = (model.name ?? model.key).replace(/'/g, "\\'");
+    lines.push(`export const ${configName} = {`);
+    lines.push(`  key: '${model.key}',`);
+    lines.push(`  name: '${escapedName}',`);
+    if (model.description) {
+        lines.push(`  description: '${model.description.replace(/'/g, "\\'")}',`);
+    }
+    lines.push('');
+    lines.push('  // Capability flags');
+    lines.push(`  records: ${model.config.records},`);
+    lines.push(`  inline: ${model.config.inline},`);
+    lines.push(`  publicApi: ${model.config.publicApi},`);
+    lines.push(`  versioning: ${model.config.versioning},`);
+    lines.push(`  publishing: ${model.config.publishing},`);
+    lines.push(`  variants: ${model.config.variants},`);
+    lines.push(`  customerScoped: ${model.config.customerScoped},`);
+    if (model.config.embeddings?.enabled) {
+        lines.push('');
+        lines.push('  // Embeddings');
+        lines.push(`  embeddings: ${JSON.stringify(model.config.embeddings, null, 4).replace(/\n/g, '\n  ')},`);
+    }
+    if (model.hooks && Object.keys(model.hooks).length > 0) {
+        lines.push('');
+        lines.push('  // Lifecycle hooks');
+        lines.push(`  hooks: ${JSON.stringify(model.hooks, null, 4).replace(/\n/g, '\n  ')},`);
+    }
+    else {
+        lines.push('');
+        lines.push('  hooks: {},');
+    }
+    lines.push('');
+    lines.push('  // Field definitions');
+    if (fields.length === 0) {
+        lines.push('  fieldDefs: [],');
+    }
+    else {
+        lines.push('  fieldDefs: [');
+        for (const field of fields) {
+            lines.push(`    ${generateFieldDef(field)},`);
+        }
+        lines.push('  ],');
+    }
+    lines.push('} as const satisfies ModelConfig;');
+    return lines.join('\n') + '\n';
+}
+function generateDataInterface(model, fields, interfaceName, allModels) {
+    const lines = [];
+    lines.push('/**');
+    lines.push(` * ${model.name} Data`);
+    lines.push(` * Field values only — no system fields`);
+    lines.push(` *`);
+    lines.push(` * @generated from model '${model.key}'`);
+    lines.push(' */');
+    lines.push(`export interface ${interfaceName} {`);
+    for (const field of fields) {
+        const fieldName = sanitizeFieldName(field.key);
+        let fieldType = getFieldType(field, 'output');
+        // Adjust type name for inline schema refs to models with records mode
+        const refModel = allModels.find((m) => m.key === field.type);
+        if (refModel && !isInlineOnlyModel(refModel)) {
+            fieldType = toPascalCase(field.type) + 'Data';
+        }
+        // Handle list/tree itemType refs
+        if ((field.type === 'list' || field.type === 'tree') && field.options?.itemType) {
+            const itemRefModel = allModels.find((m) => m.key === field.options.itemType);
+            if (itemRefModel && !isInlineOnlyModel(itemRefModel)) {
+                fieldType = toPascalCase(field.options.itemType) + 'Data[]';
+            }
+        }
+        const optional = field.required ? '' : '?';
+        const comment = field.helpText ? `  /** ${field.helpText} */\n` : '';
+        lines.push(comment + `  ${fieldName}${optional}: ${fieldType};`);
+    }
+    lines.push('}');
+    return lines.join('\n') + '\n';
+}
+function getFieldTypeImportsForFields(fields) {
+    const imports = new Set();
+    for (const field of fields) {
+        const mapping = FIELD_TYPE_MAPPING[field.type];
+        if (mapping?.needsImport === 'field-types') {
+            imports.add(mapping.outputType);
+        }
+        if ((field.type === 'list' || field.type === 'tree') && field.options?.itemType) {
+            const itemMapping = FIELD_TYPE_MAPPING[field.options.itemType];
+            if (itemMapping?.needsImport === 'field-types') {
+                imports.add(itemMapping.outputType);
+            }
+        }
+    }
+    return imports;
+}

package/dist/codegen/generators/swift-field-types.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generates the shared FieldTypes.swift file with platform value type structs.
+ */
+export declare function generateSwiftFieldTypesFile(): string;
+//# sourceMappingURL=swift-field-types.d.ts.map

package/dist/codegen/generators/swift-field-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swift-field-types.d.ts","sourceRoot":"","sources":["../../../src/codegen/generators/swift-field-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,wBAAgB,2BAA2B,IAAI,MAAM,CA6IpD"}

package/dist/codegen/generators/swift-field-types.js

@@ -0,0 +1,145 @@
+/**
+ * Generates the shared FieldTypes.swift file with platform value type structs.
+ */
+export function generateSwiftFieldTypesFile() {
+    return `//
+//  FieldTypes.swift
+//
+//  Shared value types for platform sync data.
+//
+//  @generated by foir \u2014 DO NOT EDIT MANUALLY
+//
+
+import Foundation
+
+// MARK: - Image
+
+struct ImageValue {
+    let id: String
+    let url: String
+    var alt: String?
+    var width: Int?
+    var height: Int?
+
+    func toSyncData() -> [String: Any] {
+        var data: [String: Any] = ["id": id, "url": url]
+        if let alt { data["alt"] = alt }
+        if let width { data["width"] = width }
+        if let height { data["height"] = height }
+        return data
+    }
+
+    static func fromSyncData(_ data: [String: Any]) -> ImageValue {
+        ImageValue(
+            id: data["id"] as? String ?? "",
+            url: data["url"] as? String ?? "",
+            alt: data["alt"] as? String,
+            width: data["width"] as? Int,
+            height: data["height"] as? Int
+        )
+    }
+}
+
+// MARK: - Video
+
+struct VideoValue {
+    let id: String
+    let url: String
+    var thumbnail: String?
+    var duration: Double?
+
+    func toSyncData() -> [String: Any] {
+        var data: [String: Any] = ["id": id, "url": url]
+        if let thumbnail { data["thumbnail"] = thumbnail }
+        if let duration { data["duration"] = duration }
+        return data
+    }
+
+    static func fromSyncData(_ data: [String: Any]) -> VideoValue {
+        VideoValue(
+            id: data["id"] as? String ?? "",
+            url: data["url"] as? String ?? "",
+            thumbnail: data["thumbnail"] as? String,
+            duration: data["duration"] as? Double
+        )
+    }
+}
+
+// MARK: - File
+
+struct FileValue {
+    let id: String
+    let url: String
+    let name: String
+    let size: Int
+    let mimeType: String
+
+    func toSyncData() -> [String: Any] {
+        [
+            "id": id,
+            "url": url,
+            "name": name,
+            "size": size,
+            "mimeType": mimeType,
+        ]
+    }
+
+    static func fromSyncData(_ data: [String: Any]) -> FileValue {
+        FileValue(
+            id: data["id"] as? String ?? "",
+            url: data["url"] as? String ?? "",
+            name: data["name"] as? String ?? "",
+            size: data["size"] as? Int ?? 0,
+            mimeType: data["mimeType"] as? String ?? ""
+        )
+    }
+}
+
+// MARK: - Currency
+
+struct CurrencyValue {
+    let amount: Double
+    let currency: String
+
+    func toSyncData() -> [String: Any] {
+        ["amount": amount, "currency": currency]
+    }
+
+    static func fromSyncData(_ data: [String: Any]) -> CurrencyValue {
+        CurrencyValue(
+            amount: data["amount"] as? Double ?? 0,
+            currency: data["currency"] as? String ?? ""
+        )
+    }
+}
+
+// MARK: - Link
+
+struct LinkValue {
+    let type: String
+    var entityModelKey: String?
+    var entityNaturalKey: String?
+    var url: String?
+    var target: String?
+
+    func toSyncData() -> [String: Any] {
+        var data: [String: Any] = ["type": type]
+        if let entityModelKey { data["entityModelKey"] = entityModelKey }
+        if let entityNaturalKey { data["entityNaturalKey"] = entityNaturalKey }
+        if let url { data["url"] = url }
+        if let target { data["target"] = target }
+        return data
+    }
+
+    static func fromSyncData(_ data: [String: Any]) -> LinkValue {
+        LinkValue(
+            type: data["type"] as? String ?? "",
+            entityModelKey: data["entityModelKey"] as? String,
+            entityNaturalKey: data["entityNaturalKey"] as? String,
+            url: data["url"] as? String,
+            target: data["target"] as? String
+        )
+    }
+}
+`;
+}

package/dist/codegen/generators/swift-model-keys.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates ModelKeys.swift with all model key constants in one enum.
+ */
+import type { CodegenModel } from '../fetch-models.js';
+export declare function generateSwiftModelKeys(models: CodegenModel[]): string;
+//# sourceMappingURL=swift-model-keys.d.ts.map