@lightsparkdev/core 0.1.3

package/src/utils/currency.ts

@@ -0,0 +1,119 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import LightsparkException from "../LightsparkException.js";
+
+/** 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;
+};
+
+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",
+}
+
+const CONVERSION_MAP = {
+  [CurrencyUnit.BITCOIN]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => v,
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => v * 1_000_000,
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => v * 1000,
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v * 100_000_000_000,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => v * 1_000_000_000,
+    [CurrencyUnit.SATOSHI]: (v: number) => v * 100_000_000,
+  },
+  [CurrencyUnit.MICROBITCOIN]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => Math.round(v / 1_000_000),
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => v,
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => Math.round(v / 1000),
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v * 100_000,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => v * 1000,
+    [CurrencyUnit.SATOSHI]: (v: number) => v * 100,
+  },
+  [CurrencyUnit.MILLIBITCOIN]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => Math.round(v / 1_000),
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => v * 1000,
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => v,
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v * 100_000_000,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => v * 1_000_000,
+    [CurrencyUnit.SATOSHI]: (v: number) => v * 100_000,
+  },
+  [CurrencyUnit.MILLISATOSHI]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => Math.round(v / 100_000_000_000),
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => Math.round(v / 100_000),
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => Math.round(v / 100_000_000),
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => Math.round(v / 100),
+    [CurrencyUnit.SATOSHI]: (v: number) => Math.round(v / 1000),
+  },
+  [CurrencyUnit.NANOBITCOIN]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => Math.round(v / 1_000_000_000),
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => Math.round(v / 1000),
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => Math.round(v / 1_000_000),
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v * 100,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => v,
+    [CurrencyUnit.SATOSHI]: (v: number) => Math.round(v / 10),
+  },
+  [CurrencyUnit.SATOSHI]: {
+    [CurrencyUnit.BITCOIN]: (v: number) => Math.round(v / 100_000_000),
+    [CurrencyUnit.MICROBITCOIN]: (v: number) => Math.round(v / 100),
+    [CurrencyUnit.MILLIBITCOIN]: (v: number) => Math.round(v / 100_000),
+    [CurrencyUnit.MILLISATOSHI]: (v: number) => v * 1000,
+    [CurrencyUnit.NANOBITCOIN]: (v: number) => v * 10,
+    [CurrencyUnit.SATOSHI]: (v: number) => v,
+  },
+};
+
+export const convertCurrencyAmount = (
+  from: CurrencyAmount,
+  toUnit: CurrencyUnit
+): CurrencyAmount => {
+  const conversionFn = CONVERSION_MAP[from.originalUnit][toUnit];
+  if (!conversionFn) {
+    throw new LightsparkException(
+      "CurrencyError",
+      `Cannot convert from ${from.originalUnit} to ${toUnit}`
+    );
+  }
+  return {
+    ...from,
+    preferredCurrencyUnit: toUnit,
+    preferredCurrencyValueApprox: conversionFn(from.originalValue),
+    preferredCurrencyValueRounded: conversionFn(from.originalValue),
+  };
+};

package/src/utils/environment.ts

@@ -0,0 +1,7 @@
+export const isBrowser =
+  typeof window !== "undefined" && typeof window.document !== "undefined";
+
+export const isNode =
+  typeof process !== "undefined" &&
+  process.versions != null &&
+  process.versions.node != null;

package/src/utils/index.ts

@@ -0,0 +1,6 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export * from "./base64.js";
+export * from "./currency.js";
+export * from "./environment.js";
+export * from "./types.js";

package/src/utils/types.ts

@@ -0,0 +1,23 @@
+// Copyright  ©, 2023, Lightspark Group, Inc. - All Rights Reserved
+
+export type Maybe<T> = T | null | undefined;
+
+export type ExpandRecursively<T> = T extends object
+  ? T extends infer O
+    ? { [K in keyof O]: ExpandRecursively<O[K]> } // eslint-disable-line @typescript-eslint/no-unused-vars
+    : never
+  : T;
+
+export type ById<T> = {
+  [id: string]: T;
+};
+
+export type OmitTypename<T> = Omit<T, "__typename">;
+
+export const isType =
+  <T extends string>(typename: T) =>
+  <N extends { __typename: string }>(
+    node: N | undefined | null
+  ): node is Extract<N, { __typename: T }> => {
+    return node?.__typename === typename;
+  };

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "target": "ESNext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "ESNext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    "lib": [
+      "DOM",
+      "ESNext"
+    ] /* Specify library files to be included in the compilation. */,
+    "allowJs": true,
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "dist" /* Redirect output structure to the directory. */,
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": false /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    /* Module Resolution Options */
+    "baseUrl": "./src" /* Base directory to resolve non-absolute module names. */,
+    "moduleResolution": "node16",
+    "types": [
+      "node"
+    ] /* Type declaration files to be included in compilation. */,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    /* Advanced Options */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["src"],
+  "exclude": ["test", "node_modules", "dist"]
+}