@todesktop/shared 7.191.0 → 7.192.0

package/lib/esm/introspection/breakpoints.js

@@ -0,0 +1,42 @@
+const MINUTE = 60 * 1000;
+export const BREAKPOINT_DEFAULT_LEASE_MS = 20 * MINUTE; // 20 minutes
+export const BREAKPOINT_RENEW_INCREMENT_MS = 10 * MINUTE; // 10 minutes
+export const BREAKPOINT_MAX_REMAINING_MS = 20 * MINUTE; // 20 minutes
+export function isSameBreakpoint(a, b) {
+    if (!a || !b) {
+        return false;
+    }
+    if (a.type !== b.type) {
+        return false;
+    }
+    if (a.id !== b.id) {
+        return false;
+    }
+    if (isHookBreakpointConfig(a) && isHookBreakpointConfig(b)) {
+        return a.position === b.position;
+    }
+    return true;
+}
+function isHookBreakpointConfig(config) {
+    return config.type === 'hook';
+}
+export function cloneBreakpointQueue(queue) {
+    return Array.isArray(queue) ? queue.map((entry) => (Object.assign({}, entry))) : [];
+}
+export function markQueueSkipped(queue, startIndex, options = {}) {
+    var _a;
+    const updated = cloneBreakpointQueue(queue);
+    const { fallbackHitAt } = options;
+    if (startIndex < 0 || startIndex >= updated.length) {
+        return updated;
+    }
+    const current = updated[startIndex];
+    const hitAt = (_a = current.hitAt) !== null && _a !== void 0 ? _a : fallbackHitAt;
+    updated[startIndex] = Object.assign(Object.assign(Object.assign({}, current), { skipped: true }), (hitAt ? { hitAt } : {}));
+    for (let i = startIndex + 1; i < updated.length; i += 1) {
+        if (!updated[i].hitAt) {
+            updated[i] = Object.assign(Object.assign({}, updated[i]), { skipped: true });
+        }
+    }
+    return updated;
+}

package/lib/esm/invitePermissionLabels.d.ts

@@ -0,0 +1,13 @@
+import { UserIHaveSentInviteTo } from './toDesktop';
+export type InvitePermissionKey = 'canBuild' | 'canManageBilling' | 'canManageUsers' | 'canRelease';
+export type InvitePermissionFlags = Record<InvitePermissionKey, boolean>;
+export declare const INVITE_PERMISSION_LABELS: Record<InvitePermissionKey, string>;
+export declare const formatInvitePermissionSummary: (permissions: Partial<InvitePermissionFlags>) => string;
+export type NormalizedInvitePermissions = {
+    canBuild: boolean;
+    canManageBilling: boolean;
+    canManageUsers: boolean;
+    canRelease: boolean;
+};
+export declare const FULL_OWNER_PERMISSIONS: NormalizedInvitePermissions;
+export declare const normalizeInvitePermissions: (permissions?: UserIHaveSentInviteTo["permissions"]) => NormalizedInvitePermissions;

package/lib/esm/personalAccessTokens.d.ts

@@ -0,0 +1,24 @@
+export type PatStatus = 'active' | 'expired' | 'revoked';
+export type PatPermissionSource = 'delegate' | 'owner';
+export interface PatAppScope {
+    applicationId: string;
+    ownerUserId: string;
+    permissionSource: PatPermissionSource;
+}
+export interface PatUsageApp {
+    applicationId: string;
+    ownerUserId: string;
+}
+export interface PatSummary {
+    appScopes: PatAppScope[];
+    createdAt: null | string;
+    description: string;
+    expiresAt: null | string;
+    lastUsedAt: null | string;
+    lastUsedByApp: null | PatUsageApp;
+    revokedAt: null | string;
+    status: PatStatus;
+    tokenId: string;
+    tokenPrefix: string;
+}
+export type PatListItem = PatSummary;

package/lib/esm/plans.d.ts

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

package/lib/esm/plugin.d.ts

