@lightsparkdev/lightspark-sdk 1.7.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +2 -1
  3. package/dist/{chunk-DSWMAFFH.js → chunk-J7GJGYME.js} +46 -33
  4. package/dist/{index-2f0cac65.d.ts → index-9a69ef6a.d.ts} +19 -7
  5. package/dist/index.cjs +50 -37
  6. package/dist/index.d.cts +2 -2
  7. package/dist/index.d.ts +2 -2
  8. package/dist/index.js +5 -5
  9. package/dist/objects/index.cjs +46 -33
  10. package/dist/objects/index.d.cts +1 -1
  11. package/dist/objects/index.d.ts +1 -1
  12. package/dist/objects/index.js +1 -1
  13. package/package.json +2 -2
  14. package/src/client.ts +2 -2
  15. package/src/graphql/PayUmaInvoice.ts +1 -1
  16. package/src/objects/Account.ts +6 -1
  17. package/src/objects/ApiToken.ts +4 -1
  18. package/src/objects/AuditLogActor.ts +4 -1
  19. package/src/objects/Channel.ts +4 -1
  20. package/src/objects/ChannelClosingTransaction.ts +4 -2
  21. package/src/objects/ChannelOpeningTransaction.ts +4 -2
  22. package/src/objects/ChannelSnapshot.ts +4 -1
  23. package/src/objects/CurrencyUnit.ts +1 -1
  24. package/src/objects/Deposit.ts +4 -1
  25. package/src/objects/Entity.ts +2 -0
  26. package/src/objects/GraphNode.ts +4 -1
  27. package/src/objects/Hop.ts +4 -1
  28. package/src/objects/IncomingPayment.ts +4 -1
  29. package/src/objects/IncomingPaymentAttempt.ts +4 -1
  30. package/src/objects/Invoice.ts +22 -1
  31. package/src/objects/LightningTransaction.ts +4 -1
  32. package/src/objects/LightsparkNode.ts +4 -1
  33. package/src/objects/LightsparkNodeOwner.ts +4 -1
  34. package/src/objects/LightsparkNodeWithOSK.ts +4 -2
  35. package/src/objects/LightsparkNodeWithRemoteSigning.ts +4 -2
  36. package/src/objects/Node.ts +4 -1
  37. package/src/objects/OnChainTransaction.ts +4 -1
  38. package/src/objects/OutgoingPayment.ts +4 -1
  39. package/src/objects/OutgoingPaymentAttempt.ts +4 -2
  40. package/src/objects/PaymentRequest.ts +10 -1
  41. package/src/objects/RegionCode.ts +2 -0
  42. package/src/objects/RoutingTransaction.ts +4 -1
  43. package/src/objects/Signable.ts +4 -1
  44. package/src/objects/SignablePayload.ts +4 -1
  45. package/src/objects/Transaction.ts +4 -1
  46. package/src/objects/TransactionStatus.ts +1 -1
  47. package/src/objects/UmaInvitation.ts +4 -1
  48. package/src/objects/Wallet.ts +6 -1
  49. package/src/objects/WalletStatus.ts +2 -2
  50. package/src/objects/Withdrawal.ts +4 -1
  51. package/src/objects/WithdrawalRequest.ts +4 -1
@@ -35,6 +35,18 @@ interface Invoice {
35
35
 
36
36
  /** The total amount that has been paid to this invoice. **/
37
37
  amountPaid?: CurrencyAmount | undefined;
38
+
39
+ /**
40
+ * Whether this invoice is an UMA invoice or not. NOTE: this field is only set if the invoice
41
+ * was created using the recommended `create_uma_invoice` function.
42
+ **/
43
+ isUma?: boolean | undefined;
44
+
45
+ /**
46
+ * Whether this invoice is an LNURL invoice or not. NOTE: this field is only set if the invoice
47
+ * was created using the recommended `create_lnurl_invoice` function.
48
+ **/
49
+ isLnurl?: boolean | undefined;
38
50
  }
39
51
 
40
52
  export const InvoiceFromJson = (obj: any): Invoice => {
@@ -50,6 +62,8 @@ export const InvoiceFromJson = (obj: any): Invoice => {
50
62
  amountPaid: !!obj["invoice_amount_paid"]
51
63
  ? CurrencyAmountFromJson(obj["invoice_amount_paid"])
52
64
  : undefined,
65
+ isUma: obj["invoice_is_uma"],
66
+ isLnurl: obj["invoice_is_lnurl"],
53
67
  } as Invoice;
54
68
  };
