@prismicio/e2e-tests-utils 1.18.0 → 1.19.0-canary.d349d21

package/dist/clients/coreApi.cjs

@@ -1,146 +1,155 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const log = require("../utils/log.cjs");
-const apiClient = require("./apiClient.cjs");
-class CoreApiClient extends apiClient.AuthenticatedApiClient {
-  /**
-   * @example To instantiate the class:
-   *
-   * ```js
-   * new CoreApiClient("https://my-repo.prismic.io", {
-   * 	authToken: "my-secret-token",
-   * });
-   * ```
-   *
-   * @param baseURL - the api base URL like https://my-repo.prismic.io
-   * @param config - Optional configuration
-   *
-   *   - {@link config.authToken}: Api token generated from the auth service or a
-   *       function to fetch it when it's needed.
-   */
-  constructor(baseURL, config) {
-    super(baseURL, config);
-  }
-  async getLanguages() {
-    const profiler = log.logger.startTimer();
-    const context = await this.getContext();
-    const result = await context.get("core/repository");
-    if (200 !== result.status() || !(await result.json()).languages) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not get languages from the core api.");
-    }
-    profiler.done({ message: "retrieved languages configuration" });
-    return (await result.json()).languages;
-  }
-  /**
-   * Retrieves all releases, including the migration release.
-   *
-   * @returns An array of release metadata.
-   */
-  async getReleases() {
-    const profiler = log.logger.startTimer();
-    const context = await this.getContext();
-    const result = await context.get("core/releases", {
-      params: { include_migration_releases: true }
-    });
-    if (200 !== result.status() || !(await result.json()).results) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not get releases from the core api.");
-    }
-    profiler.done({ message: "retrieved releases" });
-    return (await result.json()).results;
-  }
-  async createDraft(data) {
-    const context = await this.getContext();
-    const result = await context.post("core/documents", {
-      data
-    });
-    if (201 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not create draft document");
-    }
-    return result.json();
-  }
-  async publishDraft(documentId) {
-    const context = await this.getContext();
-    const result = await context.patch(`core/documents/${documentId}/draft`, {
-      data: {
-        status: "published"
-      }
-    });
-    if (204 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error(`Could not publish document with id ${documentId}`);
-    }
-  }
-  /**
-   * Retrieves documents.
-   *
-   * @param args - Configure which documents are retrieved.
-   *
-   * @returns A paginated set of documents.
-   */
-  async getDocuments(args) {
-    const context = await this.getContext();
-    const result = await context.post("core/documents/search", {
-      data: args
-    });
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not search documents");
-    }
-    return result.json();
-  }
-  /**
-   * Retrieves data for a specific document version.
-   *
-   * @param versionId - The document's version ID.
-   *
-   * @returns The document's version data.
-   */
-  async getDocumentData(versionId) {
-    const context = await this.getContext();
-    const result = await context.get(`core/documents/data/${versionId}`);
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not retrieve document data");
-    }
-    return result.json();
-  }
-  /**
-   * Publishes a release.
-   *
-   * @param id - The ID of the release.
-   *
-   * @returns A Promise that resolves when the release is published.
-   */
-  async publishRelease(id) {
-    const context = await this.getContext();
-    const result = await context.post(`core/releases/${id}/publish`);
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not publish release ${id}");
-    }
-  }
-  async getRepository() {
-    const context = await this.getContext();
-    const result = await context.get(`core/repository`);
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error(`Could not get repository`);
-    }
-    return result.json();
-  }
-  async updateRepository(data) {
-    const context = await this.getContext();
-    const result = await context.patch(`core/repository`, {
-      data
-    });
-    if (204 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error(`Could not update repository`);
-    }
-  }
-}
+const require_log = require("../utils/log.cjs");
+const require_apiClient = require("./apiClient.cjs");
+//#region src/clients/coreApi.ts
+var CoreApiClient = class extends require_apiClient.AuthenticatedApiClient {
+	/**
+	* @example
+	* 	To instantiate the class:
+	*
+	* 	```js
+	* 	new CoreApiClient("https://my-repo.prismic.io", {
+	* 	authToken: "my-secret-token",
+	* 	});
+	* 	```
+	*
+	* @param baseURL - The api base URL like https://my-repo.prismic.io
+	* @param config - Optional configuration
+	*
+	*   - {@link config.authToken}: Api token generated from the auth service or a function to fetch it
+	*     when it's needed.
+	*/
+	constructor(baseURL, config) {
+		super(baseURL, config);
+	}
+	async getLanguages() {
+		const profiler = require_log.logger.startTimer();
+		const result = await (await this.getContext()).get("core/repository");
+		if (200 !== result.status() || !(await result.json()).languages) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not get languages from the core api.");
+		}
+		profiler.done({ message: "retrieved languages configuration" });
+		return (await result.json()).languages;
+	}
+	/**
+	* Retrieves all releases, including the migration release.
+	*
+	* @returns An array of release metadata.
+	*/
+	async getReleases() {
+		const profiler = require_log.logger.startTimer();
+		const result = await (await this.getContext()).get("core/releases", { params: { include_migration_releases: true } });
+		if (200 !== result.status() || !(await result.json()).results) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not get releases from the core api.");
+		}
+		profiler.done({ message: "retrieved releases" });
+		return (await result.json()).results;
+	}
+	async createDraft(data) {
+		const result = await (await this.getContext()).post("core/documents", { data });
+		if (201 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not create draft document");
+		}
+		return result.json();
+	}
+	/**
+	* Creates a new draft version of an existing document, on top of the given base version.
+	*
+	* @param documentId - The id of the document to update.
+	* @param data - The new version payload in the core api format.
+	* @param baseVersionId - The id of the version the draft is created from.
+	* @returns The updated document, including the new version's id.
+	*/
+	async updateDraft(documentId, data, baseVersionId) {
+		const result = await (await this.getContext()).put(`core/documents/${documentId}/draft`, {
+			params: { base_version_id: baseVersionId },
+			data
+		});
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error(`Could not update draft for document with id ${documentId}`);
+		}
+		return result.json();
+	}
+	async publishDraft(documentId) {
+		const result = await (await this.getContext()).patch(`core/documents/${documentId}/draft`, { data: { status: "published" } });
+		if (204 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error(`Could not publish document with id ${documentId}`);
+		}
+	}
+	/**
+	* Unpublishes (archives) a live document.
+	*
+	* @param documentId - The id of the document to unpublish.
+	*/
+	async unpublishDocument(documentId) {
+		const result = await (await this.getContext()).patch(`core/documents/${documentId}/live`, { data: { status: "archived" } });
+		if (204 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error(`Could not unpublish document with id ${documentId}`);
+		}
+	}
+	/**
+	* Retrieves documents.
+	*
+	* @param args - Configure which documents are retrieved.
+	* @returns A paginated set of documents.
+	*/
+	async getDocuments(args) {
+		const result = await (await this.getContext()).post("core/documents/search", { data: args });
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not search documents");
+		}
+		return result.json();
+	}
+	/**
+	* Retrieves data for a specific document version.
+	*
+	* @param versionId - The document's version ID.
+	* @returns The document's version data.
+	*/
+	async getDocumentData(versionId) {
+		const result = await (await this.getContext()).get(`core/documents/data/${versionId}`);
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not retrieve document data");
+		}
+		return result.json();
+	}
+	/**
+	* Publishes a release.
+	*
+	* @param id - The ID of the release.
+	* @returns A Promise that resolves when the release is published.
+	*/
+	async publishRelease(id) {
+		const result = await (await this.getContext()).post(`core/releases/${id}/publish`);
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not publish release ${id}");
+		}
+	}
+	async getRepository() {
+		const result = await (await this.getContext()).get(`core/repository`);
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error(`Could not get repository`);
+		}
+		return result.json();
+	}
+	async updateRepository(data) {
+		const result = await (await this.getContext()).patch(`core/repository`, { data });
+		if (204 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error(`Could not update repository`);
+		}
+	}
+};
+//#endregion
 exports.CoreApiClient = CoreApiClient;