@@ -0,0 +1,55 @@
+type AjvJSONSchemaType = object;
+export interface DesktopAppPlugin {
+    /**
+     * Package name, including version information.
+     * e.g. "@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"
+     */
+    package: string;
+    /**
+     * Configuration gathered from the todesktop plugin.
+     * Named `todesktop` to clarify that it maps to the `todesktop` key on the package.json
+     */
+    todesktop?: ToDesktopPlugin;
+}
+export interface CustomPlugin {
+    addedAt: string;
+    description?: string;
+    displayName?: string;
+    lastLinkedAt?: string;
+    packageName: string;
+    sourcePath: string;
+    todesktop: ToDesktopPlugin;
+}
+export type ToDesktopPlugin = {
+    main?: string;
+    namespace: string;
+    preferences?: PluginPreferences;
+    preload?: string;
+    version: number;
+};
+export type PluginPreferences = {
+    [id: string]: PluginPreference;
+};
+export type PluginPreference = CheckboxSpec | NumberSpec | TextSpec;
+export type TextSpec = PreferenceSpec<'text', {
+    placeholder?: string;
+    validator?: AjvJSONSchemaType;
+    value?: string;
+}>;
+export type NumberSpec = PreferenceSpec<'number', {
+    placeholder?: number;
+    validator?: AjvJSONSchemaType;
+    value?: number;
+}>;
+export type CheckboxSpec = PreferenceSpec<'checkbox', {
+    validator?: AjvJSONSchemaType;
+    value?: boolean;
+}>;
+interface PreferenceSpec<T, V> {
+    description: string;
+    name: string;
+    order?: number;
+    spec: V;
+    type: T;
+}
+export {};

package/lib/esm/plugin.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/toDesktop.d.ts

@@ -0,0 +1,191 @@
+import { BaseApp, Schemable } from './base';
+import { IAppBuilderLib } from './desktopify';
+import { PatSummary } from './personalAccessTokens';
+export type IUploadFileStatus = 'done' | 'error' | 'removed' | 'success' | 'uploading';
+export interface IUploadFile {
+    error?: any;
+    fileName?: string;
+    lastModified?: number;
+    lastModifiedDate?: Date;
+    linkProps?: any;
+    name: string;
+    originFileObj?: File;
+    percent?: number;
+    response?: any;
+    size: number;
+    status?: IUploadFileStatus;
+    thumbUrl?: string;
+    type: string;
+    uid: string;
+    url?: string;
+}
+export interface IHueIcon extends IUploadFile {
+    hueAdjustment?: number;
+}
+export interface IAppIcon {
+    appId: string;
+    icon: IHueIcon;
+}
+export type IAppIcons = IAppIcon[];
+export interface IAppWindowOptions {
+    alwaysOnTop: boolean;
+    autoHideMenuBar: boolean;
+    hasMaxHeight: boolean;
+    hasMaxWidth: boolean;
+    hasMinHeight: boolean;
+    hasMinWidth: boolean;
+    height: number;
+    isMaximizable: boolean;
+    isMinimizable: boolean;
+    isResizable: boolean;
+    maxHeight: number;
+    maxWidth: number;
+    minHeight: number;
+    minWidth: number;
+    startInFullscreenMode: boolean;
+    transparentInsetTitlebar: boolean;
+    transparentTitlebar: boolean;
+    width: number;
+}
+export interface IWindowOptions {
+    height: number;
+    isAlwaysOnTop?: boolean;
+    isAutoHideMenuBar?: boolean;
+    isFullScreenStartEnabled?: boolean;
+    isInsetTitlebarTransparent?: boolean;
+    isMaximizable: boolean;
+    isMinimizable: boolean;
+    isResizable: boolean;
+    isTitlebarTransparent?: boolean;
+    maxHeight?: ISwitchableValue<number>;
+    maxWidth?: ISwitchableValue<number>;
+    minHeight?: ISwitchableValue<number>;
+    minWidth?: ISwitchableValue<number>;
+    width: number;
+}
+export interface IAppPublishedVersions {
+    desktopify?: string;
+    electron?: string;
+    version?: string;
+}
+export interface ISwitchableValue<T> {
+    enabled: boolean;
+    value: T;
+}
+export interface IIcon {
+    height: number;
+    type: string;
+    url: string;
+    width: number;
+}
+export interface IApp extends BaseApp {
+    appModelId: string;
+    appPkgName?: string;
+    appProtocol?: ISwitchableValue<string>;
+    appType?: string;
+    appxConfig?: Partial<IAppBuilderLib['config']['appx']>;
+    cssToInject?: string;
+    customDomain?: string;
+    customUserAgent?: ISwitchableValue<string>;
+    disableContextMenu?: boolean;
+    enablePushNotifications?: boolean;
+    environmentVariables?: {
+        [propertyName: string]: {
+            secret: string;
+        } | string;
+    };
+    extraBrowserWindowOptions?: string;
+    icon?: string;
+    icons?: IIcon[];
+    internalUrls?: ISwitchableValue<string>;
+    isBackgroundThrottlingPrevented?: boolean;
+    isContextMenuDisabled: boolean;
+    isDevToolsDisabled: boolean;
+    isFindInPageEnabled?: boolean;
+    isGoogleOAuthExternal?: boolean;
+    isNativeWindowOpenDisabled?: boolean;
+    isSingleInstance?: boolean;
+    isTitleStatic?: boolean;
+    isTransitioningFromSquirrelWindows?: boolean;
+    isWebSecurityDisabled?: boolean;
+    jsToInject?: string;
+    menubarIcon?: string;
+    name: string;
+    nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
+    pollForAppUpdatesEveryXMinutes?: number;
+    runtimeEnvs?: string;
+    secret?: string;
+    shouldLaunchAtStartupByDefault?: boolean;
+    shouldMakeSameDomainAnExternalLink?: boolean;
+    shouldOnlySendAbsolutelyNecessaryRequests?: boolean;
+    shouldReuseRendererProcess?: boolean;
+    shouldUseRealUserAgent?: boolean;
+    themeSource?: 'dark' | 'light' | 'system';
+    themeSourceMac?: 'dark' | 'light' | 'system';
+    toggleVisibilityKeyboardShortcut?: ISwitchableValue<string>;
+    trayIcon?: string;
+    url: string;
+    useSafeInternalUrlMatcher?: boolean;
+    windowOptions: IWindowOptions;
+}
+export interface IUser extends Schemable {
+    accessToken?: string;
+    allowedIPs?: string[];
+    authInfo?: object;
+    avatar?: string;
+    cliAccessTokens?: PatSummary[];
+    currentApplication?: string;
+    customerId?: string;
+    disableShouldCodeSign?: boolean;
+    email?: string;
+    featureFlags?: FeatureFlags;
+    firstName?: string;
+    id: string;
+    isAdmin?: boolean;
+    isImpersonator?: boolean;
+    isOldAccountThatNeedsNewPassword?: boolean;
+    lastName?: string;
+    seenApplicationGroupsTutorial?: boolean;
+    seenReleaseTutorial?: boolean;
+    stripeCustomerId?: string;
+}
+export interface FeatureFlags {
+    aboutBlankWindowOpenHandler: boolean;
+    desktopAppPlugins: boolean;
+    macAppStore: boolean;
+}
+export interface InvitePermissions {
+    canBuild: boolean;
+    canManageBilling?: boolean;
+    canManageUsers?: boolean;
+    canRelease: boolean;
+}
+export type InviteActorRole = 'delegate' | 'owner';
+export interface InviteActorCapabilities {
+    actorEmail: string;
+    actorId: string;
+    actorPermissions: InvitePermissions;
+    actorRole: InviteActorRole;
+}
+export interface UserIHaveSentInviteTo {
+    email: string;
+    inviterCapabilities?: InviteActorCapabilities;
+    name: string;
+    permissions?: InvitePermissions;
+    sender: UserIHaveAcceptedInviteFrom;
+}
+export interface UserIHaveAcceptedInviteFrom {
+    email: string;
+    firstName: string;
+    id: string;
+    lastName: string;
+    permissions?: InvitePermissions;
+    receiver?: Pick<IUser, 'email' | 'id'>;
+}
+export interface CiInput {
+    accessToken: string;
+    appData: IApp;
+    buildId?: string;
+    contextUserId: string;
+    userId: string;
+}

