@prismicio/plugin-kit 0.0.1

package/dist/fs/readSliceModel.js

@@ -0,0 +1,46 @@
+import * as path from "node:path";
+import { buildSliceLibraryDirectoryPath } from "./buildSliceLibraryDirectoryPath.js";
+import { SHARED_SLICE_MODEL_FILENAME } from "./constants.js";
+import { checkPathExists } from "./lib/checkPathExists.js";
+import { readdir } from "./lib/fsLimit.js";
+import { isSharedSliceModel } from "./lib/isSharedSliceModel.js";
+import { readJSONFile } from "./lib/readJSONFile.js";
+const readSliceModel = async (args) => {
+  const libraryDir = buildSliceLibraryDirectoryPath({
+    libraryID: args.libraryID,
+    absolute: true,
+    helpers: args.helpers
+  });
+  if (await checkPathExists(libraryDir)) {
+    const childDirs = await readdir(libraryDir, { withFileTypes: true });
+    const unreadableModelPaths = [];
+    const models = await Promise.all(childDirs.map(async (childDir) => {
+      if (childDir.isDirectory()) {
+        const modelPath = path.join(libraryDir, childDir.name, SHARED_SLICE_MODEL_FILENAME);
+        try {
+          const modelContents = await readJSONFile(modelPath);
+          if (isSharedSliceModel(modelContents) && modelContents.id === args.sliceID) {
+            return modelContents;
+          }
+        } catch {
+          unreadableModelPaths.push(modelPath);
+        }
+      }
+    }));
+    const [model] = models.filter((model2) => isSharedSliceModel(model2));
+    if (model) {
+      return {
+        model
+      };
+    } else {
+      if (unreadableModelPaths.length > 0) {
+        throw new Error(`Did not find a Slice model with ID "${args.sliceID}" in the "${args.libraryID}" Slice Library. The following Slice models could not be read: [${unreadableModelPaths.join(", ")}]`);
+      }
+    }
+  }
+  throw new Error(`Did not find a Slice model with ID "${args.sliceID}" in the "${args.libraryID}" Slice Library.`);
+};
+export {
+  readSliceModel
+};
+//# sourceMappingURL=readSliceModel.js.map

package/dist/fs/readSliceModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readSliceModel.js","sources":["../../../src/fs/readSliceModel.ts"],"sourcesContent":["import * as path from \"node:path\";\n\nimport TypesInternal from \"@prismicio/types-internal/lib/customtypes/index.js\";\n\nimport { PluginSystemHelpers } from \"../createPluginSystemHelpers\";\n\nimport { buildSliceLibraryDirectoryPath } from \"./buildSliceLibraryDirectoryPath\";\nimport { SHARED_SLICE_MODEL_FILENAME } from \"./constants\";\nimport { checkPathExists } from \"./lib/checkPathExists\";\nimport * as fs from \"./lib/fsLimit\";\nimport { isSharedSliceModel } from \"./lib/isSharedSliceModel\";\nimport { readJSONFile } from \"./lib/readJSONFile\";\n\nexport type ReadSliceModelArgs = {\n\tlibraryID: string;\n\tsliceID: string;\n\thelpers: PluginSystemHelpers;\n};\n\nexport type ReadSliceModelReturnType = {\n\tmodel: TypesInternal.SharedSlice;\n};\n\nexport const readSliceModel = async (\n\targs: ReadSliceModelArgs,\n): Promise<ReadSliceModelReturnType> => {\n\tconst libraryDir = buildSliceLibraryDirectoryPath({\n\t\tlibraryID: args.libraryID,\n\t\tabsolute: true,\n\t\thelpers: args.helpers,\n\t});\n\n\tif (await checkPathExists(libraryDir)) {\n\t\tconst childDirs = await fs.readdir(libraryDir, { withFileTypes: true });\n\n\t\t/**\n\t\t * Paths to models that could not be read due to invalid JSON.\n\t\t */\n\t\tconst unreadableModelPaths: string[] = [];\n\n\t\t// Find the first matching model.\n\t\tconst models: (TypesInternal.SharedSlice | undefined)[] = await Promise.all(\n\t\t\tchildDirs.map(async (childDir) => {\n\t\t\t\tif (childDir.isDirectory()) {\n\t\t\t\t\tconst modelPath = path.join(\n\t\t\t\t\t\tlibraryDir,\n\t\t\t\t\t\tchildDir.name,\n\t\t\t\t\t\tSHARED_SLICE_MODEL_FILENAME,\n\t\t\t\t\t);\n\n\t\t\t\t\ttry {\n\t\t\t\t\t\tconst modelContents = await readJSONFile(modelPath);\n\n\t\t\t\t\t\tif (\n\t\t\t\t\t\t\tisSharedSliceModel(modelContents) &&\n\t\t\t\t\t\t\tmodelContents.id === args.sliceID\n\t\t\t\t\t\t) {\n\t\t\t\t\t\t\treturn modelContents;\n\t\t\t\t\t\t}\n\t\t\t\t\t} catch {\n\t\t\t\t\t\tunreadableModelPaths.push(modelPath);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}),\n\t\t);\n\t\tconst [model] = models.filter((model): model is TypesInternal.SharedSlice =>\n\t\t\tisSharedSliceModel(model),\n\t\t);\n\n\t\tif (model) {\n\t\t\treturn {\n\t\t\t\tmodel,\n\t\t\t};\n\t\t} else {\n\t\t\tif (unreadableModelPaths.length > 0) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t`Did not find a Slice model with ID \"${args.sliceID}\" in the \"${\n\t\t\t\t\t\targs.libraryID\n\t\t\t\t\t}\" Slice Library. The following Slice models could not be read: [${unreadableModelPaths.join(\n\t\t\t\t\t\t\", \",\n\t\t\t\t\t)}]`,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\n\tthrow new Error(\n\t\t`Did not find a Slice model with ID \"${args.sliceID}\" in the \"${args.libraryID}\" Slice Library.`,\n\t);\n};\n"],"names":["fs.readdir","model"],"mappings":";;;;;;;AAuBO,MAAM,iBAAiB,OAC7B,SACsC;AACtC,QAAM,aAAa,+BAA+B;AAAA,IACjD,WAAW,KAAK;AAAA,IAChB,UAAU;AAAA,IACV,SAAS,KAAK;AAAA,EAAA,CACd;AAED,MAAI,MAAM,gBAAgB,UAAU,GAAG;AACtC,UAAM,YAAY,MAAMA,QAAW,YAAY,EAAE,eAAe,MAAM;AAKtE,UAAM,uBAAiC,CAAA;AAGvC,UAAM,SAAoD,MAAM,QAAQ,IACvE,UAAU,IAAI,OAAO,aAAY;AAChC,UAAI,SAAS,eAAe;AAC3B,cAAM,YAAY,KAAK,KACtB,YACA,SAAS,MACT,2BAA2B;AAG5B,YAAI;AACH,gBAAM,gBAAgB,MAAM,aAAa,SAAS;AAElD,cACC,mBAAmB,aAAa,KAChC,cAAc,OAAO,KAAK,SACzB;AACD,mBAAO;AAAA,UACR;AAAA,QACD,QAAQ;AACP,+BAAqB,KAAK,SAAS;AAAA,QACpC;AAAA,MACD;AAAA,IACD,CAAC,CAAC;AAEH,UAAM,CAAC,KAAK,IAAI,OAAO,OAAO,CAACC,WAC9B,mBAAmBA,MAAK,CAAC;AAG1B,QAAI,OAAO;AACV,aAAO;AAAA,QACN;AAAA,MAAA;AAAA,IAEF,OAAO;AACN,UAAI,qBAAqB,SAAS,GAAG;AACpC,cAAM,IAAI,MACT,uCAAuC,KAAK,OAAO,aAClD,KAAK,SACN,mEAAmE,qBAAqB,KACvF,IAAI,CACJ,GAAG;AAAA,MAEN;AAAA,IACD;AAAA,EACD;AAEA,QAAM,IAAI,MACT,uCAAuC,KAAK,OAAO,aAAa,KAAK,SAAS,kBAAkB;AAElG;"}

