prismic-ts-codegen 0.1.11 → 0.1.13

package/dist/lib/addTrailingNewLine.d.ts

@@ -0,0 +1,5 @@
+type AddTrailingNewLineConfig = {
+    force?: boolean;
+};
+export declare function addTrailingNewLine(state: string, config?: AddTrailingNewLineConfig): string;
+export {};

package/dist/lib/addTrailingNewLine.js

@@ -0,0 +1,11 @@
+function addTrailingNewLine(state, config) {
+  if ((!state || state.endsWith("\n")) && !(config == null ? void 0 : config.force)) {
+    return state;
+  } else {
+    return state + "\n";
+  }
+}
+export {
+  addTrailingNewLine
+};
+//# sourceMappingURL=addTrailingNewLine.js.map

package/dist/lib/addTrailingNewLine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addTrailingNewLine.js","sources":["../../../src/lib/addTrailingNewLine.ts"],"sourcesContent":["type AddTrailingNewLineConfig = {\n\tforce?: boolean;\n};\n\nexport function addTrailingNewLine(\n\tstate: string,\n\tconfig?: AddTrailingNewLineConfig,\n) {\n\tif ((!state || state.endsWith(\"\\n\")) && !config?.force) {\n\t\treturn state;\n\t} else {\n\t\treturn state + \"\\n\";\n\t}\n}\n"],"names":[],"mappings":"AAIgB,SAAA,mBACf,OACA,QAAiC;AAE5B,OAAA,CAAC,SAAS,MAAM,SAAS,IAAI,MAAM,EAAC,iCAAQ,QAAO;AAChD,WAAA;AAAA,EAAA,OACD;AACN,WAAO,QAAQ;AAAA,EACf;AACF;"}

package/dist/lib/buildCustomTypeDataType.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const commonTags = require("common-tags");
+const buildTypeName = require("./buildTypeName.cjs");
+const buildFieldProperties = require("./buildFieldProperties.cjs");
+const getHumanReadableModelName = require("./getHumanReadableModelName.cjs");
+function buildCustomTypeDataType(args) {
+  let code = "";
+  const auxiliaryTypes = [];
+  const name = buildTypeName.buildTypeName(args.model.id, "Document", "Data");
+  const humanReadableName = getHumanReadableModelName.getHumanReadableModelName({
+    name: args.model.id,
+    model: args.model
+  });
+  let fieldProperties = "";
+  for (const tabName in args.model.json) {
+    const { uid: _uid, ...fields } = args.model.json[tabName];
+    const tabFieldProperties = buildFieldProperties.buildFieldProperties({
+      fields,
+      fieldConfigs: args.fieldConfigs,
+      path: [
+        {
+          name: args.model.id,
+          model: args.model
+        }
+      ],
+      tabName
+    });
+    fieldProperties += tabFieldProperties.code;
+    auxiliaryTypes.push(...tabFieldProperties.auxiliaryTypes);
+  }
+  if (fieldProperties) {
+    code = commonTags.source`
+			/**
+			 * Content for ${humanReadableName} documents
+			 */
+			interface ${name} {
+				${fieldProperties}
+			}
+		`;
+  } else {
+    code = `interface ${name} {}`;
+  }
+  return {
+    name,
+    code,
+    auxiliaryTypes
+  };
+}
+exports.buildCustomTypeDataType = buildCustomTypeDataType;
+//# sourceMappingURL=buildCustomTypeDataType.cjs.map

package/dist/lib/buildCustomTypeDataType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildCustomTypeDataType.cjs","sources":["../../../src/lib/buildCustomTypeDataType.ts"],"sourcesContent":["import { CustomTypeModel } from \"@prismicio/client\";\nimport { source } from \"common-tags\";\n\nimport { buildTypeName } from \"../lib/buildTypeName\";\n\nimport { AuxiliaryType, FieldConfigs } from \"../types\";\n\nimport { buildFieldProperties } from \"./buildFieldProperties\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\n\ntype BuildCustomTypeDataTypeArgs = {\n\tmodel: CustomTypeModel;\n\tfieldConfigs: FieldConfigs;\n};\n\ntype BuildCustomTypeDataTypeReturnValue = {\n\tname: string;\n\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n};\n\nexport function buildCustomTypeDataType(\n\targs: BuildCustomTypeDataTypeArgs,\n): BuildCustomTypeDataTypeReturnValue {\n\tlet code = \"\";\n\tconst auxiliaryTypes: AuxiliaryType[] = [];\n\n\tconst name = buildTypeName(args.model.id, \"Document\", \"Data\");\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tname: args.model.id,\n\t\tmodel: args.model,\n\t});\n\n\tlet fieldProperties = \"\";\n\n\tfor (const tabName in args.model.json) {\n\t\tconst { uid: _uid, ...fields } = args.model.json[tabName];\n\n\t\tconst tabFieldProperties = buildFieldProperties({\n\t\t\tfields,\n\t\t\tfieldConfigs: args.fieldConfigs,\n\t\t\tpath: [\n\t\t\t\t{\n\t\t\t\t\tname: args.model.id,\n\t\t\t\t\tmodel: args.model,\n\t\t\t\t},\n\t\t\t],\n\t\t\ttabName,\n\t\t});\n\n\t\tfieldProperties += tabFieldProperties.code;\n\n\t\tauxiliaryTypes.push(...tabFieldProperties.auxiliaryTypes);\n\t}\n\n\tif (fieldProperties) {\n\t\tcode = source`\n\t\t\t/**\n\t\t\t * Content for ${humanReadableName} documents\n\t\t\t */\n\t\t\tinterface ${name} {\n\t\t\t\t${fieldProperties}\n\t\t\t}\n\t\t`;\n\t} else {\n\t\tcode = `interface ${name} {}`;\n\t}\n\n\treturn {\n\t\tname,\n\t\tcode,\n\t\tauxiliaryTypes,\n\t};\n}\n"],"names":["buildTypeName","getHumanReadableModelName","buildFieldProperties","source"],"mappings":";;;;;;AAqBM,SAAU,wBACf,MAAiC;AAEjC,MAAI,OAAO;AACX,QAAM,iBAAkC,CAAA;AAExC,QAAM,OAAOA,cAAAA,cAAc,KAAK,MAAM,IAAI,YAAY,MAAM;AAC5D,QAAM,oBAAoBC,0BAAAA,0BAA0B;AAAA,IACnD,MAAM,KAAK,MAAM;AAAA,IACjB,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,MAAI,kBAAkB;AAEX,aAAA,WAAW,KAAK,MAAM,MAAM;AAChC,UAAA,EAAE,KAAK,MAAM,GAAG,WAAW,KAAK,MAAM,KAAK,OAAO;AAExD,UAAM,qBAAqBC,qBAAAA,qBAAqB;AAAA,MAC/C;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,MAAM;AAAA,QACL;AAAA,UACC,MAAM,KAAK,MAAM;AAAA,UACjB,OAAO,KAAK;AAAA,QACZ;AAAA,MACD;AAAA,MACD;AAAA,IAAA,CACA;AAED,uBAAmB,mBAAmB;AAEvB,mBAAA,KAAK,GAAG,mBAAmB,cAAc;AAAA,EACxD;AAED,MAAI,iBAAiB;AACb,WAAAC,WAAAA;AAAAA;AAAAA,oBAEW;AAAA;AAAA,eAEL;AAAA,MACT;AAAA;AAAA;AAAA,EAAA,OAGE;AACN,WAAO,aAAa;AAAA,EACpB;AAEM,SAAA;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAEF;;"}

package/dist/lib/buildCustomTypeDataType.d.ts

@@ -0,0 +1,13 @@
+import { CustomTypeModel } from "@prismicio/client";
+import { AuxiliaryType, FieldConfigs } from "../types";
+type BuildCustomTypeDataTypeArgs = {
+    model: CustomTypeModel;
+    fieldConfigs: FieldConfigs;
+};
+type BuildCustomTypeDataTypeReturnValue = {
+    name: string;
+    code: string;
+    auxiliaryTypes: AuxiliaryType[];
+};
+export declare function buildCustomTypeDataType(args: BuildCustomTypeDataTypeArgs): BuildCustomTypeDataTypeReturnValue;
+export {};

package/dist/lib/buildCustomTypeDataType.js

