@todesktop/shared 7.106.0 → 7.109.0

package/lib/desktopify2.d.ts

@@ -2,6 +2,7 @@
 import { ISwitchableValue } from "./toDesktop";
 import { MenuItemConstructorOptions, BrowserWindowConstructorOptions, WebPreferences } from "@todesktop/client-electron-types";
 import { BaseApp } from "./base";
+import { DesktopAppPlugin } from "./plugin";
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
  */
@@ -270,9 +271,8 @@ export interface DesktopifyApp2 {
     pollForAppUpdatesEveryXMinutes?: number;
     /**
      * An array of plugin modules. Can work with semver specificity
-     * e.g. ["@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"]
      */
-    plugins?: string[];
+    plugins?: (DesktopAppPlugin | string)[];
     /**
      * The app's windows
      */

package/lib/index.d.ts

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

package/lib/plugin.d.ts

@@ -0,0 +1,26 @@
+export interface DesktopAppPlugin {
+    package: string;
+    preferences?: {
+        [id: string]: NumberSpec | TextSpec;
+    };
+}
+export declare type TextSpec = PreferenceSpec<"text", {
+    minLength?: number;
+    maxLength?: number;
+    pattern?: RegExp;
+    defaultValue?: string;
+    placeholder?: string;
+}>;
+export declare type NumberSpec = PreferenceSpec<"number", {
+    min?: number;
+    max?: number;
+    defaultValue?: number;
+    placeholder?: number;
+}>;
+interface PreferenceSpec<T, V> {
+    name: string;
+    description: string;
+    type: T;
+    value: V;
+}
+export {};

package/lib/plugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.106.0",
+  "version": "7.109.0",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/src/desktopify2.ts

@@ -5,6 +5,7 @@ import {
   WebPreferences,
 } from "@todesktop/client-electron-types";
 import { BaseApp, Schemable } from "./base";
+import { DesktopAppPlugin } from "./plugin";
 
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
@@ -383,9 +384,8 @@ export interface DesktopifyApp2 {
   pollForAppUpdatesEveryXMinutes?: number;
   /**
    * An array of plugin modules. Can work with semver specificity
-   * e.g. ["@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"]
    */
-  plugins?: string[];
+  plugins?: (DesktopAppPlugin | string)[];
   /**
    * The app's windows
    */

package/src/index.ts

@@ -6,6 +6,7 @@ export * from "./validations";
 export * from "./getSiteInfo";
 export * from "./plans";
 export * from './base';
+export * from './plugin';
 
 export * from "./desktopify2";
 

package/src/plugin.ts

@@ -0,0 +1,34 @@
+export interface DesktopAppPlugin {
+  package: string; // e.g. ["@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"]
+  preferences?: {
+    [id: string]: NumberSpec | TextSpec;
+  };
+}
+
+export type TextSpec = PreferenceSpec<
+  "text",
+  {
+    minLength?: number;
+    maxLength?: number;
+    pattern?: RegExp;
+    defaultValue?: string;
+    placeholder?: string;
+  }
+>;
+
+export type NumberSpec = PreferenceSpec<
+  "number",
+  {
+    min?: number;
+    max?: number;
+    defaultValue?: number;
+    placeholder?: number;
+  }
+>;
+
+interface PreferenceSpec<T, V> {
+  name: string;
+  description: string;
+  type: T;
+  value: V;
+}