55
69
  export const InvoiceToJson = (obj: Invoice): any => {
@@ -63,6 +77,8 @@ export const InvoiceToJson = (obj: Invoice): any => {
63
77
  invoice_amount_paid: obj.amountPaid
64
78
  ? CurrencyAmountToJson(obj.amountPaid)
65
79
  : undefined,
80
+ invoice_is_uma: obj.isUma,
81
+ invoice_is_lnurl: obj.isLnurl,
66
82
  };
67
83
  };
68
84
 
@@ -372,6 +388,8 @@ fragment InvoiceFragment on Invoice {
372
388
  currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
373
389
  currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
374
390
  }
391
+ invoice_is_uma: is_uma
392
+ invoice_is_lnurl: is_lnurl
375
393
  }`;
376
394
 
377
395
  export const getInvoiceQuery = (id: string): Query<Invoice> => {
@@ -388,7 +406,10 @@ query GetInvoice($id: ID!) {
388
406
  ${FRAGMENT}
389
407
  `,
390
408
  variables: { id },
391
- constructObject: (data: any) => InvoiceFromJson(data.entity),
409
+ constructObject: (data: unknown) =>
410
+ data && typeof data === "object" && "entity" in data
411
+ ? InvoiceFromJson(data.entity)
412
+ : null,
392
413
  };
393
414
  };
394
415
 
@@ -679,7 +679,10 @@ query GetLightningTransaction($id: ID!) {
679
679
  ${FRAGMENT}
680
680
  `,
681
681
  variables: { id },
682
- constructObject: (data: any) => LightningTransactionFromJson(data.entity),
682
+ constructObject: (data: unknown) =>
683
+ data && typeof data === "object" && "entity" in data
684
+ ? LightningTransactionFromJson(data.entity)
685
+ : null,
683
686
  };
684
687
  };
685
688
 
@@ -661,7 +661,10 @@ query GetLightsparkNode($id: ID!) {
661
661
  ${FRAGMENT}
662
662
  `,
663
663
  variables: { id },
664
- constructObject: (data: any) => LightsparkNodeFromJson(data.entity),
664
+ constructObject: (data: unknown) =>
665
+ data && typeof data === "object" && "entity" in data
666
+ ? LightsparkNodeFromJson(data.entity)
667
+ : null,
665
668
  };
666
669
  };
667
670
 
@@ -154,7 +154,10 @@ query GetLightsparkNodeOwner($id: ID!) {
154
154
  ${FRAGMENT}
155
155
  `,
156
156
  variables: { id },
157
- constructObject: (data: any) => LightsparkNodeOwnerFromJson(data.entity),
157
+ constructObject: (data: unknown) =>
158
+ data && typeof data === "object" && "entity" in data
159
+ ? LightsparkNodeOwnerFromJson(data.entity)
160
+ : null,
158
161
  };
159
162
  };
160
163
 
@@ -360,8 +360,10 @@ query GetLightsparkNodeWithOSK($id: ID!) {
360
360
  ${FRAGMENT}
361
361
  `,
362
362
  variables: { id },
363
- constructObject: (data: any) =>
364
- LightsparkNodeWithOSKFromJson(data.entity),
363
+ constructObject: (data: unknown) =>
364
+ data && typeof data === "object" && "entity" in data
365
+ ? LightsparkNodeWithOSKFromJson(data.entity)
366
+ : null,
365
367
  };
366
368
  }
367
369
 
@@ -353,8 +353,10 @@ query GetLightsparkNodeWithRemoteSigning($id: ID!) {
353
353
  ${FRAGMENT}
354
354
  `,
355
355
  variables: { id },
356
- constructObject: (data: any) =>
357
- LightsparkNodeWithRemoteSigningFromJson(data.entity),
356
+ constructObject: (data: unknown) =>
357
+ data && typeof data === "object" && "entity" in data
358
+ ? LightsparkNodeWithRemoteSigningFromJson(data.entity)
359
+ : null,
358
360
  };
359
361
  }
360
362
 
@@ -630,7 +630,10 @@ query GetNode($id: ID!) {
630
630
  ${FRAGMENT}
631
631
  `,
632
632
  variables: { id },
633
- constructObject: (data: any) => NodeFromJson(data.entity),
633
+ constructObject: (data: unknown) =>
634
+ data && typeof data === "object" && "entity" in data
635
+ ? NodeFromJson(data.entity)
636
+ : null,
634
637
  };
