@lightsparkdev/lightspark-sdk 1.7.1 → 1.8.1

package/src/objects/PaymentRequest.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { LightsparkException, type Query } from "@lightsparkdev/core";
+import { LightsparkException, isObject, type Query } from "@lightsparkdev/core";
 import {
   CurrencyAmountFromJson,
   CurrencyAmountToJson,
@@ -52,6 +52,8 @@ export const PaymentRequestFromJson = (obj: any): PaymentRequest => {
       amountPaid: !!obj["invoice_amount_paid"]
         ? CurrencyAmountFromJson(obj["invoice_amount_paid"])
         : undefined,
+      isUma: obj["invoice_is_uma"],
+      isLnurl: obj["invoice_is_lnurl"],
     } as Invoice;
   }
   throw new LightsparkException(
@@ -72,6 +74,8 @@ export const PaymentRequestToJson = (obj: PaymentRequest): any => {
       invoice_amount_paid: invoice.amountPaid
         ? CurrencyAmountToJson(invoice.amountPaid)
         : undefined,
+      invoice_is_uma: invoice.isUma,
+      invoice_is_lnurl: invoice.isLnurl,
     };
   }
   throw new LightsparkException(
@@ -388,6 +392,8 @@ fragment PaymentRequestFragment on PaymentRequest {
             currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
             currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
         }
+        invoice_is_uma: is_uma
+        invoice_is_lnurl: is_lnurl
     }
 }`;
 
@@ -405,7 +411,10 @@ query GetPaymentRequest($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => PaymentRequestFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? PaymentRequestFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/RegionCode.ts

@@ -505,6 +505,8 @@ export enum RegionCode {
   ZM = "ZM",
   /** The code representing the country of Zimbabwe. **/
   ZW = "ZW",
+  /** The code representing a fake region for testing. **/
+  NN = "NN",
 }
 
 export default RegionCode;

package/src/objects/RoutingTransaction.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import {
   CurrencyAmountFromJson,
@@ -170,7 +170,10 @@ query GetRoutingTransaction($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => RoutingTransactionFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? RoutingTransactionFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/Signable.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 
 interface Signable {
   /**
@@ -58,7 +58,10 @@ query GetSignable($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => SignableFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? SignableFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/SignablePayload.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import SignablePayloadStatus from "./SignablePayloadStatus.js";
 
 interface SignablePayload {
@@ -102,7 +102,10 @@ query GetSignablePayload($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => SignablePayloadFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? SignablePayloadFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/Transaction.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { LightsparkException, type Query } from "@lightsparkdev/core";
+import { LightsparkException, isObject, type Query } from "@lightsparkdev/core";
 import type ChannelClosingTransaction from "./ChannelClosingTransaction.js";
 import type ChannelOpeningTransaction from "./ChannelOpeningTransaction.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -1003,7 +1003,10 @@ query GetTransaction($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => TransactionFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? TransactionFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/TransactionStatus.ts

@@ -17,7 +17,7 @@ export enum TransactionStatus {
   /** Transaction has been initiated and is currently in-flight. **/
   PENDING = "PENDING",
   /**
-   * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
+   * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request. *
    */
   NOT_STARTED = "NOT_STARTED",
   /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/

package/src/objects/UmaInvitation.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import IncentivesIneligibilityReason from "./IncentivesIneligibilityReason.js";
 import IncentivesStatus from "./IncentivesStatus.js";
 
@@ -106,7 +106,10 @@ query GetUmaInvitation($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => UmaInvitationFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? UmaInvitationFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/Wallet.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type Balances from "./Balances.js";
@@ -978,6 +978,8 @@ query FetchWalletToPaymentRequestsConnection($entity_id: ID!, $first: Int, $afte
                             currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
                             currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
                         }
+                        invoice_is_uma: is_uma
+                        invoice_is_lnurl: is_lnurl
                     }
                 }
             }
@@ -1179,7 +1181,10 @@ query GetWallet($id: ID!) {
 ${FRAGMENT}    
 `,
       variables: { id },
-      constructObject: (data: any) => WalletFromJson(data.entity),
+      constructObject: (data: unknown) =>
+        isObject(data) && "entity" in data && isObject(data.entity)
+          ? WalletFromJson(data.entity)
+          : null,
     };
   }
 

package/src/objects/WalletStatus.ts

@@ -33,8 +33,8 @@ export enum WalletStatus {
   TERMINATING = "TERMINATING",
   /**
    * The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
-   * It is not connected to the Lightning network and its funds can only be accessed using the Funds
-   * Recovery flow. *
+   * It is not connected to the Lightning network and its funds can only be accessed using the
+   * Funds Recovery flow. *
    */
   TERMINATED = "TERMINATED",
 }

