@cms0/cms0 0.0.1 → 0.0.3

package/dist/esm/libs/cli/descriptor-builder-alt.js

@@ -1,8 +1,24 @@
 // Fresh descriptor builder using tree-based traversal from cms0<T>.
 import fs from "fs";
 import path from "path";
-import { Project, SyntaxKind, } from "ts-morph";
+import { Project, SyntaxKind, Node, } from "ts-morph";
 import { findTsConfig } from "./config-loader.js";
+import { customTypeNames, customInlineDescriptors, customInlineTypeNames, customModelDescriptors, customModelTypeNames, resolveCustomTypeDependencies, } from "../../custom-types/registry.js";
+function resolveCustomTypeName(type) {
+    const aliasSymbol = type.getAliasSymbol();
+    const symbol = type.getSymbol();
+    const name = aliasSymbol?.getName() ?? symbol?.getName();
+    if (name && customTypeNames.has(name)) {
+        return name;
+    }
+    const text = type.getText();
+    for (const customName of customTypeNames) {
+        if (text === customName || text.endsWith(`.${customName}`)) {
+            return customName;
+        }
+    }
+    return undefined;
+}
 function unwrapOptional(type) {
     let optional = false;
     let nullable = false;
@@ -25,6 +41,14 @@ function unwrapOptional(type) {
     }
     return { base: type, optional, nullable };
 }
