@slicemachine/manager 0.1.1-dev-plugins.3

package/dist/managers/screenshots/ScreenshotsManager.cjs

@@ -0,0 +1,206 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const t = require("io-ts");
+require("node:buffer");
+require("readable-web-to-node-stream");
+const core = require('./../../__node_modules/file-type/core.cjs');
+const index = require('./../../__node_modules/node-fetch/src/index.cjs');
+const checkIsURLAccessible = require("../../lib/checkIsURLAccessible.cjs");
+const createContentDigest = require("../../lib/createContentDigest.cjs");
+const decode = require("../../lib/decode.cjs");
+const SLICE_MACHINE_USER_AGENT = require("../../constants/SLICE_MACHINE_USER_AGENT.cjs");
+const API_ENDPOINTS = require("../../constants/API_ENDPOINTS.cjs");
+const errors = require("../../errors.cjs");
+const BaseManager = require("../BaseManager.cjs");
+const esm_min = require('./../../__node_modules/formdata-polyfill/esm.min.cjs');
+const index$1 = require('./../../__node_modules/fetch-blob/index.cjs');
+require("node:fs");
+require("node:path");
+require('./../../__node_modules/node-domexception/index.cjs');
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const t__namespace = /* @__PURE__ */ _interopNamespaceDefault(t);
+const SLICE_SIMULATOR_LOAD_TIMEOUT = 1e4;
+const SLICE_SIMULATOR_ROOT_SELECTOR = "#root";
+const DEFAULT_SCREENSHOT_VIEWPORT = {
+  width: 1200,
+  height: 800
+};
+function assertS3ACLInitialized(s3ACL) {
+  if (s3ACL == void 0) {
+    throw new Error("An S3 ACL has not been initialized. Run `SliceMachineManager.screenshots.prototype.initS3ACL()` before re-calling this method.");
+  }
+}
+function assertBrowserContextInitialized(browserContext) {
+  if (browserContext == void 0) {
+    throw new Error("A browser context has not been initialized. Run `SliceMachineManager.screenshots.prototype.initBrowserContext()` before re-calling this method.");
+  }
+}
+class ScreenshotsManager extends BaseManager.BaseManager {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_browserContext");
+    __publicField(this, "_s3ACL");
+  }
+  async initBrowserContext() {
+    if (this._browserContext) {
+      return;
+    }
+    let puppeteer;
+    try {
+      puppeteer = await import("puppeteer");
+    } catch {
+      throw new errors.InternalError("Screenshots require Puppeteer but Puppeteer was not found. Check that the `puppeteer` package is installed before trying again.");
+    }
+    const browser = await puppeteer.launch();
+    this._browserContext = await browser.createIncognitoBrowserContext();
+  }
+  async initS3ACL() {
+    if (this._s3ACL) {
+      return;
+    }
+    const sliceMachineConfig = await this.project.getSliceMachineConfig();
+    const authenticationToken = await this.user.getAuthenticationToken();
+    const awsACLURL = new URL("create", API_ENDPOINTS.API_ENDPOINTS.AwsAclProvider);
+    const awsACLRes = await index.default(awsACLURL.toString(), {
+      headers: {
+        Authorization: `Bearer ${authenticationToken}`,
+        "User-Agent": SLICE_MACHINE_USER_AGENT.SLICE_MACHINE_USER_AGENT,
+        Repository: sliceMachineConfig.repositoryName
+      }
+    });
+    const awsACLJSON = await awsACLRes.json();
+    const { value: awsACL, error } = decode.decode(t__namespace.intersection([
+      t__namespace.type({
+        values: t__namespace.type({
+          url: t__namespace.string,
+          fields: t__namespace.record(t__namespace.string, t__namespace.string)
+        }),
+        imgixEndpoint: t__namespace.string
+      }),
+      t__namespace.partial({
+        message: t__namespace.string,
+        Message: t__namespace.string,
+        error: t__namespace.string
+      })
+    ]), awsACLJSON);
+    if (error) {
+      throw new Error(`Invalid AWS ACL response from ${awsACLURL}`);
+    }
+    const errorMessage = awsACL.error || awsACL.message || awsACL.Message;
+    if (errorMessage) {
+      throw new Error(`Failed to create an AWS ACL: ${errorMessage}`);
+    }
+    this._s3ACL = {
+      uploadEndpoint: awsACL.values.url,
+      requiredFormDataFields: awsACL.values.fields,
+      imgixEndpoint: awsACL.imgixEndpoint
+    };
+  }
+  // TODO: Abstract to a generic `captureScreenshot()` method that is
+  // used within a Slice-specific method in SliceManager.
+  async captureSliceSimulatorScreenshot(args) {
+    assertBrowserContextInitialized(this._browserContext);
+    const sliceMachineConfig = await this.project.getSliceMachineConfig();
+    if (!sliceMachineConfig.localSliceSimulatorURL) {
+      throw new Error("A local Slice Simulator URL must be configured in your Slice Machine configuration file.");
+    }
+    const url = new URL(sliceMachineConfig.localSliceSimulatorURL);
+    url.searchParams.set("lid", args.libraryID);
+    url.searchParams.set("sid", args.sliceID);
+    url.searchParams.set("vid", args.variationID);
+    const isURLAccessible = await checkIsURLAccessible.checkIsURLAccessible(url.toString());
+    if (!isURLAccessible) {
+      throw new Error(`Slice Simulator URL is not accessible: ${url}`);
+    }
+    const page = await this._browserContext.newPage();
+    page.setViewport(args.viewport || DEFAULT_SCREENSHOT_VIEWPORT);
+    await page.goto(url.toString());
+    await page.waitForSelector(SLICE_SIMULATOR_ROOT_SELECTOR, {
+      timeout: SLICE_SIMULATOR_LOAD_TIMEOUT
+    });
+    const element = await page.$(SLICE_SIMULATOR_ROOT_SELECTOR);
+    if (!element) {
+      const baseURL = new URL(url.pathname, url.origin);
+      throw new Error(`Slice Simulator could not find the element to screenshot. Verify the URL is correct: ${baseURL}`);
+    }
+    const data = await element.screenshot({ encoding: "binary" });
+    return {
+      data
+    };
+  }
+  async uploadScreenshot(args) {
+    assertS3ACLInitialized(this._s3ACL);
+    const formData = new esm_min.FormData();
+    for (const requiredFormDataFieldKey in this._s3ACL.requiredFormDataFields) {
+      formData.append(requiredFormDataFieldKey, this._s3ACL.requiredFormDataFields[requiredFormDataFieldKey]);
+    }
+    const contentDigest = createContentDigest.createContentDigest(args.data);
+    const fileType = await core.fileTypeFromBuffer(args.data);
+    const fileName = fileType ? `${contentDigest}.${fileType.ext}` : contentDigest;
+    const key = args.keyPrefix ? `${args.keyPrefix}/${fileName}` : fileName;
+    formData.set("key", key);
+    if (fileType) {
+      formData.set("Content-Type", fileType.mime);
+    }
+    formData.set("file", new index$1.default([args.data], { type: fileType == null ? void 0 : fileType.mime }));
+    const res = await index.default(this._s3ACL.uploadEndpoint, {
+      method: "POST",
+      body: formData
+    });
+    if (res.ok) {
+      const url = new URL(key, this._s3ACL.imgixEndpoint);
+      url.searchParams.set("auto", "compress,format");
+      return {
+        url: url.toString()
+      };
+    } else {
+      throw new Error(`Unable to upload screenshot with status code: ${res.status}`);
+    }
+  }
+}
+exports.ScreenshotsManager = ScreenshotsManager;
+exports.assertBrowserContextInitialized = assertBrowserContextInitialized;
+exports.assertS3ACLInitialized = assertS3ACLInitialized;
+//# sourceMappingURL=ScreenshotsManager.cjs.map

