@prismicio/plugin-kit 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,129 @@
+import { PluginSystemContext } from "./createPluginSystemContext.js";
+import { Plugin } from "./definePlugin.js";
+import { CustomTypeCreateHookBase } from "./hooks/customType-create.js";
+import { CustomTypeDeleteHookBase } from "./hooks/customType-delete.js";
+import { CustomTypeReadHookBase } from "./hooks/customType-read.js";
+import { CustomTypeRenameHookBase } from "./hooks/customType-rename.js";
+import { CustomTypeUpdateHookBase } from "./hooks/customType-update.js";
+import { CustomTypeLibraryReadHookBase } from "./hooks/customTypeLibrary-read.js";
+import { DebugHookBase } from "./hooks/debug.js";
+import { ProjectInitHookBase } from "./hooks/project-init.js";
+import { SliceCreateHookBase } from "./hooks/slice-create.js";
+import { SliceDeleteHookBase } from "./hooks/slice-delete.js";
+import { SliceReadHookBase } from "./hooks/slice-read.js";
+import { SliceRenameHookBase } from "./hooks/slice-rename.js";
+import { SliceUpdateHookBase } from "./hooks/slice-update.js";
+import { SliceLibraryReadHookBase } from "./hooks/sliceLibrary-read.js";
+import { Hook } from "./lib/HookSystem.js";
+/**
+ * A value optionally wrapped in a `PromiseLike`.
+ *
+ * @typeParam T - The value that can optionally be wrapped.
+ */
+export type Promisable<T> = T | PromiseLike<T>;
+/**
+ * A generic type for a user-provided plugin options. Prefer using a
+ * plugin-specific type over this type.
+ */
+export type PluginOptions = Record<string, unknown>;
+/**
+ * A string, object, or instance representing a registered plugin.
+ *
+ * @typeParam TPluginOptions - User-provided options for the plugin.
+ */
+export type PrismicConfigPluginRegistration<TPluginOptions extends PluginOptions = PluginOptions> = string | Plugin | {
+    resolve: string | Plugin;
+    options?: TPluginOptions;
+};
+/**
+ * Prismic configuration from `prismic.config.js`.
+ */
+export type PrismicConfig = {
+    repositoryName: string;
+    adapter: PrismicConfigPluginRegistration;
+    libraries?: string[];
+    apiEndpoint?: string;
+};
+/**
+ * Prismic project metadata.
+ */
+export type PrismicProject = {
+    /**
+     * An absolute path to project root.
+     */
+    root: string;
+    /**
+     * Prismic `prismic.config.json` content, validated.
+     */
+    config: PrismicConfig;
+};
+/**
+ * A Slice Library's metadata.
+ */
+export type SliceLibrary = {
+    id: string;
+};
+/**
+ * A hook handler.
+ */
+export type PluginHook<TData, TReturn> = (data: TData) => Promisable<TReturn>;
+/**
+ * Extra arguments provided to hooks when called.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type PluginHookExtraArgs<TPluginOptions extends PluginOptions = PluginOptions> = [context: PluginSystemContext<TPluginOptions>];
+/**
+ * Utility type to extend a hook handler's type with Plugin System-specific
+ * extra arguments.
+ *
+ * @typeParam THook - Hook handler to extend.
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type ExtendPluginSystemHook<THook extends PluginHook<any, any>, TPluginOptions extends PluginOptions = PluginOptions> = (...args: [
+    ...args: Parameters<THook>,
+    ...extraArgs: PluginHookExtraArgs<TPluginOptions>
+]) => ReturnType<THook>;
+/**
+ * Hook types.
+ */
+export declare const PluginHookType: {
+    readonly slice_create: "slice:create";
+    readonly slice_update: "slice:update";
+    readonly slice_rename: "slice:rename";
+    readonly slice_delete: "slice:delete";
+    readonly slice_read: "slice:read";
+    readonly sliceLibrary_read: "slice-library:read";
+    readonly customType_create: "custom-type:create";
+    readonly customType_update: "custom-type:update";
+    readonly customType_rename: "custom-type:rename";
+    readonly customType_delete: "custom-type:delete";
+    readonly customType_read: "custom-type:read";
+    readonly customTypeLibrary_read: "custom-type-library:read";
+    readonly snippet_read: "snippet:read";
+    readonly project_init: "project:init";
+    readonly debug: "debug";
+};
+/**
+ * Hook types.
+ */
+export type PluginHookTypes = (typeof PluginHookType)[keyof typeof PluginHookType];
+/**
+ * Plugin hook handlers.
+ */
+export type PluginHooks = {
+    [PluginHookType.slice_create]: Hook<SliceCreateHookBase>;
+    [PluginHookType.slice_update]: Hook<SliceUpdateHookBase>;
+    [PluginHookType.slice_rename]: Hook<SliceRenameHookBase>;
+    [PluginHookType.slice_delete]: Hook<SliceDeleteHookBase>;
+    [PluginHookType.slice_read]: Hook<SliceReadHookBase>;
+    [PluginHookType.sliceLibrary_read]: Hook<SliceLibraryReadHookBase>;
+    [PluginHookType.customType_create]: Hook<CustomTypeCreateHookBase>;
+    [PluginHookType.customType_update]: Hook<CustomTypeUpdateHookBase>;
+    [PluginHookType.customType_rename]: Hook<CustomTypeRenameHookBase>;
+    [PluginHookType.customType_delete]: Hook<CustomTypeDeleteHookBase>;
+    [PluginHookType.customType_read]: Hook<CustomTypeReadHookBase>;
+    [PluginHookType.customTypeLibrary_read]: Hook<CustomTypeLibraryReadHookBase>;
+    [PluginHookType.project_init]: Hook<ProjectInitHookBase>;
+    [PluginHookType.debug]: Hook<DebugHookBase>;
+};