package/src/objects/Withdrawal.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import {
   CurrencyAmountFromJson,
@@ -155,7 +155,10 @@ query GetWithdrawal($id: ID!) {
 ${FRAGMENT}    
 `,
     variables: { id },
-    constructObject: (data: any) => WithdrawalFromJson(data.entity),
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? WithdrawalFromJson(data.entity)
+        : null,
   };
 };
 

package/src/objects/WithdrawalRequest.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import { type Query } from "@lightsparkdev/core";
+import { isObject, type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -294,7 +294,10 @@ query GetWithdrawalRequest($id: ID!) {
 ${FRAGMENT}    
 `,
       variables: { id },
-      constructObject: (data: any) => WithdrawalRequestFromJson(data.entity),
+      constructObject: (data: unknown) =>
+        isObject(data) && "entity" in data && isObject(data.entity)
+          ? WithdrawalRequestFromJson(data.entity)
+          : null,
     };
   }
 

package/src/tests/generated-objects.test.ts

@@ -0,0 +1,93 @@
+import { getHopQuery } from "../objects/Hop.js";
+import {
+  InvoiceDataFromJson,
+  InvoiceDataToJson,
+} from "../objects/InvoiceData.js";
+
+describe("Serialization", () => {
+  test("should serialize and deserialize InvoiceData to the same object", () => {
+    const serialized = `{"__typename": "InvoiceData", "invoice_data_encoded_payment_request":"lnbcrt34170n1pj5vdn4pp56jhw0672v566u4rvl333v8hwwuvavvu9gx4a2mqag4pkrvm0hwkqhp5xaz278y6cejcvpqnndl4wfq3slgthjduwlfksg778aevn23v2pdscqzpgxqyz5vqsp5ee5jezfvjqvvz7hfwta3ekk8hs6dq36szkgp40qh7twa8upquxlq9qyyssqjg2slc95falxf2t67y0wu2w43qwfcvfflwl8tn4ppqw9tumwqxk36qkfct9p2w8c3yy2ld7c6nacy4ssv2gl6qyqfpmhl4jmarnjf8cpvjlxek","invoice_data_bitcoin_network":"REGTEST","invoice_data_payment_hash":"d4aee7ebca6535ae546cfc63161eee7719d6338541abd56c1d454361b36fbbac","invoice_data_amount":{"currency_amount_original_value":3417,"currency_amount_original_unit":"SATOSHI","currency_amount_preferred_currency_unit":"USD","currency_amount_preferred_currency_value_rounded":118,"currency_amount_preferred_currency_value_approx":118.89352818371607},"invoice_data_created_at":"2023-11-04T12:17:57Z","invoice_data_expires_at":"2023-11-05T12:17:57Z","invoice_data_memo":null,"invoice_data_destination":{"graph_node_id":"GraphNode:0189a572-6dba-cf00-0000-ac0908d34ea6","graph_node_created_at":"2023-07-30T06:18:07.162759Z","graph_node_updated_at":"2023-11-04T12:01:04.015414Z","graph_node_alias":"ls_test_vSViIQitob_SE","graph_node_bitcoin_network":"REGTEST","graph_node_color":"#3399ff","graph_node_conductivity":null,"graph_node_display_name":"ls_test_vSViIQitob_SE","graph_node_public_key":"02253935a5703a6f0429081e08d2defce0faa15f4d75305302284751d53a4e0608", "__typename":"GraphNode"}}`;
+    const deserialized = InvoiceDataFromJson(JSON.parse(serialized));
+    const reserialized = InvoiceDataToJson(deserialized) as Record<
+      string,
+      unknown
+    >;
+    expect(reserialized).toEqual(JSON.parse(serialized));
+
+    const deserializedAgain = InvoiceDataFromJson(reserialized);
+    expect(JSON.stringify(deserializedAgain)).toEqual(
+      JSON.stringify(deserialized),
+    );
+  });
+});
+
+describe("Get entity query functions", () => {
+  test("constructObject should return null when data is not an object", () => {
+    const query = getHopQuery("something");
+    expect(query.constructObject(null)).toBeNull();
+    expect(query.constructObject(undefined)).toBeNull();
+    expect(query.constructObject("string")).toBeNull();
+    expect(query.constructObject(123)).toBeNull();
+    expect(query.constructObject(true)).toBeNull();
+  });
+  test("constructObject should return null when data.{path} is not an object", () => {
+    const query = getHopQuery("something");
+    expect(query.constructObject({ entity: null })).toBeNull();
+    expect(query.constructObject({ entity: undefined })).toBeNull();
+    expect(query.constructObject({ entity: "string" })).toBeNull();
+    expect(query.constructObject({ entity: 123 })).toBeNull();
+    expect(query.constructObject({ entity: true })).toBeNull();
+  });
+  test("constructObject should return the object when data.{path} is an object", () => {
+    const query = getHopQuery("something");
+    const data = {
+      entity: {
+        hop_id: "123",
+        hop_created_at: "2023-11-04T12:17:57Z",
+        hop_updated_at: "2023-11-04T12:17:57Z",
+        hop_index: 1,
+        hop_destination: { id: "destination" },
+        hop_public_key: "public_key",
+        hop_amount_to_forward: {
+          currency_amount_original_value: 3417,
+          currency_amount_original_unit: "SATOSHI",
+          currency_amount_preferred_currency_unit: "USD",
+          currency_amount_preferred_currency_value_rounded: 118,
+          currency_amount_preferred_currency_value_approx: 118.89352818371607,
+        },
+        hop_fee: {
+          currency_amount_original_value: 3417,
+          currency_amount_original_unit: "SATOSHI",
+          currency_amount_preferred_currency_unit: "USD",
+          currency_amount_preferred_currency_value_rounded: 118,
+          currency_amount_preferred_currency_value_approx: 118.89352818371607,
+        },
+        hop_expiry_block_height: 123,
+      },
+    };
+    expect(query.constructObject(data)).toEqual({
+      id: "123",
+      createdAt: "2023-11-04T12:17:57Z",
+      updatedAt: "2023-11-04T12:17:57Z",
+      index: 1,
+      typename: "Hop",
+      destinationId: "destination",
+      publicKey: "public_key",
+      amountToForward: {
+        originalValue: 3417,
+        originalUnit: "SATOSHI",
+        preferredCurrencyUnit: "USD",
+        preferredCurrencyValueRounded: 118,
+        preferredCurrencyValueApprox: 118.89352818371607,
+      },
+      fee: {
+        originalValue: 3417,
+        originalUnit: "SATOSHI",
+        preferredCurrencyUnit: "USD",
+        preferredCurrencyValueRounded: 118,
+        preferredCurrencyValueApprox: 118.89352818371607,
+      },
+      expiryBlockHeight: 123,
+    });
+  });
+});

