@todesktop/cli 1.7.4 → 1.7.6

package/README.md

@@ -239,11 +239,11 @@ The path can be absolute or a relative path from the project root. The directory
 
 Side note: if your `package.json` contains a `postinstall` script which references scripts, these must be accessible within the `appPath` directory as only the `appPath` is uploaded to our servers.
 
-### `appProtocolScheme` - (optional) string
+### `appProtocolScheme` - (optional) string | string[]
 
 Default: no protocol scheme is registered.
 
-Example: `word`.
+Example: `word` or `[word, ...]`.
 
 If you want to register a protocol for your application (e.g. `example://`) and or support deeplinking, you will need to use this option. If your desired protocol is `example://`, you would set `"appProtocolScheme": "example"`. NOTE: these features also require additional application logic.
 
@@ -548,12 +548,25 @@ Default: The root [`icon`](#icon---string) is used.
 
 The path to your application's Mac desktop icon. It must be an ICNS or PNG.
 
+#### `mac.requirements` - (optional) string
+
+Example: `./requirements.txt`.
+Default: No requirements file is used by default.
+
+The path to the [requirements file](https://developer.apple.com/library/archive/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used when signing your application.
+
 ### `nodeVersion` - string
 
 Example: `18.12.1`.
 
 The version of Node.js that ToDesktop should use to build your app.
 
+### `npmVersion` - string
+
+Example: `9.8.1`.
+
+The version of NPM that ToDesktop should use for installation.
+
 ### `packageJson` - (optional) object
 
 Default: `{}`
@@ -976,6 +989,15 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### v.7.6
+
+- Add support for multiple app protocol schemes
+
+### v1.7.5
+
+- Add support for specifying custom `npmVersion` in config
+- Add support for bundling a requirements file for Mac
+
 ### v1.7.4
 
 - Fix: Linux/Windows platform links no longer have mac/zip/{arch} added to the end of the download URL

package/dist/cli.js

@@ -14,10 +14,6 @@ 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
 ));