@@ -0,0 +1,51 @@
+import { source } from "common-tags";
+import { buildTypeName } from "./buildTypeName.js";
+import { buildFieldProperties } from "./buildFieldProperties.js";
+import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
+function buildCustomTypeDataType(args) {
+  let code = "";
+  const auxiliaryTypes = [];
+  const name = buildTypeName(args.model.id, "Document", "Data");
+  const humanReadableName = getHumanReadableModelName({
+    name: args.model.id,
+    model: args.model
+  });
+  let fieldProperties = "";
+  for (const tabName in args.model.json) {
+    const { uid: _uid, ...fields } = args.model.json[tabName];
+    const tabFieldProperties = buildFieldProperties({
+      fields,
+      fieldConfigs: args.fieldConfigs,
+      path: [
+        {
+          name: args.model.id,
+          model: args.model
+        }
+      ],
+      tabName
+    });
+    fieldProperties += tabFieldProperties.code;
+    auxiliaryTypes.push(...tabFieldProperties.auxiliaryTypes);
+  }
+  if (fieldProperties) {
+    code = source`
+			/**
+			 * Content for ${humanReadableName} documents
+			 */
+			interface ${name} {
+				${fieldProperties}
+			}
+		`;
+  } else {
+    code = `interface ${name} {}`;
+  }
+  return {
+    name,
+    code,
+    auxiliaryTypes
+  };
+}
+export {
+  buildCustomTypeDataType
+};
+//# sourceMappingURL=buildCustomTypeDataType.js.map

package/dist/lib/buildCustomTypeDataType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildCustomTypeDataType.js","sources":["../../../src/lib/buildCustomTypeDataType.ts"],"sourcesContent":["import { CustomTypeModel } from \"@prismicio/client\";\nimport { source } from \"common-tags\";\n\nimport { buildTypeName } from \"../lib/buildTypeName\";\n\nimport { AuxiliaryType, FieldConfigs } from \"../types\";\n\nimport { buildFieldProperties } from \"./buildFieldProperties\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\n\ntype BuildCustomTypeDataTypeArgs = {\n\tmodel: CustomTypeModel;\n\tfieldConfigs: FieldConfigs;\n};\n\ntype BuildCustomTypeDataTypeReturnValue = {\n\tname: string;\n\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n};\n\nexport function buildCustomTypeDataType(\n\targs: BuildCustomTypeDataTypeArgs,\n): BuildCustomTypeDataTypeReturnValue {\n\tlet code = \"\";\n\tconst auxiliaryTypes: AuxiliaryType[] = [];\n\n\tconst name = buildTypeName(args.model.id, \"Document\", \"Data\");\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tname: args.model.id,\n\t\tmodel: args.model,\n\t});\n\n\tlet fieldProperties = \"\";\n\n\tfor (const tabName in args.model.json) {\n\t\tconst { uid: _uid, ...fields } = args.model.json[tabName];\n\n\t\tconst tabFieldProperties = buildFieldProperties({\n\t\t\tfields,\n\t\t\tfieldConfigs: args.fieldConfigs,\n\t\t\tpath: [\n\t\t\t\t{\n\t\t\t\t\tname: args.model.id,\n\t\t\t\t\tmodel: args.model,\n\t\t\t\t},\n\t\t\t],\n\t\t\ttabName,\n\t\t});\n\n\t\tfieldProperties += tabFieldProperties.code;\n\n\t\tauxiliaryTypes.push(...tabFieldProperties.auxiliaryTypes);\n\t}\n\n\tif (fieldProperties) {\n\t\tcode = source`\n\t\t\t/**\n\t\t\t * Content for ${humanReadableName} documents\n\t\t\t */\n\t\t\tinterface ${name} {\n\t\t\t\t${fieldProperties}\n\t\t\t}\n\t\t`;\n\t} else {\n\t\tcode = `interface ${name} {}`;\n\t}\n\n\treturn {\n\t\tname,\n\t\tcode,\n\t\tauxiliaryTypes,\n\t};\n}\n"],"names":[],"mappings":";;;;AAqBM,SAAU,wBACf,MAAiC;AAEjC,MAAI,OAAO;AACX,QAAM,iBAAkC,CAAA;AAExC,QAAM,OAAO,cAAc,KAAK,MAAM,IAAI,YAAY,MAAM;AAC5D,QAAM,oBAAoB,0BAA0B;AAAA,IACnD,MAAM,KAAK,MAAM;AAAA,IACjB,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,MAAI,kBAAkB;AAEX,aAAA,WAAW,KAAK,MAAM,MAAM;AAChC,UAAA,EAAE,KAAK,MAAM,GAAG,WAAW,KAAK,MAAM,KAAK,OAAO;AAExD,UAAM,qBAAqB,qBAAqB;AAAA,MAC/C;AAAA,MACA,cAAc,KAAK;AAAA,MACnB,MAAM;AAAA,QACL;AAAA,UACC,MAAM,KAAK,MAAM;AAAA,UACjB,OAAO,KAAK;AAAA,QACZ;AAAA,MACD;AAAA,MACD;AAAA,IAAA,CACA;AAED,uBAAmB,mBAAmB;AAEvB,mBAAA,KAAK,GAAG,mBAAmB,cAAc;AAAA,EACxD;AAED,MAAI,iBAAiB;AACb,WAAA;AAAA;AAAA,oBAEW;AAAA;AAAA,eAEL;AAAA,MACT;AAAA;AAAA;AAAA,EAAA,OAGE;AACN,WAAO,aAAa;AAAA,EACpB;AAEM,SAAA;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAEF;"}

package/dist/lib/buildCustomTypeType.cjs

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const commonTags = require("common-tags");
+const constants = require("../constants.cjs");
+const addSection = require("./addSection.cjs");
+const buildCustomTypeDataType = require("./buildCustomTypeDataType.cjs");
+const buildTypeName = require("./buildTypeName.cjs");
+const buildUnion = require("./buildUnion.cjs");
+const checkHasUIDFIeld = require("./checkHasUIDFIeld.cjs");
+const getCacheKey = require("./getCacheKey.cjs");
+const getHumanReadableModelName = require("./getHumanReadableModelName.cjs");
+function buildCustomTypeType(args) {
+  if (args.cache) {
+    const key = getCacheKey.getCacheKey(args.model);
+    const cached = args.cache.get(key);
+    if (cached) {
+      return cached;
+    }
+  }
+  let code = "";
+  const auxiliaryTypes = [];
+  const name = buildTypeName.buildTypeName(args.model.id, "Document");
+  const langDefault = args.localeIDs && args.localeIDs.length > 0 ? buildUnion.buildUnion(args.localeIDs.map((localeID) => `"${localeID}"`)) : "string";
+  const baseDocumentType = checkHasUIDFIeld.checkHasUIDField(args.model) ? "PrismicDocumentWithUID" : "PrismicDocumentWithoutUID";
+  const humanReadableName = getHumanReadableModelName.getHumanReadableModelName({
+    name: args.model.id,
+    model: args.model
+  });
+  const dataType = buildCustomTypeDataType.buildCustomTypeDataType({
+    model: args.model,
+    fieldConfigs: args.fieldConfigs
+  });
+  auxiliaryTypes.push(...dataType.auxiliaryTypes);
+  code = addSection.addSection(dataType.code, code);
+  code = addSection.addSection(commonTags.source`
+			/**
+			 * ${humanReadableName} document from Prismic
+			 *
+			 * - **API ID**: \`${args.model.id}\`
+			 * - **Repeatable**: \`${args.model.repeatable.toString()}\`
+			 * - **Documentation**: ${constants.CUSTOM_TYPES_DOCUMENTATION_URL}
+			 *
+			 * @typeParam Lang - Language API ID of the document.
+			 */
+			export type ${name}<Lang extends string = ${langDefault}> = prismic.${baseDocumentType}<Simplify<${dataType.name}>, "${args.model.id}", Lang>;
+		`, code);
+  const result = {
+    name,
+    dataName: dataType.name,
+    code,
+    auxiliaryTypes
+  };
+  if (args.cache) {
+    const key = getCacheKey.getCacheKey(args.model);
+    args.cache.set(key, result);
+  }
+  return result;
+}
+exports.buildCustomTypeType = buildCustomTypeType;
+//# sourceMappingURL=buildCustomTypeType.cjs.map

