@popclip/types 1.4586.2 → 1.4615.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@popclip/types",
-  "version": "1.4586.2",
+  "version": "1.4615.0",
   "devDependencies": {
     "typedoc": "0.25.13",
     "typescript": "5.4.5"
@@ -10,5 +10,9 @@
     "check": "tsc --noEmit",
     "docs": "typedoc"
   },
-  "types": "./popclip.d.ts"
+  "types": "./popclip.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pilotmoon/popclip-types"
+  }
 }

package/popclip.d.ts

@@ -152,7 +152,7 @@ interface AssociatedApp {
  * @param context Information about the context surrounding the selection. (Same object as  {@link PopClip.context}.)
  * @returns A single action, an array of actions.
  */
-type PopulationFunction<CustomOptions extends Options = Options> = (
+type PopulationFunction<CustomOptions = Options> = (
 	input: Input,
 	options: CustomOptions,
 	context: Context,
@@ -413,7 +413,7 @@ interface ActionProperties extends IconProperties {
  * @param options Current values of the options for this extension. (Same object as  {@link PopClip.options}.)
  * @param context Information about the context surrounding the selection. (Same object as  {@link PopClip.context}.)
  */
-type ActionFunction<CustomOptions extends Options = Options> = (
+type ActionFunction<CustomOptions = Options> = (
 	input: Input,
 	options: CustomOptions & AuthOptions,
 	context: Context,
@@ -423,8 +423,7 @@ type ActionFunction<CustomOptions extends Options = Options> = (
  * **Action** represents the properties of a single action.
  * If `code` is omitted, the action displays a disabled title/icon only.
  */
-interface Action<CustomOptions extends Options = Options>
-	extends ActionProperties {
+interface Action<CustomOptions = Options> extends ActionProperties {
 	code?: ActionFunction<CustomOptions>;
 }
 
@@ -434,8 +433,7 @@ type Entitlement = "network" | "dynamic";
 /**
  * The Extension object defines the PopClip extension.
  */
-interface Extension<CustomOptions extends Options = Options>
-	extends ActionProperties {
+interface Extension<CustomOptions = Options> extends ActionProperties {
 	/**
 	 * The display name of this extension.
 	 */
@@ -480,6 +478,9 @@ interface Extension<CustomOptions extends Options = Options>
 	module?: string;
 }
 
+/**
+ * The possible values for `type` of {@link Option}.
+ */
 type OptionType =
 	| "string"
 	| "boolean"
@@ -529,6 +530,9 @@ interface OptionBase {
 	inset?: boolean;
 }
 
+/**
+ A string-valued option.
+*/
 interface StringOption extends OptionBase {
 	type: "string";
 	/**
@@ -537,6 +541,9 @@ interface StringOption extends OptionBase {
 	defaultValue?: string;
 }
 
+/**
+ * A multiple-choice option.
+ */
 interface MultipleOption extends OptionBase {
 	type: "multiple";
 	/**
@@ -550,12 +557,15 @@ interface MultipleOption extends OptionBase {
 	values?: string[];
 
 	/**
-	 * Display names corresponding to the entries in the  {@link values} array. These are shown in the option UI.
+	 * Display names corresponding to the entries in the {@link values} array. These are shown in the option UI.
 	 * If ommitted, the raw value strings are shown instead.
 	 */
 	valueLabels?: LocalizableString[];
 }
 
+/**
+ * A boolean option.
+ */
 interface BooleanOption extends OptionBase {
 	type: "boolean";
 	/**
@@ -568,14 +578,23 @@ interface BooleanOption extends OptionBase {
 	icon?: string;
 }
 
+/**
+ * A concealed string option.
+ */
 interface PasswordOption extends OptionBase {
 	type: "password" | "secret";
 }
 
+/**
+ * A heading option, which does not define an actual option, but adds a heading in the preferences window.
+ */
 interface HeadingOption extends OptionBase {
 	type: "heading";
 }
 
+/**
+ Represents a single option in the extension's preferences.
+*/
 type Option =
 	| StringOption
 	| MultipleOption
@@ -831,17 +850,22 @@ interface PopClip {
 	) => void;
 
 	/**
-	 * Display text inside PopClip's popup, with option to make the display a clickable button to
-	 * paste the text.
-	 * @param text The text to display. It will be truncated to 160 characters when shown.
-	 * @param options
+	 * Display text to the user.
+	 * @param text The text to display.
+	 * @param options Options.
 	 */
 	showText: (
 		text: string,
 		options?: {
 			/**
-			 * If `true`, and the app's Paste command is available, the displayed text will be in a cickable button,
-			 * which clicked, pastes the full text.
+			 * Display style:
+			 * - `compact` (default): Show the text inside PopClip's popup. It will be truncated to 160 characters when shown.
+			 * - `large`: Show as "Large Type" in full screen.
+			 */
+			style?: "compact" | "large";
+			/**
+			 * Applies to `compact` display mode only. If `true`, and the app's Paste command is available,
+			 * the displayed text will be in a clickable button, which clicked, pastes the full text.
 			 */
 			preview?: boolean;
 		},
@@ -1249,6 +1273,6 @@ declare function sleep(durationMilliseconds: number): Promise<void>;
  *
  * @param extension The extension object to export.
  */
-declare function defineExtension<CustomOptions extends Options = Options>(
+declare function defineExtension<CustomOptions = Options>(
 	extension: Extension<CustomOptions>,
 ): void;