@popclip/types 1.4624.1 → 1.4636.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@popclip/types",
-  "version": "1.4624.1",
+  "version": "1.4636.1",
   "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[];
 }
 
 /**
@@ -604,9 +604,8 @@ type Option =
 
 // Create a type mapping from Option Type to TypeScript types
 type OptionTypeMapping = {
-  secret: string;
-  password: string;
   string: string;
+  secret: string;
   multiple: string;
   boolean: boolean;
 };
@@ -616,12 +615,17 @@ type ExtractType<T extends Option> = T["type"] extends keyof OptionTypeMapping
   ? OptionTypeMapping[T["type"]]
   : never;
 
+// Helper type to exclude `never` properties
+type ExcludeNever<T> = {
+  [K in keyof T as T[K] extends never ? never : K]: T[K];
+};
+
 // Create a utility type to infer the OmnivoreOptions type
-type InferOptions<T extends readonly Option[]> = {
+type InferOptions<T extends readonly Option[]> = ExcludeNever<{
   readonly [K in T[number]["identifier"]]: ExtractType<
     Extract<T[number], { identifier: K }>
   >;
-} & AuthOptions;
+}>;
 
 /**
  * Represents a generic range, as a location and length
@@ -1125,6 +1129,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;