@todesktop/shared 7.190.0 → 7.191.1

package/src/plugin.ts

@@ -1,57 +1,57 @@
 type AjvJSONSchemaType = object;
 export interface DesktopAppPlugin {
-  /**
-   * Configuration gathered from the todesktop plugin.
-   * Named `todesktop` to clarify that it maps to the `todesktop` key on the package.json
-   */
-  todesktop?: ToDesktopPlugin;
-
   /**
    * 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 {
-  packageName: string;
+  addedAt: string;
+  description?: string;
   displayName?: string;
+  lastLinkedAt?: string;
+  packageName: string;
   sourcePath: string;
   todesktop: ToDesktopPlugin;
-  addedAt: string;
-  lastLinkedAt?: string;
-  description?: string;
 }
 
 export type ToDesktopPlugin = {
-  namespace: string;
-  version: number;
   main?: string;
-  preload?: string;
+  namespace: string;
   preferences?: PluginPreferences;
+  preload?: string;
+  version: number;
 };
 
 export type PluginPreferences = {
   [id: string]: PluginPreference;
 };
 
-export type PluginPreference = NumberSpec | TextSpec | CheckboxSpec;
+export type PluginPreference = CheckboxSpec | NumberSpec | TextSpec;
 
 export type TextSpec = PreferenceSpec<
   'text',
   {
+    placeholder?: string;
     validator?: AjvJSONSchemaType;
     value?: string;
-    placeholder?: string;
   }
 >;
 
 export type NumberSpec = PreferenceSpec<
   'number',
   {
+    placeholder?: number;
     validator?: AjvJSONSchemaType;
     value?: number;
-    placeholder?: number;
   }
 >;
 
@@ -64,9 +64,9 @@ export type CheckboxSpec = PreferenceSpec<
 >;
 
 interface PreferenceSpec<T, V> {
-  name: string;
   description: string;
-  type: T;
-  spec: V;
+  name: string;
   order?: number;
+  spec: V;
+  type: T;
 }

package/src/toDesktop.ts

@@ -3,28 +3,28 @@ import { IAppBuilderLib } from './desktopify';
 import { PatSummary } from './personalAccessTokens';
 
 export type IUploadFileStatus =
+  | 'done'
   | 'error'
+  | 'removed'
   | 'success'
-  | 'done'
-  | 'uploading'
-  | 'removed';
+  | 'uploading';
 
 export interface IUploadFile {
-  uid: string;
-  size: number;
-  name: string;
+  error?: any;
   fileName?: string;
   lastModified?: number;
   lastModifiedDate?: Date;
-  url?: string;
-  status?: IUploadFileStatus;
-  percent?: number;
-  thumbUrl?: string;
+  linkProps?: any;
+  name: string;
   originFileObj?: File;
+  percent?: number;
   response?: any;
-  error?: any;
-  linkProps?: any;
+  size: number;
+  status?: IUploadFileStatus;
+  thumbUrl?: string;
   type: string;
+  uid: string;
+  url?: string;
 }
 
 export interface IHueIcon extends IUploadFile {
@@ -38,47 +38,47 @@ export interface IAppIcon {
 export type IAppIcons = IAppIcon[];
 
 export interface IAppWindowOptions {
-  startInFullscreenMode: boolean;
-  isResizable: boolean;
-  width: number;
-  height: number;
-  hasMinWidth: boolean;
-  hasMinHeight: boolean;
-  hasMaxWidth: boolean;
+  alwaysOnTop: boolean;
+  autoHideMenuBar: boolean;
   hasMaxHeight: boolean;
-  minWidth: number;
-  minHeight: number;
-  maxWidth: number;
-  maxHeight: number;
+  hasMaxWidth: boolean;
+  hasMinHeight: boolean;
+  hasMinWidth: boolean;
+  height: number;
   isMaximizable: boolean;
   isMinimizable: boolean;
+  isResizable: boolean;
+  maxHeight: number;
+  maxWidth: number;
+  minHeight: number;
+  minWidth: number;
 
-  transparentTitlebar: boolean;
-  alwaysOnTop: boolean;
+  startInFullscreenMode: boolean;
   transparentInsetTitlebar: boolean;
-  autoHideMenuBar: boolean;
+  transparentTitlebar: boolean;
+  width: number;
 }
 
 export interface IWindowOptions {
+  height: number;
   isAlwaysOnTop?: boolean;
   isAutoHideMenuBar?: boolean;
+  isFullScreenStartEnabled?: boolean;
+  isInsetTitlebarTransparent?: boolean;
   isMaximizable: boolean;
   isMinimizable: boolean;
   isResizable: boolean;
-  isInsetTitlebarTransparent?: boolean;
   isTitlebarTransparent?: boolean;
-  isFullScreenStartEnabled?: boolean;
-  width: number;
-  height: number;
   maxHeight?: ISwitchableValue<number>;
-  minHeight?: ISwitchableValue<number>;
   maxWidth?: ISwitchableValue<number>;
+  minHeight?: ISwitchableValue<number>;
   minWidth?: ISwitchableValue<number>;
+  width: number;
 }
 
 export interface IAppPublishedVersions {
-  electron?: string;
   desktopify?: string;
+  electron?: string;
   version?: string;
 }
 
@@ -88,10 +88,10 @@ export interface ISwitchableValue<T> {
 }
 
 export interface IIcon {
-  url: string;
-  width: number;
   height: number;
   type: string;
+  url: string;
+  width: number;
 }
 
 export interface IApp extends BaseApp {
@@ -104,120 +104,120 @@ export interface IApp extends BaseApp {
   customDomain?: string;
   customUserAgent?: ISwitchableValue<string>;
   disableContextMenu?: boolean;
+  enablePushNotifications?: boolean;
   environmentVariables?: {
     // values that have been made secret need to be retrieved from azure key vault
-    [propertyName: string]: string | { secret: string };
+    [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;
-  isWebSecurityDisabled?: boolean;
-  isBackgroundThrottlingPrevented?: boolean;
-  isGoogleOAuthExternal?: boolean;
   isTitleStatic?: boolean;
-  shouldMakeSameDomainAnExternalLink?: boolean;
-  shouldUseRealUserAgent?: boolean;
-  extraBrowserWindowOptions?: string;
-  enablePushNotifications?: boolean;
   isTransitioningFromSquirrelWindows?: boolean;
+  isWebSecurityDisabled?: boolean;
   jsToInject?: string;
   menubarIcon?: string;
   name: string;
   nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
+  pollForAppUpdatesEveryXMinutes?: number;
   runtimeEnvs?: string;
   secret?: string; // support old schema versions
   shouldLaunchAtStartupByDefault?: boolean;
+  shouldMakeSameDomainAnExternalLink?: boolean;
   shouldOnlySendAbsolutelyNecessaryRequests?: boolean;
   shouldReuseRendererProcess?: boolean;
-  themeSource?: 'system' | 'light' | 'dark';
-  themeSourceMac?: 'system' | 'light' | 'dark';
+  shouldUseRealUserAgent?: boolean;
+  themeSource?: 'dark' | 'light' | 'system';
+  themeSourceMac?: 'dark' | 'light' | 'system';
   toggleVisibilityKeyboardShortcut?: ISwitchableValue<string>;
   trayIcon?: string;
   url: string;
-  windowOptions: IWindowOptions;
-  pollForAppUpdatesEveryXMinutes?: number;
   useSafeInternalUrlMatcher?: boolean;
+  windowOptions: IWindowOptions;
 }
 
 export interface IUser extends Schemable {
-  id: string;
+  accessToken?: string;
+  allowedIPs?: string[];
   authInfo?: object;
   avatar?: string;
+  cliAccessTokens?: PatSummary[];
   currentApplication?: string;
   customerId?: string;
+  disableShouldCodeSign?: boolean;
   email?: string;
+  featureFlags?: FeatureFlags;
   firstName?: string;
-  lastName?: string;
-  stripeCustomerId?: string;
-  isOldAccountThatNeedsNewPassword?: boolean;
-  accessToken?: string;
-  cliAccessTokens?: PatSummary[];
+  id: string;
   isAdmin?: boolean;
   isImpersonator?: boolean;
-  featureFlags?: FeatureFlags;
-  disableShouldCodeSign?: boolean;
-  allowedIPs?: string[];
-  seenReleaseTutorial?: boolean;
+  isOldAccountThatNeedsNewPassword?: boolean;
+  lastName?: string;
   seenApplicationGroupsTutorial?: boolean;
+  seenReleaseTutorial?: boolean;
+  stripeCustomerId?: string;
 }
 
 export interface FeatureFlags {
+  // Whether the user can see the toggle for allowing blank urls
+  aboutBlankWindowOpenHandler: boolean;
+
   // Whether the user can install desktop app plugins using the ToDesktop Builder
   desktopAppPlugins: boolean;
 
   // Whether the user can create builds for the mac app store.
   macAppStore: boolean;
-
-  // Whether the user can see the toggle for allowing blank urls
-  aboutBlankWindowOpenHandler: boolean;
 }
 
 export interface InvitePermissions {
   canBuild: boolean;
-  canRelease: boolean;
   canManageBilling?: boolean;
   canManageUsers?: boolean;
+  canRelease: boolean;
 }
 
-export type InviteActorRole = 'owner' | 'delegate';
+export type InviteActorRole = 'delegate' | 'owner';
 
 export interface InviteActorCapabilities {
-  actorId: string;
   actorEmail: string;
-  actorRole: InviteActorRole;
+  actorId: string;
   actorPermissions: InvitePermissions;
+  actorRole: InviteActorRole;
 }
 
 // uses an `email` identifier because an invited user may not have an account
 export interface UserIHaveSentInviteTo {
   email: string;
-  permissions?: InvitePermissions;
+  inviterCapabilities?: InviteActorCapabilities;
   name: string;
+  permissions?: InvitePermissions;
   // this allows us to encode information about the sender without loosening firebase privileges
   sender: UserIHaveAcceptedInviteFrom;
-  inviterCapabilities?: InviteActorCapabilities;
 }
 
 export interface UserIHaveAcceptedInviteFrom {
-  id: string;
   email: string;
   firstName: string;
+  id: string;
   lastName: string;
 
-  // duplicated user details about the person who accepted the invite
-  receiver?: Pick<IUser, 'id' | 'email'>;
   permissions?: InvitePermissions;
+  // duplicated user details about the person who accepted the invite
+  receiver?: Pick<IUser, 'email' | 'id'>;
 }
 
 export interface CiInput {
+  accessToken: string;
   appData: IApp;
   buildId?: string;
-  userId: string;
   contextUserId: string;
-  accessToken: string;
+  userId: string;
 }

package/src/translation.ts

@@ -1,6 +1,6 @@
 export type ValidTranslationKeys =
-  | 'updateNotification.title'
-  | 'updateNotification.body';
+  | 'updateNotification.body'
+  | 'updateNotification.title';
 export type ValidTranslationLanguages = 'default';
 /* TODO - Support more languages here */
 // | "en"

package/src/validations.ts

@@ -1,22 +1,23 @@
+import isRegex from 'is-regex';
+import semver from 'semver';
 import * as yup from 'yup';
-import * as semver from 'semver';
-import * as isRegex from 'is-regex';
 import { DesktopifyApp2 } from './desktopify2';
 import { DesktopAppPlugin } from './plugin';
+
 export const appTitleValidation = yup
   .string()
   .label('App title')
   .max(26)
   .matches(
     /^[\w\-\s]+$/,
-    'App title may contain letters, numbers, spaces and dashes only'
+    'App title may contain letters, numbers, spaces and dashes only',
   )
   .matches(/^[^\s]+(\s+[^\s]+)*$/, 'App title may not begin or end with space')
   .required();
 
 function isNumeric(str: string) {
-  if (typeof str != 'string') return false;
-  return !isNaN(Number(str)) && !isNaN(parseFloat(str));
+  if (typeof str !== 'string') return false;
+  return !Number.isNaN(Number(str)) && !Number.isNaN(parseFloat(str));
 }
 
 function isNumericSemver(value: string) {
@@ -43,8 +44,8 @@ export const forceVersionValidation = yup
           isNumericSemver(forceVersion) &&
           semver.gt(forceVersion, currentVersion)
         );
-      }
-    )
+      },
+    ),
   );
 
 export const iconValidation = yup
