@slicemachine/manager 0.0.0-alpha.dev-new-release-process.1

package/dist/managers/project/ProjectManager.js

@@ -0,0 +1,254 @@
+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 fs from "node:fs/promises";
+import { existsSync } from "node:fs";
+import * as path from "node:path";
+import { createRequire } from "node:module";
+import { detect } from "@antfu/ni";
+import * as t from "io-ts";
+import { assertPluginsInitialized } from "../../lib/assertPluginsInitialized.js";
+import { decodeHookResult } from "../../lib/decodeHookResult.js";
+import { decodeSliceMachineConfig } from "../../lib/decodeSliceMachineConfig.js";
+import { format } from "../../lib/format.js";
+import { installDependencies } from "../../lib/installDependencies.js";
+import { locateFileUpward } from "../../lib/locateFileUpward.js";
+import { SliceMachineError, InternalError, PluginError } from "../../errors.js";
+import { SLICE_MACHINE_CONFIG_FILENAME } from "../../constants/SLICE_MACHINE_CONFIG_FILENAME.js";
+import { TS_CONFIG_FILENAME } from "../../constants/TS_CONFIG_FILENAME.js";
+import { SLICE_MACHINE_NPM_PACKAGE_NAME } from "../../constants/SLICE_MACHINE_NPM_PACKAGE_NAME.js";
+import { BaseManager } from "../BaseManager.js";
+class ProjectManager extends BaseManager {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_cachedRoot");
+    __publicField(this, "_cachedSliceMachineConfigPath");
+    __publicField(this, "_cachedSliceMachineConfig");
+  }
+  async getSliceMachineConfigPath(args) {
+    if (this._cachedSliceMachineConfigPath && !(args == null ? void 0 : args.ignoreCache)) {
+      return this._cachedSliceMachineConfigPath;
+    }
+    try {
+      this._cachedSliceMachineConfigPath = await locateFileUpward(SLICE_MACHINE_CONFIG_FILENAME, { startDir: this.cwd });
+    } catch (error) {
+      throw new Error(`Could not find a ${SLICE_MACHINE_CONFIG_FILENAME} file. Please create a config file at the root of your project.`);
+    }
+    return this._cachedSliceMachineConfigPath;
+  }
+  async getRoot(args) {
+    if (this._cachedRoot && !(args == null ? void 0 : args.ignoreCache)) {
+      return this._cachedRoot;
+    }
+    const sliceMachineConfigFilePath = await this.getSliceMachineConfigPath({
+      ignoreCache: args == null ? void 0 : args.ignoreCache
+    });
+    this._cachedRoot = path.dirname(sliceMachineConfigFilePath);
+    return this._cachedRoot;
+  }
+  async suggestRoot() {
+    const suggestedRootPackageJSON = await locateFileUpward("package.json", {
+      startDir: this.cwd
+    });
+    return path.dirname(suggestedRootPackageJSON);
+  }
+  async suggestSliceMachineConfigPath() {
+    const suggestedRoot = await this.suggestRoot();
+    return path.resolve(suggestedRoot, SLICE_MACHINE_CONFIG_FILENAME);
+  }
+  async checkIsTypeScript(args) {
+    const root = (args == null ? void 0 : args.rootOverride) || await this.getRoot();
+    const rootTSConfigPath = path.resolve(root, TS_CONFIG_FILENAME);
+    return existsSync(rootTSConfigPath);
+  }
+  async getSliceMachineConfig() {
+    if (this._cachedSliceMachineConfig) {
+      return this._cachedSliceMachineConfig;
+    } else {
+      return await this.loadSliceMachineConfig();
+    }
+  }
+  async writeSliceMachineConfig(args) {
+    const configFilePath = args.path || await this.getSliceMachineConfigPath();
+    const config = await format(JSON.stringify(args.config, null, 2), configFilePath);
+    await fs.writeFile(configFilePath, config, "utf-8");
+    delete this._cachedSliceMachineConfig;
+  }
+  async loadSliceMachineConfig() {
+    const configFilePath = await this.getSliceMachineConfigPath();
+    let rawConfig;
+    try {
+      const contents = await fs.readFile(configFilePath, "utf8");
+      rawConfig = JSON.parse(contents);
+    } catch (error2) {
+      if (error2 instanceof SyntaxError) {
+        throw new SliceMachineError(`Could not parse config file at ${configFilePath}.
+
+Error Message: ${error2.message}`);
+      }
+    }
+    if (!rawConfig) {
+      throw new Error("No config found.");
+    }
+    const { value: sliceMachineConfig, error } = decodeSliceMachineConfig(rawConfig);
+    if (error) {
+      throw new Error(`Invalid config. ${error.errors.join(", ")}`, {
+        cause: { rawConfig }
+      });
+    }
+    this._cachedSliceMachineConfig = sliceMachineConfig;
+    return sliceMachineConfig;
+  }
+  async locateSliceMachineUIDir() {
+    const projectRoot = await this.getRoot();
+    const require2 = createRequire(path.join(projectRoot, "index.js"));
+    const sliceMachinePackageJSONPath = require2.resolve(`${SLICE_MACHINE_NPM_PACKAGE_NAME}/package.json`);
+    return path.dirname(sliceMachinePackageJSONPath);
+  }
+  /**
+   * Returns the project's repository name (i.e. the production environment). It
+   * ignores the currently selected environment.
+   *
+   * Use this method to retrieve the production environment domain.
+   *
+   * @returns The project's repository name.
+   */
+  async getRepositoryName() {
+    const sliceMachineConfig = await this.getSliceMachineConfig();
+    return sliceMachineConfig.repositoryName;
+  }
+  /**
+   * Returns the currently selected environment domain if set. If an environment
+   * is not set, it returns the project's repository name (the production
+   * environment).
+   *
+   * Use this method to retrieve the repository name to be sent with Prismic API
+   * requests.
+   *
+   * @returns The resolved repository name.
+   */
+  async getResolvedRepositoryName() {
+    const repositoryName = await this.getRepositoryName();
+    const supportsEnvironments = this.project.checkSupportsEnvironments();
+    if (!supportsEnvironments) {
+      return repositoryName;
+    }
+    const { environment } = await this.project.readEnvironment();
+    return environment ?? repositoryName;
+  }
+  async getAdapterName() {
+    const sliceMachineConfig = await this.getSliceMachineConfig();
+    const adapterName = typeof sliceMachineConfig.adapter === "string" ? sliceMachineConfig.adapter : sliceMachineConfig.adapter.resolve;
+    return adapterName;
+  }
+  async locateAdapterDir() {
+    const projectRoot = await this.getRoot();
+    const adapterName = await this.getAdapterName();
+    const require2 = createRequire(path.join(projectRoot, "index.js"));
+    const adapterPackageJSONPath = require2.resolve(`${adapterName}/package.json`);
+    return path.dirname(adapterPackageJSONPath);
+  }
+  async initProject(args) {
+    assertPluginsInitialized(this.sliceMachinePluginRunner);
+    const log = (args == null ? void 0 : args.log) || console.log.bind(this);
+    const { errors } = await this.sliceMachinePluginRunner.callHook("project:init", {
+      log,
+      installDependencies: async (args2) => {
+        const { execaProcess } = await this.installDependencies({
+          dependencies: args2.dependencies,
+          dev: args2.dev,
+          log
+        });
+        await execaProcess;
+      }
+    });
+    if (errors.length > 0) {
+      throw new SliceMachineError(`Failed to initialize project: ${errors.join(", ")}`);
+    }
+  }
+  async detectPackageManager(args) {
+    const projectRoot = (args == null ? void 0 : args.root) || await this.getRoot();
+    const packageManager = await detect({
+      autoInstall: true,
+      cwd: projectRoot
+    });
+    return packageManager || "npm";
+  }
+  async installDependencies(args) {
+    var _a, _b;
+    const packageManager = args.packageManager || await this.detectPackageManager();
+    const log = args.log || console.log.bind(this);
+    const wrappedLogger = (data) => {
+      if (data instanceof Buffer) {
+        log(data.toString());
+      } else if (typeof data === "string") {
+        log(data);
+      }
+    };
+    try {
+      const { execaProcess } = await installDependencies({
+        packageManager,
+        dependencies: args.dependencies,
+        dev: args.dev
+      });
+      if (process.stdout.isTTY || process.env.NODE_ENV === "test") {
+        (_a = execaProcess.stdout) == null ? void 0 : _a.on("data", wrappedLogger);
+      }
+      (_b = execaProcess.stderr) == null ? void 0 : _b.on("data", wrappedLogger);
+      return {
+        execaProcess
+      };
+    } catch (error) {
+      if (error instanceof Error && "shortMessage" in error && "stderr" in error) {
+        throw new InternalError("Package installation failed", {
+          cause: error
+        });
+      }
+      throw error;
+    }
+  }
+  checkSupportsEnvironments() {
+    assertPluginsInitialized(this.sliceMachinePluginRunner);
+    return this.sliceMachinePluginRunner.hooksForType("project:environment:read").length > 0 && this.sliceMachinePluginRunner.hooksForType("project:environment:update").length > 0;
+  }
+  async readEnvironment() {
+    var _a, _b;
+    assertPluginsInitialized(this.sliceMachinePluginRunner);
+    await this._assertAdapterSupportsEnvironments();
+    const hookResult = await this.sliceMachinePluginRunner.callHook("project:environment:read", void 0);
+    const { data, errors } = decodeHookResult(t.type({
+      environment: t.union([t.undefined, t.string])
+    }), hookResult);
+    const repositoryName = await this.project.getRepositoryName();
+    const environmentDomain = ((_a = data[0]) == null ? void 0 : _a.environment) === repositoryName ? void 0 : (_b = data[0]) == null ? void 0 : _b.environment;
+    return {
+      environment: environmentDomain,
+      errors
+    };
+  }
+  async updateEnvironment(args) {
+    assertPluginsInitialized(this.sliceMachinePluginRunner);
+    await this._assertAdapterSupportsEnvironments();
+    const repositoryName = await this.project.getRepositoryName();
+    const environment = args.environment === repositoryName ? void 0 : args.environment;
+    const hookResult = await this.sliceMachinePluginRunner.callHook("project:environment:update", { environment });
+    return {
+      errors: hookResult.errors
+    };
+  }
+  async _assertAdapterSupportsEnvironments() {
+    assertPluginsInitialized(this.sliceMachinePluginRunner);
+    const supportsEnvironments = this.checkSupportsEnvironments();
+    if (!supportsEnvironments) {
+      const adapterName = await this.project.getAdapterName();
+      throw new PluginError(`${adapterName} does not support environments. Use an adapter that implements the \`project:environment:read\` and \`project:environment:update\` hooks to use environments.`);
+    }
+  }
+}
+export {
+  ProjectManager
+};
+//# sourceMappingURL=ProjectManager.js.map

