prismic-ts-codegen 0.1.28 → 0.1.29

package/dist/cli/types.d.ts

@@ -1,175 +0,0 @@
-import { TypesProvider } from "../generateTypes";
-/**
- * Configuration to control the generated types.
- */
-export type Config = {
-    /**
-     * The name of the Prismic repository.
-     */
-    repositoryName?: string;
-    /**
-     * The access token for the Prismic repository. If the repository is private
-     * and `locales.fetchFromRepository` is `true`, providing a token is
-     * required.
-     */
-    accessToken?: string;
-    /**
-     * The Custom Types API token for the Prismic repository. If
-     * `models.fetchFromRepository` is `true`, providing a token is required.
-     */
-    customTypesAPIToken?: string;
-    /**
-     * The file path where the generated types will be saved. This path is
-     * relative to where the command is called.
-     */
-    output?: string;
-    /**
-     * The package that provides TypeScript types for Prismic data. Most projects
-     * will not need to configure this option.
-     *
-     * @defaultValue Automatically detected using the project's `package.json`.
-     */
-    typesProvider?: TypesProvider;
-    /**
-     * Configuration for automatic `@prismicio/client` integration.
-     */
-    clientIntegration?: {
-        /**
-         * Determines if a `@prismicio/client` integration with automatic typing
-         * should be included in the output.
-         *
-         * If set to `true`, Prismic clients will automatically be typed with the
-         * generated Custom Types and Slices.
-         *
-         * **Note**: If your project queries content from multiple Prismic
-         * repositories, set `includeCreateClientInterface` to `true` for the
-         * primary repository and `false` or any other repository. The generated
-         * `AllDocumentTypes` type for non-primary repositories can be provided to
-         * `@prismicio/client`'s `createClient()` function as its only type
-         * parameter to type the client.
-         *
-         * @defaultValue `true`
-         */
-        includeCreateClientInterface?: boolean;
-        /**
-         * Determines if a `@prismicio/client` namespace named `Content` containing
-         * all Document and Slice types should be included in the output.
-         *
-         * If set to `true`, a `Content` namespace from `@prismicio/client` will be
-         * available to import to easily access types for your Prismic repository
-         * content.
-         *
-         * **Note**: If your project queries content from multiple Prismic
-         * repositories, set `includeContentNamespace` to `true` for the primary
-         * repository and `false` or any other repository. Types for non-primary
-         * repositories should be imported directly from the generated file rather
-         * than via the `Content` namespace.
-         *
-         * @defaultValue `true`
-         */
-        includeContentNamespace?: boolean;
-    };
-    /**
-     * Configuration for languages for the Prismic repository.
-     *
-     * It can be configured by providing an array of locale IDs configured for the
-     * repository or an object with finer control.
-     *
-     * @example
-     *
-     * ```ts
-     * ["en-us", "fr-fr"];
-     * ```
-     *
-     * @example
-     *
-     * ```ts
-     * {
-     * 	"ids": ["en-us", "fr-fr"],
-     * 	"fetchFromRepository": true
-     * }
-     * ```
-     */
-    locales?: string[] | {
-        /**
-         * A list of locales configured for the Prismic repository. This is used
-         * to type a document's `lang` property.
-         *
-         * @example
-         *
-         * ```ts
-         * ["en-us", "fr-fr"];
-         * ```
-         */
-        ids?: string[];
-        /**
-         * Determines if the Prismic repository's locales should be fetched from
-         * the repository's API.
-         */
-        fetchFromRepository?: boolean;
-    };
-    /**
-     * Configuration for Custom Type and Slice models for the Prismic repository.
-     *
-     * It can be configured by providing an array of file paths to Custom Type and
-     * Slice JSON models or an object with finer control.
-     */
-    models?: string[] | {
-        /**
-         * A list of file paths to Custom Type and Slice models. Globs are
-         * supported.
-         */
-        files?: string[];
-        /**
-         * Determines if the Prismic repository's Custom Type and Slice models
-         * should be fetched from the repository's API.
-         *
-         * `customTypesAPIToken` must be provided if set to `true`.
-         */
-        fetchFromRepository?: boolean;
-    };
-    /**
-     * Configuration for types generated for fields.
-     */
-    fields?: {
-        /**
-         * Configuration for Embed fields.
-         */
-        embed?: {
-            /**
-             * An object mapping oEmbed providers to their type. The type should be
-             * provided as a string and is added directly into the generated types.
-             *
-             * @example
-             *
-             * ```ts
-             * {
-             * 	"YouTube": "import('./types').OEmbedYouTube"
-             * 	"Twitter": "import('./types').OEmbedTwitter"
-             * 	"Vimeo": "import('./types').OEmbedVimeo"
-             * }
-             * ```
-             */
-            providerTypes?: Record<string, string>;
-        };
-        /**
-         * Configuration for Integration Fields.
-         */
-        integrationFields?: {
-            /**
-             * An object mapping catalog IDs to their type. The type should be
-             * provided as a string and is added directly into the generated types.
-             *
-             * @example
-             *
-             * ```ts
-             * {
-             * 	"shopify_products": "import('./types').IntegrationFieldShopifyProduct"
-             * 	"mux_videos": "import('./types').IntegrationFieldMuxVideo"
-             * }
-             * ```
-             */
-            catalogTypes?: Record<string, string>;
-        };
-    };
-};

