@popclip/types 1.4636.1 → 1.4666.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@popclip/types",
-  "version": "1.4636.1",
+  "version": "1.4666.0",
   "devDependencies": {
     "typedoc": "0.25.13",
     "typescript": "5.4.5"

package/popclip.d.ts

@@ -974,16 +974,25 @@ interface PopClip {
    * popclip.openUrl(`mailto:support@pilotmoon.com?subject=${encodeURIComponent("What's up?")}`); // open mailto link in the default mail application
    * ```
    *
-   * @param url A well-formed URL
+   * @param url URL string, or an object with a `href` property. (If the latter is passed,
+   *  the `href` property is used as the URL but with `+` characters replaced with `%20`.)
    * @param options Options.
    */
   openUrl: (
-    url: string,
+    url: string | { href: string },
     options?: {
       /**
        * Bundle identifier of the app to open the URL with. For example `"com.google.Chrome"`.
        */
       app?: string;
+      /**
+       * Whether to request that macOS activate the target app. (Default: `true`)
+       */
+      activate?: boolean;
+      /**
+       * Whether to open the URL in a background browser tab, where supported. (Default: `false`)
+       */
+      backgroundTab?: boolean;
     },
   ) => void;
 
@@ -1026,7 +1035,7 @@ interface Util {
    * @param string The string to localize.
    * @return The localized string, or the original string if no localized version was avaiable.
    */
-  localize: (string: string) => string;
+  localize(string: string): string;
 
   /**
      Get information about the current locale as configures in macOS settings.
@@ -1051,7 +1060,7 @@ interface Util {
     daylightSaving: boolean;
   };
 
-  htmlToRtf: (html: string) => string | undefined;
+  htmlToRtf(html: string): string | undefined;
 
   /**
    * Encode a string as UTF-8 then Base-64 encode the result.
@@ -1059,7 +1068,7 @@ interface Util {
    * @param string The string to encode.
    * @param options
    */
-  base64Encode: (
+  base64Encode(
     string: string,
     options?: {
       /**
@@ -1071,7 +1080,7 @@ interface Util {
        */
       trimmed?: boolean;
     },
-  ) => string;
+  ): string;
 
   /**
    * Decode a Base-64 string and interpret the result as a UTF-8 string.
@@ -1082,7 +1091,7 @@ interface Util {
    * @param string
    * @returns The decoded string
    */
-  base64Decode: (string: string) => string;
+  base64Decode(string: string): string;
 
   /* Build a URL from a base URL and additional query parameters */
   buildQueryUrl: (baseUrl: string, params: { [key: string]: string }) => string;
@@ -1094,13 +1103,13 @@ interface Util {
   parseQuery: (query: string) => any;
 
   /** Decipher a JSON object that has been lightly obscured to prevent constants such as
-   * API keys appearing in plaintext in the source files.
+   * API client identifiers appearing in plaintext in the source files.
    *
    * This function will ROT13 decipher the text, apply Base64 decoding, and parse the result as JSON. */
-  clarify: (obscuredString: string) => any;
+  clarify(obscuredString: string): any;
 
   // same as global sleep()
-  sleep: (durationMilliseconds: number) => Promise<void>;
+  sleep(durationMilliseconds: number): Promise<void>;
 
   /**
    * Fill the provided `TypedArray` with cryptographically secure random values.