@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/AccountToApiTokensConnection.ts

@@ -0,0 +1,50 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import ApiToken, { ApiTokenFromJson } from "./ApiToken.js";
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+
+type AccountToApiTokensConnection = {
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count: number;
+
+  /** The API tokens for the current page of this connection. **/
+  entities: ApiToken[];
+};
+
+export const AccountToApiTokensConnectionFromJson = (
+  obj: any
+): AccountToApiTokensConnection => {
+  return {
+    pageInfo: PageInfoFromJson(
+      obj["account_to_api_tokens_connection_page_info"]
+    ),
+    count: obj["account_to_api_tokens_connection_count"],
+    entities: obj["account_to_api_tokens_connection_entities"].map((e) =>
+      ApiTokenFromJson(e)
+    ),
+  } as AccountToApiTokensConnection;
+};
+
+export const FRAGMENT = `
+fragment AccountToApiTokensConnectionFragment on AccountToApiTokensConnection {
+    __typename
+    account_to_api_tokens_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+    account_to_api_tokens_connection_count: count
+    account_to_api_tokens_connection_entities: entities {
+        id
+    }
+}`;
+
+export default AccountToApiTokensConnection;

package/src/objects/AccountToChannelsConnection.ts

@@ -0,0 +1,35 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import autoBind from "auto-bind";
+import Channel, { ChannelFromJson } from "./Channel.js";
+
+class AccountToChannelsConnection {
+  constructor(
+    public readonly count: number,
+    public readonly entities: Channel[]
+  ) {
+    autoBind(this);
+  }
+}
+
+export const AccountToChannelsConnectionFromJson = (
+  obj: any
+): AccountToChannelsConnection => {
+  return new AccountToChannelsConnection(
+    obj["account_to_channels_connection_count"],
+    obj["account_to_channels_connection_entities"].map((e) =>
+      ChannelFromJson(e)
+    )
+  );
+};
+
+export const FRAGMENT = `
+fragment AccountToChannelsConnectionFragment on AccountToChannelsConnection {
+    __typename
+    account_to_channels_connection_count: count
+    account_to_channels_connection_entities: entities {
+        id
+    }
+}`;
+
+export default AccountToChannelsConnection;

package/src/objects/AccountToNodesConnection.ts

@@ -0,0 +1,62 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import LightsparkNode, { LightsparkNodeFromJson } from "./LightsparkNode.js";
+import LightsparkNodePurpose from "./LightsparkNodePurpose.js";
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+
+/** A connection between an account and the nodes it manages. **/
+type AccountToNodesConnection = {
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count: number;
+
+  /** The nodes for the current page of this connection. **/
+  entities: LightsparkNode[];
+
+  /**
+   * The main purpose for the selected set of nodes. It is automatically determined from the nodes that
+   * are selected in this connection and is used for optimization purposes, as well as to determine the
+   * variation of the UI that should be presented to the user.
+   **/
+  purpose?: LightsparkNodePurpose;
+};
+
+export const AccountToNodesConnectionFromJson = (
+  obj: any
+): AccountToNodesConnection => {
+  return {
+    pageInfo: PageInfoFromJson(obj["account_to_nodes_connection_page_info"]),
+    count: obj["account_to_nodes_connection_count"],
+    entities: obj["account_to_nodes_connection_entities"].map((e) =>
+      LightsparkNodeFromJson(e)
+    ),
+    purpose: !!obj["account_to_nodes_connection_purpose"]
+      ? LightsparkNodePurpose[obj["account_to_nodes_connection_purpose"]] ??
+        LightsparkNodePurpose.FUTURE_VALUE
+      : null,
+  } as AccountToNodesConnection;
+};
+
+export const FRAGMENT = `
+fragment AccountToNodesConnectionFragment on AccountToNodesConnection {
+    __typename
+    account_to_nodes_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+    account_to_nodes_connection_count: count
+    account_to_nodes_connection_purpose: purpose
+    account_to_nodes_connection_entities: entities {
+        id
+    }
+}`;
+
+export default AccountToNodesConnection;

package/src/objects/AccountToPaymentRequestsConnection.ts

