@lightsparkdev/core 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @lightsparkdev/core
 
+## 1.0.2
+
+### Patch Changes
+
+- 0e8767b: Add Logger for browser console and some debugging logs
+
+## 1.0.1
+
+### Patch Changes
+
+- 808c77a: Consolidate some imports to lightspark-sdk and core
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.cjs

@@ -35,6 +35,7 @@ __export(src_exports, {
   LightsparkAuthException: () => LightsparkAuthException_default,
   LightsparkException: () => LightsparkException_default,
   LightsparkSigningException: () => LightsparkSigningException_default,
+  Logger: () => Logger,
   NodeKeyCache: () => NodeKeyCache_default,
   RSASigningKey: () => RSASigningKey,
   Requester: () => Requester_default,
@@ -49,8 +50,12 @@ __export(src_exports, {
   bytesToHex: () => bytesToHex,
   convertCurrencyAmount: () => convertCurrencyAmount,
   createSha256Hash: () => createSha256Hash,
+  getErrorMsg: () => getErrorMsg,
   hexToBytes: () => hexToBytes,
   isBrowser: () => isBrowser,
+  isError: () => isError,
+  isErrorMsg: () => isErrorMsg,
+  isErrorWithMessage: () => isErrorWithMessage,
   isNode: () => isNode,
   isType: () => isType,
   urlsafe_b64decode: () => urlsafe_b64decode
@@ -452,6 +457,30 @@ var NodeKeyCache = class {
 };
 var NodeKeyCache_default = NodeKeyCache;
 
+// src/Logger.ts
+var Logger = class {
+  context;
+  loggingEnabled = false;
+  constructor(loggerContext) {
+    this.context = loggerContext;
+    if (isBrowser) {
+      try {
+        this.loggingEnabled = localStorage.getItem("lightspark-logging-enabled") === "1";
+      } catch (e) {
+      }
+    }
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] Logging enabled`);
+    }
+  }
+  info(message, ...rest) {
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] ${message}`, ...rest);
+    }
+  }
+};
+var logger = new Logger("@lightsparkdev/core");
+
 // src/requester/Requester.ts
 var import_auto_bind2 = __toESM(require("auto-bind"), 1);
 var import_dayjs = __toESM(require("dayjs"), 1);
@@ -503,6 +532,7 @@ var Requester = class {
     return query.constructObject(data);
   }
   subscribe(queryPayload, variables = {}) {
+    logger.info(`Requester.subscribe params`, queryPayload, variables);
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
     const operationMatch = queryPayload.match(operationNameRegex);
     if (!operationMatch || operationMatch.length < 3) {
@@ -526,13 +556,15 @@ var Requester = class {
       variables,
       operationName: operation
     };
-    return new import_zen_observable_ts.Observable(
-      (observer) => this.wsClient.subscribe(bodyData, {
+    logger.info(`Requester.subscribe bodyData`, bodyData);
+    return new import_zen_observable_ts.Observable((observer) => {
+      logger.info(`Requester.subscribe observer`, observer);
+      return this.wsClient.subscribe(bodyData, {
         next: (data) => observer.next(data),
         error: (err) => observer.error(err),
         complete: () => observer.complete()
-      })
-    );
+      });
+    });
   }
   async makeRawRequest(queryPayload, variables = {}, signingNodeId = void 0, skipAuth = false) {
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
@@ -667,7 +699,8 @@ var createSha256Hash = async (data) => {
     return new Uint8Array(await window.crypto.subtle.digest("SHA-256", data));
   } else {
     const { createHash } = await import("crypto");
-    return createHash("sha256").update(data).digest();
+    const buffer = createHash("sha256").update(data).digest();
+    return new Uint8Array(buffer);
   }
 };
 
@@ -741,6 +774,27 @@ var convertCurrencyAmount = (from, toUnit) => {
   };
 };
 
+// src/utils/errors.ts
+var isError = (e) => {
+  return Boolean(
+    typeof e === "object" && e !== null && "name" in e && typeof e.name === "string" && "message" in e && typeof e.message === "string" && "stack" in e && (!e.stack || typeof e.stack === "string")
+  );
+};
+var isErrorWithMessage = (e) => {
+  return Boolean(
+    typeof e === "object" && e !== null && "message" in e && typeof e.message === "string"
+  );
+};
+var getErrorMsg = (e) => {
+  return isErrorWithMessage(e) ? e.message : "Unknown error";
+};
+var isErrorMsg = (e, msg) => {
+  if (isError(e)) {
+    return e.message === msg;
+  }
+  return false;
+};
+
 // src/utils/hex.ts
 var bytesToHex = (bytes) => {
   return bytes.reduce((acc, byte) => {
@@ -766,6 +820,7 @@ var isType = (typename) => (node) => {
   LightsparkAuthException,
   LightsparkException,
   LightsparkSigningException,
+  Logger,
   NodeKeyCache,
   RSASigningKey,
   Requester,
@@ -780,8 +835,12 @@ var isType = (typename) => (node) => {
   bytesToHex,
   convertCurrencyAmount,
   createSha256Hash,
+  getErrorMsg,
   hexToBytes,
   isBrowser,
+  isError,
+  isErrorMsg,
+  isErrorWithMessage,
   isNode,
   isType,
   urlsafe_b64decode

package/dist/index.d.ts

@@ -101,6 +101,13 @@ declare class NodeKeyCache {
     private stripPemTags;
 }
 
+declare class Logger {
+    context: string;
+    loggingEnabled: boolean;
+    constructor(loggerContext: string);
+    info(message: string, ...rest: unknown[]): void;
+}
+
 type Query<T> = {
     /** The string representation of the query payload for graphQL. **/
     queryPayload: string;
@@ -196,6 +203,14 @@ declare const convertCurrencyAmount: (from: CurrencyAmount, toUnit: CurrencyUnit
 declare const isBrowser: boolean;
 declare const isNode: boolean;
 
+declare const isError: (e: unknown) => e is Error;
+type ErrorWithMessage = {
+    message: string;
+};
+declare const isErrorWithMessage: (e: unknown) => e is ErrorWithMessage;
+declare const getErrorMsg: (e: unknown) => string;
+declare const isErrorMsg: (e: unknown, msg: string) => boolean;
+
 declare const bytesToHex: (bytes: Uint8Array) => string;
 declare const hexToBytes: (hex: string) => Uint8Array;
 
@@ -213,4 +228,4 @@ declare const isType: <T extends string>(typename: T) => <N extends {
     __typename: T;
 }>;
 
-export { AuthProvider, ById, CryptoInterface, DefaultCrypto, ExpandRecursively, GeneratedKeyPair, KeyOrAlias, KeyOrAliasType, LightsparkAuthException, LightsparkException, LightsparkSigningException, Maybe, NodeKeyCache, OmitTypename, Query, RSASigningKey, Requester, Secp256k1SigningKey, ServerEnvironment, SigningKey, SigningKeyType, StubAuthProvider, apiDomainForEnvironment, b64decode, b64encode, bytesToHex, convertCurrencyAmount, createSha256Hash, hexToBytes, isBrowser, isNode, isType, urlsafe_b64decode };
+export { AuthProvider, ById, CryptoInterface, DefaultCrypto, ExpandRecursively, GeneratedKeyPair, KeyOrAlias, KeyOrAliasType, LightsparkAuthException, LightsparkException, LightsparkSigningException, Logger, Maybe, NodeKeyCache, OmitTypename, Query, RSASigningKey, Requester, Secp256k1SigningKey, ServerEnvironment, SigningKey, SigningKeyType, StubAuthProvider, apiDomainForEnvironment, b64decode, b64encode, bytesToHex, convertCurrencyAmount, createSha256Hash, getErrorMsg, hexToBytes, isBrowser, isError, isErrorMsg, isErrorWithMessage, isNode, isType, urlsafe_b64decode };

package/dist/index.js

@@ -393,6 +393,30 @@ var NodeKeyCache = class {
 };
 var NodeKeyCache_default = NodeKeyCache;
 
+// src/Logger.ts
+var Logger = class {
+  context;
+  loggingEnabled = false;
+  constructor(loggerContext) {
+    this.context = loggerContext;
+    if (isBrowser) {
+      try {
+        this.loggingEnabled = localStorage.getItem("lightspark-logging-enabled") === "1";
+      } catch (e) {
+      }
+    }
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] Logging enabled`);
+    }
+  }
+  info(message, ...rest) {
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] ${message}`, ...rest);
+    }
+  }
+};
+var logger = new Logger("@lightsparkdev/core");
+
 // src/requester/Requester.ts
 import autoBind2 from "auto-bind";
 import dayjs from "dayjs";
@@ -444,6 +468,7 @@ var Requester = class {
     return query.constructObject(data);
   }
   subscribe(queryPayload, variables = {}) {
+    logger.info(`Requester.subscribe params`, queryPayload, variables);
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
     const operationMatch = queryPayload.match(operationNameRegex);
     if (!operationMatch || operationMatch.length < 3) {
@@ -467,13 +492,15 @@ var Requester = class {
       variables,
       operationName: operation
     };
-    return new Observable(
-      (observer) => this.wsClient.subscribe(bodyData, {
+    logger.info(`Requester.subscribe bodyData`, bodyData);
+    return new Observable((observer) => {
+      logger.info(`Requester.subscribe observer`, observer);
+      return this.wsClient.subscribe(bodyData, {
         next: (data) => observer.next(data),
         error: (err) => observer.error(err),
         complete: () => observer.complete()
-      })
-    );
+      });
+    });
   }
   async makeRawRequest(queryPayload, variables = {}, signingNodeId = void 0, skipAuth = false) {
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
@@ -608,7 +635,8 @@ var createSha256Hash = async (data) => {
     return new Uint8Array(await window.crypto.subtle.digest("SHA-256", data));
   } else {
     const { createHash } = await import("crypto");
-    return createHash("sha256").update(data).digest();
+    const buffer = createHash("sha256").update(data).digest();
+    return new Uint8Array(buffer);
   }
 };
 
@@ -682,6 +710,27 @@ var convertCurrencyAmount = (from, toUnit) => {
   };
 };
 
+// src/utils/errors.ts
+var isError = (e) => {
+  return Boolean(
+    typeof e === "object" && e !== null && "name" in e && typeof e.name === "string" && "message" in e && typeof e.message === "string" && "stack" in e && (!e.stack || typeof e.stack === "string")
+  );
+};
+var isErrorWithMessage = (e) => {
+  return Boolean(
+    typeof e === "object" && e !== null && "message" in e && typeof e.message === "string"
+  );
+};
+var getErrorMsg = (e) => {
+  return isErrorWithMessage(e) ? e.message : "Unknown error";
+};
+var isErrorMsg = (e, msg) => {
+  if (isError(e)) {
+    return e.message === msg;
+  }
+  return false;
+};
+
 // src/utils/hex.ts
 var bytesToHex = (bytes) => {
   return bytes.reduce((acc, byte) => {
@@ -706,6 +755,7 @@ export {
   LightsparkAuthException_default as LightsparkAuthException,
   LightsparkException_default as LightsparkException,
   LightsparkSigningException_default as LightsparkSigningException,
+  Logger,
   NodeKeyCache_default as NodeKeyCache,
   RSASigningKey,
   Requester_default as Requester,
@@ -720,8 +770,12 @@ export {
   bytesToHex,
   convertCurrencyAmount,
   createSha256Hash,
+  getErrorMsg,
   hexToBytes,
   isBrowser,
+  isError,
+  isErrorMsg,
+  isErrorWithMessage,
   isNode,
   isType,
   urlsafe_b64decode

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [

package/src/Logger.ts

@@ -0,0 +1,30 @@
+import { isBrowser } from "./index.js";
+
+export class Logger {
+  context: string;
+  loggingEnabled = false;
+
+  constructor(loggerContext: string) {
+    this.context = loggerContext;
+    if (isBrowser) {
+      try {
+        this.loggingEnabled =
+          localStorage.getItem("lightspark-logging-enabled") === "1";
+      } catch (e) {
+        /* ignore */
+      }
+    }
+
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] Logging enabled`);
+    }
+  }
+
+  info(message: string, ...rest: unknown[]) {
+    if (this.loggingEnabled) {
+      console.log(`[${this.context}] ${message}`, ...rest);
+    }
+  }
+}
+
+export const logger = new Logger("@lightsparkdev/core");

package/src/index.ts

@@ -3,6 +3,7 @@
 export * from "./auth/index.js";
 export * from "./crypto/index.js";
 export { default as LightsparkException } from "./LightsparkException.js";
+export { Logger } from "./Logger.js";
 export * from "./requester/index.js";
 export {
   apiDomainForEnvironment,

package/src/requester/Requester.ts

@@ -16,6 +16,7 @@ import type { CryptoInterface } from "../crypto/crypto.js";
 import { DefaultCrypto, LightsparkSigningException } from "../crypto/crypto.js";
 import type NodeKeyCache from "../crypto/NodeKeyCache.js";
 import LightsparkException from "../LightsparkException.js";
+import { logger } from "../Logger.js";
 import { b64encode } from "../utils/base64.js";
 import { isNode } from "../utils/environment.js";
 
@@ -67,6 +68,7 @@ class Requester {
     queryPayload: string,
     variables: { [key: string]: unknown } = {},
   ) {
+    logger.info(`Requester.subscribe params`, queryPayload, variables);
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
     const operationMatch = queryPayload.match(operationNameRegex);
     if (!operationMatch || operationMatch.length < 3) {
@@ -92,13 +94,15 @@ class Requester {
       operationName: operation,
     };
 
-    return new Observable<{ data: T }>((observer) =>
-      this.wsClient.subscribe(bodyData, {
+    logger.info(`Requester.subscribe bodyData`, bodyData);
+    return new Observable<{ data: T }>((observer) => {
+      logger.info(`Requester.subscribe observer`, observer);
+      return this.wsClient.subscribe(bodyData, {
         next: (data) => observer.next(data as { data: T }),
         error: (err) => observer.error(err),
         complete: () => observer.complete(),
-      }),
-    );
+      });
+    });
   }
 
   public async makeRawRequest(

package/src/utils/createHash.ts

@@ -7,6 +7,7 @@ export const createSha256Hash = async (
     return new Uint8Array(await window.crypto.subtle.digest("SHA-256", data));
   } else {
     const { createHash } = await import("crypto");
-    return createHash("sha256").update(data).digest();
+    const buffer = createHash("sha256").update(data).digest();
+    return new Uint8Array(buffer);
   }
 };

package/src/utils/errors.ts

@@ -0,0 +1,36 @@
+export const isError = (e: unknown): e is Error => {
+  return Boolean(
+    typeof e === "object" &&
+      e !== null &&
+      "name" in e &&
+      typeof e.name === "string" &&
+      "message" in e &&
+      typeof e.message === "string" &&
+      "stack" in e &&
+      (!e.stack || typeof e.stack === "string"),
+  );
+};
+
+type ErrorWithMessage = {
+  message: string;
+};
+
+export const isErrorWithMessage = (e: unknown): e is ErrorWithMessage => {
+  return Boolean(
+    typeof e === "object" &&
+      e !== null &&
+      "message" in e &&
+      typeof e.message === "string",
+  );
+};
+
+export const getErrorMsg = (e: unknown): string => {
+  return isErrorWithMessage(e) ? e.message : "Unknown error";
+};
+
+export const isErrorMsg = (e: unknown, msg: string) => {
+  if (isError(e)) {
+    return e.message === msg;
+  }
+  return false;
+};

package/src/utils/index.ts

@@ -4,5 +4,6 @@ export * from "./base64.js";
 export * from "./createHash.js";
 export * from "./currency.js";
 export * from "./environment.js";
+export * from "./errors.js";
 export * from "./hex.js";
 export * from "./types.js";