package/dist/types.js

@@ -0,0 +1,21 @@
+const PluginHookType = {
+  slice_create: "slice:create",
+  slice_update: "slice:update",
+  slice_rename: "slice:rename",
+  slice_delete: "slice:delete",
+  slice_read: "slice:read",
+  sliceLibrary_read: "slice-library:read",
+  customType_create: "custom-type:create",
+  customType_update: "custom-type:update",
+  customType_rename: "custom-type:rename",
+  customType_delete: "custom-type:delete",
+  customType_read: "custom-type:read",
+  customTypeLibrary_read: "custom-type-library:read",
+  snippet_read: "snippet:read",
+  project_init: "project:init",
+  debug: "debug"
+};
+export {
+  PluginHookType
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../../src/types.ts"],"sourcesContent":["import { PluginSystemContext } from \"./createPluginSystemContext\";\nimport { Plugin } from \"./definePlugin\";\nimport { CustomTypeCreateHookBase } from \"./hooks/customType-create\";\nimport { CustomTypeDeleteHookBase } from \"./hooks/customType-delete\";\nimport { CustomTypeReadHookBase } from \"./hooks/customType-read\";\nimport { CustomTypeRenameHookBase } from \"./hooks/customType-rename\";\nimport { CustomTypeUpdateHookBase } from \"./hooks/customType-update\";\nimport { CustomTypeLibraryReadHookBase } from \"./hooks/customTypeLibrary-read\";\nimport { DebugHookBase } from \"./hooks/debug\";\nimport { ProjectInitHookBase } from \"./hooks/project-init\";\nimport { SliceCreateHookBase } from \"./hooks/slice-create\";\nimport { SliceDeleteHookBase } from \"./hooks/slice-delete\";\nimport { SliceReadHookBase } from \"./hooks/slice-read\";\nimport { SliceRenameHookBase } from \"./hooks/slice-rename\";\nimport { SliceUpdateHookBase } from \"./hooks/slice-update\";\nimport { SliceLibraryReadHookBase } from \"./hooks/sliceLibrary-read\";\nimport { Hook } from \"./lib/HookSystem\";\n\n/**\n * A value optionally wrapped in a `PromiseLike`.\n *\n * @typeParam T - The value that can optionally be wrapped.\n */\nexport type Promisable<T> = T | PromiseLike<T>;\n\n/**\n * A generic type for a user-provided plugin options. Prefer using a\n * plugin-specific type over this type.\n */\nexport type PluginOptions = Record<string, unknown>;\n\n/**\n * A string, object, or instance representing a registered plugin.\n *\n * @typeParam TPluginOptions - User-provided options for the plugin.\n */\nexport type PrismicConfigPluginRegistration<\n\tTPluginOptions extends PluginOptions = PluginOptions,\n> =\n\t| string\n\t| Plugin\n\t| {\n\t\t\tresolve: string | Plugin;\n\t\t\toptions?: TPluginOptions;\n\t  };\n\n/**\n * Prismic configuration from `prismic.config.js`.\n */\nexport type PrismicConfig = {\n\trepositoryName: string;\n\tadapter: PrismicConfigPluginRegistration;\n\tlibraries?: string[];\n\tapiEndpoint?: string;\n};\n\n/**\n * Prismic project metadata.\n */\nexport type PrismicProject = {\n\t/**\n\t * An absolute path to project root.\n\t */\n\troot: string;\n\t/**\n\t * Prismic `prismic.config.json` content, validated.\n\t */\n\tconfig: PrismicConfig;\n};\n\n/**\n * A Slice Library's metadata.\n */\nexport type SliceLibrary = {\n\tid: string;\n};\n\n// ============================================================================\n//\n// # HOOK TYPES\n//\n// ============================================================================\n\n/**\n * A hook handler.\n */\nexport type PluginHook<TData, TReturn> = (data: TData) => Promisable<TReturn>;\n\n/**\n * Extra arguments provided to hooks when called.\n *\n * @typeParam TPluginOptions - User-provided options for the hook's plugin.\n */\nexport type PluginHookExtraArgs<\n\tTPluginOptions extends PluginOptions = PluginOptions,\n> = [context: PluginSystemContext<TPluginOptions>];\n\n/**\n * Utility type to extend a hook handler's type with Plugin System-specific\n * extra arguments.\n *\n * @typeParam THook - Hook handler to extend.\n * @typeParam TPluginOptions - User-provided options for the hook's plugin.\n */\nexport type ExtendPluginSystemHook<\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tTHook extends PluginHook<any, any>,\n\tTPluginOptions extends PluginOptions = PluginOptions,\n> = (\n\t...args: [\n\t\t...args: Parameters<THook>,\n\t\t...extraArgs: PluginHookExtraArgs<TPluginOptions>,\n\t]\n) => ReturnType<THook>;\n\n/**\n * Hook types.\n */\nexport const PluginHookType = {\n\tslice_create: \"slice:create\",\n\tslice_update: \"slice:update\",\n\tslice_rename: \"slice:rename\",\n\tslice_delete: \"slice:delete\",\n\tslice_read: \"slice:read\",\n\tsliceLibrary_read: \"slice-library:read\",\n\n\tcustomType_create: \"custom-type:create\",\n\tcustomType_update: \"custom-type:update\",\n\tcustomType_rename: \"custom-type:rename\",\n\tcustomType_delete: \"custom-type:delete\",\n\tcustomType_read: \"custom-type:read\",\n\tcustomTypeLibrary_read: \"custom-type-library:read\",\n\n\tsnippet_read: \"snippet:read\",\n\n\tproject_init: \"project:init\",\n\n\tdebug: \"debug\",\n} as const;\n\n/**\n * Hook types.\n */\nexport type PluginHookTypes =\n\t(typeof PluginHookType)[keyof typeof PluginHookType];\n\n/**\n * Plugin hook handlers.\n */\nexport type PluginHooks = {\n\t// Slices\n\t[PluginHookType.slice_create]: Hook<SliceCreateHookBase>;\n\t[PluginHookType.slice_update]: Hook<SliceUpdateHookBase>;\n\t[PluginHookType.slice_rename]: Hook<SliceRenameHookBase>;\n\t[PluginHookType.slice_delete]: Hook<SliceDeleteHookBase>;\n\t[PluginHookType.slice_read]: Hook<SliceReadHookBase>;\n\n\t// Slice Libraries\n\t[PluginHookType.sliceLibrary_read]: Hook<SliceLibraryReadHookBase>;\n\n\t// Custom Types\n\t[PluginHookType.customType_create]: Hook<CustomTypeCreateHookBase>;\n\t[PluginHookType.customType_update]: Hook<CustomTypeUpdateHookBase>;\n\t[PluginHookType.customType_rename]: Hook<CustomTypeRenameHookBase>;\n\t[PluginHookType.customType_delete]: Hook<CustomTypeDeleteHookBase>;\n\t[PluginHookType.customType_read]: Hook<CustomTypeReadHookBase>;\n\t// Custom Type Libraries\n\t[PluginHookType.customTypeLibrary_read]: Hook<CustomTypeLibraryReadHookBase>;\n\n\t// Project\n\t[PluginHookType.project_init]: Hook<ProjectInitHookBase>;\n\n\t// Debug\n\t[PluginHookType.debug]: Hook<DebugHookBase>;\n};\n"],"names":[],"mappings":"AAsHO,MAAM,iBAAiB;AAAA,EAC7B,cAAc;AAAA,EACd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,cAAc;AAAA,EACd,YAAY;AAAA,EACZ,mBAAmB;AAAA,EAEnB,mBAAmB;AAAA,EACnB,mBAAmB;AAAA,EACnB,mBAAmB;AAAA,EACnB,mBAAmB;AAAA,EACnB,iBAAiB;AAAA,EACjB,wBAAwB;AAAA,EAExB,cAAc;AAAA,EAEd,cAAc;AAAA,EAEd,OAAO;;"}

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@prismicio/plugin-kit",
+  "version": "0.0.1",
+  "description": "A set of helpers to develop and run Prismic plugins",
+  "keywords": [
+    "typescript",
+    "helpers",
+    "utils",
+    "toolbox",
+    "prismic"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@github.com/prismicio/devtools.git",
+    "directory": "packages/plugin-kit"
+  },
+  "license": "Apache-2.0",
+  "author": "Prismic <contact@prismic.io> (https://prismic.io)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./fs": {
+      "types": "./dist/fs/index.d.ts",
+      "import": "./dist/fs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ],
+      "fs": [
+        "dist/fs/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "types": "tsc --noEmit",
+    "format": "prettier --write .",
+    "lint": "eslint --max-warnings 0 .",
+    "prepack": "$npm_execpath run build",
+    "depcheck": "depcheck --config=.depcheckrc",
+    "audit": "yarn npm audit --environment production --severity high"
+  },
+  "dependencies": {
+    "@prismicio/client": "7.21.0",
+    "common-tags": "1.8.2",
+    "defu": "6.1.4",
+    "fs-extra": "11.3.2",
+    "p-limit": "7.2.0",
+    "prettier": "3.7.1",
+    "prismic-ts-codegen": "0.1.28",
+    "zod": "4.1.13"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.28.0",
+    "@prismicio/types-internal": "3.16.1",
+    "@trivago/prettier-plugin-sort-imports": "6.0.0",
+    "@types/common-tags": "1.8.4",
+    "@types/fs-extra": "11.0.4",
+    "depcheck": "1.4.7",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-tsdoc": "0.5.0",
+    "prettier-plugin-jsdoc": "1.7.0",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.33.0",
+    "vite": "7.2.4",
+    "vite-plugin-sdk": "0.1.5"
+  }
+}

