@nemtus/symbol-rest-api-client-fetch 1.0.0 → 1.0.2

package/esm/api/models/VrfKeyLinkTransactionDTO.d.ts

@@ -21,11 +21,9 @@ import type { LinkActionEnum } from './LinkActionEnum';
  */
 export interface VrfKeyLinkTransactionDTO {
     /**
-     * Unsigned 32-bit integer.
-     * Represented as integer since it fits in JSON number precision.
+     * Total size of the serialized entity in bytes. Includes the full binary payload,
+     * including the 4-byte size field itself.
      *
-     * @type {number}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     size: number;
     /**
@@ -33,77 +31,47 @@ export interface VrfKeyLinkTransactionDTO {
      * over the serialized entity payload. Can be verified with the signer's public key (`signerPublicKey`).
      * Used for blocks, transactions, and cosignatures.
      *
-     * @type {string}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     signature: string;
     /**
-     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
-     * @type {string}
-     * @memberof VrfKeyLinkTransactionDTO
+     * Public key of the account that signed the entity (e.g. block harvester, transaction signer).
      */
     signerPublicKey: string;
     /**
      * Entity version. Indicates the schema variant for serialization and validation.
-     * @type {number}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     version: number;
     /**
      * Network type (mainnet or testnet). Ensures the entity targets the correct network.
-     * @type {NetworkTypeEnum}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     network: NetworkTypeEnum;
     /**
      * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema.
-     * @type {number}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     type: number;
     /**
-     * Absolute amount expressed in the mosaic's smallest (atomic) unit, with no decimal point.
-     * For example, an amount of `123456789` for a mosaic with divisibility 6 represents
-     * `123.456789` whole units. Encoded as a string to preserve precision, since the value
-     * is an unsigned 64-bit integer.
-     *
-     * @type {string}
-     * @memberof VrfKeyLinkTransactionDTO
+     * Maximum fee the signer is willing to pay for this transaction, in smallest (atomic) units.
      */
     maxFee: string;
     /**
-     * Network timestamp in **milliseconds** since the creation of the nemesis (first) block.
-     * Used for block timestamps, transaction deadlines, and time synchronization.
-     *
-     * **Finding the nemesis block time:** The `epochAdjustment` field returned by the
-     * [`/network/properties`] endpoint gives the nemesis block creation time in seconds since the
-     * [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). For Symbol MAINNET this is
-     * always `1615853185` (15 March 2021, 00:06:25 UTC).
-     *
-     * **Converting to real time:** Add this timestamp (ms) to `epochAdjustment × 1000` (ms), then use standard date functions.
-     * Note: `epochAdjustment` may be returned as a string like `"1615853185s"`; use the numeric part.
+     * Latest network time at which the transaction can still be included in a block, expressed in milliseconds
+     * since the creation of the nemesis (first) block.
      *
-     * @type {string}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     deadline: string;
     /**
      * 256-bit public key encoded as a hexadecimal string (64 hex characters).
-     * @type {string}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     linkedPublicKey: string;
     /**
      *
-     * @type {LinkActionEnum}
-     * @memberof VrfKeyLinkTransactionDTO
      */
     linkAction: LinkActionEnum;
 }
 /**
  * Check if a given object implements the VrfKeyLinkTransactionDTO interface.
  */
-export declare function instanceOfVrfKeyLinkTransactionDTO(value: Record<string, any>): value is VrfKeyLinkTransactionDTO;
+export declare function instanceOfVrfKeyLinkTransactionDTO(value: object): value is VrfKeyLinkTransactionDTO;
 export declare function VrfKeyLinkTransactionDTOFromJSON(json: any): VrfKeyLinkTransactionDTO;
 export declare function VrfKeyLinkTransactionDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): VrfKeyLinkTransactionDTO;
 export declare function VrfKeyLinkTransactionDTOToJSON(json: any): VrfKeyLinkTransactionDTO;

package/esm/api/runtime.d.ts

@@ -124,9 +124,21 @@ export interface RequestOpts {
 }
 export declare function querystring(params: HTTPQuery, prefix?: string): string;
 export declare function exists(json: any, key: string): boolean;
