@todesktop/shared 7.190.0 → 7.191.1

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/translation.js

@@ -0,0 +1,13 @@
+export {};
+/* TODO - Support more languages here */
+// | "en"
+// | "es"
+// | "fr"
+// | "de"
+// | "it"
+// | "ja"
+// | "ko"
+// | "pt-BR"
+// | "ru"
+// | "zh-CN"
+// | "zh-TW";

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/lib/{validations.js → esm/validations.js}

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldMinimizeToTrayIsActive = exports.appConfigValidation = exports.appProtocolValidation = exports.internalAppRegexValidation = exports.widthValidation = exports.heightValidation = exports.urlValidationForm = exports.urlValidation = exports.iconValidation = exports.forceVersionValidation = exports.appTitleValidation = void 0;
-const yup = require("yup");
-const semver = require("semver");
-const isRegex = require("is-regex");
-exports.appTitleValidation = yup
+import isRegex from 'is-regex';
+import semver from 'semver';
+import * as yup from 'yup';
+export const appTitleValidation = yup
     .string()
     .label('App title')
     .max(26)
@@ -12,9 +9,9 @@ exports.appTitleValidation = yup
     .matches(/^[^\s]+(\s+[^\s]+)*$/, 'App title may not begin or end with space')
     .required();
 function isNumeric(str) {
-    if (typeof str != 'string')
+    if (typeof str !== 'string')
         return false;
-    return !isNaN(Number(str)) && !isNaN(parseFloat(str));
+    return !Number.isNaN(Number(str)) && !Number.isNaN(parseFloat(str));
 }
 function isNumericSemver(value) {
     // check if valid semver
@@ -25,7 +22,7 @@ function isNumericSemver(value) {
         return false;
     return true;
 }
-exports.forceVersionValidation = yup
+export const forceVersionValidation = yup
     .string()
     .label('App version')
     .required()
@@ -34,35 +31,35 @@ exports.forceVersionValidation = yup
     return (isNumericSemver(forceVersion) &&
         semver.gt(forceVersion, currentVersion));
 }));
-exports.iconValidation = yup
+export const iconValidation = yup
     .string()
     .label('Icon')
     .url()
     .required('You must upload an icon for your app');
-exports.urlValidation = yup
+export const urlValidation = yup
     .string()
     .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*)?$/, {
-    message: "Invalid URL. Don't forget to include the protocol (e.g.. https://).",
     excludeEmptyString: true,
+    message: "Invalid URL. Don't forget to include the protocol (e.g.. https://).",
 })
     .label('Website URL')
     .required();
-exports.urlValidationForm = yup.object().shape({
-    url: exports.urlValidation,
+export const urlValidationForm = yup.object().shape({
+    url: urlValidation,
 });
-exports.heightValidation = yup
+export const heightValidation = yup
     .number()
     .label('Height')
     .moreThan(1)
     .lessThan(2000)
     .required();
-exports.widthValidation = yup
+export const widthValidation = yup
     .number()
     .label('Width')
     .moreThan(1)
     .lessThan(3000)
     .required();
-exports.internalAppRegexValidation = yup
+export const internalAppRegexValidation = yup
     .string()
     .required()
     .label('Internal URLs')
@@ -78,8 +75,10 @@ exports.internalAppRegexValidation = yup
     }
     return true;
 })
-    .test('is-regex', '${path} must be valid regular expression', (value) => isRegex(RegExp(value)));
-exports.appProtocolValidation = yup
+    .test('is-regex', 
+// eslint-disable-next-line no-template-curly-in-string
+'${path} must be valid regular expression', (value) => isRegex(RegExp(value)));
+export const appProtocolValidation = yup
     .string()
     .required()
     .label('App Protocol')
@@ -87,54 +86,53 @@ exports.appProtocolValidation = yup
     .test('is-lowercase', 'Protocols must be lowercase', (value) => value === value.toLowerCase())
     .matches(/^[a-zA-Z-.]+:\/\/$/, 'Protocols contain letters, dots (.) and dashes (-) only')
     .min(5);
-exports.appConfigValidation = yup.object({
-    id: yup.string().required(),
-    name: exports.appTitleValidation,
-    url: exports.urlValidation,
-    isFrameBlocked: yup.boolean().required(),
-    iconUrl: exports.iconValidation,
-    disableDevTools: yup.boolean().required(),
-    singleInstance: yup.boolean().required(),
+export const appConfigValidation = yup.object({
     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(),
-        transparentTitlebar: 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(),
         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(),
 });
-const shouldMinimizeToTrayIsActive = (desktopApp) => {
+export const shouldMinimizeToTrayIsActive = (desktopApp) => {
     return desktopApp.trays.some((t) => t.leftClick.role === 'toggleMenu' || t.rightClick.role === 'toggleMenu');
 };
-exports.shouldMinimizeToTrayIsActive = shouldMinimizeToTrayIsActive;

package/package.json

@@ -1,18 +1,33 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.190.0",
+  "version": "7.191.1",
   "description": "",
-  "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": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rm -f ./lib/* && tsc",
-    "lint": "npm run lint:types && npm run lint:styles",
-    "lint:types": "tsc --noEmit",
-    "lint:styles": "prettier --check . && eslint src",
-    "prepublishOnly": "npm run build",
+    "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"
+    "dev": "tsc",
+    "format": "prettier . --write && eslint --fix",
+    "lint": "prettier . --check && eslint",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit"
   },
   "author": "Dave Jeffery <dave@davejeffery.com>",
   "license": "UNLICENSED",
@@ -25,17 +40,11 @@
     "yup": "^1.4.0"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.9.1",
+    "@todesktop/dev-config": "workspace:*",
     "@types/semver": "^7.3.9",
-    "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@typescript-eslint/parser": "^8.4.0",
     "app-builder-lib": "^25.1.8",
-    "eslint": "^9.9.1",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "globals": "^15.9.0",
-    "prettier": "^2.8.8",
-    "typescript": "^5.5.4"
+    "eslint": "catalog:",
+    "prettier": "catalog:",
+    "typescript": "catalog:"
   }
 }