@todesktop/shared 7.114.0 → 7.115.0

package/lib/plugin.d.ts

@@ -1,6 +1,14 @@
 export interface DesktopAppPlugin {
-    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;
+    /**
+     * Package name, including version information.
+     * e.g. "@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"
+     */
+    package: string;
 }
 export declare type ToDesktopPlugin = {
     namespace: string;
@@ -10,26 +18,33 @@ export declare type ToDesktopPlugin = {
     preferences?: PluginPreferences;
 };
 export declare type PluginPreferences = {
-    [id: string]: PluginSpecs;
+    [id: string]: PluginPreference;
 };
-export declare type PluginSpecs = NumberSpec | TextSpec;
+export declare type PluginPreference = NumberSpec | TextSpec;
 export declare type TextSpec = PreferenceSpec<"text", {
     minLength?: number;
     maxLength?: number;
     pattern?: RegExp;
+    value?: string;
     defaultValue?: string;
     placeholder?: string;
 }>;
+export declare type TextValue = PreferenceValue<string>;
 export declare type NumberSpec = PreferenceSpec<"number", {
     min?: number;
     max?: number;
+    value?: number;
     defaultValue?: number;
     placeholder?: number;
 }>;
+export declare type NumberValue = PreferenceValue<string>;
 interface PreferenceSpec<T, V> {
     name: string;
     description: string;
     type: T;
     value: V;
 }
+interface PreferenceValue<V> {
+    value: V;
+}
 export {};

package/package.json

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

package/src/plugin.ts

@@ -1,6 +1,15 @@
 export interface DesktopAppPlugin {
-  package: string; // e.g. ["@todesktop/plugin-foo", "@todesktop/plugin-baz@1.0.0"]
+  /**
+   * 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;
 }
 
 export type ToDesktopPlugin = {
@@ -12,10 +21,10 @@ export type ToDesktopPlugin = {
 };
 
 export type PluginPreferences = {
-  [id: string]: PluginSpecs;
+  [id: string]: PluginPreference;
 };
 
-export type PluginSpecs = NumberSpec | TextSpec;
+export type PluginPreference = NumberSpec | TextSpec;
 
 export type TextSpec = PreferenceSpec<
   "text",
@@ -23,20 +32,24 @@ export type TextSpec = PreferenceSpec<
     minLength?: number;
     maxLength?: number;
     pattern?: RegExp;
+    value?: string;
     defaultValue?: string;
     placeholder?: string;
   }
 >;
+export type TextValue = PreferenceValue<string>;
 
 export type NumberSpec = PreferenceSpec<
   "number",
   {
     min?: number;
     max?: number;
+    value?: number;
     defaultValue?: number;
     placeholder?: number;
   }
 >;
+export type NumberValue = PreferenceValue<string>;
 
 interface PreferenceSpec<T, V> {
   name: string;
@@ -44,3 +57,7 @@ interface PreferenceSpec<T, V> {
   type: T;
   value: V;
 }
+
+interface PreferenceValue<V> {
+  value: V;
+}