635
638
  };
636
639
 
@@ -425,7 +425,10 @@ query GetOnChainTransaction($id: ID!) {
425
425
  ${FRAGMENT}
426
426
  `,
427
427
  variables: { id },
428
- constructObject: (data: any) => OnChainTransactionFromJson(data.entity),
428
+ constructObject: (data: unknown) =>
429
+ data && typeof data === "object" && "entity" in data
430
+ ? OnChainTransactionFromJson(data.entity)
431
+ : null,
429
432
  };
430
433
  };
431
434
 
@@ -163,7 +163,10 @@ query GetOutgoingPayment($id: ID!) {
163
163
  ${FRAGMENT}
164
164
  `,
165
165
  variables: { id },
166
- constructObject: (data: any) => OutgoingPaymentFromJson(data.entity),
166
+ constructObject: (data: unknown) =>
167
+ data && typeof data === "object" && "entity" in data
168
+ ? OutgoingPaymentFromJson(data.entity)
169
+ : null,
167
170
  };
168
171
  }
169
172
 
@@ -143,8 +143,10 @@ query GetOutgoingPaymentAttempt($id: ID!) {
143
143
  ${FRAGMENT}
144
144
  `,
145
145
  variables: { id },
146
- constructObject: (data: any) =>
147
- OutgoingPaymentAttemptFromJson(data.entity),
146
+ constructObject: (data: unknown) =>
147
+ data && typeof data === "object" && "entity" in data
148
+ ? OutgoingPaymentAttemptFromJson(data.entity)
149
+ : null,
148
150
  };
149
151
  }
150
152
 
@@ -52,6 +52,8 @@ export const PaymentRequestFromJson = (obj: any): PaymentRequest => {
52
52
  amountPaid: !!obj["invoice_amount_paid"]
53
53
  ? CurrencyAmountFromJson(obj["invoice_amount_paid"])
54
54
  : undefined,
55
+ isUma: obj["invoice_is_uma"],
56
+ isLnurl: obj["invoice_is_lnurl"],
55
57
  } as Invoice;
56
58
  }
57
59
  throw new LightsparkException(
@@ -72,6 +74,8 @@ export const PaymentRequestToJson = (obj: PaymentRequest): any => {
72
74
  invoice_amount_paid: invoice.amountPaid
73
75
  ? CurrencyAmountToJson(invoice.amountPaid)
74
76
  : undefined,
77
+ invoice_is_uma: invoice.isUma,
78
+ invoice_is_lnurl: invoice.isLnurl,
75
79
  };
76
80
  }
77
81
  throw new LightsparkException(
@@ -388,6 +392,8 @@ fragment PaymentRequestFragment on PaymentRequest {
388
392
  currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
389
393
  currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
390
394
  }
395
+ invoice_is_uma: is_uma
396
+ invoice_is_lnurl: is_lnurl
391
397
  }
392
398
  }`;
393
399
 
@@ -405,7 +411,10 @@ query GetPaymentRequest($id: ID!) {
405
411
  ${FRAGMENT}
406
412
  `,
407
413
  variables: { id },
408
- constructObject: (data: any) => PaymentRequestFromJson(data.entity),
414
+ constructObject: (data: unknown) =>
415
+ data && typeof data === "object" && "entity" in data
416
+ ? PaymentRequestFromJson(data.entity)
417
+ : null,
409
418
  };
410
419
  };
411
420
 
@@ -505,6 +505,8 @@ export enum RegionCode {
505
505
  ZM = "ZM",
506
506
  /** The code representing the country of Zimbabwe. **/
507
507
  ZW = "ZW",
508
+ /** The code representing a fake region for testing. **/
509
+ NN = "NN",
508
510
  }
509
511
 
510
512
  export default RegionCode;
@@ -170,7 +170,10 @@ query GetRoutingTransaction($id: ID!) {
170
170
  ${FRAGMENT}
171
171
  `,
172
172
  variables: { id },
173
- constructObject: (data: any) => RoutingTransactionFromJson(data.entity),
173
+ constructObject: (data: unknown) =>
174
+ data && typeof data === "object" && "entity" in data
175
+ ? RoutingTransactionFromJson(data.entity)
176
+ : null,
174
177
  };
175
178
  };
176
179
 
