@lightsparkdev/core 0.1.3

package/dist/index.d.ts

@@ -0,0 +1,152 @@
+import { Observable } from 'zen-observable-ts';
+
+interface AuthProvider {
+    addAuthHeaders(headers: any): Promise<any>;
+    isAuthorized(): Promise<boolean>;
+    addWsConnectionParams(params: any): any;
+}
+
+declare class LightsparkException extends Error {
+    code: string;
+    message: string;
+    extraInfo: any;
+    constructor(code: string, message: string, extraInfo?: any);
+}
+
+declare class LightsparkAuthException extends LightsparkException {
+    constructor(message: string, extraInfo?: any);
+}
+
+declare class StubAuthProvider implements AuthProvider {
+    addAuthHeaders(headers: any): Promise<any>;
+    isAuthorized(): Promise<boolean>;
+    addWsConnectionParams(params: any): any;
+}
+
+declare class LightsparkSigningException extends LightsparkException {
+    constructor(message: string, extraInfo?: any);
+}
+
+declare function getCrypto(): Promise<Crypto>;
+declare const encrypt: (plaintext: ArrayBuffer, password: string, salt?: Uint8Array) => Promise<[
+    string,
+    string
+]>;
+declare const decrypt: (header_json: string, ciphertext: string, password: string) => Promise<ArrayBuffer>;
+declare function decryptSecretWithNodePassword(cipher: string, encryptedSecret: string, nodePassword: string): Promise<ArrayBuffer | null>;
+declare function decode(arrBuff: ArrayBuffer): string;
+declare const generateSigningKeyPair: () => Promise<CryptoKeyPair>;
+declare const serializeSigningKey: (key: CryptoKey, format: "pkcs8" | "spki") => Promise<ArrayBuffer>;
+declare const encryptWithNodeKey: (key: CryptoKey, data: string) => Promise<string>;
+declare const loadNodeEncryptionKey: (rawPublicKey: string) => Promise<CryptoKey>;
+declare const getNonce: () => Promise<number>;
+
+declare class NodeKeyCache {
+    private idToKey;
+    constructor();
+    loadKey(id: string, rawKey: string): Promise<CryptoKey | null>;
+    getKey(id: string): CryptoKey | undefined;
+    hasKey(id: string): boolean;
+}
+
+type Query<T> = {
+    /** The string representation of the query payload for graphQL. **/
+    queryPayload: string;
+    /** The variables that will be passed to the query. **/
+    variables?: {
+        [key: string]: any;
+    };
+    /** The function that will be called to construct the object from the response. **/
+    constructObject: (rawData: any) => T;
+    /** The id of the node that will be used to sign the query. **/
+    signingNodeId?: string;
+};
+
+declare class Requester {
+    private readonly nodeKeyCache;
+    private readonly schemaEndpoint;
+    private readonly authProvider;
+    private readonly baseUrl;
+    private readonly wsClient;
+    constructor(nodeKeyCache: NodeKeyCache, schemaEndpoint: string, authProvider?: AuthProvider, baseUrl?: string);
+    executeQuery<T>(query: Query<T>): Promise<T | null>;
+    subscribe(queryPayload: string, variables?: {
+        [key: string]: any;
+    }): Observable<any>;
+    makeRawRequest(queryPayload: string, variables?: {
+        [key: string]: any;
+    }, signingNodeId?: string | undefined): Promise<any | null>;
+    private getSdkUserAgent;
+    private addSigningDataIfNeeded;
+}
+
+declare enum ServerEnvironment {
+    PRODUCTION = "production",
+    DEV = "dev"
+}
+declare const apiDomainForEnvironment: (environment: ServerEnvironment) => string;
+
+declare const b64decode: (encoded: string) => Uint8Array;
+declare const urlsafe_b64decode: (encoded: string) => Uint8Array;
+declare const b64encode: (data: ArrayBuffer) => string;
+
+/** Represents the value and unit for an amount of currency. **/
+type CurrencyAmount = {
+    /** The original numeric value for this CurrencyAmount. **/
+    originalValue: number;
+    /** The original unit of currency for this CurrencyAmount. **/
+    originalUnit: CurrencyUnit;
+    /** The unit of user's preferred currency. **/
+    preferredCurrencyUnit: CurrencyUnit;
+    /**
+     * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
+     * currency. For example, for USD, the value will be in cents.
+     **/
+    preferredCurrencyValueRounded: number;
+    /**
+     * The approximate float value for this CurrencyAmount in the very base level of user's preferred
+     * currency. For example, for USD, the value will be in cents.
+     **/
+    preferredCurrencyValueApprox: number;
+};
+declare enum CurrencyUnit {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    /** Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. **/
+    BITCOIN = "BITCOIN",
+    /** 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. **/
+    SATOSHI = "SATOSHI",
+    /** 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MILLISATOSHI = "MILLISATOSHI",
+    /** United States Dollar. **/
+    USD = "USD",
+    /** 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    NANOBITCOIN = "NANOBITCOIN",
+    /** 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MICROBITCOIN = "MICROBITCOIN",
+    /** 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MILLIBITCOIN = "MILLIBITCOIN"
+}
+declare const convertCurrencyAmount: (from: CurrencyAmount, toUnit: CurrencyUnit) => CurrencyAmount;
+
+declare const isBrowser: boolean;
+declare const isNode: boolean;
+
+type Maybe<T> = T | null | undefined;
+type ExpandRecursively<T> = T extends object ? T extends infer O ? {
+    [K in keyof O]: ExpandRecursively<O[K]>;
+} : never : T;
+type ById<T> = {
+    [id: string]: T;
+};
+type OmitTypename<T> = Omit<T, "__typename">;
+declare const isType: <T extends string>(typename: T) => <N extends {
+    __typename: string;
+}>(node: N | null | undefined) => node is Extract<N, {
+    __typename: T;
+}>;
+
+export { AuthProvider, ById, ExpandRecursively, LightsparkAuthException, LightsparkException, LightsparkSigningException, Maybe, NodeKeyCache, OmitTypename, Query, Requester, ServerEnvironment, StubAuthProvider, apiDomainForEnvironment, b64decode, b64encode, convertCurrencyAmount, decode, decrypt, decryptSecretWithNodePassword, encrypt, encryptWithNodeKey, generateSigningKeyPair, getCrypto, getNonce, isBrowser, isNode, isType, loadNodeEncryptionKey, serializeSigningKey, urlsafe_b64decode };