@@ -58,10 +59,10 @@ export const urlValidation = yup
   .matches(
     /^(?:([a-z0-9+.-]+):\/\/)(?:\S+(?::\S*)?@)?(?:(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*\.?)(?::\d{2,5})?(?:[/?#]\S*)?$/,
     {
+      excludeEmptyString: true,
       message:
         "Invalid URL. Don't forget to include the protocol (e.g.. https://).",
-      excludeEmptyString: true,
-    }
+    },
   )
   .label('Website URL')
   .required();
@@ -102,12 +103,13 @@ export const internalAppRegexValidation = yup
         return forwardSlashCount === backSlashEscapeCount;
       }
       return true;
-    }
+    },
   )
   .test(
     'is-regex',
+    // eslint-disable-next-line no-template-curly-in-string
     '${path} must be valid regular expression',
-    (value: string) => isRegex(RegExp(value))
+    (value: string) => isRegex(RegExp(value)),
   );
 
 export const appProtocolValidation = yup
@@ -117,73 +119,73 @@ export const appProtocolValidation = yup
   .test(
     'ends-with-protocol',
     'Protocols must end with `://`',
-    (value: string) => value.endsWith('://')
+    (value: string) => value.endsWith('://'),
   )
   .test(
     'is-lowercase',
     'Protocols must be lowercase',
-    (value) => value === value.toLowerCase()
+    (value) => value === value.toLowerCase(),
   )
   .matches(
     /^[a-zA-Z-.]+:\/\/$/,
-    'Protocols contain letters, dots (.) and dashes (-) only'
+    'Protocols contain letters, dots (.) and dashes (-) only',
   )
   .min(5);
 
 export const appConfigValidation = yup.object({
-  id: yup.string().required(),
-  name: appTitleValidation,
-  url: urlValidation,
-  isFrameBlocked: yup.boolean().required(),
-  iconUrl: iconValidation,
-  disableDevTools: yup.boolean().required(),
-  singleInstance: yup.boolean().required(),
   customUserAgent: yup.string().required(),
+  disableDevTools: yup.boolean().required(),
+  iconUrl: iconValidation,
+  id: yup.string().required(),
   internalURLs: yup.string().required(),
+  isFrameBlocked: yup.boolean().required(),
+  meta: yup
+    .object({
+      appIterations: yup.number().required(),
+      hasAppChanged: yup.boolean().required(),
+      publishedVersions: yup.object({
+        desktopify: yup.string().notRequired(),
+        electron: yup.string().notRequired(),
+        version: yup.string().notRequired(),
+      }),
+      schemaVersion: yup.number().required(),
+    })
+    .required(),
+  name: appTitleValidation,
   secret: yup.string().required(),
+  singleInstance: yup.boolean().required(),
+  url: urlValidation,
   windowOptions: yup
     .object({
-      startInFullscreenMode: yup.boolean().required(),
-      isResizable: yup.boolean().required(),
-      width: yup.number().required(),
-      height: yup.number().required(),
-      hasMinWidth: yup.boolean().required(),
-      hasMinHeight: yup.boolean().required(),
-      hasMaxWidth: yup.boolean().required(),
       hasMaxHeight: yup.boolean().required(),
-      minWidth: yup.number().required(),
-      minHeight: yup.number().required(),
-      maxWidth: yup.number().required(),
-      maxHeight: yup.number().required(),
+      hasMaxWidth: yup.boolean().required(),
+      hasMinHeight: yup.boolean().required(),
+      hasMinWidth: yup.boolean().required(),
+      height: yup.number().required(),
+      isFullscreenable: yup.boolean().required(),
       isMaximizable: yup.boolean().required(),
       isMinimizable: yup.boolean().required(),
-      isFullscreenable: yup.boolean().required(),
+      isResizable: yup.boolean().required(),
+      maxHeight: yup.number().required(),
+      maxWidth: yup.number().required(),
+      minHeight: yup.number().required(),
+      minWidth: yup.number().required(),
+      startInFullscreenMode: yup.boolean().required(),
+      width: yup.number().required(),
 
-      transparentTitlebar: yup.boolean().required(),
       alwaysOnTop: yup.boolean().required(),
-      transparentInsetTitlebar: yup.boolean().required(),
       autoHideMenuBar: yup.boolean().required(),
-    })
-    .required(),
-  meta: yup
-    .object({
-      schemaVersion: yup.number().required(),
-      hasAppChanged: yup.boolean().required(),
-      appIterations: yup.number().required(),
-      publishedVersions: yup.object({
-        electron: yup.string().notRequired(),
-        desktopify: yup.string().notRequired(),
-        version: yup.string().notRequired(),
-      }),
+      transparentInsetTitlebar: yup.boolean().required(),
+      transparentTitlebar: yup.boolean().required(),
     })
     .required(),
 });
 
 export const shouldMinimizeToTrayIsActive = <Plugin = DesktopAppPlugin>(
-  desktopApp: DesktopifyApp2<Plugin>
+  desktopApp: DesktopifyApp2<Plugin>,
 ) => {
   return desktopApp.trays.some(
     (t) =>
-      t.leftClick.role === 'toggleMenu' || t.rightClick.role === 'toggleMenu'
+      t.leftClick.role === 'toggleMenu' || t.rightClick.role === 'toggleMenu',
   );
 };

