@atomiqlabs/sdk 8.9.0 → 8.9.2

package/dist/api/ApiEndpoints.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/ApiParser.d.ts

@@ -1,10 +1,10 @@
-import { InputSchema } from "./ApiTypes";
-/**
- * Parses raw input values according to the endpoint schema.
- *
- * This accepts untyped transport input such as HTTP query params, JSON request bodies,
- * or CLI arguments and returns the normalized callback input type.
- *
- * @category API
- */
-export declare function parseApiInput<TInput>(inputSchema: InputSchema<TInput>, rawInput: unknown): TInput;
+import { InputSchema } from "./ApiTypes";
+/**
+ * Parses raw input values according to the endpoint schema.
+ *
+ * This accepts untyped transport input such as HTTP query params, JSON request bodies,
+ * or CLI arguments and returns the normalized callback input type.
+ *
+ * @category API
+ */
+export declare function parseApiInput<TInput>(inputSchema: InputSchema<TInput>, rawInput: unknown): TInput;

package/dist/api/ApiParser.js

@@ -1,134 +1,134 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseApiInput = void 0;
-// Errors
-function invalidInput(path, expected, value) {
-    const actualType = value == null ? String(value) : Array.isArray(value) ? "array" : typeof (value);
-    return new Error(`Invalid input "${path}", expected ${expected}, got ${actualType}`);
-}
-function missingInput(path) {
-    return new Error(`Missing required input "${path}"`);
-}
-function invalidAllowedValue(path, allowedValues, value) {
-    return new Error(`Invalid input "${path}", expected one of: ${allowedValues.map(val => val.toString()).join(", ")}, got ${value.toString()}`);
-}
-// Parsers
-function parseNumber(path, value) {
-    let result;
-    if (typeof (value) === "number") {
-        result = value;
-    }
-    else if (typeof (value) === "string") {
-        const trimmedValue = value.trim();
-        if (trimmedValue === "")
-            throw invalidInput(path, "finite number", value);
-        result = Number(trimmedValue);
-    }
-    else
-        throw invalidInput(path, "finite number", value);
-    if (!Number.isFinite(result))
-        throw invalidInput(path, "finite number", value);
-    return result;
-}
-function parseBigInt(path, value) {
-    if (typeof (value) === "bigint")
-        return value;
-    if (typeof (value) === "number") {
-        if (!Number.isSafeInteger(value))
-            throw invalidInput(path, "safe integer", value);
-        return BigInt(value);
-    }
-    if (typeof (value) === "string") {
-        const trimmedValue = value.trim();
-        if (!/^[+-]?\d+$/.test(trimmedValue))
-            throw invalidInput(path, "integer", value);
-        return BigInt(trimmedValue);
-    }
-    throw invalidInput(path, "integer", value);
-}
-function parseBoolean(path, value) {
-    Boolean(value);
-    if (typeof (value) === "boolean")
-        return value;
-    if (value === "true")
-        return true;
-    if (value === "false")
-        return false;
-    throw invalidInput(path, "boolean", value);
-}
-// Object type check
-function isObject(value) {
-    return value != null && typeof (value) === "object" && !Array.isArray(value);
-}
-// Allowed values for enums
-function applyAllowedValues(path, value, allowedValues) {
-    if (allowedValues != null && !allowedValues.includes(value)) {
-        throw invalidAllowedValue(path, allowedValues, value);
-    }
-    return value;
-}
-function parseField(field, value, path) {
-    switch (field.type) {
-        case "string": {
-            if (typeof (value) !== "string")
-                throw invalidInput(path, "string", value);
-            return applyAllowedValues(path, value, field.allowedValues);
-        }
-        case "number": {
-            const parsedValue = parseNumber(path, value);
-            return applyAllowedValues(path, parsedValue, field.allowedValues);
-        }
-        case "bigint": {
-            const parsedValue = parseBigInt(path, value);
-            return applyAllowedValues(path, parsedValue, field.allowedValues);
-        }
-        case "boolean":
-            return parseBoolean(path, value);
-        case "array": {
-            if (!Array.isArray(value))
-                throw invalidInput(path, "array", value);
-            if (field.items == null)
-                return [...value];
-            return value.map((item, index) => parseField(field.items, item, `${path}[${index}]`));
-        }
-        case "object": {
-            if (!isObject(value))
-                throw invalidInput(path, "object", value);
-            if (field.properties == null)
-                return { ...value };
-            return _parseApiInput(field.properties, value, path);
-        }
-        default:
-            throw new Error(`Unsupported input schema type for "${path}": ${field.type}`);
-    }
-}
-function _parseApiInput(inputSchema, rawInput, parentPath = "") {
-    if (!isObject(rawInput)) {
-        throw invalidInput(parentPath || "input", "object", rawInput);
-    }
-    const parsedInput = {};
-    for (const key in inputSchema) {
-        const field = inputSchema[key];
-        const value = rawInput[key];
-        const path = parentPath === "" ? key : `${parentPath}.${key}`;
-        if (value == null) {
-            if (field.required)
-                throw missingInput(path);
-            continue;
-        }
-        parsedInput[key] = parseField(field, value, path);
-    }
-    return parsedInput;
-}
-/**
- * Parses raw input values according to the endpoint schema.
- *
- * This accepts untyped transport input such as HTTP query params, JSON request bodies,
- * or CLI arguments and returns the normalized callback input type.
- *
- * @category API
- */
-function parseApiInput(inputSchema, rawInput) {
-    return _parseApiInput(inputSchema, rawInput);
-}
-exports.parseApiInput = parseApiInput;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseApiInput = void 0;
+// Errors
+function invalidInput(path, expected, value) {
+    const actualType = value == null ? String(value) : Array.isArray(value) ? "array" : typeof (value);
+    return new Error(`Invalid input "${path}", expected ${expected}, got ${actualType}`);
+}
+function missingInput(path) {
+    return new Error(`Missing required input "${path}"`);
+}
+function invalidAllowedValue(path, allowedValues, value) {
+    return new Error(`Invalid input "${path}", expected one of: ${allowedValues.map(val => val.toString()).join(", ")}, got ${value.toString()}`);
+}
+// Parsers
+function parseNumber(path, value) {
+    let result;
+    if (typeof (value) === "number") {
+        result = value;
+    }
+    else if (typeof (value) === "string") {
+        const trimmedValue = value.trim();
+        if (trimmedValue === "")
+            throw invalidInput(path, "finite number", value);
+        result = Number(trimmedValue);
+    }
+    else
+        throw invalidInput(path, "finite number", value);
+    if (!Number.isFinite(result))
+        throw invalidInput(path, "finite number", value);
+    return result;
+}
+function parseBigInt(path, value) {
+    if (typeof (value) === "bigint")
+        return value;
+    if (typeof (value) === "number") {
+        if (!Number.isSafeInteger(value))
+            throw invalidInput(path, "safe integer", value);
+        return BigInt(value);
+    }
+    if (typeof (value) === "string") {
+        const trimmedValue = value.trim();
+        if (!/^[+-]?\d+$/.test(trimmedValue))
+            throw invalidInput(path, "integer", value);
+        return BigInt(trimmedValue);
+    }
+    throw invalidInput(path, "integer", value);
+}
+function parseBoolean(path, value) {
+    Boolean(value);
+    if (typeof (value) === "boolean")
+        return value;
+    if (value === "true")
+        return true;
+    if (value === "false")
+        return false;
+    throw invalidInput(path, "boolean", value);
+}
+// Object type check
+function isObject(value) {
+    return value != null && typeof (value) === "object" && !Array.isArray(value);
+}
+// Allowed values for enums
+function applyAllowedValues(path, value, allowedValues) {
+    if (allowedValues != null && !allowedValues.includes(value)) {
+        throw invalidAllowedValue(path, allowedValues, value);
+    }
+    return value;
+}
+function parseField(field, value, path) {
+    switch (field.type) {
+        case "string": {
+            if (typeof (value) !== "string")
+                throw invalidInput(path, "string", value);
+            return applyAllowedValues(path, value, field.allowedValues);
+        }
+        case "number": {
+            const parsedValue = parseNumber(path, value);
+            return applyAllowedValues(path, parsedValue, field.allowedValues);
+        }
+        case "bigint": {
+            const parsedValue = parseBigInt(path, value);
+            return applyAllowedValues(path, parsedValue, field.allowedValues);
+        }
+        case "boolean":
+            return parseBoolean(path, value);
+        case "array": {
+            if (!Array.isArray(value))
+                throw invalidInput(path, "array", value);
+            if (field.items == null)
+                return [...value];
+            return value.map((item, index) => parseField(field.items, item, `${path}[${index}]`));
+        }
+        case "object": {
+            if (!isObject(value))
+                throw invalidInput(path, "object", value);
+            if (field.properties == null)
+                return { ...value };
+            return _parseApiInput(field.properties, value, path);
+        }
+        default:
+            throw new Error(`Unsupported input schema type for "${path}": ${field.type}`);
+    }
+}
+function _parseApiInput(inputSchema, rawInput, parentPath = "") {
+    if (!isObject(rawInput)) {
+        throw invalidInput(parentPath || "input", "object", rawInput);
+    }
+    const parsedInput = {};
+    for (const key in inputSchema) {
+        const field = inputSchema[key];
+        const value = rawInput[key];
+        const path = parentPath === "" ? key : `${parentPath}.${key}`;
+        if (value == null) {
+            if (field.required)
+                throw missingInput(path);
+            continue;
+        }
+        parsedInput[key] = parseField(field, value, path);
+    }
+    return parsedInput;
+}
+/**
+ * Parses raw input values according to the endpoint schema.
+ *
+ * This accepts untyped transport input such as HTTP query params, JSON request bodies,
+ * or CLI arguments and returns the normalized callback input type.
+ *
+ * @category API
+ */
+function parseApiInput(inputSchema, rawInput) {
+    return _parseApiInput(inputSchema, rawInput);
+}
+exports.parseApiInput = parseApiInput;

