@cms0/cms0 0.2.7 → 0.2.9

package/README.md

@@ -11,11 +11,15 @@ pnpm add @cms0/cms0
 ## Usage
 
 ```ts
-import { cms0 } from "@cms0/cms0";
-import type { Image } from "@cms0/cms0/custom-types";
+import { cms0, toNextMetadata } from "@cms0/cms0";
+import type { Metadata } from "next";
+import type { Image, Seo } from "@cms0/cms0/custom-types";
 
 type RootSchema = {
-  images: Image[];
+  homePage: {
+    heroImage: Image;
+    seo: Seo;
+  };
 };
 
 export const data = cms0<RootSchema>({
@@ -24,8 +28,29 @@ export const data = cms0<RootSchema>({
     key: import.meta.env.VITE_CMS0_API_KEY,
   },
 });
+
+const page = await data.homePage();
+const metadata = toNextMetadata<Metadata>(page.seo, { locale: "en" });
+```
+
+## Accessor Options
+
+All root/model accessors accept options:
+
+```ts
+await data.homePage({
+  includeId: true,
+  locale: "en",
+  fields: ["heroImage", "seo.openGraph.images"],
+  exclude: ["seo.jsonLd"],
+  query: { raw: 1 },
+});
 ```
 
+- `fields`: recursive include projection (supports nested paths like `a.b.c`).
+- `exclude`: recursive remove projection (also supports nested paths).
+- `query`: passthrough query params to API.
+
 ## Custom Types
 
 See `CUSTOM_TYPES.md` for the built-in custom types you can reference.

package/dist/cjs/custom-types/registry.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.customInlineTypeNames = exports.customModelTypeNames = exports.customTypeNames = exports.customTypeDescriptors = exports.customInlineTypeMetadata = exports.customInlineDescriptors = exports.customModelDescriptors = void 0;
 exports.getCustomInlineTypeMetadata = getCustomInlineTypeMetadata;
 exports.resolveCustomTypeDependencies = resolveCustomTypeDependencies;