package/src/createPluginHookSystem.ts

@@ -0,0 +1,9 @@
+import { HookSystem } from "./lib/HookSystem";
+import type { PluginHooks } from "./types";
+
+/**
+ * @internal
+ */
+export const createPluginHookSystem = (): HookSystem<PluginHooks> => {
+	return new HookSystem<PluginHooks>();
+};

package/src/createPluginSystemActions.ts

@@ -0,0 +1,188 @@
+import {
+	CustomTypeReadHookData,
+	CustomTypeReadHookReturnType,
+} from "./hooks/customType-read";
+import { CustomTypeLibraryReadHookReturnType } from "./hooks/customTypeLibrary-read";
+import { SliceReadHookData, SliceReadHookReturnType } from "./hooks/slice-read";
+import {
+	SliceLibraryReadHookData,
+	SliceLibraryReadHookReturnType,
+} from "./hooks/sliceLibrary-read";
+import { HookSystem } from "./lib/HookSystem";
+import { PluginHooks, PrismicProject } from "./types";
+
+export type ReadAllSliceModelsActionArgs<
+	TWithMetadata extends boolean = false,
+> = {
+	withMetadata?: TWithMetadata;
+};
+
+export type ReadAllSliceModelsActionReturnType = (SliceReadHookReturnType & {
+	libraryID: string;
+})[];
+
+export type ReadAllSliceModelsForLibraryActionArgs = {
+	libraryID: string;
+};
+
+/**
+ * Creates Plugin System actions.
+ *
+ * @internal
+ */
+export const createPluginSystemActions = (
+	project: PrismicProject,
+	hookSystem: HookSystem<PluginHooks>,
+): PluginSystemActions => {
+	return new PluginSystemActions(project, hookSystem);
+};
+
+/**
+ * Plugin System actions shared to plugins and hooks.
+ */
+export class PluginSystemActions {
+	/**
+	 * The Prismic project's metadata.
+	 *
+	 * @internal
+	 */
+	private _project: PrismicProject;
+	/**
+	 * The actions' hook system used to internally trigger hook calls.
+	 *
+	 * @internal
+	 */
+	private _hookSystem: HookSystem<PluginHooks>;
+
+	constructor(project: PrismicProject, hookSystem: HookSystem<PluginHooks>) {
+		this._project = project;
+		this._hookSystem = hookSystem;
+	}
+
+	readAllSliceModels =
+		async (): Promise<ReadAllSliceModelsActionReturnType> => {
+			const libraryIDs = this._project.config.libraries || [];
+
+			return (
+				await Promise.all(
+					libraryIDs.map(async (libraryID) => {
+						const models = await this.readAllSliceModelsForLibrary({
+							libraryID,
+						});
+
+						return models.map((model) => {
+							return {
+								libraryID,
+								...model,
+							};
+						});
+					}),
+				)
+			).flat();
+		};
+
+	readAllSliceModelsForLibrary = async (
+		args: ReadAllSliceModelsForLibraryActionArgs,
+	): Promise<SliceReadHookReturnType[]> => {
+		const { sliceIDs } = await this.readSliceLibrary({
+			libraryID: args.libraryID,
+		});
+
+		return await Promise.all(
+			sliceIDs.map(async (sliceID) => {
+				return await this.readSliceModel({
+					libraryID: args.libraryID,
+					sliceID,
+				});
+			}),
+		);
+	};
+
+	readSliceModel = async (
+		args: SliceReadHookData,
+	): Promise<SliceReadHookReturnType> => {
+		const {
+			data: [model],
+			errors: [cause],
+		} = await this._hookSystem.callHook("slice:read", {
+			libraryID: args.libraryID,
+			sliceID: args.sliceID,
+		});
+
+		if (!model) {
+			throw new Error(
+				`Slice \`${args.sliceID}\` not found in the \`${args.libraryID}\` library.`,
+				{ cause },
+			);
+		}
+
+		return model;
+	};
+
+	readSliceLibrary = async (
+		args: SliceLibraryReadHookData,
+	): Promise<SliceLibraryReadHookReturnType> => {
+		const {
+			data: [library],
+			errors: [cause],
+		} = await this._hookSystem.callHook("slice-library:read", {
+			libraryID: args.libraryID,
+		});
+
+		if (!library) {
+			throw new Error(`Slice library \`${args.libraryID}\` not found.`, {
+				cause,
+			});
+		}
+
+		return library;
+	};
+
+	readAllCustomTypeModels = async (): Promise<
+		CustomTypeReadHookReturnType[]
+	> => {
+		const { ids } = await this.readCustomTypeLibrary();
+
+		return await Promise.all(
+			ids.map(async (id) => {
+				return this.readCustomTypeModel({ id });
+			}),
+		);
+	};
+
+	readCustomTypeModel = async (
+		args: CustomTypeReadHookData,
+	): Promise<CustomTypeReadHookReturnType> => {
+		const {
+			data: [model],
+			errors: [cause],
+		} = await this._hookSystem.callHook("custom-type:read", {
+			id: args.id,
+		});
+
+		if (!model) {
+			throw new Error(`Custom type \`${args.id}\` not found.`, { cause });
+		}
+
+		return model;
+	};
+
+	readCustomTypeLibrary =
+		async (): Promise<CustomTypeLibraryReadHookReturnType> => {
+			const {
+				data: [library],
+				errors: [cause],
+			} = await this._hookSystem.callHook(
+				"custom-type-library:read",
+				undefined,
+			);
+
+			if (!library) {
+				throw new Error(`Couldn't read custom type library.`, {
+					cause,
+				});
+			}
+
+			return library;
+		};
+}