package/dist/lib/buildCustomTypeType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildCustomTypeType.cjs","sources":["../../../src/lib/buildCustomTypeType.ts"],"sourcesContent":["import { CustomTypeModel } from \"@prismicio/client\";\nimport { source } from \"common-tags\";\nimport QuickLRU from \"quick-lru\";\n\nimport { AuxiliaryType, FieldConfigs } from \"../types\";\n\nimport { CUSTOM_TYPES_DOCUMENTATION_URL } from \"../constants\";\n\nimport { addSection } from \"./addSection\";\nimport { buildCustomTypeDataType } from \"./buildCustomTypeDataType\";\nimport { buildTypeName } from \"./buildTypeName\";\nimport { buildUnion } from \"./buildUnion\";\nimport { checkHasUIDField } from \"./checkHasUIDFIeld\";\nimport { getCacheKey } from \"./getCacheKey\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\n\ntype BuildCustomTypeTypesArgs = {\n\tmodel: CustomTypeModel;\n\tlocaleIDs?: string[];\n\tfieldConfigs: FieldConfigs;\n\tcache?: QuickLRU<string, unknown>;\n};\n\ntype BuildCustomTypeTypeReturnValue = {\n\tname: string;\n\tdataName: string;\n\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n};\n\nexport function buildCustomTypeType(\n\targs: BuildCustomTypeTypesArgs,\n): BuildCustomTypeTypeReturnValue {\n\tif (args.cache) {\n\t\tconst key = getCacheKey(args.model);\n\t\tconst cached = args.cache.get(key);\n\n\t\tif (cached) {\n\t\t\treturn cached as BuildCustomTypeTypeReturnValue;\n\t\t}\n\t}\n\n\tlet code = \"\";\n\n\tconst auxiliaryTypes: AuxiliaryType[] = [];\n\n\tconst name = buildTypeName(args.model.id, \"Document\");\n\tconst langDefault =\n\t\targs.localeIDs && args.localeIDs.length > 0\n\t\t\t? buildUnion(args.localeIDs.map((localeID) => `\"${localeID}\"`))\n\t\t\t: \"string\";\n\tconst baseDocumentType = checkHasUIDField(args.model)\n\t\t? \"PrismicDocumentWithUID\"\n\t\t: \"PrismicDocumentWithoutUID\";\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tname: args.model.id,\n\t\tmodel: args.model,\n\t});\n\n\tconst dataType = buildCustomTypeDataType({\n\t\tmodel: args.model,\n\t\tfieldConfigs: args.fieldConfigs,\n\t});\n\n\tauxiliaryTypes.push(...dataType.auxiliaryTypes);\n\n\tcode = addSection(dataType.code, code);\n\n\tcode = addSection(\n\t\tsource`\n\t\t\t/**\n\t\t\t * ${humanReadableName} document from Prismic\n\t\t\t *\n\t\t\t * - **API ID**: \\`${args.model.id}\\`\n\t\t\t * - **Repeatable**: \\`${args.model.repeatable.toString()}\\`\n\t\t\t * - **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}\n\t\t\t *\n\t\t\t * @typeParam Lang - Language API ID of the document.\n\t\t\t */\n\t\t\texport type ${name}<Lang extends string = ${langDefault}> = prismic.${baseDocumentType}<Simplify<${\n\t\t\tdataType.name\n\t\t}>, \"${args.model.id}\", Lang>;\n\t\t`,\n\t\tcode,\n\t);\n\n\tconst result = {\n\t\tname,\n\t\tdataName: dataType.name,\n\t\tcode,\n\t\tauxiliaryTypes,\n\t};\n\n\tif (args.cache) {\n\t\tconst key = getCacheKey(args.model);\n\n\t\targs.cache.set(key, result);\n\t}\n\n\treturn result;\n}\n"],"names":["getCacheKey","buildTypeName","buildUnion","checkHasUIDField","getHumanReadableModelName","buildCustomTypeDataType","addSection","source","CUSTOM_TYPES_DOCUMENTATION_URL"],"mappings":";;;;;;;;;;;AA8BM,SAAU,oBACf,MAA8B;AAE9B,MAAI,KAAK,OAAO;AACT,UAAA,MAAMA,YAAAA,YAAY,KAAK,KAAK;AAClC,UAAM,SAAS,KAAK,MAAM,IAAI,GAAG;AAEjC,QAAI,QAAQ;AACJ,aAAA;AAAA,IACP;AAAA,EACD;AAED,MAAI,OAAO;AAEX,QAAM,iBAAkC,CAAA;AAExC,QAAM,OAAOC,cAAAA,cAAc,KAAK,MAAM,IAAI,UAAU;AACpD,QAAM,cACL,KAAK,aAAa,KAAK,UAAU,SAAS,IACvCC,sBAAW,KAAK,UAAU,IAAI,CAAC,aAAa,IAAI,WAAW,CAAC,IAC5D;AACJ,QAAM,mBAAmBC,iBAAAA,iBAAiB,KAAK,KAAK,IACjD,2BACA;AACH,QAAM,oBAAoBC,0BAAAA,0BAA0B;AAAA,IACnD,MAAM,KAAK,MAAM;AAAA,IACjB,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,QAAM,WAAWC,wBAAAA,wBAAwB;AAAA,IACxC,OAAO,KAAK;AAAA,IACZ,cAAc,KAAK;AAAA,EAAA,CACnB;AAEc,iBAAA,KAAK,GAAG,SAAS,cAAc;AAEvC,SAAAC,WAAAA,WAAW,SAAS,MAAM,IAAI;AAErC,SAAOA,WACN,WAAAC;;QAEM;AAAA;AAAA,wBAEgB,KAAK,MAAM;AAAA,4BACP,KAAK,MAAM,WAAW,SAAU;AAAA,6BAC/BC;;;;iBAIZ,8BAA8B,0BAA0B,6BACtE,SAAS,WACH,KAAK,MAAM;AAAA,KAElB,IAAI;AAGL,QAAM,SAAS;AAAA,IACd;AAAA,IACA,UAAU,SAAS;AAAA,IACnB;AAAA,IACA;AAAA,EAAA;AAGD,MAAI,KAAK,OAAO;AACT,UAAA,MAAMR,YAAAA,YAAY,KAAK,KAAK;AAE7B,SAAA,MAAM,IAAI,KAAK,MAAM;AAAA,EAC1B;AAEM,SAAA;AACR;;"}

package/dist/lib/buildCustomTypeType.d.ts

@@ -0,0 +1,17 @@
+import { CustomTypeModel } from "@prismicio/client";
+import QuickLRU from "quick-lru";
+import { AuxiliaryType, FieldConfigs } from "../types";
+type BuildCustomTypeTypesArgs = {
+    model: CustomTypeModel;
+    localeIDs?: string[];
+    fieldConfigs: FieldConfigs;
+    cache?: QuickLRU<string, unknown>;
+};
+type BuildCustomTypeTypeReturnValue = {
+    name: string;
+    dataName: string;
+    code: string;
+    auxiliaryTypes: AuxiliaryType[];
+};
+export declare function buildCustomTypeType(args: BuildCustomTypeTypesArgs): BuildCustomTypeTypeReturnValue;
+export {};

package/dist/lib/buildCustomTypeType.js

@@ -0,0 +1,60 @@
+import { source } from "common-tags";
+import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants.js";
+import { addSection } from "./addSection.js";
+import { buildCustomTypeDataType } from "./buildCustomTypeDataType.js";
+import { buildTypeName } from "./buildTypeName.js";
+import { buildUnion } from "./buildUnion.js";
+import { checkHasUIDField } from "./checkHasUIDFIeld.js";
+import { getCacheKey } from "./getCacheKey.js";
+import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
+function buildCustomTypeType(args) {
+  if (args.cache) {
+    const key = getCacheKey(args.model);
+    const cached = args.cache.get(key);
+    if (cached) {
+      return cached;
+    }
+  }
+  let code = "";
+  const auxiliaryTypes = [];
+  const name = buildTypeName(args.model.id, "Document");
+  const langDefault = args.localeIDs && args.localeIDs.length > 0 ? buildUnion(args.localeIDs.map((localeID) => `"${localeID}"`)) : "string";
+  const baseDocumentType = checkHasUIDField(args.model) ? "PrismicDocumentWithUID" : "PrismicDocumentWithoutUID";
+  const humanReadableName = getHumanReadableModelName({
+    name: args.model.id,
+    model: args.model
+  });
+  const dataType = buildCustomTypeDataType({
+    model: args.model,
+    fieldConfigs: args.fieldConfigs
+  });
+  auxiliaryTypes.push(...dataType.auxiliaryTypes);
+  code = addSection(dataType.code, code);
+  code = addSection(source`
+			/**
+			 * ${humanReadableName} document from Prismic
+			 *
+			 * - **API ID**: \`${args.model.id}\`
+			 * - **Repeatable**: \`${args.model.repeatable.toString()}\`
+			 * - **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}
+			 *
+			 * @typeParam Lang - Language API ID of the document.
+			 */
+			export type ${name}<Lang extends string = ${langDefault}> = prismic.${baseDocumentType}<Simplify<${dataType.name}>, "${args.model.id}", Lang>;
+		`, code);
+  const result = {
+    name,
+    dataName: dataType.name,
+    code,
+    auxiliaryTypes
+  };
+  if (args.cache) {
+    const key = getCacheKey(args.model);
+    args.cache.set(key, result);
+  }
+  return result;
+}
+export {
+  buildCustomTypeType
+};
+//# sourceMappingURL=buildCustomTypeType.js.map