-//# sourceMappingURL=coreApi.cjs.map
+
+//# sourceMappingURL=coreApi.cjs.map

package/dist/clients/coreApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"coreApi.cjs","sources":["../../../src/clients/coreApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\ntype Language = {\n\tid: string;\n\tname: string;\n\tis_master: boolean;\n};\n\nexport type Release = {\n\tid: string;\n\tlabel: string;\n\tmigration: boolean;\n};\n\nexport type CoreApiDocumentCreationPayload = {\n\ttitle: string;\n\tlocale?: string;\n\tgroup_lang_id?: string;\n\trelease_id?: string;\n\tintegration_field_ids: string[];\n\tdata: Record<string, unknown>;\n\tcustom_type_id: string;\n\ttags: string[];\n};\n\nexport type CoreApiRepository = Record<string, unknown> & {\n\tsimulator_url?: string;\n};\n\nexport type CoreApiDocumentCreationResponse = {\n\tid: string;\n\tgroup_lang_id: string;\n\tcustom_type_id: string;\n\tlocale: string;\n\tlanguage: { id: string; name: string };\n\tfirst_publication_date: number | null;\n\tlast_publication_date: number | null;\n\ttitle: string;\n\tversions: {\n\t\tstatus: string;\n\t\tversion_id: string;\n\t\tauthor: {\n\t\t\tid: string;\n\t\t\tfirst_name: string | null;\n\t\t\tlast_name: string | null;\n\t\t\temail: string;\n\t\t};\n\t\trelease_id: string | null;\n\t\tlast_modified_date: number;\n\t\ttags: string[];\n\t\tcustom_type_label: string;\n\t\tpreview_summary?: string;\n\t\tpreview_image?: string;\n\t\tuid?: string;\n\t}[];\n};\n\nexport type CoreApiDocumentsPayload = {\n\tlanguage?: string;\n\tlimit?: number;\n\tstatuses?: string[];\n\tgroupLangIds?: string[];\n};\n\nexport type CoreApiDocumentsResponse = {\n\ttotal: number;\n\tcursor: string;\n\tresults: CoreApiDocumentCreationResponse[];\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CoreApiDocumentData = Record<string, any>;\n\nexport class CoreApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new CoreApiClient(\"https://my-repo.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - the api base URL like https://my-repo.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: Api token generated from the auth service or a\n\t *       function to fetch it when it's needed.\n\t */\n\tconstructor(baseURL: string, config: AuthServerToken) {\n\t\tsuper(baseURL, config);\n\t}\n\n\tasync getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"core/repository\");\n\n\t\tif (200 !== result.status() || !(await result.json()).languages) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get languages from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" });\n\n\t\treturn (await result.json()).languages;\n\t}\n\n\t/**\n\t * Retrieves all releases, including the migration release.\n\t *\n\t * @returns An array of release metadata.\n\t */\n\tasync getReleases(): Promise<Release[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"core/releases\", {\n\t\t\tparams: { include_migration_releases: true },\n\t\t});\n\n\t\tif (200 !== result.status() || !(await result.json()).results) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get releases from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved releases\" });\n\n\t\treturn (await result.json()).results;\n\t}\n\n\tasync createDraft(\n\t\tdata: CoreApiDocumentCreationPayload,\n\t): Promise<CoreApiDocumentCreationResponse> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"core/documents\", {\n\t\t\tdata,\n\t\t});\n\n\t\tif (201 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not create draft document\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\tasync publishDraft(documentId: string): Promise<void> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.patch(`core/documents/${documentId}/draft`, {\n\t\t\tdata: {\n\t\t\t\tstatus: \"published\",\n\t\t\t},\n\t\t});\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`);\n\t\t}\n\t}\n\n\t/**\n\t * Retrieves documents.\n\t *\n\t * @param args - Configure which documents are retrieved.\n\t *\n\t * @returns A paginated set of documents.\n\t */\n\tasync getDocuments(\n\t\targs: CoreApiDocumentsPayload,\n\t): Promise<CoreApiDocumentsResponse> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"core/documents/search\", {\n\t\t\tdata: args,\n\t\t});\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not search documents\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\t/**\n\t * Retrieves data for a specific document version.\n\t *\n\t * @param versionId - The document's version ID.\n\t *\n\t * @returns The document's version data.\n\t */\n\tasync getDocumentData(versionId: string): Promise<CoreApiDocumentData> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(`core/documents/data/${versionId}`);\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not retrieve document data\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\t/**\n\t * Publishes a release.\n\t *\n\t * @param id - The ID of the release.\n\t *\n\t * @returns A Promise that resolves when the release is published.\n\t */\n\tasync publishRelease(id: string): Promise<void> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(`core/releases/${id}/publish`);\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not publish release ${id}\");\n\t\t}\n\t}\n\n\tasync getRepository(): Promise<CoreApiRepository> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(`core/repository`);\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not get repository`);\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\tasync updateRepository(data: CoreApiRepository): Promise<void> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.patch(`core/repository`, {\n\t\t\tdata,\n\t\t});\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not update repository`);\n\t\t}\n\t}\n}\n"],"names":["AuthenticatedApiClient","logger","logPlaywrightApiResponse"],"mappings":";;;;AA2EM,MAAO,sBAAsBA,UAAAA,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBxD,YAAY,SAAiB,QAAuB;AACnD,UAAM,SAAS,MAAM;AAAA,EACtB;AAAA,EAEA,MAAM,eAAY;AACX,UAAA,WAAWC,WAAO;AAClB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,iBAAiB;AAE9C,QAAA,QAAQ,OAAO,OAAM,KAAM,EAAE,MAAM,OAAO,KAAI,GAAI,WAAW;AAChE,YAAMC,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,4CAA4C;AAAA,IAC7D;AAEA,aAAS,KAAK,EAAE,SAAS,oCAAqC,CAAA;AAEtD,YAAA,MAAM,OAAO,KAAA,GAAQ;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAW;AACV,UAAA,WAAWD,WAAO;AAClB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,iBAAiB;AAAA,MACjD,QAAQ,EAAE,4BAA4B,KAAM;AAAA,IAAA,CAC5C;AAEG,QAAA,QAAQ,OAAO,OAAM,KAAM,EAAE,MAAM,OAAO,KAAI,GAAI,SAAS;AAC9D,YAAMC,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,2CAA2C;AAAA,IAC5D;AAEA,aAAS,KAAK,EAAE,SAAS,qBAAsB,CAAA;AAEvC,YAAA,MAAM,OAAO,KAAA,GAAQ;AAAA,EAC9B;AAAA,EAEA,MAAM,YACL,MAAoC;AAE9B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,kBAAkB;AAAA,MACnD;AAAA,IAAA,CACA;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,iCAAiC;AAAA,IAClD;AAEA,WAAO,OAAO;EACf;AAAA,EAEA,MAAM,aAAa,YAAkB;AAC9B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,MAAM,kBAAkB,UAAU,UAAU;AAAA,MACxE,MAAM;AAAA,QACL,QAAQ;AAAA,MACR;AAAA,IAAA,CACD;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AACrC,YAAM,IAAI,MAAM,sCAAsC,UAAU,EAAE;AAAA,IACnE;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aACL,MAA6B;AAEvB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,yBAAyB;AAAA,MAC1D,MAAM;AAAA,IAAA,CACN;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,4BAA4B;AAAA,IAC7C;AAEA,WAAO,OAAO;EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,WAAiB;AAChC,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,uBAAuB,SAAS,EAAE;AAE/D,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,kCAAkC;AAAA,IACnD;AAEA,WAAO,OAAO;EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eAAe,IAAU;AACxB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,iBAAiB,EAAE,UAAU;AAE3D,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,iCAAiC;AAAA,IAClD;AAAA,EACD;AAAA,EAEA,MAAM,gBAAa;AACZ,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,iBAAiB;AAE9C,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,0BAA0B;AAAA,IAC3C;AAEA,WAAO,OAAO;EACf;AAAA,EAEA,MAAM,iBAAiB,MAAuB;AACvC,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,MAAM,mBAAmB;AAAA,MACrD;AAAA,IAAA,CACA;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,6BAA6B;AAAA,IAC9C;AAAA,EACD;AACA;;"}
+{"version":3,"file":"coreApi.cjs","names":["AuthenticatedApiClient","logger","logPlaywrightApiResponse"],"sources":["../../src/clients/coreApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse, logger } from \"../utils/log\"\nimport type { AuthServerToken } from \"./apiClient\"\nimport { AuthenticatedApiClient } from \"./apiClient\"\n\ntype Language = {\n\tid: string\n\tname: string\n\tis_master: boolean\n}\n\nexport type Release = {\n\tid: string\n\tlabel: string\n\tmigration: boolean\n}\n\nexport type CoreApiDocumentCreationPayload = {\n\ttitle: string\n\tlocale?: string\n\tgroup_lang_id?: string\n\trelease_id?: string\n\tintegration_field_ids: string[]\n\tdata: Record<string, unknown>\n\tcustom_type_id: string\n\ttags: string[]\n}\n\nexport type CoreApiDocumentUpdatePayload = {\n\tdata: Record<string, unknown>\n\tintegration_field_ids: string[]\n\ttags: string[]\n}\n\nexport type CoreApiRepository = Record<string, unknown> & {\n\tsimulator_url?: string\n}\n\nexport type CoreApiDocumentCreationResponse = {\n\tid: string\n\tgroup_lang_id: string\n\tcustom_type_id: string\n\tlocale: string\n\tlanguage: { id: string; name: string }\n\tfirst_publication_date: number | null\n\tlast_publication_date: number | null\n\ttitle: string\n\tversions: {\n\t\tstatus: string\n\t\tversion_id: string\n\t\tauthor: {\n\t\t\tid: string\n\t\t\tfirst_name: string | null\n\t\t\tlast_name: string | null\n\t\t\temail: string\n\t\t}\n\t\trelease_id: string | null\n\t\tlast_modified_date: number\n\t\ttags: string[]\n\t\tcustom_type_label: string\n\t\tpreview_summary?: string\n\t\tpreview_image?: string\n\t\tuid?: string\n\t}[]\n}\n\nexport type CoreApiDocumentsPayload = {\n\tlanguage?: string\n\tlimit?: number\n\tstatuses?: string[]\n\tgroupLangIds?: string[]\n\tdocumentIds?: string[]\n}\n\nexport type CoreApiDocumentsResponse = {\n\ttotal: number\n\tcursor: string\n\tresults: CoreApiDocumentCreationResponse[]\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type CoreApiDocumentData = Record<string, any>\n\nexport class CoreApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example\n\t * \tTo instantiate the class:\n\t *\n\t * \t```js\n\t * \tnew CoreApiClient(\"https://my-repo.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * \t});\n\t * \t```\n\t *\n\t * @param baseURL - The api base URL like https://my-repo.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: Api token generated from the auth service or a function to fetch it\n\t *     when it's needed.\n\t */\n\tconstructor(baseURL: string, config: AuthServerToken) {\n\t\tsuper(baseURL, config)\n\t}\n\n\tasync getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer()\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.get(\"core/repository\")\n\n\t\tif (200 !== result.status() || !(await result.json()).languages) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not get languages from the core api.\")\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" })\n\n\t\treturn (await result.json()).languages\n\t}\n\n\t/**\n\t * Retrieves all releases, including the migration release.\n\t *\n\t * @returns An array of release metadata.\n\t */\n\tasync getReleases(): Promise<Release[]> {\n\t\tconst profiler = logger.startTimer()\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.get(\"core/releases\", {\n\t\t\tparams: { include_migration_releases: true },\n\t\t})\n\n\t\tif (200 !== result.status() || !(await result.json()).results) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not get releases from the core api.\")\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved releases\" })\n\n\t\treturn (await result.json()).results\n\t}\n\n\tasync createDraft(\n\t\tdata: CoreApiDocumentCreationPayload,\n\t): Promise<CoreApiDocumentCreationResponse> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.post(\"core/documents\", {\n\t\t\tdata,\n\t\t})\n\n\t\tif (201 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not create draft document\")\n\t\t}\n\n\t\treturn result.json()\n\t}\n\n\t/**\n\t * Creates a new draft version of an existing document, on top of the given base version.\n\t *\n\t * @param documentId - The id of the document to update.\n\t * @param data - The new version payload in the core api format.\n\t * @param baseVersionId - The id of the version the draft is created from.\n\t * @returns The updated document, including the new version's id.\n\t */\n\tasync updateDraft(\n\t\tdocumentId: string,\n\t\tdata: CoreApiDocumentUpdatePayload,\n\t\tbaseVersionId: string,\n\t): Promise<CoreApiDocumentCreationResponse> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.put(`core/documents/${documentId}/draft`, {\n\t\t\tparams: { base_version_id: baseVersionId },\n\t\t\tdata,\n\t\t})\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(`Could not update draft for document with id ${documentId}`)\n\t\t}\n\n\t\treturn result.json()\n\t}\n\n\tasync publishDraft(documentId: string): Promise<void> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.patch(`core/documents/${documentId}/draft`, {\n\t\t\tdata: {\n\t\t\t\tstatus: \"published\",\n\t\t\t},\n\t\t})\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`)\n\t\t}\n\t}\n\n\t/**\n\t * Unpublishes (archives) a live document.\n\t *\n\t * @param documentId - The id of the document to unpublish.\n\t */\n\tasync unpublishDocument(documentId: string): Promise<void> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.patch(`core/documents/${documentId}/live`, {\n\t\t\tdata: {\n\t\t\t\tstatus: \"archived\",\n\t\t\t},\n\t\t})\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(`Could not unpublish document with id ${documentId}`)\n\t\t}\n\t}\n\n\t/**\n\t * Retrieves documents.\n\t *\n\t * @param args - Configure which documents are retrieved.\n\t * @returns A paginated set of documents.\n\t */\n\tasync getDocuments(args: CoreApiDocumentsPayload): Promise<CoreApiDocumentsResponse> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.post(\"core/documents/search\", {\n\t\t\tdata: args,\n\t\t})\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not search documents\")\n\t\t}\n\n\t\treturn result.json()\n\t}\n\n\t/**\n\t * Retrieves data for a specific document version.\n\t *\n\t * @param versionId - The document's version ID.\n\t * @returns The document's version data.\n\t */\n\tasync getDocumentData(versionId: string): Promise<CoreApiDocumentData> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.get(`core/documents/data/${versionId}`)\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not retrieve document data\")\n\t\t}\n\n\t\treturn result.json()\n\t}\n\n\t/**\n\t * Publishes a release.\n\t *\n\t * @param id - The ID of the release.\n\t * @returns A Promise that resolves when the release is published.\n\t */\n\tasync publishRelease(id: string): Promise<void> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.post(`core/releases/${id}/publish`)\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(\"Could not publish release ${id}\")\n\t\t}\n\t}\n\n\tasync getRepository(): Promise<CoreApiRepository> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.get(`core/repository`)\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(`Could not get repository`)\n\t\t}\n\n\t\treturn result.json()\n\t}\n\n\tasync updateRepository(data: CoreApiRepository): Promise<void> {\n\t\tconst context = await this.getContext()\n\t\tconst result = await context.patch(`core/repository`, {\n\t\t\tdata,\n\t\t})\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result)\n\t\t\tthrow new Error(`Could not update repository`)\n\t\t}\n\t}\n}\n"],"mappings":";;;AAkFA,IAAa,gBAAb,cAAmCA,kBAAAA,uBAAuB;;;;;;;;;;;;;;;;;CAiBzD,YAAY,SAAiB,QAAyB;EACrD,MAAM,SAAS,MAAM;CACtB;CAEA,MAAM,eAAoC;EACzC,MAAM,WAAWC,YAAAA,OAAO,WAAW;EAEnC,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,IAAI,iBAAiB;EAElD,IAAI,QAAQ,OAAO,OAAO,KAAK,EAAE,MAAM,OAAO,KAAK,EAAA,CAAG,WAAW;GAChE,MAAMC,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,4CAA4C;EAC7D;EAEA,SAAS,KAAK,EAAE,SAAS,oCAAoC,CAAC;EAE9D,QAAQ,MAAM,OAAO,KAAK,EAAA,CAAG;CAC9B;;;;;;CAOA,MAAM,cAAkC;EACvC,MAAM,WAAWD,YAAAA,OAAO,WAAW;EAEnC,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,IAAI,iBAAiB,EACjD,QAAQ,EAAE,4BAA4B,KAAK,EAC5C,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,KAAK,EAAE,MAAM,OAAO,KAAK,EAAA,CAAG,SAAS;GAC9D,MAAMC,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,2CAA2C;EAC5D;EAEA,SAAS,KAAK,EAAE,SAAS,qBAAqB,CAAC;EAE/C,QAAQ,MAAM,OAAO,KAAK,EAAA,CAAG;CAC9B;CAEA,MAAM,YACL,MAC2C;EAE3C,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,KAAK,kBAAkB,EACnD,KACD,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,iCAAiC;EAClD;EAEA,OAAO,OAAO,KAAK;CACpB;;;;;;;;;CAUA,MAAM,YACL,YACA,MACA,eAC2C;EAE3C,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,IAAI,kBAAkB,WAAW,SAAS;GACtE,QAAQ,EAAE,iBAAiB,cAAc;GACzC;EACD,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,+CAA+C,YAAY;EAC5E;EAEA,OAAO,OAAO,KAAK;CACpB;CAEA,MAAM,aAAa,YAAmC;EAErD,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,MAAM,kBAAkB,WAAW,SAAS,EACxE,MAAM,EACL,QAAQ,YACT,EACD,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,sCAAsC,YAAY;EACnE;CACD;;;;;;CAOA,MAAM,kBAAkB,YAAmC;EAE1D,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,MAAM,kBAAkB,WAAW,QAAQ,EACvE,MAAM,EACL,QAAQ,WACT,EACD,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,wCAAwC,YAAY;EACrE;CACD;;;;;;;CAQA,MAAM,aAAa,MAAkE;EAEpF,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,KAAK,yBAAyB,EAC1D,MAAM,KACP,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,4BAA4B;EAC7C;EAEA,OAAO,OAAO,KAAK;CACpB;;;;;;;CAQA,MAAM,gBAAgB,WAAiD;EAEtE,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,IAAI,uBAAuB,WAAW;EAEnE,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,kCAAkC;EACnD;EAEA,OAAO,OAAO,KAAK;CACpB;;;;;;;CAQA,MAAM,eAAe,IAA2B;EAE/C,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,KAAK,iBAAiB,GAAG,SAAS;EAE/D,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,iCAAiC;EAClD;CACD;CAEA,MAAM,gBAA4C;EAEjD,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,IAAI,iBAAiB;EAElD,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,0BAA0B;EAC3C;EAEA,OAAO,OAAO,KAAK;CACpB;CAEA,MAAM,iBAAiB,MAAwC;EAE9D,MAAM,SAAS,OAAM,MADC,KAAK,WAAW,EAAA,CACT,MAAM,mBAAmB,EACrD,KACD,CAAC;EAED,IAAI,QAAQ,OAAO,OAAO,GAAG;GAC5B,MAAMA,YAAAA,yBAAyB,MAAM;GACrC,MAAM,IAAI,MAAM,6BAA6B;EAC9C;CACD;AACD"}