package/src/tests/serialization.test.ts

@@ -1,21 +0,0 @@
-import {
-  InvoiceDataFromJson,
-  InvoiceDataToJson,
-} from "../objects/InvoiceData.js";
-
-describe("Serialization", () => {
-  test("should serialize and deserialize InvoiceData to the same object", () => {
-    const serialized = `{"__typename": "InvoiceData", "invoice_data_encoded_payment_request":"lnbcrt34170n1pj5vdn4pp56jhw0672v566u4rvl333v8hwwuvavvu9gx4a2mqag4pkrvm0hwkqhp5xaz278y6cejcvpqnndl4wfq3slgthjduwlfksg778aevn23v2pdscqzpgxqyz5vqsp5ee5jezfvjqvvz7hfwta3ekk8hs6dq36szkgp40qh7twa8upquxlq9qyyssqjg2slc95falxf2t67y0wu2w43qwfcvfflwl8tn4ppqw9tumwqxk36qkfct9p2w8c3yy2ld7c6nacy4ssv2gl6qyqfpmhl4jmarnjf8cpvjlxek","invoice_data_bitcoin_network":"REGTEST","invoice_data_payment_hash":"d4aee7ebca6535ae546cfc63161eee7719d6338541abd56c1d454361b36fbbac","invoice_data_amount":{"currency_amount_original_value":3417,"currency_amount_original_unit":"SATOSHI","currency_amount_preferred_currency_unit":"USD","currency_amount_preferred_currency_value_rounded":118,"currency_amount_preferred_currency_value_approx":118.89352818371607},"invoice_data_created_at":"2023-11-04T12:17:57Z","invoice_data_expires_at":"2023-11-05T12:17:57Z","invoice_data_memo":null,"invoice_data_destination":{"graph_node_id":"GraphNode:0189a572-6dba-cf00-0000-ac0908d34ea6","graph_node_created_at":"2023-07-30T06:18:07.162759Z","graph_node_updated_at":"2023-11-04T12:01:04.015414Z","graph_node_alias":"ls_test_vSViIQitob_SE","graph_node_bitcoin_network":"REGTEST","graph_node_color":"#3399ff","graph_node_conductivity":null,"graph_node_display_name":"ls_test_vSViIQitob_SE","graph_node_public_key":"02253935a5703a6f0429081e08d2defce0faa15f4d75305302284751d53a4e0608", "__typename":"GraphNode"}}`;
-    const deserialized = InvoiceDataFromJson(JSON.parse(serialized));
-    const reserialized = InvoiceDataToJson(deserialized) as Record<
-      string,
-      unknown
-    >;
-    expect(reserialized).toEqual(JSON.parse(serialized));
-
-    const deserializedAgain = InvoiceDataFromJson(reserialized);
-    expect(JSON.stringify(deserializedAgain)).toEqual(
-      JSON.stringify(deserialized),
-    );
-  });
-});