package/dist/managers/project/ProjectManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectManager.js","sources":["../../../../src/managers/project/ProjectManager.ts"],"sourcesContent":["import * as fs from \"node:fs/promises\";\nimport { existsSync } from \"node:fs\";\nimport * as path from \"node:path\";\nimport { createRequire } from \"node:module\";\nimport { detect as niDetect } from \"@antfu/ni\";\nimport { ExecaChildProcess } from \"execa\";\nimport {\n\tHookError,\n\tCallHookReturnType,\n\tProjectEnvironmentUpdateHook,\n} from \"@slicemachine/plugin-kit\";\nimport * as t from \"io-ts\";\n\nimport { DecodeError } from \"../../lib/DecodeError\";\nimport { assertPluginsInitialized } from \"../../lib/assertPluginsInitialized\";\nimport { decodeHookResult } from \"../../lib/decodeHookResult\";\nimport { decodeSliceMachineConfig } from \"../../lib/decodeSliceMachineConfig\";\nimport { format } from \"../../lib/format\";\nimport { installDependencies } from \"../../lib/installDependencies\";\nimport { locateFileUpward } from \"../../lib/locateFileUpward\";\n\nimport {\n\tPackageManager,\n\tSliceMachineConfig,\n\tOnlyHookErrors,\n} from \"../../types\";\n\nimport { SliceMachineError, InternalError, PluginError } from \"../../errors\";\n\nimport { SLICE_MACHINE_CONFIG_FILENAME } from \"../../constants/SLICE_MACHINE_CONFIG_FILENAME\";\nimport { TS_CONFIG_FILENAME } from \"../../constants/TS_CONFIG_FILENAME\";\nimport { SLICE_MACHINE_NPM_PACKAGE_NAME } from \"../../constants/SLICE_MACHINE_NPM_PACKAGE_NAME\";\n\nimport { BaseManager } from \"../BaseManager\";\n\ntype ProjectManagerGetSliceMachineConfigPathArgs = {\n\tignoreCache?: boolean;\n};\n\ntype ProjectManagerGetRootArgs = {\n\tignoreCache?: boolean;\n};\n\ntype ProjectManagerCheckIsTypeScriptArgs = {\n\trootOverride?: string;\n};\n\ntype ProjectManagerWriteSliceMachineConfigArgs = {\n\tconfig: SliceMachineConfig;\n\tpath?: string;\n};\n\ntype ProjectManagerInitProjectArgs = {\n\tlog?: (message: string) => void;\n};\n\ntype ProjectManagerDetectPackageManager = {\n\troot?: string;\n};\n\ntype ProjectManagerInstallDependenciesArgs = {\n\tdependencies: Record<string, string>;\n\tdev?: boolean;\n\tpackageManager?: PackageManager;\n\tlog?: (message: string) => void;\n};\n\ntype ProjectManagerInstallDependenciesReturnType = {\n\texecaProcess: ExecaChildProcess;\n};\n\ntype ProjectManagerReadEnvironmentReturnType = {\n\tenvironment: string | undefined;\n\terrors: (DecodeError | HookError)[];\n};\n\ntype ProjectManagerUpdateEnvironmentArgs = {\n\tenvironment: string | undefined;\n};\n\nexport class ProjectManager extends BaseManager {\n\tprivate _cachedRoot: string | undefined;\n\tprivate _cachedSliceMachineConfigPath: string | undefined;\n\tprivate _cachedSliceMachineConfig: SliceMachineConfig | undefined;\n\n\tasync getSliceMachineConfigPath(\n\t\targs?: ProjectManagerGetSliceMachineConfigPathArgs,\n\t): Promise<string> {\n\t\tif (this._cachedSliceMachineConfigPath && !args?.ignoreCache) {\n\t\t\treturn this._cachedSliceMachineConfigPath;\n\t\t}\n\n\t\ttry {\n\t\t\tthis._cachedSliceMachineConfigPath = await locateFileUpward(\n\t\t\t\tSLICE_MACHINE_CONFIG_FILENAME,\n\t\t\t\t{ startDir: this.cwd },\n\t\t\t);\n\t\t} catch (error) {\n\t\t\tthrow new Error(\n\t\t\t\t`Could not find a ${SLICE_MACHINE_CONFIG_FILENAME} file. Please create a config file at the root of your project.`,\n\t\t\t);\n\t\t}\n\n\t\treturn this._cachedSliceMachineConfigPath;\n\t}\n\n\tasync getRoot(args?: ProjectManagerGetRootArgs): Promise<string> {\n\t\tif (this._cachedRoot && !args?.ignoreCache) {\n\t\t\treturn this._cachedRoot;\n\t\t}\n\n\t\tconst sliceMachineConfigFilePath = await this.getSliceMachineConfigPath({\n\t\t\tignoreCache: args?.ignoreCache,\n\t\t});\n\n\t\tthis._cachedRoot = path.dirname(sliceMachineConfigFilePath);\n\n\t\treturn this._cachedRoot;\n\t}\n\n\tasync suggestRoot(): Promise<string> {\n\t\tconst suggestedRootPackageJSON = await locateFileUpward(\"package.json\", {\n\t\t\tstartDir: this.cwd,\n\t\t});\n\n\t\treturn path.dirname(suggestedRootPackageJSON);\n\t}\n\n\tasync suggestSliceMachineConfigPath(): Promise<string> {\n\t\tconst suggestedRoot = await this.suggestRoot();\n\n\t\treturn path.resolve(suggestedRoot, SLICE_MACHINE_CONFIG_FILENAME);\n\t}\n\n\tasync checkIsTypeScript(\n\t\targs?: ProjectManagerCheckIsTypeScriptArgs,\n\t): Promise<boolean> {\n\t\tconst root = args?.rootOverride || (await this.getRoot());\n\t\tconst rootTSConfigPath = path.resolve(root, TS_CONFIG_FILENAME);\n\n\t\t// We just care if the file exists, we don't need access to it\n\t\treturn existsSync(rootTSConfigPath);\n\t}\n\n\tasync getSliceMachineConfig(): Promise<SliceMachineConfig> {\n\t\tif (this._cachedSliceMachineConfig) {\n\t\t\treturn this._cachedSliceMachineConfig;\n\t\t} else {\n\t\t\treturn await this.loadSliceMachineConfig();\n\t\t}\n\t}\n\n\tasync writeSliceMachineConfig(\n\t\targs: ProjectManagerWriteSliceMachineConfigArgs,\n\t): Promise<void> {\n\t\tconst configFilePath =\n\t\t\targs.path || (await this.getSliceMachineConfigPath());\n\n\t\tconst config = await format(\n\t\t\tJSON.stringify(args.config, null, 2),\n\t\t\tconfigFilePath,\n\t\t);\n\n\t\tawait fs.writeFile(configFilePath, config, \"utf-8\");\n\t\tdelete this._cachedSliceMachineConfig; // Clear config cache\n\t}\n\n\tasync loadSliceMachineConfig(): Promise<SliceMachineConfig> {\n\t\t// TODO: Reload plugins with a fresh plugin runner. Plugins may\n\t\t// have been added or removed.\n\t\tconst configFilePath = await this.getSliceMachineConfigPath();\n\n\t\tlet rawConfig: unknown | undefined;\n\t\ttry {\n\t\t\tconst contents = await fs.readFile(configFilePath, \"utf8\");\n\t\t\trawConfig = JSON.parse(contents);\n\t\t} catch (error) {\n\t\t\tif (error instanceof SyntaxError) {\n\t\t\t\tthrow new SliceMachineError(\n\t\t\t\t\t`Could not parse config file at ${configFilePath}.\\n\\nError Message: ${error.message}`,\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Noop, more specific error is thrown after\n\t\t}\n\n\t\tif (!rawConfig) {\n\t\t\t// TODO: Write a more friendly and useful message.\n\t\t\tthrow new Error(\"No config found.\");\n\t\t}\n\n\t\tconst { value: sliceMachineConfig, error } =\n\t\t\tdecodeSliceMachineConfig(rawConfig);\n\n\t\tif (error) {\n\t\t\t// TODO: Write a more friendly and useful message.\n\t\t\tthrow new Error(`Invalid config. ${error.errors.join(\", \")}`, {\n\t\t\t\tcause: { rawConfig },\n\t\t\t});\n\t\t}\n\n\t\t// Allow cached config reading using `SliceMachineManager.prototype.getProjectConfig()`.\n\t\tthis._cachedSliceMachineConfig = sliceMachineConfig;\n\n\t\treturn sliceMachineConfig;\n\t}\n\n\tasync locateSliceMachineUIDir(): Promise<string> {\n\t\tconst projectRoot = await this.getRoot();\n\n\t\tconst require = createRequire(path.join(projectRoot, \"index.js\"));\n\t\tconst sliceMachinePackageJSONPath = require.resolve(\n\t\t\t`${SLICE_MACHINE_NPM_PACKAGE_NAME}/package.json`,\n\t\t);\n\n\t\treturn path.dirname(sliceMachinePackageJSONPath);\n\t}\n\n\t/**\n\t * Returns the project's repository name (i.e. the production environment). It\n\t * ignores the currently selected environment.\n\t *\n\t * Use this method to retrieve the production environment domain.\n\t *\n\t * @returns The project's repository name.\n\t */\n\tasync getRepositoryName(): Promise<string> {\n\t\tconst sliceMachineConfig = await this.getSliceMachineConfig();\n\n\t\treturn sliceMachineConfig.repositoryName;\n\t}\n\n\t/**\n\t * Returns the currently selected environment domain if set. If an environment\n\t * is not set, it returns the project's repository name (the production\n\t * environment).\n\t *\n\t * Use this method to retrieve the repository name to be sent with Prismic API\n\t * requests.\n\t *\n\t * @returns The resolved repository name.\n\t */\n\tasync getResolvedRepositoryName(): Promise<string> {\n\t\tconst repositoryName = await this.getRepositoryName();\n\n\t\tconst supportsEnvironments = this.project.checkSupportsEnvironments();\n\t\tif (!supportsEnvironments) {\n\t\t\treturn repositoryName;\n\t\t}\n\n\t\tconst { environment } = await this.project.readEnvironment();\n\n\t\treturn environment ?? repositoryName;\n\t}\n\n\tasync getAdapterName(): Promise<string> {\n\t\tconst sliceMachineConfig = await this.getSliceMachineConfig();\n\t\tconst adapterName =\n\t\t\ttypeof sliceMachineConfig.adapter === \"string\"\n\t\t\t\t? sliceMachineConfig.adapter\n\t\t\t\t: sliceMachineConfig.adapter.resolve;\n\n\t\treturn adapterName;\n\t}\n\n\tasync locateAdapterDir(): Promise<string> {\n\t\tconst projectRoot = await this.getRoot();\n\t\tconst adapterName = await this.getAdapterName();\n\t\tconst require = createRequire(path.join(projectRoot, \"index.js\"));\n\t\tconst adapterPackageJSONPath = require.resolve(\n\t\t\t`${adapterName}/package.json`,\n\t\t);\n\n\t\treturn path.dirname(adapterPackageJSONPath);\n\t}\n\n\tasync initProject(args?: ProjectManagerInitProjectArgs): Promise<void> {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\t// eslint-disable-next-line no-console\n\t\tconst log = args?.log || console.log.bind(this);\n\n\t\tconst { errors } = await this.sliceMachinePluginRunner.callHook(\n\t\t\t\"project:init\",\n\t\t\t{\n\t\t\t\tlog,\n\t\t\t\tinstallDependencies: async (args) => {\n\t\t\t\t\tconst { execaProcess } = await this.installDependencies({\n\t\t\t\t\t\tdependencies: args.dependencies,\n\t\t\t\t\t\tdev: args.dev,\n\t\t\t\t\t\tlog,\n\t\t\t\t\t});\n\n\t\t\t\t\tawait execaProcess;\n\t\t\t\t},\n\t\t\t},\n\t\t);\n\n\t\tif (errors.length > 0) {\n\t\t\t// TODO: Provide better error message.\n\t\t\tthrow new SliceMachineError(\n\t\t\t\t`Failed to initialize project: ${errors.join(\", \")}`,\n\t\t\t);\n\t\t}\n\t}\n\n\tasync detectPackageManager(\n\t\targs?: ProjectManagerDetectPackageManager,\n\t): Promise<PackageManager> {\n\t\tconst projectRoot = args?.root || (await this.getRoot());\n\n\t\tconst packageManager = await niDetect({\n\t\t\tautoInstall: true,\n\t\t\tcwd: projectRoot,\n\t\t});\n\n\t\treturn packageManager || \"npm\";\n\t}\n\n\tasync installDependencies(\n\t\targs: ProjectManagerInstallDependenciesArgs,\n\t): Promise<ProjectManagerInstallDependenciesReturnType> {\n\t\tconst packageManager =\n\t\t\targs.packageManager || (await this.detectPackageManager());\n\n\t\t// eslint-disable-next-line no-console\n\t\tconst log = args.log || console.log.bind(this);\n\n\t\tconst wrappedLogger = (data: Buffer | string | null) => {\n\t\t\tif (data instanceof Buffer) {\n\t\t\t\tlog(data.toString());\n\t\t\t} else if (typeof data === \"string\") {\n\t\t\t\tlog(data);\n\t\t\t}\n\t\t};\n\n\t\ttry {\n\t\t\tconst { execaProcess } = await installDependencies({\n\t\t\t\tpackageManager,\n\t\t\t\tdependencies: args.dependencies,\n\t\t\t\tdev: args.dev,\n\t\t\t});\n\n\t\t\t// Don't clutter console with logs when process is non TTY (CI, etc.)\n\t\t\tif (process.stdout.isTTY || process.env.NODE_ENV === \"test\") {\n\t\t\t\texecaProcess.stdout?.on(\"data\", wrappedLogger);\n\t\t\t}\n\t\t\texecaProcess.stderr?.on(\"data\", wrappedLogger);\n\n\t\t\treturn {\n\t\t\t\texecaProcess,\n\t\t\t};\n\t\t} catch (error) {\n\t\t\tif (\n\t\t\t\terror instanceof Error &&\n\t\t\t\t\"shortMessage\" in error &&\n\t\t\t\t\"stderr\" in error\n\t\t\t) {\n\t\t\t\tthrow new InternalError(\"Package installation failed\", {\n\t\t\t\t\tcause: error,\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tthrow error;\n\t\t}\n\t}\n\n\tcheckSupportsEnvironments(): boolean {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\treturn (\n\t\t\tthis.sliceMachinePluginRunner.hooksForType(\"project:environment:read\")\n\t\t\t\t.length > 0 &&\n\t\t\tthis.sliceMachinePluginRunner.hooksForType(\"project:environment:update\")\n\t\t\t\t.length > 0\n\t\t);\n\t}\n\n\tasync readEnvironment(): Promise<ProjectManagerReadEnvironmentReturnType> {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\tawait this._assertAdapterSupportsEnvironments();\n\n\t\tconst hookResult = await this.sliceMachinePluginRunner.callHook(\n\t\t\t\"project:environment:read\",\n\t\t\tundefined,\n\t\t);\n\t\tconst { data, errors } = decodeHookResult(\n\t\t\tt.type({\n\t\t\t\tenvironment: t.union([t.undefined, t.string]),\n\t\t\t}),\n\t\t\thookResult,\n\t\t);\n\n\t\t// An undefined value is equivalent to the production environment.\n\t\t// We cast to undefined.\n\t\tconst repositoryName = await this.project.getRepositoryName();\n\t\tconst environmentDomain =\n\t\t\tdata[0]?.environment === repositoryName\n\t\t\t\t? undefined\n\t\t\t\t: data[0]?.environment;\n\n\t\treturn {\n\t\t\tenvironment: environmentDomain,\n\t\t\terrors,\n\t\t};\n\t}\n\n\tasync updateEnvironment(\n\t\targs: ProjectManagerUpdateEnvironmentArgs,\n\t): Promise<OnlyHookErrors<CallHookReturnType<ProjectEnvironmentUpdateHook>>> {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\tawait this._assertAdapterSupportsEnvironments();\n\n\t\tconst repositoryName = await this.project.getRepositoryName();\n\t\tconst environment =\n\t\t\targs.environment === repositoryName ? undefined : args.environment;\n\n\t\tconst hookResult = await this.sliceMachinePluginRunner.callHook(\n\t\t\t\"project:environment:update\",\n\t\t\t{ environment },\n\t\t);\n\n\t\treturn {\n\t\t\terrors: hookResult.errors,\n\t\t};\n\t}\n\n\tprivate async _assertAdapterSupportsEnvironments(): Promise<void> {\n\t\tassertPluginsInitialized(this.sliceMachinePluginRunner);\n\n\t\tconst supportsEnvironments = this.checkSupportsEnvironments();\n\n\t\tif (!supportsEnvironments) {\n\t\t\tconst adapterName = await this.project.getAdapterName();\n\n\t\t\tthrow new PluginError(\n\t\t\t\t`${adapterName} does not support environments. Use an adapter that implements the \\`project:environment:read\\` and \\`project:environment:update\\` hooks to use environments.`,\n\t\t\t);\n\t\t}\n\t}\n}\n"],"names":["error","require","args","niDetect"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAgFM,MAAO,uBAAuB,YAAW;AAAA,EAAzC;AAAA;AACG;AACA;AACA;AAAA;AAAA,EAER,MAAM,0BACL,MAAkD;AAElD,QAAI,KAAK,iCAAiC,EAAC,6BAAM,cAAa;AAC7D,aAAO,KAAK;AAAA,IACZ;AAEG,QAAA;AACE,WAAA,gCAAgC,MAAM,iBAC1C,+BACA,EAAE,UAAU,KAAK,KAAK;AAAA,aAEf;AACF,YAAA,IAAI,MACT,oBAAoB,8FAA8F;AAAA,IAEnH;AAED,WAAO,KAAK;AAAA,EACb;AAAA,EAEA,MAAM,QAAQ,MAAgC;AAC7C,QAAI,KAAK,eAAe,EAAC,6BAAM,cAAa;AAC3C,aAAO,KAAK;AAAA,IACZ;AAEK,UAAA,6BAA6B,MAAM,KAAK,0BAA0B;AAAA,MACvE,aAAa,6BAAM;AAAA,IAAA,CACnB;AAEI,SAAA,cAAc,KAAK,QAAQ,0BAA0B;AAE1D,WAAO,KAAK;AAAA,EACb;AAAA,EAEA,MAAM,cAAW;AACV,UAAA,2BAA2B,MAAM,iBAAiB,gBAAgB;AAAA,MACvE,UAAU,KAAK;AAAA,IAAA,CACf;AAEM,WAAA,KAAK,QAAQ,wBAAwB;AAAA,EAC7C;AAAA,EAEA,MAAM,gCAA6B;AAC5B,UAAA,gBAAgB,MAAM,KAAK;AAE1B,WAAA,KAAK,QAAQ,eAAe,6BAA6B;AAAA,EACjE;AAAA,EAEA,MAAM,kBACL,MAA0C;AAE1C,UAAM,QAAO,6BAAM,iBAAiB,MAAM,KAAK,QAAO;AACtD,UAAM,mBAAmB,KAAK,QAAQ,MAAM,kBAAkB;AAG9D,WAAO,WAAW,gBAAgB;AAAA,EACnC;AAAA,EAEA,MAAM,wBAAqB;AAC1B,QAAI,KAAK,2BAA2B;AACnC,aAAO,KAAK;AAAA,IAAA,OACN;AACC,aAAA,MAAM,KAAK;IAClB;AAAA,EACF;AAAA,EAEA,MAAM,wBACL,MAA+C;AAE/C,UAAM,iBACL,KAAK,QAAS,MAAM,KAAK,0BAAyB;AAE7C,UAAA,SAAS,MAAM,OACpB,KAAK,UAAU,KAAK,QAAQ,MAAM,CAAC,GACnC,cAAc;AAGf,UAAM,GAAG,UAAU,gBAAgB,QAAQ,OAAO;AAClD,WAAO,KAAK;AAAA,EACb;AAAA,EAEA,MAAM,yBAAsB;AAGrB,UAAA,iBAAiB,MAAM,KAAK;AAE9B,QAAA;AACA,QAAA;AACH,YAAM,WAAW,MAAM,GAAG,SAAS,gBAAgB,MAAM;AAC7C,kBAAA,KAAK,MAAM,QAAQ;AAAA,aACvBA;AACR,UAAIA,kBAAiB,aAAa;AAC3B,cAAA,IAAI,kBACT,kCAAkC;AAAA;AAAA,iBAAqCA,OAAM,SAAS;AAAA,MAEvF;AAAA,IAGD;AAED,QAAI,CAAC,WAAW;AAET,YAAA,IAAI,MAAM,kBAAkB;AAAA,IAClC;AAED,UAAM,EAAE,OAAO,oBAAoB,MAAO,IACzC,yBAAyB,SAAS;AAEnC,QAAI,OAAO;AAEV,YAAM,IAAI,MAAM,mBAAmB,MAAM,OAAO,KAAK,IAAI,KAAK;AAAA,QAC7D,OAAO,EAAE,UAAW;AAAA,MAAA,CACpB;AAAA,IACD;AAGD,SAAK,4BAA4B;AAE1B,WAAA;AAAA,EACR;AAAA,EAEA,MAAM,0BAAuB;AACtB,UAAA,cAAc,MAAM,KAAK;AAE/B,UAAMC,WAAU,cAAc,KAAK,KAAK,aAAa,UAAU,CAAC;AAChE,UAAM,8BAA8BA,SAAQ,QAC3C,GAAG,6CAA6C;AAG1C,WAAA,KAAK,QAAQ,2BAA2B;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,oBAAiB;AAChB,UAAA,qBAAqB,MAAM,KAAK;AAEtC,WAAO,mBAAmB;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,4BAAyB;AACxB,UAAA,iBAAiB,MAAM,KAAK;AAE5B,UAAA,uBAAuB,KAAK,QAAQ;AAC1C,QAAI,CAAC,sBAAsB;AACnB,aAAA;AAAA,IACP;AAED,UAAM,EAAE,YAAW,IAAK,MAAM,KAAK,QAAQ,gBAAe;AAE1D,WAAO,eAAe;AAAA,EACvB;AAAA,EAEA,MAAM,iBAAc;AACb,UAAA,qBAAqB,MAAM,KAAK;AAChC,UAAA,cACL,OAAO,mBAAmB,YAAY,WACnC,mBAAmB,UACnB,mBAAmB,QAAQ;AAExB,WAAA;AAAA,EACR;AAAA,EAEA,MAAM,mBAAgB;AACf,UAAA,cAAc,MAAM,KAAK;AACzB,UAAA,cAAc,MAAM,KAAK;AAC/B,UAAMA,WAAU,cAAc,KAAK,KAAK,aAAa,UAAU,CAAC;AAChE,UAAM,yBAAyBA,SAAQ,QACtC,GAAG,0BAA0B;AAGvB,WAAA,KAAK,QAAQ,sBAAsB;AAAA,EAC3C;AAAA,EAEA,MAAM,YAAY,MAAoC;AACrD,6BAAyB,KAAK,wBAAwB;AAGtD,UAAM,OAAM,6BAAM,QAAO,QAAQ,IAAI,KAAK,IAAI;AAE9C,UAAM,EAAE,OAAQ,IAAG,MAAM,KAAK,yBAAyB,SACtD,gBACA;AAAA,MACC;AAAA,MACA,qBAAqB,OAAOC,UAAQ;AACnC,cAAM,EAAE,aAAA,IAAiB,MAAM,KAAK,oBAAoB;AAAA,UACvD,cAAcA,MAAK;AAAA,UACnB,KAAKA,MAAK;AAAA,UACV;AAAA,QAAA,CACA;AAEK,cAAA;AAAA,MACP;AAAA,IAAA,CACA;AAGE,QAAA,OAAO,SAAS,GAAG;AAEtB,YAAM,IAAI,kBACT,iCAAiC,OAAO,KAAK,IAAI,GAAG;AAAA,IAErD;AAAA,EACF;AAAA,EAEA,MAAM,qBACL,MAAyC;AAEzC,UAAM,eAAc,6BAAM,SAAS,MAAM,KAAK,QAAO;AAE/C,UAAA,iBAAiB,MAAMC,OAAS;AAAA,MACrC,aAAa;AAAA,MACb,KAAK;AAAA,IAAA,CACL;AAED,WAAO,kBAAkB;AAAA,EAC1B;AAAA,EAEA,MAAM,oBACL,MAA2C;;AAE3C,UAAM,iBACL,KAAK,kBAAmB,MAAM,KAAK,qBAAoB;AAGxD,UAAM,MAAM,KAAK,OAAO,QAAQ,IAAI,KAAK,IAAI;AAEvC,UAAA,gBAAgB,CAAC,SAAgC;AACtD,UAAI,gBAAgB,QAAQ;AACvB,YAAA,KAAK,UAAU;AAAA,MAAA,WACT,OAAO,SAAS,UAAU;AACpC,YAAI,IAAI;AAAA,MACR;AAAA,IAAA;AAGE,QAAA;AACH,YAAM,EAAE,iBAAiB,MAAM,oBAAoB;AAAA,QAClD;AAAA,QACA,cAAc,KAAK;AAAA,QACnB,KAAK,KAAK;AAAA,MAAA,CACV;AAGD,UAAI,QAAQ,OAAO,SAAS,QAAQ,IAAI,aAAa,QAAQ;AAC/C,2BAAA,WAAA,mBAAQ,GAAG,QAAQ;AAAA,MAChC;AACY,yBAAA,WAAA,mBAAQ,GAAG,QAAQ;AAEzB,aAAA;AAAA,QACN;AAAA,MAAA;AAAA,aAEO;AACR,UACC,iBAAiB,SACjB,kBAAkB,SAClB,YAAY,OACX;AACK,cAAA,IAAI,cAAc,+BAA+B;AAAA,UACtD,OAAO;AAAA,QAAA,CACP;AAAA,MACD;AAEK,YAAA;AAAA,IACN;AAAA,EACF;AAAA,EAEA,4BAAyB;AACxB,6BAAyB,KAAK,wBAAwB;AAEtD,WACC,KAAK,yBAAyB,aAAa,0BAA0B,EACnE,SAAS,KACX,KAAK,yBAAyB,aAAa,4BAA4B,EACrE,SAAS;AAAA,EAEb;AAAA,EAEA,MAAM,kBAAe;;AACpB,6BAAyB,KAAK,wBAAwB;AAEtD,UAAM,KAAK;AAEX,UAAM,aAAa,MAAM,KAAK,yBAAyB,SACtD,4BACA,MAAS;AAEV,UAAM,EAAE,MAAM,OAAA,IAAW,iBACxB,EAAE,KAAK;AAAA,MACN,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC;AAAA,IAAA,CAC5C,GACD,UAAU;AAKX,UAAM,iBAAiB,MAAM,KAAK,QAAQ,kBAAiB;AACrD,UAAA,sBACL,UAAK,CAAC,MAAN,mBAAS,iBAAgB,iBACtB,UACA,UAAK,CAAC,MAAN,mBAAS;AAEN,WAAA;AAAA,MACN,aAAa;AAAA,MACb;AAAA,IAAA;AAAA,EAEF;AAAA,EAEA,MAAM,kBACL,MAAyC;AAEzC,6BAAyB,KAAK,wBAAwB;AAEtD,UAAM,KAAK;AAEX,UAAM,iBAAiB,MAAM,KAAK,QAAQ,kBAAiB;AAC3D,UAAM,cACL,KAAK,gBAAgB,iBAAiB,SAAY,KAAK;AAElD,UAAA,aAAa,MAAM,KAAK,yBAAyB,SACtD,8BACA,EAAE,aAAa;AAGT,WAAA;AAAA,MACN,QAAQ,WAAW;AAAA,IAAA;AAAA,EAErB;AAAA,EAEQ,MAAM,qCAAkC;AAC/C,6BAAyB,KAAK,wBAAwB;AAEhD,UAAA,uBAAuB,KAAK;AAElC,QAAI,CAAC,sBAAsB;AAC1B,YAAM,cAAc,MAAM,KAAK,QAAQ,eAAc;AAE/C,YAAA,IAAI,YACT,GAAG,0KAA0K;AAAA,IAE9K;AAAA,EACF;AACA;"}

package/dist/managers/screenshots/ScreenshotsManager.cjs

@@ -0,0 +1,164 @@
+"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 t = require("io-ts");
+require("readable-web-to-node-stream");
+const core = require('./../../_node_modules/file-type/core.cjs');
+const index = require('./../../_node_modules/p-limit/index.cjs');
+const fetch = require("../../lib/fetch.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 BaseManager = require("../BaseManager.cjs");
+const esm_min = require('./../../_node_modules/formdata-polyfill/esm.min.cjs');
+require("node:http");
+require("node:https");
+require("node:zlib");
+require("node:stream");
+require("node:buffer");
+require("node:fs");
+require("node:path");
+require('./../../_node_modules/node-domexception/index.cjs');
+const index$1 = require('./../../_node_modules/fetch-blob/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);
+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.");
+  }
+}
+const uploadScreenshotLimit = index(10);
+class ScreenshotsManager extends BaseManager.BaseManager {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_s3ACL");
+  }
+  async initS3ACL() {
+    const awsACLURL = new URL("create", API_ENDPOINTS.API_ENDPOINTS.AwsAclProvider);
+    const awsACLRes = await this._fetch({ url: awsACLURL });
+    const awsACLText = await awsACLRes.text();
+    let awsACLJSON;
+    try {
+      awsACLJSON = JSON.parse(awsACLText);
+    } catch (error2) {
+      throw new Error(`Invalid AWS ACL response from ${awsACLURL}: ${awsACLText}`, {
+        cause: error2
+      });
+    }
+    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}`, {
+        cause: error
+      });
+    }
+    const errorMessage = awsACL.error || awsACL.message || awsACL.Message;
+    if (errorMessage) {
+      throw new Error(`Failed to create an AWS ACL: ${errorMessage}`, {
+        cause: error
+      });
+    }
+    this._s3ACL = {
+      uploadEndpoint: awsACL.values.url,
+      requiredFormDataFields: awsACL.values.fields,
+      imgixEndpoint: awsACL.imgixEndpoint
+    };
+  }
+  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 s3ACLEndpoint = this._s3ACL.uploadEndpoint;
+    const res = await uploadScreenshotLimit(() => fetch.default(s3ACLEndpoint, {
+      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 {
+      const text = await res.text();
+      throw new Error(`Unable to upload screenshot with status code: ${res.status}`, {
+        cause: text
+      });
+    }
+  }
+  async deleteScreenshotFolder(args) {
+    const res = await this._fetch({
+      // We're sending `args.sliceID` as `sliceName` because it's inconsistently
+      // named in the ACL Provider API.
+      body: { sliceName: args.sliceID },
+      method: "POST",
+      url: new URL("delete-folder", API_ENDPOINTS.API_ENDPOINTS.AwsAclProvider)
+    });
+    if (!res.ok) {
+      const text = await res.text();
+      throw new Error(`Unable to delete screenshot folder with status code: ${res.status}`, {
+        cause: text
+      });
+    }
+  }
+  async _fetch(args) {
+    const authenticationToken = await this.user.getAuthenticationToken();
+    const repositoryName = await this.project.getRepositoryName();
+    return await fetch.default(args.url, {
+      body: args.body ? JSON.stringify(args.body) : void 0,
+      headers: {
+        Authorization: `Bearer ${authenticationToken}`,
+        Repository: repositoryName,
+        "User-Agent": SLICE_MACHINE_USER_AGENT.SLICE_MACHINE_USER_AGENT,
+        ...args.body ? { "Content-Type": "application/json" } : {}
+      },
+      method: args.method
+    });
+  }
+}
+exports.ScreenshotsManager = ScreenshotsManager;
+//# 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 pLimit from \"p-limit\";\nimport fetch, { FormData, Blob, Response } from \"../../lib/fetch\";\n\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\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nfunction 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\nconst uploadScreenshotLimit = pLimit(10);\n\ntype ScreenshotsManagerUploadScreenshotArgs = {\n\tdata: Buffer;\n\tkeyPrefix?: string;\n};\n\ntype ScreenshotsManagerUploadScreenshotReturnType = {\n\turl: string;\n};\n\ntype ScreenshotsManagerDeleteScreenshotFolderArgs = {\n\tsliceID: string;\n};\n\nexport class ScreenshotsManager extends BaseManager {\n\tprivate _s3ACL: S3ACL | undefined;\n\n\tasync initS3ACL(): Promise<void> {\n\t\t// TODO: we need to find a way to create a new AWS ACL only when necessary (e.g., when it has expired).\n\t\t// if (this._s3ACL) {\n\t\t// \treturn;\n\t\t// }\n\n\t\tconst awsACLURL = new URL(\"create\", API_ENDPOINTS.AwsAclProvider);\n\t\tconst awsACLRes = await this._fetch({ url: awsACLURL });\n\n\t\tconst awsACLText = await awsACLRes.text();\n\t\tlet awsACLJSON: unknown;\n\t\ttry {\n\t\t\tawsACLJSON = JSON.parse(awsACLText);\n\t\t} catch (error) {\n\t\t\t// Response is not JSON\n\t\t\tthrow new Error(\n\t\t\t\t`Invalid AWS ACL response from ${awsACLURL}: ${awsACLText}`,\n\t\t\t\t{\n\t\t\t\t\tcause: error,\n\t\t\t\t},\n\t\t\t);\n\t\t}\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\t\tcause: error,\n\t\t\t});\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\t\tcause: error,\n\t\t\t});\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\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 s3ACLEndpoint = this._s3ACL.uploadEndpoint;\n\t\tconst res = await uploadScreenshotLimit(() =>\n\t\t\tfetch(s3ACLEndpoint, {\n\t\t\t\tmethod: \"POST\",\n\t\t\t\tbody: formData,\n\t\t\t}),\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\tconst text = await res.text();\n\t\t\tthrow new Error(\n\t\t\t\t`Unable to upload screenshot with status code: ${res.status}`,\n\t\t\t\t{\n\t\t\t\t\tcause: text,\n\t\t\t\t},\n\t\t\t);\n\t\t}\n\t}\n\n\tasync deleteScreenshotFolder(\n\t\targs: ScreenshotsManagerDeleteScreenshotFolderArgs,\n\t): Promise<void> {\n\t\tconst res = await this._fetch({\n\t\t\t// We're sending `args.sliceID` as `sliceName` because it's inconsistently\n\t\t\t// named in the ACL Provider API.\n\t\t\tbody: { sliceName: args.sliceID },\n\t\t\tmethod: \"POST\",\n\t\t\turl: new URL(\"delete-folder\", API_ENDPOINTS.AwsAclProvider),\n\t\t});\n\t\tif (!res.ok) {\n\t\t\tconst text = await res.text();\n\t\t\tthrow new Error(\n\t\t\t\t`Unable to delete screenshot folder with status code: ${res.status}`,\n\t\t\t\t{\n\t\t\t\t\tcause: text,\n\t\t\t\t},\n\t\t\t);\n\t\t}\n\t}\n\n\tprivate async _fetch(args: {\n\t\turl: URL;\n\t\tmethod?: \"GET\" | \"POST\";\n\t\tbody?: unknown;\n\t}): Promise<Response> {\n\t\tconst authenticationToken = await this.user.getAuthenticationToken();\n\t\tconst repositoryName = await this.project.getRepositoryName();\n\n\t\treturn await fetch(args.url, {\n\t\t\tbody: args.body ? JSON.stringify(args.body) : undefined,\n\t\t\theaders: {\n\t\t\t\tAuthorization: `Bearer ${authenticationToken}`,\n\t\t\t\tRepository: repositoryName,\n\t\t\t\t\"User-Agent\": SLICE_MACHINE_USER_AGENT,\n\t\t\t\t...(args.body ? { \"Content-Type\": \"application/json\" } : {}),\n\t\t\t},\n\t\t\tmethod: args.method,\n\t\t});\n\t}\n}\n"],"names":["pLimit","BaseManager","API_ENDPOINTS","error","decode","t","FormData","createContentDigest","fileTypeFromBuffer","Blob","fetch","SLICE_MACHINE_USER_AGENT"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA,SAAS,uBACR,OAAwB;AAExB,MAAI,SAAS,QAAW;AACjB,UAAA,IAAI,MACT,gIAAgI;AAAA,EAEjI;AACF;AAEA,MAAM,wBAAwBA,MAAO,EAAE;AAejC,MAAO,2BAA2BC,YAAAA,YAAW;AAAA,EAA7C;AAAA;AACG;AAAA;AAAA,EAER,MAAM,YAAS;AAMd,UAAM,YAAY,IAAI,IAAI,UAAUC,4BAAc,cAAc;AAChE,UAAM,YAAY,MAAM,KAAK,OAAO,EAAE,KAAK,WAAW;AAEhD,UAAA,aAAa,MAAM,UAAU;AAC/B,QAAA;AACA,QAAA;AACU,mBAAA,KAAK,MAAM,UAAU;AAAA,aAC1BC;AAER,YAAM,IAAI,MACT,iCAAiC,cAAc,cAC/C;AAAA,QACC,OAAOA;AAAAA,MAAA,CACP;AAAA,IAEF;AAED,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,aAAa;AAAA,QAC7D,OAAO;AAAA,MAAA,CACP;AAAA,IACD;AAED,UAAM,eAAe,OAAO,SAAS,OAAO,WAAW,OAAO;AAC9D,QAAI,cAAc;AACX,YAAA,IAAI,MAAM,gCAAgC,gBAAgB;AAAA,QAC/D,OAAO;AAAA,MAAA,CACP;AAAA,IACD;AAED,SAAK,SAAS;AAAA,MACb,gBAAgB,OAAO,OAAO;AAAA,MAC9B,wBAAwB,OAAO,OAAO;AAAA,MACtC,eAAe,OAAO;AAAA,IAAA;AAAA,EAExB;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;AAE9D,UAAA,gBAAgB,KAAK,OAAO;AAClC,UAAM,MAAM,MAAM,sBAAsB,MACvCC,MAAAA,QAAM,eAAe;AAAA,MACpB,QAAQ;AAAA,MACR,MAAM;AAAA,IACN,CAAA,CAAC;AAGH,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;AACA,YAAA,OAAO,MAAM,IAAI;AACvB,YAAM,IAAI,MACT,iDAAiD,IAAI,UACrD;AAAA,QACC,OAAO;AAAA,MAAA,CACP;AAAA,IAEF;AAAA,EACF;AAAA,EAEA,MAAM,uBACL,MAAkD;AAE5C,UAAA,MAAM,MAAM,KAAK,OAAO;AAAA;AAAA;AAAA,MAG7B,MAAM,EAAE,WAAW,KAAK,QAAS;AAAA,MACjC,QAAQ;AAAA,MACR,KAAK,IAAI,IAAI,iBAAiBR,cAAAA,cAAc,cAAc;AAAA,IAAA,CAC1D;AACG,QAAA,CAAC,IAAI,IAAI;AACN,YAAA,OAAO,MAAM,IAAI;AACvB,YAAM,IAAI,MACT,wDAAwD,IAAI,UAC5D;AAAA,QACC,OAAO;AAAA,MAAA,CACP;AAAA,IAEF;AAAA,EACF;AAAA,EAEQ,MAAM,OAAO,MAIpB;AACA,UAAM,sBAAsB,MAAM,KAAK,KAAK,uBAAsB;AAClE,UAAM,iBAAiB,MAAM,KAAK,QAAQ,kBAAiB;AAEpD,WAAA,MAAMQ,MAAAA,QAAM,KAAK,KAAK;AAAA,MAC5B,MAAM,KAAK,OAAO,KAAK,UAAU,KAAK,IAAI,IAAI;AAAA,MAC9C,SAAS;AAAA,QACR,eAAe,UAAU;AAAA,QACzB,YAAY;AAAA,QACZ,cAAcC,yBAAA;AAAA,QACd,GAAI,KAAK,OAAO,EAAE,gBAAgB,uBAAuB;MACzD;AAAA,MACD,QAAQ,KAAK;AAAA,IAAA,CACb;AAAA,EACF;AACA;;"}

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

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import { BaseManager } from "../BaseManager";
+type ScreenshotsManagerUploadScreenshotArgs = {
+    data: Buffer;
+    keyPrefix?: string;
+};
+type ScreenshotsManagerUploadScreenshotReturnType = {
+    url: string;
+};
+type ScreenshotsManagerDeleteScreenshotFolderArgs = {
+    sliceID: string;
+};
+export declare class ScreenshotsManager extends BaseManager {
+    private _s3ACL;
+    initS3ACL(): Promise<void>;
+    uploadScreenshot(args: ScreenshotsManagerUploadScreenshotArgs): Promise<ScreenshotsManagerUploadScreenshotReturnType>;
+    deleteScreenshotFolder(args: ScreenshotsManagerDeleteScreenshotFolderArgs): Promise<void>;
+    private _fetch;
+}
+export {};

package/dist/managers/screenshots/ScreenshotsManager.js

@@ -0,0 +1,147 @@
+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 "readable-web-to-node-stream";
+import { fileTypeFromBuffer } from './../../_node_modules/file-type/core.js';
+import pLimit from './../../_node_modules/p-limit/index.js';
+import fetch from "../../lib/fetch.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 { BaseManager } from "../BaseManager.js";
+import { FormData } from './../../_node_modules/formdata-polyfill/esm.min.js';
+import "node:http";
+import "node:https";
+import "node:zlib";
+import "node:stream";
+import "node:buffer";
+import "node:fs";
+import "node:path";
+import './../../_node_modules/node-domexception/index.js';
+import Blob from './../../_node_modules/fetch-blob/index.js';
+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.");
+  }
+}
+const uploadScreenshotLimit = pLimit(10);
+class ScreenshotsManager extends BaseManager {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_s3ACL");
+  }
+  async initS3ACL() {
+    const awsACLURL = new URL("create", API_ENDPOINTS.AwsAclProvider);
+    const awsACLRes = await this._fetch({ url: awsACLURL });
+    const awsACLText = await awsACLRes.text();
+    let awsACLJSON;
+    try {
+      awsACLJSON = JSON.parse(awsACLText);
+    } catch (error2) {
+      throw new Error(`Invalid AWS ACL response from ${awsACLURL}: ${awsACLText}`, {
+        cause: error2
+      });
+    }
+    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}`, {
+        cause: error
+      });
+    }
+    const errorMessage = awsACL.error || awsACL.message || awsACL.Message;
+    if (errorMessage) {
+      throw new Error(`Failed to create an AWS ACL: ${errorMessage}`, {
+        cause: error
+      });
+    }
+    this._s3ACL = {
+      uploadEndpoint: awsACL.values.url,
+      requiredFormDataFields: awsACL.values.fields,
+      imgixEndpoint: awsACL.imgixEndpoint
+    };
+  }
+  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 s3ACLEndpoint = this._s3ACL.uploadEndpoint;
+    const res = await uploadScreenshotLimit(() => fetch(s3ACLEndpoint, {
+      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 {
+      const text = await res.text();
+      throw new Error(`Unable to upload screenshot with status code: ${res.status}`, {
+        cause: text
+      });
+    }
+  }
+  async deleteScreenshotFolder(args) {
+    const res = await this._fetch({
+      // We're sending `args.sliceID` as `sliceName` because it's inconsistently
+      // named in the ACL Provider API.
+      body: { sliceName: args.sliceID },
+      method: "POST",
+      url: new URL("delete-folder", API_ENDPOINTS.AwsAclProvider)
+    });
+    if (!res.ok) {
+      const text = await res.text();
+      throw new Error(`Unable to delete screenshot folder with status code: ${res.status}`, {
+        cause: text
+      });
+    }
+  }
+  async _fetch(args) {
+    const authenticationToken = await this.user.getAuthenticationToken();
+    const repositoryName = await this.project.getRepositoryName();
+    return await fetch(args.url, {
+      body: args.body ? JSON.stringify(args.body) : void 0,
+      headers: {
+        Authorization: `Bearer ${authenticationToken}`,
+        Repository: repositoryName,
+        "User-Agent": SLICE_MACHINE_USER_AGENT,
+        ...args.body ? { "Content-Type": "application/json" } : {}
+      },
+      method: args.method
+    });
+  }
+}
+export {
+  ScreenshotsManager
+};
+//# sourceMappingURL=ScreenshotsManager.js.map