node-red-contrib-tak-registration 0.11.6 → 0.12.1

package/node_modules/@types/node/querystring.d.ts

@@ -9,14 +9,26 @@
  * `querystring` is more performant than `URLSearchParams` but is not a
  * standardized API. Use `URLSearchParams` when performance is not critical or
  * when compatibility with browser code is desirable.
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/querystring.js)
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/querystring.js)
  */
 declare module "querystring" {
     interface StringifyOptions {
+        /**
+         * The function to use when converting URL-unsafe characters to percent-encoding in the query string.
+         * @default `querystring.escape()`
+         */
         encodeURIComponent?: ((str: string) => string) | undefined;
     }
     interface ParseOptions {
+        /**
+         * Specifies the maximum number of keys to parse. Specify `0` to remove key counting limitations.
+         * @default 1000
+         */
         maxKeys?: number | undefined;
+        /**
+         * The function to use when decoding percent-encoded characters in the query string.
+         * @default `querystring.unescape()`
+         */
         decodeURIComponent?: ((str: string) => string) | undefined;
     }
     interface ParsedUrlQuery extends NodeJS.Dict<string | string[]> {}
@@ -35,7 +47,7 @@ declare module "querystring" {
      * The `querystring.stringify()` method produces a URL query string from a
      * given `obj` by iterating through the object's "own properties".
      *
-     * It serializes the following types of values passed in `obj`:[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) |
+     * It serializes the following types of values passed in `obj`: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) |
      * [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) |
      * [bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) |
      * [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) |
@@ -54,7 +66,7 @@ declare module "querystring" {
      * ```
      *
      * By default, characters requiring percent-encoding within the query string will
-     * be encoded as UTF-8\. If an alternative encoding is required, then an alternative`encodeURIComponent` option will need to be specified:
+     * be encoded as UTF-8\. If an alternative encoding is required, then an alternative `encodeURIComponent` option will need to be specified:
      *
      * ```js
      * // Assuming gbkEncodeURIComponent function already exists,
@@ -81,7 +93,7 @@ declare module "querystring" {
      * }
      * ```
      *
-     * The object returned by the `querystring.parse()` method _does not_prototypically inherit from the JavaScript `Object`. This means that typical`Object` methods such as `obj.toString()`,
+     * The object returned by the `querystring.parse()` method _does not_ prototypically inherit from the JavaScript `Object`. This means that typical `Object` methods such as `obj.toString()`,
      * `obj.hasOwnProperty()`, and others
      * are not defined and _will not work_.
      *
@@ -98,7 +110,7 @@ declare module "querystring" {
      * @since v0.1.25
      * @param str The URL query string to parse
      * @param [sep='&'] The substring used to delimit key and value pairs in the query string.
-     * @param [eq='='] . The substring used to delimit keys and values in the query string.
+     * @param [eq='='] The substring used to delimit keys and values in the query string.
      */
     function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): ParsedUrlQuery;
     /**
@@ -110,7 +122,7 @@ declare module "querystring" {
      */
     const decode: typeof parse;
     /**
-     * The `querystring.escape()` method performs URL percent-encoding on the given`str` in a manner that is optimized for the specific requirements of URL
+     * The `querystring.escape()` method performs URL percent-encoding on the given `str` in a manner that is optimized for the specific requirements of URL
      * query strings.
      *
      * The `querystring.escape()` method is used by `querystring.stringify()` and is

package/node_modules/@types/node/readline/promises.d.ts

@@ -6,7 +6,7 @@ declare module "readline/promises" {
     import { AsyncCompleter, Completer, Direction, Interface as _Interface, ReadLineOptions } from "node:readline";
     import { Abortable } from "node:events";
     /**
-     * Instances of the `readlinePromises.Interface` class are constructed using the`readlinePromises.createInterface()` method. Every instance is associated with a
+     * Instances of the `readlinePromises.Interface` class are constructed using the `readlinePromises.createInterface()` method. Every instance is associated with a
      * single `input` `Readable` stream and a single `output` `Writable` stream.
      * The `output` stream is used to print prompts for user input that arrives on,
      * and is read from, the `input` stream.
@@ -15,12 +15,12 @@ declare module "readline/promises" {
     class Interface extends _Interface {
         /**
          * The `rl.question()` method displays the `query` by writing it to the `output`,
-         * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument.
+         * waits for user input to be provided on `input`, then invokes the `callback` function passing the provided input as the first argument.
          *
          * When called, `rl.question()` will resume the `input` stream if it has been
          * paused.
          *
-         * If the `Interface` was created with `output` set to `null` or`undefined` the `query` is not written.
+         * If the `Interface` was created with `output` set to `null` or `undefined` the `query` is not written.
          *
          * If the question is called after `rl.close()`, it returns a rejected promise.
          *
@@ -67,7 +67,7 @@ declare module "readline/promises" {
          * The `rl.clearLine()` method adds to the internal list of pending action an
          * action that clears current line of the associated `stream` in a specified
          * direction identified by `dir`.
-         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
          * @since v17.0.0
          * @return this
          */
@@ -76,20 +76,20 @@ declare module "readline/promises" {
          * The `rl.clearScreenDown()` method adds to the internal list of pending action an
          * action that clears the associated stream from the current position of the
          * cursor down.
-         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
          * @since v17.0.0
          * @return this
          */
         clearScreenDown(): this;
         /**
-         * The `rl.commit()` method sends all the pending actions to the associated`stream` and clears the internal list of pending actions.
+         * The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
          * @since v17.0.0
          */
         commit(): Promise<void>;
         /**
          * The `rl.cursorTo()` method adds to the internal list of pending action an action
          * that moves cursor to the specified position in the associated `stream`.
-         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
          * @since v17.0.0
          * @return this
          */
@@ -98,7 +98,7 @@ declare module "readline/promises" {
          * The `rl.moveCursor()` method adds to the internal list of pending action an
          * action that moves the cursor _relative_ to its current position in the
          * associated `stream`.
-         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`was passed to the constructor.
+         * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
          * @since v17.0.0
          * @return this
          */
@@ -112,7 +112,7 @@ declare module "readline/promises" {
         rollback(): this;
     }
     /**
-     * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface`instance.
+     * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
      *
      * ```js
      * const readlinePromises = require('node:readline/promises');

package/node_modules/@types/node/readline.d.ts

@@ -1,5 +1,6 @@
 /**
- * The `node:readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time.
+ * The `node:readline` module provides an interface for reading data from a [Readable](https://nodejs.org/docs/latest-v22.x/api/stream.html#readable-streams) stream
+ * (such as [`process.stdin`](https://nodejs.org/docs/latest-v22.x/api/process.html#processstdin)) one line at a time.
  *
  * To use the promise-based APIs:
  *
@@ -13,7 +14,7 @@
  * import * as readline from 'node:readline';
  * ```
  *
- * The following simple example illustrates the basic use of the `node:readline`module.
+ * The following simple example illustrates the basic use of the `node:readline` module.
  *
  * ```js
  * import * as readline from 'node:readline/promises';
@@ -28,9 +29,9 @@
  * rl.close();
  * ```
  *
- * Once this code is invoked, the Node.js application will not terminate until the`readline.Interface` is closed because the interface waits for data to be
+ * Once this code is invoked, the Node.js application will not terminate until the `readline.Interface` is closed because the interface waits for data to be
  * received on the `input` stream.
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/readline.js)
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/readline.js)
  */
 declare module "readline" {
     import { Abortable, EventEmitter } from "node:events";
@@ -44,8 +45,8 @@ declare module "readline" {
         shift?: boolean | undefined;
     }
     /**
-     * Instances of the `readline.Interface` class are constructed using the`readline.createInterface()` method. Every instance is associated with a
-     * single `input` `Readable` stream and a single `output` `Writable` stream.
+     * Instances of the `readline.Interface` class are constructed using the `readline.createInterface()` method. Every instance is associated with a
+     * single `input` [Readable](https://nodejs.org/docs/latest-v22.x/api/stream.html#readable-streams) stream and a single `output` [Writable](https://nodejs.org/docs/latest-v22.x/api/stream.html#writable-streams) stream.
      * The `output` stream is used to print prompts for user input that arrives on,
      * and is read from, the `input` stream.
      * @since v0.1.104
@@ -99,7 +100,7 @@ declare module "readline" {
          * > Instances of the `readline.Interface` class are constructed using the
          * > `readline.createInterface()` method.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/readline.html#class-interfaceconstructor
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/readline.html#class-interfaceconstructor
          */
         protected constructor(
             input: NodeJS.ReadableStream,
@@ -113,7 +114,7 @@ declare module "readline" {
          * > Instances of the `readline.Interface` class are constructed using the
          * > `readline.createInterface()` method.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/readline.html#class-interfaceconstructor
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/readline.html#class-interfaceconstructor
          */
         protected constructor(options: ReadLineOptions);
         /**
@@ -123,7 +124,7 @@ declare module "readline" {
          */
         getPrompt(): string;
         /**
-         * The `rl.setPrompt()` method sets the prompt that will be written to `output`whenever `rl.prompt()` is called.
+         * The `rl.setPrompt()` method sets the prompt that will be written to `output` whenever `rl.prompt()` is called.
          * @since v0.1.98
          */
         setPrompt(prompt: string): void;
@@ -134,19 +135,19 @@ declare module "readline" {
          * When called, `rl.prompt()` will resume the `input` stream if it has been
          * paused.
          *
-         * If the `Interface` was created with `output` set to `null` or`undefined` the prompt is not written.
+         * If the `Interface` was created with `output` set to `null` or `undefined` the prompt is not written.
          * @since v0.1.98
          * @param preserveCursor If `true`, prevents the cursor placement from being reset to `0`.
          */
         prompt(preserveCursor?: boolean): void;
         /**
          * The `rl.question()` method displays the `query` by writing it to the `output`,
-         * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument.
+         * waits for user input to be provided on `input`, then invokes the `callback` function passing the provided input as the first argument.
          *
          * When called, `rl.question()` will resume the `input` stream if it has been
          * paused.
          *
-         * If the `Interface` was created with `output` set to `null` or`undefined` the `query` is not written.
+         * If the `Interface` was created with `output` set to `null` or `undefined` the `query` is not written.
          *
          * The `callback` function passed to `rl.question()` does not follow the typical
          * pattern of accepting an `Error` object or `null` as the first argument.
@@ -188,7 +189,7 @@ declare module "readline" {
          * The `rl.pause()` method pauses the `input` stream, allowing it to be resumed
          * later if necessary.
          *
-         * Calling `rl.pause()` does not immediately pause other events (including`'line'`) from being emitted by the `Interface` instance.
+         * Calling `rl.pause()` does not immediately pause other events (including `'line'`) from being emitted by the `Interface` instance.
          * @since v0.3.4
          */
         pause(): this;
@@ -218,7 +219,7 @@ declare module "readline" {
          * When called, `rl.write()` will resume the `input` stream if it has been
          * paused.
          *
-         * If the `Interface` was created with `output` set to `null` or`undefined` the `data` and `key` are not written.
+         * If the `Interface` was created with `output` set to `null` or `undefined` the `data` and `key` are not written.
          *
          * ```js
          * rl.write('Delete this!');
@@ -226,7 +227,7 @@ declare module "readline" {
          * rl.write(null, { ctrl: true, name: 'u' });
          * ```
          *
-         * The `rl.write()` method will write the data to the `readline` `Interface`'s`input`_as if it were provided by the user_.
+         * The `rl.write()` method will write the data to the `readline` `Interface`'s `input` _as if it were provided by the user_.
          * @since v0.1.98
          */
         write(data: string | Buffer, key?: Key): void;
@@ -338,7 +339,7 @@ declare module "readline" {
         tabSize?: number | undefined;
     }
     /**
-     * The `readline.createInterface()` method creates a new `readline.Interface`instance.
+     * The `readline.createInterface()` method creates a new `readline.Interface` instance.
      *
      * ```js
      * const readline = require('node:readline');
@@ -382,7 +383,7 @@ declare module "readline" {
      *
      * If the `stream` is a `TTY`, then it must be in raw mode.
      *
-     * This is automatically called by any readline instance on its `input` if the`input` is a terminal. Closing the `readline` instance does not stop
+     * This is automatically called by any readline instance on its `input` if the `input` is a terminal. Closing the `readline` instance does not stop
      * the `input` from emitting `'keypress'` events.
      *
      * ```js
@@ -467,7 +468,7 @@ declare module "readline" {
      * });
      * ```
      *
-     * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied:
+     * Currently, `for await...of` loop can be a bit slower. If `async` / `await` flow and speed are both essential, a mixed approach can be applied:
      *
      * ```js
      * const { once } = require('node:events');
@@ -502,7 +503,7 @@ declare module "readline" {
         cols: number;
     }
     /**
-     * The `readline.clearLine()` method clears current line of given `TTY` stream
+     * The `readline.clearLine()` method clears current line of given [TTY](https://nodejs.org/docs/latest-v22.x/api/tty.html) stream
      * in a specified direction identified by `dir`.
      * @since v0.7.7
      * @param callback Invoked once the operation completes.
@@ -510,7 +511,7 @@ declare module "readline" {
      */
     export function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
     /**
-     * The `readline.clearScreenDown()` method clears the given `TTY` stream from
+     * The `readline.clearScreenDown()` method clears the given [TTY](https://nodejs.org/docs/latest-v22.x/api/tty.html) stream from
      * the current position of the cursor down.
      * @since v0.7.7
      * @param callback Invoked once the operation completes.
@@ -519,7 +520,7 @@ declare module "readline" {
     export function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
     /**
      * The `readline.cursorTo()` method moves cursor to the specified position in a
-     * given `TTY` `stream`.
+     * given [TTY](https://nodejs.org/docs/latest-v22.x/api/tty.html) `stream`.
      * @since v0.7.7
      * @param callback Invoked once the operation completes.
      * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
@@ -527,7 +528,7 @@ declare module "readline" {
     export function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
     /**
      * The `readline.moveCursor()` method moves the cursor _relative_ to its current
-     * position in a given `TTY` `stream`.
+     * position in a given [TTY](https://nodejs.org/docs/latest-v22.x/api/tty.html) `stream`.
      * @since v0.7.7
      * @param callback Invoked once the operation completes.
      * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.

package/node_modules/@types/node/repl.d.ts

@@ -6,7 +6,7 @@
  * ```js
  * const repl = require('node:repl');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/repl.js)
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/repl.js)
  */
 declare module "repl" {
     import { AsyncCompleter, Completer, Interface } from "node:readline";
@@ -41,8 +41,8 @@ declare module "repl" {
          * error with `repl.Recoverable` to indicate the input was incomplete and prompt for
          * additional lines.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_default_evaluation
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_custom_evaluation_functions
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_default_evaluation
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_custom_evaluation_functions
          */
         eval?: REPLEval | undefined;
         /**
@@ -54,33 +54,33 @@ declare module "repl" {
          * If `true`, specifies that the default `writer` function should include ANSI color
          * styling to REPL output. If a custom `writer` function is provided then this has no
          * effect.
-         * Default: the REPL instance's `terminal` value.
+         * @default the REPL instance's `terminal` value
          */
         useColors?: boolean | undefined;
         /**
          * If `true`, specifies that the default evaluation function will use the JavaScript
          * `global` as the context as opposed to creating a new separate context for the REPL
          * instance. The node CLI REPL sets this value to `true`.
-         * Default: `false`.
+         * @default false
          */
         useGlobal?: boolean | undefined;
         /**
          * If `true`, specifies that the default writer will not output the return value of a
          * command if it evaluates to `undefined`.
-         * Default: `false`.
+         * @default false
          */
         ignoreUndefined?: boolean | undefined;
         /**
          * The function to invoke to format the output of each command before writing to `output`.
-         * Default: a wrapper for `util.inspect`.
+         * @default a wrapper for `util.inspect`
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_customizing_repl_output
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_customizing_repl_output
          */
         writer?: REPLWriter | undefined;
         /**
          * An optional function used for custom Tab auto completion.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/readline.html#readline_use_of_the_completer_function
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/readline.html#readline_use_of_the_completer_function
          */
         completer?: Completer | AsyncCompleter | undefined;
         /**
@@ -95,7 +95,7 @@ declare module "repl" {
         /**
          * Stop evaluating the current piece of code when `SIGINT` is received, i.e. `Ctrl+C` is
          * pressed. This cannot be used together with a custom `eval` function.
-         * Default: `false`.
+         * @default false
          */
         breakEvalOnSigint?: boolean | undefined;
     }
@@ -168,33 +168,33 @@ declare module "repl" {
         /**
          * A value indicating whether the REPL is currently in "editor mode".
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_commands_and_special_keys
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_commands_and_special_keys
          */
         readonly editorMode: boolean;
         /**
          * A value indicating whether the `_` variable has been assigned.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
          */
         readonly underscoreAssigned: boolean;
         /**
          * The last evaluation result from the REPL (assigned to the `_` variable inside of the REPL).
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
          */
         readonly last: any;
         /**
          * A value indicating whether the `_error` variable has been assigned.
          *
          * @since v9.8.0
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
          */
         readonly underscoreErrAssigned: boolean;
         /**
          * The last error raised inside the REPL (assigned to the `_error` variable inside of the REPL).
          *
          * @since v9.8.0
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
          */
         readonly lastError: any;
         /**
@@ -246,12 +246,12 @@ declare module "repl" {
          *
          * `REPLServer` cannot be subclassed due to implementation specifics in NodeJS.
          *
-         * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_class_replserver
+         * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_class_replserver
          */
         private constructor();
         /**
          * The `replServer.defineCommand()` method is used to add new `.`\-prefixed commands
-         * to the REPL instance. Such commands are invoked by typing a `.` followed by the`keyword`. The `cmd` is either a `Function` or an `Object` with the following
+         * to the REPL instance. Such commands are invoked by typing a `.` followed by the `keyword`. The `cmd` is either a `Function` or an `Object` with the following
          * properties:
          *
          * The following example shows two new commands added to the REPL instance:
@@ -289,7 +289,7 @@ declare module "repl" {
         defineCommand(keyword: string, cmd: REPLCommandAction | REPLCommand): void;
         /**
          * The `replServer.displayPrompt()` method readies the REPL instance for input
-         * from the user, printing the configured `prompt` to a new line in the `output`and resuming the `input` to accept new input.
+         * from the user, printing the configured `prompt` to a new line in the `output` and resuming the `input` to accept new input.
          *
          * When multi-line input is being entered, an ellipsis is printed rather than the
          * 'prompt'.
@@ -297,14 +297,14 @@ declare module "repl" {
          * When `preserveCursor` is `true`, the cursor placement will not be reset to `0`.
          *
          * The `replServer.displayPrompt` method is primarily intended to be called from
-         * within the action function for commands registered using the`replServer.defineCommand()` method.
+         * within the action function for commands registered using the `replServer.defineCommand()` method.
          * @since v0.1.91
          */
         displayPrompt(preserveCursor?: boolean): void;
         /**
          * The `replServer.clearBufferedCommand()` method clears any command that has been
          * buffered but not yet executed. This method is primarily intended to be
-         * called from within the action function for commands registered using the`replServer.defineCommand()` method.
+         * called from within the action function for commands registered using the `replServer.defineCommand()` method.
          * @since v9.0.0
          */
         clearBufferedCommand(): void;
@@ -418,7 +418,7 @@ declare module "repl" {
     /**
      * Indicates a recoverable error that a `REPLServer` can use to support multi-line input.
      *
-     * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_recoverable_errors
+     * @see https://nodejs.org/dist/latest-v22.x/docs/api/repl.html#repl_recoverable_errors
      */
     class Recoverable extends SyntaxError {
         err: Error;

package/node_modules/@types/node/sea.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This feature allows the distribution of a Node.js application conveniently to a
+ * system that does not have Node.js installed.
+ *
+ * Node.js supports the creation of [single executable applications](https://github.com/nodejs/single-executable) by allowing
+ * the injection of a blob prepared by Node.js, which can contain a bundled script,
+ * into the `node` binary. During start up, the program checks if anything has been
+ * injected. If the blob is found, it executes the script in the blob. Otherwise
+ * Node.js operates as it normally does.
+ *
+ * The single executable application feature currently only supports running a
+ * single embedded script using the `CommonJS` module system.
+ *
+ * Users can create a single executable application from their bundled script
+ * with the `node` binary itself and any tool which can inject resources into the
+ * binary.
+ *
+ * Here are the steps for creating a single executable application using one such
+ * tool, [postject](https://github.com/nodejs/postject):
+ *
+ * 1. Create a JavaScript file:
+ * ```bash
+ * echo 'console.log(`Hello, ${process.argv[2]}!`);' > hello.js
+ * ```
+ * 2. Create a configuration file building a blob that can be injected into the
+ * single executable application (see `Generating single executable preparation blobs` for details):
+ * ```bash
+ * echo '{ "main": "hello.js", "output": "sea-prep.blob" }' > sea-config.json
+ * ```
+ * 3. Generate the blob to be injected:
+ * ```bash
+ * node --experimental-sea-config sea-config.json
+ * ```
+ * 4. Create a copy of the `node` executable and name it according to your needs:
+ *    * On systems other than Windows:
+ * ```bash
+ * cp $(command -v node) hello
+ * ```
+ *    * On Windows:
+ * ```text
+ * node -e "require('fs').copyFileSync(process.execPath, 'hello.exe')"
+ * ```
+ * The `.exe` extension is necessary.
+ * 5. Remove the signature of the binary (macOS and Windows only):
+ *    * On macOS:
+ * ```bash
+ * codesign --remove-signature hello
+ * ```
+ *    * On Windows (optional):
+ * [signtool](https://learn.microsoft.com/en-us/windows/win32/seccrypto/signtool) can be used from the installed [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/).
+ * If this step is
+ * skipped, ignore any signature-related warning from postject.
+ * ```powershell
+ * signtool remove /s hello.exe
+ * ```
+ * 6. Inject the blob into the copied binary by running `postject` with
+ * the following options:
+ *    * `hello` / `hello.exe` \- The name of the copy of the `node` executable
+ *    created in step 4.
+ *    * `NODE_SEA_BLOB` \- The name of the resource / note / section in the binary
+ *    where the contents of the blob will be stored.
+ *    * `sea-prep.blob` \- The name of the blob created in step 1.
+ *    * `--sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2` \- The [fuse](https://www.electronjs.org/docs/latest/tutorial/fuses) used by the Node.js project to detect if a file has been
+ * injected.
+ *    * `--macho-segment-name NODE_SEA` (only needed on macOS) - The name of the
+ *    segment in the binary where the contents of the blob will be
+ *    stored.
+ * To summarize, here is the required command for each platform:
+ *    * On Linux:
+ *    ```bash
+ *    npx postject hello NODE_SEA_BLOB sea-prep.blob \
+ *        --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2
+ *    ```
+ *    * On Windows - PowerShell:
+ *    ```powershell
+ *    npx postject hello.exe NODE_SEA_BLOB sea-prep.blob `
+ *        --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2
+ *    ```
+ *    * On Windows - Command Prompt:
+ *    ```text
+ *    npx postject hello.exe NODE_SEA_BLOB sea-prep.blob ^
+ *        --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2
+ *    ```
+ *    * On macOS:
+ *    ```bash
+ *    npx postject hello NODE_SEA_BLOB sea-prep.blob \
+ *        --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2 \
+ *        --macho-segment-name NODE_SEA
+ *    ```
+ * 7. Sign the binary (macOS and Windows only):
+ *    * On macOS:
+ * ```bash
+ * codesign --sign - hello
+ * ```
+ *    * On Windows (optional):
+ * A certificate needs to be present for this to work. However, the unsigned
+ * binary would still be runnable.
+ * ```powershell
+ * signtool sign /fd SHA256 hello.exe
+ * ```
+ * 8. Run the binary:
+ *    * On systems other than Windows
+ * ```console
+ * $ ./hello world
+ * Hello, world!
+ * ```
+ *    * On Windows
+ * ```console
+ * $ .\hello.exe world
+ * Hello, world!
+ * ```
+ * @since v19.7.0, v18.16.0
+ * @experimental
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/src/node_sea.cc)
+ */
+declare module "node:sea" {
+    type AssetKey = string;
+    /**
+     * @since v20.12.0
+     * @return Whether this script is running inside a single-executable application.
+     */
+    function isSea(): boolean;
+    /**
+     * This method can be used to retrieve the assets configured to be bundled into the
+     * single-executable application at build time.
+     * An error is thrown when no matching asset can be found.
+     * @since v20.12.0
+     */
+    function getAsset(key: AssetKey): ArrayBuffer;
+    function getAsset(key: AssetKey, encoding: string): string;
+    /**
+     * Similar to `sea.getAsset()`, but returns the result in a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
+     * An error is thrown when no matching asset can be found.
+     * @since v20.12.0
+     */
+    function getAssetAsBlob(key: AssetKey, options?: {
+        type: string;
+    }): Blob;
+    /**
+     * This method can be used to retrieve the assets configured to be bundled into the
+     * single-executable application at build time.
+     * An error is thrown when no matching asset can be found.
+     *
+     * Unlike `sea.getRawAsset()` or `sea.getAssetAsBlob()`, this method does not
+     * return a copy. Instead, it returns the raw asset bundled inside the executable.
+     *
+     * For now, users should avoid writing to the returned array buffer. If the
+     * injected section is not marked as writable or not aligned properly,
+     * writes to the returned array buffer is likely to result in a crash.
+     * @since v20.12.0
+     */
+    function getRawAsset(key: AssetKey): string | ArrayBuffer;
+}

package/node_modules/@types/node/stream/web.d.ts

@@ -156,6 +156,7 @@ declare module "stream/web" {
     }
     const ReadableStream: {
         prototype: ReadableStream;
+        from<T>(iterable: Iterable<T> | AsyncIterable<T>): ReadableStream<T>;
         new(underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>;
         new<R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
     };
@@ -350,7 +351,7 @@ declare module "stream/web" {
     }
     const CompressionStream: {
         prototype: CompressionStream;
-        new<R = any, W = any>(format: string): CompressionStream<R, W>;
+        new<R = any, W = any>(format: "deflate" | "deflate-raw" | "gzip"): CompressionStream<R, W>;
     };
     interface DecompressionStream<R = any, W = any> {
         readonly readable: ReadableStream<R>;
@@ -358,7 +359,7 @@ declare module "stream/web" {
     }
     const DecompressionStream: {
         prototype: DecompressionStream;
-        new<R = any, W = any>(format: string): DecompressionStream<R, W>;
+        new<R = any, W = any>(format: "deflate" | "deflate-raw" | "gzip"): DecompressionStream<R, W>;
     };
 }
 declare module "node:stream/web" {