package/dist/clients/coreApi.d.cts

@@ -0,0 +1,143 @@
+import { AuthServerToken, AuthenticatedApiClient } from "./apiClient.cjs";
+
+//#region src/clients/coreApi.d.ts
+type Language = {
+  id: string;
+  name: string;
+  is_master: boolean;
+};
+type Release = {
+  id: string;
+  label: string;
+  migration: boolean;
+};
+type CoreApiDocumentCreationPayload = {
+  title: string;
+  locale?: string;
+  group_lang_id?: string;
+  release_id?: string;
+  integration_field_ids: string[];
+  data: Record<string, unknown>;
+  custom_type_id: string;
+  tags: string[];
+};
+type CoreApiDocumentUpdatePayload = {
+  data: Record<string, unknown>;
+  integration_field_ids: string[];
+  tags: string[];
+};
+type CoreApiRepository = Record<string, unknown> & {
+  simulator_url?: string;
+};
+type CoreApiDocumentCreationResponse = {
+  id: string;
+  group_lang_id: string;
+  custom_type_id: string;
+  locale: string;
+  language: {
+    id: string;
+    name: string;
+  };
+  first_publication_date: number | null;
+  last_publication_date: number | null;
+  title: string;
+  versions: {
+    status: string;
+    version_id: string;
+    author: {
+      id: string;
+      first_name: string | null;
+      last_name: string | null;
+      email: string;
+    };
+    release_id: string | null;
+    last_modified_date: number;
+    tags: string[];
+    custom_type_label: string;
+    preview_summary?: string;
+    preview_image?: string;
+    uid?: string;
+  }[];
+};
+type CoreApiDocumentsPayload = {
+  language?: string;
+  limit?: number;
+  statuses?: string[];
+  groupLangIds?: string[];
+  documentIds?: string[];
+};
+type CoreApiDocumentsResponse = {
+  total: number;
+  cursor: string;
+  results: CoreApiDocumentCreationResponse[];
+};
+type CoreApiDocumentData = Record<string, any>;
+declare class CoreApiClient extends AuthenticatedApiClient {
+  /**
+   * @example
+   * 	To instantiate the class:
+   *
+   * 	```js
+   * 	new CoreApiClient("https://my-repo.prismic.io", {
+   * 	authToken: "my-secret-token",
+   * 	});
+   * 	```
+   *
+   * @param baseURL - The api base URL like https://my-repo.prismic.io
+   * @param config - Optional configuration
+   *
+   *   - {@link config.authToken}: Api token generated from the auth service or a function to fetch it
+   *     when it's needed.
+   */
+  constructor(baseURL: string, config: AuthServerToken);
+  getLanguages(): Promise<Language[]>;
+  /**
+   * Retrieves all releases, including the migration release.
+   *
+   * @returns An array of release metadata.
+   */
+  getReleases(): Promise<Release[]>;
+  createDraft(data: CoreApiDocumentCreationPayload): Promise<CoreApiDocumentCreationResponse>;
+  /**
+   * Creates a new draft version of an existing document, on top of the given base version.
+   *
+   * @param documentId - The id of the document to update.
+   * @param data - The new version payload in the core api format.
+   * @param baseVersionId - The id of the version the draft is created from.
+   * @returns The updated document, including the new version's id.
+   */
+  updateDraft(documentId: string, data: CoreApiDocumentUpdatePayload, baseVersionId: string): Promise<CoreApiDocumentCreationResponse>;
+  publishDraft(documentId: string): Promise<void>;
+  /**
+   * Unpublishes (archives) a live document.
+   *
+   * @param documentId - The id of the document to unpublish.
+   */
+  unpublishDocument(documentId: string): Promise<void>;
+  /**
+   * Retrieves documents.
+   *
+   * @param args - Configure which documents are retrieved.
+   * @returns A paginated set of documents.
+   */
+  getDocuments(args: CoreApiDocumentsPayload): Promise<CoreApiDocumentsResponse>;
+  /**
+   * Retrieves data for a specific document version.
+   *
+   * @param versionId - The document's version ID.
+   * @returns The document's version data.
+   */
+  getDocumentData(versionId: string): Promise<CoreApiDocumentData>;
+  /**
+   * Publishes a release.
+   *
+   * @param id - The ID of the release.
+   * @returns A Promise that resolves when the release is published.
+   */
+  publishRelease(id: string): Promise<void>;
+  getRepository(): Promise<CoreApiRepository>;
+  updateRepository(data: CoreApiRepository): Promise<void>;
+}
+//#endregion
+export { CoreApiClient, CoreApiDocumentCreationPayload, CoreApiDocumentCreationResponse, CoreApiDocumentData, CoreApiDocumentUpdatePayload, CoreApiDocumentsPayload, CoreApiDocumentsResponse, CoreApiRepository, Release };
+//# sourceMappingURL=coreApi.d.cts.map