package/dist/fs/renameCustomType.d.ts

@@ -0,0 +1,3 @@
+import { WriteCustomTypeModelArgs } from "./writeCustomTypeModel.js";
+export type RenameCustomTypeArgs = WriteCustomTypeModelArgs;
+export declare const renameCustomType: (args: RenameCustomTypeArgs) => Promise<void>;

package/dist/fs/renameCustomType.js

@@ -0,0 +1,8 @@
+import { writeCustomTypeModel } from "./writeCustomTypeModel.js";
+const renameCustomType = async (args) => {
+  await writeCustomTypeModel(args);
+};
+export {
+  renameCustomType
+};
+//# sourceMappingURL=renameCustomType.js.map

package/dist/fs/renameCustomType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renameCustomType.js","sources":["../../../src/fs/renameCustomType.ts"],"sourcesContent":["import {\n\twriteCustomTypeModel,\n\tWriteCustomTypeModelArgs,\n} from \"./writeCustomTypeModel\";\n\nexport type RenameCustomTypeArgs = WriteCustomTypeModelArgs;\n\nexport const renameCustomType = async (\n\targs: RenameCustomTypeArgs,\n): Promise<void> => {\n\tawait writeCustomTypeModel(args);\n};\n"],"names":[],"mappings":";AAOO,MAAM,mBAAmB,OAC/B,SACkB;AAClB,QAAM,qBAAqB,IAAI;AAChC;"}

package/dist/fs/renameSlice.d.ts

@@ -0,0 +1,7 @@
+import { PluginSystemActions } from "../createPluginSystemActions.js";
+import { BuildSliceDirectoryPathArgs } from "./buildSliceDirectoryPath.js";
+import { WriteSliceModelArgs } from "./writeSliceModel.js";
+export type RenameSliceArgs = {
+    actions: PluginSystemActions;
+} & Omit<BuildSliceDirectoryPathArgs, "sliceID"> & WriteSliceModelArgs;
+export declare const renameSlice: (args: RenameSliceArgs) => Promise<void>;

package/dist/fs/renameSlice.js

@@ -0,0 +1,22 @@
+import * as fse from "fs-extra";
+import { buildSliceDirectoryPath } from "./buildSliceDirectoryPath.js";
+import { writeSliceModel } from "./writeSliceModel.js";
+const renameSlice = async (args) => {
+  const { model: existingModel } = await args.actions.readSliceModel({
+    libraryID: args.libraryID,
+    sliceID: args.model.id
+  });
+  await fse.move(await buildSliceDirectoryPath({
+    ...args,
+    model: existingModel,
+    absolute: true
+  }), await buildSliceDirectoryPath({
+    ...args,
+    absolute: true
+  }));
+  await writeSliceModel(args);
+};
+export {
+  renameSlice
+};
+//# sourceMappingURL=renameSlice.js.map