package/dist/managers/screenshots/ScreenshotsManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScreenshotsManager.cjs","sources":["../../../../src/managers/screenshots/ScreenshotsManager.ts"],"sourcesContent":["import * as t from \"io-ts\";\nimport { fileTypeFromBuffer } from \"file-type\";\nimport fetch, { FormData, Blob } from \"node-fetch\";\n// puppeteer is lazy-loaded in captureSliceSimulatorScreenshot\nimport type { BrowserContext, Viewport } from \"puppeteer\";\n\nimport { checkIsURLAccessible } from \"../../lib/checkIsURLAccessible\";\nimport { createContentDigest } from \"../../lib/createContentDigest\";\nimport { decode } from \"../../lib/decode\";\n\nimport { S3ACL } from \"../../types\";\nimport { SLICE_MACHINE_USER_AGENT } from \"../../constants/SLICE_MACHINE_USER_AGENT\";\nimport { API_ENDPOINTS } from \"../../constants/API_ENDPOINTS\";\nimport { InternalError } from \"../../errors\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nconst SLICE_SIMULATOR_LOAD_TIMEOUT = 10_000; // ms\nconst SLICE_SIMULATOR_ROOT_SELECTOR = \"#root\";\n\nconst DEFAULT_SCREENSHOT_VIEWPORT: Viewport = {\n\twidth: 1200,\n\theight: 800,\n};\n\nexport function assertS3ACLInitialized(\n\ts3ACL: S3ACL | undefined,\n): asserts s3ACL is NonNullable<typeof s3ACL> {\n\tif (s3ACL == undefined) {\n\t\tthrow new Error(\n\t\t\t\"An S3 ACL has not been initialized. Run `SliceMachineManager.screenshots.prototype.initS3ACL()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport function assertBrowserContextInitialized(\n\tbrowserContext: BrowserContext | undefined,\n): asserts browserContext is NonNullable<typeof browserContext> {\n\tif (browserContext == undefined) {\n\t\tthrow new Error(\n\t\t\t\"A browser context has not been initialized. Run `SliceMachineManager.screenshots.prototype.initBrowserContext()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\ntype ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs = {\n\tlibraryID: string;\n\tsliceID: string;\n\tvariationID: string;\n\tviewport?: Viewport;\n};\n\ntype ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType = {\n\tdata: Buffer;\n};\n\ntype ScreenshotsManagerUploadScreenshotArgs = {\n\tdata: Buffer;\n\tkeyPrefix?: string;\n};\n\ntype ScreenshotsManagerUploadScreenshotReturnType = {\n\turl: string;\n};\n\nexport class ScreenshotsManager extends BaseManager {\n\tprivate _browserContext: BrowserContext | undefined;\n\tprivate _s3ACL: S3ACL | undefined;\n\n\tasync initBrowserContext(): Promise<void> {\n\t\tif (this._browserContext) {\n\t\t\treturn;\n\t\t}\n\n\t\tlet puppeteer: typeof import(\"puppeteer\");\n\t\ttry {\n\t\t\t// Lazy-load Puppeteer only once it is needed.\n\t\t\tpuppeteer = await import(\"puppeteer\");\n\t\t} catch {\n\t\t\tthrow new InternalError(\n\t\t\t\t\"Screenshots require Puppeteer but Puppeteer was not found. Check that the `puppeteer` package is installed before trying again.\",\n\t\t\t);\n\t\t}\n\n\t\tconst browser = await puppeteer.launch();\n\n\t\tthis._browserContext = await browser.createIncognitoBrowserContext();\n\t}\n\n\tasync initS3ACL(): Promise<void> {\n\t\tif (this._s3ACL) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst sliceMachineConfig = await this.project.getSliceMachineConfig();\n\t\tconst authenticationToken = await this.user.getAuthenticationToken();\n\n\t\tconst awsACLURL = new URL(\"create\", API_ENDPOINTS.AwsAclProvider);\n\t\tconst awsACLRes = await fetch(awsACLURL.toString(), {\n\t\t\theaders: {\n\t\t\t\tAuthorization: `Bearer ${authenticationToken}`,\n\t\t\t\t\"User-Agent\": SLICE_MACHINE_USER_AGENT,\n\t\t\t\tRepository: sliceMachineConfig.repositoryName,\n\t\t\t},\n\t\t});\n\t\tconst awsACLJSON = await awsACLRes.json();\n\n\t\tconst { value: awsACL, error } = decode(\n\t\t\tt.intersection([\n\t\t\t\tt.type({\n\t\t\t\t\tvalues: t.type({\n\t\t\t\t\t\turl: t.string,\n\t\t\t\t\t\tfields: t.record(t.string, t.string),\n\t\t\t\t\t}),\n\t\t\t\t\timgixEndpoint: t.string,\n\t\t\t\t}),\n\t\t\t\tt.partial({\n\t\t\t\t\tmessage: t.string,\n\t\t\t\t\tMessage: t.string,\n\t\t\t\t\terror: t.string,\n\t\t\t\t}),\n\t\t\t]),\n\t\t\tawsACLJSON,\n\t\t);\n\n\t\tif (error) {\n\t\t\tthrow new Error(`Invalid AWS ACL response from ${awsACLURL}`);\n\t\t}\n\n\t\tconst errorMessage = awsACL.error || awsACL.message || awsACL.Message;\n\t\tif (errorMessage) {\n\t\t\tthrow new Error(`Failed to create an AWS ACL: ${errorMessage}`);\n\t\t}\n\n\t\tthis._s3ACL = {\n\t\t\tuploadEndpoint: awsACL.values.url,\n\t\t\trequiredFormDataFields: awsACL.values.fields,\n\t\t\timgixEndpoint: awsACL.imgixEndpoint,\n\t\t};\n\t}\n\n\t// TODO: Abstract to a generic `captureScreenshot()` method that is\n\t// used within a Slice-specific method in SliceManager.\n\tasync captureSliceSimulatorScreenshot(\n\t\targs: ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs,\n\t): Promise<ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType> {\n\t\tassertBrowserContextInitialized(this._browserContext);\n\n\t\tconst sliceMachineConfig = await this.project.getSliceMachineConfig();\n\n\t\tif (!sliceMachineConfig.localSliceSimulatorURL) {\n\t\t\t// TODO: Provide a more helpful error message.\n\t\t\tthrow new Error(\n\t\t\t\t\"A local Slice Simulator URL must be configured in your Slice Machine configuration file.\",\n\t\t\t);\n\t\t}\n\n\t\tconst url = new URL(sliceMachineConfig.localSliceSimulatorURL);\n\t\turl.searchParams.set(\"lid\", args.libraryID);\n\t\turl.searchParams.set(\"sid\", args.sliceID);\n\t\turl.searchParams.set(\"vid\", args.variationID);\n\n\t\tconst isURLAccessible = await checkIsURLAccessible(url.toString());\n\n\t\tif (!isURLAccessible) {\n\t\t\tthrow new Error(`Slice Simulator URL is not accessible: ${url}`);\n\t\t}\n\n\t\tconst page = await this._browserContext.newPage();\n\t\tpage.setViewport(args.viewport || DEFAULT_SCREENSHOT_VIEWPORT);\n\n\t\t// TODO: I removed `goto`'s `{ waitUntil: \"networkidle2\" }` option.\n\t\t// Good idea? Bad idea?\n\t\tawait page.goto(url.toString());\n\t\tawait page.waitForSelector(SLICE_SIMULATOR_ROOT_SELECTOR, {\n\t\t\ttimeout: SLICE_SIMULATOR_LOAD_TIMEOUT,\n\t\t});\n\n\t\tconst element = await page.$(SLICE_SIMULATOR_ROOT_SELECTOR);\n\t\tif (!element) {\n\t\t\tconst baseURL = new URL(url.pathname, url.origin);\n\n\t\t\tthrow new Error(\n\t\t\t\t`Slice Simulator could not find the element to screenshot. Verify the URL is correct: ${baseURL}`,\n\t\t\t);\n\t\t}\n\n\t\tconst data = (await element.screenshot({ encoding: \"binary\" })) as Buffer;\n\n\t\treturn {\n\t\t\tdata,\n\t\t};\n\t}\n\n\tasync uploadScreenshot(\n\t\targs: ScreenshotsManagerUploadScreenshotArgs,\n\t): Promise<ScreenshotsManagerUploadScreenshotReturnType> {\n\t\tassertS3ACLInitialized(this._s3ACL);\n\n\t\tconst formData = new FormData();\n\n\t\tfor (const requiredFormDataFieldKey in this._s3ACL.requiredFormDataFields) {\n\t\t\tformData.append(\n\t\t\t\trequiredFormDataFieldKey,\n\t\t\t\tthis._s3ACL.requiredFormDataFields[requiredFormDataFieldKey],\n\t\t\t);\n\t\t}\n\n\t\tconst contentDigest = createContentDigest(args.data);\n\t\tconst fileType = await fileTypeFromBuffer(args.data);\n\t\tconst fileName = fileType\n\t\t\t? `${contentDigest}.${fileType.ext}`\n\t\t\t: contentDigest;\n\t\tconst key = args.keyPrefix ? `${args.keyPrefix}/${fileName}` : fileName;\n\n\t\tformData.set(\"key\", key);\n\n\t\tif (fileType) {\n\t\t\tformData.set(\"Content-Type\", fileType.mime);\n\t\t}\n\n\t\tformData.set(\"file\", new Blob([args.data], { type: fileType?.mime }));\n\n\t\tconst res = await fetch(this._s3ACL.uploadEndpoint, {\n\t\t\tmethod: \"POST\",\n\t\t\tbody: formData,\n\t\t});\n\n\t\tif (res.ok) {\n\t\t\tconst url = new URL(key, this._s3ACL.imgixEndpoint);\n\t\t\turl.searchParams.set(\"auto\", \"compress,format\");\n\n\t\t\treturn {\n\t\t\t\turl: url.toString(),\n\t\t\t};\n\t\t} else {\n\t\t\tthrow new Error(\n\t\t\t\t`Unable to upload screenshot with status code: ${res.status}`,\n\t\t\t);\n\t\t}\n\t}\n}\n"],"names":["BaseManager","InternalError","API_ENDPOINTS","fetch","SLICE_MACHINE_USER_AGENT","decode","t","checkIsURLAccessible","FormData","createContentDigest","fileTypeFromBuffer","Blob"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiBA,MAAM,+BAA+B;AACrC,MAAM,gCAAgC;AAEtC,MAAM,8BAAwC;AAAA,EAC7C,OAAO;AAAA,EACP,QAAQ;;AAGH,SAAU,uBACf,OAAwB;AAExB,MAAI,SAAS,QAAW;AACjB,UAAA,IAAI,MACT,gIAAgI;AAAA,EAEjI;AACF;AAEM,SAAU,gCACf,gBAA0C;AAE1C,MAAI,kBAAkB,QAAW;AAC1B,UAAA,IAAI,MACT,iJAAiJ;AAAA,EAElJ;AACF;AAsBM,MAAO,2BAA2BA,YAAAA,YAAW;AAAA,EAA7C;AAAA;AACG;AACA;AAAA;AAAA,EAER,MAAM,qBAAkB;AACvB,QAAI,KAAK,iBAAiB;AACzB;AAAA,IACA;AAEG,QAAA;AACA,QAAA;AAES,kBAAA,MAAM,OAAO,WAAW;AAAA,IAAA,QACnC;AACK,YAAA,IAAIC,OAAAA,cACT,iIAAiI;AAAA,IAElI;AAEK,UAAA,UAAU,MAAM,UAAU;AAE3B,SAAA,kBAAkB,MAAM,QAAQ;EACtC;AAAA,EAEA,MAAM,YAAS;AACd,QAAI,KAAK,QAAQ;AAChB;AAAA,IACA;AAED,UAAM,qBAAqB,MAAM,KAAK,QAAQ,sBAAqB;AACnE,UAAM,sBAAsB,MAAM,KAAK,KAAK,uBAAsB;AAElE,UAAM,YAAY,IAAI,IAAI,UAAUC,4BAAc,cAAc;AAChE,UAAM,YAAY,MAAMC,MAAAA,QAAM,UAAU,YAAY;AAAA,MACnD,SAAS;AAAA,QACR,eAAe,UAAU;AAAA,QACzB,cAAcC,yBAAA;AAAA,QACd,YAAY,mBAAmB;AAAA,MAC/B;AAAA,IAAA,CACD;AACK,UAAA,aAAa,MAAM,UAAU;AAEnC,UAAM,EAAE,OAAO,QAAQ,MAAU,IAAAC,OAAA,OAChCC,aAAE,aAAa;AAAA,MACdA,aAAE,KAAK;AAAA,QACN,QAAQA,aAAE,KAAK;AAAA,UACd,KAAKA,aAAE;AAAA,UACP,QAAQA,aAAE,OAAOA,aAAE,QAAQA,aAAE,MAAM;AAAA,QAAA,CACnC;AAAA,QACD,eAAeA,aAAE;AAAA,MAAA,CACjB;AAAA,MACDA,aAAE,QAAQ;AAAA,QACT,SAASA,aAAE;AAAA,QACX,SAASA,aAAE;AAAA,QACX,OAAOA,aAAE;AAAA,MAAA,CACT;AAAA,IAAA,CACD,GACD,UAAU;AAGX,QAAI,OAAO;AACJ,YAAA,IAAI,MAAM,iCAAiC,WAAW;AAAA,IAC5D;AAED,UAAM,eAAe,OAAO,SAAS,OAAO,WAAW,OAAO;AAC9D,QAAI,cAAc;AACX,YAAA,IAAI,MAAM,gCAAgC,cAAc;AAAA,IAC9D;AAED,SAAK,SAAS;AAAA,MACb,gBAAgB,OAAO,OAAO;AAAA,MAC9B,wBAAwB,OAAO,OAAO;AAAA,MACtC,eAAe,OAAO;AAAA,IAAA;AAAA,EAExB;AAAA;AAAA;AAAA,EAIA,MAAM,gCACL,MAA2D;AAE3D,oCAAgC,KAAK,eAAe;AAEpD,UAAM,qBAAqB,MAAM,KAAK,QAAQ,sBAAqB;AAE/D,QAAA,CAAC,mBAAmB,wBAAwB;AAEzC,YAAA,IAAI,MACT,0FAA0F;AAAA,IAE3F;AAED,UAAM,MAAM,IAAI,IAAI,mBAAmB,sBAAsB;AAC7D,QAAI,aAAa,IAAI,OAAO,KAAK,SAAS;AAC1C,QAAI,aAAa,IAAI,OAAO,KAAK,OAAO;AACxC,QAAI,aAAa,IAAI,OAAO,KAAK,WAAW;AAE5C,UAAM,kBAAkB,MAAMC,qBAAAA,qBAAqB,IAAI,SAAU,CAAA;AAEjE,QAAI,CAAC,iBAAiB;AACf,YAAA,IAAI,MAAM,0CAA0C,KAAK;AAAA,IAC/D;AAED,UAAM,OAAO,MAAM,KAAK,gBAAgB,QAAO;AAC1C,SAAA,YAAY,KAAK,YAAY,2BAA2B;AAI7D,UAAM,KAAK,KAAK,IAAI,SAAU,CAAA;AACxB,UAAA,KAAK,gBAAgB,+BAA+B;AAAA,MACzD,SAAS;AAAA,IAAA,CACT;AAED,UAAM,UAAU,MAAM,KAAK,EAAE,6BAA6B;AAC1D,QAAI,CAAC,SAAS;AACb,YAAM,UAAU,IAAI,IAAI,IAAI,UAAU,IAAI,MAAM;AAE1C,YAAA,IAAI,MACT,wFAAwF,SAAS;AAAA,IAElG;AAED,UAAM,OAAQ,MAAM,QAAQ,WAAW,EAAE,UAAU,UAAU;AAEtD,WAAA;AAAA,MACN;AAAA,IAAA;AAAA,EAEF;AAAA,EAEA,MAAM,iBACL,MAA4C;AAE5C,2BAAuB,KAAK,MAAM;AAE5B,UAAA,WAAW,IAAIC,QAAAA;AAEV,eAAA,4BAA4B,KAAK,OAAO,wBAAwB;AAC1E,eAAS,OACR,0BACA,KAAK,OAAO,uBAAuB,wBAAwB,CAAC;AAAA,IAE7D;AAEK,UAAA,gBAAgBC,oBAAAA,oBAAoB,KAAK,IAAI;AACnD,UAAM,WAAW,MAAMC,KAAAA,mBAAmB,KAAK,IAAI;AACnD,UAAM,WAAW,WACd,GAAG,iBAAiB,SAAS,QAC7B;AACH,UAAM,MAAM,KAAK,YAAY,GAAG,KAAK,aAAa,aAAa;AAEtD,aAAA,IAAI,OAAO,GAAG;AAEvB,QAAI,UAAU;AACJ,eAAA,IAAI,gBAAgB,SAAS,IAAI;AAAA,IAC1C;AAED,aAAS,IAAI,QAAQ,IAAIC,QAAAA,QAAK,CAAC,KAAK,IAAI,GAAG,EAAE,MAAM,qCAAU,KAAA,CAAM,CAAC;AAEpE,UAAM,MAAM,MAAMR,MAAAA,QAAM,KAAK,OAAO,gBAAgB;AAAA,MACnD,QAAQ;AAAA,MACR,MAAM;AAAA,IAAA,CACN;AAED,QAAI,IAAI,IAAI;AACX,YAAM,MAAM,IAAI,IAAI,KAAK,KAAK,OAAO,aAAa;AAC9C,UAAA,aAAa,IAAI,QAAQ,iBAAiB;AAEvC,aAAA;AAAA,QACN,KAAK,IAAI,SAAU;AAAA,MAAA;AAAA,WAEd;AACN,YAAM,IAAI,MACT,iDAAiD,IAAI,QAAQ;AAAA,IAE9D;AAAA,EACF;AACA;;;;"}

package/dist/managers/screenshots/ScreenshotsManager.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import type { BrowserContext, Viewport } from "puppeteer";
+import { S3ACL } from "../../types";
+import { BaseManager } from "../BaseManager";
+export declare function assertS3ACLInitialized(s3ACL: S3ACL | undefined): asserts s3ACL is NonNullable<typeof s3ACL>;
+export declare function assertBrowserContextInitialized(browserContext: BrowserContext | undefined): asserts browserContext is NonNullable<typeof browserContext>;
+type ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs = {
+    libraryID: string;
+    sliceID: string;
+    variationID: string;
+    viewport?: Viewport;
+};
+type ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType = {
+    data: Buffer;
+};
+type ScreenshotsManagerUploadScreenshotArgs = {
+    data: Buffer;
+    keyPrefix?: string;
+};
+type ScreenshotsManagerUploadScreenshotReturnType = {
+    url: string;
+};
+export declare class ScreenshotsManager extends BaseManager {
+    private _browserContext;
+    private _s3ACL;
+    initBrowserContext(): Promise<void>;
+    initS3ACL(): Promise<void>;
+    captureSliceSimulatorScreenshot(args: ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs): Promise<ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType>;
+    uploadScreenshot(args: ScreenshotsManagerUploadScreenshotArgs): Promise<ScreenshotsManagerUploadScreenshotReturnType>;
+}
+export {};

package/dist/managers/screenshots/ScreenshotsManager.js

@@ -0,0 +1,168 @@
+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 * as t from "io-ts";
+import "node:buffer";
+import "readable-web-to-node-stream";
+import { fileTypeFromBuffer } from './../../__node_modules/file-type/core.js';
+import fetch from './../../__node_modules/node-fetch/src/index.js';
+import { checkIsURLAccessible } from "../../lib/checkIsURLAccessible.js";
+import { createContentDigest } from "../../lib/createContentDigest.js";
+import { decode } from "../../lib/decode.js";
+import { SLICE_MACHINE_USER_AGENT } from "../../constants/SLICE_MACHINE_USER_AGENT.js";
+import { API_ENDPOINTS } from "../../constants/API_ENDPOINTS.js";
+import { InternalError } from "../../errors.js";
+import { BaseManager } from "../BaseManager.js";
+import { FormData } from './../../__node_modules/formdata-polyfill/esm.min.js';
+import Blob from './../../__node_modules/fetch-blob/index.js';
+import "node:fs";
+import "node:path";
+import './../../__node_modules/node-domexception/index.js';
+const SLICE_SIMULATOR_LOAD_TIMEOUT = 1e4;
+const SLICE_SIMULATOR_ROOT_SELECTOR = "#root";
+const DEFAULT_SCREENSHOT_VIEWPORT = {
+  width: 1200,
+  height: 800
+};
+function assertS3ACLInitialized(s3ACL) {
+  if (s3ACL == void 0) {
+    throw new Error("An S3 ACL has not been initialized. Run `SliceMachineManager.screenshots.prototype.initS3ACL()` before re-calling this method.");
+  }
+}
+function assertBrowserContextInitialized(browserContext) {
+  if (browserContext == void 0) {
+    throw new Error("A browser context has not been initialized. Run `SliceMachineManager.screenshots.prototype.initBrowserContext()` before re-calling this method.");
+  }
+}
+class ScreenshotsManager extends BaseManager {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_browserContext");
+    __publicField(this, "_s3ACL");
+  }
+  async initBrowserContext() {
+    if (this._browserContext) {
+      return;
+    }
+    let puppeteer;
+    try {
+      puppeteer = await import("puppeteer");
+    } catch {
+      throw new InternalError("Screenshots require Puppeteer but Puppeteer was not found. Check that the `puppeteer` package is installed before trying again.");
+    }
+    const browser = await puppeteer.launch();
+    this._browserContext = await browser.createIncognitoBrowserContext();
+  }
+  async initS3ACL() {
+    if (this._s3ACL) {
+      return;
+    }
+    const sliceMachineConfig = await this.project.getSliceMachineConfig();
+    const authenticationToken = await this.user.getAuthenticationToken();
+    const awsACLURL = new URL("create", API_ENDPOINTS.AwsAclProvider);
+    const awsACLRes = await fetch(awsACLURL.toString(), {
+      headers: {
+        Authorization: `Bearer ${authenticationToken}`,
+        "User-Agent": SLICE_MACHINE_USER_AGENT,
+        Repository: sliceMachineConfig.repositoryName
+      }
+    });
+    const awsACLJSON = await awsACLRes.json();
+    const { value: awsACL, error } = decode(t.intersection([
+      t.type({
+        values: t.type({
+          url: t.string,
+          fields: t.record(t.string, t.string)
+        }),
+        imgixEndpoint: t.string
+      }),
+      t.partial({
+        message: t.string,
+        Message: t.string,
+        error: t.string
+      })
+    ]), awsACLJSON);
+    if (error) {
+      throw new Error(`Invalid AWS ACL response from ${awsACLURL}`);
+    }
+    const errorMessage = awsACL.error || awsACL.message || awsACL.Message;
+    if (errorMessage) {
+      throw new Error(`Failed to create an AWS ACL: ${errorMessage}`);
+    }
+    this._s3ACL = {
+      uploadEndpoint: awsACL.values.url,
+      requiredFormDataFields: awsACL.values.fields,
+      imgixEndpoint: awsACL.imgixEndpoint
+    };
+  }
+  // TODO: Abstract to a generic `captureScreenshot()` method that is
+  // used within a Slice-specific method in SliceManager.
+  async captureSliceSimulatorScreenshot(args) {
+    assertBrowserContextInitialized(this._browserContext);
+    const sliceMachineConfig = await this.project.getSliceMachineConfig();
+    if (!sliceMachineConfig.localSliceSimulatorURL) {
+      throw new Error("A local Slice Simulator URL must be configured in your Slice Machine configuration file.");
+    }
+    const url = new URL(sliceMachineConfig.localSliceSimulatorURL);
+    url.searchParams.set("lid", args.libraryID);
+    url.searchParams.set("sid", args.sliceID);
+    url.searchParams.set("vid", args.variationID);
+    const isURLAccessible = await checkIsURLAccessible(url.toString());
+    if (!isURLAccessible) {
+      throw new Error(`Slice Simulator URL is not accessible: ${url}`);
+    }
+    const page = await this._browserContext.newPage();
+    page.setViewport(args.viewport || DEFAULT_SCREENSHOT_VIEWPORT);
+    await page.goto(url.toString());
+    await page.waitForSelector(SLICE_SIMULATOR_ROOT_SELECTOR, {
+      timeout: SLICE_SIMULATOR_LOAD_TIMEOUT
+    });
+    const element = await page.$(SLICE_SIMULATOR_ROOT_SELECTOR);
+    if (!element) {
+      const baseURL = new URL(url.pathname, url.origin);
+      throw new Error(`Slice Simulator could not find the element to screenshot. Verify the URL is correct: ${baseURL}`);
+    }
+    const data = await element.screenshot({ encoding: "binary" });
+    return {
+      data
+    };
+  }
+  async uploadScreenshot(args) {
+    assertS3ACLInitialized(this._s3ACL);
+    const formData = new FormData();
+    for (const requiredFormDataFieldKey in this._s3ACL.requiredFormDataFields) {
+      formData.append(requiredFormDataFieldKey, this._s3ACL.requiredFormDataFields[requiredFormDataFieldKey]);
+    }
+    const contentDigest = createContentDigest(args.data);
+    const fileType = await fileTypeFromBuffer(args.data);
+    const fileName = fileType ? `${contentDigest}.${fileType.ext}` : contentDigest;
+    const key = args.keyPrefix ? `${args.keyPrefix}/${fileName}` : fileName;
+    formData.set("key", key);
+    if (fileType) {
+      formData.set("Content-Type", fileType.mime);
+    }
+    formData.set("file", new Blob([args.data], { type: fileType == null ? void 0 : fileType.mime }));
+    const res = await fetch(this._s3ACL.uploadEndpoint, {
+      method: "POST",
+      body: formData
+    });
+    if (res.ok) {
+      const url = new URL(key, this._s3ACL.imgixEndpoint);
+      url.searchParams.set("auto", "compress,format");
+      return {
+        url: url.toString()
+      };
+    } else {
+      throw new Error(`Unable to upload screenshot with status code: ${res.status}`);
+    }
+  }
+}
+export {
+  ScreenshotsManager,
+  assertBrowserContextInitialized,
+  assertS3ACLInitialized
+};
+//# sourceMappingURL=ScreenshotsManager.js.map

