@lightsparkdev/core 0.3.8 → 0.3.10

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @lightsparkdev/core
 
+## 0.3.10
+
+### Patch Changes
+
+- 141d73a: Enable/fix consistent-type-imports lint rule
+
+## 0.3.9
+
+### Patch Changes
+
+- 19c8513: Add lint to js packages
+
 ## 0.3.8
 
 ### Patch Changes

package/dist/index.cjs

@@ -89,7 +89,7 @@ var StubAuthProvider = class {
 var chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
 var Base64 = {
   btoa: (input = "") => {
-    let str = input;
+    const str = input;
     let output = "";
     for (let block = 0, charCode, i = 0, map = chars; str.charAt(i | 0) || (map = "=", i % 1); output += map.charAt(63 & block >> 8 - i % 1 * 8)) {
       charCode = str.charCodeAt(i += 3 / 4);
@@ -103,7 +103,7 @@ var Base64 = {
     return output;
   },
   atob: (input = "") => {
-    let str = input.replace(/=+$/, "");
+    const str = input.replace(/=+$/, "");
     let output = "";
     if (str.length % 4 == 1) {
       throw new Error(
@@ -205,8 +205,8 @@ var deriveKey = async (password, salt, iterations, algorithm, bit_len) => {
   return [key, iv];
 };
 var decrypt = async (header_json, ciphertext, password) => {
-  var decoded = b64decode(ciphertext);
-  var header;
+  let decoded = b64decode(ciphertext);
+  let header;
   if (header_json === "AES_256_CBC_PBKDF2_5000_SHA256") {
     header = {
       v: 0,
@@ -294,7 +294,6 @@ var serializeSigningKey = async (key, format) => {
   );
 };
 var getNonce = async () => {
-  const cryptoImpl = await getCrypto();
   const nonceSt = await getRandomValues32(new Uint32Array(1));
   return Number(nonceSt);
 };
@@ -452,7 +451,7 @@ var Requester = class {
       }
     }
     const operation = operationMatch[2];
-    let bodyData = {
+    const bodyData = {
       query: queryPayload,
       variables,
       operationName: operation
@@ -558,10 +557,13 @@ var Requester = class {
         "Missing node of encrypted_signing_private_key"
       );
     }
+    let TextEncoderImpl = TextEncoder;
     if (typeof TextEncoder === "undefined") {
-      const TextEncoder2 = (await import("text-encoding")).TextEncoder;
+      TextEncoderImpl = (await import("text-encoding")).TextEncoder;
     }
-    const encodedPayload = new TextEncoder().encode(JSON.stringify(payload));
+    const encodedPayload = new TextEncoderImpl().encode(
+      JSON.stringify(payload)
+    );
     const signedPayload = await this.cryptoImpl.sign(key, encodedPayload);
     const encodedSignedPayload = b64encode(signedPayload);
     headers["X-Lightspark-Signing"] = JSON.stringify({

package/dist/index.d.ts

@@ -1,30 +1,32 @@
 import { Observable } from 'zen-observable-ts';
 
+type Headers = Record<string, string>;
+type WsConnectionParams = Record<string, unknown>;
 interface AuthProvider {
-    addAuthHeaders(headers: any): Promise<any>;
+    addAuthHeaders(headers: Headers): Promise<Headers>;
     isAuthorized(): Promise<boolean>;
-    addWsConnectionParams(params: any): Promise<any>;
+    addWsConnectionParams(params: WsConnectionParams): Promise<WsConnectionParams>;
 }
 
 declare class LightsparkException extends Error {
     code: string;
     message: string;
-    extraInfo: any;
-    constructor(code: string, message: string, extraInfo?: any);
+    extraInfo: Record<string, unknown> | undefined;
+    constructor(code: string, message: string, extraInfo?: Record<string, unknown>);
 }
 
 declare class LightsparkAuthException extends LightsparkException {
-    constructor(message: string, extraInfo?: any);
+    constructor(message: string, extraInfo?: Record<string, unknown>);
 }
 
 declare class StubAuthProvider implements AuthProvider {
-    addAuthHeaders(headers: any): Promise<any>;
+    addAuthHeaders(headers: Headers): Promise<Headers>;
     isAuthorized(): Promise<boolean>;
-    addWsConnectionParams(params: any): Promise<any>;
+    addWsConnectionParams(params: WsConnectionParams): Promise<WsConnectionParams>;
 }
 
 declare class LightsparkSigningException extends LightsparkException {
-    constructor(message: string, extraInfo?: any);
+    constructor(message: string, extraInfo?: Record<string, unknown>);
 }
 
 type GeneratedKeyPair = {
@@ -79,7 +81,7 @@ type Query<T> = {
     queryPayload: string;
     /** The variables that will be passed to the query. **/
     variables?: {
-        [key: string]: any;
+        [key: string]: unknown;
     };
     /** The function that will be called to construct the object from the response. **/
     constructObject: (rawData: any) => T;
@@ -99,11 +101,13 @@ declare class Requester {
     private readonly wsClient;
     constructor(nodeKeyCache: NodeKeyCache, schemaEndpoint: string, sdkUserAgent: string, authProvider?: AuthProvider, baseUrl?: string, cryptoImpl?: CryptoInterface);
     executeQuery<T>(query: Query<T>): Promise<T | null>;
-    subscribe(queryPayload: string, variables?: {
-        [key: string]: any;
-    }): Observable<any>;
+    subscribe<T>(queryPayload: string, variables?: {
+        [key: string]: unknown;
+    }): Observable<{
+        data: T;
+    }>;
     makeRawRequest(queryPayload: string, variables?: {
-        [key: string]: any;
+        [key: string]: unknown;
     }, signingNodeId?: string | undefined, skipAuth?: boolean): Promise<any | null>;
     private getSdkUserAgent;
     private stripProtocol;

package/dist/index.js

@@ -37,7 +37,7 @@ var StubAuthProvider = class {
 var chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
 var Base64 = {
   btoa: (input = "") => {
-    let str = input;
+    const str = input;
     let output = "";
     for (let block = 0, charCode, i = 0, map = chars; str.charAt(i | 0) || (map = "=", i % 1); output += map.charAt(63 & block >> 8 - i % 1 * 8)) {
       charCode = str.charCodeAt(i += 3 / 4);
@@ -51,7 +51,7 @@ var Base64 = {
     return output;
   },
   atob: (input = "") => {
-    let str = input.replace(/=+$/, "");
+    const str = input.replace(/=+$/, "");
     let output = "";
     if (str.length % 4 == 1) {
       throw new Error(
@@ -153,8 +153,8 @@ var deriveKey = async (password, salt, iterations, algorithm, bit_len) => {
   return [key, iv];
 };
 var decrypt = async (header_json, ciphertext, password) => {
-  var decoded = b64decode(ciphertext);
-  var header;
+  let decoded = b64decode(ciphertext);
+  let header;
   if (header_json === "AES_256_CBC_PBKDF2_5000_SHA256") {
     header = {
       v: 0,
@@ -242,7 +242,6 @@ var serializeSigningKey = async (key, format) => {
   );
 };
 var getNonce = async () => {
-  const cryptoImpl = await getCrypto();
   const nonceSt = await getRandomValues32(new Uint32Array(1));
   return Number(nonceSt);
 };
@@ -400,7 +399,7 @@ var Requester = class {
       }
     }
     const operation = operationMatch[2];
-    let bodyData = {
+    const bodyData = {
       query: queryPayload,
       variables,
       operationName: operation
@@ -506,10 +505,13 @@ var Requester = class {
         "Missing node of encrypted_signing_private_key"
       );
     }
+    let TextEncoderImpl = TextEncoder;
     if (typeof TextEncoder === "undefined") {
-      const TextEncoder2 = (await import("text-encoding")).TextEncoder;
+      TextEncoderImpl = (await import("text-encoding")).TextEncoder;
     }
-    const encodedPayload = new TextEncoder().encode(JSON.stringify(payload));
+    const encodedPayload = new TextEncoderImpl().encode(
+      JSON.stringify(payload)
+    );
     const signedPayload = await this.cryptoImpl.sign(key, encodedPayload);
     const encodedSignedPayload = b64encode(signedPayload);
     headers["X-Lightspark-Signing"] = JSON.stringify({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/core",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [
@@ -48,14 +48,17 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "yarn build -- --watch",
     "clean": "rm -rf .turbo && rm -rf dist",
-    "lint": "npx prettier --check ./src",
-    "format": "prettier src --check",
+    "dev": "yarn build -- --watch",
     "format:fix": "prettier src --write",
+    "format": "prettier src --check",
+    "lint:fix": "eslint --fix .",
+    "lint:watch": "esw ./src -w --ext .ts,.tsx,.js --color",
+    "lint": "eslint .",
+    "postversion": "yarn build",
     "test": "echo \"TODO\"",
-    "types": "tsc",
-    "postversion": "yarn build"
+    "types:watch": "tsc-absolute --watch",
+    "types": "tsc"
   },
   "license": "Apache-2.0",
   "dependencies": {
@@ -70,13 +73,17 @@
     "zen-observable-ts": "^1.1.0"
   },
   "devDependencies": {
+    "@lightsparkdev/eslint-config": "*",
+    "@lightsparkdev/tsconfig": "0.0.0",
     "@types/crypto-js": "^4.1.1",
     "@types/ws": "^8.5.4",
+    "eslint": "^8.3.0",
+    "eslint-watch": "^8.0.0",
     "jest": "^29.4.1",
     "prettier": "2.8.7",
     "prettier-plugin-organize-imports": "^3.2.2",
     "ts-jest": "^29.0.5",
-    "tsconfig": "*",
+    "tsc-absolute": "^1.0.1",
     "tsup": "^6.7.0",
     "typescript": "^4.9.5"
   }

package/src/LightsparkException.ts

@@ -3,9 +3,13 @@
 class LightsparkException extends Error {
   code: string;
   message: string;
-  extraInfo: any;
+  extraInfo: Record<string, unknown> | undefined;
 
-  constructor(code: string, message: string, extraInfo?: any) {
+  constructor(
+    code: string,
+    message: string,
+    extraInfo?: Record<string, unknown>
+  ) {
     super(message);
     this.code = code;
     this.message = message;

package/src/auth/AuthProvider.ts

@@ -1,7 +1,12 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+export type Headers = Record<string, string>;
+export type WsConnectionParams = Record<string, unknown>;
+
 export default interface AuthProvider {
-  addAuthHeaders(headers: any): Promise<any>;
+  addAuthHeaders(headers: Headers): Promise<Headers>;
   isAuthorized(): Promise<boolean>;
-  addWsConnectionParams(params: any): Promise<any>;
+  addWsConnectionParams(
+    params: WsConnectionParams
+  ): Promise<WsConnectionParams>;
 }

package/src/auth/LightsparkAuthException.ts

@@ -3,7 +3,7 @@
 import LightsparkException from "../LightsparkException.js";
 
 class LightsparkAuthException extends LightsparkException {
-  constructor(message: string, extraInfo?: any) {
+  constructor(message: string, extraInfo?: Record<string, unknown>) {
     super("AuthException", message, extraInfo);
   }
 }

package/src/auth/StubAuthProvider.ts

@@ -1,16 +1,17 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import AuthProvider from "./AuthProvider.js";
+import type AuthProvider from "./AuthProvider.js";
+import { type Headers, type WsConnectionParams } from "./AuthProvider.js";
 
 export default class StubAuthProvider implements AuthProvider {
-  async addAuthHeaders(headers: any): Promise<any> {
+  async addAuthHeaders(headers: Headers) {
     return headers;
   }
   async isAuthorized(): Promise<boolean> {
     return false;
   }
 
-  async addWsConnectionParams(params: any): Promise<any> {
+  async addWsConnectionParams(params: WsConnectionParams) {
     return params;
   }
 }

package/src/crypto/LightsparkSigningException.ts

@@ -3,7 +3,7 @@
 import LightsparkException from "../LightsparkException.js";
 
 class LightsparkSigningException extends LightsparkException {
-  constructor(message: string, extraInfo?: any) {
+  constructor(message: string, extraInfo?: Record<string, unknown>) {
     super("SigningException", message, extraInfo);
   }
 }

package/src/crypto/NodeKeyCache.ts

@@ -3,8 +3,9 @@
 import autoBind from "auto-bind";
 
 import { b64decode } from "../utils/base64.js";
-import { CryptoInterface, DefaultCrypto } from "./crypto.js";
-import { KeyOrAliasType } from "./KeyOrAlias.js";
+import type { CryptoInterface } from "./crypto.js";
+import { DefaultCrypto } from "./crypto.js";
+import type { KeyOrAliasType } from "./KeyOrAlias.js";
 
 class NodeKeyCache {
   private idToKey: Map<string, CryptoKey | string>;

package/src/crypto/crypto.ts

@@ -122,9 +122,9 @@ const decrypt = async (
   ciphertext: string,
   password: string
 ): Promise<ArrayBuffer> => {
-  var decoded = b64decode(ciphertext);
+  let decoded = b64decode(ciphertext);
 
-  var header;
+  let header;
   if (header_json === "AES_256_CBC_PBKDF2_5000_SHA256") {
     header = {
       v: 0,
@@ -225,7 +225,6 @@ const serializeSigningKey = async (
 };
 
 const getNonce = async () => {
-  const cryptoImpl = await getCrypto();
   const nonceSt = await getRandomValues32(new Uint32Array(1));
   return Number(nonceSt);
 };

package/src/requester/Query.ts

@@ -5,10 +5,10 @@ type Query<T> = {
   queryPayload: string;
 
   /** The variables that will be passed to the query. **/
-  variables?: { [key: string]: any };
+  variables?: { [key: string]: unknown };
 
   /** The function that will be called to construct the object from the response. **/
-  constructObject: (rawData: any) => T;
+  constructObject: (rawData: any) => T; // eslint-disable-line @typescript-eslint/no-explicit-any -- LIG-3400
 
   /** The id of the node that will be used to sign the query. **/
   signingNodeId?: string;

package/src/requester/Requester.ts

@@ -3,20 +3,18 @@
 import autoBind from "auto-bind";
 import dayjs from "dayjs";
 import utc from "dayjs/plugin/utc.js";
-import { Client as WsClient, createClient } from "graphql-ws";
+import type { Client as WsClient } from "graphql-ws";
+import { createClient } from "graphql-ws";
 import NodeWebSocket from "ws";
 import { Observable } from "zen-observable-ts";
 
-import Query from "./Query.js";
+import type Query from "./Query.js";
 
-import AuthProvider from "../auth/AuthProvider.js";
+import type AuthProvider from "../auth/AuthProvider.js";
 import StubAuthProvider from "../auth/StubAuthProvider.js";
-import {
-  CryptoInterface,
-  DefaultCrypto,
-  LightsparkSigningException,
-} from "../crypto/crypto.js";
-import NodeKeyCache from "../crypto/NodeKeyCache.js";
+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 { b64encode } from "../utils/base64.js";
 import { isNode } from "../utils/environment.js";
@@ -65,10 +63,10 @@ class Requester {
     return query.constructObject(data);
   }
 
-  public subscribe(
+  public subscribe<T>(
     queryPayload: string,
-    variables: { [key: string]: any } = {}
-  ): Observable<any> {
+    variables: { [key: string]: unknown } = {}
+  ) {
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
     const operationMatch = queryPayload.match(operationNameRegex);
     if (!operationMatch || operationMatch.length < 3) {
@@ -88,15 +86,15 @@ class Requester {
       }
     }
     const operation = operationMatch[2];
-    let bodyData = {
+    const bodyData = {
       query: queryPayload,
       variables,
       operationName: operation,
     };
 
-    return new Observable((observer) =>
+    return new Observable<{ data: T }>((observer) =>
       this.wsClient.subscribe(bodyData, {
-        next: (data) => observer.next(data),
+        next: (data) => observer.next(data as { data: T }),
         error: (err) => observer.error(err),
         complete: () => observer.complete(),
       })
@@ -105,9 +103,10 @@ class Requester {
 
   public async makeRawRequest(
     queryPayload: string,
-    variables: { [key: string]: any } = {},
+    variables: { [key: string]: unknown } = {},
     signingNodeId: string | undefined = undefined,
     skipAuth: boolean = false
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any -- LIG-3400 */
   ): Promise<any | null> {
     const operationNameRegex = /^\s*(query|mutation|subscription)\s+(\w+)/i;
     const operationMatch = queryPayload.match(operationNameRegex);
@@ -191,9 +190,10 @@ class Requester {
   }
 
   private async addSigningDataIfNeeded(
-    queryPayload: { query: string; variables: any; operationName: string },
+    queryPayload: { query: string; variables: unknown; operationName: string },
     headers: { [key: string]: string },
     signingNodeId: string | undefined
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any -- LIG-3400 */
   ): Promise<any> {
     if (!signingNodeId) {
       return queryPayload;
@@ -221,10 +221,13 @@ class Requester {
       );
     }
 
+    let TextEncoderImpl = TextEncoder;
     if (typeof TextEncoder === "undefined") {
-      const TextEncoder = (await import("text-encoding")).TextEncoder;
+      TextEncoderImpl = (await import("text-encoding")).TextEncoder;
     }
-    const encodedPayload = new TextEncoder().encode(JSON.stringify(payload));
+    const encodedPayload = new TextEncoderImpl().encode(
+      JSON.stringify(payload)
+    );
     const signedPayload = await this.cryptoImpl.sign(key, encodedPayload);
     const encodedSignedPayload = b64encode(signedPayload);
 

package/src/utils/base64.ts

@@ -4,7 +4,7 @@ const chars =
   "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
 const Base64 = {
   btoa: (input: string = "") => {
-    let str = input;
+    const str = input;
     let output = "";
 
     for (
@@ -27,7 +27,7 @@ const Base64 = {
   },
 
   atob: (input: string = "") => {
-    let str = input.replace(/=+$/, "");
+    const str = input.replace(/=+$/, "");
     let output = "";
 
     if (str.length % 4 == 1) {