dxfl 0.2.2 → 0.3.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.3.1
+
+- fix `deuxfleurs.toml`: always pass the user-provided value of index_page to garage
+
+# v0.3.0
+
+- improve `list` presentation
+- add `inspect` command to show a website details
+
 # v0.2.2
 
 - add color on prefixes from error/warning messages

package/README.md

@@ -46,6 +46,12 @@ Use the `empty` command to delete all files from a website (required before dele
 dxfl empty example.com
 ```
 
+Use the `inspect` command to show more detailed informations about a website
+
+```
+dxfl inspect example.com
+```
+
 ## Website configuration
 
 `dxfl deploy` reads a `deuxfleurs.toml` configuration file (if it exists in the current directory).

package/dist/guichet.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { WebsiteApi, } from "guichet-sdk-ts";
-import clc from "cli-color";
+import { textWarn } from "./utils.js";
 import { ErrorGuichet } from "./error.js";
 // The GuichetApi class wraps WebsiteApi (from the guichet sdk). It catches
 // errors that can happen in normal use, and it turn them into a dedicated error type
@@ -45,7 +45,7 @@ export class GuichetApi {
                     // the migration of websites *.web.deuxfleurs.fr to bucket
                     // names with the full domain name.
                     // We just warn that this is a working but deprecated name.
-                    console.log(`${clc.yellow("Warning")}: the name "${vhost}" is now deprecated for this website,` +
+                    console.log(`${textWarn("Warning")}: the name "${vhost}" is now deprecated for this website,` +
                         ` you should use "${vhost}.web.deuxfleurs.fr" instead.`);
                 }
                 return websiteInfo;

package/dist/index.js

@@ -5,7 +5,8 @@ import { login, logout } from "./auth.js";
 import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
 import { vhostsList } from "./vhosts.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.2.2");
+import { inspect } from "./inspect.js";
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.3.1");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")
@@ -15,6 +16,12 @@ program
     .command("list")
     .description("List all your websites")
     .action(() => withHandleErrors(vhostsList));
+program
+    .command("inspect")
+    .description("Show your website details")
+    .argument("<website>", "selected website")
+    .option("--secret", "reveal your S3 secret access key")
+    .action((website, options) => withHandleErrors(() => inspect(website, options)));
 program
     .command("deploy")
     .description("Deploy your website")

package/dist/inspect.js

@@ -0,0 +1,40 @@
+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 { WebsiteApi } from "guichet-sdk-ts";
+import { openApiConf } from "./auth.js";
+import { formatBytesHuman, separator, textGreen, textGrey, } from "./utils.js";
+import clc from "cli-color";
+export function inspect(website, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        const conf = yield openApiConf();
+        const web = new WebsiteApi(conf);
+        let siteData = yield web.getWebsite({ vhost: website });
+        const q = siteData.quotaSize;
+        const v = siteData.vhost;
+        const kId = siteData === null || siteData === void 0 ? void 0 : siteData.accessKeyId;
+        let kSecret = siteData === null || siteData === void 0 ? void 0 : siteData.secretAccessKey;
+        if (!options.secret) {
+            kSecret =
+                `**** ` +
+                    textGrey.italic(`(use \`dxfl inspect ${v === null || v === void 0 ? void 0 : v.name} --secret\` to reveal it)`);
+        }
+        console.log(textGreen.bold(`${v === null || v === void 0 ? void 0 : v.name} details`));
+        console.log(separator());
+        console.log(`  ${clc.bold("id")}: ${v === null || v === void 0 ? void 0 : v.name}`);
+        console.log(`  ${clc.bold("url")}: ${clc.underline("https://" + (v === null || v === void 0 ? void 0 : v.domain))}`);
+        console.log(`  ${clc.bold("usage")}:`, `${formatBytesHuman((_a = q === null || q === void 0 ? void 0 : q.current) !== null && _a !== void 0 ? _a : 0)} / ${formatBytesHuman((_b = q === null || q === void 0 ? void 0 : q.max) !== null && _b !== void 0 ? _b : 0)}`, `(${Math.round(((_c = q === null || q === void 0 ? void 0 : q.ratio) !== null && _c !== void 0 ? _c : 0) * 100)}%)`);
+        console.log(`  ${clc.bold("S3 keys")}:`);
+        console.log(`    ${clc.bold("access_key_id")}: ${kId}`);
+        console.log(`    ${clc.bold("secret_access_key")}: ${kSecret}`);
+        console.log(separator());
+        console.log(textGrey.italic(`→ For more information and features, you can visit the web UI:`, `${clc.underline("https://guichet.deuxfleurs.fr/website/inspect/" + (v === null || v === void 0 ? void 0 : v.name))}`));
+    });
+}

package/dist/utils.js

@@ -19,6 +19,11 @@ import crypto from "crypto";
 import { stdin, stdout } from "process";
 import readline from "readline/promises";
 import { ErrorMsg } from "./error.js";
+import clc from "cli-color";
+export const textGreen = clc.green;
+export const textWarn = clc.yellow;
+export const textError = clc.red;
+export const textGrey = clc.xterm(242);
 export function getFileMd5(file) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
@@ -122,3 +127,10 @@ export function filterMap(a, f) {
         return y ? [y] : [];
     });
 }