package/dist/fs/renameSlice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renameSlice.js","sources":["../../../src/fs/renameSlice.ts"],"sourcesContent":["import * as fse from \"fs-extra\";\n\nimport { PluginSystemActions } from \"../createPluginSystemActions\";\n\nimport {\n\tbuildSliceDirectoryPath,\n\tBuildSliceDirectoryPathArgs,\n} from \"./buildSliceDirectoryPath\";\nimport { writeSliceModel, WriteSliceModelArgs } from \"./writeSliceModel\";\n\nexport type RenameSliceArgs = {\n\tactions: PluginSystemActions;\n} & Omit<BuildSliceDirectoryPathArgs, \"sliceID\"> &\n\tWriteSliceModelArgs;\n\nexport const renameSlice = async (args: RenameSliceArgs): Promise<void> => {\n\tconst { model: existingModel } = await args.actions.readSliceModel({\n\t\tlibraryID: args.libraryID,\n\t\tsliceID: args.model.id,\n\t});\n\n\tawait fse.move(\n\t\tawait buildSliceDirectoryPath({\n\t\t\t...args,\n\t\t\tmodel: existingModel,\n\t\t\tabsolute: true,\n\t\t}),\n\t\tawait buildSliceDirectoryPath({\n\t\t\t...args,\n\t\t\tabsolute: true,\n\t\t}),\n\t);\n\n\tawait writeSliceModel(args);\n};\n"],"names":[],"mappings":";;;AAeO,MAAM,cAAc,OAAO,SAAwC;AACzE,QAAM,EAAE,OAAO,cAAA,IAAkB,MAAM,KAAK,QAAQ,eAAe;AAAA,IAClE,WAAW,KAAK;AAAA,IAChB,SAAS,KAAK,MAAM;AAAA,EAAA,CACpB;AAED,QAAM,IAAI,KACT,MAAM,wBAAwB;AAAA,IAC7B,GAAG;AAAA,IACH,OAAO;AAAA,IACP,UAAU;AAAA,EAAA,CACV,GACD,MAAM,wBAAwB;AAAA,IAC7B,GAAG;AAAA,IACH,UAAU;AAAA,EAAA,CACV,CAAC;AAGH,QAAM,gBAAgB,IAAI;AAC3B;"}

package/dist/fs/types.d.ts

@@ -0,0 +1,3 @@
+import type * as fs from "node:fs/promises";
+export type PluginOptions = never;
+export type BufferEncoding = Extract<Parameters<typeof fs.readFile>[1], string>;

package/dist/fs/upsertGlobalTypeScriptTypes.d.ts

@@ -0,0 +1,16 @@
+import { PluginSystemActions } from "../createPluginSystemActions.js";
+import { WriteProjectFileArgs } from "./writeProjectFile.js";
+/**
+ * Arguments for `upsertGlobalContentTypes()`.
+ */
+export type UpsertGlobalTypeScriptTypesArgs = {
+    filename?: string;
+    actions: PluginSystemActions;
+} & Omit<WriteProjectFileArgs, "filename" | "contents">;
+/**
+ * Creates a globally accessible TypeScript file containing types representing
+ * the Prismic repository's content.
+ *
+ * @returns The file path to the written file.
+ */
+export declare const upsertGlobalTypeScriptTypes: (args: UpsertGlobalTypeScriptTypesArgs) => Promise<string>;

package/dist/fs/upsertGlobalTypeScriptTypes.js

@@ -0,0 +1,37 @@
+import { generateTypes, detectTypesProvider } from "prismic-ts-codegen";
+import { GLOBAL_TYPESCRIPT_TYPES_FILENAME, NON_EDITABLE_FILE_BANNER } from "./constants.js";
+import { writeProjectFile } from "./writeProjectFile.js";
+const upsertGlobalTypeScriptTypes = async (args) => {
+  const project = await args.helpers.getProject();
+  const [customTypeModelDescriptors, sharedSliceModelDescriptors] = await Promise.all([
+    args.actions.readAllCustomTypeModels(),
+    args.actions.readAllSliceModels()
+  ]);
+  const customTypeModels = customTypeModelDescriptors.map((customTypeModelDescriptors2) => {
+    return customTypeModelDescriptors2.model;
+  });
+  const sharedSliceModels = sharedSliceModelDescriptors.map((sharedSliceModelDescriptors2) => {
+    return sharedSliceModelDescriptors2.model;
+  });
+  let contents = generateTypes({
+    customTypeModels,
+    sharedSliceModels,
+    clientIntegration: {
+      includeCreateClientInterface: true,
+      includeContentNamespace: true
+    },
+    typesProvider: await detectTypesProvider({ cwd: project.root })
+  });
+  contents = `${NON_EDITABLE_FILE_BANNER}
+
+${contents}`;
+  return await writeProjectFile({
+    ...args,
+    filename: args.filename || GLOBAL_TYPESCRIPT_TYPES_FILENAME,
+    contents
+  });
+};
+export {
+  upsertGlobalTypeScriptTypes
+};
+//# sourceMappingURL=upsertGlobalTypeScriptTypes.js.map

package/dist/fs/upsertGlobalTypeScriptTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertGlobalTypeScriptTypes.js","sources":["../../../src/fs/upsertGlobalTypeScriptTypes.ts"],"sourcesContent":["import { detectTypesProvider, generateTypes } from \"prismic-ts-codegen\";\n\nimport { PluginSystemActions } from \"../createPluginSystemActions\";\n\nimport {\n\tGLOBAL_TYPESCRIPT_TYPES_FILENAME,\n\tNON_EDITABLE_FILE_BANNER,\n} from \"./constants\";\nimport { writeProjectFile, WriteProjectFileArgs } from \"./writeProjectFile\";\n\n/**\n * Arguments for `upsertGlobalContentTypes()`.\n */\nexport type UpsertGlobalTypeScriptTypesArgs = {\n\tfilename?: string;\n\tactions: PluginSystemActions;\n} & Omit<WriteProjectFileArgs, \"filename\" | \"contents\">;\n\n/**\n * Creates a globally accessible TypeScript file containing types representing\n * the Prismic repository's content.\n *\n * @returns The file path to the written file.\n */\nexport const upsertGlobalTypeScriptTypes = async (\n\targs: UpsertGlobalTypeScriptTypesArgs,\n): Promise<string> => {\n\tconst project = await args.helpers.getProject();\n\n\tconst [customTypeModelDescriptors, sharedSliceModelDescriptors] =\n\t\tawait Promise.all([\n\t\t\targs.actions.readAllCustomTypeModels(),\n\t\t\targs.actions.readAllSliceModels(),\n\t\t]);\n\n\tconst customTypeModels = customTypeModelDescriptors.map(\n\t\t(customTypeModelDescriptors) => {\n\t\t\treturn customTypeModelDescriptors.model;\n\t\t},\n\t);\n\tconst sharedSliceModels = sharedSliceModelDescriptors.map(\n\t\t(sharedSliceModelDescriptors) => {\n\t\t\treturn sharedSliceModelDescriptors.model;\n\t\t},\n\t);\n\n\tlet contents = generateTypes({\n\t\tcustomTypeModels,\n\t\tsharedSliceModels,\n\t\tclientIntegration: {\n\t\t\tincludeCreateClientInterface: true,\n\t\t\tincludeContentNamespace: true,\n\t\t},\n\t\ttypesProvider: await detectTypesProvider({ cwd: project.root }),\n\t});\n\n\tcontents = `${NON_EDITABLE_FILE_BANNER}\\n\\n${contents}`;\n\n\treturn await writeProjectFile({\n\t\t...args,\n\t\tfilename: args.filename || GLOBAL_TYPESCRIPT_TYPES_FILENAME,\n\t\tcontents,\n\t});\n};\n"],"names":["customTypeModelDescriptors","sharedSliceModelDescriptors"],"mappings":";;;AAwBO,MAAM,8BAA8B,OAC1C,SACoB;AACpB,QAAM,UAAU,MAAM,KAAK,QAAQ,WAAA;AAEnC,QAAM,CAAC,4BAA4B,2BAA2B,IAC7D,MAAM,QAAQ,IAAI;AAAA,IACjB,KAAK,QAAQ,wBAAA;AAAA,IACb,KAAK,QAAQ,mBAAA;AAAA,EAAkB,CAC/B;AAEF,QAAM,mBAAmB,2BAA2B,IACnD,CAACA,gCAA8B;AAC9B,WAAOA,4BAA2B;AAAA,EACnC,CAAC;AAEF,QAAM,oBAAoB,4BAA4B,IACrD,CAACC,iCAA+B;AAC/B,WAAOA,6BAA4B;AAAA,EACpC,CAAC;AAGF,MAAI,WAAW,cAAc;AAAA,IAC5B;AAAA,IACA;AAAA,IACA,mBAAmB;AAAA,MAClB,8BAA8B;AAAA,MAC9B,yBAAyB;AAAA,IAAA;AAAA,IAE1B,eAAe,MAAM,oBAAoB,EAAE,KAAK,QAAQ,MAAM;AAAA,EAAA,CAC9D;AAED,aAAW,GAAG,wBAAwB;AAAA;AAAA,EAAO,QAAQ;AAErD,SAAO,MAAM,iBAAiB;AAAA,IAC7B,GAAG;AAAA,IACH,UAAU,KAAK,YAAY;AAAA,IAC3B;AAAA,EAAA,CACA;AACF;"}

package/dist/fs/writeCustomTypeFile.d.ts

@@ -0,0 +1,9 @@
+import { BuildCustomTypeFilePathArgs } from "./buildCustomTypeFilePath.js";
+import { WriteProjectFileArgs } from "./writeProjectFile.js";
+export type WriteCustomTypeFileArgs = Omit<WriteProjectFileArgs, "filePath"> & BuildCustomTypeFilePathArgs;
+/**
+ * Writes a custom type model to the file system.
+ *
+ * @returns The file path to the written file.
+ */
+export declare const writeCustomTypeFile: (args: WriteCustomTypeFileArgs) => Promise<string>;

package/dist/fs/writeCustomTypeFile.js

@@ -0,0 +1,18 @@
+import { buildCustomTypeFilePath } from "./buildCustomTypeFilePath.js";
+import { writeProjectFile } from "./writeProjectFile.js";
+const writeCustomTypeFile = async (args) => {
+  const filePath = buildCustomTypeFilePath(args);
+  const relativeFilePath = buildCustomTypeFilePath({
+    ...args,
+    absolute: false
+  });
+  await writeProjectFile({
+    ...args,
+    filename: relativeFilePath
+  });
+  return filePath;
+};
+export {
+  writeCustomTypeFile
+};
+//# sourceMappingURL=writeCustomTypeFile.js.map

