prismic-ts-codegen

A Prismic model-to-TypeScript-type generator.

• Converts custom type and shared Slice models to TypeScript types
• Integrates with other Prismic TypeScript libraries
• Built upon the @prismicio/client library

Install

npm install @prismicio/client
npm install --save-dev prismic-ts-codegen

Usage

1. Create a config file

   To get started, create a prismicCodegen.config.ts file at the root of your project with the following command:

   npx prismic-ts-codegen init

2. Configure your model paths

   Next, add paths to all of your Custom Type and Shared Slice models in your prismicCodegen.config.ts file (globs are supported):

    // prismicCodegen.config.ts
   
    import type { Config } from "prismic-ts-codegen";
   
    const config: Config = {
      output: "./types.generated.ts",
   +   models: ["./customtypes/**/index.json", "./slices/**/model.json"],
    };
   
    export default config;

3. Generate your types

   Now, anytime you want to generate types, run the codegen tool:

   npx prismic-ts-codegen

   By default, your types will be exported from types.generated.ts.

Documentation

Configuration

prismic-ts-codegen is configured using a prismicCodegen.config.ts file. It must export a configuration object as the default export.

Interface

See the Config TypeScript interface for a complete reference of each configuration property.

Full example

// prismicCodegen.config.ts
import type { Config } from "prismic-ts-codegen";

const config: Config = {
    repositoryName: "nextjs-blog-demo",
    accessToken: "abc123xyz345",
    customTypesAPIToken: "abc123xyz345",

    output: "./types.generated.ts",

    clientIntegration: {
        includeCreateClientInterface: true,
    },

    locales: {
        ids: ["en-us", "fr-fr", "en-gb"],
        fetchFromRepository: true,
    },

    models: {
        files: ["./customtypes/**/index.json", "./slices/**/model.json"],
        fetchFromRepository: true,
    },

    fields: {
        embed: {
            providerTypes: {
                YouTube: 'import("./types").OEmbedYouTube',
                Twitter: 'import("./types").OEmbedTwitter',
                Vimeo: 'import("./types").OEmbedVimeo',
            },
        },
        integrationFields: {
            catalogTypes: {
                shop: 'import("./types").IntegrationFieldShop',
            },
        },
    },
};

export default config;

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project, check out the detailed CONTRIBUTING.md document.

License

Copyright 2013-2024 Prismic <contact@prismic.io> (https://prismic.io)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.