package/dist/lib/buildCustomTypeType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildCustomTypeType.js","sources":["../../../src/lib/buildCustomTypeType.ts"],"sourcesContent":["import { CustomTypeModel } from \"@prismicio/client\";\nimport { source } from \"common-tags\";\nimport QuickLRU from \"quick-lru\";\n\nimport { AuxiliaryType, FieldConfigs } from \"../types\";\n\nimport { CUSTOM_TYPES_DOCUMENTATION_URL } from \"../constants\";\n\nimport { addSection } from \"./addSection\";\nimport { buildCustomTypeDataType } from \"./buildCustomTypeDataType\";\nimport { buildTypeName } from \"./buildTypeName\";\nimport { buildUnion } from \"./buildUnion\";\nimport { checkHasUIDField } from \"./checkHasUIDFIeld\";\nimport { getCacheKey } from \"./getCacheKey\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\n\ntype BuildCustomTypeTypesArgs = {\n\tmodel: CustomTypeModel;\n\tlocaleIDs?: string[];\n\tfieldConfigs: FieldConfigs;\n\tcache?: QuickLRU<string, unknown>;\n};\n\ntype BuildCustomTypeTypeReturnValue = {\n\tname: string;\n\tdataName: string;\n\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n};\n\nexport function buildCustomTypeType(\n\targs: BuildCustomTypeTypesArgs,\n): BuildCustomTypeTypeReturnValue {\n\tif (args.cache) {\n\t\tconst key = getCacheKey(args.model);\n\t\tconst cached = args.cache.get(key);\n\n\t\tif (cached) {\n\t\t\treturn cached as BuildCustomTypeTypeReturnValue;\n\t\t}\n\t}\n\n\tlet code = \"\";\n\n\tconst auxiliaryTypes: AuxiliaryType[] = [];\n\n\tconst name = buildTypeName(args.model.id, \"Document\");\n\tconst langDefault =\n\t\targs.localeIDs && args.localeIDs.length > 0\n\t\t\t? buildUnion(args.localeIDs.map((localeID) => `\"${localeID}\"`))\n\t\t\t: \"string\";\n\tconst baseDocumentType = checkHasUIDField(args.model)\n\t\t? \"PrismicDocumentWithUID\"\n\t\t: \"PrismicDocumentWithoutUID\";\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tname: args.model.id,\n\t\tmodel: args.model,\n\t});\n\n\tconst dataType = buildCustomTypeDataType({\n\t\tmodel: args.model,\n\t\tfieldConfigs: args.fieldConfigs,\n\t});\n\n\tauxiliaryTypes.push(...dataType.auxiliaryTypes);\n\n\tcode = addSection(dataType.code, code);\n\n\tcode = addSection(\n\t\tsource`\n\t\t\t/**\n\t\t\t * ${humanReadableName} document from Prismic\n\t\t\t *\n\t\t\t * - **API ID**: \\`${args.model.id}\\`\n\t\t\t * - **Repeatable**: \\`${args.model.repeatable.toString()}\\`\n\t\t\t * - **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}\n\t\t\t *\n\t\t\t * @typeParam Lang - Language API ID of the document.\n\t\t\t */\n\t\t\texport type ${name}<Lang extends string = ${langDefault}> = prismic.${baseDocumentType}<Simplify<${\n\t\t\tdataType.name\n\t\t}>, \"${args.model.id}\", Lang>;\n\t\t`,\n\t\tcode,\n\t);\n\n\tconst result = {\n\t\tname,\n\t\tdataName: dataType.name,\n\t\tcode,\n\t\tauxiliaryTypes,\n\t};\n\n\tif (args.cache) {\n\t\tconst key = getCacheKey(args.model);\n\n\t\targs.cache.set(key, result);\n\t}\n\n\treturn result;\n}\n"],"names":[],"mappings":";;;;;;;;;AA8BM,SAAU,oBACf,MAA8B;AAE9B,MAAI,KAAK,OAAO;AACT,UAAA,MAAM,YAAY,KAAK,KAAK;AAClC,UAAM,SAAS,KAAK,MAAM,IAAI,GAAG;AAEjC,QAAI,QAAQ;AACJ,aAAA;AAAA,IACP;AAAA,EACD;AAED,MAAI,OAAO;AAEX,QAAM,iBAAkC,CAAA;AAExC,QAAM,OAAO,cAAc,KAAK,MAAM,IAAI,UAAU;AACpD,QAAM,cACL,KAAK,aAAa,KAAK,UAAU,SAAS,IACvC,WAAW,KAAK,UAAU,IAAI,CAAC,aAAa,IAAI,WAAW,CAAC,IAC5D;AACJ,QAAM,mBAAmB,iBAAiB,KAAK,KAAK,IACjD,2BACA;AACH,QAAM,oBAAoB,0BAA0B;AAAA,IACnD,MAAM,KAAK,MAAM;AAAA,IACjB,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,QAAM,WAAW,wBAAwB;AAAA,IACxC,OAAO,KAAK;AAAA,IACZ,cAAc,KAAK;AAAA,EAAA,CACnB;AAEc,iBAAA,KAAK,GAAG,SAAS,cAAc;AAEvC,SAAA,WAAW,SAAS,MAAM,IAAI;AAErC,SAAO,WACN;AAAA;AAAA,QAEM;AAAA;AAAA,wBAEgB,KAAK,MAAM;AAAA,4BACP,KAAK,MAAM,WAAW,SAAU;AAAA,6BAC/B;AAAA;AAAA;AAAA;AAAA,iBAIZ,8BAA8B,0BAA0B,6BACtE,SAAS,WACH,KAAK,MAAM;AAAA,KAElB,IAAI;AAGL,QAAM,SAAS;AAAA,IACd;AAAA,IACA,UAAU,SAAS;AAAA,IACnB;AAAA,IACA;AAAA,EAAA;AAGD,MAAI,KAAK,OAAO;AACT,UAAA,MAAM,YAAY,KAAK,KAAK;AAE7B,SAAA,MAAM,IAAI,KAAK,MAAM;AAAA,EAC1B;AAEM,SAAA;AACR;"}

package/dist/lib/buildFieldDocs.cjs

@@ -1,43 +1,75 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const constants = require("../constants.cjs");
+const addLine = require("./addLine.cjs");
 const getAPIIDPath = require("./getAPIIDPath.cjs");
-const getFieldDocumentationURL = require("./getFieldDocumentationURL.cjs");
-const getHumanReadableFieldPath = require("./getHumanReadableFieldPath.cjs");
-const getHumanReadableFieldType = require("./getHumanReadableFieldType.cjs");
 const getHumanReadableModelName = require("./getHumanReadableModelName.cjs");