@@ -58,7 +58,10 @@ query GetSignable($id: ID!) {
58
58
  ${FRAGMENT}
59
59
  `,
60
60
  variables: { id },
61
- constructObject: (data: any) => SignableFromJson(data.entity),
61
+ constructObject: (data: unknown) =>
62
+ data && typeof data === "object" && "entity" in data
63
+ ? SignableFromJson(data.entity)
64
+ : null,
62
65
  };
63
66
  };
64
67
 
@@ -102,7 +102,10 @@ query GetSignablePayload($id: ID!) {
102
102
  ${FRAGMENT}
103
103
  `,
104
104
  variables: { id },
105
- constructObject: (data: any) => SignablePayloadFromJson(data.entity),
105
+ constructObject: (data: unknown) =>
106
+ data && typeof data === "object" && "entity" in data
107
+ ? SignablePayloadFromJson(data.entity)
108
+ : null,
106
109
  };
107
110
  };
108
111
 
@@ -1003,7 +1003,10 @@ query GetTransaction($id: ID!) {
1003
1003
  ${FRAGMENT}
1004
1004
  `,
1005
1005
  variables: { id },
1006
- constructObject: (data: any) => TransactionFromJson(data.entity),
1006
+ constructObject: (data: unknown) =>
1007
+ data && typeof data === "object" && "entity" in data
1008
+ ? TransactionFromJson(data.entity)
1009
+ : null,
1007
1010
  };
1008
1011
  };
1009
1012
 
@@ -17,7 +17,7 @@ export enum TransactionStatus {
17
17
  /** Transaction has been initiated and is currently in-flight. **/
18
18
  PENDING = "PENDING",
19
19
  /**
20
- * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
20
+ * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request. *
21
21
  */
22
22
  NOT_STARTED = "NOT_STARTED",
23
23
  /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
@@ -106,7 +106,10 @@ query GetUmaInvitation($id: ID!) {
106
106
  ${FRAGMENT}
107
107
  `,
108
108
  variables: { id },
109
- constructObject: (data: any) => UmaInvitationFromJson(data.entity),
109
+ constructObject: (data: unknown) =>
110
+ data && typeof data === "object" && "entity" in data
111
+ ? UmaInvitationFromJson(data.entity)
112
+ : null,
110
113
  };
111
114
  };
112
115
 
@@ -978,6 +978,8 @@ query FetchWalletToPaymentRequestsConnection($entity_id: ID!, $first: Int, $afte
978
978
  currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
979
979
  currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
980
980
  }
981
+ invoice_is_uma: is_uma
982
+ invoice_is_lnurl: is_lnurl
981
983
  }
982
984
  }
983
985
  }
@@ -1179,7 +1181,10 @@ query GetWallet($id: ID!) {
1179
1181
  ${FRAGMENT}
1180
1182
  `,
1181
1183
  variables: { id },
1182
- constructObject: (data: any) => WalletFromJson(data.entity),
1184
+ constructObject: (data: unknown) =>
1185
+ data && typeof data === "object" && "entity" in data
1186
+ ? WalletFromJson(data.entity)
1187
+ : null,
1183
1188
  };
1184
1189
  }
1185
1190
 
@@ -33,8 +33,8 @@ export enum WalletStatus {
33
33
  TERMINATING = "TERMINATING",
34
34
  /**
35
35
  * The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
36
- * It is not connected to the Lightning network and its funds can only be accessed using the Funds
37
- * Recovery flow. *
36
+ * It is not connected to the Lightning network and its funds can only be accessed using the
37
+ * Funds Recovery flow. *
38
38
  */
39
39
  TERMINATED = "TERMINATED",
40
40
  }
@@ -155,7 +155,10 @@ query GetWithdrawal($id: ID!) {
155
155
  ${FRAGMENT}
156
156
  `,
157
157
  variables: { id },
158
- constructObject: (data: any) => WithdrawalFromJson(data.entity),
158
+ constructObject: (data: unknown) =>
159
+ data && typeof data === "object" && "entity" in data
160
+ ? WithdrawalFromJson(data.entity)
161
+ : null,
159
162
  };
160
163
  };
161
164
 
@@ -294,7 +294,10 @@ query GetWithdrawalRequest($id: ID!) {
294
294
  ${FRAGMENT}
295
295
  `,
296
296
  variables: { id },
297
- constructObject: (data: any) => WithdrawalRequestFromJson(data.entity),
297
+ constructObject: (data: unknown) =>
298
+ data && typeof data === "object" && "entity" in data
299
+ ? WithdrawalRequestFromJson(data.entity)
300
+ : null,
298
301
  };
299
302
  }
300
303