package/lib/esm/toDesktop.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/translation.d.ts

@@ -0,0 +1,2 @@
+export type ValidTranslationKeys = 'updateNotification.body' | 'updateNotification.title';
+export type ValidTranslationLanguages = 'default';

package/lib/esm/validations.d.ts

@@ -0,0 +1,102 @@
+import * as yup from 'yup';
+import { DesktopifyApp2 } from './desktopify2';
+import { DesktopAppPlugin } from './plugin';
+export declare const appTitleValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const forceVersionValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const iconValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const urlValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const urlValidationForm: yup.ObjectSchema<{
+    url: string;
+}, yup.AnyObject, {
+    url: undefined;
+}, "">;
+export declare const heightValidation: yup.NumberSchema<number, yup.AnyObject, undefined, "">;
+export declare const widthValidation: yup.NumberSchema<number, yup.AnyObject, undefined, "">;
+export declare const internalAppRegexValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const appProtocolValidation: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+export declare const appConfigValidation: yup.ObjectSchema<{
+    customUserAgent: string;
+    disableDevTools: NonNullable<boolean | undefined>;
+    iconUrl: string;
+    id: string;
+    internalURLs: string;
+    isFrameBlocked: NonNullable<boolean | undefined>;
+    meta: {
+        schemaVersion: number;
+        appIterations: number;
+        hasAppChanged: NonNullable<boolean | undefined>;
+        publishedVersions: {
+            electron?: yup.Maybe<string | undefined>;
+            version?: yup.Maybe<string | undefined>;
+            desktopify?: yup.Maybe<string | undefined>;
+        };
+    };
+    name: string;
+    secret: string;
+    singleInstance: NonNullable<boolean | undefined>;
+    url: string;
+    windowOptions: {
+        alwaysOnTop: NonNullable<boolean | undefined>;
+        autoHideMenuBar: NonNullable<boolean | undefined>;
+        height: number;
+        maxHeight: number;
+        maxWidth: number;
+        minHeight: number;
+        minWidth: number;
+        width: number;
+        hasMaxHeight: NonNullable<boolean | undefined>;
+        hasMaxWidth: NonNullable<boolean | undefined>;
+        hasMinHeight: NonNullable<boolean | undefined>;
+        hasMinWidth: NonNullable<boolean | undefined>;
+        isFullscreenable: NonNullable<boolean | undefined>;
+        isMaximizable: NonNullable<boolean | undefined>;
+        isMinimizable: NonNullable<boolean | undefined>;
+        isResizable: NonNullable<boolean | undefined>;
+        startInFullscreenMode: NonNullable<boolean | undefined>;
+        transparentInsetTitlebar: NonNullable<boolean | undefined>;
+        transparentTitlebar: NonNullable<boolean | undefined>;
+    };
+}, yup.AnyObject, {
+    customUserAgent: undefined;
+    disableDevTools: undefined;
+    iconUrl: undefined;
+    id: undefined;
+    internalURLs: undefined;
+    isFrameBlocked: undefined;
+    meta: {
+        appIterations: undefined;
+        hasAppChanged: undefined;
+        publishedVersions: {
+            desktopify: undefined;
+            electron: undefined;
+            version: undefined;
+        };
+        schemaVersion: undefined;
+    };
+    name: undefined;
+    secret: undefined;
+    singleInstance: undefined;
+    url: undefined;
+    windowOptions: {
+        hasMaxHeight: undefined;
+        hasMaxWidth: undefined;
+        hasMinHeight: undefined;
+        hasMinWidth: undefined;
+        height: undefined;
+        isFullscreenable: undefined;
+        isMaximizable: undefined;
+        isMinimizable: undefined;
+        isResizable: undefined;
+        maxHeight: undefined;
+        maxWidth: undefined;
+        minHeight: undefined;
+        minWidth: undefined;
+        startInFullscreenMode: undefined;
+        width: undefined;
+        alwaysOnTop: undefined;
+        autoHideMenuBar: undefined;
+        transparentInsetTitlebar: undefined;
+        transparentTitlebar: undefined;
+    };
+}, "">;
+export declare const shouldMinimizeToTrayIsActive: <Plugin = DesktopAppPlugin>(desktopApp: DesktopifyApp2<Plugin>) => boolean;