-const writeFieldDocsDescription = require("./writeFieldDocsDescription.cjs");
-const buildFieldDocs = (config) => {
-  return [
-    {
-      description: (writer) => {
-        const name = getHumanReadableModelName.getHumanReadableModelName({
-          id: config.id,
-          model: config.model
-        });
-        const humanReadablePath = getHumanReadableFieldPath.getHumanReadableFieldPath({
-          path: config.path
-        });
-        const fieldType = getHumanReadableFieldType.getHumanReadableFieldType({
-          model: config.model
-        });
-        const placeholder = config.model.config && "placeholder" in config.model.config && config.model.config.placeholder ? config.model.config.placeholder : `*None*`;
-        const defaultValue = config.model.config && "default_value" in config.model.config ? config.model.config.default_value : void 0;
-        const apiIDPath = getAPIIDPath.getAPIIDPath({
-          path: [...config.path, { id: config.id, model: config.model }]
-        });
-        writeFieldDocsDescription.writeFieldDocsDescription({
-          writer,
-          description: `${name} field in *${humanReadablePath}*`,
-          fieldType,
-          placeholder,
-          defaultValue,
-          apiIDPath,
-          tabName: config.tabName,
-          documentationURL: getFieldDocumentationURL.getFieldDocumentationURL({ model: config.model })
-        });
+const getHumanReadablePath = require("./getHumanReadablePath.cjs");
+function getHumanReadableFieldType(args) {
+  var _a, _b;
+  switch (args.field.type) {
+    case "StructuredText": {
+      const isTitleField = args.field.config && "single" in args.field.config && args.field.config.single && args.field.config.single.split(",").every((blockType) => /heading/.test(blockType));
+      return isTitleField ? "Title" : "Rich Text";
+    }
+    case "IntegrationFields": {
+      const catalog = (_a = args.field.config) == null ? void 0 : _a.catalog;
+      return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
+    }
+    case "Link": {
+      switch ((_b = args.field.config) == null ? void 0 : _b.select) {
+        case "document": {
+          return "Content Relationship";
+        }
+        case "media": {
+          return "Link to Media";
+        }
+        default: {
+          return "Link";
+        }
       }
     }
-  ];
-};
+    case "Slices": {
+      return "Slice Zone";
+    }
+    default: {
+      return args.field.type;
+    }
+  }
+}
+function buildFieldDocs(args) {
+  let result = "/**";
+  const humanReadableName = getHumanReadableModelName.getHumanReadableModelName({
+    model: args.field,
+    name: args.name
+  });
+  const humanReadablePath = getHumanReadablePath.getHumanReadablePath({ path: args.path });
+  const humanReadableFieldType = getHumanReadableFieldType({
+    field: args.field
+  });
+  result = addLine.addLine(` * ${humanReadableName} field in *${humanReadablePath}*`, result);
+  result = addLine.addLine(" *", result);
+  result = addLine.addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);
+  const placeholder = args.field.config && "placeholder" in args.field.config && args.field.config.placeholder || `*None*`;
+  result = addLine.addLine(` * - **Placeholder**: ${placeholder}`, result);
+  const defaultValue = args.field.config && "default_value" in args.field.config ? args.field.config.default_value : void 0;
+  if (defaultValue !== void 0) {
+    const stringifiedDefaultValue = typeof defaultValue === "boolean" ? `${defaultValue}` : defaultValue;
+    result = addLine.addLine(` * - **Default Value**: ${stringifiedDefaultValue}`, result);
+  }
+  const apiIDPath = getAPIIDPath.getAPIIDPath({
+    path: [...args.path, { name: args.name, model: args.field }]
+  });
+  result = addLine.addLine(` * - **API ID Path**: ${apiIDPath}`, result);
+  if (args.tabName) {
+    result = addLine.addLine(` * - **Tab**: ${args.tabName}`, result);
+  }
+  const documentationURL = constants.FIELD_DOCUMENTATION_URLS[args.field.type];
+  if (documentationURL) {
+    result = addLine.addLine(` * - **Documentation**: ${documentationURL}`, result);
+  }
+  result = addLine.addLine(" */", result);
+  return result;
+}
 exports.buildFieldDocs = buildFieldDocs;
 //# sourceMappingURL=buildFieldDocs.cjs.map

package/dist/lib/buildFieldDocs.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"buildFieldDocs.cjs","sources":["../../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import type {\n\tCustomTypeModel,\n\tCustomTypeModelField,\n\tCustomTypeModelSlice,\n\tSharedSliceModel,\n} from \"@prismicio/client\";\nimport type { JSDocableNodeStructure } from \"ts-morph\";\n\nimport { PathElement } from \"../types\";\n\nimport { getAPIIDPath } from \"./getAPIIDPath\";\nimport { getFieldDocumentationURL } from \"./getFieldDocumentationURL\";\nimport { getHumanReadableFieldPath } from \"./getHumanReadableFieldPath\";\nimport { getHumanReadableFieldType } from \"./getHumanReadableFieldType\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\nimport { writeFieldDocsDescription } from \"./writeFieldDocsDescription\";\n\ntype BuildFieldDocsConfig = {\n\tid: string;\n\tmodel: CustomTypeModelField;\n\tpath: [\n\t\tPathElement<CustomTypeModel | SharedSliceModel>,\n\t\t...PathElement<CustomTypeModelField | CustomTypeModelSlice>[],\n\t];\n\ttabName?: string;\n};\n\nexport const buildFieldDocs = (\n\tconfig: BuildFieldDocsConfig,\n): NonNullable<JSDocableNodeStructure[\"docs\"]> => {\n\treturn [\n\t\t{\n\t\t\tdescription: (writer) => {\n\t\t\t\tconst name = getHumanReadableModelName({\n\t\t\t\t\tid: config.id,\n\t\t\t\t\tmodel: config.model,\n\t\t\t\t});\n\t\t\t\tconst humanReadablePath = getHumanReadableFieldPath({\n\t\t\t\t\tpath: config.path,\n\t\t\t\t});\n\n\t\t\t\tconst fieldType = getHumanReadableFieldType({\n\t\t\t\t\tmodel: config.model,\n\t\t\t\t});\n\n\t\t\t\tconst placeholder =\n\t\t\t\t\tconfig.model.config &&\n\t\t\t\t\t\"placeholder\" in config.model.config &&\n\t\t\t\t\tconfig.model.config.placeholder\n\t\t\t\t\t\t? config.model.config.placeholder\n\t\t\t\t\t\t: `*None*`;\n\n\t\t\t\tconst defaultValue =\n\t\t\t\t\tconfig.model.config && \"default_value\" in config.model.config\n\t\t\t\t\t\t? config.model.config.default_value\n\t\t\t\t\t\t: undefined;\n\n\t\t\t\tconst apiIDPath = getAPIIDPath({\n\t\t\t\t\tpath: [...config.path, { id: config.id, model: config.model }],\n\t\t\t\t});\n\n\t\t\t\twriteFieldDocsDescription({\n\t\t\t\t\twriter,\n\t\t\t\t\tdescription: `${name} field in *${humanReadablePath}*`,\n\t\t\t\t\tfieldType,\n\t\t\t\t\tplaceholder,\n\t\t\t\t\tdefaultValue,\n\t\t\t\t\tapiIDPath,\n\t\t\t\t\ttabName: config.tabName,\n\t\t\t\t\tdocumentationURL: getFieldDocumentationURL({ model: config.model }),\n\t\t\t\t});\n\t\t\t},\n\t\t},\n\t];\n};\n"],"names":["getHumanReadableModelName","getHumanReadableFieldPath","getHumanReadableFieldType","getAPIIDPath","writeFieldDocsDescription","getFieldDocumentationURL"],"mappings":";;;;;;;;AA2Ba,MAAA,iBAAiB,CAC7B,WACgD;AACzC,SAAA;AAAA,IACN;AAAA,MACC,aAAa,CAAC,WAAU;AACvB,cAAM,OAAOA,0BAAAA,0BAA0B;AAAA,UACtC,IAAI,OAAO;AAAA,UACX,OAAO,OAAO;AAAA,QAAA,CACd;AACD,cAAM,oBAAoBC,0BAAAA,0BAA0B;AAAA,UACnD,MAAM,OAAO;AAAA,QAAA,CACb;AAED,cAAM,YAAYC,0BAAAA,0BAA0B;AAAA,UAC3C,OAAO,OAAO;AAAA,QAAA,CACd;AAED,cAAM,cACL,OAAO,MAAM,UACb,iBAAiB,OAAO,MAAM,UAC9B,OAAO,MAAM,OAAO,cACjB,OAAO,MAAM,OAAO,cACpB;AAEE,cAAA,eACL,OAAO,MAAM,UAAU,mBAAmB,OAAO,MAAM,SACpD,OAAO,MAAM,OAAO,gBACpB;AAEJ,cAAM,YAAYC,aAAAA,aAAa;AAAA,UAC9B,MAAM,CAAC,GAAG,OAAO,MAAM,EAAE,IAAI,OAAO,IAAI,OAAO,OAAO,MAAA,CAAO;AAAA,QAAA,CAC7D;AAEyBC,4DAAA;AAAA,UACzB;AAAA,UACA,aAAa,GAAG,kBAAkB;AAAA,UAClC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,SAAS,OAAO;AAAA,UAChB,kBAAkBC,yBAAAA,yBAAyB,EAAE,OAAO,OAAO,OAAO;AAAA,QAAA,CAClE;AAAA,MACF;AAAA,IACA;AAAA,EAAA;AAEH;;"}
+{"version":3,"file":"buildFieldDocs.cjs","sources":["../../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import { CustomTypeModelField } from \"@prismicio/client\";\n\nimport { FieldPath } from \"../types\";\n\nimport { FIELD_DOCUMENTATION_URLS } from \"../constants\";\n\nimport { addLine } from \"./addLine\";\nimport { getAPIIDPath } from \"./getAPIIDPath\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\nimport { getHumanReadablePath } from \"./getHumanReadablePath\";\n\ntype GetFieldHumanReadableTypeArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getHumanReadableFieldType(\n\targs: GetFieldHumanReadableTypeArgs,\n): string {\n\tswitch (args.field.type) {\n\t\tcase \"StructuredText\": {\n\t\t\tconst isTitleField =\n\t\t\t\targs.field.config &&\n\t\t\t\t\"single\" in args.field.config &&\n\t\t\t\targs.field.config.single &&\n\t\t\t\targs.field.config.single\n\t\t\t\t\t.split(\",\")\n\t\t\t\t\t.every((blockType) => /heading/.test(blockType));\n\n\t\t\treturn isTitleField ? \"Title\" : \"Rich Text\";\n\t\t}\n\n\t\tcase \"IntegrationFields\": {\n\t\t\tconst catalog = args.field.config?.catalog;\n\n\t\t\treturn `Integration Fields (Catalog: ${\n\t\t\t\tcatalog ? `\\`${catalog}\\`` : \"*unknown*\"\n\t\t\t})`;\n\t\t}\n\n\t\tcase \"Link\": {\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn \"Content Relationship\";\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn \"Link to Media\";\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn \"Link\";\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tcase \"Slices\": {\n\t\t\treturn \"Slice Zone\";\n\t\t}\n\n\t\tdefault: {\n\t\t\treturn args.field.type;\n\t\t}\n\t}\n}\n\ntype BuildFieldDocsArgs = {\n\tname: string;\n\tfield: CustomTypeModelField;\n\tpath: FieldPath;\n\ttabName?: string;\n};\n\nexport function buildFieldDocs(args: BuildFieldDocsArgs): string {\n\tlet result = \"/**\";\n\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tmodel: args.field,\n\t\tname: args.name,\n\t});\n\tconst humanReadablePath = getHumanReadablePath({ path: args.path });\n\tconst humanReadableFieldType = getHumanReadableFieldType({\n\t\tfield: args.field,\n\t});\n\n\tresult = addLine(\n\t\t` * ${humanReadableName} field in *${humanReadablePath}*`,\n\t\tresult,\n\t);\n\n\tresult = addLine(\" *\", result);\n\n\tresult = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);\n\n\tconst placeholder =\n\t\t(args.field.config &&\n\t\t\t\"placeholder\" in args.field.config &&\n\t\t\targs.field.config.placeholder) ||\n\t\t`*None*`;\n\tresult = addLine(` * - **Placeholder**: ${placeholder}`, result);\n\n\tconst defaultValue =\n\t\targs.field.config && \"default_value\" in args.field.config\n\t\t\t? args.field.config.default_value\n\t\t\t: undefined;\n\tif (defaultValue !== undefined) {\n\t\tconst stringifiedDefaultValue =\n\t\t\ttypeof defaultValue === \"boolean\" ? `${defaultValue}` : defaultValue;\n\n\t\tresult = addLine(\n\t\t\t` * - **Default Value**: ${stringifiedDefaultValue}`,\n\t\t\tresult,\n\t\t);\n\t}\n\n\tconst apiIDPath = getAPIIDPath({\n\t\tpath: [...args.path, { name: args.name, model: args.field }],\n\t});\n\tresult = addLine(` * - **API ID Path**: ${apiIDPath}`, result);\n\n\tif (args.tabName) {\n\t\tresult = addLine(` * - **Tab**: ${args.tabName}`, result);\n\t}\n\n\tconst documentationURL =\n\t\tFIELD_DOCUMENTATION_URLS[\n\t\t\targs.field.type as keyof typeof FIELD_DOCUMENTATION_URLS\n\t\t];\n\tif (documentationURL) {\n\t\tresult = addLine(` * - **Documentation**: ${documentationURL}`, result);\n\t}\n\n\tresult = addLine(\" */\", result);\n\n\treturn result;\n}\n"],"names":["getHumanReadableModelName","getHumanReadablePath","addLine","getAPIIDPath","FIELD_DOCUMENTATION_URLS"],"mappings":";;;;;;;AAeA,SAAS,0BACR,MAAmC;;AAE3B,UAAA,KAAK,MAAM,MAAM;AAAA,IACxB,KAAK,kBAAkB;AAChB,YAAA,eACL,KAAK,MAAM,UACX,YAAY,KAAK,MAAM,UACvB,KAAK,MAAM,OAAO,UAClB,KAAK,MAAM,OAAO,OAChB,MAAM,GAAG,EACT,MAAM,CAAC,cAAc,UAAU,KAAK,SAAS,CAAC;AAEjD,aAAO,eAAe,UAAU;AAAA,IAChC;AAAA,IAED,KAAK,qBAAqB;AACnB,YAAA,WAAU,UAAK,MAAM,WAAX,mBAAmB;AAE5B,aAAA,gCACN,UAAU,KAAK,cAAc;AAAA,IAE9B;AAAA,IAED,KAAK,QAAQ;AACJ,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AACT,iBAAA;AAAA,QACP;AAAA,QAED,KAAK,SAAS;AACN,iBAAA;AAAA,QACP;AAAA,QAED,SAAS;AACD,iBAAA;AAAA,QACP;AAAA,MACD;AAAA,IACD;AAAA,IAED,KAAK,UAAU;AACP,aAAA;AAAA,IACP;AAAA,IAED,SAAS;AACR,aAAO,KAAK,MAAM;AAAA,IAClB;AAAA,EACD;AACF;AASM,SAAU,eAAe,MAAwB;AACtD,MAAI,SAAS;AAEb,QAAM,oBAAoBA,0BAAAA,0BAA0B;AAAA,IACnD,OAAO,KAAK;AAAA,IACZ,MAAM,KAAK;AAAA,EAAA,CACX;AACD,QAAM,oBAAoBC,qBAAAA,qBAAqB,EAAE,MAAM,KAAK,MAAM;AAClE,QAAM,yBAAyB,0BAA0B;AAAA,IACxD,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,WAASC,QAAAA,QACR,MAAM,+BAA+B,sBACrC,MAAM;AAGE,WAAAA,QAAA,QAAQ,MAAM,MAAM;AAEpB,WAAAA,QAAA,QAAQ,wBAAwB,0BAA0B,MAAM;AAEnE,QAAA,cACJ,KAAK,MAAM,UACX,iBAAiB,KAAK,MAAM,UAC5B,KAAK,MAAM,OAAO,eACnB;AACQ,WAAAA,QAAA,QAAQ,yBAAyB,eAAe,MAAM;AAEzD,QAAA,eACL,KAAK,MAAM,UAAU,mBAAmB,KAAK,MAAM,SAChD,KAAK,MAAM,OAAO,gBAClB;AACJ,MAAI,iBAAiB,QAAW;AAC/B,UAAM,0BACL,OAAO,iBAAiB,YAAY,GAAG,iBAAiB;AAEhD,aAAAA,QAAA,QACR,2BAA2B,2BAC3B,MAAM;AAAA,EAEP;AAED,QAAM,YAAYC,aAAAA,aAAa;AAAA,IAC9B,MAAM,CAAC,GAAG,KAAK,MAAM,EAAE,MAAM,KAAK,MAAM,OAAO,KAAK,MAAA,CAAO;AAAA,EAAA,CAC3D;AACQ,WAAAD,QAAA,QAAQ,yBAAyB,aAAa,MAAM;AAE7D,MAAI,KAAK,SAAS;AACjB,aAASA,QAAQ,QAAA,iBAAiB,KAAK,WAAW,MAAM;AAAA,EACxD;AAED,QAAM,mBACLE,UAAA,yBACC,KAAK,MAAM,IAA6C;AAE1D,MAAI,kBAAkB;AACZ,aAAAF,QAAA,QAAQ,2BAA2B,oBAAoB,MAAM;AAAA,EACtE;AAEQ,WAAAA,QAAA,QAAQ,OAAO,MAAM;AAEvB,SAAA;AACR;;"}