package/dist/constants.d.ts

@@ -1,26 +0,0 @@
-export declare const CUSTOM_TYPES_DOCUMENTATION_URL = "https://prismic.io/docs/content-modeling";
-export declare const SHARED_SLICES_DOCUMENTATION_URL = "https://prismic.io/docs/slices";
-export declare const FIELD_DOCUMENTATION_URLS: {
-    UID: string;
-    Boolean: string;
-    Color: string;
-    Date: string;
-    Timestamp: string;
-    Number: string;
-    Text: string;
-    Select: string;
-    StructuredText: string;
-    Image: string;
-    Link: {
-        contentRelationship: string;
-        link: string;
-        linkToMedia: string;
-    };
-    Embed: string;
-    GeoPoint: string;
-    Table: string;
-    Group: string;
-    IntegrationFields: string;
-    Slices: string;
-    Choice: string;
-};

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/lib/addBlankLine.d.ts

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

package/dist/lib/addLine.d.ts

@@ -1 +0,0 @@
-export declare function addLine(line: string, state: string): string;

package/dist/lib/addSection.d.ts

@@ -1 +0,0 @@
-export declare function addSection(section: string, state: string): string;

package/dist/lib/addTrailingNewLine.d.ts

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

package/dist/lib/buildCustomTypeDataType.d.ts

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

package/dist/lib/buildCustomTypeType.d.ts

@@ -1,17 +0,0 @@
-import type { 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;
-    code: string;
-    auxiliaryTypes: AuxiliaryType[];
-    contentTypeNames: string[];
-};
-export declare function buildCustomTypeType(args: BuildCustomTypeTypesArgs): BuildCustomTypeTypeReturnValue;
-export {};

package/dist/lib/buildFieldDocs.d.ts

@@ -1,10 +0,0 @@
-import type { CustomTypeModelField } from "@prismicio/client";
-import { FieldPath } from "../types";
-type BuildFieldDocsArgs = {
-    name: string;
-    field: CustomTypeModelField;
-    path: FieldPath;
-    tabName?: string;
-};
-export declare function buildFieldDocs(args: BuildFieldDocsArgs): string;
-export {};

package/dist/lib/buildFieldProperties.d.ts

@@ -1,15 +0,0 @@
-import { type CustomTypeModelField } from "@prismicio/client";
-import { AuxiliaryType, FieldConfigs, FieldPath } from "../types";
-type BuildFieldPropertiesArgs = {
-    fields: Record<string, CustomTypeModelField>;
-    path: FieldPath;
-    fieldConfigs: FieldConfigs;
-    tabName?: string;
-};
-type BuildFieldPropertiesReturnType = {
-    code: string;
-    auxiliaryTypes: AuxiliaryType[];
-    contentTypeNames: string[];
-};
-export declare function buildFieldProperties(args: BuildFieldPropertiesArgs): BuildFieldPropertiesReturnType;
-export {};

package/dist/lib/buildSharedSliceType.d.ts

