prismic-ts-codegen 0.1.28 → 0.1.29

package/dist/lib/buildCustomTypeType.js

@@ -1,39 +1,38 @@
-import { source } from "common-tags";
-import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants.js";
 import { addSection } from "./addSection.js";
-import { buildCustomTypeDataType } from "./buildCustomTypeDataType.js";
+import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants.js";
 import { buildTypeName } from "./buildTypeName.js";
+import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
 import { buildUnion } from "./buildUnion.js";
+import { buildCustomTypeDataType } from "./buildCustomTypeDataType.js";
 import { checkHasUIDField } from "./checkHasUIDFIeld.js";
 import { getCacheKey } from "./getCacheKey.js";
-import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
+import { source } from "common-tags";
+//#region src/lib/buildCustomTypeType.ts
 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 contentTypeNames = [];
-  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);
-  contentTypeNames.push(dataType.name);
-  contentTypeNames.push(...dataType.contentTypeNames);
-  code = addSection(dataType.code, code);
-  code = addSection(source`
+	if (args.cache) {
+		const key = getCacheKey(args.model);
+		const cached = args.cache.get(key);
+		if (cached) return cached;
+	}
+	let code = "";
+	const auxiliaryTypes = [];
+	const contentTypeNames = [];
+	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);
+	contentTypeNames.push(dataType.name);
+	contentTypeNames.push(...dataType.contentTypeNames);
+	code = addSection(dataType.code, code);
+	code = addSection(source`
 			/**
 			 * ${humanReadableName} document from Prismic
 			 *
@@ -45,19 +44,19 @@ function buildCustomTypeType(args) {
 			 */
 			export type ${name}<Lang extends string = ${langDefault}> = prismic.${baseDocumentType}<Simplify<${dataType.name}>, "${args.model.id}", Lang>;
 		`, code);
-  const result = {
-    name,
-    code,
-    auxiliaryTypes,
-    contentTypeNames
-  };
-  if (args.cache) {
-    const key = getCacheKey(args.model);
-    args.cache.set(key, result);
-  }
-  return result;
+	const result = {
+		name,
+		code,
+		auxiliaryTypes,
+		contentTypeNames
+	};
+	if (args.cache) {
+		const key = getCacheKey(args.model);
+		args.cache.set(key, result);
+	}
+	return result;
 }
-export {
-  buildCustomTypeType
-};
-//# sourceMappingURL=buildCustomTypeType.js.map
+//#endregion
+export { buildCustomTypeType };
+
+//# sourceMappingURL=buildCustomTypeType.js.map

package/dist/lib/buildCustomTypeType.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildCustomTypeType.js","sources":["../../../src/lib/buildCustomTypeType.ts"],"sourcesContent":["import type { 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\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n\tcontentTypeNames: string[];\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\tconst contentTypeNames: string[] = [];\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\tcontentTypeNames.push(dataType.name);\n\tcontentTypeNames.push(...dataType.contentTypeNames);\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\tcode,\n\t\tauxiliaryTypes,\n\t\tcontentTypeNames,\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,IACR;AAAA,EACD;AAEA,MAAI,OAAO;AAEX,QAAM,iBAAkC,CAAA;AACxC,QAAM,mBAA6B,CAAA;AAEnC,QAAM,OAAO,cAAc,KAAK,MAAM,IAAI,UAAU;AACpD,QAAM,cACL,KAAK,aAAa,KAAK,UAAU,SAAS,IACvC,WAAW,KAAK,UAAU,IAAI,CAAC,aAAa,IAAI,QAAQ,GAAG,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;AAC7B,mBAAA,KAAK,SAAS,IAAI;AAClB,mBAAA,KAAK,GAAG,SAAS,gBAAgB;AAE3C,SAAA,WAAW,SAAS,MAAM,IAAI;AAErC,SAAO,WACN;AAAA;AAAA,QAEM,iBAAiB;AAAA;AAAA,wBAED,KAAK,MAAM,EAAE;AAAA,4BACT,KAAK,MAAM,WAAW,SAAA,CAAU;AAAA,6BAC/B,8BAA8B;AAAA;AAAA;AAAA;AAAA,iBAI1C,IAAI,0BAA0B,WAAW,eAAe,gBAAgB,aACtF,SAAS,IACV,OAAO,KAAK,MAAM,EAAE;AAAA,KAEpB,IAAI;AAGL,QAAM,SAAS;AAAA,IACd;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAGD,MAAI,KAAK,OAAO;AACT,UAAA,MAAM,YAAY,KAAK,KAAK;AAE7B,SAAA,MAAM,IAAI,KAAK,MAAM;AAAA,EAC3B;AAEO,SAAA;AACR;"}
+{"version":3,"file":"buildCustomTypeType.js","names":[],"sources":["../../src/lib/buildCustomTypeType.ts"],"sourcesContent":["import type { CustomTypeModel } from \"@prismicio/client\";\nimport { source } from \"common-tags\";\nimport type QuickLRU from \"quick-lru\";\n\nimport { CUSTOM_TYPES_DOCUMENTATION_URL } from \"../constants\";\nimport type { AuxiliaryType, FieldConfigs } from \"../types\";\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\tcode: string;\n\tauxiliaryTypes: AuxiliaryType[];\n\tcontentTypeNames: string[];\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\tconst contentTypeNames: string[] = [];\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\tcontentTypeNames.push(dataType.name);\n\tcontentTypeNames.push(...dataType.contentTypeNames);\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\tcode,\n\t\tauxiliaryTypes,\n\t\tcontentTypeNames,\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"],"mappings":";;;;;;;;;;AA4BA,SAAgB,oBACf,MACiC;AACjC,KAAI,KAAK,OAAO;EACf,MAAM,MAAM,YAAY,KAAK,MAAM;EACnC,MAAM,SAAS,KAAK,MAAM,IAAI,IAAI;AAElC,MAAI,OACH,QAAO;;CAIT,IAAI,OAAO;CAEX,MAAM,iBAAkC,EAAE;CAC1C,MAAM,mBAA6B,EAAE;CAErC,MAAM,OAAO,cAAc,KAAK,MAAM,IAAI,WAAW;CACrD,MAAM,cACL,KAAK,aAAa,KAAK,UAAU,SAAS,IACvC,WAAW,KAAK,UAAU,KAAK,aAAa,IAAI,SAAS,GAAG,CAAC,GAC7D;CACJ,MAAM,mBAAmB,iBAAiB,KAAK,MAAM,GAClD,2BACA;CACH,MAAM,oBAAoB,0BAA0B;EACnD,MAAM,KAAK,MAAM;EACjB,OAAO,KAAK;EACZ,CAAC;CAEF,MAAM,WAAW,wBAAwB;EACxC,OAAO,KAAK;EACZ,cAAc,KAAK;EACnB,CAAC;AAEF,gBAAe,KAAK,GAAG,SAAS,eAAe;AAC/C,kBAAiB,KAAK,SAAS,KAAK;AACpC,kBAAiB,KAAK,GAAG,SAAS,iBAAiB;AAEnD,QAAO,WAAW,SAAS,MAAM,KAAK;AAEtC,QAAO,WACN,MAAM;;QAEA,kBAAkB;;wBAEF,KAAK,MAAM,GAAG;4BACV,KAAK,MAAM,WAAW,UAAU,CAAC;6BAChC,+BAA+B;;;;iBAI3C,KAAK,yBAAyB,YAAY,cAAc,iBAAiB,YACvF,SAAS,KACT,MAAM,KAAK,MAAM,GAAG;KAErB,KACA;CAED,MAAM,SAAS;EACd;EACA;EACA;EACA;EACA;AAED,KAAI,KAAK,OAAO;EACf,MAAM,MAAM,YAAY,KAAK,MAAM;AAEnC,OAAK,MAAM,IAAI,KAAK,OAAO;;AAG5B,QAAO"}

package/dist/lib/buildFieldDocs.cjs

@@ -1,99 +1,66 @@
-"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 getHumanReadableModelName = require("./getHumanReadableModelName.cjs");
-const getHumanReadablePath = require("./getHumanReadablePath.cjs");
+const require_addLine = require("./addLine.cjs");
+const require_constants = require("../constants.cjs");
+const require_getAPIIDPath = require("./getAPIIDPath.cjs");
+const require_getHumanReadableModelName = require("./getHumanReadableModelName.cjs");
+const require_getHumanReadablePath = require("./getHumanReadablePath.cjs");
+//#region src/lib/buildFieldDocs.ts
 function getHumanReadableFieldType(args) {
-  var _a, _b;
-  switch (args.field.type) {
-    case "StructuredText": {
-      return "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;
-    }
-  }
+	switch (args.field.type) {
+		case "StructuredText": return "Rich Text";
+		case "IntegrationFields": {
+			const catalog = args.field.config?.catalog;
+			return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
+		}
+		case "Link": switch (args.field.config?.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 getDocumentationURL(args) {
-  var _a;
-  switch (args.field.type) {
-    case "Link": {
-      const urls = constants.FIELD_DOCUMENTATION_URLS.Link;
-      switch ((_a = args.field.config) == null ? void 0 : _a.select) {
-        case "document": {
-          return urls.contentRelationship;
-        }
-        case "media": {
-          return urls.linkToMedia;
-        }
-        default: {
-          return urls.link;
-        }
-      }
-    }
-    default: {
-      const url = constants.FIELD_DOCUMENTATION_URLS[args.field.type];
-      if (typeof url === "string") {
-        return url;
-      }
-    }
-  }
+	switch (args.field.type) {
+		case "Link": {
+			const urls = require_constants.FIELD_DOCUMENTATION_URLS.Link;
+			switch (args.field.config?.select) {
+				case "document": return urls.contentRelationship;
+				case "media": return urls.linkToMedia;
+				default: return urls.link;
+			}
+		}
+		default: {
+			const url = require_constants.FIELD_DOCUMENTATION_URLS[args.field.type];
+			if (typeof url === "string") return url;
+		}
+	}
 }
 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 = getDocumentationURL({ field: args.field });
-  if (documentationURL) {
-    result = addLine.addLine(` * - **Documentation**: ${documentationURL}`, result);
-  }
-  result = addLine.addLine(" */", result);
-  return result;
+	let result = "/**";
+	const humanReadableName = require_getHumanReadableModelName.getHumanReadableModelName({
+		model: args.field,
+		name: args.name
+	});
+	const humanReadablePath = require_getHumanReadablePath.getHumanReadablePath({ path: args.path });
+	const humanReadableFieldType = getHumanReadableFieldType({ field: args.field });
+	result = require_addLine.addLine(` * ${humanReadableName} field in *${humanReadablePath}*`, result);
+	result = require_addLine.addLine(" *", result);
+	result = require_addLine.addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);
+	result = require_addLine.addLine(` * - **Placeholder**: ${args.field.config && "placeholder" in args.field.config && args.field.config.placeholder || `*None*`}`, result);
+	const defaultValue = args.field.config && "default_value" in args.field.config ? args.field.config.default_value : void 0;
+	if (defaultValue !== void 0) result = require_addLine.addLine(` * - **Default Value**: ${typeof defaultValue === "boolean" ? `${defaultValue}` : defaultValue}`, result);
+	result = require_addLine.addLine(` * - **API ID Path**: ${require_getAPIIDPath.getAPIIDPath({ path: [...args.path, {
+		name: args.name,
+		model: args.field
+	}] })}`, result);
+	if (args.tabName) result = require_addLine.addLine(` * - **Tab**: ${args.tabName}`, result);
+	const documentationURL = getDocumentationURL({ field: args.field });
+	if (documentationURL) result = require_addLine.addLine(` * - **Documentation**: ${documentationURL}`, result);
+	result = require_addLine.addLine(" */", result);
+	return result;
 }
+//#endregion
 exports.buildFieldDocs = buildFieldDocs;
-//# sourceMappingURL=buildFieldDocs.cjs.map
+
+//# 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 { 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\treturn \"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 getDocumentationURLArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getDocumentationURL(args: getDocumentationURLArgs) {\n\tswitch (args.field.type) {\n\t\tcase \"Link\": {\n\t\t\tconst urls = FIELD_DOCUMENTATION_URLS.Link;\n\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn urls.contentRelationship;\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn urls.linkToMedia;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn urls.link;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tdefault: {\n\t\t\tconst url =\n\t\t\t\tFIELD_DOCUMENTATION_URLS[\n\t\t\t\t\targs.field.type as keyof typeof FIELD_DOCUMENTATION_URLS\n\t\t\t\t];\n\n\t\t\tif (typeof url === \"string\") {\n\t\t\t\treturn url;\n\t\t\t}\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 = getDocumentationURL({ field: args.field });\n\tif (documentationURL) {\n\t\tresult = addLine(` * - **Documentation**: ${documentationURL}`, result);\n\t}\n\n\tresult = addLine(\" */\", result);\n\n\treturn result;\n}\n"],"names":["FIELD_DOCUMENTATION_URLS","getHumanReadableModelName","getHumanReadablePath","addLine","getAPIIDPath"],"mappings":";;;;;;;AAeA,SAAS,0BACR,MAAmC;;AAE3B,UAAA,KAAK,MAAM,MAAM;AAAA,IACxB,KAAK,kBAAkB;AACf,aAAA;AAAA,IACR;AAAA,IAEA,KAAK,qBAAqB;AACnB,YAAA,WAAU,UAAK,MAAM,WAAX,mBAAmB;AAEnC,aAAO,gCACN,UAAU,KAAK,OAAO,OAAO,WAC9B;AAAA,IACD;AAAA,IAEA,KAAK,QAAQ;AACJ,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AACT,iBAAA;AAAA,QACR;AAAA,QAEA,KAAK,SAAS;AACN,iBAAA;AAAA,QACR;AAAA,QAEA,SAAS;AACD,iBAAA;AAAA,QACR;AAAA,MACD;AAAA,IACD;AAAA,IAEA,KAAK,UAAU;AACP,aAAA;AAAA,IACR;AAAA,IAEA,SAAS;AACR,aAAO,KAAK,MAAM;AAAA,IACnB;AAAA,EACD;AACD;AAMA,SAAS,oBAAoB,MAA6B;;AACjD,UAAA,KAAK,MAAM,MAAM;AAAA,IACxB,KAAK,QAAQ;AACZ,YAAM,OAAOA,UAAyB,yBAAA;AAE9B,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AAChB,iBAAO,KAAK;AAAA,QACb;AAAA,QAEA,KAAK,SAAS;AACb,iBAAO,KAAK;AAAA,QACb;AAAA,QAEA,SAAS;AACR,iBAAO,KAAK;AAAA,QACb;AAAA,MACD;AAAA,IACD;AAAA,IAEA,SAAS;AACR,YAAM,MACLA,UAAA,yBACC,KAAK,MAAM,IAA6C;AAGtD,UAAA,OAAO,QAAQ,UAAU;AACrB,eAAA;AAAA,MACR;AAAA,IACD;AAAA,EACD;AACD;AASM,SAAU,eAAe,MAAwB;AACtD,MAAI,SAAS;AAEb,QAAM,oBAAoBC,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,iBAAiB,cAAc,iBAAiB,KACtD,MAAM;AAGE,WAAAA,QAAA,QAAQ,MAAM,MAAM;AAE7B,WAASA,QAAQ,QAAA,wBAAwB,sBAAsB,IAAI,MAAM;AAEnE,QAAA,cACJ,KAAK,MAAM,UACX,iBAAiB,KAAK,MAAM,UAC5B,KAAK,MAAM,OAAO,eACnB;AACD,WAASA,QAAQ,QAAA,yBAAyB,WAAW,IAAI,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,YAAY,KAAK;AAEzD,aAASA,QACR,QAAA,2BAA2B,uBAAuB,IAClD,MAAM;AAAA,EAER;AAEA,QAAM,YAAYC,aAAAA,aAAa;AAAA,IAC9B,MAAM,CAAC,GAAG,KAAK,MAAM,EAAE,MAAM,KAAK,MAAM,OAAO,KAAK,MAAA,CAAO;AAAA,EAAA,CAC3D;AACD,WAASD,QAAQ,QAAA,yBAAyB,SAAS,IAAI,MAAM;AAE7D,MAAI,KAAK,SAAS;AACjB,aAASA,QAAQ,QAAA,iBAAiB,KAAK,OAAO,IAAI,MAAM;AAAA,EACzD;AAEA,QAAM,mBAAmB,oBAAoB,EAAE,OAAO,KAAK,OAAO;AAClE,MAAI,kBAAkB;AACrB,aAASA,QAAQ,QAAA,2BAA2B,gBAAgB,IAAI,MAAM;AAAA,EACvE;AAES,WAAAA,QAAA,QAAQ,OAAO,MAAM;AAEvB,SAAA;AACR;;"}
+{"version":3,"file":"buildFieldDocs.cjs","names":["FIELD_DOCUMENTATION_URLS","getHumanReadableModelName","getHumanReadablePath","addLine","getAPIIDPath"],"sources":["../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import type { CustomTypeModelField } from \"@prismicio/client\";\n\nimport { FIELD_DOCUMENTATION_URLS } from \"../constants\";\nimport type { FieldPath } from \"../types\";\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(args: GetFieldHumanReadableTypeArgs): string {\n\tswitch (args.field.type) {\n\t\tcase \"StructuredText\": {\n\t\t\treturn \"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: ${catalog ? `\\`${catalog}\\`` : \"*unknown*\"})`;\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 getDocumentationURLArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getDocumentationURL(args: getDocumentationURLArgs) {\n\tswitch (args.field.type) {\n\t\tcase \"Link\": {\n\t\t\tconst urls = FIELD_DOCUMENTATION_URLS.Link;\n\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn urls.contentRelationship;\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn urls.linkToMedia;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn urls.link;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tdefault: {\n\t\t\tconst url =\n\t\t\t\tFIELD_DOCUMENTATION_URLS[args.field.type as keyof typeof FIELD_DOCUMENTATION_URLS];\n\n\t\t\tif (typeof url === \"string\") {\n\t\t\t\treturn url;\n\t\t\t}\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(` * ${humanReadableName} field in *${humanReadablePath}*`, result);\n\n\tresult = addLine(\" *\", result);\n\n\tresult = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);\n\n\tconst placeholder =\n\t\t(args.field.config && \"placeholder\" in args.field.config && args.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(` * - **Default Value**: ${stringifiedDefaultValue}`, result);\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 = getDocumentationURL({ field: args.field });\n\tif (documentationURL) {\n\t\tresult = addLine(` * - **Documentation**: ${documentationURL}`, result);\n\t}\n\n\tresult = addLine(\" */\", result);\n\n\treturn result;\n}\n"],"mappings":";;;;;;AAaA,SAAS,0BAA0B,MAA6C;AAC/E,SAAQ,KAAK,MAAM,MAAnB;EACC,KAAK,iBACJ,QAAO;EAGR,KAAK,qBAAqB;GACzB,MAAM,UAAU,KAAK,MAAM,QAAQ;AAEnC,UAAO,gCAAgC,UAAU,KAAK,QAAQ,MAAM,YAAY;;EAGjF,KAAK,OACJ,SAAQ,KAAK,MAAM,QAAQ,QAA3B;GACC,KAAK,WACJ,QAAO;GAGR,KAAK,QACJ,QAAO;GAGR,QACC,QAAO;;EAKV,KAAK,SACJ,QAAO;EAGR,QACC,QAAO,KAAK,MAAM;;;AASrB,SAAS,oBAAoB,MAA+B;AAC3D,SAAQ,KAAK,MAAM,MAAnB;EACC,KAAK,QAAQ;GACZ,MAAM,OAAOA,kBAAAA,yBAAyB;AAEtC,WAAQ,KAAK,MAAM,QAAQ,QAA3B;IACC,KAAK,WACJ,QAAO,KAAK;IAGb,KAAK,QACJ,QAAO,KAAK;IAGb,QACC,QAAO,KAAK;;;EAKf,SAAS;GACR,MAAM,MACLA,kBAAAA,yBAAyB,KAAK,MAAM;AAErC,OAAI,OAAO,QAAQ,SAClB,QAAO;;;;AAaX,SAAgB,eAAe,MAAkC;CAChE,IAAI,SAAS;CAEb,MAAM,oBAAoBC,kCAAAA,0BAA0B;EACnD,OAAO,KAAK;EACZ,MAAM,KAAK;EACX,CAAC;CACF,MAAM,oBAAoBC,6BAAAA,qBAAqB,EAAE,MAAM,KAAK,MAAM,CAAC;CACnE,MAAM,yBAAyB,0BAA0B,EACxD,OAAO,KAAK,OACZ,CAAC;AAEF,UAASC,gBAAAA,QAAQ,MAAM,kBAAkB,aAAa,kBAAkB,IAAI,OAAO;AAEnF,UAASA,gBAAAA,QAAQ,MAAM,OAAO;AAE9B,UAASA,gBAAAA,QAAQ,wBAAwB,0BAA0B,OAAO;AAK1E,UAASA,gBAAAA,QAAQ,yBAFf,KAAK,MAAM,UAAU,iBAAiB,KAAK,MAAM,UAAU,KAAK,MAAM,OAAO,eAC9E,YACwD,OAAO;CAEhE,MAAM,eACL,KAAK,MAAM,UAAU,mBAAmB,KAAK,MAAM,SAChD,KAAK,MAAM,OAAO,gBAClB,KAAA;AACJ,KAAI,iBAAiB,KAAA,EAIpB,UAASA,gBAAAA,QAAQ,2BAFhB,OAAO,iBAAiB,YAAY,GAAG,iBAAiB,gBAEc,OAAO;AAM/E,UAASA,gBAAAA,QAAQ,yBAHCC,qBAAAA,aAAa,EAC9B,MAAM,CAAC,GAAG,KAAK,MAAM;EAAE,MAAM,KAAK;EAAM,OAAO,KAAK;EAAO,CAAC,EAC5D,CAAC,IACqD,OAAO;AAE9D,KAAI,KAAK,QACR,UAASD,gBAAAA,QAAQ,iBAAiB,KAAK,WAAW,OAAO;CAG1D,MAAM,mBAAmB,oBAAoB,EAAE,OAAO,KAAK,OAAO,CAAC;AACnE,KAAI,iBACH,UAASA,gBAAAA,QAAQ,2BAA2B,oBAAoB,OAAO;AAGxE,UAASA,gBAAAA,QAAQ,OAAO,OAAO;AAE/B,QAAO"}

package/dist/lib/buildFieldDocs.js

@@ -1,99 +1,66 @@
-import { FIELD_DOCUMENTATION_URLS } from "../constants.js";
 import { addLine } from "./addLine.js";
+import { FIELD_DOCUMENTATION_URLS } from "../constants.js";
 import { getAPIIDPath } from "./getAPIIDPath.js";
 import { getHumanReadableModelName } from "./getHumanReadableModelName.js";
 import { getHumanReadablePath } from "./getHumanReadablePath.js";
+//#region src/lib/buildFieldDocs.ts
 function getHumanReadableFieldType(args) {
-  var _a, _b;
-  switch (args.field.type) {
-    case "StructuredText": {
-      return "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;
-    }
-  }
+	switch (args.field.type) {
+		case "StructuredText": return "Rich Text";
+		case "IntegrationFields": {
+			const catalog = args.field.config?.catalog;
+			return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
+		}
+		case "Link": switch (args.field.config?.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 getDocumentationURL(args) {
-  var _a;
-  switch (args.field.type) {
-    case "Link": {
-      const urls = FIELD_DOCUMENTATION_URLS.Link;
-      switch ((_a = args.field.config) == null ? void 0 : _a.select) {
-        case "document": {
-          return urls.contentRelationship;
-        }
-        case "media": {
-          return urls.linkToMedia;
-        }
-        default: {
-          return urls.link;
-        }
-      }
-    }
-    default: {
-      const url = FIELD_DOCUMENTATION_URLS[args.field.type];
-      if (typeof url === "string") {
-        return url;
-      }
-    }
-  }
+	switch (args.field.type) {
+		case "Link": {
+			const urls = FIELD_DOCUMENTATION_URLS.Link;
+			switch (args.field.config?.select) {
+				case "document": return urls.contentRelationship;
+				case "media": return urls.linkToMedia;
+				default: return urls.link;
+			}
+		}
+		default: {
+			const url = FIELD_DOCUMENTATION_URLS[args.field.type];
+			if (typeof url === "string") return url;
+		}
+	}
 }
 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 = getDocumentationURL({ field: args.field });
-  if (documentationURL) {
-    result = addLine(` * - **Documentation**: ${documentationURL}`, result);
-  }
-  result = addLine(" */", result);
-  return result;
+	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);
+	result = addLine(` * - **Placeholder**: ${args.field.config && "placeholder" in args.field.config && args.field.config.placeholder || `*None*`}`, result);
+	const defaultValue = args.field.config && "default_value" in args.field.config ? args.field.config.default_value : void 0;
+	if (defaultValue !== void 0) result = addLine(` * - **Default Value**: ${typeof defaultValue === "boolean" ? `${defaultValue}` : defaultValue}`, result);
+	result = addLine(` * - **API ID Path**: ${getAPIIDPath({ path: [...args.path, {
+		name: args.name,
+		model: args.field
+	}] })}`, result);
+	if (args.tabName) result = addLine(` * - **Tab**: ${args.tabName}`, result);
+	const documentationURL = getDocumentationURL({ field: args.field });
+	if (documentationURL) result = addLine(` * - **Documentation**: ${documentationURL}`, result);
+	result = addLine(" */", result);
+	return result;
 }
-export {
-  buildFieldDocs
-};
-//# sourceMappingURL=buildFieldDocs.js.map
+//#endregion
+export { buildFieldDocs };
+
+//# sourceMappingURL=buildFieldDocs.js.map

package/dist/lib/buildFieldDocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildFieldDocs.js","sources":["../../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import type { 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\treturn \"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 getDocumentationURLArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getDocumentationURL(args: getDocumentationURLArgs) {\n\tswitch (args.field.type) {\n\t\tcase \"Link\": {\n\t\t\tconst urls = FIELD_DOCUMENTATION_URLS.Link;\n\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn urls.contentRelationship;\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn urls.linkToMedia;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn urls.link;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tdefault: {\n\t\t\tconst url =\n\t\t\t\tFIELD_DOCUMENTATION_URLS[\n\t\t\t\t\targs.field.type as keyof typeof FIELD_DOCUMENTATION_URLS\n\t\t\t\t];\n\n\t\t\tif (typeof url === \"string\") {\n\t\t\t\treturn url;\n\t\t\t}\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 = getDocumentationURL({ field: args.field });\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;AACf,aAAA;AAAA,IACR;AAAA,IAEA,KAAK,qBAAqB;AACnB,YAAA,WAAU,UAAK,MAAM,WAAX,mBAAmB;AAEnC,aAAO,gCACN,UAAU,KAAK,OAAO,OAAO,WAC9B;AAAA,IACD;AAAA,IAEA,KAAK,QAAQ;AACJ,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AACT,iBAAA;AAAA,QACR;AAAA,QAEA,KAAK,SAAS;AACN,iBAAA;AAAA,QACR;AAAA,QAEA,SAAS;AACD,iBAAA;AAAA,QACR;AAAA,MACD;AAAA,IACD;AAAA,IAEA,KAAK,UAAU;AACP,aAAA;AAAA,IACR;AAAA,IAEA,SAAS;AACR,aAAO,KAAK,MAAM;AAAA,IACnB;AAAA,EACD;AACD;AAMA,SAAS,oBAAoB,MAA6B;;AACjD,UAAA,KAAK,MAAM,MAAM;AAAA,IACxB,KAAK,QAAQ;AACZ,YAAM,OAAO,yBAAyB;AAE9B,eAAA,UAAK,MAAM,WAAX,mBAAmB,QAAQ;AAAA,QAClC,KAAK,YAAY;AAChB,iBAAO,KAAK;AAAA,QACb;AAAA,QAEA,KAAK,SAAS;AACb,iBAAO,KAAK;AAAA,QACb;AAAA,QAEA,SAAS;AACR,iBAAO,KAAK;AAAA,QACb;AAAA,MACD;AAAA,IACD;AAAA,IAEA,SAAS;AACR,YAAM,MACL,yBACC,KAAK,MAAM,IAA6C;AAGtD,UAAA,OAAO,QAAQ,UAAU;AACrB,eAAA;AAAA,MACR;AAAA,IACD;AAAA,EACD;AACD;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,iBAAiB,cAAc,iBAAiB,KACtD,MAAM;AAGE,WAAA,QAAQ,MAAM,MAAM;AAE7B,WAAS,QAAQ,wBAAwB,sBAAsB,IAAI,MAAM;AAEnE,QAAA,cACJ,KAAK,MAAM,UACX,iBAAiB,KAAK,MAAM,UAC5B,KAAK,MAAM,OAAO,eACnB;AACD,WAAS,QAAQ,yBAAyB,WAAW,IAAI,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,YAAY,KAAK;AAEzD,aAAS,QACR,2BAA2B,uBAAuB,IAClD,MAAM;AAAA,EAER;AAEA,QAAM,YAAY,aAAa;AAAA,IAC9B,MAAM,CAAC,GAAG,KAAK,MAAM,EAAE,MAAM,KAAK,MAAM,OAAO,KAAK,MAAA,CAAO;AAAA,EAAA,CAC3D;AACD,WAAS,QAAQ,yBAAyB,SAAS,IAAI,MAAM;AAE7D,MAAI,KAAK,SAAS;AACjB,aAAS,QAAQ,iBAAiB,KAAK,OAAO,IAAI,MAAM;AAAA,EACzD;AAEA,QAAM,mBAAmB,oBAAoB,EAAE,OAAO,KAAK,OAAO;AAClE,MAAI,kBAAkB;AACrB,aAAS,QAAQ,2BAA2B,gBAAgB,IAAI,MAAM;AAAA,EACvE;AAES,WAAA,QAAQ,OAAO,MAAM;AAEvB,SAAA;AACR;"}
+{"version":3,"file":"buildFieldDocs.js","names":[],"sources":["../../src/lib/buildFieldDocs.ts"],"sourcesContent":["import type { CustomTypeModelField } from \"@prismicio/client\";\n\nimport { FIELD_DOCUMENTATION_URLS } from \"../constants\";\nimport type { FieldPath } from \"../types\";\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(args: GetFieldHumanReadableTypeArgs): string {\n\tswitch (args.field.type) {\n\t\tcase \"StructuredText\": {\n\t\t\treturn \"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: ${catalog ? `\\`${catalog}\\`` : \"*unknown*\"})`;\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 getDocumentationURLArgs = {\n\tfield: CustomTypeModelField;\n};\n\nfunction getDocumentationURL(args: getDocumentationURLArgs) {\n\tswitch (args.field.type) {\n\t\tcase \"Link\": {\n\t\t\tconst urls = FIELD_DOCUMENTATION_URLS.Link;\n\n\t\t\tswitch (args.field.config?.select) {\n\t\t\t\tcase \"document\": {\n\t\t\t\t\treturn urls.contentRelationship;\n\t\t\t\t}\n\n\t\t\t\tcase \"media\": {\n\t\t\t\t\treturn urls.linkToMedia;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\treturn urls.link;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tdefault: {\n\t\t\tconst url =\n\t\t\t\tFIELD_DOCUMENTATION_URLS[args.field.type as keyof typeof FIELD_DOCUMENTATION_URLS];\n\n\t\t\tif (typeof url === \"string\") {\n\t\t\t\treturn url;\n\t\t\t}\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(` * ${humanReadableName} field in *${humanReadablePath}*`, result);\n\n\tresult = addLine(\" *\", result);\n\n\tresult = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);\n\n\tconst placeholder =\n\t\t(args.field.config && \"placeholder\" in args.field.config && args.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(` * - **Default Value**: ${stringifiedDefaultValue}`, result);\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 = getDocumentationURL({ field: args.field });\n\tif (documentationURL) {\n\t\tresult = addLine(` * - **Documentation**: ${documentationURL}`, result);\n\t}\n\n\tresult = addLine(\" */\", result);\n\n\treturn result;\n}\n"],"mappings":";;;;;;AAaA,SAAS,0BAA0B,MAA6C;AAC/E,SAAQ,KAAK,MAAM,MAAnB;EACC,KAAK,iBACJ,QAAO;EAGR,KAAK,qBAAqB;GACzB,MAAM,UAAU,KAAK,MAAM,QAAQ;AAEnC,UAAO,gCAAgC,UAAU,KAAK,QAAQ,MAAM,YAAY;;EAGjF,KAAK,OACJ,SAAQ,KAAK,MAAM,QAAQ,QAA3B;GACC,KAAK,WACJ,QAAO;GAGR,KAAK,QACJ,QAAO;GAGR,QACC,QAAO;;EAKV,KAAK,SACJ,QAAO;EAGR,QACC,QAAO,KAAK,MAAM;;;AASrB,SAAS,oBAAoB,MAA+B;AAC3D,SAAQ,KAAK,MAAM,MAAnB;EACC,KAAK,QAAQ;GACZ,MAAM,OAAO,yBAAyB;AAEtC,WAAQ,KAAK,MAAM,QAAQ,QAA3B;IACC,KAAK,WACJ,QAAO,KAAK;IAGb,KAAK,QACJ,QAAO,KAAK;IAGb,QACC,QAAO,KAAK;;;EAKf,SAAS;GACR,MAAM,MACL,yBAAyB,KAAK,MAAM;AAErC,OAAI,OAAO,QAAQ,SAClB,QAAO;;;;AAaX,SAAgB,eAAe,MAAkC;CAChE,IAAI,SAAS;CAEb,MAAM,oBAAoB,0BAA0B;EACnD,OAAO,KAAK;EACZ,MAAM,KAAK;EACX,CAAC;CACF,MAAM,oBAAoB,qBAAqB,EAAE,MAAM,KAAK,MAAM,CAAC;CACnE,MAAM,yBAAyB,0BAA0B,EACxD,OAAO,KAAK,OACZ,CAAC;AAEF,UAAS,QAAQ,MAAM,kBAAkB,aAAa,kBAAkB,IAAI,OAAO;AAEnF,UAAS,QAAQ,MAAM,OAAO;AAE9B,UAAS,QAAQ,wBAAwB,0BAA0B,OAAO;AAK1E,UAAS,QAAQ,yBAFf,KAAK,MAAM,UAAU,iBAAiB,KAAK,MAAM,UAAU,KAAK,MAAM,OAAO,eAC9E,YACwD,OAAO;CAEhE,MAAM,eACL,KAAK,MAAM,UAAU,mBAAmB,KAAK,MAAM,SAChD,KAAK,MAAM,OAAO,gBAClB,KAAA;AACJ,KAAI,iBAAiB,KAAA,EAIpB,UAAS,QAAQ,2BAFhB,OAAO,iBAAiB,YAAY,GAAG,iBAAiB,gBAEc,OAAO;AAM/E,UAAS,QAAQ,yBAHC,aAAa,EAC9B,MAAM,CAAC,GAAG,KAAK,MAAM;EAAE,MAAM,KAAK;EAAM,OAAO,KAAK;EAAO,CAAC,EAC5D,CAAC,IACqD,OAAO;AAE9D,KAAI,KAAK,QACR,UAAS,QAAQ,iBAAiB,KAAK,WAAW,OAAO;CAG1D,MAAM,mBAAmB,oBAAoB,EAAE,OAAO,KAAK,OAAO,CAAC;AACnE,KAAI,iBACH,UAAS,QAAQ,2BAA2B,oBAAoB,OAAO;AAGxE,UAAS,QAAQ,OAAO,OAAO;AAE/B,QAAO"}