package/package.json

@@ -1,17 +1,33 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.191.0",
+  "version": "7.192.0",
   "description": "",
-  "type": "module",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/index.d.ts",
+        "default": "./lib/esm/index.js"
+      },
+      "require": {
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
   "scripts": {
-    "build": "rm -f ./lib/* && tsc",
+    "build": "rm -rf ./lib && pnpm run build:cjs && pnpm run build:esm && pnpm run build:rename-cjs-index",
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:rename-cjs-index": "mv ./lib/cjs/index.cjs.js ./lib/cjs/index.js && mv ./lib/cjs/index.cjs.d.ts ./lib/cjs/index.d.ts",
     "bump": "npm version minor && git push && npm publish",
     "dev": "tsc",
     "format": "prettier . --write && eslint --fix",
     "lint": "prettier . --check && eslint",
     "prepublishOnly": "npm run build",
+    "test": "vitest run",
     "typecheck": "tsc --noEmit"
   },
   "author": "Dave Jeffery <dave@davejeffery.com>",
@@ -30,6 +46,7 @@
     "app-builder-lib": "^25.1.8",
     "eslint": "catalog:",
     "prettier": "catalog:",
-    "typescript": "catalog:"
+    "typescript": "catalog:",
+    "vitest": "^1.6.1"
   }
 }

package/src/base.ts

@@ -171,6 +171,7 @@ export interface ToDesktopJson {
   mas?: {
     entitlements?: FilePath;
     entitlementsInherit?: FilePath;
+    minimumSystemVersion?: string;
     provisioningProfile?: FilePath;
     type?: 'development' | 'distribution'; // defaults to development
     x64ArchFiles?: string;