@argos-ci/core 5.2.1 → 5.3.0

package/dist/index.cjs

@@ -12,3 +12,13 @@ exports.readConfig = async (...args) => {
   const { readConfig } = await import("./index.mjs");
   return readConfig(...args);
 };
+
+exports.deploy = async (...args) => {
+  const { deploy } = await import("./index.mjs");
+  return deploy(...args);
+};
+
+exports.skip = async (...args) => {
+  const { skip } = await import("./index.mjs");
+  return skip(...args);
+};

package/dist/index.d.mts

@@ -139,6 +139,51 @@ declare function getConfigFromOptions({
   } | false | undefined;
 }): Promise<Config>;
 //#endregion
+//#region src/deploy.d.ts
+interface DeployParameters {
+  /**
+   * Directory containing the static files to deploy.
+   */
+  root: string;
+  /**
+   * Argos repository access token.
+   */
+  token?: string;
+  /**
+   * Base URL of the Argos API.
+   * @default "https://api.argos-ci.com/v2/"
+   */
+  apiBaseUrl?: string;
+  /**
+   * Git commit SHA of the deployment.
+   */
+  commit?: string;
+  /**
+   * Git branch name of the deployment.
+   */
+  branch?: string;
+  /**
+   * Pull request number associated with the deployment.
+   */
+  prNumber?: number;
+  /**
+   * Deployment environment.
+   */
+  environment?: "preview" | "production";
+}
+/**
+ * Deploy a static site (e.g. Storybook) to Argos.
+ */
+declare function deploy(params: DeployParameters): Promise<{
+  id: string;
+  status: "pending" | "ready" | "error";
+  environment: "preview" | "production";
+  branch: string;
+  commitSha: string;
+  url: string;
+  createdAt: string;
+}>;
+//#endregion
 //#region src/finalize.d.ts
 type FinalizeParameters = {
   parallel?: {
@@ -322,4 +367,4 @@ declare function skip(params: SkipParameters): Promise<{
   build: ArgosAPISchema.components["schemas"]["Build"];
 }>;
 //#endregion
-export { Config, FinalizeParameters, UploadParameters, finalize, getConfigFromOptions, readConfig, skip, upload };
+export { Config, DeployParameters, FinalizeParameters, UploadParameters, deploy, finalize, getConfigFromOptions, readConfig, skip, upload };

package/dist/index.mjs

@@ -3,16 +3,16 @@ import convict from "convict";
 import { execSync } from "node:child_process";
 import createDebug from "debug";
 import { createReadStream, existsSync, readFileSync } from "node:fs";
-import { createClient, throwAPIError } from "@argos-ci/api-client";
-import { basename, extname, resolve } from "node:path";
+import { readFile, stat } from "node:fs/promises";
+import { basename, extname, join, resolve } from "node:path";
 import glob from "fast-glob";
+import mime from "mime-types";
+import { createClient, throwAPIError } from "@argos-ci/api-client";
+import { createHash } from "node:crypto";
 import { promisify } from "node:util";
 import sharp from "sharp";
 import tmp from "tmp";
-import { createHash } from "node:crypto";
-import { readFile } from "node:fs/promises";
 import { getPlaywrightTracePath, readMetadata, readVersionFromPackage } from "@argos-ci/util";
-import mime from "mime-types";
 //#region src/debug.ts
 const KEY = "@argos-ci/core";
 const debug = createDebug(KEY);
@@ -978,6 +978,48 @@ async function getConfigFromOptions({ parallel, ...options }) {
 	});
 }
 //#endregion
