@todesktop/cli 1.15.0 → 1.15.1

package/README.md

@@ -42,7 +42,7 @@ Create a `todesktop.json` file in the root of your Electron project.
 
 ```json
 {
-  "$schema": "https://unpkg.com/@todesktop/cli@1.14.0/schemas/schema.json",
+  "$schema": "https://unpkg.com/@todesktop/cli@1.15.0/schemas/schema.json",
   "schemaVersion": 1
   "id": "your-todesktop-id",
   "icon": "./desktop-icon.png",
@@ -272,7 +272,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
 - For example, if using a hosted version of the schema:
   ```json
   {
-    "$schema": "https://unpkg.com/@todesktop/cli@1.14.0/schemas/schema.json",
+    "$schema": "https://unpkg.com/@todesktop/cli@1.15.0/schemas/schema.json",
     "id": "your-todesktop-id"
   }
   ```
@@ -1334,6 +1334,10 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### v1.15.1
+
+- Update dependencies to latest non-breaking versions.
+
 ### v1.15.0
 
 - Add support for `todesktop.ts` configuration file with full TypeScript type checking and IntelliSense.

package/dist/cli.js

@@ -14,6 +14,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -73,7 +77,10 @@ function sanitizeFields(obj) {
     const lowerKey = key.toLowerCase();
     const value = copy[key];
     if (SENSITIVE_FIELD_KEY_SUBSTRINGS.some(
-      (substring) => lowerKey.includes(substring) && !lowerKey.startsWith("$")
+      (substring) => (
+        // Fields that start with `$` are references to secrets (and not secrets themselves) so keep them in logs because they are useful.
+        lowerKey.includes(substring) && !lowerKey.startsWith("$")
+      )
     )) {
       copy[key] = "[REDACTED]";
     } else if (typeof value === "string" && isJWT(value)) {
@@ -344,7 +351,9 @@ var useExit_default = () => {
     logger_default.debug({ error }, "Exit called");
     let timeoutId;
     Promise.race([
+      // flush the analytics to make sure all outstanding events are pushed to segment
       new Promise((resolve5) => flush(() => resolve5())),
+      // If it takes longer than 1 second, resolve early to proceed with program exit
       new Promise(
         (resolve5) => timeoutId = setTimeout(() => resolve5(), 1e3)
       )
@@ -491,7 +500,8 @@ var isPlatformBuildRunning = (platformBuild) => {
   if (!platformBuild) {
     return false;
   }
-  return !platformBuild.shouldSkip && !["cancelled", "succeeded"].includes(platformBuild.status) && ("failed" !== platformBuild.status || platformBuild.numberOfAttemptedBuilds < 2);
+  return !platformBuild.shouldSkip && // <-- Noteworthy
+  !["cancelled", "succeeded"].includes(platformBuild.status) && ("failed" !== platformBuild.status || platformBuild.numberOfAttemptedBuilds < 2);
 };
 
 // src/components/BuildProgress.tsx
@@ -967,6 +977,7 @@ var ProgressBar = ({ left, right, percent }) => /* @__PURE__ */ (0, import_jsx_r
 ProgressBar.propTypes = {
   left: import_prop_types6.default.number,
   right: import_prop_types6.default.number,
+  // 0 -> 1
   percent: import_prop_types6.default.number.isRequired
 };
 var ProgressBar_default = ProgressBar;
@@ -1245,6 +1256,7 @@ var packageJSON_default = (context) => {
       dependencies: {
         type: "object",
         required: ["@todesktop/runtime"],
+        // custom keyword that checks package names aren't included in dependencies
         excludedDependencies: {
           dependencyKey: "dependencies",
           blacklist: ["@todesktop/cli"]
@@ -2999,19 +3011,36 @@ async function uploadApplicationSource({
   );
   let totalBytes = 0;
   const files = [
+    /*
+      App files (stored in app/ in the ZIP)
+    */
     ...await getAppFiles(config2.appFiles, config2.appPath, appPkgJson),
+    /*
+      Optional extra content files (stored in extraContentFiles/ in the ZIP). Their
+      paths within is the their relative path from the project root so
+      there will be no issues with clashing filenames. We also don't
+      also any file paths in our todesktop.json that are outside of the
+      project directory
+    */
     ...(config2.extraContentFiles || []).map(({ from, to = "." }) => {
       return {
         from,
         to: path7.join("extraContentFiles", to, path7.basename(from))
       };
     }),
+    /*
+      Optional extra resources (stored in extraResources/ in the ZIP).
+      Similar to extra content files above
+    */
     ...(config2.extraResources || []).map(({ from, to = "." }) => {
       return {
         from,
         to: path7.join("extraResources", to, path7.basename(from))
       };
     }),
+    /*
+      Icons (more may be added below)
+    */
     {
       from: config2.icon,
       to: path7.join("icons", "appIcon" + path7.extname(config2.icon))
@@ -4665,7 +4694,9 @@ var SelectTable = ({ data, onSelect }) => {
     });
   };
   const ItemComponent = ({
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     label,
+    // Make it compatible to SelectInput type, not used actually
     index,
     isSelected
   }) => {
@@ -5662,6 +5693,7 @@ function OsProgress({
     error: "red",
     done: "green",
     skipped: "yellow"
+    // Not used actually, just for type matching
   };
   const text = progress.message + (progress.state === "progress" ? "..." : "");
   return /* @__PURE__ */ (0, import_jsx_runtime42.jsx)(
@@ -5912,6 +5944,7 @@ async function smokeTestWorkflow({
     const stateMap = {
       done: "complete",
       progress: "complete",
+      // Not actually used, just for TS
       error: "progress-error",
       canceled: "canceled"
     };
@@ -5992,7 +6025,7 @@ var package_default = {
     access: "public"
   },
   name: "@todesktop/cli",
-  version: "1.14.0",
+  version: "1.15.0",
   license: "MIT",
   author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
   homepage: "https://todesktop.com/cli",