+/**
+ * Every generated date call site routes through these.
+ *
+ * `format: date` is a calendar date, with no time and no offset, so it is converted
+ * against the local calendar on both ends: they have to agree or the date shifts by
+ * a day. `format: date-time` is an instant and uses UTC.
+ */
+export declare function serializeDateTime(value: Date): string;
+export declare function serializeDate(value: Date): string;
+export declare function parseDate(value: Date | string): Date;
+export declare function parseDateTime(value: any): Date;
 export declare function mapValues(data: any, fn: (item: any) => any): {
     [key: string]: any;
 };
+export declare function anyToJSON(value: any): any;
 export declare function canConsumeForm(consumes: Consume[]): boolean;
 export interface Consume {
     contentType: string;
@@ -172,11 +184,32 @@ export declare class VoidApiResponse {
     constructor(raw: Response);
     value(): Promise<void>;
 }
+/**
+ * A Blob carrying the file name the server advertised, empty when it did not send one. It is a File
+ * wherever one can be built, and the bare Blob given a name otherwise. Same name and shape as the
+ * `typescript` generator's browser HttpFile.
+ */
+export type HttpFile = Blob & {
+    readonly name: string;
+};
 export declare class BlobApiResponse {
     raw: Response;
     constructor(raw: Response);
-    value(): Promise<Blob>;
+    /**
+     * The body named after the Content-Disposition header, so that a download keeps the name the
+     * server gave it. A File is built from a native Blob; the Blob itself is named where there is no
+     * global File (Node.js before 20), where File cannot be constructed, or where the Blob is not the
+     * native one, as returned by an injected fetch implementation such as node-fetch, which a File
+     * would stringify instead of wrapping.
+     */
+    value(): Promise<HttpFile>;
 }
+/**
+ * The file name advertised by a Content-Disposition header (RFC 6266): the RFC 5987 encoded
+ * `filename*` parameter first, falling back to the plain `filename` when it is malformed, not UTF-8
+ * or has no usable name. Any directory part is dropped; undefined when no usable name is advertised.
+ */
+export declare function parseContentDispositionFilename(headers: Headers): string | undefined;
 export declare class TextApiResponse {
     raw: Response;
     constructor(raw: Response);

package/esm/api/runtime.js

@@ -65,7 +65,7 @@ export const DefaultConfig = new Configuration();
  */
 export class BaseAPI {
     configuration;
-    static jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+    static jsonRegex = /^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$/i;
     middleware;
     constructor(configuration = DefaultConfig) {
         this.configuration = configuration;
@@ -223,6 +223,11 @@ export class ResponseError extends Error {
     constructor(response, msg) {
         super(msg);
         this.response = response;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export class FetchError extends Error {
@@ -231,6 +236,11 @@ export class FetchError extends Error {
     constructor(cause, msg) {
         super(msg);
         this.cause = cause;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export class RequiredError extends Error {
@@ -239,6 +249,11 @@ export class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
         this.field = field;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 export const COLLECTION_FORMATS = {
@@ -265,7 +280,7 @@ function querystringSingleKey(key, value, keyPrefix = '') {
         return querystringSingleKey(key, valueAsArray, keyPrefix);
     }
     if (value instanceof Date) {
-        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(serializeDateTime(value))}`;
     }
     if (value instanceof Object) {
         return querystring(value, fullKey);
@@ -276,6 +291,52 @@ export function exists(json, key) {
     const value = json[key];
     return value !== null && value !== undefined;
 }
+/**
+ * Every generated date call site routes through these.
+ *
+ * `format: date` is a calendar date, with no time and no offset, so it is converted
+ * against the local calendar on both ends: they have to agree or the date shifts by
+ * a day. `format: date-time` is an instant and uses UTC.
+ */
+export function serializeDateTime(value) {
+    return value.toISOString();
+}
+export function serializeDate(value) {
+    if (isNaN(value.getTime())) {
+        throw new RangeError('Invalid time value');
+    }
+    const year = ('000' + value.getFullYear()).slice(-4);
+    const month = ('0' + (value.getMonth() + 1)).slice(-2);
+    const day = ('0' + value.getDate()).slice(-2);
+    return `${year}-${month}-${day}`;
+}
+export function parseDate(value) {
+    if (value instanceof Date) {
+        return value;
+    }
+    // `new Date("2026-08-05")` would parse as UTC midnight: a different day west of UTC.
+    // Local midnight is the stated day everywhere. setFullYear avoids the 1900 offset the
+    // multi-argument constructor applies to years 0-99.
+    const fullDate = /^(\d{4})-(\d{2})-(\d{2})$/.exec(String(value));
+    if (fullDate) {
+        const year = Number(fullDate[1]);
+        const month = Number(fullDate[2]) - 1;
+        const day = Number(fullDate[3]);
+        const date = new Date(0);
+        date.setFullYear(year, month, day);
+        date.setHours(0, 0, 0, 0);
+        // Out-of-range components (or a day the local zone skipped) silently roll over,
+        // which would hand back a date the server never sent.
+        if (date.getFullYear() !== year || date.getMonth() !== month || date.getDate() !== day) {
+            return new Date(NaN);
+        }
+        return date;
+    }
+    return new Date(value);
+}
+export function parseDateTime(value) {
+    return new Date(value);
+}
 export function mapValues(data, fn) {
     const result = {};
     for (const key of Object.keys(data)) {
@@ -283,9 +344,13 @@ export function mapValues(data, fn) {
     }
     return result;
 }
+// Pass-through serializer for `any`-typed properties in form data. See #1877.
+export function anyToJSON(value) {
+    return value;
+}
 export function canConsumeForm(consumes) {
     for (const consume of consumes) {
-        if ('multipart/form-data' === consume.contentType) {
+        if (consume.contentType?.startsWith('multipart/form-data') == true) {
             return true;
         }
     }
@@ -316,11 +381,69 @@ export class BlobApiResponse {
     constructor(raw) {
         this.raw = raw;
     }
+    /**
+     * The body named after the Content-Disposition header, so that a download keeps the name the
+     * server gave it. A File is built from a native Blob; the Blob itself is named where there is no
+     * global File (Node.js before 20), where File cannot be constructed, or where the Blob is not the
+     * native one, as returned by an injected fetch implementation such as node-fetch, which a File
+     * would stringify instead of wrapping.
+     */
     async value() {
-        return await this.raw.blob();
+        const blob = await this.raw.blob();
+        const name = parseContentDispositionFilename(this.raw.headers) ?? '';
+        if (typeof File !== 'undefined' && blob instanceof Blob) {
+            try {
+                return new File([blob], name, { type: blob.type });
+            }
+            catch {
+                // File cannot be constructed: name the Blob itself
+            }
+        }
+        return Object.assign(blob, { name });
     }
     ;
 }
+/**
+ * The file name advertised by a Content-Disposition header (RFC 6266): the RFC 5987 encoded
+ * `filename*` parameter first, falling back to the plain `filename` when it is malformed, not UTF-8
+ * or has no usable name. Any directory part is dropped; undefined when no usable name is advertised.
+ */
+export function parseContentDispositionFilename(headers) {
+    const params = parseHeaderParameters(headers.get('Content-Disposition') ?? '');
+    return basename(decodeExtValue(params.get('filename*'))) ?? basename(params.get('filename'));
+}
+/** The decoded RFC 5987 ext-value, or undefined when it is not UTF-8 or its percent-encoding is malformed. */
+function decodeExtValue(value) {
+    const match = value === undefined ? null : /^utf-8'[^']*'(.*)$/i.exec(value);
+    try {
+        return match ? decodeURIComponent(match[1]) : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * The `name=value` parameters of a header value, consumed one at a time so that a quoted-string is
+ * taken whole, `;` included. Names are lower-cased, quoted-string values are unquoted with their
+ * backslash escapes resolved, and the first occurrence of a name wins.
+ */
+function parseHeaderParameters(value) {
+    const params = new Map();
+    const parameter = /(?:^|;)\s*([^=;]+?)\s*=\s*(?:"((?:[^"\\]|\\.)*)"?|([^;]*))/g;
+    let match;
+    while ((match = parameter.exec(value)) !== null) {
+        const name = match[1].toLowerCase();
+        if (!params.has(name)) {
+            params.set(name, match[2] !== undefined ? match[2].replace(/\\(.)/g, '$1') : match[3].trim());
+        }
+    }
+    return params;
+}
+/** The last `/` or `\` separated segment of a file name, or undefined when it is not a file name. */
+function basename(name) {
+    const base = name?.split(/[\\/]/).pop();
+    return !base || base === '.' || base === '..' ? undefined : base;
+}
 export class TextApiResponse {
     raw;
     constructor(raw) {