package/dist/clients/coreApi.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coreApi.d.cts","names":[],"sources":["../../src/clients/coreApi.ts"],"mappings":";;;KAIK,QAAA;EACJ,EAAA;EACA,IAAA;EACA,SAAA;AAAA;AAAA,KAGW,OAAA;EACX,EAAA;EACA,KAAA;EACA,SAAA;AAAA;AAAA,KAGW,8BAAA;EACX,KAAA;EACA,MAAA;EACA,aAAA;EACA,UAAA;EACA,qBAAA;EACA,IAAA,EAAM,MAAM;EACZ,cAAA;EACA,IAAA;AAAA;AAAA,KAGW,4BAAA;EACX,IAAA,EAAM,MAAM;EACZ,qBAAA;EACA,IAAA;AAAA;AAAA,KAGW,iBAAA,GAAoB,MAAM;EACrC,aAAa;AAAA;AAAA,KAGF,+BAAA;EACX,EAAA;EACA,aAAA;EACA,cAAA;EACA,MAAA;EACA,QAAA;IAAY,EAAA;IAAY,IAAA;EAAA;EACxB,sBAAA;EACA,qBAAA;EACA,KAAA;EACA,QAAA;IACC,MAAA;IACA,UAAA;IACA,MAAA;MACC,EAAA;MACA,UAAA;MACA,SAAA;MACA,KAAA;IAAA;IAED,UAAA;IACA,kBAAA;IACA,IAAA;IACA,iBAAA;IACA,eAAA;IACA,aAAA;IACA,GAAA;EAAA;AAAA;AAAA,KAIU,uBAAA;EACX,QAAA;EACA,KAAA;EACA,QAAA;EACA,YAAA;EACA,WAAA;AAAA;AAAA,KAGW,wBAAA;EACX,KAAA;EACA,MAAA;EACA,OAAA,EAAS,+BAA+B;AAAA;AAAA,KAI7B,mBAAA,GAAsB,MAAM;AAAA,cAE3B,aAAA,SAAsB,sBAAA;EA1BjC;;;;;;;AAKG;AAIL;;;;;;;;cAkCa,OAAA,UAAiB,MAAA,EAAQ,eAAA;EAI/B,YAAA,IAAgB,OAAA,CAAQ,QAAA;EAjCnB;AAGZ;;;;EAkDO,WAAA,IAAe,OAAA,CAAQ,OAAA;EAiBvB,WAAA,CACL,IAAA,EAAM,8BAAA,GACJ,OAAA,CAAQ,+BAAA;EAlEX;;;AAAwC;AAIzC;;;;EAoFO,WAAA,CACL,UAAA,UACA,IAAA,EAAM,4BAAA,EACN,aAAA,WACE,OAAA,CAAQ,+BAAA;EAeL,YAAA,CAAa,UAAA,WAAqB,OAAA;EArGd;;;;;EAwHpB,iBAAA,CAAkB,UAAA,WAAqB,OAAA;EA/ExB;;;;;;EAmGf,YAAA,CAAa,IAAA,EAAM,uBAAA,GAA0B,OAAA,CAAQ,wBAAA;EAvCnB;;;;;;EA2DlC,eAAA,CAAgB,SAAA,WAAoB,OAAA,CAAQ,mBAAA;EAkBhB;;;;;;EAA5B,cAAA,CAAe,EAAA,WAAa,OAAA;EAU5B,aAAA,IAAiB,OAAA,CAAQ,iBAAA;EAYzB,gBAAA,CAAiB,IAAA,EAAM,iBAAA,GAAoB,OAAA;AAAA"}