@@ -1,17 +0,0 @@
-import type { SharedSliceModel } from "@prismicio/client";
-import QuickLRU from "quick-lru";
-import { AuxiliaryType, FieldConfigs } from "../types";
-type BuildSharedSliceTypeArgs = {
-    model: SharedSliceModel;
-    fieldConfigs: FieldConfigs;
-    cache?: QuickLRU<string, unknown>;
-};
-type BuildSharedSliceTypeReturnValue = {
-    name: string;
-    variationNames: string[];
-    code: string;
-    auxiliaryTypes: AuxiliaryType[];
-    contentTypeNames: string[];
-};
-export declare function buildSharedSliceType(args: BuildSharedSliceTypeArgs): BuildSharedSliceTypeReturnValue;
-export {};

package/dist/lib/buildTypeName.d.ts

@@ -1 +0,0 @@
-export declare const buildTypeName: (...parts: string[]) => string;

package/dist/lib/buildUnion.d.ts

@@ -1 +0,0 @@
-export declare function buildUnion(types: string[]): string;

package/dist/lib/checkHasUIDFIeld.d.ts

@@ -1,2 +0,0 @@
-import type { CustomTypeModel } from "@prismicio/client";
-export declare function checkHasUIDField(model: CustomTypeModel): boolean;

package/dist/lib/getAPIIDPath.d.ts

@@ -1,6 +0,0 @@
-import { FieldPath } from "../types";
-type GetAPIIDPathArgs = {
-    path: FieldPath;
-};
-export declare function getAPIIDPath(args: GetAPIIDPathArgs): string;
-export {};

package/dist/lib/getCacheKey.d.ts

@@ -1,9 +0,0 @@
-/**
- * Returns a key based on the provided input that can be used as a cache
- * identifier.
- *
- * @param input - The value used to create a key.
- *
- * @returns The cache key.
- */
-export declare const getCacheKey: (input: unknown) => string;

package/dist/lib/getHumanReadableModelName.d.ts

@@ -1,7 +0,0 @@
-import type { CustomTypeModel, CustomTypeModelField, CustomTypeModelSlice, SharedSliceModel } from "@prismicio/client";
-type GetModelHumanNameArgs = {
-    name: string;
-    model: CustomTypeModel | SharedSliceModel | CustomTypeModelField | CustomTypeModelSlice;
-};
-export declare const getHumanReadableModelName: (args: GetModelHumanNameArgs) => string;
-export {};

package/dist/lib/getHumanReadablePath.d.ts

@@ -1,6 +0,0 @@
-import { FieldPath } from "../types";
-type GetHumanReadablePathArgs = {
-    path: FieldPath;
-};
-export declare function getHumanReadablePath(args: GetHumanReadablePathArgs): string;
-export {};

package/src/cli/types.ts