+export function separator(size = 42) {
+    let dashes = "";
+    for (let i = 0; i < size; i++) {
+        dashes += "-";
+    }
+    return textGrey(dashes);
+}

package/dist/vhosts.js

@@ -9,12 +9,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { WebsiteApi } from "guichet-sdk-ts";
 import { openApiConf } from "./auth.js";
+import { separator, textGreen } from "./utils.js";
+import clc from "cli-color";
 export function vhostsList() {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a;
+        var _a, _b, _c;
         const conf = yield openApiConf();
         const web = new WebsiteApi(conf);
-        const wlist = yield web.listWebsites();
-        (_a = wlist.vhosts) === null || _a === void 0 ? void 0 : _a.forEach(v => console.log(v.name));
+        const sitesData = yield web.listWebsites();
+        // Counter
+        console.log(`${((_a = sitesData.quotaWebsiteCount) === null || _a === void 0 ? void 0 : _a.current) || 0} websites`, `(out of ${(_b = sitesData.quotaWebsiteCount) === null || _b === void 0 ? void 0 : _b.max}):`);
+        // List
+        (_c = sitesData.vhosts) === null || _c === void 0 ? void 0 : _c.forEach((v, i) => {
+            if (i === 0) {
+                console.log(separator());
+            }
+            console.log(textGreen(v.name));
+            console.log(`  ${clc.bold("id")}: ${v.name}`);
+            console.log(`  ${clc.bold("url")}: ${clc.underline("https://" + v.domain)}`);
+            console.log(separator());
+        });
     });
 }

package/dist/website_config.js

@@ -143,8 +143,8 @@ function unescape(s) {
     }
 }
 function interpConfig(rawcfg) {
-    var _a, _b, _c, _d, _e;
-    function interpRedirect(i, r) {
+    var _a, _b, _c, _d, _e, _f;
+    function interpRedirect(r) {
         var _a, _b;
         const rfrom = withErrorMsg(() => unescape(r.from), msg => `from: ${msg}`);
         const rto = withErrorMsg(() => unescape(r.to), msg => `to: ${msg}`);
@@ -264,7 +264,7 @@ function interpConfig(rawcfg) {
         return s !== null && s !== void 0 ? s : def;
     };
     // use index.html as default index page
-    const index_page = withDefault(rawcfg.index_page, "index.html");
+    const index_page = (_a = rawcfg.index_page) !== null && _a !== void 0 ? _a : "index.html";
     // use error.html as default error page
     const error_page = withDefault(rawcfg.error_page, "error.html");
     let cfg = {
@@ -274,9 +274,9 @@ function interpConfig(rawcfg) {
         object_redirects: new Map(),
         cors_rules: [],
     };
-    for (const [i, raw] of ((_a = rawcfg.redirects) !== null && _a !== void 0 ? _a : []).entries()) {
+    for (const [i, raw] of ((_b = rawcfg.redirects) !== null && _b !== void 0 ? _b : []).entries()) {
         // `i+1` is only used for display: start counting redirects from 1 instead of 0
-        const r = withErrorMsg(() => interpRedirect(i + 1, raw), msg => `Redirect ${i + 1}: ${msg}`);
+        const r = withErrorMsg(() => interpRedirect(raw), msg => `Redirect ${i + 1}: ${msg}`);
         if (r.kind == "bucket") {
             cfg.bucket_redirects.push(r.r);
         }
@@ -287,15 +287,15 @@ function interpConfig(rawcfg) {
             cfg.object_redirects.set(r.from, r.to);
         }
     }
-    for (const [_, raw] of ((_b = rawcfg.cors) !== null && _b !== void 0 ? _b : []).entries()) {
+    for (const [_, raw] of ((_c = rawcfg.cors) !== null && _c !== void 0 ? _c : []).entries()) {
         const interpRawArray = (x) => {
             return typeof x === "string" ? [x] : x;
         };
         cfg.cors_rules.push({
             allowed_origins: interpRawArray(raw.allowed_origins),
-            allowed_methods: interpRawArray((_c = raw.allowed_methods) !== null && _c !== void 0 ? _c : ["GET", "HEAD"]),
-            allowed_headers: interpRawArray((_d = raw.allowed_methods) !== null && _d !== void 0 ? _d : []),
-            expose_headers: interpRawArray((_e = raw.expose_headers) !== null && _e !== void 0 ? _e : []),
+            allowed_methods: interpRawArray((_d = raw.allowed_methods) !== null && _d !== void 0 ? _d : ["GET", "HEAD"]),
+            allowed_headers: interpRawArray((_e = raw.allowed_methods) !== null && _e !== void 0 ? _e : []),
+            expose_headers: interpRawArray((_f = raw.expose_headers) !== null && _f !== void 0 ? _f : []),
         });
     }
     return cfg;
@@ -431,10 +431,10 @@ export function putBucketWebsiteConfig(bucket, index_page, error_page, bucket_re
     return __awaiter(this, void 0, void 0, function* () {
         // TODO: printing to show what changes are being applied?
         const WebsiteConfiguration = {};
-        if (error_page) {
+        if (error_page != undefined) {
             WebsiteConfiguration.ErrorDocument = { Key: error_page };
         }
-        if (index_page) {
+        if (index_page != undefined) {
             WebsiteConfiguration.IndexDocument = { Suffix: index_page };
         }
         if (bucket_redirects.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dxfl",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",