@knocklabs/client 0.10.8 → 0.10.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.10.8",
+  "version": "0.10.10",
   "description": "The clientside library for interacting with Knock",
   "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
   "author": "@knocklabs",
@@ -33,15 +33,14 @@
   },
   "scripts": {
     "dev": "tsc && vite build --watch --emptyOutDir false",
-    "lint": "eslint \"src/**/*.+(ts|js|tsx)\"",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
     "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check",
     "test": "vitest run",
     "test:watch": "vitest",
+    "type:check": "tsc --noEmit",
     "coverage": "vitest run --coverage",
     "clean": "rimraf dist",
-    "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch",
     "build": "yarn clean && yarn build:cjs && yarn build:esm",
     "build:esm": "BUILD_TARGET=esm;  vite build",
     "build:cjs": "BUILD_TARGET=cjs;  vite build",
@@ -56,22 +55,22 @@
     "@babel/preset-env": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
     "@types/jsonwebtoken": "^9.0.5",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "cross-env": "^7.0.3",
     "crypto": "^1.0.1",
-    "eslint": "^8.53.0",
+    "eslint": "^8.56.0",
     "jsonwebtoken": "^9.0.2",
     "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
     "rollup": "^2.46.0",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.3",
     "vite": "^5.0.0",
     "vitest": "^1.2.2"
   },
   "dependencies": {
     "@babel/runtime": "^7.23.9",
-    "@knocklabs/types": "^0.1.3",
+    "@knocklabs/types": "^0.1.4",
     "@types/phoenix": "^1.5.4",
     "axios": "^1.6.0",
     "axios-retry": "^3.1.9",

package/src/api.ts

@@ -50,7 +50,6 @@ class ApiClient {
       });
     }
 