@@ -0,0 +1,50 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+import PaymentRequest, { PaymentRequestFromJson } from "./PaymentRequest.js";
+
+type AccountToPaymentRequestsConnection = {
+  /** The payment requests for the current page of this connection. **/
+  entities: PaymentRequest[];
+
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count?: number;
+};
+
+export const AccountToPaymentRequestsConnectionFromJson = (
+  obj: any
+): AccountToPaymentRequestsConnection => {
+  return {
+    entities: obj["account_to_payment_requests_connection_entities"].map((e) =>
+      PaymentRequestFromJson(e)
+    ),
+    pageInfo: PageInfoFromJson(
+      obj["account_to_payment_requests_connection_page_info"]
+    ),
+    count: obj["account_to_payment_requests_connection_count"],
+  } as AccountToPaymentRequestsConnection;
+};
+
+export const FRAGMENT = `
+fragment AccountToPaymentRequestsConnectionFragment on AccountToPaymentRequestsConnection {
+    __typename
+    account_to_payment_requests_connection_count: count
+    account_to_payment_requests_connection_entities: entities {
+        id
+    }
+    account_to_payment_requests_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+}`;
+
+export default AccountToPaymentRequestsConnection;

package/src/objects/AccountToTransactionsConnection.ts

@@ -0,0 +1,112 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+import Transaction, { TransactionFromJson } from "./Transaction.js";
+
+type AccountToTransactionsConnection = {
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count: number;
+
+  /** The transactions for the current page of this connection. **/
+  entities: Transaction[];
+
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * Profit (or loss) generated by the transactions in this connection, with the set of filters and
+   * constraints provided.
+   **/
+  profitLoss?: CurrencyAmount;
+
+  /**
+   * Average fee earned for the transactions in this connection, with the set of filters and constraints
+   * provided.
+   **/
+  averageFeeEarned?: CurrencyAmount;
+
+  /**
+   * Total amount transacted by the transactions in this connection, with the set of filters and
+   * constraints provided.
+   **/
+  totalAmountTransacted?: CurrencyAmount;
+};
+
+export const AccountToTransactionsConnectionFromJson = (
+  obj: any
+): AccountToTransactionsConnection => {
+  return {
+    count: obj["account_to_transactions_connection_count"],
+    entities: obj["account_to_transactions_connection_entities"].map((e) =>
+      TransactionFromJson(e)
+    ),
+    pageInfo: PageInfoFromJson(
+      obj["account_to_transactions_connection_page_info"]
+    ),
+    profitLoss: !!obj["account_to_transactions_connection_profit_loss"]
+      ? CurrencyAmountFromJson(
+          obj["account_to_transactions_connection_profit_loss"]
+        )
+      : undefined,
+    averageFeeEarned: !!obj[
+      "account_to_transactions_connection_average_fee_earned"
+    ]
+      ? CurrencyAmountFromJson(
+          obj["account_to_transactions_connection_average_fee_earned"]
+        )
+      : undefined,
+    totalAmountTransacted: !!obj[
+      "account_to_transactions_connection_total_amount_transacted"
+    ]
+      ? CurrencyAmountFromJson(
+          obj["account_to_transactions_connection_total_amount_transacted"]
+        )
+      : undefined,
+  } as AccountToTransactionsConnection;
+};
+
+export const FRAGMENT = `
+fragment AccountToTransactionsConnectionFragment on AccountToTransactionsConnection {
+    __typename
+    account_to_transactions_connection_profit_loss: profit_loss {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    account_to_transactions_connection_average_fee_earned: average_fee_earned {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    account_to_transactions_connection_count: count
+    account_to_transactions_connection_total_amount_transacted: total_amount_transacted {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    account_to_transactions_connection_entities: entities {
+        id
+    }
+    account_to_transactions_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+}`;
+
+export default AccountToTransactionsConnection;

package/src/objects/ApiToken.ts

