monday-sdk-js 0.5.3 → 0.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",

package/types/client-data.interface.ts

@@ -1,10 +1,28 @@
 import { AppFeatureContextMap, AppFeatureTypes } from "./client-context.type";
 
+export type LocationResponse = Record<string, any> & {
+  href: string;
+  search: string;
+};
+
+export type FilterResponse = Record<string, any> & {
+  term: string;
+  rules: (Record<string, any> & {
+    column_id?: string;
+    compare_value?: string[];
+    compare_attribute?: string;
+    operator?: string;
+  })[];
+  operator: string | null;
+};
+
 type SubscribableEventsResponse<AppFeatureType extends AppFeatureTypes = AppFeatureTypes> = {
   context: AppFeatureContextMap[AppFeatureType];
   settings: Record<string, any>;
   itemIds: number[];
   events: Record<string, any>;
+  location: LocationResponse;
+  filter: FilterResponse;
 };
 
 type SubscribableEvents = keyof SubscribableEventsResponse;
@@ -54,6 +72,8 @@ export type GetterResponse<AppFeatureType extends AppFeatureTypes = AppFeatureTy
   settings: Record<string, any>;
   itemIds: number[];
   sessionToken: string;
+  location: LocationResponse;
+  filter: FilterResponse;
 };
 export interface ClientData {
   /**
@@ -80,6 +100,7 @@ export interface ClientData {
    * @param typeOrTypes The type, or array of types, of events to subscribe to
    * @param callback A callback function that is fired when the listener is triggered by a client-side event
    * @param params Reserved for future use
+   * @return Unsubscribe/unlisten from all added during this method call
    */
   listen<
     CustomResponse,
@@ -89,7 +110,7 @@ export interface ClientData {
     typeOrTypes: T | ReadonlyArray<T>,
     callback: (res: { data: SubscribableEventsResponse<AppFeatureType>[T] & CustomResponse }) => void,
     params?: Record<string, any> & { appFeatureType?: AppFeatureType }
-  ): void;
+  ): () => void;
 
   /**
    * Set data in your application, such as updating settings

package/types/index.d.ts

@@ -1,22 +1,24 @@
 // Original Definitions were contributed by: Josh Parnham <https://github.com/josh->
-import { MondayClientSdk } from './client-sdk.interface';
-import { MondayServerSdk } from './server-sdk.interface';
+import { MondayClientSdk } from "./client-sdk.interface";
+import { MondayServerSdk } from "./server-sdk.interface";
 
 export as namespace mondaySdk;
 
 declare function init(
-    config?: Partial<{
-        clientId: string;
-        apiToken: string;
-        apiVersion: string;
-    }>,
+  config?: Partial<{
+    clientId: string;
+    apiToken: string;
+    apiVersion: string;
+  }>
 ): MondayClientSdk;
 
 declare function init(
-    config?: Partial<{
-        token: string;
-        apiVersion: string;
-    }>,
+  config?: Partial<{
+    token: string;
+    apiVersion: string;
+  }>
 ): MondayServerSdk;
 
-export = init;
+export { MondayClientSdk, MondayServerSdk };
+
+export default init;