package/dist/fs/writeCustomTypeFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeCustomTypeFile.js","sources":["../../../src/fs/writeCustomTypeFile.ts"],"sourcesContent":["import {\n\tbuildCustomTypeFilePath,\n\tBuildCustomTypeFilePathArgs,\n} from \"./buildCustomTypeFilePath\";\nimport { writeProjectFile, WriteProjectFileArgs } from \"./writeProjectFile\";\n\nexport type WriteCustomTypeFileArgs = Omit<WriteProjectFileArgs, \"filePath\"> &\n\tBuildCustomTypeFilePathArgs;\n\n/**\n * Writes a custom type model to the file system.\n *\n * @returns The file path to the written file.\n */\nexport const writeCustomTypeFile = async (\n\targs: WriteCustomTypeFileArgs,\n): Promise<string> => {\n\tconst filePath = buildCustomTypeFilePath(args);\n\tconst relativeFilePath = buildCustomTypeFilePath({\n\t\t...args,\n\t\tabsolute: false,\n\t});\n\n\tawait writeProjectFile({\n\t\t...args,\n\t\tfilename: relativeFilePath,\n\t});\n\n\treturn filePath;\n};\n"],"names":[],"mappings":";;AAcO,MAAM,sBAAsB,OAClC,SACoB;AACpB,QAAM,WAAW,wBAAwB,IAAI;AAC7C,QAAM,mBAAmB,wBAAwB;AAAA,IAChD,GAAG;AAAA,IACH,UAAU;AAAA,EAAA,CACV;AAED,QAAM,iBAAiB;AAAA,IACtB,GAAG;AAAA,IACH,UAAU;AAAA,EAAA,CACV;AAED,SAAO;AACR;"}

package/dist/fs/writeCustomTypeModel.d.ts

@@ -0,0 +1,12 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import { WriteCustomTypeFileArgs } from "./writeCustomTypeFile.js";
+export type WriteCustomTypeModelArgs = Omit<WriteCustomTypeFileArgs, "customTypeID" | "filename" | "contents"> & {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Writes a CustomType model to the file system in the CustomType's CustomType
+ * library.
+ *
+ * @returns The file path to the written model.
+ */
+export declare const writeCustomTypeModel: (args: WriteCustomTypeModelArgs) => Promise<string>;

package/dist/fs/writeCustomTypeModel.js

@@ -0,0 +1,14 @@
+import { CUSTOM_TYPE_MODEL_FILENAME } from "./constants.js";
+import { writeCustomTypeFile } from "./writeCustomTypeFile.js";
+const writeCustomTypeModel = async (args) => {
+  return await writeCustomTypeFile({
+    ...args,
+    customTypeID: args.model.id,
+    filename: CUSTOM_TYPE_MODEL_FILENAME,
+    contents: JSON.stringify(args.model, null, 2)
+  });
+};
+export {
+  writeCustomTypeModel
+};
+//# sourceMappingURL=writeCustomTypeModel.js.map

package/dist/fs/writeCustomTypeModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeCustomTypeModel.js","sources":["../../../src/fs/writeCustomTypeModel.ts"],"sourcesContent":["import TypesInternal from \"@prismicio/types-internal/lib/customtypes/index.js\";\n\nimport { CUSTOM_TYPE_MODEL_FILENAME } from \"./constants\";\nimport {\n\twriteCustomTypeFile,\n\tWriteCustomTypeFileArgs,\n} from \"./writeCustomTypeFile\";\n\nexport type WriteCustomTypeModelArgs = Omit<\n\tWriteCustomTypeFileArgs,\n\t\"customTypeID\" | \"filename\" | \"contents\"\n> & {\n\tmodel: TypesInternal.CustomType;\n};\n\n/**\n * Writes a CustomType model to the file system in the CustomType's CustomType\n * library.\n *\n * @returns The file path to the written model.\n */\nexport const writeCustomTypeModel = async (\n\targs: WriteCustomTypeModelArgs,\n): Promise<string> => {\n\treturn await writeCustomTypeFile({\n\t\t...args,\n\t\tcustomTypeID: args.model.id,\n\t\tfilename: CUSTOM_TYPE_MODEL_FILENAME,\n\t\tcontents: JSON.stringify(args.model, null, 2),\n\t});\n};\n"],"names":[],"mappings":";;AAqBO,MAAM,uBAAuB,OACnC,SACoB;AACpB,SAAO,MAAM,oBAAoB;AAAA,IAChC,GAAG;AAAA,IACH,cAAc,KAAK,MAAM;AAAA,IACzB,UAAU;AAAA,IACV,UAAU,KAAK,UAAU,KAAK,OAAO,MAAM,CAAC;AAAA,EAAA,CAC5C;AACF;"}

package/dist/fs/writeProjectFile.d.ts

@@ -0,0 +1,15 @@
+import { PluginSystemHelpers } from "../createPluginSystemHelpers.js";
+import * as fs from "./lib/fsLimit.js";
+export type WriteProjectFileArgs = {
+    filename: string;
+    contents: Parameters<typeof fs.writeFile>[1];
+    format?: boolean;
+    formatOptions?: Parameters<PluginSystemHelpers["format"]>[2];
+    helpers: PluginSystemHelpers;
+};
+/**
+ * Writes a file to the project with optional formatting.
+ *
+ * @returns The file path to the written file.
+ */
+export declare const writeProjectFile: (args: WriteProjectFileArgs) => Promise<string>;

package/dist/fs/writeProjectFile.js