@@ -0,0 +1,80 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import Entity from "./Entity.js";
+import Permission from "./Permission.js";
+
+type ApiToken = Entity & {
+  /**
+   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+   * string.
+   **/
+  id: string;
+
+  /** The date and time when the entity was first created. **/
+  createdAt: string;
+
+  /** The date and time when the entity was last updated. **/
+  updatedAt: string;
+
+  /**
+   * An opaque identifier that should be used as a client_id (or username) in the HTTP Basic
+   * Authentication scheme when issuing requests against the Lightspark API.
+   **/
+  clientId: string;
+
+  /**
+   * An arbitrary name chosen by the creator of the token to help identify the token in the list of
+   * tokens that have been created for the account.
+   **/
+  name: string;
+
+  /** A list of permissions granted to the token. **/
+  permissions: Permission[];
+
+  /** The typename of the object **/
+  typename: string;
+};
+
+export const ApiTokenFromJson = (obj: any): ApiToken => {
+  return {
+    id: obj["api_token_id"],
+    createdAt: obj["api_token_created_at"],
+    updatedAt: obj["api_token_updated_at"],
+    clientId: obj["api_token_client_id"],
+    name: obj["api_token_name"],
+    permissions: obj["api_token_permissions"].map((e) => Permission[e]),
+    typename: "ApiToken",
+  } as ApiToken;
+};
+
+export const FRAGMENT = `
+fragment ApiTokenFragment on ApiToken {
+    __typename
+    api_token_id: id
+    api_token_created_at: created_at
+    api_token_updated_at: updated_at
+    api_token_client_id: client_id
+    api_token_name: name
+    api_token_permissions: permissions
+}`;
+
+export const getApiTokenQuery = (id: string): Query<ApiToken> => {
+  return {
+    queryPayload: `
+query GetApiToken($id: ID!) {
+    entity(id: $id) {
+        ... on ApiToken {
+            ...ApiTokenFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => ApiTokenFromJson(data.entity),
+  };
+};
+
+export default ApiToken;

package/src/objects/BitcoinNetwork.ts

@@ -0,0 +1,19 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum BitcoinNetwork {
+  /**
+   * 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",
+  /** The production version of the Bitcoin Blockchain. **/
+  MAINNET = "MAINNET",
+  /** A test version of the Bitcoin Blockchain, maintained by Lightspark. **/
+  REGTEST = "REGTEST",
+  /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
+  SIGNET = "SIGNET",
+  /** A test version of the Bitcoin Blockchain, publically available. **/
+  TESTNET = "TESTNET",
+}
+
+export default BitcoinNetwork;

package/src/objects/BlockchainBalance.ts

@@ -0,0 +1,102 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+/** This object provides a detailed breakdown of a `LightsparkNode`'s current balance on the Bitcoin Network. **/
+type BlockchainBalance = {
+  /** The total wallet balance, including unconfirmed UTXOs. **/
+  totalBalance?: CurrencyAmount;
+
+  /** The balance of confirmed UTXOs in the wallet. **/
+  confirmedBalance?: CurrencyAmount;
+
+  /** The balance of unconfirmed UTXOs in the wallet. **/
+  unconfirmedBalance?: CurrencyAmount;
+
+  /** The balance that's locked by an on-chain transaction. **/
+  lockedBalance?: CurrencyAmount;
+
+  /** Funds required to be held in reserve for channel bumping. **/
+  requiredReserve?: CurrencyAmount;
+
+  /** Funds available for creating channels or withdrawing. **/
+  availableBalance?: CurrencyAmount;
+};
+
+export const BlockchainBalanceFromJson = (obj: any): BlockchainBalance => {
+  return {
+    totalBalance: !!obj["blockchain_balance_total_balance"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_total_balance"])
+      : undefined,
+    confirmedBalance: !!obj["blockchain_balance_confirmed_balance"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_confirmed_balance"])
+      : undefined,
+    unconfirmedBalance: !!obj["blockchain_balance_unconfirmed_balance"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_unconfirmed_balance"])
+      : undefined,
+    lockedBalance: !!obj["blockchain_balance_locked_balance"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_locked_balance"])
+      : undefined,
+    requiredReserve: !!obj["blockchain_balance_required_reserve"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_required_reserve"])
+      : undefined,
+    availableBalance: !!obj["blockchain_balance_available_balance"]
+      ? CurrencyAmountFromJson(obj["blockchain_balance_available_balance"])
+      : undefined,
+  } as BlockchainBalance;
+};
+
+export const FRAGMENT = `
+fragment BlockchainBalanceFragment on BlockchainBalance {
+    __typename
+    blockchain_balance_total_balance: total_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    blockchain_balance_confirmed_balance: confirmed_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    blockchain_balance_unconfirmed_balance: unconfirmed_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    blockchain_balance_locked_balance: locked_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    blockchain_balance_required_reserve: required_reserve {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    blockchain_balance_available_balance: available_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+}`;
+
+export default BlockchainBalance;