@todesktop/cli 1.7.2 → 1.7.4

package/README.md

@@ -247,6 +247,12 @@ Example: `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.
 
+### `asar` - (optional) boolean
+
+Default: true
+
+Whether to package your application's source code within an asar archive. You should only turn this off if you have a good reason to.
+
 ### `asarUnpack` - (optional) boolean or array of glob patterns
 
 Default: [`**/*.node`]
@@ -584,7 +590,7 @@ Default: If `yarn.lock` exists, `yarn` is used. If `pnpm-lock.yaml` or `shrinkwr
 
 Example: `yarn`
 
-The package manager to use when installing dependencies. Valid values are `npm`, `yarn` or `npm`.
+The package manager to use when installing dependencies. Valid values are `npm`, `yarn` or `pnpm`.
 
 ### `schemaVersion` - number
 
@@ -843,10 +849,10 @@ const { writeFile } = require("fs/promises");
 module.exports = async ({ appOutDir, packager }) => {
   if (os.platform() === "darwin") {
     const appName = packager.appInfo.productFilename;
-    const appPath = path.join(`${appOutDir}`, `${APP_NAME}.app`);
+    const appPath = path.join(`${appOutDir}`, `${appName}.app`);
     await writeFile(
       path.join(appPath, "copyright.txt"),
-      `Copyright © ${new Date().getFullYear()} ${APP_NAME}`
+      `Copyright © ${new Date().getFullYear()} ${appName}`
     );
   }
 };
@@ -970,6 +976,23 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### v1.7.4
+
+- Fix: Linux/Windows platform links no longer have mac/zip/{arch} added to the end of the download URL
+
+### v1.7.3
+
+- Add asar configuration support
+
+### v1.7.1
+
+- Add support for specifying custom `appBuilderLibVersion` in config
+- Show suggestion to run a Smoke Test when releasing an untested build
+
+### v1.7.0
+
+- Add `todesktop smoke-test` command
+
 ### v1.6.3
 
 - Add support for specifying custom `windows.nsisCustomBinary` in config

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
 ));
@@ -304,11 +308,16 @@ var useExit_default = () => {
   return (error = void 0) => {
     logger_default.debug({ error }, "Exit called");
     firestore_default.terminate().catch(
-      (e) => logger_default.error(e)
+      (e) => (
+        // Ignore
+        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)
       )
@@ -393,7 +402,7 @@ var PlatformProgress = ({
 }) => {
   let progressIndicator;
   if (activityType === "done") {
-    if (process.platform === "darwin") {
+    if (platform === "mac") {
       downloadUrl = import_path3.default.posix.join(downloadUrl, "mac", "zip", process.arch);
     }
     progressIndicator = /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)(import_ink3.Box, { flexDirection: "column", marginBottom: 1, children: [
@@ -455,7 +464,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
@@ -601,6 +611,7 @@ 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;
@@ -1067,6 +1078,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"]
@@ -1455,6 +1467,10 @@ var full_default = (context) => {
           mustBeElectronApp: true
         }
       },
+      asar: {
+        type: "boolean",
+        default: true
+      },
       asarUnpack: {
         oneOf: [
           { type: "boolean" },
@@ -2089,19 +2105,36 @@ 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))
@@ -2755,6 +2788,7 @@ var findAppUserId = async (appId) => {
       if (doc.exists)
         return user;
     } catch (err) {
+      console.error(err);
     }
   }
   return primaryUser;
@@ -3345,7 +3379,7 @@ async function getBuilds({
 
 // src/utilities/getRelativeDateFromDateString.ts
 var dateFns = __toESM(require("date-fns"));
-var getRelativeDateFromDateString_default = (input) => dateFns.formatDistance(new Date(input), new Date()) + " ago";
+var getRelativeDateFromDateString_default = (input) => dateFns.formatDistance(new Date(input), /* @__PURE__ */ new Date()) + " ago";
 
 // src/components/SyntaxHighlight.tsx
 var import_chalk2 = __toESM(require("chalk"));
@@ -3660,7 +3694,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
   }) => {
@@ -3879,9 +3915,10 @@ async function getBuildAttributes({
   configPath
 }) {
   const { id: appId, nodeVersion } = getProjectConfig(configPath).config;
-  const userId = await fetchUserIdByAppId(appId);
+  const { id: userId } = await findAppUserId_default(appId);
+  const { uid: contextUserId } = currentUser();
   const build = await fetchBuild({ appId, buildId, userId });
-  return { appId, build, buildId, nodeVersion, userId };
+  return { appId, build, buildId, contextUserId, nodeVersion, userId };
 }
 async function fetchBuild({
   appId,
@@ -3894,14 +3931,6 @@ async function fetchBuild({
   }
   return build;
 }
-async function fetchUserIdByAppId(appId) {
-  try {
-    const { id: userId } = await findAppUserId_default(appId);
-    return userId;
-  } catch (e) {
-    throw new Error(`Can't fetch user for app ${appId}, ${e.message}`);
-  }
-}
 
 // src/commands/release/components/ReleaseBuild.tsx
 var import_jsx_runtime35 = require("react/jsx-runtime");
@@ -4121,7 +4150,7 @@ function validateBuild(build) {
   }
   if (!isRuntimeVerRangeAllowed(build.todesktopRuntimeVersionSpecified)) {
     throw new SmokeError(
-      `The build should have @todesktop/shared@${MIN_RUNTIME_VERSION} installed at least`
+      `This build should have @todesktop/runtime version ${MIN_RUNTIME_VERSION} or later to run smoke tests.`
     );
   }
 }
@@ -4443,6 +4472,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_runtime41.jsx)(
@@ -4530,6 +4560,7 @@ async function cancelSmokeTest({
 async function queueSmokeTest({
   appId,
   buildId,
+  contextUserId,
   nodeVersion,
   userId
 }) {
@@ -4538,7 +4569,8 @@ async function queueSmokeTest({
       appId,
       buildId,
       nodeVersion,
-      userId
+      userId,
+      contextUserId
     });
   } catch (e) {
     if (["failed-precondition", "not-found"].includes(e.code)) {
@@ -4647,14 +4679,20 @@ async function smokeTestWorkflow({
   updateState
 }) {
   try {
-    const { appId, build, nodeVersion, userId } = await getBuildAttributes({
+    const { appId, build, contextUserId, nodeVersion, userId } = await getBuildAttributes({
       buildId,
       configPath
     });
     updateState({ appId, build, userId });
     validateBuild(build);
     if (!abortSignal.aborted && !isTestRunning(build)) {
-      await queueSmokeTest({ appId, buildId, nodeVersion, userId });
+      await queueSmokeTest({
+        appId,
+        buildId,
+        nodeVersion,
+        userId,
+        contextUserId
+      });
     }
     updateState({ state: "progress" });
     const { total } = await waitUntilFinished({
@@ -4666,6 +4704,7 @@ async function smokeTestWorkflow({
     const stateMap = {
       done: "complete",
       progress: "complete",
+      // Not actually used, just for TS
       error: "progress-error",
       canceled: "canceled"
     };
@@ -4746,7 +4785,7 @@ var package_default = {
     access: "public"
   },
   name: "@todesktop/cli",
-  version: "1.7.1",
+  version: "1.7.3",
   license: "MIT",
   author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
   homepage: "https://todesktop.com/cli",