Upgrade dependencies, reformat comments in objects

.changeset/selfish-crabs-pull.md

@@ -0,0 +1,13 @@
+---
+"@lightsparkdev/lightspark-cli": patch
+"@lightsparkdev/lightspark-sdk": patch
+"@lightsparkdev/react-native": patch
+"@lightsparkdev/react-wallet": patch
+"@lightsparkdev/wallet-cli": patch
+"@lightsparkdev/wallet-sdk": patch
+"@lightsparkdev/oauth": patch
+"@lightsparkdev/core": patch
+"@lightsparkdev/ui": patch
+---
+
+Upgrade dependencies

.changeset/wicked-spoons-relate.md

@@ -0,0 +1,5 @@
+---
+"@lightsparkdev/ui": patch
+---
+
+[ui] Fix getHeadlineText return

.github/workflows/test-release-sync.yaml

@@ -32,6 +32,8 @@ jobs:
 
       - name: "Setup Node"
         uses: "actions/setup-node@v3"
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
         with:
           node-version-file: ".nvmrc"
 
@@ -76,6 +78,8 @@ jobs:
 
       - name: "Setup Node v${{ matrix.node-version }}"
         uses: "actions/setup-node@v3"
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -122,6 +126,8 @@ jobs:
 
       - name: "Setup Node"
         uses: "actions/setup-node@v3"
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
         with:
           node-version-file: ".nvmrc"
 
@@ -163,6 +169,8 @@ jobs:
 
       - name: "Setup Node v${{ matrix.node-version }}"
         uses: "actions/setup-node@v3"
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -197,6 +205,8 @@ jobs:
 
       - name: "Setup Node"
         uses: "actions/setup-node@v3"
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
         with:
           node-version-file: ".nvmrc"
 

README.md