package/dist/lib/buildFieldDocs.d.ts

@@ -1,14 +1,10 @@
-import type { CustomTypeModel, CustomTypeModelField, CustomTypeModelSlice, SharedSliceModel } from "@prismicio/client";
-import type { JSDocableNodeStructure } from "ts-morph";
-import { PathElement } from "../types";
-type BuildFieldDocsConfig = {
-    id: string;
-    model: CustomTypeModelField;
-    path: [
-        PathElement<CustomTypeModel | SharedSliceModel>,
-        ...PathElement<CustomTypeModelField | CustomTypeModelSlice>[]
-    ];
+import { CustomTypeModelField } from "@prismicio/client";
+import { FieldPath } from "../types";
+type BuildFieldDocsArgs = {
+    name: string;
+    field: CustomTypeModelField;
+    path: FieldPath;
     tabName?: string;
 };
-export declare const buildFieldDocs: (config: BuildFieldDocsConfig) => NonNullable<JSDocableNodeStructure["docs"]>;
+export declare function buildFieldDocs(args: BuildFieldDocsArgs): string;
 export {};

package/dist/lib/buildFieldDocs.js

@@ -1,42 +1,74 @@
+import { FIELD_DOCUMENTATION_URLS } from "../constants.js";
+import { addLine } from "./addLine.js";
 import { getAPIIDPath } from "./getAPIIDPath.js";
-import { getFieldDocumentationURL } from "./getFieldDocumentationURL.js";
-import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath.js";
-import { getHumanReadableFieldType } from "./getHumanReadableFieldType.js";
 import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
-import { writeFieldDocsDescription } from "./writeFieldDocsDescription.js";
-const buildFieldDocs = (config) => {
-  return [
-    {
-      description: (writer) => {
-        const name = getHumanReadableModelName({
-          id: config.id,
-          model: config.model
-        });
-        const humanReadablePath = getHumanReadableFieldPath({
-          path: config.path
-        });
-        const fieldType = getHumanReadableFieldType({
-          model: config.model
-        });
-        const placeholder = config.model.config && "placeholder" in config.model.config && config.model.config.placeholder ? config.model.config.placeholder : `*None*`;
-        const defaultValue = config.model.config && "default_value" in config.model.config ? config.model.config.default_value : void 0;
-        const apiIDPath = getAPIIDPath({
-          path: [...config.path, { id: config.id, model: config.model }]
-        });
-        writeFieldDocsDescription({
-          writer,
-          description: `${name} field in *${humanReadablePath}*`,
-          fieldType,
-          placeholder,
-          defaultValue,
-          apiIDPath,
-          tabName: config.tabName,
-          documentationURL: getFieldDocumentationURL({ model: config.model })
-        });
+import { getHumanReadablePath } from "./getHumanReadablePath.js";
+function getHumanReadableFieldType(args) {
+  var _a, _b;
+  switch (args.field.type) {
+    case "StructuredText": {
+      const isTitleField = args.field.config && "single" in args.field.config && args.field.config.single && args.field.config.single.split(",").every((blockType) => /heading/.test(blockType));
+      return isTitleField ? "Title" : "Rich Text";
+    }
+    case "IntegrationFields": {
+      const catalog = (_a = args.field.config) == null ? void 0 : _a.catalog;
+      return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
+    }
+    case "Link": {
+      switch ((_b = args.field.config) == null ? void 0 : _b.select) {
+        case "document": {
+          return "Content Relationship";
+        }
+        case "media": {
+          return "Link to Media";
+        }
+        default: {
+          return "Link";
+        }
       }
     }
-  ];
-};
+    case "Slices": {
+      return "Slice Zone";
+    }
+    default: {
+      return args.field.type;
+    }
+  }
+}
+function buildFieldDocs(args) {
+  let result = "/**";
+  const humanReadableName = getHumanReadableModelName({
+    model: args.field,
+    name: args.name
+  });
+  const humanReadablePath = getHumanReadablePath({ path: args.path });
+  const humanReadableFieldType = getHumanReadableFieldType({
+    field: args.field
+  });
+  result = addLine(` * ${humanReadableName} field in *${humanReadablePath}*`, result);
+  result = addLine(" *", result);
+  result = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);
+  const placeholder = args.field.config && "placeholder" in args.field.config && args.field.config.placeholder || `*None*`;
+  result = addLine(` * - **Placeholder**: ${placeholder}`, result);
+  const defaultValue = args.field.config && "default_value" in args.field.config ? args.field.config.default_value : void 0;
+  if (defaultValue !== void 0) {
+    const stringifiedDefaultValue = typeof defaultValue === "boolean" ? `${defaultValue}` : defaultValue;
+    result = addLine(` * - **Default Value**: ${stringifiedDefaultValue}`, result);
+  }
+  const apiIDPath = getAPIIDPath({
+    path: [...args.path, { name: args.name, model: args.field }]
+  });
+  result = addLine(` * - **API ID Path**: ${apiIDPath}`, result);
+  if (args.tabName) {
+    result = addLine(` * - **Tab**: ${args.tabName}`, result);
+  }
+  const documentationURL = FIELD_DOCUMENTATION_URLS[args.field.type];
+  if (documentationURL) {
+    result = addLine(` * - **Documentation**: ${documentationURL}`, result);
+  }
+  result = addLine(" */", result);
+  return result;
+}
 export {
   buildFieldDocs
 };

package/dist/lib/buildFieldDocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildFieldDocs.js","sources":["../../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import type {\n\tCustomTypeModel,\n\tCustomTypeModelField,\n\tCustomTypeModelSlice,\n\tSharedSliceModel,\n} from \"@prismicio/client\";\nimport type { JSDocableNodeStructure } from \"ts-morph\";\n\nimport { PathElement } from \"../types\";\n\nimport { getAPIIDPath } from \"./getAPIIDPath\";\nimport { getFieldDocumentationURL } from \"./getFieldDocumentationURL\";\nimport { getHumanReadableFieldPath } from \"./getHumanReadableFieldPath\";\nimport { getHumanReadableFieldType } from \"./getHumanReadableFieldType\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\nimport { writeFieldDocsDescription } from \"./writeFieldDocsDescription\";\n\ntype BuildFieldDocsConfig = {\n\tid: string;\n\tmodel: CustomTypeModelField;\n\tpath: [\n\t\tPathElement<CustomTypeModel | SharedSliceModel>,\n\t\t...PathElement<CustomTypeModelField | CustomTypeModelSlice>[],\n\t];\n\ttabName?: string;\n};\n\nexport const buildFieldDocs = (\n\tconfig: BuildFieldDocsConfig,\n): NonNullable<JSDocableNodeStructure[\"docs\"]> => {\n\treturn [\n\t\t{\n\t\t\tdescription: (writer) => {\n\t\t\t\tconst name = getHumanReadableModelName({\n\t\t\t\t\tid: config.id,\n\t\t\t\t\tmodel: config.model,\n\t\t\t\t});\n\t\t\t\tconst humanReadablePath = getHumanReadableFieldPath({\n\t\t\t\t\tpath: config.path,\n\t\t\t\t});\n\n\t\t\t\tconst fieldType = getHumanReadableFieldType({\n\t\t\t\t\tmodel: config.model,\n\t\t\t\t});\n\n\t\t\t\tconst placeholder =\n\t\t\t\t\tconfig.model.config &&\n\t\t\t\t\t\"placeholder\" in config.model.config &&\n\t\t\t\t\tconfig.model.config.placeholder\n\t\t\t\t\t\t? config.model.config.placeholder\n\t\t\t\t\t\t: `*None*`;\n\n\t\t\t\tconst defaultValue =\n\t\t\t\t\tconfig.model.config && \"default_value\" in config.model.config\n\t\t\t\t\t\t? config.model.config.default_value\n\t\t\t\t\t\t: undefined;\n\n\t\t\t\tconst apiIDPath = getAPIIDPath({\n\t\t\t\t\tpath: [...config.path, { id: config.id, model: config.model }],\n\t\t\t\t});\n\n\t\t\t\twriteFieldDocsDescription({\n\t\t\t\t\twriter,\n\t\t\t\t\tdescription: `${name} field in *${humanReadablePath}*`,\n\t\t\t\t\tfieldType,\n\t\t\t\t\tplaceholder,\n\t\t\t\t\tdefaultValue,\n\t\t\t\t\tapiIDPath,\n\t\t\t\t\ttabName: config.tabName,\n\t\t\t\t\tdocumentationURL: getFieldDocumentationURL({ model: config.model }),\n\t\t\t\t});\n\t\t\t},\n\t\t},\n\t];\n};\n"],"names":[],"mappings":";;;;;;AA2Ba,MAAA,iBAAiB,CAC7B,WACgD;AACzC,SAAA;AAAA,IACN;AAAA,MACC,aAAa,CAAC,WAAU;AACvB,cAAM,OAAO,0BAA0B;AAAA,UACtC,IAAI,OAAO;AAAA,UACX,OAAO,OAAO;AAAA,QAAA,CACd;AACD,cAAM,oBAAoB,0BAA0B;AAAA,UACnD,MAAM,OAAO;AAAA,QAAA,CACb;AAED,cAAM,YAAY,0BAA0B;AAAA,UAC3C,OAAO,OAAO;AAAA,QAAA,CACd;AAED,cAAM,cACL,OAAO,MAAM,UACb,iBAAiB,OAAO,MAAM,UAC9B,OAAO,MAAM,OAAO,cACjB,OAAO,MAAM,OAAO,cACpB;AAEE,cAAA,eACL,OAAO,MAAM,UAAU,mBAAmB,OAAO,MAAM,SACpD,OAAO,MAAM,OAAO,gBACpB;AAEJ,cAAM,YAAY,aAAa;AAAA,UAC9B,MAAM,CAAC,GAAG,OAAO,MAAM,EAAE,IAAI,OAAO,IAAI,OAAO,OAAO,MAAA,CAAO;AAAA,QAAA,CAC7D;AAEyB,kCAAA;AAAA,UACzB;AAAA,UACA,aAAa,GAAG,kBAAkB;AAAA,UAClC;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,SAAS,OAAO;AAAA,UAChB,kBAAkB,yBAAyB,EAAE,OAAO,OAAO,OAAO;AAAA,QAAA,CAClE;AAAA,MACF;AAAA,IACA;AAAA,EAAA;AAEH;"}
+{"version":3,"file":"buildFieldDocs.js","sources":["../../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import { CustomTypeModelField } from \"@prismicio/client\";\n\nimport { FieldPath } from \"../types\";\n\nimport { FIELD_DOCUMENTATION_URLS } from \"../constants\";\n\nimport { addLine } from \"./addLine\";\nimport { getAPIIDPath } from \"./getAPIIDPath\";\nimport { getHumanReadableModelName } from \"./getHumanReadableModelName\";\nimport { getHumanReadablePath } from \"./getHumanReadablePath\";\n\ntype GetFieldHumanReadableTypeArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getHumanReadableFieldType(\n\targs: GetFieldHumanReadableTypeArgs,\n): string {\n\tswitch (args.field.type) {\n\t\tcase \"StructuredText\": {\n\t\t\tconst isTitleField =\n\t\t\t\targs.field.config &&\n\t\t\t\t\"single\" in args.field.config &&\n\t\t\t\targs.field.config.single &&\n\t\t\t\targs.field.config.single\n\t\t\t\t\t.split(\",\")\n\t\t\t\t\t.every((blockType) => /heading/.test(blockType));\n\n\t\t\treturn isTitleField ? \"Title\" : \"Rich Text\";\n\t\t}\n\n\t\tcase \"IntegrationFields\": {\n\t\t\tconst catalog = args.field.config?.catalog;\n\n\t\t\treturn `Integration Fields (Catalog: ${\n\t\t\t\tcatalog ? `\\`${catalog}\\`` : \"*unknown*\"\n\t\t\t})`;\n\t\t}\n\n\t\tcase \"Link\": {\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn \"Content Relationship\";\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn \"Link to Media\";\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn \"Link\";\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tcase \"Slices\": {\n\t\t\treturn \"Slice Zone\";\n\t\t}\n\n\t\tdefault: {\n\t\t\treturn args.field.type;\n\t\t}\n\t}\n}\n\ntype BuildFieldDocsArgs = {\n\tname: string;\n\tfield: CustomTypeModelField;\n\tpath: FieldPath;\n\ttabName?: string;\n};\n\nexport function buildFieldDocs(args: BuildFieldDocsArgs): string {\n\tlet result = \"/**\";\n\n\tconst humanReadableName = getHumanReadableModelName({\n\t\tmodel: args.field,\n\t\tname: args.name,\n\t});\n\tconst humanReadablePath = getHumanReadablePath({ path: args.path });\n\tconst humanReadableFieldType = getHumanReadableFieldType({\n\t\tfield: args.field,\n\t});\n\n\tresult = addLine(\n\t\t` * ${humanReadableName} field in *${humanReadablePath}*`,\n\t\tresult,\n\t);\n\n\tresult = addLine(\" *\", result);\n\n\tresult = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);\n\n\tconst placeholder =\n\t\t(args.field.config &&\n\t\t\t\"placeholder\" in args.field.config &&\n\t\t\targs.field.config.placeholder) ||\n\t\t`*None*`;\n\tresult = addLine(` * - **Placeholder**: ${placeholder}`, result);\n\n\tconst defaultValue =\n\t\targs.field.config && \"default_value\" in args.field.config\n\t\t\t? args.field.config.default_value\n\t\t\t: undefined;\n\tif (defaultValue !== undefined) {\n\t\tconst stringifiedDefaultValue =\n\t\t\ttypeof defaultValue === \"boolean\" ? `${defaultValue}` : defaultValue;\n\n\t\tresult = addLine(\n\t\t\t` * - **Default Value**: ${stringifiedDefaultValue}`,\n\t\t\tresult,\n\t\t);\n\t}\n\n\tconst apiIDPath = getAPIIDPath({\n\t\tpath: [...args.path, { name: args.name, model: args.field }],\n\t});\n\tresult = addLine(` * - **API ID Path**: ${apiIDPath}`, result);\n\n\tif (args.tabName) {\n\t\tresult = addLine(` * - **Tab**: ${args.tabName}`, result);\n\t}\n\n\tconst documentationURL =\n\t\tFIELD_DOCUMENTATION_URLS[\n\t\t\targs.field.type as keyof typeof FIELD_DOCUMENTATION_URLS\n\t\t];\n\tif (documentationURL) {\n\t\tresult = addLine(` * - **Documentation**: ${documentationURL}`, result);\n\t}\n\n\tresult = addLine(\" */\", result);\n\n\treturn result;\n}\n"],"names":[],"mappings":";;;;;AAeA,SAAS,0BACR,MAAmC;;AAE3B,UAAA,KAAK,MAAM,MAAM;AAAA,IACxB,KAAK,kBAAkB;AAChB,YAAA,eACL,KAAK,MAAM,UACX,YAAY,KAAK,MAAM,UACvB,KAAK,MAAM,OAAO,UAClB,KAAK,MAAM,OAAO,OAChB,MAAM,GAAG,EACT,MAAM,CAAC,cAAc,UAAU,KAAK,SAAS,CAAC;AAEjD,aAAO,eAAe,UAAU;AAAA,IAChC;AAAA,IAED,KAAK,qBAAqB;AACnB,YAAA,WAAU,UAAK,MAAM,WAAX,mBAAmB;AAE5B,aAAA,gCACN,UAAU,KAAK,cAAc;AAAA,IAE9B;AAAA,IAED,KAAK,QAAQ;AACJ,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AACT,iBAAA;AAAA,QACP;AAAA,QAED,KAAK,SAAS;AACN,iBAAA;AAAA,QACP;AAAA,QAED,SAAS;AACD,iBAAA;AAAA,QACP;AAAA,MACD;AAAA,IACD;AAAA,IAED,KAAK,UAAU;AACP,aAAA;AAAA,IACP;AAAA,IAED,SAAS;AACR,aAAO,KAAK,MAAM;AAAA,IAClB;AAAA,EACD;AACF;AASM,SAAU,eAAe,MAAwB;AACtD,MAAI,SAAS;AAEb,QAAM,oBAAoB,0BAA0B;AAAA,IACnD,OAAO,KAAK;AAAA,IACZ,MAAM,KAAK;AAAA,EAAA,CACX;AACD,QAAM,oBAAoB,qBAAqB,EAAE,MAAM,KAAK,MAAM;AAClE,QAAM,yBAAyB,0BAA0B;AAAA,IACxD,OAAO,KAAK;AAAA,EAAA,CACZ;AAED,WAAS,QACR,MAAM,+BAA+B,sBACrC,MAAM;AAGE,WAAA,QAAQ,MAAM,MAAM;AAEpB,WAAA,QAAQ,wBAAwB,0BAA0B,MAAM;AAEnE,QAAA,cACJ,KAAK,MAAM,UACX,iBAAiB,KAAK,MAAM,UAC5B,KAAK,MAAM,OAAO,eACnB;AACQ,WAAA,QAAQ,yBAAyB,eAAe,MAAM;AAEzD,QAAA,eACL,KAAK,MAAM,UAAU,mBAAmB,KAAK,MAAM,SAChD,KAAK,MAAM,OAAO,gBAClB;AACJ,MAAI,iBAAiB,QAAW;AAC/B,UAAM,0BACL,OAAO,iBAAiB,YAAY,GAAG,iBAAiB;AAEhD,aAAA,QACR,2BAA2B,2BAC3B,MAAM;AAAA,EAEP;AAED,QAAM,YAAY,aAAa;AAAA,IAC9B,MAAM,CAAC,GAAG,KAAK,MAAM,EAAE,MAAM,KAAK,MAAM,OAAO,KAAK,MAAA,CAAO;AAAA,EAAA,CAC3D;AACQ,WAAA,QAAQ,yBAAyB,aAAa,MAAM;AAE7D,MAAI,KAAK,SAAS;AACjB,aAAS,QAAQ,iBAAiB,KAAK,WAAW,MAAM;AAAA,EACxD;AAED,QAAM,mBACL,yBACC,KAAK,MAAM,IAA6C;AAE1D,MAAI,kBAAkB;AACZ,aAAA,QAAQ,2BAA2B,oBAAoB,MAAM;AAAA,EACtE;AAEQ,WAAA,QAAQ,OAAO,MAAM;AAEvB,SAAA;AACR;"}