@@ -0,0 +1,16 @@
+import * as path from "node:path";
+import { mkdir, writeFile } from "./lib/fsLimit.js";
+const writeProjectFile = async (args) => {
+  const filePath = args.helpers.joinPathFromRoot(args.filename);
+  let contents = args.contents;
+  if (args.format) {
+    contents = await args.helpers.format(contents.toString(), filePath, args.formatOptions);
+  }
+  await mkdir(path.dirname(filePath), { recursive: true });
+  await writeFile(filePath, contents);
+  return filePath;
+};
+export {
+  writeProjectFile
+};
+//# sourceMappingURL=writeProjectFile.js.map

package/dist/fs/writeProjectFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeProjectFile.js","sources":["../../../src/fs/writeProjectFile.ts"],"sourcesContent":["import * as path from \"node:path\";\n\nimport { PluginSystemHelpers } from \"../createPluginSystemHelpers\";\n\nimport * as fs from \"./lib/fsLimit\";\n\nexport type WriteProjectFileArgs = {\n\tfilename: string;\n\tcontents: Parameters<typeof fs.writeFile>[1];\n\tformat?: boolean;\n\tformatOptions?: Parameters<PluginSystemHelpers[\"format\"]>[2];\n\thelpers: PluginSystemHelpers;\n};\n\n/**\n * Writes a file to the project with optional formatting.\n *\n * @returns The file path to the written file.\n */\nexport const writeProjectFile = async (\n\targs: WriteProjectFileArgs,\n): Promise<string> => {\n\tconst filePath = args.helpers.joinPathFromRoot(args.filename);\n\n\tlet contents = args.contents;\n\n\tif (args.format) {\n\t\tcontents = await args.helpers.format(\n\t\t\tcontents.toString(),\n\t\t\tfilePath,\n\t\t\targs.formatOptions,\n\t\t);\n\t}\n\n\tawait fs.mkdir(path.dirname(filePath), { recursive: true });\n\tawait fs.writeFile(filePath, contents);\n\n\treturn filePath;\n};\n"],"names":["fs.mkdir","fs.writeFile"],"mappings":";;AAmBO,MAAM,mBAAmB,OAC/B,SACoB;AACpB,QAAM,WAAW,KAAK,QAAQ,iBAAiB,KAAK,QAAQ;AAE5D,MAAI,WAAW,KAAK;AAEpB,MAAI,KAAK,QAAQ;AAChB,eAAW,MAAM,KAAK,QAAQ,OAC7B,SAAS,YACT,UACA,KAAK,aAAa;AAAA,EAEpB;AAEA,QAAMA,MAAS,KAAK,QAAQ,QAAQ,GAAG,EAAE,WAAW,MAAM;AAC1D,QAAMC,UAAa,UAAU,QAAQ;AAErC,SAAO;AACR;"}

package/dist/fs/writeSliceFile.d.ts

@@ -0,0 +1,9 @@
+import { BuildSliceFilePathArgs } from "./buildSliceFilePath.js";
+import { WriteProjectFileArgs } from "./writeProjectFile.js";
+export type WriteSliceFileArgs = Omit<WriteProjectFileArgs, "filePath"> & BuildSliceFilePathArgs;
+/**
+ * Writes a Slice model to the file system in the Slice's Slice library.
+ *
+ * @returns The file path to the written file.
+ */
+export declare const writeSliceFile: (args: WriteSliceFileArgs) => Promise<string>;

package/dist/fs/writeSliceFile.js

@@ -0,0 +1,18 @@
+import { buildSliceFilePath } from "./buildSliceFilePath.js";
+import { writeProjectFile } from "./writeProjectFile.js";
+const writeSliceFile = async (args) => {
+  const filePath = await buildSliceFilePath(args);
+  const relativeFilePath = await buildSliceFilePath({
+    ...args,
+    absolute: false
+  });
+  await writeProjectFile({
+    ...args,
+    filename: relativeFilePath
+  });
+  return filePath;
+};
+export {
+  writeSliceFile
+};
+//# sourceMappingURL=writeSliceFile.js.map

package/dist/fs/writeSliceFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeSliceFile.js","sources":["../../../src/fs/writeSliceFile.ts"],"sourcesContent":["import {\n\tbuildSliceFilePath,\n\tBuildSliceFilePathArgs,\n} from \"./buildSliceFilePath\";\nimport { writeProjectFile, WriteProjectFileArgs } from \"./writeProjectFile\";\n\nexport type WriteSliceFileArgs = Omit<WriteProjectFileArgs, \"filePath\"> &\n\tBuildSliceFilePathArgs;\n\n/**\n * Writes a Slice model to the file system in the Slice's Slice library.\n *\n * @returns The file path to the written file.\n */\nexport const writeSliceFile = async (\n\targs: WriteSliceFileArgs,\n): Promise<string> => {\n\tconst filePath = await buildSliceFilePath(args);\n\tconst relativeFilePath = await buildSliceFilePath({\n\t\t...args,\n\t\tabsolute: false,\n\t});\n\n\tawait writeProjectFile({\n\t\t...args,\n\t\tfilename: relativeFilePath,\n\t});\n\n\treturn filePath;\n};\n"],"names":[],"mappings":";;AAcO,MAAM,iBAAiB,OAC7B,SACoB;AACpB,QAAM,WAAW,MAAM,mBAAmB,IAAI;AAC9C,QAAM,mBAAmB,MAAM,mBAAmB;AAAA,IACjD,GAAG;AAAA,IACH,UAAU;AAAA,EAAA,CACV;AAED,QAAM,iBAAiB;AAAA,IACtB,GAAG;AAAA,IACH,UAAU;AAAA,EAAA,CACV;AAED,SAAO;AACR;"}