+//#region src/hashing.ts
+const hashFile = async (filepath) => {
+	const fileStream = createReadStream(filepath);
+	const hash = createHash("sha256");
+	await new Promise((resolve, reject) => {
+		fileStream.on("error", reject);
+		hash.on("error", reject);
+		hash.on("finish", resolve);
+		fileStream.pipe(hash);
+	});
+	return hash.digest("hex");
+};
+//#endregion
+//#region src/s3.ts
+async function uploadFile(input) {
+	const file = await readFile(input.path);
+	const response = await fetch(input.url, {
+		method: "PUT",
+		headers: {
+			"Content-Type": input.contentType,
+			"Content-Length": file.length.toString()
+		},
+		signal: AbortSignal.timeout(3e4),
+		body: new Uint8Array(file)
+	});
+	if (!response.ok) throw new Error(`Failed to upload file to ${input.url}: ${response.status} ${response.statusText}`);
+}
+//#endregion
+//#region src/util/chunk.ts
+/**
+* Split an array into chunks of a given size.
+*/
+const chunk = (collection, size) => {
+	const result = [];
+	for (let x = 0; x < Math.ceil(collection.length / size); x++) {
+		const start = x * size;
+		const end = start + size;
+		result.push(collection.slice(start, end));
+	}
+	return result;
+};
+//#endregion
 //#region src/auth.ts
 const base64Encode = (obj) => Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
 /**
@@ -1002,6 +1044,84 @@ function getAuthToken(args) {
 	}
 }
 //#endregion
+//#region src/deploy.ts
+const CHUNK_SIZE$1 = 10;
+function getContentType(filePath) {
+	return mime.lookup(filePath) || "application/octet-stream";
+}
+/**
+* Deploy a static site (e.g. Storybook) to Argos.
+*/
+async function deploy(params) {
+	const { token: _token, ...debugParams } = params;
+	debug("Starting deploy with params", debugParams);
+	const config = await getConfigFromOptions(params);
+	const authToken = getAuthToken(config);
+	const apiClient = createClient({
+		baseUrl: config.apiBaseUrl,
+		authToken
+	});
+	debug("Listing files in", params.root);
+	const relativePaths = await glob("**/*", {
+		cwd: params.root,
+		onlyFiles: true,
+		dot: true
+	});
+	if (relativePaths.length === 0) throw new Error(`No files found in directory: ${params.root}`);
+	debug(`Found ${relativePaths.length} files`);
+	const files = await Promise.all(relativePaths.map(async (relativePath) => {
+		const absolutePath = join(params.root, relativePath);
+		const [hash, stats] = await Promise.all([hashFile(absolutePath), stat(absolutePath)]);
+		return {
+			absolutePath,
+			path: relativePath,
+			hash,
+			size: stats.size,
+			contentType: getContentType(absolutePath)
+		};
+	}));
+	const filesByPath = new Map(files.map((file) => [file.path, file]));
+	debug("Creating deployment");
+	const createResponse = await apiClient.POST("/deployments", { body: {
+		commit: config.commit ?? null,
+		branch: config.branch ?? null,
+		prNumber: config.prNumber ?? null,
+		environment: params.environment,
+		files: files.map(({ path, hash, size, contentType }) => ({
+			path,
+			hash,
+			size,
+			contentType
+		}))
+	} });
+	if (createResponse.error) throwAPIError(createResponse.error);
+	const { deploymentId, uploadFiles: filesToUpload } = createResponse.data;
+	debug(`Deployment created: ${deploymentId}, files to upload: ${filesToUpload.length}`);
+	const uploadChunks = chunk(filesToUpload.map(({ path, uploadUrl }) => {
+		const file = filesByPath.get(path);
+		if (!file) throw new Error(`Invariant: file not found for path: ${path}`);
+		return {
+			url: uploadUrl,
+			path: file.absolutePath,
+			contentType: file.contentType
+		};
+	}), CHUNK_SIZE$1);
+	for (let i = 0; i < uploadChunks.length; i++) {
+		const uploadChunk = uploadChunks[i];
+		if (!uploadChunk) continue;
+		debug(`Uploading chunk ${i + 1}/${uploadChunks.length}`);
+		await Promise.all(uploadChunk.map(({ url, path, contentType }) => uploadFile({
+			url,
+			path,
+			contentType
+		})));
+	}
+	debug("Finalizing deployment");
+	const finalizeResponse = await apiClient.POST("/deployments/{deploymentId}/finalize", { params: { path: { deploymentId } } });
+	if (finalizeResponse.error) throwAPIError(finalizeResponse.error);
+	return finalizeResponse.data;
+}
+//#endregion
 //#region src/finalize.ts
 /**
 * Finalize pending builds.
@@ -1100,48 +1220,6 @@ async function optimizeScreenshot(filepath) {
 	}
 }
 //#endregion
-//#region src/hashing.ts
-const hashFile = async (filepath) => {
-	const fileStream = createReadStream(filepath);
-	const hash = createHash("sha256");
-	await new Promise((resolve, reject) => {
-		fileStream.on("error", reject);
-		hash.on("error", reject);
-		hash.on("finish", resolve);
-		fileStream.pipe(hash);
-	});
-	return hash.digest("hex");
-};
-//#endregion
-//#region src/s3.ts
-async function uploadFile(input) {
-	const file = await readFile(input.path);
-	const response = await fetch(input.url, {
-		method: "PUT",
-		headers: {
-			"Content-Type": input.contentType,
-			"Content-Length": file.length.toString()
-		},
-		signal: AbortSignal.timeout(3e4),
-		body: new Uint8Array(file)
-	});
-	if (!response.ok) throw new Error(`Failed to upload file to ${input.url}: ${response.status} ${response.statusText}`);
-}
-//#endregion
-//#region src/util/chunk.ts
-/**
-* Split an array into chunks of a given size.
-*/
-const chunk = (collection, size) => {
-	const result = [];
-	for (let x = 0; x < Math.ceil(collection.length / size); x++) {
-		const start = x * size;
-		const end = start + size;
-		result.push(collection.slice(start, end));
-	}
-	return result;
-};
-//#endregion
 //#region src/version.ts
 const require = createRequire(import.meta.url);
 /**
@@ -1386,4 +1464,4 @@ function formatPreviewUrl(url, formatter) {
 	return new URL(urlObj.pathname + urlObj.search + urlObj.hash, formatter.baseUrl).href;
 }
 //#endregion
-export { finalize, getConfigFromOptions, readConfig, skip, upload };
+export { deploy, finalize, getConfigFromOptions, readConfig, skip, upload };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "5.2.1",
+  "version": "5.3.0",
   "type": "module",
   "exports": {
     ".": {
@@ -39,7 +39,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.18.0",
+    "@argos-ci/api-client": "0.19.0",
     "@argos-ci/util": "3.4.0",
     "convict": "^6.2.5",
     "debug": "^4.4.3",
@@ -67,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "906c65c34de9cadf237cee1bf14a925dd960b6c6"
+  "gitHead": "9ff7241b23dce530910d0fffd113db23e2fbe949"
 }