@@ -1,192 +0,0 @@
-import { TypesProvider } from "../generateTypes";
-
-/**
- * Configuration to control the generated types.
- */
-export type Config = {
-	/**
-	 * The name of the Prismic repository.
-	 */
-	repositoryName?: string;
-
-	/**
-	 * The access token for the Prismic repository. If the repository is private
-	 * and `locales.fetchFromRepository` is `true`, providing a token is
-	 * required.
-	 */
-	accessToken?: string;
-
-	/**
-	 * The Custom Types API token for the Prismic repository. If
-	 * `models.fetchFromRepository` is `true`, providing a token is required.
-	 */
-	customTypesAPIToken?: string;
-
-	/**
-	 * The file path where the generated types will be saved. This path is
-	 * relative to where the command is called.
-	 */
-	output?: string;
-
-	/**
-	 * The package that provides TypeScript types for Prismic data. Most projects
-	 * will not need to configure this option.
-	 *
-	 * @defaultValue Automatically detected using the project's `package.json`.
-	 */
-	typesProvider?: TypesProvider;
-
-	/**
-	 * Configuration for automatic `@prismicio/client` integration.
-	 */
-	clientIntegration?: {
-		/**
-		 * Determines if a `@prismicio/client` integration with automatic typing
-		 * should be included in the output.
-		 *
-		 * If set to `true`, Prismic clients will automatically be typed with the
-		 * generated Custom Types and Slices.
-		 *
-		 * **Note**: If your project queries content from multiple Prismic
-		 * repositories, set `includeCreateClientInterface` to `true` for the
-		 * primary repository and `false` or any other repository. The generated
-		 * `AllDocumentTypes` type for non-primary repositories can be provided to
-		 * `@prismicio/client`'s `createClient()` function as its only type
-		 * parameter to type the client.
-		 *
-		 * @defaultValue `true`
-		 */
-		includeCreateClientInterface?: boolean;
-
-		/**
-		 * Determines if a `@prismicio/client` namespace named `Content` containing
-		 * all Document and Slice types should be included in the output.
-		 *
-		 * If set to `true`, a `Content` namespace from `@prismicio/client` will be
-		 * available to import to easily access types for your Prismic repository
-		 * content.
-		 *
-		 * **Note**: If your project queries content from multiple Prismic
-		 * repositories, set `includeContentNamespace` to `true` for the primary
-		 * repository and `false` or any other repository. Types for non-primary
-		 * repositories should be imported directly from the generated file rather
-		 * than via the `Content` namespace.
-		 *
-		 * @defaultValue `true`
-		 */
-		includeContentNamespace?: boolean;
-	};
-
-	/**
-	 * Configuration for languages for the Prismic repository.
-	 *
-	 * It can be configured by providing an array of locale IDs configured for the
-	 * repository or an object with finer control.
-	 *
-	 * @example
-	 *
-	 * ```ts
-	 * ["en-us", "fr-fr"];
-	 * ```
-	 *
-	 * @example
-	 *
-	 * ```ts
-	 * {
-	 * 	"ids": ["en-us", "fr-fr"],
-	 * 	"fetchFromRepository": true
-	 * }
-	 * ```
-	 */
-	locales?:
-		| string[]
-		| {
-				/**
-				 * A list of locales configured for the Prismic repository. This is used
-				 * to type a document's `lang` property.
-				 *
-				 * @example
-				 *
-				 * ```ts
-				 * ["en-us", "fr-fr"];
-				 * ```
-				 */
-				ids?: string[];
-
-				/**
-				 * Determines if the Prismic repository's locales should be fetched from
-				 * the repository's API.
-				 */
-				fetchFromRepository?: boolean;
-		  };
-
-	/**
-	 * Configuration for Custom Type and Slice models for the Prismic repository.
-	 *
-	 * It can be configured by providing an array of file paths to Custom Type and
-	 * Slice JSON models or an object with finer control.
-	 */
-	models?:
-		| string[]
-		| {
-				/**
-				 * A list of file paths to Custom Type and Slice models. Globs are
-				 * supported.
-				 */
-				files?: string[];
-
-				/**
-				 * Determines if the Prismic repository's Custom Type and Slice models
-				 * should be fetched from the repository's API.
-				 *
-				 * `customTypesAPIToken` must be provided if set to `true`.
-				 */
-				fetchFromRepository?: boolean;
-		  };
-
-	/**
-	 * Configuration for types generated for fields.
-	 */
-	fields?: {
-		/**
-		 * Configuration for Embed fields.
-		 */
-		embed?: {
-			/**
-			 * An object mapping oEmbed providers to their type. The type should be
-			 * provided as a string and is added directly into the generated types.
-			 *
-			 * @example
-			 *
-			 * ```ts
-			 * {
-			 * 	"YouTube": "import('./types').OEmbedYouTube"
-			 * 	"Twitter": "import('./types').OEmbedTwitter"
-			 * 	"Vimeo": "import('./types').OEmbedVimeo"
-			 * }
-			 * ```
-			 */
-			providerTypes?: Record<string, string>;
-		};
-
-		/**
-		 * Configuration for Integration Fields.
-		 */
-		integrationFields?: {
-			/**
-			 * An object mapping catalog IDs to their type. The type should be
-			 * provided as a string and is added directly into the generated types.
-			 *
-			 * @example
-			 *
-			 * ```ts
-			 * {
-			 * 	"shopify_products": "import('./types').IntegrationFieldShopifyProduct"
-			 * 	"mux_videos": "import('./types').IntegrationFieldMuxVideo"
-			 * }
-			 * ```
-			 */
-			catalogTypes?: Record<string, string>;
-		};
-	};
-};