package/tsconfig.esm.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@todesktop/dev-config/tsconfig.base.json",
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "outDir": "./lib/esm",
+    "rootDir": "./src",
+    "resolveJsonModule": true,
+    "strict": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "lib", "src/index.cjs.ts"]
+}

package/tsconfig.json

@@ -1,12 +1,14 @@
 {
+  "extends": "@todesktop/dev-config/tsconfig.base.json",
   "compilerOptions": {
     "target": "es2016",
     "module": "commonjs",
     "declaration": true,
-    "outDir": "./lib",
+    "outDir": "./lib/cjs",
     "rootDir": "./src",
-    "skipLibCheck": true
+    "resolveJsonModule": true,
+    "strict": true
   },
-  // "include": ["src"],
-  "exclude": ["node_modules", "lib"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "lib", "src/index.ts"]
 }

package/.prettierrc

@@ -1,5 +0,0 @@
-{
-  "tabWidth": 2,
-  "semi": true,
-  "singleQuote": true
-}

package/lib/translation.d.ts

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

package/lib/{base.js → cjs/base.js}

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WindowsHSMCertType = exports.WindowsEVOnboardingProvider = exports.WindowsEVOnboardingSteps = void 0;
 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;
@@ -16,7 +16,7 @@ var WindowsEVOnboardingProvider;
 })(WindowsEVOnboardingProvider || (exports.WindowsEVOnboardingProvider = WindowsEVOnboardingProvider = {}));
 var WindowsHSMCertType;
 (function (WindowsHSMCertType) {
+    WindowsHSMCertType["azureTrustedSigning"] = "azureTrustedSigning";
     WindowsHSMCertType["ev"] = "ev";
     WindowsHSMCertType["file"] = "file";
-    WindowsHSMCertType["azureTrustedSigning"] = "azureTrustedSigning";
 })(WindowsHSMCertType || (exports.WindowsHSMCertType = WindowsHSMCertType = {}));