@todesktop/shared 7.188.18 → 7.188.19-beta.1

package/lib/desktopify2.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { ISwitchableValue } from './toDesktop';
 import { MenuItemConstructorOptions, BrowserWindowConstructorOptions, WebPreferences, NotificationConstructorOptions, MessageBoxOptions } from '@todesktop/client-electron-types';
 import { BaseApp } from './base';
@@ -27,11 +26,11 @@ export interface FileAssetDetails extends BaseAssetDetails {
     md5Hash: string;
     type: 'file';
 }
-export declare type AssetDetails = AppIconAssetDetails | MenuIconAssetDetails | TrayMenubarIconAssetDetails | FileAssetDetails;
+export type AssetDetails = AppIconAssetDetails | MenuIconAssetDetails | TrayMenubarIconAssetDetails | FileAssetDetails;
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
  */
-declare type todesktopRoles = 'todesktop:launch-at-startup' | 'todesktop:check-for-updates' | 'todesktop:quit' | 'todesktop:quit-completely' | 'todesktop:new-window' | 'todesktop:new-tab' | 'todesktop:check-for-updates' | 'todesktop:history-home' | 'todesktop:history-back' | 'todesktop:history-forward' | 'todesktop:show-window' | 'todesktop:hide-window' | 'todesktop:toggle-window' | 'todesktop:toggle-window0' | 'todesktop:toggle-window1' | 'todesktop:toggle-window2' | 'todesktop:toggle-window3' | 'todesktop:toggle-window4';
+type todesktopRoles = 'todesktop:launch-at-startup' | 'todesktop:check-for-updates' | 'todesktop:quit' | 'todesktop:quit-completely' | 'todesktop:new-window' | 'todesktop:new-tab' | 'todesktop:check-for-updates' | 'todesktop:history-home' | 'todesktop:history-back' | 'todesktop:history-forward' | 'todesktop:show-window' | 'todesktop:hide-window' | 'todesktop:toggle-window' | 'todesktop:toggle-window0' | 'todesktop:toggle-window1' | 'todesktop:toggle-window2' | 'todesktop:toggle-window3' | 'todesktop:toggle-window4';
 export interface DesktopifyMenuItemConstructorOptions extends Omit<MenuItemConstructorOptions, 'role' | 'submenu'> {
     platforms?: NodeJS.Platform[];
     submenu?: DesktopifyMenuItemConstructorOptions[];
@@ -51,7 +50,7 @@ export interface DesktopifyMenuItemConstructorOptions extends Omit<MenuItemConst
  *
  * @param windowId - The id of the window to toggle
  */
-export declare type DesktopifyAppTrayToggleWindowAction = {
+export type DesktopifyAppTrayToggleWindowAction = {
     role: 'toggleWindow';
     windowId: string;
 };
@@ -60,7 +59,7 @@ export declare type DesktopifyAppTrayToggleWindowAction = {
  *
  * @param menu - The menu to show when action triggered
  */
-export declare type DesktopifyAppTrayToggleMenuAction = {
+export type DesktopifyAppTrayToggleMenuAction = {
     role: 'toggleMenu';
     menu: DesktopifyMenuItemConstructorOptions[];
 };
@@ -69,17 +68,17 @@ export declare type DesktopifyAppTrayToggleMenuAction = {
  *
  * @param event - The name of the event
  */
-export declare type DesktopifyAppTrayJSEventAction = {
+export type DesktopifyAppTrayJSEventAction = {
     role: 'jsEvent';
     event: string;
 };
 /**
  * No Action Tray Action
  */
-export declare type DesktopifyAppTrayNoAction = {
+export type DesktopifyAppTrayNoAction = {
     role: 'noAction';
 };
-export declare type DesktopifyAppTrayAction = DesktopifyAppTrayToggleMenuAction | DesktopifyAppTrayToggleWindowAction | DesktopifyAppTrayJSEventAction | DesktopifyAppTrayNoAction;
+export type DesktopifyAppTrayAction = DesktopifyAppTrayToggleMenuAction | DesktopifyAppTrayToggleWindowAction | DesktopifyAppTrayJSEventAction | DesktopifyAppTrayNoAction;
 export interface DesktopifyAppTray {
     id: string;
     objectId?: string;
@@ -98,21 +97,21 @@ export interface DesktopifyAppTray {
     rightClick: DesktopifyAppTrayAction;
     leftClick: DesktopifyAppTrayAction;
 }
-export declare type DesktopifyAppMenu = DesktopifyMenuItemConstructorOptions;
+export type DesktopifyAppMenu = DesktopifyMenuItemConstructorOptions;
 /**
  * Whitelist of allowed DesktopifyWindow Options.
  * These attrs (if set) are passed to the `BrowserWindow` constructor
  * when the window is created
  */
 export declare const allowedBrowserWindowConstructorOptions: Readonly<(keyof BrowserWindowConstructorOptions)[]>;
-export declare type whitelistedBrowserWindowConstructorOptions = (typeof allowedBrowserWindowConstructorOptions)[number];
+export type whitelistedBrowserWindowConstructorOptions = (typeof allowedBrowserWindowConstructorOptions)[number];
 /**
  * Whitelist of allowed DesktopifyWindow Web Preferences Options.
  * These attrs (if set) are passed to the webPreferences object in the `BrowserWindow` constructor
  * when the window is created
  */
 export declare const allowedWebPreferencesOptions: Readonly<(keyof WebPreferences)[]>;
-export declare type whitelistedWebPreferencesOptions = (typeof allowedWebPreferencesOptions)[number];
+export type whitelistedWebPreferencesOptions = (typeof allowedWebPreferencesOptions)[number];
 /**
  * Interface for ToDesktop App Windows
  */
@@ -162,6 +161,10 @@ export interface DesktopifyAppWindow {
      * Disables default rightClick menu
      */
     disableContextMenu: boolean;
+    /**
+     * Disables the menu item for opening a link in a new app window
+     */
+    disableContextMenuOpenInWindow: boolean;
     /**
      * Allows user to `Cmd+F` or `Edit>Find` to search for text on page
      */
@@ -230,7 +233,7 @@ export interface DesktopifyAppWindow {
      */
     file?: string;
 }
-export declare type AutoUpdateConfiguration = {
+export type AutoUpdateConfiguration = {
     autoUpdater: boolean;
     shouldAutoCheckOnLaunch: boolean;
     shouldAutoCheckInterval: boolean;
@@ -386,9 +389,17 @@ export interface DesktopifyApp2<Plugin = DesktopAppPlugin> {
      */
     shouldMakeSameDomainAnExternalLink?: boolean;
     /**
-     * Enables push notifications
+     * Enables push notifications — uses `electron-push-receiver`
      */
     enablePushNotifications?: boolean;
+    /**
+     * Enables NEW push notifications — uses `@cuj1559/electron-push-receiver`
+     */
+    enableNewPushNotifications?: boolean;
+    /**
+     * Disable error reporting (Sentry)
+     */
+    disableErrorTracking?: boolean;
     /**
      * Sets theme for Electron UI elements and css.
      *
@@ -473,7 +484,7 @@ export interface DesktopifyApp2<Plugin = DesktopAppPlugin> {
      */
     shouldProtectContent?: boolean;
 }
-export declare type FindInPagePlacement = {
+export type FindInPagePlacement = {
     offset: number;
 };
 export interface IApp2<Plugin = DesktopAppPlugin> extends BaseApp {

package/lib/hsm.d.ts

@@ -0,0 +1,30 @@
+/**
+ * - mac = Developer ID Application
+ * - mac-installer = Developer ID Installer
+ * - mas = Apple Distribution or Mac App Distribution (for Mac App Store)
+ * - mas-installer = Mac Installer Distribution (for Mac App Store)
+ * - mas-dev = Apple Development
+ */
+export type MacTarget = 'mac' | 'mac-installer' | 'mas' | 'mas-installer' | 'mas-dev';
+export type WindowsTarget = 'windows';
+export declare function isMacTarget(type: string): type is MacTarget;
+export declare function isWindowsTarget(type: string): type is MacTarget;
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for certificate files that have a `.p12` postfix.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+export declare const getCertificateNameFromHSM: (appId: string, target: MacTarget | WindowsTarget) => string;
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for key files that have a `.p8` postfix.
+ * Currently only used for mac notarization.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+export declare const getAPIKeyNameFromHSM: (appId: string, target: MacTarget) => string;

package/lib/hsm.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAPIKeyNameFromHSM = exports.getCertificateNameFromHSM = void 0;
+exports.isMacTarget = isMacTarget;
+exports.isWindowsTarget = isWindowsTarget;
+function isMacTarget(type) {
+    return ['mac', 'mac-installer', 'mas', 'mas-installer', 'mas-dev'].includes(type);
+}
+function isWindowsTarget(type) {
+    return ['windows'].includes(type);
+}
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for certificate files that have a `.p12` postfix.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+const getCertificateNameFromHSM = (appId, target) => {
+    if (!isMacTarget(target) && !isWindowsTarget(target)) {
+        throw new Error(`Invalid target '${target}'. Only windows or mac certs are supported`);
+    }
+    return `todesktop-${appId}-${target}-cert`;
+};
+exports.getCertificateNameFromHSM = getCertificateNameFromHSM;
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for key files that have a `.p8` postfix.
+ * Currently only used for mac notarization.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+const getAPIKeyNameFromHSM = (appId, target) => {
+    if (!isMacTarget(target)) {
+        throw new Error(`Invalid target '${target}'. Only mac certs are supported`);
+    }
+    return `todesktop-${appId}-${target}-api-key`;
+};
+exports.getAPIKeyNameFromHSM = getAPIKeyNameFromHSM;

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export * from './getSiteInfo';
 export * from './plans';
 export * from './base';
 export * from './plugin';
+export * from './hsm';
 export * from './desktopify2';
 declare const schemaVersion: string;
 export { schemaVersion };

package/lib/index.js

@@ -1,13 +1,17 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schemaVersion = void 0;
@@ -19,6 +23,7 @@ __exportStar(require("./getSiteInfo"), exports);
 __exportStar(require("./plans"), exports);
 __exportStar(require("./base"), exports);
 __exportStar(require("./plugin"), exports);
+__exportStar(require("./hsm"), exports);
 __exportStar(require("./desktopify2"), exports);
 const schemaVersion = package_json_1.version;
 exports.schemaVersion = schemaVersion;

package/lib/plans.d.ts

@@ -1,223 +1,130 @@
-export declare const devPlanIds: {
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
+import { Subscription } from './base';
+export type PriceKey = `${'monthly' | 'yearly'}_${string}`;
+export type Price = {
+    id: string;
+    status: 'active' | 'inactive';
+    period: 'monthly' | 'yearly';
+    amount: number;
 };
-export declare const prodPlanIds: {
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    professional_annual_full_price: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
+export type Product<T extends PriceKey = any> = {
+    id: string;
+    prices: Record<T, Price>;
 };
-export declare type PlanIds = typeof prodPlanIds;
-export declare const getPlanEnvironment: (stage: 'dev' | 'prod') => {
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
+export type PlanTier = 'basic' | 'legacy_pro' | 'pro' | 'scale';
+export type Plan = {
+    tier: PlanTier;
+    label: string;
+    eligiblePlanTiers: PlanTier[];
+    products: Record<'dev' | 'prod', Product[]>;
 };
-export declare const getCLIPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "cli_founder" | "cli_founder_30" | "cli_founder_50" | "cli_performance" | "cli_scale">;
-export declare const getCLIFounderPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "cli_founder" | "cli_founder_30" | "cli_founder_50">;
-export declare const getCLIPerformancePlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "cli_performance">;
-export declare const getCLIScalePlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "cli_scale">;
-export declare const getBuilderPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "builder_essential" | "builder_professional">;
-export declare const getBuilderEssentialPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "builder_essential">;
-export declare const getBuilderProfessionalPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "builder_professional">;
-export declare const getEssentialPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "startup" | "essential" | "essential_new">;
-export declare const getProfessionalPlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "business" | "growth" | "professional" | "professional_annual">;
-export declare const getEnterprisePlanIds: (stage: 'dev' | 'prod') => Pick<{
-    startup: string;
-    business: string;
-    essential: string;
-    growth: string;
-    essential_new: string;
-    professional: string;
-    professional_annual: string;
-    cli_founder: string;
-    cli_founder_30: string;
-    cli_founder_50: string;
-    cli_performance: string;
-    cli_scale: string;
-    builder_essential: string;
-    builder_professional: string;
-    enterprise: string;
-}, "enterprise">;
+export type Configuration = {
+    default_return_url: string;
+    business_profile: {
+        headline: string;
+        privacy_policy_url: string;
+        terms_of_service_url: string;
+    };
+    metadata: {
+        [name: string]: string | number | null;
+    };
+    features: {
+        payment_method_update: {
+            enabled: boolean;
+        };
+        subscription_update: {
+            enabled: boolean;
+            default_allowed_updates: ('price' | 'promotion_code' | 'quantity')[];
+            products: {
+                product: string;
+                prices: string[];
+            }[];
+        };
+    };
+};
+export declare enum PortalConfigKey {
+    CLIUpdateDev = "cli_update_dev",
+    CLIUpdateProd = "cli_update_prod",
+    CLIUpgradeDev = "cli_upgrade_dev",
+    CLIUpgradeProd = "cli_upgrade_prod",
+    BuilderUpdateDev = "builder_update_dev",
+    BuilderUpdateProd = "builder_update_prod",
+    BuilderUpgradeDev = "builder_upgrade_dev",
+    BuilderUpgradeProd = "builder_upgrade_prod"
+}
+export declare const products: {
+    readonly dev: {
+        readonly builder: {
+            readonly essential: Product<"monthly_99" | "monthly_125" | "yearly_1200">;
+            readonly professional: Product<"monthly_199" | "monthly_240" | "monthly_300" | "yearly_2880">;
+        };
+        readonly cli: {
+            readonly founder30: Product<"monthly_30">;
+            readonly founder50: Product<"monthly_50" | "monthly_90">;
+            readonly founder: Product<"monthly_125" | "yearly_1200" | "monthly_100">;
+            readonly performance: Product<"monthly_300" | "monthly_375" | "yearly_3600">;
+            readonly scale: Product<"monthly_1200" | "monthly_1500" | "yearly_14400">;
+        };
+        readonly legacy: {
+            readonly essential: Product<"monthly_58">;
+            readonly essentialNew: Product<"monthly_58" | "yearly_580">;
+            readonly professional: Product<"monthly_199" | "yearly_1990" | "yearly_2388">;
+            readonly startup: Product<"monthly_49" | "yearly_200">;
+            readonly growth: Product<"monthly_199">;
+            readonly business: Product<"monthly_199">;
+            readonly enterprise: Product<"monthly_700">;
+        };
+    };
+    readonly prod: {
+        readonly builder: {
+            readonly essential: Product<"monthly_99" | "monthly_125" | "yearly_1200">;
+            readonly professional: Product<"monthly_199" | "monthly_240" | "monthly_300" | "yearly_2880">;
+        };
+        readonly cli: {
+            readonly founder30: Product<"monthly_30">;
+            readonly founder50: Product<"monthly_50" | "monthly_90">;
+            readonly founder: Product<"monthly_125" | "yearly_1200" | "monthly_100">;
+            readonly performance: Product<"monthly_300" | "monthly_375" | "yearly_3600">;
+            readonly scale: Product<"monthly_1200" | "monthly_1500" | "yearly_14400">;
+        };
+        readonly legacy: {
+            readonly essential: Product<"monthly_58">;
+            readonly essentialNew: Product<"monthly_58" | "yearly_580">;
+            readonly professional: Product<"monthly_199" | "yearly_1990" | "yearly_2388">;
+            readonly startup: Product<"monthly_49" | "yearly_200">;
+            readonly growth: Product<"monthly_199">;
+            readonly business: Product<"monthly_199">;
+            readonly enterprise: Product<"monthly_700">;
+        };
+    };
+};
+export declare const basicPlan: Plan;
+export declare const legacyProPlan: Plan;
+export declare const proPlan: Plan;
+export declare const scalePlan: Plan;
+export declare const configurations: {
+    dev: {
+        builder: {
+            update: Configuration;
+            upgrade: Configuration;
+        };
+        cli: {
+            update: Configuration;
+            upgrade: Configuration;
+        };
+    };
+    prod: {
+        builder: {
+            update: Configuration;
+            upgrade: Configuration;
+        };
+        cli: {
+            update: Configuration;
+            upgrade: Configuration;
+        };
+    };
+};
+export declare const hasActiveSub: (sub?: Subscription) => boolean;
+export declare const hasPlan: (plan: Plan, sub?: Subscription) => boolean;
+export declare const getPlan: (sub?: Pick<Subscription, "productId" | "planId">) => Plan | null;
+export type LegacyProductKey = 'startup' | 'business' | 'essential' | 'growth' | 'essential_new' | 'professional' | 'professional_annual' | 'professional_annual_full_price' | 'cli_founder' | 'cli_founder_30' | 'cli_founder_50' | 'cli_performance' | 'cli_scale' | 'builder_essential' | 'builder_professional' | 'enterprise';
+export declare const LegacyProductRecord: Record<LegacyProductKey, Record<'dev' | 'prod', Product>>;