@@ -308,16 +304,11 @@ var useExit_default = () => {
   return (error = void 0) => {
     logger_default.debug({ error }, "Exit called");
     firestore_default.terminate().catch(
-      (e) => (
-        // Ignore
-        logger_default.error(e)
-      )
+      (e) => logger_default.error(e)
     );
     let timeoutId;
     Promise.race([
-      // flush the analytics to make sure all outstanding events are pushed to segment
       new Promise((resolve4) => flush(() => resolve4())),
-      // If it takes longer than 1 second, resolve early to proceed with program exit
       new Promise(
         (resolve4) => timeoutId = setTimeout(() => resolve4(), 1e3)
       )
@@ -464,8 +455,7 @@ var isPlatformBuildRunning = (platformBuild) => {
   if (!platformBuild) {
     return false;
   }
-  return !platformBuild.shouldSkip && // <-- Noteworthy
-  !["cancelled", "succeeded"].includes(platformBuild.status) && ("failed" !== platformBuild.status || platformBuild.numberOfAttemptedBuilds < 2);
+  return !platformBuild.shouldSkip && !["cancelled", "succeeded"].includes(platformBuild.status) && ("failed" !== platformBuild.status || platformBuild.numberOfAttemptedBuilds < 2);
 };
 
 // src/components/BuildProgress.tsx
@@ -611,7 +601,6 @@ var ProgressBar = ({ left, right, percent }) => /* @__PURE__ */ (0, import_jsx_r
 ProgressBar.propTypes = {
   left: import_prop_types5.default.number,
   right: import_prop_types5.default.number,
-  // 0 -> 1
   percent: import_prop_types5.default.number.isRequired
 };
 var ProgressBar_default = ProgressBar;
@@ -1023,6 +1012,9 @@ function resolveConfigPaths({
     if (config2.mac.entitlements) {
       result.mac.entitlements = resolvePath(config2.mac.entitlements);
     }
+    if (config2.mac.requirements) {
+      result.mac.requirements = resolvePath(config2.mac.requirements);
+    }
     if (config2.mac.icon) {
       result.mac.icon = resolvePath(config2.mac.icon);
     }
@@ -1078,7 +1070,6 @@ 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"]
@@ -1458,7 +1449,16 @@ var full_default = (context) => {
         },
         minItems: 1
       },
-      appProtocolScheme: { type: "string", minLength: 1 },
+      appProtocolScheme: {
+        oneOf: [
+          { type: "string", minLength: 1 },
+          {
+            type: "array",
+            items: { type: "string", minLength: 1 },
+            minItems: 1
+          }
+        ]
+      },
       appPath: {
         type: "string",
         file: {
@@ -1603,7 +1603,16 @@ var full_default = (context) => {
           extendInfo: {
             type: "object"
           },
-          icon: getIconSchema()
+          icon: getIconSchema(),
+          requirements: {
+            type: "string",
+            file: {
+              from: context.projectRoot,
+              extensions: ["txt"],
+              mustBeFile: true
+            },
+            minLength: 1
+          }
         }
       },
       dmg: {
@@ -1649,6 +1658,11 @@ var full_default = (context) => {
         validSemver: {},
         minLength: 1
       },
+      npmVersion: {
+        type: "string",
+        validSemver: {},
+        minLength: 1
+      },
       appBuilderLibVersion: {
         type: "string",
         validSemver: {},
@@ -2105,36 +2119,19 @@ var uploadApplicationSource_default = async ({ appId, appPkgJson, buildId, confi
   );
   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: path8.join("extraContentFiles", to, path8.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: path8.join("extraResources", to, path8.basename(from))
       };
     }),
-    /*
-      Icons (more may be added below)
-    */
     {
       from: config2.icon,
       to: path8.join("icons", "appIcon" + path8.extname(config2.icon))
@@ -2164,6 +2161,12 @@ var uploadApplicationSource_default = async ({ appId, appPkgJson, buildId, confi
         to: path8.join("icons", "appIcon-mac" + path8.extname(config2.mac.icon))
       });
     }
+    if (config2.mac.requirements) {
+      files.push({
+        from: config2.mac.requirements,
+        to: path8.join("other", "mac", "requirements.txt")
+      });
+    }
   }
   if (config2.dmg) {
     if (config2.dmg.background) {
@@ -2322,6 +2325,7 @@ var runBuild_default = async ({ onEvent, shouldCodeSign = true, configPath }) =>
       userId: primaryUserId,
       sourceArchiveDetails,
       nodeVersion: config2.nodeVersion,
+      npmVersion: config2.npmVersion,
       appBuilderLibVersion: config2.appBuilderLibVersion
     });
   } catch (e) {
@@ -3379,7 +3383,7 @@ async function getBuilds({
 
 // src/utilities/getRelativeDateFromDateString.ts
 var dateFns = __toESM(require("date-fns"));
-var getRelativeDateFromDateString_default = (input) => dateFns.formatDistance(new Date(input), /* @__PURE__ */ new Date()) + " ago";
+var getRelativeDateFromDateString_default = (input) => dateFns.formatDistance(new Date(input), new Date()) + " ago";
 
 // src/components/SyntaxHighlight.tsx
 var import_chalk2 = __toESM(require("chalk"));
@@ -3694,9 +3698,7 @@ 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
   }) => {
@@ -3914,11 +3916,23 @@ async function getBuildAttributes({
   buildId,
   configPath
 }) {
-  const { id: appId, nodeVersion } = getProjectConfig(configPath).config;
+  const {
+    id: appId,
+    nodeVersion,
+    npmVersion
+  } = getProjectConfig(configPath).config;
   const { id: userId } = await findAppUserId_default(appId);
   const { uid: contextUserId } = currentUser();
   const build = await fetchBuild({ appId, buildId, userId });
-  return { appId, build, buildId, contextUserId, nodeVersion, userId };
+  return {
+    appId,
+    build,
+    buildId,
+    contextUserId,
+    nodeVersion,
+    npmVersion,
+    userId
+  };
 }
 async function fetchBuild({
   appId,
@@ -4472,7 +4486,6 @@ 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_runtime41.jsx)(
@@ -4562,6 +4575,7 @@ async function queueSmokeTest({
   buildId,
   contextUserId,
   nodeVersion,
+  npmVersion,
   userId
 }) {
   try {
@@ -4569,6 +4583,7 @@ async function queueSmokeTest({
       appId,
       buildId,
       nodeVersion,
+      npmVersion,
       userId,
       contextUserId
     });
@@ -4679,7 +4694,7 @@ async function smokeTestWorkflow({
   updateState
 }) {
   try {
-    const { appId, build, contextUserId, nodeVersion, userId } = await getBuildAttributes({
+    const { appId, build, contextUserId, nodeVersion, npmVersion, userId } = await getBuildAttributes({
       buildId,
       configPath
     });
@@ -4690,6 +4705,7 @@ async function smokeTestWorkflow({
         appId,
         buildId,
         nodeVersion,
+        npmVersion,
         userId,
         contextUserId
       });
@@ -4704,7 +4720,6 @@ async function smokeTestWorkflow({
     const stateMap = {
       done: "complete",
       progress: "complete",
-      // Not actually used, just for TS
       error: "progress-error",
       canceled: "canceled"
     };
@@ -4785,7 +4800,7 @@ var package_default = {
     access: "public"
   },
   name: "@todesktop/cli",
-  version: "1.7.3",
+  version: "1.7.5",
   license: "MIT",
   author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
   homepage: "https://todesktop.com/cli",
@@ -4865,7 +4880,7 @@ var package_default = {
     "xdg-basedir": "^4.0.0"
   },
   devDependencies: {
-    "@todesktop/shared": "^7.180.0",
+    "@todesktop/shared": "^7.186.6",
     "@types/bunyan": "^1.8.6",
     "@types/react": "^18.0.26",
     "@typescript-eslint/eslint-plugin": "^5.46.1",