-    // @ts-ignore
     axiosRetry(this.axiosClient, {
       retries: 3,
       retryCondition: this.canRetryRequest,

package/src/clients/feed/feed.ts

@@ -1,3 +1,4 @@
+import { GenericData } from "@knocklabs/types";
 import EventEmitter from "eventemitter2";
 import { Channel } from "phoenix";
 import { StoreApi } from "zustand";
@@ -42,9 +43,9 @@ class Feed {
   private defaultOptions: FeedClientOptions;
   private broadcastChannel!: BroadcastChannel | null;
   private disconnectTimer: ReturnType<typeof setTimeout> | null = null;
-  private hasSubscribedToRealTimeUpdates: Boolean = false;
+  private hasSubscribedToRealTimeUpdates: boolean = false;
   private visibilityChangeHandler: () => void = () => {};
-  private visibilityChangeListenerConnected: Boolean = false;
+  private visibilityChangeListenerConnected: boolean = false;
 
   // The raw store instance, used for binding in React and other environments
   public store: StoreApi<FeedStoreState>;
@@ -112,7 +113,6 @@ class Feed {
     this.teardown();
     this.broadcaster.removeAllListeners();
     this.knock.feeds.removeInstance(this);
-    this.store.destroy();
   }
 
   /*
@@ -660,7 +660,7 @@ class Feed {
     }
   }
 
-  private broadcastOverChannel(type: string, payload: any) {
+  private broadcastOverChannel(type: string, payload: GenericData) {
     // The broadcastChannel may not be available in non-browser environments
     if (!this.broadcastChannel) {
       return;

package/src/clients/feed/interfaces.ts

@@ -94,7 +94,7 @@ export interface FeedMetadata {
   unseen_count: number;
 }
 
-export interface FeedResponse<T = any> {
+export interface FeedResponse<T = GenericData> {
   entries: FeedItem<T>[];
   meta: FeedMetadata;
   page_info: PageInfo;

package/src/clients/feed/store.ts

@@ -1,3 +1,4 @@
+import { GenericData } from "@knocklabs/types";
 import create from "zustand/vanilla";
 
 import { NetworkStatus } from "../../networkStatus";
@@ -53,7 +54,7 @@ export default function createStore() {
       set((state) => {
         // We resort the list on set, so concating everything is fine (if a bit suboptimal)
         const items = options.shouldAppend
-          ? processItems(state.items.concat(entries))
+          ? processItems(state.items.concat(entries as FeedItem<GenericData>[]))
           : entries;
 
         return {

package/src/clients/feed/types.ts

@@ -1,4 +1,4 @@
-import { PageInfo } from "@knocklabs/types";
+import { GenericData, PageInfo } from "@knocklabs/types";
 
 import { NetworkStatus } from "../../networkStatus";
 
@@ -51,7 +51,7 @@ export type FeedEvent =
 // Because we can bind to wild card feed events, this is here to accomodate whatever can be bound to
 export type BindableFeedEvent = FeedEvent | "items.received.*" | "items.*";
 
-export interface FeedEventPayload<T = any> {
+export interface FeedEventPayload<T = GenericData> {
   event: Omit<FeedEvent, "messages.new">;
   items: FeedItem<T>[];
   metadata: FeedMetadata;

package/src/clients/messages/index.ts

@@ -75,7 +75,7 @@ class MessageClient {
     return this.handleResponse<BulkOperation>(result);
   }
 
-  private handleResponse<T = any>(response: ApiResponse) {
+  private handleResponse<T = unknown>(response: ApiResponse) {
     if (response.statusCode === "error") {
       if (response.error?.response?.status < 500) {
         return response.error || response.body;

package/src/clients/messages/interfaces.ts

@@ -1,3 +1,5 @@
+import { GenericData } from "@knocklabs/types";
+
 import { RecipientRef } from "../..";
 
 export type MessageDeliveryStatus =
@@ -20,7 +22,7 @@ export type MessageEngagementStatus =
   | "interacted"
   | "archived";
 
-export interface Message<T = any> {
+export interface Message<T = GenericData> {
   id: string;
   channel_id: string;
   recipient: RecipientRef;

package/src/clients/objects/index.ts

@@ -1,3 +1,5 @@
+import { GenericData } from "@knocklabs/types";
+
 import { ApiResponse } from "../../api";
 import { ChannelData } from "../../interfaces";
 import Knock from "../../knock";
@@ -12,7 +14,7 @@ type SetChannelDataInput = {
   objectId: string;
   collection: string;
   channelId: string;
-  data: any;
+  data: GenericData;
 };
 
 class ObjectClient {
@@ -21,7 +23,7 @@ class ObjectClient {
   constructor(instance: Knock) {
     this.instance = instance;
   }
-  async getChannelData<T = any>({
+  async getChannelData<T = GenericData>({
     collection,
     objectId,
     channelId,

package/src/clients/preferences/index.ts

@@ -1,13 +1,15 @@
 import { ChannelType } from "@knocklabs/types";
+
 import { ApiResponse } from "../../api";
 import Knock from "../../knock";
+
 import {
   ChannelTypePreferences,
   PreferenceOptions,
+  PreferenceSet,
   SetPreferencesProperties,
   WorkflowPreferenceSetting,
   WorkflowPreferences,
-  PreferenceSet,
 } from "./interfaces";
 
 const DEFAULT_PREFERENCE_SET_ID = "default";

package/src/clients/users/index.ts

@@ -1,3 +1,5 @@
+import { GenericData } from "@knocklabs/types";
+
 import { ApiResponse } from "../../api";
 import { ChannelData, User } from "../../interfaces";
 import Knock from "../../knock";
@@ -28,7 +30,7 @@ class UserClient {
     return this.handleResponse<User>(result);
   }
 
-  async identify(props: Record<string, any> = {}) {
+  async identify(props: GenericData = {}) {
     const result = await this.instance.client().makeRequest({
       method: "PUT",
       url: `/v1/users/${this.instance.userId}`,
@@ -76,7 +78,7 @@ class UserClient {
     return this.handleResponse<PreferenceSet>(result);
   }
 
-  async getChannelData<T = any>(params: GetChannelDataInput) {
+  async getChannelData<T = GenericData>(params: GetChannelDataInput) {
     const result = await this.instance.client().makeRequest({
       method: "GET",
       url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,
@@ -85,7 +87,7 @@ class UserClient {
     return this.handleResponse<ChannelData<T>>(result);
   }
 
-  async setChannelData<T = any>({
+  async setChannelData<T = GenericData>({
     channelId,
     channelData,
   }: SetChannelDataInput) {

package/src/clients/users/interfaces.ts

@@ -1,6 +1,8 @@
+import { GenericData } from "@knocklabs/types";
+
 export interface SetChannelDataInput {
   channelId: string;
-  channelData: Record<string, any>;
+  channelData: GenericData;
 }
 
 export interface GetChannelDataInput {

package/src/interfaces.ts

@@ -1,4 +1,5 @@
 import { GenericData } from "@knocklabs/types";
+import { JwtPayload } from "jwt-decode";
 
 export type LogLevel = "debug";
 
@@ -38,14 +39,14 @@ export interface Activity<T = GenericData> {
   data: T | null;
 }
 
-export interface ChannelData<T = any> {
+export interface ChannelData<T = GenericData> {
   channel_id: string;
   data: T;
 }
 
 export type UserTokenExpiringCallback = (
   currentToken: string,
-  decodedToken: any,
+  decodedToken: JwtPayload,
 ) => Promise<string | void>;
 
 export interface AuthenticateOptions {