package/dist/managers/screenshots/ScreenshotsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScreenshotsManager.js","sources":["../../../../src/managers/screenshots/ScreenshotsManager.ts"],"sourcesContent":["import * as t from \"io-ts\";\nimport { fileTypeFromBuffer } from \"file-type\";\nimport fetch, { FormData, Blob } from \"node-fetch\";\n// puppeteer is lazy-loaded in captureSliceSimulatorScreenshot\nimport type { BrowserContext, Viewport } from \"puppeteer\";\n\nimport { checkIsURLAccessible } from \"../../lib/checkIsURLAccessible\";\nimport { createContentDigest } from \"../../lib/createContentDigest\";\nimport { decode } from \"../../lib/decode\";\n\nimport { S3ACL } from \"../../types\";\nimport { SLICE_MACHINE_USER_AGENT } from \"../../constants/SLICE_MACHINE_USER_AGENT\";\nimport { API_ENDPOINTS } from \"../../constants/API_ENDPOINTS\";\nimport { InternalError } from \"../../errors\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nconst SLICE_SIMULATOR_LOAD_TIMEOUT = 10_000; // ms\nconst SLICE_SIMULATOR_ROOT_SELECTOR = \"#root\";\n\nconst DEFAULT_SCREENSHOT_VIEWPORT: Viewport = {\n\twidth: 1200,\n\theight: 800,\n};\n\nexport function assertS3ACLInitialized(\n\ts3ACL: S3ACL | undefined,\n): asserts s3ACL is NonNullable<typeof s3ACL> {\n\tif (s3ACL == undefined) {\n\t\tthrow new Error(\n\t\t\t\"An S3 ACL has not been initialized. Run `SliceMachineManager.screenshots.prototype.initS3ACL()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport function assertBrowserContextInitialized(\n\tbrowserContext: BrowserContext | undefined,\n): asserts browserContext is NonNullable<typeof browserContext> {\n\tif (browserContext == undefined) {\n\t\tthrow new Error(\n\t\t\t\"A browser context has not been initialized. Run `SliceMachineManager.screenshots.prototype.initBrowserContext()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\ntype ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs = {\n\tlibraryID: string;\n\tsliceID: string;\n\tvariationID: string;\n\tviewport?: Viewport;\n};\n\ntype ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType = {\n\tdata: Buffer;\n};\n\ntype ScreenshotsManagerUploadScreenshotArgs = {\n\tdata: Buffer;\n\tkeyPrefix?: string;\n};\n\ntype ScreenshotsManagerUploadScreenshotReturnType = {\n\turl: string;\n};\n\nexport class ScreenshotsManager extends BaseManager {\n\tprivate _browserContext: BrowserContext | undefined;\n\tprivate _s3ACL: S3ACL | undefined;\n\n\tasync initBrowserContext(): Promise<void> {\n\t\tif (this._browserContext) {\n\t\t\treturn;\n\t\t}\n\n\t\tlet puppeteer: typeof import(\"puppeteer\");\n\t\ttry {\n\t\t\t// Lazy-load Puppeteer only once it is needed.\n\t\t\tpuppeteer = await import(\"puppeteer\");\n\t\t} catch {\n\t\t\tthrow new InternalError(\n\t\t\t\t\"Screenshots require Puppeteer but Puppeteer was not found. Check that the `puppeteer` package is installed before trying again.\",\n\t\t\t);\n\t\t}\n\n\t\tconst browser = await puppeteer.launch();\n\n\t\tthis._browserContext = await browser.createIncognitoBrowserContext();\n\t}\n\n\tasync initS3ACL(): Promise<void> {\n\t\tif (this._s3ACL) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst sliceMachineConfig = await this.project.getSliceMachineConfig();\n\t\tconst authenticationToken = await this.user.getAuthenticationToken();\n\n\t\tconst awsACLURL = new URL(\"create\", API_ENDPOINTS.AwsAclProvider);\n\t\tconst awsACLRes = await fetch(awsACLURL.toString(), {\n\t\t\theaders: {\n\t\t\t\tAuthorization: `Bearer ${authenticationToken}`,\n\t\t\t\t\"User-Agent\": SLICE_MACHINE_USER_AGENT,\n\t\t\t\tRepository: sliceMachineConfig.repositoryName,\n\t\t\t},\n\t\t});\n\t\tconst awsACLJSON = await awsACLRes.json();\n\n\t\tconst { value: awsACL, error } = decode(\n\t\t\tt.intersection([\n\t\t\t\tt.type({\n\t\t\t\t\tvalues: t.type({\n\t\t\t\t\t\turl: t.string,\n\t\t\t\t\t\tfields: t.record(t.string, t.string),\n\t\t\t\t\t}),\n\t\t\t\t\timgixEndpoint: t.string,\n\t\t\t\t}),\n\t\t\t\tt.partial({\n\t\t\t\t\tmessage: t.string,\n\t\t\t\t\tMessage: t.string,\n\t\t\t\t\terror: t.string,\n\t\t\t\t}),\n\t\t\t]),\n\t\t\tawsACLJSON,\n\t\t);\n\n\t\tif (error) {\n\t\t\tthrow new Error(`Invalid AWS ACL response from ${awsACLURL}`);\n\t\t}\n\n\t\tconst errorMessage = awsACL.error || awsACL.message || awsACL.Message;\n\t\tif (errorMessage) {\n\t\t\tthrow new Error(`Failed to create an AWS ACL: ${errorMessage}`);\n\t\t}\n\n\t\tthis._s3ACL = {\n\t\t\tuploadEndpoint: awsACL.values.url,\n\t\t\trequiredFormDataFields: awsACL.values.fields,\n\t\t\timgixEndpoint: awsACL.imgixEndpoint,\n\t\t};\n\t}\n\n\t// TODO: Abstract to a generic `captureScreenshot()` method that is\n\t// used within a Slice-specific method in SliceManager.\n\tasync captureSliceSimulatorScreenshot(\n\t\targs: ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs,\n\t): Promise<ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType> {\n\t\tassertBrowserContextInitialized(this._browserContext);\n\n\t\tconst sliceMachineConfig = await this.project.getSliceMachineConfig();\n\n\t\tif (!sliceMachineConfig.localSliceSimulatorURL) {\n\t\t\t// TODO: Provide a more helpful error message.\n\t\t\tthrow new Error(\n\t\t\t\t\"A local Slice Simulator URL must be configured in your Slice Machine configuration file.\",\n\t\t\t);\n\t\t}\n\n\t\tconst url = new URL(sliceMachineConfig.localSliceSimulatorURL);\n\t\turl.searchParams.set(\"lid\", args.libraryID);\n\t\turl.searchParams.set(\"sid\", args.sliceID);\n\t\turl.searchParams.set(\"vid\", args.variationID);\n\n\t\tconst isURLAccessible = await checkIsURLAccessible(url.toString());\n\n\t\tif (!isURLAccessible) {\n\t\t\tthrow new Error(`Slice Simulator URL is not accessible: ${url}`);\n\t\t}\n\n\t\tconst page = await this._browserContext.newPage();\n\t\tpage.setViewport(args.viewport || DEFAULT_SCREENSHOT_VIEWPORT);\n\n\t\t// TODO: I removed `goto`'s `{ waitUntil: \"networkidle2\" }` option.\n\t\t// Good idea? Bad idea?\n\t\tawait page.goto(url.toString());\n\t\tawait page.waitForSelector(SLICE_SIMULATOR_ROOT_SELECTOR, {\n\t\t\ttimeout: SLICE_SIMULATOR_LOAD_TIMEOUT,\n\t\t});\n\n\t\tconst element = await page.$(SLICE_SIMULATOR_ROOT_SELECTOR);\n\t\tif (!element) {\n\t\t\tconst baseURL = new URL(url.pathname, url.origin);\n\n\t\t\tthrow new Error(\n\t\t\t\t`Slice Simulator could not find the element to screenshot. Verify the URL is correct: ${baseURL}`,\n\t\t\t);\n\t\t}\n\n\t\tconst data = (await element.screenshot({ encoding: \"binary\" })) as Buffer;\n\n\t\treturn {\n\t\t\tdata,\n\t\t};\n\t}\n\n\tasync uploadScreenshot(\n\t\targs: ScreenshotsManagerUploadScreenshotArgs,\n\t): Promise<ScreenshotsManagerUploadScreenshotReturnType> {\n\t\tassertS3ACLInitialized(this._s3ACL);\n\n\t\tconst formData = new FormData();\n\n\t\tfor (const requiredFormDataFieldKey in this._s3ACL.requiredFormDataFields) {\n\t\t\tformData.append(\n\t\t\t\trequiredFormDataFieldKey,\n\t\t\t\tthis._s3ACL.requiredFormDataFields[requiredFormDataFieldKey],\n\t\t\t);\n\t\t}\n\n\t\tconst contentDigest = createContentDigest(args.data);\n\t\tconst fileType = await fileTypeFromBuffer(args.data);\n\t\tconst fileName = fileType\n\t\t\t? `${contentDigest}.${fileType.ext}`\n\t\t\t: contentDigest;\n\t\tconst key = args.keyPrefix ? `${args.keyPrefix}/${fileName}` : fileName;\n\n\t\tformData.set(\"key\", key);\n\n\t\tif (fileType) {\n\t\t\tformData.set(\"Content-Type\", fileType.mime);\n\t\t}\n\n\t\tformData.set(\"file\", new Blob([args.data], { type: fileType?.mime }));\n\n\t\tconst res = await fetch(this._s3ACL.uploadEndpoint, {\n\t\t\tmethod: \"POST\",\n\t\t\tbody: formData,\n\t\t});\n\n\t\tif (res.ok) {\n\t\t\tconst url = new URL(key, this._s3ACL.imgixEndpoint);\n\t\t\turl.searchParams.set(\"auto\", \"compress,format\");\n\n\t\t\treturn {\n\t\t\t\turl: url.toString(),\n\t\t\t};\n\t\t} else {\n\t\t\tthrow new Error(\n\t\t\t\t`Unable to upload screenshot with status code: ${res.status}`,\n\t\t\t);\n\t\t}\n\t}\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAiBA,MAAM,+BAA+B;AACrC,MAAM,gCAAgC;AAEtC,MAAM,8BAAwC;AAAA,EAC7C,OAAO;AAAA,EACP,QAAQ;;AAGH,SAAU,uBACf,OAAwB;AAExB,MAAI,SAAS,QAAW;AACjB,UAAA,IAAI,MACT,gIAAgI;AAAA,EAEjI;AACF;AAEM,SAAU,gCACf,gBAA0C;AAE1C,MAAI,kBAAkB,QAAW;AAC1B,UAAA,IAAI,MACT,iJAAiJ;AAAA,EAElJ;AACF;AAsBM,MAAO,2BAA2B,YAAW;AAAA,EAA7C;AAAA;AACG;AACA;AAAA;AAAA,EAER,MAAM,qBAAkB;AACvB,QAAI,KAAK,iBAAiB;AACzB;AAAA,IACA;AAEG,QAAA;AACA,QAAA;AAES,kBAAA,MAAM,OAAO,WAAW;AAAA,IAAA,QACnC;AACK,YAAA,IAAI,cACT,iIAAiI;AAAA,IAElI;AAEK,UAAA,UAAU,MAAM,UAAU;AAE3B,SAAA,kBAAkB,MAAM,QAAQ;EACtC;AAAA,EAEA,MAAM,YAAS;AACd,QAAI,KAAK,QAAQ;AAChB;AAAA,IACA;AAED,UAAM,qBAAqB,MAAM,KAAK,QAAQ,sBAAqB;AACnE,UAAM,sBAAsB,MAAM,KAAK,KAAK,uBAAsB;AAElE,UAAM,YAAY,IAAI,IAAI,UAAU,cAAc,cAAc;AAChE,UAAM,YAAY,MAAM,MAAM,UAAU,YAAY;AAAA,MACnD,SAAS;AAAA,QACR,eAAe,UAAU;AAAA,QACzB,cAAc;AAAA,QACd,YAAY,mBAAmB;AAAA,MAC/B;AAAA,IAAA,CACD;AACK,UAAA,aAAa,MAAM,UAAU;AAEnC,UAAM,EAAE,OAAO,QAAQ,MAAU,IAAA,OAChC,EAAE,aAAa;AAAA,MACd,EAAE,KAAK;AAAA,QACN,QAAQ,EAAE,KAAK;AAAA,UACd,KAAK,EAAE;AAAA,UACP,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;AAAA,QAAA,CACnC;AAAA,QACD,eAAe,EAAE;AAAA,MAAA,CACjB;AAAA,MACD,EAAE,QAAQ;AAAA,QACT,SAAS,EAAE;AAAA,QACX,SAAS,EAAE;AAAA,QACX,OAAO,EAAE;AAAA,MAAA,CACT;AAAA,IAAA,CACD,GACD,UAAU;AAGX,QAAI,OAAO;AACJ,YAAA,IAAI,MAAM,iCAAiC,WAAW;AAAA,IAC5D;AAED,UAAM,eAAe,OAAO,SAAS,OAAO,WAAW,OAAO;AAC9D,QAAI,cAAc;AACX,YAAA,IAAI,MAAM,gCAAgC,cAAc;AAAA,IAC9D;AAED,SAAK,SAAS;AAAA,MACb,gBAAgB,OAAO,OAAO;AAAA,MAC9B,wBAAwB,OAAO,OAAO;AAAA,MACtC,eAAe,OAAO;AAAA,IAAA;AAAA,EAExB;AAAA;AAAA;AAAA,EAIA,MAAM,gCACL,MAA2D;AAE3D,oCAAgC,KAAK,eAAe;AAEpD,UAAM,qBAAqB,MAAM,KAAK,QAAQ,sBAAqB;AAE/D,QAAA,CAAC,mBAAmB,wBAAwB;AAEzC,YAAA,IAAI,MACT,0FAA0F;AAAA,IAE3F;AAED,UAAM,MAAM,IAAI,IAAI,mBAAmB,sBAAsB;AAC7D,QAAI,aAAa,IAAI,OAAO,KAAK,SAAS;AAC1C,QAAI,aAAa,IAAI,OAAO,KAAK,OAAO;AACxC,QAAI,aAAa,IAAI,OAAO,KAAK,WAAW;AAE5C,UAAM,kBAAkB,MAAM,qBAAqB,IAAI,SAAU,CAAA;AAEjE,QAAI,CAAC,iBAAiB;AACf,YAAA,IAAI,MAAM,0CAA0C,KAAK;AAAA,IAC/D;AAED,UAAM,OAAO,MAAM,KAAK,gBAAgB,QAAO;AAC1C,SAAA,YAAY,KAAK,YAAY,2BAA2B;AAI7D,UAAM,KAAK,KAAK,IAAI,SAAU,CAAA;AACxB,UAAA,KAAK,gBAAgB,+BAA+B;AAAA,MACzD,SAAS;AAAA,IAAA,CACT;AAED,UAAM,UAAU,MAAM,KAAK,EAAE,6BAA6B;AAC1D,QAAI,CAAC,SAAS;AACb,YAAM,UAAU,IAAI,IAAI,IAAI,UAAU,IAAI,MAAM;AAE1C,YAAA,IAAI,MACT,wFAAwF,SAAS;AAAA,IAElG;AAED,UAAM,OAAQ,MAAM,QAAQ,WAAW,EAAE,UAAU,UAAU;AAEtD,WAAA;AAAA,MACN;AAAA,IAAA;AAAA,EAEF;AAAA,EAEA,MAAM,iBACL,MAA4C;AAE5C,2BAAuB,KAAK,MAAM;AAE5B,UAAA,WAAW,IAAI;AAEV,eAAA,4BAA4B,KAAK,OAAO,wBAAwB;AAC1E,eAAS,OACR,0BACA,KAAK,OAAO,uBAAuB,wBAAwB,CAAC;AAAA,IAE7D;AAEK,UAAA,gBAAgB,oBAAoB,KAAK,IAAI;AACnD,UAAM,WAAW,MAAM,mBAAmB,KAAK,IAAI;AACnD,UAAM,WAAW,WACd,GAAG,iBAAiB,SAAS,QAC7B;AACH,UAAM,MAAM,KAAK,YAAY,GAAG,KAAK,aAAa,aAAa;AAEtD,aAAA,IAAI,OAAO,GAAG;AAEvB,QAAI,UAAU;AACJ,eAAA,IAAI,gBAAgB,SAAS,IAAI;AAAA,IAC1C;AAED,aAAS,IAAI,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI,GAAG,EAAE,MAAM,qCAAU,KAAA,CAAM,CAAC;AAEpE,UAAM,MAAM,MAAM,MAAM,KAAK,OAAO,gBAAgB;AAAA,MACnD,QAAQ;AAAA,MACR,MAAM;AAAA,IAAA,CACN;AAED,QAAI,IAAI,IAAI;AACX,YAAM,MAAM,IAAI,IAAI,KAAK,KAAK,OAAO,aAAa;AAC9C,UAAA,aAAa,IAAI,QAAQ,iBAAiB;AAEvC,aAAA;AAAA,QACN,KAAK,IAAI,SAAU;AAAA,MAAA;AAAA,WAEd;AACN,YAAM,IAAI,MACT,iDAAiD,IAAI,QAAQ;AAAA,IAE9D;AAAA,EACF;AACA;"}