package/dist/fs/writeSliceModel.d.ts

@@ -0,0 +1,11 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import { WriteSliceFileArgs } from "./writeSliceFile.js";
+export type WriteSliceModelArgs = Omit<WriteSliceFileArgs, "filename" | "contents" | "sliceID"> & {
+    model: TypesInternal.SharedSlice;
+};
+/**
+ * Writes a Slice model to the file system in the Slice's Slice library.
+ *
+ * @returns The file path to the written model.
+ */
+export declare const writeSliceModel: (args: WriteSliceModelArgs) => Promise<string>;

package/dist/fs/writeSliceModel.js

@@ -0,0 +1,13 @@
+import { SHARED_SLICE_MODEL_FILENAME } from "./constants.js";
+import { writeSliceFile } from "./writeSliceFile.js";
+const writeSliceModel = async (args) => {
+  return await writeSliceFile({
+    ...args,
+    filename: SHARED_SLICE_MODEL_FILENAME,
+    contents: JSON.stringify(args.model, null, 2)
+  });
+};
+export {
+  writeSliceModel
+};
+//# sourceMappingURL=writeSliceModel.js.map

package/dist/fs/writeSliceModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeSliceModel.js","sources":["../../../src/fs/writeSliceModel.ts"],"sourcesContent":["import TypesInternal from \"@prismicio/types-internal/lib/customtypes/index.js\";\n\nimport { SHARED_SLICE_MODEL_FILENAME } from \"./constants\";\nimport { writeSliceFile, WriteSliceFileArgs } from \"./writeSliceFile\";\n\nexport type WriteSliceModelArgs = Omit<\n\tWriteSliceFileArgs,\n\t\"filename\" | \"contents\" | \"sliceID\"\n> & {\n\tmodel: TypesInternal.SharedSlice;\n};\n\n/**\n * Writes a Slice model to the file system in the Slice's Slice library.\n *\n * @returns The file path to the written model.\n */\nexport const writeSliceModel = async (\n\targs: WriteSliceModelArgs,\n): Promise<string> => {\n\treturn await writeSliceFile({\n\t\t...args,\n\t\tfilename: SHARED_SLICE_MODEL_FILENAME,\n\t\tcontents: JSON.stringify(args.model, null, 2),\n\t});\n};\n"],"names":[],"mappings":";;AAiBO,MAAM,kBAAkB,OAC9B,SACoB;AACpB,SAAO,MAAM,eAAe;AAAA,IAC3B,GAAG;AAAA,IACH,UAAU;AAAA,IACV,UAAU,KAAK,UAAU,KAAK,OAAO,MAAM,CAAC;AAAA,EAAA,CAC5C;AACF;"}

package/dist/hooks/customType-create.d.ts