package/src/createPluginSystemContext.ts

@@ -0,0 +1,51 @@
+import { PluginSystemActions } from "./createPluginSystemActions";
+import { PluginSystemHelpers } from "./createPluginSystemHelpers";
+import { LoadedPlugin } from "./definePlugin";
+import { PrismicProject } from "./types";
+
+/**
+ * Plugin context shared to plugins and hooks.
+ */
+export type PluginSystemContext<
+	TPluginOptions extends Record<string, unknown>,
+> = {
+	actions: PluginSystemActions;
+	helpers: PluginSystemHelpers;
+	project: PrismicProject;
+	options: TPluginOptions;
+};
+
+/**
+ * Arguments for `createPluginSystemContext()`.
+ *
+ * @typeParam TPluginOptions - Options for the plugin's context.
+ */
+type CreatePluginSystemContextArgs<
+	TPluginOptions extends Record<string, unknown>,
+> = {
+	actions: PluginSystemActions;
+	helpers: PluginSystemHelpers;
+	project: PrismicProject;
+	plugin: LoadedPlugin<TPluginOptions>;
+};
+
+/**
+ * Creates Plugin context.
+ *
+ * @internal
+ */
+export const createPluginSystemContext = <
+	TPluginOptions extends Record<string, unknown>,
+>({
+	actions,
+	helpers,
+	project,
+	plugin,
+}: CreatePluginSystemContextArgs<TPluginOptions>): PluginSystemContext<TPluginOptions> => {
+	return {
+		actions,
+		helpers,
+		project,
+		options: plugin.options,
+	};
+};

