dxfl 0.5.5 → 0.6.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.6.1
+
+- Dependencies bump
+- Enforce lockfile on publication (npm shrinkwrap)
+
+# v0.6.0
+
+- Allow passing a URL as the website name
+
 # v0.5.4, v0.5.5
 
 - Fix bug when deploying compressed files in subdirectories (introduced in 0.5.0)

package/README.md

@@ -220,7 +220,7 @@ Then to publish a release:
 vim CHANGELOG.md # update the version and its content in this file
 vim package.json # update the version in this file
 vim index.ts # update the version in this file
-npm install # update the version in the package-lock.json
+npm install # update the version in the lock file
 npm run prettier # fix potential coding style problem
 git commit -a -m 'set version 0.1.5' # commit your change
 git push # send update

package/dist/_empty.js

@@ -0,0 +1,64 @@
+// // TODO: Refacto the codebase global before integrate this feature
+export {};
+// export async function empty(
+// 	vhost: string,
+// 	options: { dryRun: boolean | undefined },
+// ) {
+// 	const conf = await openApiConf();
+// 	// Get website info from guichet (bucket name and keys)
+// 	const api = new WebsiteApi(conf);
+// 	let vhostInfo = await api.getWebsite({ vhost }).catch(err => {
+// 		if (err.response.status == 404) {
+// 			console.error(`Error: website '${vhost}' does not exist`);
+// 		} else {
+// 			console.error(err);
+// 		}
+// 		process.exit(1);
+// 	});
+// 	// List the files currently stored in the bucket
+// 	// @FIXME this info could be returned by the guichet API
+// 	const s3client = new S3Client({
+// 		endpoint: "https://garage.deuxfleurs.fr",
+// 		region: "garage",
+// 		forcePathStyle: true,
+// 		credentials: {
+// 			accessKeyId: vhostInfo.accessKeyId!,
+// 			secretAccessKey: vhostInfo.secretAccessKey!,
+// 		},
+// 	});
+// 	const Bucket = vhostInfo.vhost!.name!;
+// 	const filesToDelete = [...(await getBucketFiles(s3client, Bucket))].map(
+// 		([name, { size }]) => ({
+// 			name,
+// 			size,
+// 		}),
+// 	);
+// 	for (const file of filesToDelete) {
+// 		process.stdout.write(`Deleting ${file.name}\n`);
+// 	}
+// 	// If not in dry-run mode, send the delete command
+// 	if (!options.dryRun) {
+// 		const resp = await deleteFiles(s3client, Bucket, filesToDelete);
+// 		if (resp && resp!.$metadata.httpStatusCode != 200) {
+// 			// TODO: better error handling?
+// 			console.error(resp);
+// 			process.exit(1);
+// 		}
+// 	}
+// 	// Display a summary
+// 	function sum(a: number[]) {
+// 		return a.reduce((x, y) => x + y, 0);
+// 	}
+// 	function formatFiles(n: number) {
+// 		if (n == 1) {
+// 			return `${n} file `;
+// 		} else {
+// 			return `${n} files`;
+// 		}
+// 	}
+// 	const sizeDeleted = sum(filesToDelete.map(f => f.size ?? 0));
+// 	process.stdout.write("\nSummary:\n");
+// 	process.stdout.write(
+// 		`${formatFiles(filesToDelete.length)} deleted (${formatBytes(sizeDeleted)})\n`,
+// 	);
+// }

package/dist/deploy.js

@@ -13,7 +13,7 @@ import { PromisePool } from "@supercharge/promise-pool";
 import { deleteBucketFile, deleteBucketFiles, getBucketCredentials, getBucket, getBucketFiles, putEmptyObjectRedirect, uploadFile, setObjectHeaders, } from "./bucket.js";
 import { ErrorMsg } from "./error.js";
 import { fileContentType, supportedHeaders, } from "./headers.js";
-import { confirmationPrompt, filterMap, formatBytesHuman, formatCount, getFileMd5, gzipFile, mapEq, mkTmpDir, sum, } from "./utils.js";
+import { confirmationPrompt, filterMap, formatBytesHuman, formatCount, getFileMd5, gzipFile, mapEq, mkTmpDir, sum, websiteIdBestEffort, } from "./utils.js";
 import { evalHeadersRules, equalBucketRedirect, getBucketConfig, putBucketWebsiteConfig, readConfigFile, } from "./website_config.js";
 // Walks through the local directory at path `dir`, and for each file it contains, returns :
 // - `localPath`: its path on the local filesystem (includes `dir`). On windows, this path
@@ -429,13 +429,15 @@ export function deploy(website, localFolder, options) {
         }
         // Read and validate the local configuration file before doing anything else
         const localWebsiteConfig = yield readConfigFile(options.configFile);