+function applyOptionalityToDescriptor(desc, optional, nullable) {
+    const clone = JSON.parse(JSON.stringify(desc));
+    if (optional)
+        clone.optional = true;
+    if (nullable)
+        clone.nullable = true;
+    return clone;
+}
 function collectModelNames(sourceFiles) {
     const names = new Set();
     sourceFiles.forEach((sf) => {
@@ -50,7 +74,9 @@ function collectReferencedModelNames(type, names, visited, ctx) {
         return;
     visited.add(key);
     if (base.isUnion()) {
-        base.getUnionTypes().forEach((t, idx) => collectReferencedModelNames(t, names, visited, `${ctx}|${idx}`));
+        base
+            .getUnionTypes()
+            .forEach((t, idx) => collectReferencedModelNames(t, names, visited, `${ctx}|${idx}`));
         return;
     }
     if (base.isArray()) {
@@ -61,7 +87,11 @@ function collectReferencedModelNames(type, names, visited, ctx) {
     const aliasSymbol = base.getAliasSymbol();
     const symbol = base.getSymbol();
     const name = aliasSymbol?.getName() ?? symbol?.getName();
-    if (name && base.isObject()) {
+    const customName = resolveCustomTypeName(base);
+    if (customName) {
+        names.add(customName);
+    }
+    else if (name && base.isObject()) {
         names.add(name);
     }
     if (base.isObject()) {
@@ -80,7 +110,10 @@ function buildProperties(type, modelNames, warnings, ctx) {
         if (!decl)
             return;
         const analyzed = unwrapOptional(decl.getType());
-        props[prop.getName()] = descriptorFromType(analyzed.base, modelNames, warnings, `${ctx}.${prop.getName()}`, { optional: prop.isOptional() || analyzed.optional, nullable: analyzed.nullable });
+        props[prop.getName()] = descriptorFromType(analyzed.base, modelNames, warnings, `${ctx}.${prop.getName()}`, {
+            optional: prop.isOptional() || analyzed.optional,
+            nullable: analyzed.nullable,
+        });
     });
     return props;
 }
@@ -89,13 +122,35 @@ function descriptorFromType(type, modelNames, warnings, ctx, opts) {
     const isOptional = !!opts?.optional || optional;
     const isNullable = !!opts?.nullable || nullable;
     if (base.isString()) {
-        return { kind: "primitive", type: "string", optional: isOptional, nullable: isNullable };
+        return {
+            kind: "primitive",
+            type: "string",
+            optional: isOptional,
+            nullable: isNullable,
+        };
     }
     if (base.isNumber()) {
-        return { kind: "primitive", type: "number", optional: isOptional, nullable: isNullable };
+        return {
+            kind: "primitive",
+            type: "number",
+            optional: isOptional,
+            nullable: isNullable,
+        };
     }
     if (base.isBoolean()) {
-        return { kind: "primitive", type: "boolean", optional: isOptional, nullable: isNullable };
+        return {
+            kind: "primitive",
+            type: "boolean",
+            optional: isOptional,
+            nullable: isNullable,
+        };
+    }
+    const customName = resolveCustomTypeName(base);
+    if (customName && customInlineTypeNames.has(customName)) {
+        const inlineDescriptor = customInlineDescriptors[customName];
+        if (inlineDescriptor) {
+            return applyOptionalityToDescriptor(inlineDescriptor, isOptional, isNullable);
+        }
     }
     if (base.isArray()) {
         const elem = base.getArrayElementTypeOrThrow();
@@ -109,8 +164,14 @@ function descriptorFromType(type, modelNames, warnings, ctx, opts) {
     const aliasSymbol = base.getAliasSymbol();
     const symbol = base.getSymbol();
     const name = aliasSymbol?.getName() ?? symbol?.getName();
-    if (name && modelNames.has(name)) {
-        return { kind: "modelRef", model: name, optional: isOptional, nullable: isNullable };
+    const modelName = customName ?? name;
+    if (modelName && modelNames.has(modelName)) {
+        return {
+            kind: "modelRef",
+            model: modelName,
+            optional: isOptional,
+            nullable: isNullable,
+        };
     }
     if (base.isObject()) {
         return {
@@ -121,7 +182,12 @@ function descriptorFromType(type, modelNames, warnings, ctx, opts) {
         };
     }
     warnings.add(`cms0: unsupported type at ${ctx}; falling back to string`);
-    return { kind: "primitive", type: "string", optional: isOptional, nullable: isNullable };
+    return {
+        kind: "primitive",
+        type: "string",
+        optional: isOptional,
+        nullable: isNullable,
+    };
 }
 function collectModels(sourceFiles, modelNames, modelMap, warnings) {
     const handleShape = (name, type, ctx) => {
@@ -131,7 +197,10 @@ function collectModels(sourceFiles, modelNames, modelMap, warnings) {
             return;
         if (!type.isObject())
             return;
-        modelMap[name] = { kind: "model", properties: buildProperties(type, modelNames, warnings, ctx) };
+        modelMap[name] = {
+            kind: "model",
+            properties: buildProperties(type, modelNames, warnings, ctx),
+        };
     };
     sourceFiles.forEach((sf) => {
         sf.getTypeAliases().forEach((alias) => {
@@ -146,24 +215,57 @@ function collectModels(sourceFiles, modelNames, modelMap, warnings) {
         });
     });
 }
-function findRootType(sourceFiles) {
+function readCms0Options(invoc) {
+    const arg = invoc.getArguments()[0];
+    if (!arg || !Node.isObjectLiteralExpression(arg))
+        return {};
+    const options = {};
+    const localesProp = arg.getProperty("locales");
+    if (localesProp && Node.isPropertyAssignment(localesProp)) {
+        const init = localesProp.getInitializer();
+        if (init && Node.isArrayLiteralExpression(init)) {
+            const values = init
+                .getElements()
+                .map((el) => (Node.isStringLiteral(el) ? el.getLiteralValue() : null))
+                .filter((val) => Boolean(val));
+            if (values.length)
+                options.locales = values;
+        }
+    }
+    const defaultProp = arg.getProperty("defaultLocale");
+    if (defaultProp && Node.isPropertyAssignment(defaultProp)) {
+        const init = defaultProp.getInitializer();
+        if (init && Node.isStringLiteral(init)) {
+            options.defaultLocale = init.getLiteralValue();
+        }
+    }
+    return options;
+}
+function findRootInvocation(sourceFiles) {
     for (const sf of sourceFiles) {
         const invoc = sf
             ?.getDescendantsOfKind(SyntaxKind.CallExpression)
             .find((call) => call.getExpression().getText() === "cms0");
         if (invoc) {
             const typeArgs = invoc.getTypeArguments();
-            if (typeArgs.length > 0)
-                return typeArgs[0].getType();
+            if (typeArgs.length > 0) {
+                return {
+                    rootType: typeArgs[0].getType(),
+                    ...readCms0Options(invoc),
+                };
+            }
         }
     }
     return undefined;
 }
 function buildDescriptorAlt(resolved) {
     const tsconfig = resolved.tsconfigPath ?? findTsConfig(resolved.entryFile);
-    const project = tsconfig ? new Project({ tsConfigFilePath: tsconfig }) : new Project();
+    const project = tsconfig
+        ? new Project({ tsConfigFilePath: tsconfig })
+        : new Project();
     const warnings = new Set();
-    if (!project.getSourceFile(resolved.entryFile) && fs.existsSync(resolved.entryFile)) {
+    if (!project.getSourceFile(resolved.entryFile) &&
+        fs.existsSync(resolved.entryFile)) {
         project.addSourceFileAtPath(resolved.entryFile);
     }
     const sourceFiles = project.getSourceFiles().filter((sf) => {
@@ -175,16 +277,36 @@ function buildDescriptorAlt(resolved) {
         const rel = path.relative(path.dirname(resolved.entryFile), filePath);
         return rel && !rel.startsWith("..") && !path.isAbsolute(rel);
     });
-    const rootType = findRootType(sourceFiles);
-    if (!rootType)
+    const invocation = findRootInvocation(sourceFiles);
+    if (!invocation)
         throw new Error("Could not locate cms0<T>() invocation in project sources.");
+    const rootType = invocation.rootType;
     // Restrict models to only those referenced by the root type tree and exported in scope.
     const exportedModelNames = collectModelNames(sourceFiles);
+    const collisions = Array.from(customTypeNames).filter((name) => exportedModelNames.has(name));
+    if (collisions.length) {
+        throw new Error(`cms0: custom type name collision: ${collisions.join(", ")}. Rename your model(s) or use a different custom type name.`);
+    }
     const referencedModelNames = new Set();
     collectReferencedModelNames(rootType, referencedModelNames, new Set(), "root");
-    const modelNames = new Set(Array.from(referencedModelNames).filter((n) => exportedModelNames.has(n)));
+    const referencedCustomTypeNames = new Set(Array.from(referencedModelNames).filter((n) => customTypeNames.has(n)));
+    const referencedCustomModelNames = new Set(Array.from(referencedCustomTypeNames).filter((n) => customModelTypeNames.has(n)));
+    const resolvedCustomTypeNames = resolveCustomTypeDependencies(referencedCustomModelNames);
+    const modelNames = new Set([
+        ...Array.from(referencedModelNames).filter((n) => exportedModelNames.has(n)),
+        ...Array.from(resolvedCustomTypeNames),
+    ]);
     const modelMap = {};
     collectModels(sourceFiles, modelNames, modelMap, warnings);
+    resolvedCustomTypeNames.forEach((name) => {
+        if (modelMap[name]) {
+            return;
+        }
+        const descriptor = customModelDescriptors[name];
+        if (descriptor) {
+            modelMap[name] = descriptor;
+        }
+    });
     const roots = {};
     for (const prop of rootType.getProperties()) {
         const name = prop.getName();
@@ -211,6 +333,17 @@ function buildDescriptorAlt(resolved) {
     }
     if (warnings.size)
         warnings.forEach((w) => console.warn(w));
-    return { models: modelMap, roots };
+    const locales = invocation.locales;
+    const defaultLocale = invocation.defaultLocale;
+    return {
+        models: modelMap,
+        roots,
+        metadata: locales || defaultLocale
+            ? {
+                locales,
+                defaultLocale,
+            }
+            : undefined,
+    };
 }
 export { buildDescriptorAlt };

package/dist/esm/libs/cli/descriptor-builder.js

@@ -1,7 +1,7 @@
 // Build a schema descriptor by inspecting user types with ts-morph.
 import fs from "fs";
 import path from "path";
-import { Project, SyntaxKind, } from "ts-morph";
+import { Project, SyntaxKind, Node, } from "ts-morph";
 import { findTsConfig } from "./config-loader.js";
 function unwrapOptional(type) {
     let optional = false;
@@ -121,7 +121,33 @@ function collectModels(sourceFiles, modelMap, warnings) {
         });
     });
 }
-function findRootType(sourceFiles) {
+function readCms0Options(invoc) {
+    const arg = invoc.getArguments()[0];
+    if (!arg || !Node.isObjectLiteralExpression(arg))
+        return {};
+    const options = {};
+    const localesProp = arg.getProperty("locales");
+    if (localesProp && Node.isPropertyAssignment(localesProp)) {
+        const init = localesProp.getInitializer();
+        if (init && Node.isArrayLiteralExpression(init)) {
+            const values = init
+                .getElements()
+                .map((el) => (Node.isStringLiteral(el) ? el.getLiteralValue() : null))
+                .filter((val) => Boolean(val));
+            if (values.length)
+                options.locales = values;
+        }
+    }
+    const defaultProp = arg.getProperty("defaultLocale");
+    if (defaultProp && Node.isPropertyAssignment(defaultProp)) {
+        const init = defaultProp.getInitializer();
+        if (init && Node.isStringLiteral(init)) {
+            options.defaultLocale = init.getLiteralValue();
+        }
+    }
+    return options;
+}
+function findRootInvocation(sourceFiles) {
     for (const sf of sourceFiles) {
         const invoc = sf
             ?.getDescendantsOfKind(SyntaxKind.CallExpression)
@@ -129,7 +155,10 @@ function findRootType(sourceFiles) {
         if (invoc) {
             const typeArgs = invoc.getTypeArguments();
             if (typeArgs.length > 0) {
-                return typeArgs[0].getType();
+                return {
+                    rootType: typeArgs[0].getType(),
+                    ...readCms0Options(invoc),
+                };
             }
         }
     }
@@ -153,10 +182,11 @@ function buildDescriptor(resolved) {
     });
     const modelMap = {};
     collectModels(sourceFiles, modelMap, warnings);
-    const rootType = findRootType(sourceFiles);
-    if (!rootType) {
+    const invocation = findRootInvocation(sourceFiles);
+    if (!invocation) {
         throw new Error("Could not locate cms0<T>() invocation in project sources.");
     }
+    const rootType = invocation.rootType;
     const roots = {};
     for (const prop of rootType.getProperties()) {
         const name = prop.getName();
@@ -222,6 +252,17 @@ function buildDescriptor(resolved) {
     if (warnings.size) {
         warnings.forEach((w) => console.warn(w));
     }
-    return { models: modelMap, roots };
+    const locales = invocation.locales;
+    const defaultLocale = invocation.defaultLocale;
+    return {
+        models: modelMap,
+        roots,
+        metadata: locales || defaultLocale
+            ? {
+                locales,
+                defaultLocale,
+            }
+            : undefined,
+    };
 }
 export { buildDescriptor };

package/dist/types/custom-types/index.d.ts

@@ -0,0 +1,35 @@
+export type FileBase = {
+    name: string;
+    filename: string;
+    extension: string;
+    mimeType: string;
+    size: number;
+};
+export type File = FileBase;
+export type Image = FileBase & {
+    width: number;
+    height: number;
+    alt?: string;
+};
+export type Video = FileBase & {
+    width: number;
+    height: number;
+    length: number;
+    alt?: string;
+};
+export type RichText = {
+    value: Record<string, any>;
+    html: string;
+};
+export type LocalizedString = Array<{
+    locale: string;
+    isDefault: boolean;
+    value: string;
+}>;
+export type LocalizedRichText = Array<{
+    locale: string;
+    isDefault: boolean;
+    value: Record<string, any>;
+    html: string;
+}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/custom-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/custom-types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC;AAE5B,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAAC"}

package/dist/types/custom-types/registry.d.ts

@@ -0,0 +1,65 @@
+import type { FieldDescriptor, ModelDescriptor, PrimitiveType } from "@cms0/shared";
+export declare const customModelDescriptors: {
+    readonly File: ModelDescriptor;
+    readonly Image: ModelDescriptor;
+    readonly Video: ModelDescriptor;
+};
+export declare const customInlineDescriptors: {
+    readonly RichText: {
+        kind?: "primitive";
+        type: PrimitiveType;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+    readonly LocalizedString: {
+        kind?: "array";
+        type: "array";
+        items: FieldDescriptor;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+    readonly LocalizedRichText: {
+        kind?: "array";
+        type: "array";
+        items: FieldDescriptor;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+};
+export declare const customTypeDescriptors: {
+    readonly RichText: {
+        kind?: "primitive";
+        type: PrimitiveType;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+    readonly LocalizedString: {
+        kind?: "array";
+        type: "array";
+        items: FieldDescriptor;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+    readonly LocalizedRichText: {
+        kind?: "array";
+        type: "array";
+        items: FieldDescriptor;
+        optional?: boolean;
+        nullable?: boolean;
+        customType?: string;
+    };
+    readonly File: ModelDescriptor;
+    readonly Image: ModelDescriptor;
+    readonly Video: ModelDescriptor;
+};
+export type CustomTypeName = keyof typeof customTypeDescriptors;
+export declare const customTypeNames: Set<string>;
+export declare const customModelTypeNames: Set<string>;
+export declare const customInlineTypeNames: Set<string>;
+export declare function resolveCustomTypeDependencies(names: Iterable<string>): Set<string>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/types/custom-types/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/custom-types/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AA4EpF,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AAEX,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;CAI1B,CAAC;AAEX,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGxB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAEhE,eAAO,MAAM,eAAe,aAAsD,CAAC;AACnF,eAAO,MAAM,oBAAoB,aAEhC,CAAC;AACF,eAAO,MAAM,qBAAqB,aAEjC,CAAC;AAEF,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAwBlF"}