@@ -33,4 +33,4 @@ Or to build all packages and run all examples simply do:
 yarn start
 ```
 
-Please see the README files in the [examples directory](./apps/examples) for instructions on running the examples. Please note that some packages such as @lightspark/ui are for building the examples only and not necessary for your implementation of our [published SDK packages](https://www.npmjs.com/search?q=%40lightsparkdev).
+Please see the README files in the [examples directory](./apps/examples) for instructions on running the examples. Please note that some packages such as @lightsparkdev/ui are for building the examples only and not necessary for your implementation of our [published SDK packages](https://www.npmjs.com/search?q=%40lightsparkdev).

apps/examples/jwt-server/.eslintrc.cjs

@@ -1,31 +1,12 @@
 module.exports = {
-  root: true,
-  env: {
-    es6: true,
-    node: true,
-  },
-  extends: [
-    "eslint:recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "google",
-    "plugin:@typescript-eslint/recommended",
-  ],
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    project: ["tsconfig.json", "tsconfig.dev.json"],
-    sourceType: "module",
-  },
-  ignorePatterns: [
-    "/lib/**/*", // Ignore built files.
-  ],
+  extends: ["@lightsparkdev/eslint-config/base", "google"],
   plugins: ["@typescript-eslint", "import"],
   rules: {
-    "quotes": ["error", "double"],
+    quotes: ["error", "double"],
     "import/no-unresolved": 0,
-    "indent": ["error", 2],
+    indent: ["error", 2],
     "max-len": ["error", { code: 120 }],
     "object-curly-spacing": ["error", "always"],
+    "quote-props": ["off"],
   },
 };

apps/examples/jwt-server/package.json

@@ -15,20 +15,22 @@
   "engines": {
     "node": "18"
   },
-  "main": "lib/index.js",
+  "main": "dist/index.js",
   "dependencies": {
     "@lightsparkdev/lightspark-sdk": "^1.2.0",
     "firebase-admin": "^11.9.0",
     "firebase-functions": "^4.4.1",
     "jsonwebtoken": "^9.0.1"
   },
   "devDependencies": {
+    "@lightsparkdev/eslint-config": "*",
     "@types/zen-observable": "^0.8.5",
     "@typescript-eslint/eslint-plugin": "^6.2.0",
     "@typescript-eslint/parser": "^6.7.4",
     "eslint": "^8.3.0",
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-import": "^2.26.0",
+    "eslint-watch": "^8.0.0",
     "firebase-functions-test": "^3.0.0",
     "typescript": "^5.0.0"
   },

apps/examples/jwt-server/src/index.ts

@@ -40,7 +40,7 @@ export const getJwt = onRequest(
         .status(500)
         .send(
           "Missing account config. Please add account_id and " +
-            "private_signing_key to the firebase config.",
+            "private_signing_key to the firebase config."
         );
       return;
     }
@@ -62,7 +62,7 @@ export const getJwt = onRequest(
 
     logger.info("Generating JWT for a user", { userId, accountId });
     response.send({ token, accountId });
-  },
+  }
 );
 
 export const handleWebhook = onRequest(
@@ -73,23 +73,24 @@ export const handleWebhook = onRequest(
     const event = await verifyAndParseWebhook(
       bodyData,
       hexdigest,
-      webhookSecretParam.value(),
+      webhookSecretParam.value()
     );
     console.log(`Received webhook event: ${event.event_type}`);
     console.log(`Event data: ${JSON.stringify(event)}`);
 
-    // From here, you could take some action based on the event type. For example:
-    // if (event.event_type === WebhookEventType.WALLET_INCOMING_PAYMENT_FINISHED) {
-    //   const payment = await lightsparkClient.executeRawQuery(
-    //       IncomingPayment.getIncomingPaymentQuery(event.entity_id)
-    //   );
-    //   console.log(`Incoming payment: ${JSON.stringify(payment)}`);
-    //   const wallet = await lightsparkClient.executeRawQuery(Wallet.getWalletQuery(payment.wallet_id));
-    //   await sendPaymentReceivedNotification(wallet.thirdPartyIdentifier, payment.amount);
-    // }
+    // From here, you could take some action based on the event type. For
+    // example: if (event.event_type ===
+    // WebhookEventType.WALLET_INCOMING_PAYMENT_FINISHED) { const payment =
+    // await lightsparkClient.executeRawQuery(
+    // IncomingPayment.getIncomingPaymentQuery(event.entity_id) );
+    // console.log(`Incoming payment: ${JSON.stringify(payment)}`);
+    // const wallet = await
+    // lightsparkClient.executeRawQuery(Wallet.getWalletQuery(payment.wallet_id));
+    // await sendPaymentReceivedNotification(wallet.thirdPartyIdentifier,
+    // payment.amount); }
 
     response.send("ok");
-  },
+  }
 );
 
 const checkOrCreateUser = async (userId: string, password: string) => {

apps/examples/jwt-server/tsconfig.json

@@ -4,7 +4,7 @@
     "moduleResolution": "node",
     "noImplicitReturns": true,
     "noUnusedLocals": true,
-    "outDir": "lib",
+    "outDir": "dist",
     "sourceMap": true,
     "strict": true,
     "target": "es2017",

apps/examples/ls-react-native-crypto-app/app.json

@@ -1,6 +1,6 @@
 {
   "expo": {
-    "name": "ls-react-native-crypto-example",
+    "name": "@lightsparkdev/ls-react-native-crypto-example",
     "slug": "ls-react-native-crypto-example",
     "version": "1.0.0",
     "orientation": "portrait",
@@ -11,9 +11,7 @@
       "resizeMode": "contain",
       "backgroundColor": "#ffffff"
     },
-    "assetBundlePatterns": [
-      "**/*"
-    ],
+    "assetBundlePatterns": ["**/*"],
     "ios": {
       "supportsTablet": true,
       "bundleIdentifier": "com.lightspark.sdk.rn.crypto.example"

apps/examples/remote-signing-server/tsconfig.json

@@ -1,3 +1,3 @@
 {
-  "extends": "@lightsparkdev/tsconfig/ts-node-app.json"
+  "extends": "../../../packages/tsconfig/ts-node-app.json"
 }

apps/examples/uma-vasp/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@lightsparkdev/tsconfig/ts-node-app.json",
+  "extends": "../../../packages/tsconfig/ts-node-app.json",
   "compilerOptions": {
     "types": ["node", "jest"]
   }

package.json

@@ -25,8 +25,7 @@
     "lint": "turbo run lint",
     "lint:fix": "turbo run lint:fix",
     "release": "turbo build && changeset publish",
-    "start:check": "turbo run build && turbo run build:watch start types:watch lint:watch --parallel --concurrency 200",
-    "start": "turbo run build && turbo run build:watch start --concurrency 200",
+    "start": "./start.sh",
     "test": "turbo run test",
     "test:hermetic-integration": "turbo run test:hermetic-integration",
     "test:integration": "turbo run test:integration",

packages/core/src/constants/localStorage.ts

@@ -5,6 +5,11 @@ export const ConfigKeys = {
 export type ConfigKeys = (typeof ConfigKeys)[keyof typeof ConfigKeys];
 
 export const getLocalStorageConfigItem = (key: ConfigKeys) => {
+  return getLocalStorageBoolean(key);
+};
+
+export const getLocalStorageBoolean = (key: string) => {
+  /* localStorage is not available in all contexts, use try/catch: */
   try {
     return localStorage.getItem(key) === "1";
   } catch (e) {

packages/core/src/utils/errors.ts

@@ -1,3 +1,5 @@
+import { type JSONType } from "./types.js";
+
 export const isError = (e: unknown): e is Error => {
   return Boolean(
     typeof e === "object" &&
@@ -34,3 +36,17 @@ export const isErrorMsg = (e: unknown, msg: string) => {
   }
   return false;
 };
+
+export function errorToJSON(err: unknown) {
+  if (
+    typeof err === "object" &&
+    err !== null &&
+    "toJSON" in err &&
+    typeof err.toJSON === "function"
+  ) {
+    return err.toJSON() as JSONType;
+  }
+  return JSON.parse(
+    JSON.stringify(err, Object.getOwnPropertyNames(err)),
+  ) as JSONType;
+}

packages/core/src/utils/types.ts

@@ -27,3 +27,7 @@ export type DeepPartial<T> = T extends object
       [P in keyof T]?: DeepPartial<T[P]>;
     }
   : T;
+
+export type JSONLiteral = string | number | boolean | null;
+export type JSONType = JSONLiteral | JSONType[] | { [key: string]: JSONType };
+export type JSONObject = { [key: string]: JSONType };

packages/core/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@lightsparkdev/tsconfig/base.json",
+  "extends": "../tsconfig/base.json",
   "include": ["src", "src/crypto/types.ts"],
   "exclude": ["**/tests", "node_modules", "dist"]
 }

packages/eslint-config/base.js

@@ -2,7 +2,7 @@ const path = require("path");
 
 const commentOptions = {
   mode: "overflow-only",
-  maxLength: 80,
+  maxLength: 100,
   logicalWrap: true,
   ignoreUrls: true,
   ignoreCommentsWithCode: true,

packages/eslint-config/react-app.js

@@ -20,7 +20,7 @@ module.exports = {
             importNames: ["Link", "Navigate", "useNavigate"],
             message:
               "Please use typesafe imports from components/router instead.",
-            name: "@lightsparkdev/ui/src/router",
+            name: "@lightsparkdev/ui/router",
           },
           {
             importNames: ["default", "QRCodeSVG"],

packages/lightspark-cli/README.md

@@ -8,7 +8,7 @@ The `lightspark` script is a wrapper around the `lightspark-sdk` which can simpl
 
 The first command you'll need to run get set up is init-env.
 
-You'll need to provide your API token's client ID and client secret. You can set this up from the [Lightspark API config page](https://app.lightspark.com/api-config). For more info on API authentication, see the [Lightspark API Authentication docs](https://app.lightspark.com/docs/api/authentication).
+You'll need to provide your API token's client ID and client secret. You can set this up from the [Lightspark API config page](https://app.lightspark.com/api-config). For more info on API authentication, see the [Lightspark API Authentication docs](https://docs.lightspark.com/lightspark-sdk/authentication?language=Typescript).
 
 If you run it without any arguments, it will prompt you for your API token's client ID and client secret:
 

packages/lightspark-cli/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@lightsparkdev/tsconfig/ts-node-app.json",
+  "extends": "../tsconfig/ts-node-app.json",
   "compilerOptions": {
     "outDir": "dist",
     "rootDir": "src"

packages/lightspark-sdk/src/objects/Account.ts

@@ -28,8 +28,8 @@ import type TransactionType from "./TransactionType.js";
 
 /**
  * This is an object representing the connected Lightspark account.
- * You can retrieve this object to see your account information and objects
- * tied to your account. *
+ * You can retrieve this object to see your account information and objects tied to your account.
+ * *
  */
 class Account implements LightsparkNodeOwner, Entity {
   constructor(

packages/lightspark-sdk/src/objects/AccountToApiTokensConnection.ts

@@ -8,15 +8,12 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 interface AccountToApiTokensConnection {
   /**
    * 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).
+   * It is different from the number of objects returned in the current page (in the `entities`
+   * field).
    **/
   count: number;
 
-  /**
-   * An object that holds pagination information about the objects in this
-   * connection. *
-   */
+  /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
   /** The API tokens for the current page of this connection. **/

packages/lightspark-sdk/src/objects/AccountToChannelsConnection.ts

@@ -7,9 +7,9 @@ import { ChannelFromJson } from "./Channel.js";
 class AccountToChannelsConnection {
   constructor(
     /**
-     * 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).
+     * 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).
      **/
     public readonly count: number,
     /** The channels for the current page of this connection. **/

packages/lightspark-sdk/src/objects/AccountToNodesConnection.ts

@@ -12,15 +12,12 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 interface AccountToNodesConnection {
   /**
    * 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).
+   * It is different from the number of objects returned in the current page (in the `entities`
+   * field).
    **/
   count: number;
 
-  /**
-   * An object that holds pagination information about the objects in this
-   * connection. *
-   */
+  /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
   /** The nodes for the current page of this connection. **/