+        // Interpret the name of the website
+        const websiteId = websiteIdBestEffort(website);
         process.stdout.write("Fetching the website configuration and metadata...\n");
         const [localFiles, [bucket, remoteFiles, remoteWebsiteConfig]] = yield Promise.all([
             // Get paths & size of the local files to deploy
             getLocalFilesWithInfo(localFolder),
             // Get the bucket, list of files stored in the bucket, and bucket website config
             (() => __awaiter(this, void 0, void 0, function* () {
-                const bucket = yield getBucket(website, yield getBucketCredentials(website));
+                const bucket = yield getBucket(websiteId, yield getBucketCredentials(websiteId));
                 const remoteFiles = yield getBucketFiles(bucket);
                 // This can be slow because it needs to query each object in the bucket.
                 const remoteWebsiteConfig = yield getBucketConfig(bucket, [

package/dist/empty.js

@@ -9,14 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { getBucket, getBucketCredentials, getBucketFiles, deleteBucketFiles, } from "./bucket.js";
 import { ErrorMsg } from "./error.js";
-import { confirmationPrompt, formatBytesHuman, formatCount, sum, } from "./utils.js";
+import { confirmationPrompt, formatBytesHuman, formatCount, sum, websiteIdBestEffort, } from "./utils.js";
 export function empty(website, options) {
     return __awaiter(this, void 0, void 0, function* () {
         if (options.dryRun && options.yes) {
             throw new ErrorMsg("options --yes and --dry-run cannot be passed at the same time");
         }
         process.stdout.write("Fetching the website configuration and metadata...\n");
-        const bucket = yield getBucket(website, yield getBucketCredentials(website));
+        // Interpret the name of the website
+        const websiteId = websiteIdBestEffort(website);
+        const bucket = yield getBucket(websiteId, yield getBucketCredentials(websiteId));
         const filesToDelete = [...(yield getBucketFiles(bucket))].map(([name, { size }]) => ({
             name,
             size,

package/dist/index.js

@@ -4,9 +4,9 @@ import { withHandleErrors } from "./error.js";
 import { login, logout } from "./auth.js";
 import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
-import { vhostsList } from "./vhosts.js";
+import { list } from "./vhosts.js";
 import { inspect } from "./inspect.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.5.5");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.6.1");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")
@@ -15,7 +15,7 @@ program
 program
     .command("list")
     .description("List all your websites")
-    .action(() => withHandleErrors(vhostsList));
+    .action(() => withHandleErrors(list));
 program
     .command("inspect")
     .description("Show your website details")

package/dist/inspect.js

@@ -9,14 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { WebsiteApi } from "guichet-sdk-ts";
 import { openApiConf } from "./auth.js";
-import { formatBytesHuman, separator } from "./utils.js";
+import { formatBytesHuman, separator, websiteIdBestEffort } from "./utils.js";
 import { styleText } from "node:util";
 export function inspect(website, options) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;
+        const websiteId = websiteIdBestEffort(website); // Interpret the name of the website
         const conf = yield openApiConf();
         const web = new WebsiteApi(conf);
-        let siteData = yield web.getWebsite({ vhost: website });
+        let siteData = yield web.getWebsite({ vhost: websiteId });
         const q = siteData.quotaSize;
         const v = siteData.vhost;
         const kId = siteData === null || siteData === void 0 ? void 0 : siteData.accessKeyId;

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../auth.ts","../bucket.ts","../deploy.ts","../empty.ts","../error.ts","../guichet.ts","../headers.ts","../index.ts","../inspect.ts","../utils.ts","../vhosts.ts","../website_config.ts"],"version":"5.9.3"}

package/dist/utils.js

@@ -23,6 +23,7 @@ import { pipeline } from "node:stream/promises";
 import { styleText } from "node:util";
 import zlib from "node:zlib";
 import readline from "readline/promises";
+import URI from "fast-uri";
 import { ErrorMsg } from "./error.js";
 export function getFileMd5(file) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -150,3 +151,15 @@ export function mapEq(m1, m2) {
     return (m1.size === m2.size &&
         Array.from(m1.keys()).every(key => m1.get(key) == m2.get(key)));
 }
+// Accept {http,https}://website{,/} as identifier for "website".
+// (Useful to allow copy-pasting URLs into the terminal.)
+export function websiteIdBestEffort(website) {
+    const asURI = URI.parse(website);
+    if (!asURI.error &&
+        asURI.host &&
+        (asURI.scheme == "http" || asURI.scheme == "https") &&
+        (asURI.path == "" || asURI.path == "/")) {
+        return asURI.host;
+    }
+    return website;
+}

package/dist/vhosts.js

@@ -11,7 +11,7 @@ import { WebsiteApi } from "guichet-sdk-ts";
 import { openApiConf } from "./auth.js";
 import { separator } from "./utils.js";
 import { styleText } from "node:util";
-export function vhostsList() {
+export function list() {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;
         const conf = yield openApiConf();