package/src/createPluginSystemHelpers.ts

@@ -0,0 +1,129 @@
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+
+import { stripIndent } from "common-tags";
+import * as prettier from "prettier";
+
+import { decodePrismicConfig } from "./lib/decodePrismicConfig";
+import { PrismicConfig, PrismicProject } from "./types";
+
+type UpdatePrismicConfigOptions = {
+	format?: boolean;
+};
+
+type FormatOptions = {
+	prettier?: prettier.Options;
+	/**
+	 * Determines if a newline is included at the end of the formatted result.
+	 *
+	 * @defaultValue `true`
+	 */
+	includeNewlineAtEnd?: boolean;
+};
+
+/**
+ * Creates Plugin System helpers.
+ *
+ * @internal
+ */
+export const createPluginSystemHelpers = (
+	project: PrismicProject,
+): PluginSystemHelpers => {
+	return new PluginSystemHelpers(project);
+};
+
+/**
+ * Plugin System helpers shared to plugins and hooks.
+ */
+export class PluginSystemHelpers {
+	/**
+	 * Project's metadata.
+	 *
+	 * @internal
+	 */
+	private _project: PrismicProject;
+
+	constructor(project: PrismicProject) {
+		this._project = project;
+	}
+
+	getProject = async (): Promise<PrismicProject> => {
+		const configFilePath = this.joinPathFromRoot("prismic.config.json");
+
+		let rawConfig: unknown | undefined;
+		try {
+			const contents = await fs.readFile(configFilePath, "utf8");
+			rawConfig = JSON.parse(contents);
+		} catch {
+			// noop
+		}
+
+		if (!rawConfig) {
+			throw new Error(
+				"No Prismic config found, please initialize your project with first.",
+			);
+		}
+
+		const { value: prismicConfig, error } = decodePrismicConfig(rawConfig);
+
+		if (error) {
+			throw new Error(`Invalid Prismic config. ${error.errors.join(", ")}`);
+		}
+
+		return {
+			...this._project,
+			config: prismicConfig,
+		};
+	};
+
+	updatePrismicConfig = async (
+		prismicConfig: PrismicConfig,
+		options?: UpdatePrismicConfigOptions,
+	): Promise<void> => {
+		const { value: decodedPrismicConfig, error } =
+			decodePrismicConfig(prismicConfig);
+
+		if (error) {
+			throw new Error(
+				`Invalid Prismic config provided. ${error.errors.join(", ")}`,
+			);
+		}
+
+		const configFilePath = this.joinPathFromRoot("prismic.config.json");
+		let content = JSON.stringify(decodedPrismicConfig, null, 2);
+
+		if (options?.format) {
+			content = await this.format(content, configFilePath);
+		}
+
+		await fs.writeFile(configFilePath, content);
+	};
+
+	format = async (
+		source: string,
+		filePath?: string,
+		options?: FormatOptions,
+	): Promise<string> => {
+		let formatted = stripIndent(source);
+
+		const prettierOptions = await prettier.resolveConfig(
+			filePath || this._project.root,
+		);
+
+		formatted = await prettier.format(formatted, {
+			...prettierOptions,
+			filepath: filePath,
+			...(options?.prettier ?? {}),
+		});
+
+		if (options?.includeNewlineAtEnd === false) {
+			formatted = formatted.replace(/[\r\n]+$/, "");
+		}
+
+		return formatted;
+	};
+
+	joinPathFromRoot = (...paths: string[]): string => {
+		return path.join(this._project.root, ...paths);
+	};
+}