@todesktop/cli 1.14.0 → 1.15.1

package/README.md

@@ -10,7 +10,7 @@ For more information, visit the project [landing page](https://www.todesktop.com
 - [Get started](#get-started)
 - [CLI commands](#cli-commands)
 - [Automating your builds (CI)](#automating-your-builds-ci)
-- [Project configuration (todesktop.json or todesktop.js)](#project-configuration-todesktopjson-or-todesktopjs)
+- [Project configuration (todesktop.json, todesktop.js, or todesktop.ts)](#project-configuration-todesktopjson-todesktopjs-or-todesktops)
 - [Build lifecycle hooks (package.json scripts)](#build-lifecycle-hooks-packagejson-scripts)
 - [App package.json requirements](#app-packagejson-requirements)
 - [FAQs](#faqs)
@@ -42,7 +42,7 @@ Create a `todesktop.json` file in the root of your Electron project.
 
 ```json
 {
-  "$schema": "https://unpkg.com/@todesktop/cli@1.13.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",
@@ -62,7 +62,26 @@ module.exports = {
 };
 ```
 
-See [Project configuration](#project-configuration-todesktopjson-or-todesktopjs) for the full list of configuration options.
+You can also create a `todesktop.ts` file for TypeScript projects with full type checking and IntelliSense:
+
+```typescript
+import type { Schema } from "@todesktop/cli";
+import path from "path";
+
+const config: Schema = {
+  id: process.env.TODESKTOP_APP_ID || "your-default-todesktop-id",
+  icon: path.join(__dirname, "assets", "desktop-icon.png"),
+  schemaVersion: 1,
+  nodeVersion: "18.12.1",
+  mac: {
+    category: "public.app-category.productivity",
+  },
+};
+
+export default config;
+```
+
+See [Project configuration](#project-configuration-todesktopjson-todesktopjs-or-todesktops) for the full list of configuration options.
 
 ### Step 3: Add @todesktop/runtime as a dependency
 
@@ -220,17 +239,27 @@ The webhook receives a POST request with the following JSON body:
 }
 ```
 
-## Project configuration (todesktop.json or todesktop.js)
+## Project configuration (todesktop.json, todesktop.js, or todesktop.ts)
+
+This describes all of the possible configuration options in your `todesktop.json`, `todesktop.js`, or `todesktop.ts` file.
+
+You can use:
+
+- A standard JSON file (`todesktop.json`) for static configuration
+- A JavaScript file (`todesktop.js`) that exports a configuration object for dynamic configuration
+- A TypeScript file (`todesktop.ts`) that exports a configuration object with full type checking and IntelliSense
 
-This describes all of the possible configuration options in your `todesktop.json` or `todesktop.js` file.
+Using `.js` or `.ts` files allows for dynamic configuration, such as setting values based on environment variables or computing paths.
 
-You can use a standard JSON file (`todesktop.json`) for static configuration, or a JavaScript file (`todesktop.js`) that exports a configuration object. Using a `.js` file allows for dynamic configuration, such as setting values based on environment variables or computing paths.
+**Note:**
 
-**Note:** Schema validation and IntelliSense (described under [Installation](#installation)) currently only work for `.json` files.
+- Schema validation and IntelliSense for `.json` files are available through the JSON schema (described under [Installation](#installation))
+- TypeScript files (`.ts`) provide full type checking and IntelliSense when using the exported `Schema` type from `@todesktop/cli`
+- TypeScript compilation requires a local installation of TypeScript in your project
 
 To avoid confusion, the following terms will be used throughout this file:
 
-- "Project root": this is the parent directory of your `todesktop.json` or `todesktop.js`.
+- "Project root": this is the parent directory of your `todesktop.json`, `todesktop.js`, or `todesktop.ts`.
 
 ### `$schema` - (optional) string
 
@@ -243,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.13.0/schemas/schema.json",
+    "$schema": "https://unpkg.com/@todesktop/cli@1.15.0/schemas/schema.json",
     "id": "your-todesktop-id"
   }
   ```
@@ -1305,6 +1334,16 @@ 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.
+- Export `Schema` type from `@todesktop/cli` for TypeScript configuration files.
+- TypeScript compilation uses user's local TypeScript installation (no production dependencies added).
+
 ### v1.14.0
 
 - Add support for `todesktop.js` configuration file for dynamic configurations.

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,9 +351,11 @@ var useExit_default = () => {
     logger_default.debug({ error }, "Exit called");
     let timeoutId;
     Promise.race([
-      new Promise((resolve4) => flush(() => resolve4())),
+      // 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(
-        (resolve4) => timeoutId = setTimeout(() => resolve4(), 1e3)
+        (resolve5) => timeoutId = setTimeout(() => resolve5(), 1e3)
       )
     ]).catch(() => {
     }).finally(() => {
@@ -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;
@@ -1025,10 +1036,101 @@ async function postToFirebaseFunction_default(functionName, body = {}, config2 =
 // src/utilities/projectConfig/getProjectConfig.ts
 var import_find_up = __toESM(require("find-up"));
 var import_fs = require("fs");
+var import_path5 = require("path");
+
+// src/utilities/projectConfig/loadConfig.ts
 var import_path3 = require("path");
 
+// src/utilities/projectConfig/loadTypeScriptConfig.ts
+var import_path2 = require("path");
+function loadTypeScriptConfig(configPath) {
+  const projectRoot = process.cwd();
+  try {
+    logger_default.debug(`Attempting to load TypeScript config from: ${configPath}`);
+    let typescript;
+    try {
+      const tsPath = (0, import_path2.resolve)(projectRoot, "node_modules", "typescript");
+      typescript = require(tsPath);
+      logger_default.debug(`Found TypeScript in user's project at: ${tsPath}`);
+    } catch (error) {
+      try {
+        typescript = require("typescript");
+        logger_default.debug("Using globally available TypeScript installation");
+      } catch (globalError) {
+        throw new Error(
+          `TypeScript is required to load .ts configuration files but was not found. Please install TypeScript in your project: npm install --save-dev typescript`
+        );
+      }
+    }
+    const fs6 = require("fs");
+    const sourceCode = fs6.readFileSync(configPath, "utf8");
+    const result = typescript.transpile(sourceCode, {
+      target: typescript.ScriptTarget.ES2018,
+      module: typescript.ModuleKind.CommonJS,
+      moduleResolution: typescript.ModuleResolutionKind.NodeJs,
+      esModuleInterop: true,
+      allowSyntheticDefaultImports: true,
+      resolveJsonModule: true,
+      declaration: false,
+      sourceMap: false
+    });
+    const module2 = { exports: {} };
+    const moduleWrapper = new Function(
+      "module",
+      "exports",
+      "require",
+      "__filename",
+      "__dirname",
+      result
+    );
+    moduleWrapper(
+      module2,
+      module2.exports,
+      (id) => {
+        if (id.startsWith(".")) {
+          return require((0, import_path2.resolve)(configPath, "..", id));
+        }
+        return require(id);
+      },
+      configPath,
+      (0, import_path2.resolve)(configPath, "..")
+    );
+    const config2 = module2.exports.default || module2.exports;
+    if (!config2 || typeof config2 !== "object") {
+      throw new Error(
+        `TypeScript configuration file must export a configuration object. Received: ${typeof config2}`
+      );
+    }
+    logger_default.debug("Successfully loaded and compiled TypeScript configuration");
+    return config2;
+  } catch (error) {
+    logger_default.error(
+      `Failed to load TypeScript configuration from ${configPath}:`,
+      error
+    );
+    if (error instanceof Error) {
+      if (error.message.includes("Cannot find module")) {
+        throw new Error(
+          `Failed to load TypeScript configuration: ${error.message}. Make sure all imported modules are installed.`
+        );
+      } else if (error.message.includes("TypeScript is required")) {
+        throw error;
+      } else {
+        throw new Error(
+          `Failed to compile TypeScript configuration: ${error.message}. Please check your todesktop.ts file for syntax errors.`
+        );
+      }
+    }
+    throw error;
+  }
+}
+
 // src/utilities/projectConfig/loadConfig.ts
 function loadConfig(configPath) {
+  const extension = (0, import_path3.extname)(configPath);
+  if (extension === ".ts") {
+    return loadTypeScriptConfig(configPath);
+  }
   return require(configPath);
 }
 
@@ -1154,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"]
@@ -2469,14 +2572,14 @@ ${output}`
 
 // src/utilities/projectConfig/computeFullProjectConfig.ts
 var import_lodash2 = __toESM(require("lodash.merge"));
-var import_path2 = require("path");
+var import_path4 = require("path");
 function computeFullProjectConfig(partialConfig, projectRoot, flags) {
   if (!partialConfig.extends) {
     logger_default.debug("No extends field, returning partial config");
     return partialConfig;
   } else {
     logger_default.debug("Extends field found, resolving");
-    const parentConfigPath = (0, import_path2.resolve)(projectRoot, partialConfig.extends);
+    const parentConfigPath = (0, import_path4.resolve)(projectRoot, partialConfig.extends);
     const parentConfig = loadConfig(parentConfigPath);
     parentConfig.appPath = parentConfig.appPath || ".";
     const parentFullConfig = computeFullProjectConfig(
@@ -2510,20 +2613,24 @@ You can disable this error by running todesktop build with the --ignore-extends-
 function getProjectConfig(configPath, flags) {
   if (!configPath) {
     logger_default.debug("No config path provided, searching for one");
-    configPath = import_find_up.default.sync(["todesktop.json", "todesktop.js"]);
+    configPath = import_find_up.default.sync([
+      "todesktop.json",
+      "todesktop.js",
+      "todesktop.ts"
+    ]);
     if (!configPath) {
       throw new Error(
-        "Can not find todesktop.json or todesktop.js in this folder or any parent folders"
+        "Can not find todesktop.json, todesktop.js, or todesktop.ts in this folder or any parent folders"
       );
     }
   } else {
-    configPath = (0, import_path3.resolve)(process.cwd(), configPath);
+    configPath = (0, import_path5.resolve)(process.cwd(), configPath);
     if (!(0, import_fs.existsSync)(configPath)) {
       logger_default.error("Provided config path does not exist");
       throw new Error(`Config file not found at ${configPath}`);
     }
   }
-  const projectRoot = (0, import_path3.dirname)(configPath);
+  const projectRoot = (0, import_path5.dirname)(configPath);
   const partialConfig = loadConfig(configPath);
   const config2 = computeFullProjectConfig(partialConfig, projectRoot, flags);
   validateConfig({ config: config2, projectRoot });
@@ -2544,7 +2651,7 @@ var shouldExitOnBuildFailure_default = (build) => {
 
 // src/commands/build/utilities/getPackageJson.ts
 var import_lodash3 = __toESM(require("lodash.merge"));
-var import_path4 = __toESM(require("path"));
+var import_path6 = __toESM(require("path"));
 function deleteNullDeps(dep) {
   Object.keys(dep).forEach((key) => {
     if (dep[key] === null) {
@@ -2566,7 +2673,7 @@ function removeNullDependencies(pkgJson) {
 function getAppPkgJson({ config: config2 }) {
   const packageJsonFromConfig = config2.packageJson || {};
   const extendsFrom = packageJsonFromConfig.extends || "package.json";
-  const packageJsonFromFile = readJson(import_path4.default.join(config2.appPath, extendsFrom));
+  const packageJsonFromFile = readJson(import_path6.default.join(config2.appPath, extendsFrom));
   return removeNullDependencies(
     (0, import_lodash3.default)({}, packageJsonFromFile, packageJsonFromConfig)
   );
@@ -2606,10 +2713,10 @@ function spyBuild() {
     if (latestBuildDoc && predicate(latestBuildDoc)) {
       return Promise.resolve(latestBuildDoc);
     }
-    return new Promise((resolve4, reject) => {
+    return new Promise((resolve5, reject) => {
       emitter.on("update", ({ build }) => {
         if (predicate(build)) {
-          resolve4(build);
+          resolve5(build);
         }
       }).once("error", (e) => reject(e));
     });
@@ -2645,8 +2752,8 @@ function spyBuild() {
       if (latestBuildDoc) {
         return Promise.resolve(latestBuildDoc);
       }
-      return new Promise((resolve4, reject) => {
-        emitter.once("update", (data) => resolve4(data)).once("error", (e) => reject(e));
+      return new Promise((resolve5, reject) => {
+        emitter.once("update", (data) => resolve5(data)).once("error", (e) => reject(e));
       });
     },
     async whenSettled() {
@@ -2677,7 +2784,7 @@ var import_stream_to_array = __toESM(require("stream-to-array"));
 var { TODESKTOP_CLI_S3_BUCKET } = getEnvironmentVariables_default();
 var MAX_RETRIES = 3;
 var RETRY_DELAY = 2e3;
-var delay = (ms) => new Promise((resolve4) => setTimeout(resolve4, ms));
+var delay = (ms) => new Promise((resolve5) => setTimeout(resolve5, ms));
 var uploadToS3WithRetry = async (input, retries = MAX_RETRIES) => {
   try {
     return await uploadToS3(input);
@@ -2711,14 +2818,14 @@ var uploadToS3 = async ({
     (part) => Buffer.isBuffer(part) ? part : Buffer.from(part)
   );
   const body = Buffer.concat(buffers);
-  return new Promise((resolve4, reject) => {
+  return new Promise((resolve5, reject) => {
     import_superagent.default.put(data.signedURL).send(body).set("content-type", "application/zip").on("progress", onProgress).end((err) => {
       logger_default.debug({ bucket, key, url: data.uploadURL }, "uploadToS3");
       if (err) {
         logger_default.error({ err }, "uploadToS3");
         return reject(err);
       }
-      return resolve4({ bucket, key, url: data.uploadURL });
+      return resolve5({ bucket, key, url: data.uploadURL });
     });
   });
 };
@@ -2729,7 +2836,7 @@ var import_archiver = __toESM(require("archiver"));
 var import_du = __toESM(require("du"));
 var import_fs2 = __toESM(require("fs"));
 var import_chalk = __toESM(require("chalk"));
-var import_path5 = __toESM(require("path"));
+var import_path7 = __toESM(require("path"));
 async function zip_default({
   files,
   fileSizeLimit = 20,
@@ -2784,7 +2891,7 @@ Your app is larger than ${fileSizeLimit}MB. Your app is ${import_chalk.default.b
   processedFiles.forEach(({ from, isDirectory, stats, to }) => {
     if (isDirectory) {
       stream.directory(from, to);
-    } else if (appPkgJson && to === import_path5.default.join("app", "package.json")) {
+    } else if (appPkgJson && to === import_path7.default.join("app", "package.json")) {
       stream.append(JSON.stringify(appPkgJson), {
         name: to
       });
@@ -2904,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))
@@ -3583,7 +3707,7 @@ async function getLatestBuildId({
 // src/utilities/subscribeToFirebaseDoc.ts
 var import_firestore10 = require("firebase/firestore");
 async function subscribeToFirebaseDoc(key, receiver) {
-  return new Promise((resolve4, reject) => {
+  return new Promise((resolve5, reject) => {
     logger_default.debug({ key }, "subscribeToFirebaseDoc");
     const unsubscribe = (0, import_firestore10.onSnapshot)(
       (0, import_firestore10.doc)(firestore_default, key),
@@ -3592,7 +3716,7 @@ async function subscribeToFirebaseDoc(key, receiver) {
           snapshot,
           data: snapshot.exists() ? snapshot.data() : void 0
         });
-        resolve4(unsubscribe);
+        resolve5(unsubscribe);
       },
       (err) => {
         reject(err);
@@ -4570,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
   }) => {
@@ -5567,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)(
@@ -5689,7 +5816,7 @@ async function waitUntilFinished({
   userId
 }) {
   const docPath = `users/${userId}/applications/${appId}/builds/${buildId}`;
-  return new Promise((resolve4, reject) => {
+  return new Promise((resolve5, reject) => {
     const unsubscribe = (0, import_firestore27.onSnapshot)(
       (0, import_firestore27.doc)(firestore_default, docPath),
       (snapshot) => {
@@ -5698,7 +5825,7 @@ async function waitUntilFinished({
         onProgress(progress);
         if (progress.isFinished) {
           unsubscribe();
-          resolve4(progress);
+          resolve5(progress);
         }
       },
       (err) => {
@@ -5817,6 +5944,7 @@ async function smokeTestWorkflow({
     const stateMap = {
       done: "complete",
       progress: "complete",
+      // Not actually used, just for TS
       error: "progress-error",
       canceled: "canceled"
     };
@@ -5897,7 +6025,7 @@ var package_default = {
     access: "public"
   },
   name: "@todesktop/cli",
-  version: "1.13.0",
+  version: "1.15.0",
   license: "MIT",
   author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
   homepage: "https://todesktop.com/cli",
@@ -5907,6 +6035,7 @@ var package_default = {
   bin: {
     todesktop: "./dist/cli.js"
   },
+  types: "./dist/types.d.ts",
   engines: {
     node: ">=16"
   },
@@ -5914,14 +6043,15 @@ var package_default = {
     dev: "cp-cli dev.env .env && npm run build:dev && npm link",
     "dev:prod": "cp-cli prod.env .env && npm run build && npm link",
     "dev:local:prod": "cp-cli prod-local.env .env && npm run build && npm link && cp-cli prod-local.env .env",
-    build: "esbuild src/index.ts --packages=external --bundle --sourcemap --platform=node --outfile=dist/cli.js && cp-cli prod.env .env",
-    "build:dev": "esbuild src/index.ts --packages=external --bundle --sourcemap --platform=node --outfile=dist/cli.js && cp-cli dev.env .env",
+    build: "npm run types:generate && esbuild src/index.ts --packages=external --bundle --sourcemap --platform=node --outfile=dist/cli.js && cp-cli prod.env .env",
+    "build:dev": "npm run types:generate && esbuild src/index.ts --packages=external --bundle --sourcemap --platform=node --outfile=dist/cli.js && cp-cli dev.env .env",
     lint: "npm run lint:types && npm run lint:styles",
     "lint:styles": "eslint src test .eslintrc.js && prettier --check .",
     format: "prettier --write .",
     "lint:types": "tsc && tsc-strict",
     "lint--fix": "eslint src test --fix",
     "docs:generate": "node scripts/generate-readme.js",
+    "types:generate": "node scripts/generate-types.js",
     release: "npm run docs:generate && npm run build && npx np --tag=latest",
     "release-beta": "npm run docs:generate && npm run build && npx np --any-branch --no-tests --tag=beta",
     test: "ava",
@@ -6005,6 +6135,7 @@ var package_default = {
     "fs-extra": "^9.0.1",
     husky: "^4.3.0",
     "ink-testing-library": "^2.1.0",
+    "json-schema-to-typescript": "^15.0.4",
     "lint-staged": "^10.2.11",
     "package-json-type": "^1.0.3",
     prettier: "^2.8.1",