package/dist/api/ApiTypes.d.ts

@@ -1,157 +1,157 @@
-import { Token } from "../types/Token";
-import { TokenAmount } from "../types/TokenAmount";
-import { LNURLPay, LNURLPayParamsWithUrl } from "../types/lnurl/LNURLPay";
-import { LNURLWithdraw, LNURLWithdrawParamsWithUrl } from "../types/lnurl/LNURLWithdraw";
-import { Swapper } from "../swapper/Swapper";
-/**
- * Unified amount type for all API responses
- *
- * @category API
- */
-export type ApiAmount = {
-    /** Decimal format of the amount, e.g. "1.5" */
-    amount: string;
-    /** Raw base units as string, e.g. "1500000000000000000" */
-    rawAmount: string;
-    /** Token decimals, e.g. 18 */
-    decimals: number;
-    /** Token ticker, e.g. "STRK" */
-    symbol: string;
-    /** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
-    chain: string;
-};
-/**
- * Serializable token representation for API responses
- *
- * @category API
- */
-export type ApiToken = {
-    /** Canonical token identifier accepted by the API, e.g. "BITCOIN-BTC", "LIGHTNING-BTC", "STARKNET-STRK" */
-    id: string;
-    /** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
-    chainId: string;
-    /** Token ticker, e.g. "STRK" */
-    ticker: string;
-    /** Full token name */
-    name: string;
-    /** Decimal places of the token */
-    decimals: number;
-    /** Token contract address, or empty string for BTC on Bitcoin/Lightning */
-    address: string;
-};
-/**
- * Serializable LNURL-pay representation for API responses
- *
- * @category API
- */
-export type ApiLNURLPay = {
-    /** Marks the LNURL payload as an LNURL-pay response. */
-    type: "pay";
-    /** Minimum payable amount supported by the LNURL-pay endpoint. */
-    min: ApiAmount;
-    /** Maximum payable amount supported by the LNURL-pay endpoint. */
-    max: ApiAmount;
-    /** Maximum comment length accepted by the LNURL-pay endpoint. */
-    commentMaxLength: number;
-    /** Short human-readable description of the payee, when provided by the LNURL service. */
-    shortDescription?: string;
-    /** Longer human-readable description of the payee, when provided by the LNURL service. */
-    longDescription?: string;
-    /** Optional icon for the payee, usually encoded as a data URL. */
-    icon?: string;
-    /** Raw LNURL-pay metadata and callback parameters. */
-    params: LNURLPayParamsWithUrl;
-};
-/**
- * Serializable LNURL-withdraw representation for API responses
- *
- * @category API
- */
-export type ApiLNURLWithdraw = {
-    /** Marks the LNURL payload as an LNURL-withdraw response. */
-    type: "withdraw";
-    /** Minimum withdrawable amount supported by the LNURL-withdraw endpoint. */
-    min: ApiAmount;
-    /** Maximum withdrawable amount supported by the LNURL-withdraw endpoint. */
-    max: ApiAmount;
-    /** Raw LNURL-withdraw metadata and callback parameters. */
-    params: LNURLWithdrawParamsWithUrl;
-};
-/**
- * Serializable LNURL representation for API responses
- *
- * @category API
- */
-export type ApiLNURL = ApiLNURLPay | ApiLNURLWithdraw;
-/**
- * Converts a TokenAmount to the serializable ApiAmount format
- *
- * @category API
- */
-export declare function toApiAmount(tokenAmount: TokenAmount): ApiAmount;
-/**
- * Converts a Token to the serializable ApiToken format
- *
- * @category API
- */
-export declare function toApiToken(token: Token): ApiToken;
-/**
- * Converts LNURL data to the serializable API format
- *
- * @category API
- */
-export declare function toApiLNURL(lnurl: LNURLPay | LNURLWithdraw, swapper: Swapper<any>): ApiLNURL;
-/**
- * Maps a TypeScript type to its schema type string representation
- *
- * @category API
- */
-type TypeToSchemaType<T> = NonNullable<T> extends string ? "string" : NonNullable<T> extends number ? "number" : NonNullable<T> extends bigint ? "bigint" : NonNullable<T> extends boolean ? "boolean" : NonNullable<T> extends any[] ? "array" : "object";
-/**
- * Schema definition for a single API input field.
- *
- * @category API
- */
-export type InputSchemaField<T = unknown> = {
-    /** Primitive schema type inferred from the TypeScript field type. */
-    type: TypeToSchemaType<T>;
-    /** Whether the field is required by the endpoint input parser. */
-    required: boolean;
-    /** Human-readable description of the field exposed by the API schema. */
-    description: string;
-    /** Nested schema properties for object-like fields. */
-    properties?: T extends readonly any[] ? never : T extends object ? {
-        [K in keyof T]-?: InputSchemaField<T[K]>;
-    } : never;
-    /** Schema definition for array items when the field is an array. */
-    items?: T extends readonly (infer U)[] ? InputSchemaField<U> : never;
-    /** Enumerated allowed values for string, number, or bigint fields when constrained. */
-    allowedValues?: NonNullable<T> extends string | number | bigint ? NonNullable<T>[] : never;
-};
-/**
- * Schema definition describing the accepted input shape for an API endpoint.
- *
- * @category API
- */
-export type InputSchema<TInput> = {
-    [K in keyof TInput]-?: InputSchemaField<TInput[K]>;
-};
-/**
- * Typed API endpoint definition for framework-agnostic integration
- *
- * @category API
- */
-export type ApiEndpoint<TInput, TOutput, Type extends "GET" | "POST"> = {
-    /** HTTP method used by the endpoint. */
-    type: Type;
-    /** Human-readable description of what this endpoint does, written for AI agent consumption. */
-    description: string;
-    /** Structured schema describing the accepted input payload. */
-    inputSchema: InputSchema<TInput>;
-    /** Typed endpoint implementation that receives already-validated input. */
-    callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>;
-    /** Raw endpoint implementation that parses unknown input into the typed callback. */
-    callbackRaw: (input: unknown, abortSignal?: AbortSignal) => Promise<TOutput>;
-};
-export declare function createApiEndpoint<TInput, TOutput, Type extends "GET" | "POST">(type: Type, description: string, callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>, inputSchema: InputSchema<TInput>): ApiEndpoint<TInput, TOutput, Type>;
-export {};
+import { Token } from "../types/Token";
+import { TokenAmount } from "../types/TokenAmount";
+import { LNURLPay, LNURLPayParamsWithUrl } from "../types/lnurl/LNURLPay";
+import { LNURLWithdraw, LNURLWithdrawParamsWithUrl } from "../types/lnurl/LNURLWithdraw";
+import { Swapper } from "../swapper/Swapper";
+/**
+ * Unified amount type for all API responses
+ *
+ * @category API
+ */
+export type ApiAmount = {
+    /** Decimal format of the amount, e.g. "1.5" */
+    amount: string;
+    /** Raw base units as string, e.g. "1500000000000000000" */
+    rawAmount: string;
+    /** Token decimals, e.g. 18 */
+    decimals: number;
+    /** Token ticker, e.g. "STRK" */
+    symbol: string;
+    /** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
+    chain: string;
+};
+/**
+ * Serializable token representation for API responses
+ *
+ * @category API
+ */
+export type ApiToken = {
+    /** Canonical token identifier accepted by the API, e.g. "BITCOIN-BTC", "LIGHTNING-BTC", "STARKNET-STRK" */
+    id: string;
+    /** Chain identifier, e.g. "STARKNET", "BITCOIN", "LIGHTNING" */
+    chainId: string;
+    /** Token ticker, e.g. "STRK" */
+    ticker: string;
+    /** Full token name */
+    name: string;
+    /** Decimal places of the token */
+    decimals: number;
+    /** Token contract address, or empty string for BTC on Bitcoin/Lightning */
+    address: string;
+};
+/**
+ * Serializable LNURL-pay representation for API responses
+ *
+ * @category API
+ */
+export type ApiLNURLPay = {
+    /** Marks the LNURL payload as an LNURL-pay response. */
+    type: "pay";
+    /** Minimum payable amount supported by the LNURL-pay endpoint. */
+    min: ApiAmount;
+    /** Maximum payable amount supported by the LNURL-pay endpoint. */
+    max: ApiAmount;
+    /** Maximum comment length accepted by the LNURL-pay endpoint. */
+    commentMaxLength: number;
+    /** Short human-readable description of the payee, when provided by the LNURL service. */
+    shortDescription?: string;
+    /** Longer human-readable description of the payee, when provided by the LNURL service. */
+    longDescription?: string;
+    /** Optional icon for the payee, usually encoded as a data URL. */
+    icon?: string;
+    /** Raw LNURL-pay metadata and callback parameters. */
+    params: LNURLPayParamsWithUrl;
+};
+/**
+ * Serializable LNURL-withdraw representation for API responses
+ *
+ * @category API
+ */
+export type ApiLNURLWithdraw = {
+    /** Marks the LNURL payload as an LNURL-withdraw response. */
+    type: "withdraw";
+    /** Minimum withdrawable amount supported by the LNURL-withdraw endpoint. */
+    min: ApiAmount;
+    /** Maximum withdrawable amount supported by the LNURL-withdraw endpoint. */
+    max: ApiAmount;
+    /** Raw LNURL-withdraw metadata and callback parameters. */
+    params: LNURLWithdrawParamsWithUrl;
+};
+/**
+ * Serializable LNURL representation for API responses
+ *
+ * @category API
+ */
+export type ApiLNURL = ApiLNURLPay | ApiLNURLWithdraw;
+/**
+ * Converts a TokenAmount to the serializable ApiAmount format
+ *
+ * @category API
+ */
+export declare function toApiAmount(tokenAmount: TokenAmount): ApiAmount;
+/**
+ * Converts a Token to the serializable ApiToken format
+ *
+ * @category API
+ */
+export declare function toApiToken(token: Token): ApiToken;
+/**
+ * Converts LNURL data to the serializable API format
+ *
+ * @category API
+ */
+export declare function toApiLNURL(lnurl: LNURLPay | LNURLWithdraw, swapper: Swapper<any>): ApiLNURL;
+/**
+ * Maps a TypeScript type to its schema type string representation
+ *
+ * @category API
+ */
+type TypeToSchemaType<T> = NonNullable<T> extends string ? "string" : NonNullable<T> extends number ? "number" : NonNullable<T> extends bigint ? "bigint" : NonNullable<T> extends boolean ? "boolean" : NonNullable<T> extends any[] ? "array" : "object";
+/**
+ * Schema definition for a single API input field.
+ *
+ * @category API
+ */
+export type InputSchemaField<T = unknown> = {
+    /** Primitive schema type inferred from the TypeScript field type. */
+    type: TypeToSchemaType<T>;
+    /** Whether the field is required by the endpoint input parser. */
+    required: boolean;
+    /** Human-readable description of the field exposed by the API schema. */
+    description: string;
+    /** Nested schema properties for object-like fields. */
+    properties?: T extends readonly any[] ? never : T extends object ? {
+        [K in keyof T]-?: InputSchemaField<T[K]>;
+    } : never;
+    /** Schema definition for array items when the field is an array. */
+    items?: T extends readonly (infer U)[] ? InputSchemaField<U> : never;
+    /** Enumerated allowed values for string, number, or bigint fields when constrained. */
+    allowedValues?: NonNullable<T> extends string | number | bigint ? NonNullable<T>[] : never;
+};
+/**
+ * Schema definition describing the accepted input shape for an API endpoint.
+ *
+ * @category API
+ */
+export type InputSchema<TInput> = {
+    [K in keyof TInput]-?: InputSchemaField<TInput[K]>;
+};
+/**
+ * Typed API endpoint definition for framework-agnostic integration
+ *
+ * @category API
+ */
+export type ApiEndpoint<TInput, TOutput, Type extends "GET" | "POST"> = {
+    /** HTTP method used by the endpoint. */
+    type: Type;
+    /** Human-readable description of what this endpoint does, written for AI agent consumption. */
+    description: string;
+    /** Structured schema describing the accepted input payload. */
+    inputSchema: InputSchema<TInput>;
+    /** Typed endpoint implementation that receives already-validated input. */
+    callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>;
+    /** Raw endpoint implementation that parses unknown input into the typed callback. */
+    callbackRaw: (input: unknown, abortSignal?: AbortSignal) => Promise<TOutput>;
+};
+export declare function createApiEndpoint<TInput, TOutput, Type extends "GET" | "POST">(type: Type, description: string, callback: (input: TInput, abortSignal?: AbortSignal) => Promise<TOutput>, inputSchema: InputSchema<TInput>): ApiEndpoint<TInput, TOutput, Type>;
+export {};