@popclip/types 1.4624.2 → 1.4663.0

package/package.json

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

package/popclip.d.ts

@@ -554,13 +554,13 @@ interface MultipleOption extends OptionBase {
   /**
    * The possible values for a `multiple` option.
    */
-  readonly values?: string[];
+  readonly values?: readonly string[];
 
   /**
    * 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.
    */
-  readonly valueLabels?: LocalizableString[];
+  readonly valueLabels?: readonly LocalizableString[];
 }
 
 /**
@@ -984,6 +984,14 @@ interface PopClip {
        * 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 +1034,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 +1059,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 +1067,7 @@ interface Util {
    * @param string The string to encode.
    * @param options
    */
-  base64Encode: (
+  base64Encode(
     string: string,
     options?: {
       /**
@@ -1071,7 +1079,7 @@ interface Util {
        */
       trimmed?: boolean;
     },
-  ) => string;
+  ): string;
 
   /**
    * Decode a Base-64 string and interpret the result as a UTF-8 string.
@@ -1082,7 +1090,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 +1102,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.
@@ -1129,6 +1137,22 @@ interface Util {
       | BigUint64Array,
   ): void;
 
+  /**
+   * Generate a RFC 4122 version 4 UUID using a cryptographically secure random number generator.
+   * @returns UUID string such as "e621e1f8-c36c-495a-93fc-0c247a3e6e5f".
+   */
+  randomUuid(): string;
+
+  /**
+   * Generate hash-based message authentication code (HMAC) using the supplied data, key and algorithm.
+   * Implemented internally by Apple's CommonCrypto.
+   */
+  hmac(
+    data: Uint8Array,
+    key: Uint8Array,
+    algorithm: "sha1" | "md5" | "sha256" | "sha384" | "sha512" | "sha224",
+  ): Uint8Array;
+
   /**
    * The `constant` property is a container for pre-defined constants.
    */

package/extra/require.d.ts

@@ -1,32 +0,0 @@
-/* Declare ambient module + exports for CommonJS-style exporting */
-declare const module: { exports: any };
-declare const exports: any;
-
-/**
- * Import an object from another file.
- *
- * #### Notes
- *
- * PopClip's `require()` implementation attempts to import from the following module formats:
- *
- * - AMD modules, which use `define(...)`.
- * - CommonJS modules, which use `module.exports = ...` or `exports.name = ...`
- * - TypeScript-compiled ES modules, which use `exports.default = ...`
- *
- * #### Notes
- *
- * Paths beginning with `./` or `../` are resolved relative to the the location of the current file.
- *
- * Otherwise, the path is resolved relative to the extensions's package root.
- * If there is no file in the extension, PopClip will look in its internal module repository.
- *
- * If no file extension is given, PopCLip will try adding the extensions `.js`, `.ts`, `.json` in that order.
- *
- * TypeScript files are transpiled to JavaScript on the fly.
- *
- * JSON files are parsed and returned as an object.å
- *
- * @param file Path to the file to import.
- * @return The imported object.
- */
-declare function require(file: string): object;

package/extra/shims.d.ts

@@ -1,20 +0,0 @@
-/* WebAPI and Node.js Globals
- * The following functions and objects are available in PopClip via polyfills.
- * TODO: Not sure how to improve typings for these?
- */
-
-// these are from WebAPI, and are implemented in PopClip with polyfills from `core-js` library
-declare function btoa(string: string): string;
-declare function atob(string: string): string;
-declare function structuredClone<T>(value: T): T;
-declare const URL: any;
-declare const URLSearchParams: any;
-
-// XMLHttpRequest is implemented natively in PopClip
-declare const XMLHttpRequest: any;
-
-// Blob is is a WebAPI object, implemented in PopClip with 'node-blob` library
-declare const Blob: any;
-
-// Buffer is a node.js object, implemented in PopClip with 'buffer' library
-declare const Buffer: any;

package/extra/timeout.d.ts

@@ -1,27 +0,0 @@
-/**
- * Call a function after a specified time interval.
- *
- * #### Notes
- *
- * This is PopClip's own implementation of the standard
- * [setTimeout](http://developer.mozilla.org/en-US/docs/Web/API/SetTimeout) function,
- * as found in browsers.
- * Ordinarily you shouldn't need to use this. It is is mainly included for
- * compatibility with libraries that might need it.
- *
- * @param callback A function to be called after the timer expires.
- * @param timeout Timeout in milliseconds. If this parameter is omitted, a value of 0 is used,
- * @param args Additional arguments to be passed to the callback function.
- * @returns Numeric identifier for the timer which can be passed to  {@link clearTimeout} to cancel it.
- */
-declare function setTimeout(
-	callback: (...args: any) => void,
-	timeout?: number,
-	...args: any
-): number;
-
-/**
- * Cancels a timeout prevouly created with  {@link setTimeout}.
- * @param timeoutId Identifier of the timeout to cancel.
- */
-declare function clearTimeout(timeoutId: number): void;