@todesktop/shared 7.190.0 → 7.191.0

package/.prettierignore

@@ -1,3 +1 @@
-.vscode
 lib
-node_modules

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @todesktop/shared
+
+## 7.191.0
+
+### Minor Changes
+
+- a13a5ff: Add `canManageBilling` permission for delegated billing access
+
+## 7.190.0
+
+### Minor Changes
+
+- 302a751: Add support for Apple Silicon only (non-intel) Mac App Store builds

package/README.md

@@ -1,22 +1,39 @@
 ## Stripe Subscriptions
 
-Most of the code for coordinating Stripe subscriptions can be found in `plans.ts`. Conceptually, we organize subscriptions as follows:
+Most of the code for coordinating Stripe subscriptions can be found in
+`plans.ts`. Conceptually, we organize subscriptions as follows:
 
-- A `Price` captures the ID information of a Stripe Price and it's current status:
-  - `inactive` means that the price should no longer be used (but may have been used previously).
+- A `Price` captures the ID information of a Stripe Price and it's current
+  status:
+  - `inactive` means that the price should no longer be used (but may have been
+    used previously).
   - `active` means that the price should be used going forward.
-- A `Product` maps to what is shown in Stripe's [Product Catalogue](https://dashboard.stripe.com/products?active=true) UI. These help use organize the dev and prod versions of a `Product`, as well as their underlying `productId` and `priceIds`.
-- A `Plan` is a collection of `Product`s, organized by their tier (basic, legacy_pro, pro, scale).
-
-Each Plan also specifies the `eligiblePlanTiers` that it accepts for validation purposes. E.g. the basic plan specifies `['basic', 'legacy_pro', 'pro', 'scale']` in its `eligiblePlanTiers` field, meaning that Products belonging within any of those tiers would satisfy validation requirements. Similarly, the basic plan specifies `['scale']` in its tiers field, meaning that only **Products** belonging to the scale **Plans** would satisfy validation.
+- A `Product` maps to what is shown in Stripe's
+  [Product Catalogue](https://dashboard.stripe.com/products?active=true) UI.
+  These help use organize the dev and prod versions of a `Product`, as well as
+  their underlying `productId` and `priceIds`.
+- A `Plan` is a collection of `Product`s, organized by their tier (basic,
+  legacy_pro, pro, scale).
+
+Each Plan also specifies the `eligiblePlanTiers` that it accepts for validation
+purposes. E.g. the basic plan specifies
+`['basic', 'legacy_pro', 'pro', 'scale']` in its `eligiblePlanTiers` field,
+meaning that Products belonging within any of those tiers would satisfy
+validation requirements. Similarly, the basic plan specifies `['scale']` in its
+tiers field, meaning that only **Products** belonging to the scale **Plans**
+would satisfy validation.
 
 ### Adding a new subscription price
 
-Before adding a new price, you'll first need to identify the Stripe [Stripe Product](https://dashboard.stripe.com/products?active=true) that the price should be added to.
+Before adding a new price, you'll first need to identify the Stripe
+[Stripe Product](https://dashboard.stripe.com/products?active=true) that the
+price should be added to.
 
-Once you've added a new price to the product in Stripe's `live` and `test` mode, then you can come back and add it to the relevant product in `plans.ts`.
+Once you've added a new price to the product in Stripe's `live` and `test` mode,
+then you can come back and add it to the relevant product in `plans.ts`.
 
-For example, these are the dev and prod records for the legacy enterprise product:
+For example, these are the dev and prod records for the legacy enterprise
+product:
 
 ```ts
 const legacyEnterpriseDev = createProduct('prod_Hc9PMnHUmHvOlw', {
@@ -28,7 +45,8 @@ const legacyEnterpriseProd = createProduct('prod_GuGGWeMQ3SCuE9', {
 });
 ```
 
-If you added a new Stripe price to this product that is billed yearly for $10,000, then you would add update the products as follows:
+If you added a new Stripe price to this product that is billed yearly for
+$10,000, then you would add update the products as follows:
 
 ```ts
 const legacyEnterpriseDev = createProduct('prod_Hc9PMnHUmHvOlw', {
@@ -44,7 +62,11 @@ const legacyEnterpriseProd = createProduct('prod_GuGGWeMQ3SCuE9', {
 
 ### Rebuilding the Stripe Customer Portals
 
-ToDesktop's subscription flow needs to support both **CLI** and **ToDesktop Builder** customers. To achieve this, we dynamically create/load billing portals based on whether the customer is a **CLI** or **ToDesktop Builder** user, whether the customer needs to **Upgrade** or **Update** their plan, and whether the environment is in prod or dev.
+ToDesktop's subscription flow needs to support both **CLI** and **ToDesktop
+Builder** customers. To achieve this, we dynamically create/load billing portals
+based on whether the customer is a **CLI** or **ToDesktop Builder** user,
+whether the customer needs to **Upgrade** or **Update** their plan, and whether
+the environment is in prod or dev.
 
 This leaves us with 8 unique customer portal configurations:
 
@@ -57,9 +79,11 @@ This leaves us with 8 unique customer portal configurations:
 - _builderUpgradeConfigurationDev_
 - _builderUpgradeConfigurationProd_
 
-Each configuration specifies the products and prices (with an `active` status) that should be displayed when a user navigates to the customer billing portal.
+Each configuration specifies the products and prices (with an `active` status)
+that should be displayed when a user navigates to the customer billing portal.
 
-The web app and desktop app then only need to specify the `PortalConfigKey` when creating a checkout session from the client:
+The web app and desktop app then only need to specify the `PortalConfigKey` when
+creating a checkout session from the client:
 
 ```ts
 // begin a CLI upgrade customer portal session
@@ -72,4 +96,7 @@ await createCustomerPortalSession({
 });
 ```
 
-If you have updated the products that are used by any of the portal configurations, then you'll also need to increase the `PORTAL_VERSION` constant by 1. This will ensure that the portals are rebuilt to use the latest products and prices. This happens in `createCustomerPortalSession` in the web app.
+If you have updated the products that are used by any of the portal
+configurations, then you'll also need to increase the `PORTAL_VERSION` constant
+by 1. This will ensure that the portals are rebuilt to use the latest products
+and prices. This happens in `createCustomerPortalSession` in the web app.

package/eslint.config.mjs

@@ -1,57 +1,10 @@
-import typescriptEslint from '@typescript-eslint/eslint-plugin';
-import prettier from 'eslint-plugin-prettier';
-import globals from 'globals';
-import tsParser from '@typescript-eslint/parser';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import js from '@eslint/js';
-import { FlatCompat } from '@eslint/eslintrc';
+import { configs, defineConfig } from '@todesktop/dev-config/eslint';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  recommendedConfig: js.configs.recommended,
-  allConfig: js.configs.all,
-});
+export default defineConfig(
+  configs.base,
+  configs.strict,
+  configs.ts,
+  configs.prettier,
 
-export default [
-  ...compat.extends(
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier'
-  ),
-  {
-    plugins: {
-      '@typescript-eslint': typescriptEslint,
-      prettier,
-    },
-
-    languageOptions: {
-      globals: {
-        ...globals.node,
-      },
-
-      parser: tsParser,
-      ecmaVersion: 2020,
-      sourceType: 'module',
-
-      parserOptions: {
-        project: './tsconfig.json',
-      },
-    },
-
-    rules: {
-      'prettier/prettier': 'error',
-
-      '@typescript-eslint/no-misused-promises': [
-        'error',
-        {
-          checksVoidReturn: false,
-        },
-      ],
-
-      '@typescript-eslint/no-explicit-any': 'warn',
-    },
-  },
-];
+  { ignores: ['lib'] },
+);

package/lib/base.d.ts

@@ -7,31 +7,31 @@ type CompositeIdFileLocationKey = string;
 export type StaticAnalysisItem = {
     hidden: boolean;
 };
-export type ProgressTypes = 'queued' | 'progress' | 'done' | 'error';
+export type ProgressTypes = 'done' | 'error' | 'progress' | 'queued';
 export interface IChecklistItem {
     [id: string]: boolean;
 }
 export interface IDownloadButtonOptions {
-    buttonSize: 'small' | 'medium' | 'large';
-    fontFamily: 'serif' | 'sans-serif';
     bgColor: string;
-    fgColor: string;
     borderRadius: number;
+    btnText: string;
+    buttonSize: 'large' | 'medium' | 'small';
+    fgColor: string;
+    fontFamily: 'sans-serif' | 'serif';
     showAppIcon: {
+        alignment: 'left' | 'right';
         enabled: boolean;
-        alignment: 'right' | 'left';
     };
     showDownloadIcon: {
+        alignment: 'left' | 'right';
         enabled: boolean;
-        alignment: 'right' | 'left';
     };
-    btnText: string;
 }
 export declare enum WindowsEVOnboardingSteps {
-    'hasChosenProvider' = "hasChosenProvider",
-    'hasOrderedCert' = "hasOrderedCert",
     'hasBeenVerified' = "hasBeenVerified",
+    'hasChosenProvider' = "hasChosenProvider",
     'hasGeneratedCert' = "hasGeneratedCert",
+    'hasOrderedCert' = "hasOrderedCert",
     'hasUploadedCert' = "hasUploadedCert"
 }
 export declare enum WindowsEVOnboardingProvider {
@@ -42,8 +42,8 @@ export interface IAppBuildProgress {
     isBuilding: boolean;
     message: string;
     percent: number;
-    type: ProgressTypes;
     shouldSkip: boolean;
+    type: ProgressTypes;
 }
 export interface IAppMeta {
     appIterations?: number;
@@ -53,79 +53,83 @@ export interface IAppMeta {
     currentBuildProgress?: {
         channel?: string;
         id?: string;
-        releaseId?: Release['id'];
         linux?: IAppBuildProgress;
         mac?: IAppBuildProgress;
         projectConfig?: ToDesktopJson;
+        releaseId?: Release['id'];
         shouldCodeSign?: boolean;
         shouldRelease?: boolean;
         shouldSendCompletionEmail?: boolean;
         sourceArchiveDetails?: {
             bucket: string;
+            hash?: string;
             key: string;
             url: string;
-            hash?: string;
         };
         windows?: IAppBuildProgress;
     };
     downloadButtons?: {
-        universal: IDownloadButtonOptions;
+        linux: IDownloadButtonOptions;
         mac: IDownloadButtonOptions;
+        universal: IDownloadButtonOptions;
         windows: IDownloadButtonOptions;
-        linux: IDownloadButtonOptions;
     };
     firstSuccessfulBuildEndedAt?: string;
-    staticAnalysis?: Record<CompositeIdFileLocationKey, StaticAnalysisItem>;
+    forceVersionNumber?: string;
     isAppChanged?: boolean;
     isFrameBlocked?: boolean;
     isHttps?: boolean;
     latestReleaseBuildId?: string;
+    previousInstallLockSha?: string;
     publishedVersions: {
         desktopify?: string;
         electron?: string;
         version?: string;
     };
-    previousInstallLockSha?: string;
     releaseRedirections?: ReleaseRedirectionRule[];
+    staticAnalysis?: Record<CompositeIdFileLocationKey, StaticAnalysisItem>;
+    webhookHMACKey?: string;
+    webhooks?: {
+        release?: string;
+    };
     windowsEVOnboarding?: {
-        provider: WindowsEVOnboardingProvider;
-        tempHSMCertName: string;
-        [WindowsEVOnboardingSteps.hasChosenProvider]: boolean;
-        [WindowsEVOnboardingSteps.hasOrderedCert]: boolean;
         [WindowsEVOnboardingSteps.hasBeenVerified]: boolean;
+        [WindowsEVOnboardingSteps.hasChosenProvider]: boolean;
         [WindowsEVOnboardingSteps.hasGeneratedCert]: boolean;
+        [WindowsEVOnboardingSteps.hasOrderedCert]: boolean;
         [WindowsEVOnboardingSteps.hasUploadedCert]: boolean;
+        provider: WindowsEVOnboardingProvider;
+        tempHSMCertName: string;
     };
-    forceVersionNumber?: string;
-    webhooks?: {
-        release?: string;
-    };
-    webhookHMACKey?: string;
 }
 export interface ToDesktopJson {
     appBuilderLibVersion?: string;
-    appId?: string;
     appFiles?: string[];
+    appId?: string;
     appPath?: FilePath;
     appProtocolScheme?: string | string[];
     asar?: boolean;
     asarUnpack?: boolean | string[];
     bucket?: string;
     buildVersion?: string;
+    bytenode?: {
+        enabled?: boolean;
+        files?: string[];
+    };
     copyright?: string;
     dmg?: {
-        background?: FilePath;
         artifactName?: string;
+        background?: FilePath;
         backgroundColor?: string;
+        contents?: NonNullable<IAppBuilderLib['config']['dmg']>['contents'];
         iconSize?: number;
         iconTextSize?: number;
         title?: string;
-        contents?: IAppBuilderLib['config']['dmg']['contents'];
-        window?: IAppBuilderLib['config']['dmg']['window'];
+        window?: NonNullable<IAppBuilderLib['config']['dmg']>['window'];
     };
-    extraContentFiles?: ExtraFileReference[];
     electronMirror?: string;
     electronVersion?: string;
+    extraContentFiles?: ExtraFileReference[];
     extraResources?: ExtraFileReference[];
     fileAssociations?: IAppBuilderLib['config']['fileAssociations'];
     filesForDistribution?: string[];
@@ -144,24 +148,24 @@ export interface ToDesktopJson {
         dmgBackground?: FilePath;
         entitlements?: FilePath;
         entitlementsInherit?: FilePath;
-        provisioningProfile?: FilePath;
-        extendInfo?: IAppBuilderLib['config']['mac']['extendInfo'];
+        extendInfo?: NonNullable<IAppBuilderLib['config']['mac']>['extendInfo'];
         icon?: FilePath;
+        provisioningProfile?: FilePath;
         requirements?: FilePath;
     };
     mas?: {
-        type?: 'development' | 'distribution';
         entitlements?: FilePath;
         entitlementsInherit?: FilePath;
         provisioningProfile?: FilePath;
+        type?: 'development' | 'distribution';
         x64ArchFiles?: string;
     };
     nodeVersion?: string;
     npmVersion?: string;
-    packageManager?: 'npm' | 'yarn' | 'pnpm';
+    packageManager?: 'npm' | 'pnpm' | 'yarn';
     pnpmVersion?: string;
     productName?: string;
-    rebuildLibrary?: 'app-builder' | '@electron/rebuild';
+    rebuildLibrary?: '@electron/rebuild' | 'app-builder';
     schemaVersion: number;
     snap?: IAppBuilderLib['config']['snap'];
     updateUrlBase?: string;
@@ -181,43 +185,43 @@ export interface ToDesktopJson {
     yarnVersion?: string;
 }
 export declare enum WindowsHSMCertType {
+    azureTrustedSigning = "azureTrustedSigning",
     ev = "ev",
-    file = "file",
-    azureTrustedSigning = "azureTrustedSigning"
+    file = "file"
 }
 export interface CustomWindowsCodeSignFile {
     certType: string;
-    hsmCertType: WindowsHSMCertType.file;
     hsmCertName: string;
+    hsmCertType: WindowsHSMCertType.file;
 }
 export interface CustomWindowsCodeSignEV {
     certType: 'hsm';
-    hsmCertType: WindowsHSMCertType.ev;
     hsmCertName: string;
+    hsmCertType: WindowsHSMCertType.ev;
 }
 export interface CustomWindowsCodeSignAzureTrustedSigning {
-    certType: 'azureTrustedSigning';
-    azureCredentialsStored: boolean;
     azureBaseSettings: {
         $azureClientSecretRef: string;
         clientId: string;
-        tenantId: string;
         codeSigningAccountName: string;
-        subscriptionId: string;
         resourceGroupName: string;
+        subscriptionId: string;
+        tenantId: string;
     };
+    azureCredentialsStored: boolean;
     azureSettings?: {
         accountUri: string;
         certificateProfileId: string;
         certificateProfileName: string;
         publisherName: string;
     };
+    certType: 'azureTrustedSigning';
 }
 export type CustomMacCodeSign = {
-    type: 'url';
     certName: string;
     certPassword: string;
     certUrl: string;
+    type: 'url';
 } | {
     type: 'hsm';
 };
@@ -227,31 +231,24 @@ export type CustomLinuxPGPKey = {
 };
 export type CustomMacNotarization = CustomNotarizationApiKeyAuth | CustomNotarizationPasswordHsmAuth;
 export interface CustomNotarizationApiKeyAuth {
-    type: 'hsm-api';
-    appleApiKeyId: string;
-    appleApiIssuer: string;
     $appleApiKey: string;
+    appleApiIssuer: string;
+    appleApiKeyId: string;
+    type: 'hsm-api';
 }
 export interface CustomNotarizationPasswordHsmAuth {
-    type: 'hsm';
+    $appSpecificPassword: string;
     appleId: string;
     teamId: string;
-    $appSpecificPassword: string;
+    type: 'hsm';
 }
 export type ReleaseRedirectionRule = {
-    appId: string;
-    rule: 'app';
-} | {
-    feedUrl: string;
-    rule: 'app';
-} | {
     appId: string;
     ipList: string[];
     rule: 'appByIp';
 } | {
-    feedUrl: string;
-    ipList: string[];
-    rule: 'appByIp';
+    appId: string;
+    rule: 'app';
 } | {
     buildId: string;
     ipList: string[];
@@ -260,25 +257,38 @@ export type ReleaseRedirectionRule = {
     buildId: string;
     platforms: PlatformName[];
     rule: 'buildByPlatform';
+} | {
+    feedUrl: string;
+    ipList: string[];
+    rule: 'appByIp';
+} | {
+    feedUrl: string;
+    rule: 'app';
 };
 export interface BaseApp extends Schemable {
-    id: string;
     appModelId?: string;
+    appxConfig?: Partial<IAppBuilderLib['config']['appx']>;
     customDomain?: string;
-    domainVerificationCode?: string;
+    customLinuxPgpKey?: CustomLinuxPGPKey;
     customMacCodeSign?: CustomMacCodeSign;
     customNotarization?: CustomMacNotarization;
-    customLinuxPgpKey?: CustomLinuxPGPKey;
-    customWindowsCodeSign?: CustomWindowsCodeSignFile | CustomWindowsCodeSignEV | CustomWindowsCodeSignAzureTrustedSigning;
+    customWindowsCodeSign?: CustomWindowsCodeSignAzureTrustedSigning | CustomWindowsCodeSignEV | CustomWindowsCodeSignFile;
+    domainVerificationCode?: string;
+    id: string;
     macHsmCertNames?: Record<MacTarget, string>;
-    windowsHsmCertNames?: Record<WindowsTarget, string>;
+    macUniversalInstallerConfig?: {
+        shouldPinToVersion?: boolean;
+    };
+    masConfig?: {
+        arch?: 'arm64' | 'universal';
+    } & Partial<IAppBuilderLib['config']['mas']>;
     meta?: IAppMeta;
-    parentApp?: BaseApp;
+    nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
     parent?: {
         id: string;
         relationshipToParent: string;
     } | null;
-    subscription?: Subscription;
+    parentApp?: BaseApp;
     shouldCreate32BitWindowsArtifacts?: boolean;
     shouldCreateAppImages?: boolean;
     shouldCreateAppleIntelArtifacts?: boolean;
@@ -297,23 +307,19 @@ export interface BaseApp extends Schemable {
     shouldCreateNSISWebInstaller?: boolean;
     shouldCreateRPMPackages?: boolean;
     shouldCreateSnapFiles?: boolean;
-    appxConfig?: Partial<IAppBuilderLib['config']['appx']>;
-    masConfig?: Partial<IAppBuilderLib['config']['mas']>;
-    nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
     snapStore?: {
-        login?: string;
         description?: string;
+        login?: string;
     };
-    macUniversalInstallerConfig?: {
-        shouldPinToVersion?: boolean;
-    };
+    subscription?: Subscription;
+    windowsHsmCertNames?: Record<WindowsTarget, string>;
 }
 export type Subscription = {
-    status: string;
-    subscriptionId: string;
     itemId: string;
     planId: string;
-    productId?: string;
     priceId?: string;
+    productId?: string;
+    status: string;
+    subscriptionId: string;
 };
 export {};

package/lib/base.js

@@ -1,22 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WindowsHSMCertType = exports.WindowsEVOnboardingProvider = exports.WindowsEVOnboardingSteps = void 0;
-var WindowsEVOnboardingSteps;
+export var WindowsEVOnboardingSteps;
 (function (WindowsEVOnboardingSteps) {
-    WindowsEVOnboardingSteps["hasChosenProvider"] = "hasChosenProvider";
-    WindowsEVOnboardingSteps["hasOrderedCert"] = "hasOrderedCert";
     WindowsEVOnboardingSteps["hasBeenVerified"] = "hasBeenVerified";
+    WindowsEVOnboardingSteps["hasChosenProvider"] = "hasChosenProvider";
     WindowsEVOnboardingSteps["hasGeneratedCert"] = "hasGeneratedCert";
+    WindowsEVOnboardingSteps["hasOrderedCert"] = "hasOrderedCert";
     WindowsEVOnboardingSteps["hasUploadedCert"] = "hasUploadedCert";
-})(WindowsEVOnboardingSteps || (exports.WindowsEVOnboardingSteps = WindowsEVOnboardingSteps = {}));
-var WindowsEVOnboardingProvider;
+})(WindowsEVOnboardingSteps || (WindowsEVOnboardingSteps = {}));
+export var WindowsEVOnboardingProvider;
 (function (WindowsEVOnboardingProvider) {
     WindowsEVOnboardingProvider["globalsign"] = "globalsign";
     WindowsEVOnboardingProvider["other"] = "other";
-})(WindowsEVOnboardingProvider || (exports.WindowsEVOnboardingProvider = WindowsEVOnboardingProvider = {}));
-var WindowsHSMCertType;
+})(WindowsEVOnboardingProvider || (WindowsEVOnboardingProvider = {}));
+export var WindowsHSMCertType;
 (function (WindowsHSMCertType) {
+    WindowsHSMCertType["azureTrustedSigning"] = "azureTrustedSigning";
     WindowsHSMCertType["ev"] = "ev";
     WindowsHSMCertType["file"] = "file";
-    WindowsHSMCertType["azureTrustedSigning"] = "azureTrustedSigning";
-})(WindowsHSMCertType || (exports.WindowsHSMCertType = WindowsHSMCertType = {}));
+})(WindowsHSMCertType || (WindowsHSMCertType = {}));