@@ -0,0 +1,28 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type:create` hook handlers.
+ */
+export type CustomTypeCreateHookData = {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Return value for `custom-type:create` hook handlers.
+ */
+export type CustomTypeCreateHookReturnType = void;
+/**
+ * Base version of `custom-type:create` without plugin runner context.
+ *
+ * @internal
+ */
+export type CustomTypeCreateHookBase = PluginHook<CustomTypeCreateHookData, CustomTypeCreateHookReturnType>;
+/**
+ * Handler for the `custom-type:create` hook. The hook is called when a Custom
+ * Type is created.
+ *
+ * `custom-type:create` is only called the first time a Custom Type is saved.
+ * Subsequent saves will call the `custom-type:update` hook.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeCreateHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeCreateHookBase, TPluginOptions>;

package/dist/hooks/customType-delete.d.ts

@@ -0,0 +1,26 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type:delete` hook handlers.
+ */
+export type CustomTypeDeleteHookData = {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Return value for `custom-type:delete` hook handlers.
+ */
+export type CustomTypeDeleteHookReturnType = void;
+/**
+ * Base version of a `custom-type:delete` hook handler without plugin runner
+ * context.
+ *
+ * @internal
+ */
+export type CustomTypeDeleteHookBase = PluginHook<CustomTypeDeleteHookData, CustomTypeDeleteHookReturnType>;
+/**
+ * Handler for the `custom-type:delete` hook. The hook is called when a Custom
+ * Type is deleted.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeDeleteHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeDeleteHookBase, TPluginOptions>;

package/dist/hooks/customType-read.d.ts

@@ -0,0 +1,32 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type:read` hook handlers.
+ */
+export type CustomTypeReadHookData = {
+    id: string;
+};
+/**
+ * Return value for `custom-type:read` hook handlers.
+ */
+export type CustomTypeReadHookReturnType = {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Base version of a `custom-type:read` hook handler without plugin runner
+ * context.
+ *
+ * @internal
+ */
+export type CustomTypeReadHookBase = PluginHook<CustomTypeReadHookData, CustomTypeReadHookReturnType>;
+/**
+ * Handler for the `custom-type:read` hook. The hook is called when a Custom
+ * Type's model is needed.
+ *
+ * This hook is **required** to be implemented by adapters.
+ *
+ * This hook will only be called in adapters.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeReadHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeReadHookBase, TPluginOptions>;

package/dist/hooks/customType-rename.d.ts

@@ -0,0 +1,29 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type:rename` hook handlers.
+ */
+export type CustomTypeRenameHookData = {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Return value for `custom-type:rename` hook handlers.
+ */
+export type CustomTypeRenameHookReturnType = void;
+/**
+ * Base version of a `custom-type:rename` hook handler without plugin runner
+ * context.
+ *
+ * @internal
+ */
+export type CustomTypeRenameHookBase = PluginHook<CustomTypeRenameHookData, CustomTypeRenameHookReturnType>;
+/**
+ * Handler for the `custom-type:rename` hook. The hook is called when a Custom
+ * Type is renamed.
+ *
+ * `custom-type:rename` is not called the first time a Custom Type is saved. The
+ * `custom-type:create` hook is called instead.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeRenameHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeRenameHookBase, TPluginOptions>;

package/dist/hooks/customType-update.d.ts

@@ -0,0 +1,29 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type:update` hook handlers.
+ */
+export type CustomTypeUpdateHookData = {
+    model: TypesInternal.CustomType;
+};
+/**
+ * Return value for `custom-type:update` hook handlers.
+ */
+export type CustomTypeUpdateHookReturnType = void;
+/**
+ * Base version of a `custom-type:update` hook handler without plugin runner
+ * context.
+ *
+ * @internal
+ */
+export type CustomTypeUpdateHookBase = PluginHook<CustomTypeUpdateHookData, CustomTypeUpdateHookReturnType>;
+/**
+ * Handler for the `custom-type:update` hook. The hook is called when a Custom
+ * Type is updated.
+ *
+ * `custom-type:update` is not called the first time a Custom Type is saved. The
+ * `custom-type:create` hook is called instead.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeUpdateHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeUpdateHookBase, TPluginOptions>;

package/dist/hooks/customTypeLibrary-read.d.ts

@@ -0,0 +1,25 @@
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `custom-type-library:read` hook handlers.
+ */
+export type CustomTypeLibraryReadHookData = undefined;
+/**
+ * Return value for `custom-type-library:read` hook handlers.
+ */
+export type CustomTypeLibraryReadHookReturnType = {
+    ids: string[];
+};
+/**
+ * Base version of a `custom-type-library:read` hook handler without plugin
+ * runner context.
+ *
+ * @internal
+ */
+export type CustomTypeLibraryReadHookBase = PluginHook<CustomTypeLibraryReadHookData, CustomTypeLibraryReadHookReturnType>;
+/**
+ * Handler for the `custom-type-library:read` hook. The hook is called when a
+ * Custom Type Library's metadata is needed.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type CustomTypeLibraryReadHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<CustomTypeLibraryReadHookBase, TPluginOptions>;

package/dist/hooks/debug.d.ts

@@ -0,0 +1,22 @@
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `debug` hook handlers.
+ */
+export type DebugHookData = unknown;
+/**
+ * Return value for `debug` hook handlers.
+ */
+export type DebugHookReturnType = unknown;
+/**
+ * Base version of a `debug` hook handler without plugin runner context.
+ *
+ * @internal
+ */
+export type DebugHookBase = PluginHook<DebugHookData, DebugHookReturnType>;
+/**
+ * Handler for the `debug` hook. This hook is never called in a production app.
+ * It can be used for testing purposes.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type DebugHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<DebugHookBase, TPluginOptions>;

package/dist/hooks/project-init.d.ts

@@ -0,0 +1,35 @@
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `project:init` hook handlers.
+ */
+export type ProjectInitHookData = {
+    /**
+     * Log messages. The message may be sent to the console or elsewhere.
+     */
+    log: (message: string) => void;
+    /**
+     * Install package dependencies. The correct package manager will
+     * automatically be used (npm/Yarn/pnpm/etc.).
+     */
+    installDependencies: (args: {
+        dependencies: Record<string, string>;
+        dev?: boolean;
+    }) => Promise<void>;
+};
+/**
+ * Return value for `project:init` hook handlers.
+ */
+export type ProjectInitHookReturnType = void;
+/**
+ * Base version of `project:init` without plugin runner context.
+ *
+ * @internal
+ */
+export type ProjectInitHookBase = PluginHook<ProjectInitHookData, ProjectInitHookReturnType>;
+/**
+ * Handler for the `project:init` hook. The hook is called during the init
+ * Project for plugins to init
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type ProjectInitHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<ProjectInitHookBase, TPluginOptions>;

package/dist/hooks/slice-create.d.ts

@@ -0,0 +1,30 @@
+import TypesInternal from "@prismicio/types-internal/lib/customtypes/index.js";
+import type { ExtendPluginSystemHook, PluginOptions, PluginHook } from "../types.js";
+/**
+ * Data provided to `slice:create` hook handlers.
+ */
+export type SliceCreateHookData = {
+    libraryID: string;
+    model: TypesInternal.SharedSlice;
+    componentContents?: string;
+};
+/**
+ * Return value for `slice:create` hook handlers.
+ */
+export type SliceCreateHookReturnType = void;
+/**
+ * Base version of `slice:create` without plugin runner context.
+ *
+ * @internal
+ */
+export type SliceCreateHookBase = PluginHook<SliceCreateHookData, SliceCreateHookReturnType>;
+/**
+ * Handler for the `slice:create` hook. The hook is called when a Slice is
+ * created.
+ *
+ * `slice:create` is only called the first time a Slice is saved. Subsequent
+ * saves will call the `slice:update` hook.
+ *
+ * @typeParam TPluginOptions - User-provided options for the hook's plugin.
+ */
+export type SliceCreateHook<TPluginOptions extends PluginOptions = PluginOptions> = ExtendPluginSystemHook<SliceCreateHookBase, TPluginOptions>;