+const shared_1 = require("@cms0/shared");
 const primitive = (type) => ({
     kind: "primitive",
     type,
@@ -54,6 +55,237 @@ const localizedRichTextDescriptor = {
     type: "json",
     customType: "LocalizedRichText",
 };
+function createUnionDescriptor(branches) {
+    return {
+        kind: "union",
+        anyOf: branches,
+        branchKeys: (0, shared_1.computeUnionBranchKeys)(branches),
+    };
+}
+const localizedOrStringDescriptor = createUnionDescriptor([
+    localizedStringDescriptor,
+    {
+        kind: "primitive",
+        type: "string",
+    },
+]);
+const keywordsDescriptor = createUnionDescriptor([
+    localizedStringDescriptor,
+    {
+        type: "array",
+        items: {
+            kind: "primitive",
+            type: "string",
+        },
+    },
+]);
+const robotsDescriptor = createUnionDescriptor([
+    {
+        kind: "primitive",
+        type: "boolean",
+    },
+    {
+        type: "object",
+        properties: {
+            index: {
+                kind: "primitive",
+                type: "boolean",
+                optional: true,
+                nullable: false,
+            },
+            follow: {
+                kind: "primitive",
+                type: "boolean",
+                optional: true,
+                nullable: false,
+            },
+            nocache: {
+                kind: "primitive",
+                type: "boolean",
+                optional: true,
+                nullable: false,
+            },
+        },
+    },
+]);
+const alternatesDescriptor = {
+    type: "object",
+    properties: {
+        canonical: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        languages: {
+            kind: "primitive",
+            type: "json",
+            optional: true,
+            nullable: false,
+        },
+    },
+};
+const imageOrStringDescriptor = createUnionDescriptor([
+    {
+        kind: "modelRef",
+        model: "Image",
+    },
+    {
+        kind: "primitive",
+        type: "string",
+    },
+]);
+const openGraphDescriptor = {
+    type: "object",
+    properties: {
+        type: {
+            kind: "enum",
+            valueType: "string",
+            values: ["website", "article", "profile"],
+            optional: true,
+            nullable: false,
+        },
+        url: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        siteName: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        title: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        description: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        images: {
+            type: "array",
+            items: imageOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        locale: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        alternateLocale: {
+            type: "array",
+            items: {
+                kind: "primitive",
+                type: "string",
+            },
+            optional: true,
+            nullable: false,
+        },
+    },
+};
+const twitterDescriptor = {
+    type: "object",
+    properties: {
+        card: {
+            kind: "enum",
+            valueType: "string",
+            values: ["summary", "summary_large_image", "app", "player"],
+            optional: true,
+            nullable: false,
+        },
+        site: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        creator: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        title: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        description: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        images: {
+            type: "array",
+            items: imageOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+    },
+};
+const seoDescriptor = {
+    type: "object",
+    customType: "Seo",
+    properties: {
+        title: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        description: {
+            ...localizedOrStringDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        keywords: {
+            ...keywordsDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        canonical: {
+            kind: "primitive",
+            type: "string",
+            optional: true,
+            nullable: false,
+        },
+        robots: {
+            ...robotsDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        alternates: {
+            ...alternatesDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        openGraph: {
+            ...openGraphDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        twitter: {
+            ...twitterDescriptor,
+            optional: true,
+            nullable: false,
+        },
+        jsonLd: {
+            type: "array",
+            items: {
+                kind: "primitive",
+                type: "json",
+            },
+            optional: true,
+            nullable: false,
+        },
+    },
+};
 exports.customModelDescriptors = {
     File: fileDescriptor,
     Image: imageDescriptor,
@@ -63,6 +295,7 @@ exports.customInlineDescriptors = {
     RichText: richTextDescriptor,
     LocalizedString: localizedStringDescriptor,
     LocalizedRichText: localizedRichTextDescriptor,
+    Seo: seoDescriptor,
 };
 exports.customInlineTypeMetadata = {
     RichText: {},
@@ -72,6 +305,7 @@ exports.customInlineTypeMetadata = {
     LocalizedRichText: {
         includeId: { mapLikeFields: ["locales"] },
     },
+    Seo: {},
 };
 exports.customTypeDescriptors = {
     ...exports.customModelDescriptors,
@@ -90,13 +324,20 @@ function resolveCustomTypeDependencies(names) {
         const name = queue.shift();
         if (!name || resolved.has(name))
             continue;
-        const descriptor = exports.customModelDescriptors[name];
+        const modelDescriptor = exports.customModelDescriptors[name];
+        const inlineDescriptor = exports.customInlineDescriptors[name];
+        const descriptor = modelDescriptor ?? inlineDescriptor;
         if (!descriptor)
             continue;
         resolved.add(name);
         const refs = new Set();
-        for (const prop of Object.values(descriptor.properties)) {
-            collectModelRefs(prop, refs);
+        if (modelDescriptor) {
+            for (const prop of Object.values(modelDescriptor.properties)) {
+                collectModelRefs(prop, refs);
+            }
+        }
+        else {
+            collectModelRefs(inlineDescriptor, refs);
         }
         refs.forEach((ref) => {
             if (exports.customTypeDescriptors[ref] && !resolved.has(ref)) {
@@ -111,11 +352,15 @@ function collectModelRefs(desc, out) {
         out.add(desc.model);
         return;
     }
-    if (desc.type === "array") {
+    if ("type" in desc && desc.type === "array") {
         collectModelRefs(desc.items, out);
         return;
     }
-    if (desc.type === "object") {
+    if ("type" in desc && desc.type === "object") {
         Object.values(desc.properties).forEach((child) => collectModelRefs(child, out));
+        return;
+    }
+    if (desc.kind === "union") {
+        desc.anyOf.forEach((branch) => collectModelRefs(branch, out));
     }
 }