@prismicio/e2e-tests-utils 1.1.2 → 1.2.0

package/src/types.ts

@@ -1,27 +1 @@
-export type UrlConfig = {
-	/** Prismic base url */
-	baseURL: string;
-	/** Custom types api base url */
-	customTypesApi: string;
-	/** Auth service api base url */
-	authenticationApi: string;
-};
-
-export type AuthConfig = {
-	email: string;
-	password: string;
-};
-
-export type ManageV2Config = {
-	secret: string;
-	audience: string;
-};
-
-// Global configuration Object
-export type SetupConfiguration = {
-	// If provided as a string: It is treated as the base URL for Prismic. Other
-	// URLs (Custom Types API, Auth API) will be derived from it.
-	urlConfig: UrlConfig | string;
-	authConfig: AuthConfig;
-	manageV2Config?: ManageV2Config;
-};
+export type Credentials = { email: string; password: string };

package/dist/clients/manageV2.cjs

@@ -1,145 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
-const jwt = require("jsonwebtoken");
-const cookies = require("../utils/cookies.cjs");
-const ManageV2StaticAuthor = "prismic-e2e-tests-utils";
-class ManageV2Client {
-  /**
-   * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
-   * @param config - ManageV2 configuration variable to call ManageV2.
-   */
-  constructor(baseUrl, config) {
-    __publicField(this, "client");
-    // Not private to have it available on tests
-    __publicField(this, "token", null);
-    /**
-     * The function `toggleRolePerLocal` enable or disable the role per local
-     * feature
-     *
-     * @param repository - The Repository name
-     * @param enabled - The feature new status
-     */
-    __publicField(this, "toggleRolePerLocal", this.assertTokenExist((params) => {
-      return this.client.post("/repository/toggleRolesPerLocale", {
-        domain: params.repository,
-        enabled: params.enabled,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `changePlan` changes the plan of a repository the database
-     *
-     * @param repository - The Repository name
-     * @param newPlanId - The new planId
-     * @param bypassManualBilling - Beware that using this will not verify that
-     *   the database and Stripe are in sync
-     */
-    __publicField(this, "changePlan", this.assertTokenExist(({ repository, newPlanId, bypassManualBilling = false }) => {
-      return this.client.post(`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`, {
-        domain: repository,
-        newPlan: newPlanId,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `addUserToRepository` adds a user corresponding to the email
-     * to the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    __publicField(this, "addUserToRepository", this.assertTokenExist(({ repository, email }) => {
-      return this.client.post("/repository/addUser", {
-        domain: repository,
-        email,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `removeUserFromRepository` removes a user corresponding to the
-     * email from the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    __publicField(this, "removeUserFromRepository", this.assertTokenExist(({ repository, email }) => {
-      return this.client.post("/repository/removeUser", {
-        domain: repository,
-        email,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    this.token = config ? this.generateToken(config) : null;
-    this.client = axios.create({
-      baseURL: `${baseUrl}/manageroutes/`,
-      withCredentials: true,
-      validateStatus: () => true,
-      headers: {
-        "User-Agent": "prismic-cli/prismic-e2e-tests-utils",
-        Authorization: `Bearer ${this.token}`
-      }
-    });
-    this.client.interceptors.response.use((response) => {
-      const cookies$1 = response.headers["set-cookie"];
-      if (cookies$1 && cookies.extractCookie(cookies$1, "SESSION")) {
-        this.client.defaults.headers["Cookie"] = cookies$1;
-      }
-      return response;
-    });
-  }
-  /**
-   * The function generates a JWT token using the provided configuration
-   * parameters.
-   *
-   * @param {ManageV2Config} config - The `config` parameter in the
-   *   `generateToken` function is of type `ManageV2Config`. It contains the
-   *   following properties:
-   *
-   * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
-   *   function. The token is signed using the provided `config.secret` with the
-   *   HS256 algorithm and includes the specified audience and issuer values.
-   */
-  generateToken(config) {
-    return jwt.sign({}, config.secret, {
-      algorithm: "HS256",
-      audience: config.audience,
-      issuer: "prismic.io"
-    });
-  }
-  /**
-   * The function `assertTokenExist` checks if a token exists before executing a
-   * given function.
-   *
-   * @param f - The `assertTokenExist` function takes a function `f` as a
-   *   parameter. This function `f` should accept a parameter of type
-   *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
-   *   `assertTokenExist` function ensures that a token is not null before
-   *   calling the provided
-   *
-   * @returns A function is being returned that takes a parameter of type
-   *   Parameters and checks if the token is null. If the token is null, an
-   *   error is thrown. Otherwise, the function f is called with the provided
-   *   parameters.
-   */
-  assertTokenExist(f) {
-    return (params) => {
-      if (this.token === null) {
-        throw new Error("Undefined configuration for ManageV2 while trying to use it's routes");
-      } else {
-        return f(params);
-      }
-    };
-  }
-  getBaseURL() {
-    return this.client.getUri();
-  }
-}
-exports.ManageV2Client = ManageV2Client;
-//# sourceMappingURL=manageV2.cjs.map

package/dist/clients/manageV2.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"manageV2.cjs","sources":["../../../src/clients/manageV2.ts"],"sourcesContent":["import axios, { AxiosInstance, AxiosResponse } from \"axios\";\nimport jwt from \"jsonwebtoken\";\n\nimport { ManageV2Config } from \"../types\";\n\nimport { extractCookie } from \"../utils/cookies\";\n\nconst ManageV2StaticAuthor = \"prismic-e2e-tests-utils\";\n\n/**\n * Client for interacting with ManageV2 routes to perform operations on\n * repositories.\n */\nexport class ManageV2Client {\n\treadonly client: AxiosInstance; // Not private to have it available on tests\n\tprivate token: string | null = null;\n\n\t/**\n\t * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io\n\t * @param config - ManageV2 configuration variable to call ManageV2.\n\t */\n\tconstructor(baseUrl: string, config?: ManageV2Config | undefined) {\n\t\tthis.token = config ? this.generateToken(config) : null;\n\n\t\tthis.client = axios.create({\n\t\t\tbaseURL: `${baseUrl}/manageroutes/`,\n\t\t\twithCredentials: true,\n\t\t\tvalidateStatus: () => true,\n\t\t\theaders: {\n\t\t\t\t\"User-Agent\": \"prismic-cli/prismic-e2e-tests-utils\",\n\t\t\t\tAuthorization: `Bearer ${this.token}`,\n\t\t\t},\n\t\t});\n\n\t\t// cookies are not forwarded automatically in a non-browser env\n\t\tthis.client.interceptors.response.use((response) => {\n\t\t\tconst cookies = response.headers[\"set-cookie\"];\n\t\t\tif (cookies && extractCookie(cookies, \"SESSION\")) {\n\t\t\t\tthis.client.defaults.headers[\"Cookie\"] = cookies;\n\t\t\t}\n\n\t\t\treturn response;\n\t\t});\n\t}\n\n\t/**\n\t * The function generates a JWT token using the provided configuration\n\t * parameters.\n\t *\n\t * @param {ManageV2Config} config - The `config` parameter in the\n\t *   `generateToken` function is of type `ManageV2Config`. It contains the\n\t *   following properties:\n\t *\n\t * @returns A JSON Web Token (JWT) is being returned by the `generateToken`\n\t *   function. The token is signed using the provided `config.secret` with the\n\t *   HS256 algorithm and includes the specified audience and issuer values.\n\t */\n\tprivate generateToken(config: ManageV2Config): string {\n\t\treturn jwt.sign({}, config.secret, {\n\t\t\talgorithm: \"HS256\",\n\t\t\taudience: config.audience,\n\t\t\tissuer: \"prismic.io\",\n\t\t});\n\t}\n\n\t/**\n\t * The function `assertTokenExist` checks if a token exists before executing a\n\t * given function.\n\t *\n\t * @param f - The `assertTokenExist` function takes a function `f` as a\n\t *   parameter. This function `f` should accept a parameter of type\n\t *   `Parameters` and return a Promise that resolves to an AxiosResponse. The\n\t *   `assertTokenExist` function ensures that a token is not null before\n\t *   calling the provided\n\t *\n\t * @returns A function is being returned that takes a parameter of type\n\t *   Parameters and checks if the token is null. If the token is null, an\n\t *   error is thrown. Otherwise, the function f is called with the provided\n\t *   parameters.\n\t */\n\tprivate assertTokenExist<Parameters>(\n\t\tf: (_: Parameters) => Promise<AxiosResponse>,\n\t) {\n\t\treturn (params: Parameters) => {\n\t\t\tif (this.token === null) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t\"Undefined configuration for ManageV2 while trying to use it's routes\",\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\treturn f(params);\n\t\t\t}\n\t\t};\n\t}\n\n\tgetBaseURL(): string {\n\t\treturn this.client.getUri();\n\t}\n\n\t/**\n\t * The function `toggleRolePerLocal` enable or disable the role per local\n\t * feature\n\t *\n\t * @param repository - The Repository name\n\t * @param enabled - The feature new status\n\t */\n\ttoggleRolePerLocal = this.assertTokenExist(\n\t\t(params: { repository: string; enabled: boolean }) => {\n\t\t\treturn this.client.post(\"/repository/toggleRolesPerLocale\", {\n\t\t\t\tdomain: params.repository,\n\t\t\t\tenabled: params.enabled,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n\n\t/**\n\t * The function `changePlan` changes the plan of a repository the database\n\t *\n\t * @param repository - The Repository name\n\t * @param newPlanId - The new planId\n\t * @param bypassManualBilling - Beware that using this will not verify that\n\t *   the database and Stripe are in sync\n\t */\n\tchangePlan = this.assertTokenExist(\n\t\t({\n\t\t\trepository,\n\t\t\tnewPlanId,\n\t\t\tbypassManualBilling = false,\n\t\t}: {\n\t\t\trepository: string;\n\t\t\tnewPlanId: string;\n\t\t\tbypassManualBilling?: boolean;\n\t\t}) => {\n\t\t\treturn this.client.post(\n\t\t\t\t`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`,\n\t\t\t\t{\n\t\t\t\t\tdomain: repository,\n\t\t\t\t\tnewPlan: newPlanId,\n\t\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t\t},\n\t\t\t);\n\t\t},\n\t);\n\n\t/**\n\t * The function `addUserToRepository` adds a user corresponding to the email\n\t * to the given repository\n\t *\n\t * @param repository - The Repository name\n\t * @param email - The user email\n\t */\n\taddUserToRepository = this.assertTokenExist(\n\t\t({ repository, email }: { repository: string; email: string }) => {\n\t\t\treturn this.client.post(\"/repository/addUser\", {\n\t\t\t\tdomain: repository,\n\t\t\t\temail: email,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n\n\t/**\n\t * The function `removeUserFromRepository` removes a user corresponding to the\n\t * email from the given repository\n\t *\n\t * @param repository - The Repository name\n\t * @param email - The user email\n\t */\n\tremoveUserFromRepository = this.assertTokenExist(\n\t\t({ repository, email }: { repository: string; email: string }) => {\n\t\t\treturn this.client.post(\"/repository/removeUser\", {\n\t\t\t\tdomain: repository,\n\t\t\t\temail: email,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n}\n"],"names":["cookies","extractCookie"],"mappings":";;;;;;;;;;;AAOA,MAAM,uBAAuB;MAMhB,eAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,YAAY,SAAiB,QAAmC;AAPvD;AACD;AAAA,iCAAuB;AA0F/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8CAAqB,KAAK,iBACzB,CAAC,WAAoD;AAC7C,aAAA,KAAK,OAAO,KAAK,oCAAoC;AAAA,QAC3D,QAAQ,OAAO;AAAA,QACf,SAAS,OAAO;AAAA,QAChB,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAWF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sCAAa,KAAK,iBACjB,CAAC,EACA,YACA,WACA,sBAAsB,YAKlB;AACJ,aAAO,KAAK,OAAO,KAClB,8CAA8C,mBAAmB,IACjE;AAAA,QACC,QAAQ;AAAA,QACR,SAAS;AAAA,QACT,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CAEF;AAUF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+CAAsB,KAAK,iBAC1B,CAAC,EAAE,YAAY,YAAkD;AACzD,aAAA,KAAK,OAAO,KAAK,uBAAuB;AAAA,QAC9C,QAAQ;AAAA,QACR;AAAA,QACA,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAUF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oDAA2B,KAAK,iBAC/B,CAAC,EAAE,YAAY,YAAkD;AACzD,aAAA,KAAK,OAAO,KAAK,0BAA0B;AAAA,QACjD,QAAQ;AAAA,QACR;AAAA,QACA,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAzJD,SAAK,QAAQ,SAAS,KAAK,cAAc,MAAM,IAAI;AAE9C,SAAA,SAAS,MAAM,OAAO;AAAA,MAC1B,SAAS,GAAG,OAAO;AAAA,MACnB,iBAAiB;AAAA,MACjB,gBAAgB,MAAM;AAAA,MACtB,SAAS;AAAA,QACR,cAAc;AAAA,QACd,eAAe,UAAU,KAAK,KAAK;AAAA,MACnC;AAAA,IAAA,CACD;AAGD,SAAK,OAAO,aAAa,SAAS,IAAI,CAAC,aAAY;AAC5C,YAAAA,YAAU,SAAS,QAAQ,YAAY;AAC7C,UAAIA,aAAWC,QAAAA,cAAcD,WAAS,SAAS,GAAG;AACjD,aAAK,OAAO,SAAS,QAAQ,QAAQ,IAAIA;AAAAA,MACzC;AAEM,aAAA;AAAA,IAAA,CACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcQ,cAAc,QAAsB;AAC3C,WAAO,IAAI,KAAK,IAAI,OAAO,QAAQ;AAAA,MAClC,WAAW;AAAA,MACX,UAAU,OAAO;AAAA,MACjB,QAAQ;AAAA,IAAA,CACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBQ,iBACP,GAA4C;AAE5C,WAAO,CAAC,WAAsB;AACzB,UAAA,KAAK,UAAU,MAAM;AAClB,cAAA,IAAI,MACT,sEAAsE;AAAA,MAAA,OAEjE;AACN,eAAO,EAAE,MAAM;AAAA,MACf;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,aAAU;AACF,WAAA,KAAK,OAAO;EACpB;AAiFA;;"}

package/dist/clients/manageV2.d.ts

@@ -1,91 +0,0 @@
-import { AxiosInstance, AxiosResponse } from "axios";
-import { ManageV2Config } from "../types";
-/**
- * Client for interacting with ManageV2 routes to perform operations on
- * repositories.
- */
-export declare class ManageV2Client {
-    readonly client: AxiosInstance;
-    private token;
-    /**
-     * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
-     * @param config - ManageV2 configuration variable to call ManageV2.
-     */
-    constructor(baseUrl: string, config?: ManageV2Config | undefined);
-    /**
-     * The function generates a JWT token using the provided configuration
-     * parameters.
-     *
-     * @param {ManageV2Config} config - The `config` parameter in the
-     *   `generateToken` function is of type `ManageV2Config`. It contains the
-     *   following properties:
-     *
-     * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
-     *   function. The token is signed using the provided `config.secret` with the
-     *   HS256 algorithm and includes the specified audience and issuer values.
-     */
-    private generateToken;
-    /**
-     * The function `assertTokenExist` checks if a token exists before executing a
-     * given function.
-     *
-     * @param f - The `assertTokenExist` function takes a function `f` as a
-     *   parameter. This function `f` should accept a parameter of type
-     *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
-     *   `assertTokenExist` function ensures that a token is not null before
-     *   calling the provided
-     *
-     * @returns A function is being returned that takes a parameter of type
-     *   Parameters and checks if the token is null. If the token is null, an
-     *   error is thrown. Otherwise, the function f is called with the provided
-     *   parameters.
-     */
-    private assertTokenExist;
-    getBaseURL(): string;
-    /**
-     * The function `toggleRolePerLocal` enable or disable the role per local
-     * feature
-     *
-     * @param repository - The Repository name
-     * @param enabled - The feature new status
-     */
-    toggleRolePerLocal: (params: {
-        repository: string;
-        enabled: boolean;
-    }) => Promise<AxiosResponse<any, any>>;
-    /**
-     * The function `changePlan` changes the plan of a repository the database
-     *
-     * @param repository - The Repository name
-     * @param newPlanId - The new planId
-     * @param bypassManualBilling - Beware that using this will not verify that
-     *   the database and Stripe are in sync
-     */
-    changePlan: (params: {
-        repository: string;
-        newPlanId: string;
-        bypassManualBilling?: boolean | undefined;
-    }) => Promise<AxiosResponse<any, any>>;
-    /**
-     * The function `addUserToRepository` adds a user corresponding to the email
-     * to the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    addUserToRepository: (params: {
-        repository: string;
-        email: string;
-    }) => Promise<AxiosResponse<any, any>>;
-    /**
-     * The function `removeUserFromRepository` removes a user corresponding to the
-     * email from the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    removeUserFromRepository: (params: {
-        repository: string;
-        email: string;
-    }) => Promise<AxiosResponse<any, any>>;
-}

package/dist/clients/manageV2.js

@@ -1,145 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-import axios from "axios";
-import jwt from "jsonwebtoken";
-import { extractCookie } from "../utils/cookies.js";
-const ManageV2StaticAuthor = "prismic-e2e-tests-utils";
-class ManageV2Client {
-  /**
-   * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
-   * @param config - ManageV2 configuration variable to call ManageV2.
-   */
-  constructor(baseUrl, config) {
-    __publicField(this, "client");
-    // Not private to have it available on tests
-    __publicField(this, "token", null);
-    /**
-     * The function `toggleRolePerLocal` enable or disable the role per local
-     * feature
-     *
-     * @param repository - The Repository name
-     * @param enabled - The feature new status
-     */
-    __publicField(this, "toggleRolePerLocal", this.assertTokenExist((params) => {
-      return this.client.post("/repository/toggleRolesPerLocale", {
-        domain: params.repository,
-        enabled: params.enabled,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `changePlan` changes the plan of a repository the database
-     *
-     * @param repository - The Repository name
-     * @param newPlanId - The new planId
-     * @param bypassManualBilling - Beware that using this will not verify that
-     *   the database and Stripe are in sync
-     */
-    __publicField(this, "changePlan", this.assertTokenExist(({ repository, newPlanId, bypassManualBilling = false }) => {
-      return this.client.post(`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`, {
-        domain: repository,
-        newPlan: newPlanId,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `addUserToRepository` adds a user corresponding to the email
-     * to the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    __publicField(this, "addUserToRepository", this.assertTokenExist(({ repository, email }) => {
-      return this.client.post("/repository/addUser", {
-        domain: repository,
-        email,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    /**
-     * The function `removeUserFromRepository` removes a user corresponding to the
-     * email from the given repository
-     *
-     * @param repository - The Repository name
-     * @param email - The user email
-     */
-    __publicField(this, "removeUserFromRepository", this.assertTokenExist(({ repository, email }) => {
-      return this.client.post("/repository/removeUser", {
-        domain: repository,
-        email,
-        author: ManageV2StaticAuthor
-      });
-    }));
-    this.token = config ? this.generateToken(config) : null;
-    this.client = axios.create({
-      baseURL: `${baseUrl}/manageroutes/`,
-      withCredentials: true,
-      validateStatus: () => true,
-      headers: {
-        "User-Agent": "prismic-cli/prismic-e2e-tests-utils",
-        Authorization: `Bearer ${this.token}`
-      }
-    });
-    this.client.interceptors.response.use((response) => {
-      const cookies = response.headers["set-cookie"];
-      if (cookies && extractCookie(cookies, "SESSION")) {
-        this.client.defaults.headers["Cookie"] = cookies;
-      }
-      return response;
-    });
-  }
-  /**
-   * The function generates a JWT token using the provided configuration
-   * parameters.
-   *
-   * @param {ManageV2Config} config - The `config` parameter in the
-   *   `generateToken` function is of type `ManageV2Config`. It contains the
-   *   following properties:
-   *
-   * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
-   *   function. The token is signed using the provided `config.secret` with the
-   *   HS256 algorithm and includes the specified audience and issuer values.
-   */
-  generateToken(config) {
-    return jwt.sign({}, config.secret, {
-      algorithm: "HS256",
-      audience: config.audience,
-      issuer: "prismic.io"
-    });
-  }
-  /**
-   * The function `assertTokenExist` checks if a token exists before executing a
-   * given function.
-   *
-   * @param f - The `assertTokenExist` function takes a function `f` as a
-   *   parameter. This function `f` should accept a parameter of type
-   *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
-   *   `assertTokenExist` function ensures that a token is not null before
-   *   calling the provided
-   *
-   * @returns A function is being returned that takes a parameter of type
-   *   Parameters and checks if the token is null. If the token is null, an
-   *   error is thrown. Otherwise, the function f is called with the provided
-   *   parameters.
-   */
-  assertTokenExist(f) {
-    return (params) => {
-      if (this.token === null) {
-        throw new Error("Undefined configuration for ManageV2 while trying to use it's routes");
-      } else {
-        return f(params);
-      }
-    };
-  }
-  getBaseURL() {
-    return this.client.getUri();
-  }
-}
-export {
-  ManageV2Client
-};
-//# sourceMappingURL=manageV2.js.map

package/dist/clients/manageV2.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"manageV2.js","sources":["../../../src/clients/manageV2.ts"],"sourcesContent":["import axios, { AxiosInstance, AxiosResponse } from \"axios\";\nimport jwt from \"jsonwebtoken\";\n\nimport { ManageV2Config } from \"../types\";\n\nimport { extractCookie } from \"../utils/cookies\";\n\nconst ManageV2StaticAuthor = \"prismic-e2e-tests-utils\";\n\n/**\n * Client for interacting with ManageV2 routes to perform operations on\n * repositories.\n */\nexport class ManageV2Client {\n\treadonly client: AxiosInstance; // Not private to have it available on tests\n\tprivate token: string | null = null;\n\n\t/**\n\t * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io\n\t * @param config - ManageV2 configuration variable to call ManageV2.\n\t */\n\tconstructor(baseUrl: string, config?: ManageV2Config | undefined) {\n\t\tthis.token = config ? this.generateToken(config) : null;\n\n\t\tthis.client = axios.create({\n\t\t\tbaseURL: `${baseUrl}/manageroutes/`,\n\t\t\twithCredentials: true,\n\t\t\tvalidateStatus: () => true,\n\t\t\theaders: {\n\t\t\t\t\"User-Agent\": \"prismic-cli/prismic-e2e-tests-utils\",\n\t\t\t\tAuthorization: `Bearer ${this.token}`,\n\t\t\t},\n\t\t});\n\n\t\t// cookies are not forwarded automatically in a non-browser env\n\t\tthis.client.interceptors.response.use((response) => {\n\t\t\tconst cookies = response.headers[\"set-cookie\"];\n\t\t\tif (cookies && extractCookie(cookies, \"SESSION\")) {\n\t\t\t\tthis.client.defaults.headers[\"Cookie\"] = cookies;\n\t\t\t}\n\n\t\t\treturn response;\n\t\t});\n\t}\n\n\t/**\n\t * The function generates a JWT token using the provided configuration\n\t * parameters.\n\t *\n\t * @param {ManageV2Config} config - The `config` parameter in the\n\t *   `generateToken` function is of type `ManageV2Config`. It contains the\n\t *   following properties:\n\t *\n\t * @returns A JSON Web Token (JWT) is being returned by the `generateToken`\n\t *   function. The token is signed using the provided `config.secret` with the\n\t *   HS256 algorithm and includes the specified audience and issuer values.\n\t */\n\tprivate generateToken(config: ManageV2Config): string {\n\t\treturn jwt.sign({}, config.secret, {\n\t\t\talgorithm: \"HS256\",\n\t\t\taudience: config.audience,\n\t\t\tissuer: \"prismic.io\",\n\t\t});\n\t}\n\n\t/**\n\t * The function `assertTokenExist` checks if a token exists before executing a\n\t * given function.\n\t *\n\t * @param f - The `assertTokenExist` function takes a function `f` as a\n\t *   parameter. This function `f` should accept a parameter of type\n\t *   `Parameters` and return a Promise that resolves to an AxiosResponse. The\n\t *   `assertTokenExist` function ensures that a token is not null before\n\t *   calling the provided\n\t *\n\t * @returns A function is being returned that takes a parameter of type\n\t *   Parameters and checks if the token is null. If the token is null, an\n\t *   error is thrown. Otherwise, the function f is called with the provided\n\t *   parameters.\n\t */\n\tprivate assertTokenExist<Parameters>(\n\t\tf: (_: Parameters) => Promise<AxiosResponse>,\n\t) {\n\t\treturn (params: Parameters) => {\n\t\t\tif (this.token === null) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t\"Undefined configuration for ManageV2 while trying to use it's routes\",\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\treturn f(params);\n\t\t\t}\n\t\t};\n\t}\n\n\tgetBaseURL(): string {\n\t\treturn this.client.getUri();\n\t}\n\n\t/**\n\t * The function `toggleRolePerLocal` enable or disable the role per local\n\t * feature\n\t *\n\t * @param repository - The Repository name\n\t * @param enabled - The feature new status\n\t */\n\ttoggleRolePerLocal = this.assertTokenExist(\n\t\t(params: { repository: string; enabled: boolean }) => {\n\t\t\treturn this.client.post(\"/repository/toggleRolesPerLocale\", {\n\t\t\t\tdomain: params.repository,\n\t\t\t\tenabled: params.enabled,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n\n\t/**\n\t * The function `changePlan` changes the plan of a repository the database\n\t *\n\t * @param repository - The Repository name\n\t * @param newPlanId - The new planId\n\t * @param bypassManualBilling - Beware that using this will not verify that\n\t *   the database and Stripe are in sync\n\t */\n\tchangePlan = this.assertTokenExist(\n\t\t({\n\t\t\trepository,\n\t\t\tnewPlanId,\n\t\t\tbypassManualBilling = false,\n\t\t}: {\n\t\t\trepository: string;\n\t\t\tnewPlanId: string;\n\t\t\tbypassManualBilling?: boolean;\n\t\t}) => {\n\t\t\treturn this.client.post(\n\t\t\t\t`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`,\n\t\t\t\t{\n\t\t\t\t\tdomain: repository,\n\t\t\t\t\tnewPlan: newPlanId,\n\t\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t\t},\n\t\t\t);\n\t\t},\n\t);\n\n\t/**\n\t * The function `addUserToRepository` adds a user corresponding to the email\n\t * to the given repository\n\t *\n\t * @param repository - The Repository name\n\t * @param email - The user email\n\t */\n\taddUserToRepository = this.assertTokenExist(\n\t\t({ repository, email }: { repository: string; email: string }) => {\n\t\t\treturn this.client.post(\"/repository/addUser\", {\n\t\t\t\tdomain: repository,\n\t\t\t\temail: email,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n\n\t/**\n\t * The function `removeUserFromRepository` removes a user corresponding to the\n\t * email from the given repository\n\t *\n\t * @param repository - The Repository name\n\t * @param email - The user email\n\t */\n\tremoveUserFromRepository = this.assertTokenExist(\n\t\t({ repository, email }: { repository: string; email: string }) => {\n\t\t\treturn this.client.post(\"/repository/removeUser\", {\n\t\t\t\tdomain: repository,\n\t\t\t\temail: email,\n\t\t\t\tauthor: ManageV2StaticAuthor,\n\t\t\t});\n\t\t},\n\t);\n}\n"],"names":[],"mappings":";;;;;;;;;AAOA,MAAM,uBAAuB;MAMhB,eAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,YAAY,SAAiB,QAAmC;AAPvD;AACD;AAAA,iCAAuB;AA0F/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8CAAqB,KAAK,iBACzB,CAAC,WAAoD;AAC7C,aAAA,KAAK,OAAO,KAAK,oCAAoC;AAAA,QAC3D,QAAQ,OAAO;AAAA,QACf,SAAS,OAAO;AAAA,QAChB,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAWF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sCAAa,KAAK,iBACjB,CAAC,EACA,YACA,WACA,sBAAsB,YAKlB;AACJ,aAAO,KAAK,OAAO,KAClB,8CAA8C,mBAAmB,IACjE;AAAA,QACC,QAAQ;AAAA,QACR,SAAS;AAAA,QACT,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CAEF;AAUF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+CAAsB,KAAK,iBAC1B,CAAC,EAAE,YAAY,YAAkD;AACzD,aAAA,KAAK,OAAO,KAAK,uBAAuB;AAAA,QAC9C,QAAQ;AAAA,QACR;AAAA,QACA,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAUF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oDAA2B,KAAK,iBAC/B,CAAC,EAAE,YAAY,YAAkD;AACzD,aAAA,KAAK,OAAO,KAAK,0BAA0B;AAAA,QACjD,QAAQ;AAAA,QACR;AAAA,QACA,QAAQ;AAAA,MAAA,CACR;AAAA,IAAA,CACD;AAzJD,SAAK,QAAQ,SAAS,KAAK,cAAc,MAAM,IAAI;AAE9C,SAAA,SAAS,MAAM,OAAO;AAAA,MAC1B,SAAS,GAAG,OAAO;AAAA,MACnB,iBAAiB;AAAA,MACjB,gBAAgB,MAAM;AAAA,MACtB,SAAS;AAAA,QACR,cAAc;AAAA,QACd,eAAe,UAAU,KAAK,KAAK;AAAA,MACnC;AAAA,IAAA,CACD;AAGD,SAAK,OAAO,aAAa,SAAS,IAAI,CAAC,aAAY;AAC5C,YAAA,UAAU,SAAS,QAAQ,YAAY;AAC7C,UAAI,WAAW,cAAc,SAAS,SAAS,GAAG;AACjD,aAAK,OAAO,SAAS,QAAQ,QAAQ,IAAI;AAAA,MACzC;AAEM,aAAA;AAAA,IAAA,CACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcQ,cAAc,QAAsB;AAC3C,WAAO,IAAI,KAAK,IAAI,OAAO,QAAQ;AAAA,MAClC,WAAW;AAAA,MACX,UAAU,OAAO;AAAA,MACjB,QAAQ;AAAA,IAAA,CACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBQ,iBACP,GAA4C;AAE5C,WAAO,CAAC,WAAsB;AACzB,UAAA,KAAK,UAAU,MAAM;AAClB,cAAA,IAAI,MACT,sEAAsE;AAAA,MAAA,OAEjE;AACN,eAAO,EAAE,MAAM;AAAA,MACf;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,aAAU;AACF,WAAA,KAAK,OAAO;EACpB;AAiFA;"}

package/src/clients/manageV2.ts

@@ -1,178 +0,0 @@
-import axios, { AxiosInstance, AxiosResponse } from "axios";
-import jwt from "jsonwebtoken";
-
-import { ManageV2Config } from "../types";
-
-import { extractCookie } from "../utils/cookies";
-
-const ManageV2StaticAuthor = "prismic-e2e-tests-utils";
-
-/**
- * Client for interacting with ManageV2 routes to perform operations on
- * repositories.
- */
-export class ManageV2Client {
-	readonly client: AxiosInstance; // Not private to have it available on tests
-	private token: string | null = null;
-
-	/**
-	 * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
-	 * @param config - ManageV2 configuration variable to call ManageV2.
-	 */
-	constructor(baseUrl: string, config?: ManageV2Config | undefined) {
-		this.token = config ? this.generateToken(config) : null;
-
-		this.client = axios.create({
-			baseURL: `${baseUrl}/manageroutes/`,
-			withCredentials: true,
-			validateStatus: () => true,
-			headers: {
-				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
-				Authorization: `Bearer ${this.token}`,
-			},
-		});
-
-		// cookies are not forwarded automatically in a non-browser env
-		this.client.interceptors.response.use((response) => {
-			const cookies = response.headers["set-cookie"];
-			if (cookies && extractCookie(cookies, "SESSION")) {
-				this.client.defaults.headers["Cookie"] = cookies;
-			}
-
-			return response;
-		});
-	}
-
-	/**
-	 * The function generates a JWT token using the provided configuration
-	 * parameters.
-	 *
-	 * @param {ManageV2Config} config - The `config` parameter in the
-	 *   `generateToken` function is of type `ManageV2Config`. It contains the
-	 *   following properties:
-	 *
-	 * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
-	 *   function. The token is signed using the provided `config.secret` with the
-	 *   HS256 algorithm and includes the specified audience and issuer values.
-	 */
-	private generateToken(config: ManageV2Config): string {
-		return jwt.sign({}, config.secret, {
-			algorithm: "HS256",
-			audience: config.audience,
-			issuer: "prismic.io",
-		});
-	}
-
-	/**
-	 * The function `assertTokenExist` checks if a token exists before executing a
-	 * given function.
-	 *
-	 * @param f - The `assertTokenExist` function takes a function `f` as a
-	 *   parameter. This function `f` should accept a parameter of type
-	 *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
-	 *   `assertTokenExist` function ensures that a token is not null before
-	 *   calling the provided
-	 *
-	 * @returns A function is being returned that takes a parameter of type
-	 *   Parameters and checks if the token is null. If the token is null, an
-	 *   error is thrown. Otherwise, the function f is called with the provided
-	 *   parameters.
-	 */
-	private assertTokenExist<Parameters>(
-		f: (_: Parameters) => Promise<AxiosResponse>,
-	) {
-		return (params: Parameters) => {
-			if (this.token === null) {
-				throw new Error(
-					"Undefined configuration for ManageV2 while trying to use it's routes",
-				);
-			} else {
-				return f(params);
-			}
-		};
-	}
-
-	getBaseURL(): string {
-		return this.client.getUri();
-	}
-
-	/**
-	 * The function `toggleRolePerLocal` enable or disable the role per local
-	 * feature
-	 *
-	 * @param repository - The Repository name
-	 * @param enabled - The feature new status
-	 */
-	toggleRolePerLocal = this.assertTokenExist(
-		(params: { repository: string; enabled: boolean }) => {
-			return this.client.post("/repository/toggleRolesPerLocale", {
-				domain: params.repository,
-				enabled: params.enabled,
-				author: ManageV2StaticAuthor,
-			});
-		},
-	);
-
-	/**
-	 * The function `changePlan` changes the plan of a repository the database
-	 *
-	 * @param repository - The Repository name
-	 * @param newPlanId - The new planId
-	 * @param bypassManualBilling - Beware that using this will not verify that
-	 *   the database and Stripe are in sync
-	 */
-	changePlan = this.assertTokenExist(
-		({
-			repository,
-			newPlanId,
-			bypassManualBilling = false,
-		}: {
-			repository: string;
-			newPlanId: string;
-			bypassManualBilling?: boolean;
-		}) => {
-			return this.client.post(
-				`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`,
-				{
-					domain: repository,
-					newPlan: newPlanId,
-					author: ManageV2StaticAuthor,
-				},
-			);
-		},
-	);
-
-	/**
-	 * The function `addUserToRepository` adds a user corresponding to the email
-	 * to the given repository
-	 *
-	 * @param repository - The Repository name
-	 * @param email - The user email
-	 */
-	addUserToRepository = this.assertTokenExist(
-		({ repository, email }: { repository: string; email: string }) => {
-			return this.client.post("/repository/addUser", {
-				domain: repository,
-				email: email,
-				author: ManageV2StaticAuthor,
-			});
-		},
-	);
-
-	/**
-	 * The function `removeUserFromRepository` removes a user corresponding to the
-	 * email from the given repository
-	 *
-	 * @param repository - The Repository name
-	 * @param email - The user email
-	 */
-	removeUserFromRepository = this.assertTokenExist(
-		({ repository, email }: { repository: string; email: string }) => {
-			return this.client.post("/repository/removeUser", {
-				domain: repository,
-				email: email,
-				author: ManageV2StaticAuthor,
-			});
-		},
-	);
-}