package/dist/managers/simulator/SimulatorManager.cjs

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const t = require("io-ts");
+const index = require('./../../__node_modules/node-fetch/src/index.cjs');
+const assertPluginsInitialized = require("../../lib/assertPluginsInitialized.cjs");
+const castArray = require("../../lib/castArray.cjs");
+const decode = require("../../lib/decode.cjs");
+const decodeHookResult = require("../../lib/decodeHookResult.cjs");
+const functionCodec = require("../../lib/functionCodec.cjs");
+const markdownToHTML = require("../../lib/markdownToHTML.cjs");
+const errors = require("../../errors.cjs");
+const BaseManager = require("../BaseManager.cjs");
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const t__namespace = /* @__PURE__ */ _interopNamespaceDefault(t);
+const sliceSimulatorSetupStepCodec = t__namespace.intersection([
+  t__namespace.type({
+    title: t__namespace.string,
+    body: t__namespace.string
+  }),
+  t__namespace.partial({
+    description: t__namespace.string,
+    validate: functionCodec.functionCodec
+  })
+]);
+const SliceSimulatorSetupStepValidationMessageCodec = t__namespace.type({
+  title: t__namespace.string,
+  message: t__namespace.string
+});
+class SimulatorManager extends BaseManager.BaseManager {
+  async getLocalSliceSimulatorURL() {
+    const sliceMachineConfig = await this.project.getSliceMachineConfig();
+    return sliceMachineConfig.localSliceSimulatorURL;
+  }
+  /**
+   * @throws {@link UnexpectedDataError} Thrown if the project is not configured
+   *   with a Slice Simulator URL.
+   */
+  async checkIsLocalSliceSimulatorURLAccessible() {
+    const localSliceSimulatorURL = await this.getLocalSliceSimulatorURL();
+    if (!localSliceSimulatorURL) {
+      throw new errors.UnexpectedDataError("The project has not been configured with a Slice Simulator URL. Add a `localSliceSimulatorURL` property to your project's configuration to fix this error.");
+    }
+    const res = await index.default(localSliceSimulatorURL);
+    return res.ok;
+  }
+  async readSliceSimulatorSetupSteps() {
+    assertPluginsInitialized.assertPluginsInitialized(this.sliceMachinePluginRunner);
+    const hookResult = await this.sliceMachinePluginRunner.callHook("slice-simulator:setup:read", void 0);
+    const { data, errors: errors2 } = decodeHookResult.decodeHookResult(t__namespace.array(sliceSimulatorSetupStepCodec), hookResult);
+    const steps = await Promise.all(data[0].map(async (step) => {
+      const bodyHTML = await markdownToHTML.markdownToHTML(step.body);
+      const res = {
+        title: step.title,
+        description: step.description,
+        body: bodyHTML,
+        isComplete: void 0,
+        validationMessages: []
+      };
+      if (step.validate) {
+        const validationResult = await step.validate();
+        const { value: validationMessages, error } = decode.decode(t__namespace.array(SliceSimulatorSetupStepValidationMessageCodec), validationResult == null ? [] : castArray.castArray(validationResult));
+        if (error) {
+          return res;
+        }
+        const isComplete = validationMessages.length < 1;
+        const processedValidationMessages = await Promise.all(validationMessages.map(async (validationMessage) => {
+          const messageHTML = await markdownToHTML.markdownToHTML(validationMessage.message);
+          return {
+            ...validationMessage,
+            message: messageHTML
+          };
+        }));
+        res.isComplete = isComplete;
+        res.validationMessages = processedValidationMessages;
+      }
+      return res;
+    }));
+    return {
+      steps,
+      errors: errors2
+    };
+  }
+}
+exports.SimulatorManager = SimulatorManager;
+//# sourceMappingURL=SimulatorManager.cjs.map

