dxfl 0.5.5 → 0.6.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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/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.0");
 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();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dxfl",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",
@@ -23,7 +23,7 @@
     "prettier-check": "npx prettier . --check"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1012.0",
+    "@aws-sdk/client-s3": "^3.1014.0",
     "@commander-js/extra-typings": "^14.0.0",
     "@supercharge/promise-pool": "^3.2.0",
     "@types/node": "^25.2.1",
@@ -42,10 +42,5 @@
   "devDependencies": {
     "onchange": "^7.1.0",
     "prettier": "3.5.3"
-  },
-  "overrides": {
-    "@aws-sdk/xml-builder": {
-      "fast-xml-parser": "^5.5.6"
-    }
   }
 }

package/deuxfleurs.toml

@@ -1,18 +0,0 @@
-error_page = "error.html"
-
-# [[redirects]]
-# from = "TinyCorePure64-15.0.iso"
-# to = "/bbc"
-
-[[redirects]]
-from = "/a"
-to = "/def"
-
-[[cors]]
-allowed_origins = "foo"
-
-[[headers]]
-for = ["**/*.txt"]
-compress = "gzip"
-[headers.values]
-Cache-Control = "hello44"

package/dist/deploy_websiteconfig.js

@@ -1,108 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { PromisePool } from "@supercharge/promise-pool";
-import { GetBucketWebsiteCommand, HeadObjectCommand, } from "@aws-sdk/client-s3";
-export function getBucketWebsite(client, Bucket) {
-    return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b;
-        const cmd = new GetBucketWebsiteCommand({ Bucket });
-        const response = yield client.send(cmd);
-        if (response.RedirectAllRequestsTo) {
-            // NB: garage does not currently support RedirectAllRequestsTo so this should never happen
-            throw `remote website configuration: RedirectAllRequestsTo is specified; \
-               this is currently unsupported by dxfl`;
-        }
-        const index_page = (_a = response.ErrorDocument) === null || _a === void 0 ? void 0 : _a.Key;
-        const error_page = (_b = response.IndexDocument) === null || _b === void 0 ? void 0 : _b.Suffix;
-        let redirects = [];
-        if (response.RoutingRules) {
-            for (const rule of response.RoutingRules) {
-                // If no Condition is specified, then the redirect always applies, which is equivalent
-                // to matching on an empty prefix
-                let prefix = "";
-                let if_error = undefined;
-                if (rule.Condition) {
-                    if (rule.Condition.HttpErrorCodeReturnedEquals) {
-                        if (rule.Condition.HttpErrorCodeReturnedEquals == "404") {
-                            if_error = 404;
-                        }
-                        else {
-                            // currently not supported by garage
-                            throw `remote website configuration: 'if_error' specified with a different \
-                               code than 404; this is currently unsupported by dxfl`;
-                        }
-                    }
-                    if (rule.Condition.KeyPrefixEquals) {
-                        prefix = rule.Condition.KeyPrefixEquals;
-                    }
-                }
-                const hostname = rule.Redirect.HostName;
-                const code = rule.Redirect.HttpRedirectCode
-                    ? parseInt(rule.Redirect.HttpRedirectCode)
-                    : undefined;
-                let protocol = undefined;
-                if (rule.Redirect.Protocol) {
-                    if (rule.Redirect.Protocol == "http" ||
-                        rule.Redirect.Protocol == "https") {
-                        protocol = rule.Redirect.Protocol;
-                    }
-                    else {
-                        // currently not supported by garage
-                        throw `remote website configuration: 'protocol' is neither http or https; \
-                           this is currently unsupported by dxfl`;
-                    }
-                }
-                let to;
-                if (rule.Redirect.ReplaceKeyPrefixWith) {
-                    to = {
-                        kind: "replace_prefix",
-                        prefix: rule.Redirect.ReplaceKeyPrefixWith,
-                    };
-                }
-                else if (rule.Redirect.ReplaceKeyWith) {
-                    to = { kind: "replace", target: rule.Redirect.ReplaceKeyWith };
-                }
-                else {
-                    // not completely sure whether this is the correct behavior, but it should
-                    // match garage's implementation
-                    to = { kind: "replace", target: "" };
-                }
-                redirects.push({
-                    kind: "bucket",
-                    r: { prefix, if_error, hostname, code, protocol, to },
-                });
-            }
-        }
-        return { index_page, error_page, redirects };
-    });
-}
-// XXX
-const MD5METAFIELD = "dfl-md5sum";
-export function getBucketFilesDetails(client, Bucket, files) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let res = new Map();
-        function doFile(file) {
-            return __awaiter(this, void 0, void 0, function* () {
-                var _a;
-                const resp = yield client.send(new HeadObjectCommand({ Bucket, Key: file }));
-                if (resp.$metadata.httpStatusCode != 200) {
-                    // TODO: better error handling?
-                    throw resp;
-                }
-                res.set(file, {
-                    md5: (_a = resp.Metadata) === null || _a === void 0 ? void 0 : _a[MD5METAFIELD],
-                    redirect: resp.WebsiteRedirectLocation,
-                });
-            });
-        }
-        yield PromisePool.for(files).withConcurrency(50).process(doFile);
-        return res;
-    });
-}

package/dist/errors.js

@@ -1,7 +0,0 @@
-import { err } from "neverthrow";
-export function errMsg(msg) {
-    return err({ kind: "msg", msg });
-}
-export function errS3(resp) {
-    return err({ kind: "s3", resp: resp.$metadata });
-}

package/public/TinyCorePure64-15.0.iso

@@ -1 +0,0 @@
-toto

package/public/d/b

@@ -1,2 +0,0 @@
-b
-foo

package/public/d/c

@@ -1,2 +0,0 @@
-c
-foo

package/public/d/dd/bla

@@ -1 +0,0 @@
-bla

package/public/d/dd/foo.txt

@@ -1 +0,0 @@
-test

package/public/def

@@ -1,2 +0,0 @@
-abc
-abc

package/public/error.html

@@ -1 +0,0 @@
-oops, 404 error!

package/public/index.html

@@ -1 +0,0 @@
-hello there! 花見 toto312

package/public/index.html~

@@ -1 +0,0 @@
-hello there! 花見 toto2

package/public/slt

@@ -1 +0,0 @@
-abc

package/public/toto.txt

@@ -1 +0,0 @@
-abc defuieu

package/public/toto2.txt

@@ -1 +0,0 @@
-abc