package/dist/managers/simulator/SimulatorManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimulatorManager.cjs","sources":["../../../../src/managers/simulator/SimulatorManager.ts"],"sourcesContent":["import * as t from \"io-ts\";\nimport { HookError } from \"@slicemachine/plugin-kit\";\nimport fetch from \"node-fetch\";\n\nimport { DecodeError } from \"../../lib/DecodeError\";\nimport { assertPluginsInitialized } from \"../../lib/assertPluginsInitialized\";\nimport { castArray } from \"../../lib/castArray\";\nimport { decode } from \"../../lib/decode\";\nimport { decodeHookResult } from \"../../lib/decodeHookResult\";\nimport { functionCodec } from \"../../lib/functionCodec\";\nimport { markdownToHTML } from \"../../lib/markdownToHTML\";\n\nimport { UnexpectedDataError } from \"../../errors\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nconst sliceSimulatorSetupStepCodec = t.intersection([\n\tt.type({\n\t\ttitle: t.string,\n\t\tbody: t.string,\n\t}),\n\tt.partial({\n\t\tdescription: t.string,\n\t\tvalidate: functionCodec,\n\t}),\n]);\n\nconst SliceSimulatorSetupStepValidationMessageCodec = t.type({\n\ttitle: t.string,\n\tmessage: t.string,\n});\ntype SliceSimulatorSetupStepValidationMessageCodec = t.TypeOf<\n\ttypeof SliceSimulatorSetupStepValidationMessageCodec\n>;\n\nexport type SimulatorManagerReadSliceSimulatorSetupStep = {\n\ttitle: string;\n\tdescription?: string;\n\tbody: string;\n\t/**\n\t * Determines if the step is completed.\n\t *\n\t * This proeprty is `undefined` if the project's adapter does not provide a\n\t * validation function for the step; we cannot know if the step is complete\n\t * without a validator.\n\t */\n\tisComplete: boolean | undefined;\n\tvalidationMessages: SliceSimulatorSetupStepValidationMessageCodec[];\n};\n\nexport type SimulatorManagerReadSliceSimulatorSetupStepsReturnType = {\n\tsteps: SimulatorManagerReadSliceSimulatorSetupStep[];\n\terrors: (DecodeError | HookError)[];\n};\n\nexport class SimulatorManager extends BaseManager {\n\tasync getLocalSliceSimulatorURL(): Promise<string | undefined> {\n\t\tconst sliceMachineConfig = await this.project.getSliceMachineConfig();\n\n\t\treturn sliceMachineConfig.localSliceSimulatorURL;\n\t}\n\n\t/**\n\t * @throws {@link UnexpectedDataError} Thrown if the project is not configured\n\t *   with a Slice Simulator URL.\n\t */\n\tasync checkIsLocalSliceSimulatorURLAccessible(): Promise<boolean> {\n\t\tconst localSliceSimulatorURL = await this.getLocalSliceSimulatorURL();\n\n\t\tif (!localSliceSimulatorURL) {\n\t\t\tthrow new UnexpectedDataError(\n\t\t\t\t\"The project has not been configured with a Slice Simulator URL. Add a `localSliceSimulatorURL` property to your project's configuration to fix this error.\",\n\t\t\t);\n\t\t}\n\n\t\tconst res = await fetch(localSliceSimulatorURL);\n\n\t\treturn res.ok;\n\t}\n\n\tasync readSliceSimulatorSetupSteps(): Promise<SimulatorManagerReadSliceSimulatorSetupStepsReturnType> {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\tconst hookResult = await this.sliceMachinePluginRunner.callHook(\n\t\t\t\"slice-simulator:setup:read\",\n\t\t\tundefined,\n\t\t);\n\t\tconst { data, errors } = decodeHookResult(\n\t\t\tt.array(sliceSimulatorSetupStepCodec),\n\t\t\thookResult,\n\t\t);\n\n\t\tconst steps = await Promise.all(\n\t\t\tdata[0].map(async (step) => {\n\t\t\t\tconst bodyHTML = await markdownToHTML(step.body);\n\n\t\t\t\tconst res: SimulatorManagerReadSliceSimulatorSetupStep = {\n\t\t\t\t\ttitle: step.title,\n\t\t\t\t\tdescription: step.description,\n\t\t\t\t\tbody: bodyHTML,\n\t\t\t\t\tisComplete: undefined,\n\t\t\t\t\tvalidationMessages: [],\n\t\t\t\t};\n\n\t\t\t\tif (step.validate) {\n\t\t\t\t\tconst validationResult = await step.validate();\n\t\t\t\t\tconst { value: validationMessages, error } = decode(\n\t\t\t\t\t\tt.array(SliceSimulatorSetupStepValidationMessageCodec),\n\t\t\t\t\t\tvalidationResult == null ? [] : castArray(validationResult),\n\t\t\t\t\t);\n\n\t\t\t\t\tif (error) {\n\t\t\t\t\t\t// TODO: We may want to do\n\t\t\t\t\t\t// something with the error,\n\t\t\t\t\t\t// like log to the console.\n\t\t\t\t\t\t// This branch should only be\n\t\t\t\t\t\t// reached if the adapter\n\t\t\t\t\t\t// returns invalid data.\n\n\t\t\t\t\t\treturn res;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst isComplete = validationMessages.length < 1;\n\n\t\t\t\t\tconst processedValidationMessages = await Promise.all(\n\t\t\t\t\t\tvalidationMessages.map(async (validationMessage) => {\n\t\t\t\t\t\t\tconst messageHTML = await markdownToHTML(\n\t\t\t\t\t\t\t\tvalidationMessage.message,\n\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\treturn {\n\t\t\t\t\t\t\t\t...validationMessage,\n\t\t\t\t\t\t\t\tmessage: messageHTML,\n\t\t\t\t\t\t\t};\n\t\t\t\t\t\t}),\n\t\t\t\t\t);\n\n\t\t\t\t\tres.isComplete = isComplete;\n\t\t\t\t\tres.validationMessages = processedValidationMessages;\n\t\t\t\t}\n\n\t\t\t\treturn res;\n\t\t\t}),\n\t\t);\n\n\t\treturn {\n\t\t\tsteps,\n\t\t\terrors,\n\t\t};\n\t}\n}\n"],"names":["t","functionCodec","BaseManager","UnexpectedDataError","fetch","assertPluginsInitialized","errors","decodeHookResult","markdownToHTML","decode","castArray"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBA,MAAM,+BAA+BA,aAAE,aAAa;AAAA,EACnDA,aAAE,KAAK;AAAA,IACN,OAAOA,aAAE;AAAA,IACT,MAAMA,aAAE;AAAA,EAAA,CACR;AAAA,EACDA,aAAE,QAAQ;AAAA,IACT,aAAaA,aAAE;AAAA,IACf,UAAUC,cAAA;AAAA,EAAA,CACV;AACD,CAAA;AAED,MAAM,gDAAgDD,aAAE,KAAK;AAAA,EAC5D,OAAOA,aAAE;AAAA,EACT,SAASA,aAAE;AACX,CAAA;AAyBK,MAAO,yBAAyBE,YAAAA,YAAW;AAAA,EAChD,MAAM,4BAAyB;AAC9B,UAAM,qBAAqB,MAAM,KAAK,QAAQ,sBAAqB;AAEnE,WAAO,mBAAmB;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,0CAAuC;AACtC,UAAA,yBAAyB,MAAM,KAAK;AAE1C,QAAI,CAAC,wBAAwB;AACtB,YAAA,IAAIC,OAAAA,oBACT,4JAA4J;AAAA,IAE7J;AAEK,UAAA,MAAM,MAAMC,cAAM,sBAAsB;AAE9C,WAAO,IAAI;AAAA,EACZ;AAAA,EAEA,MAAM,+BAA4B;AACjCC,sDAAyB,KAAK,wBAAwB;AAEtD,UAAM,aAAa,MAAM,KAAK,yBAAyB,SACtD,8BACA,MAAS;AAEJ,UAAA,EAAE,MAAM,QAAAC,QAAM,IAAKC,kCACxBP,aAAE,MAAM,4BAA4B,GACpC,UAAU;AAGL,UAAA,QAAQ,MAAM,QAAQ,IAC3B,KAAK,CAAC,EAAE,IAAI,OAAO,SAAQ;AAC1B,YAAM,WAAW,MAAMQ,eAAAA,eAAe,KAAK,IAAI;AAE/C,YAAM,MAAmD;AAAA,QACxD,OAAO,KAAK;AAAA,QACZ,aAAa,KAAK;AAAA,QAClB,MAAM;AAAA,QACN,YAAY;AAAA,QACZ,oBAAoB,CAAE;AAAA,MAAA;AAGvB,UAAI,KAAK,UAAU;AACZ,cAAA,mBAAmB,MAAM,KAAK;AACpC,cAAM,EAAE,OAAO,oBAAoB,MAAK,IAAKC,OAAAA,OAC5CT,aAAE,MAAM,6CAA6C,GACrD,oBAAoB,OAAO,CAAK,IAAAU,UAAA,UAAU,gBAAgB,CAAC;AAG5D,YAAI,OAAO;AAQH,iBAAA;AAAA,QACP;AAEK,cAAA,aAAa,mBAAmB,SAAS;AAE/C,cAAM,8BAA8B,MAAM,QAAQ,IACjD,mBAAmB,IAAI,OAAO,sBAAqB;AAClD,gBAAM,cAAc,MAAMF,eAAAA,eACzB,kBAAkB,OAAO;AAGnB,iBAAA;AAAA,YACN,GAAG;AAAA,YACH,SAAS;AAAA,UAAA;AAAA,QAEV,CAAA,CAAC;AAGH,YAAI,aAAa;AACjB,YAAI,qBAAqB;AAAA,MACzB;AAEM,aAAA;AAAA,IACP,CAAA,CAAC;AAGI,WAAA;AAAA,MACN;AAAA,MACA,QAAAF;AAAA,IAAA;AAAA,EAEF;AACA;;"}

package/dist/managers/simulator/SimulatorManager.d.ts

@@ -0,0 +1,37 @@
+import * as t from "io-ts";
+import { HookError } from "@slicemachine/plugin-kit";
+import { DecodeError } from "../../lib/DecodeError";
+import { BaseManager } from "../BaseManager";
+declare const SliceSimulatorSetupStepValidationMessageCodec: t.TypeC<{
+    title: t.StringC;
+    message: t.StringC;
+}>;
+type SliceSimulatorSetupStepValidationMessageCodec = t.TypeOf<typeof SliceSimulatorSetupStepValidationMessageCodec>;
+export type SimulatorManagerReadSliceSimulatorSetupStep = {
+    title: string;
+    description?: string;
+    body: string;
+    /**
+     * Determines if the step is completed.
+     *
+     * This proeprty is `undefined` if the project's adapter does not provide a
+     * validation function for the step; we cannot know if the step is complete
+     * without a validator.
+     */
+    isComplete: boolean | undefined;
+    validationMessages: SliceSimulatorSetupStepValidationMessageCodec[];
+};
+export type SimulatorManagerReadSliceSimulatorSetupStepsReturnType = {
+    steps: SimulatorManagerReadSliceSimulatorSetupStep[];
+    errors: (DecodeError | HookError)[];
+};
+export declare class SimulatorManager extends BaseManager {
+    getLocalSliceSimulatorURL(): Promise<string | undefined>;
+    /**
+     * @throws {@link UnexpectedDataError} Thrown if the project is not configured
+     *   with a Slice Simulator URL.
+     */
+    checkIsLocalSliceSimulatorURLAccessible(): Promise<boolean>;
+    readSliceSimulatorSetupSteps(): Promise<SimulatorManagerReadSliceSimulatorSetupStepsReturnType>;
+}
+export {};