@refinedev/core 4.44.3 → 4.44.5

package/CHANGELOG.md

@@ -1,5 +1,109 @@
 # @refinedev/core
 
+## 4.44.5
+
+### Patch Changes
+
+-   [#5087](https://github.com/refinedev/refine/pull/5087) [`88d52d639b9`](https://github.com/refinedev/refine/commit/88d52d639b9e4590d70847812c47d3fb40fc6ebe) Thanks [@alicanerdurmaz](https://github.com/alicanerdurmaz)! - feat: `meta` props added `liveProvider.subscribe` and `liveProvider.publish` methods.
+    From now on, you can use `meta` to distinguish between methods by `meta`.
+
+    `meta` type:
+
+    ```ts
+    import { QueryFunctionContext } from "@tanstack/react-query";
+
+    type Fields = Array<string | object | NestedField>;
+
+    type VariableOptions =
+        | {
+              type?: string;
+              name?: string;
+              value: any;
+              list?: boolean;
+              required?: boolean;
+          }
+        | { [k: string]: any };
+
+    type Meta = {
+        dataProviderName?: string;
+        operation?: string;
+        fields?: Fields;
+        variables?: VariableOptions;
+        queryContext?: QueryFunctionContext;
+        [k: string]: any;
+    };
+    ```
+
+    #### Usage
+
+    ```ts
+    import { LiveProvider, LiveEvent } from "@refinedev/core";
+
+    export const liveProvider = (client: any): LiveProvider => {
+        return {
+            subscribe: ({ channel, types, params, callback, meta }) => {
+                console.log({ meta });
+            },
+
+            publish: ({ channel, type, payload, date, meta }: LiveEvent) => {
+                console.log({ meta });
+            },
+        };
+    };
+    ```
+
+## 4.44.4
+
+### Patch Changes
+
+-   [#5087](https://github.com/refinedev/refine/pull/5087) [`88d52d639b9`](https://github.com/refinedev/refine/commit/88d52d639b9e4590d70847812c47d3fb40fc6ebe) Thanks [@alicanerdurmaz](https://github.com/alicanerdurmaz)! - feat: `meta` props added `liveProvider.subscribe` and `liveProvider.publish` methods.
+    From now on, you can use `meta` to distinguish between methods by `meta`.
+
+    `meta` type:
+
+    ```ts
+    import { QueryFunctionContext } from "@tanstack/react-query";
+
+    type Fields = Array<string | object | NestedField>;
+
+    type VariableOptions =
+        | {
+              type?: string;
+              name?: string;
+              value: any;
+              list?: boolean;
+              required?: boolean;
+          }
+        | { [k: string]: any };
+
+    type Meta = {
+        dataProviderName?: string;
+        operation?: string;
+        fields?: Fields;
+        variables?: VariableOptions;
+        queryContext?: QueryFunctionContext;
+        [k: string]: any;
+    };
+    ```
+
+    #### Usage
+
+    ```ts
+    import { LiveProvider, LiveEvent } from "@refinedev/core";
+
+    export const liveProvider = (client: any): LiveProvider => {
+        return {
+            subscribe: ({ channel, types, params, callback, meta }) => {
+                console.log({ meta });
+            },
+
+            publish: ({ channel, type, payload, date, meta }: LiveEvent) => {
+                console.log({ meta });
+            },
+        };
+    };
+    ```
+
 ## 4.44.3
 
 ### Patch Changes

package/dist/contexts/live/ILiveContext.d.ts

@@ -7,6 +7,9 @@ export declare type ILiveContext = {
         params?: {
             ids?: BaseKey[];
             id?: BaseKey;
+            /**
+             * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
+             */
             meta?: MetaQuery;
             /**
              * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
@@ -28,7 +31,13 @@ export declare type ILiveContext = {
             [key: string]: any;
         };
         types: LiveEvent["type"][];
+        /**
+         * @deprecated use `meta.dataProviderName` instead.
+         */
         dataProviderName?: string;
+        meta?: MetaQuery & {
+            dataProviderName?: string;
+        };
         callback: (event: LiveEvent) => void;
     }) => any;
     unsubscribe: (subscription: any) => void;

package/dist/contexts/live/ILiveContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ILiveContext.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/ILiveContext.ts"],"names":[],"mappings":";AAAA,OAAO,EACH,OAAO,EACP,WAAW,EACX,WAAW,EACX,SAAS,EACT,SAAS,EACT,UAAU,EACb,MAAM,kBAAkB,CAAC;AAE1B,oBAAY,YAAY,GAClB;IACI,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,SAAS,EAAE,CAAC,OAAO,EAAE;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE;YACL,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;YAChB,EAAE,CAAC,EAAE,OAAO,CAAC;YACb,IAAI,CAAC,EAAE,SAAS,CAAC;YACjB;;eAEG;YACH,QAAQ,CAAC,EAAE,SAAS,CAAC;YACrB,UAAU,CAAC,EAAE,UAAU,CAAC;YACxB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC;YACnB,OAAO,CAAC,EAAE,WAAW,CAAC;YACtB,OAAO,CAAC,EAAE,WAAW,CAAC;YACtB,gBAAgB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;YACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;SACtB,CAAC;QACF,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;KACxC,KAAK,GAAG,CAAC;IACV,WAAW,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,CAAC;CAC5C,GACD,SAAS,CAAC;AAEhB,oBAAY,oBAAoB,GAAG;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"ILiveContext.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/ILiveContext.ts"],"names":[],"mappings":";AAAA,OAAO,EACH,OAAO,EACP,WAAW,EACX,WAAW,EACX,SAAS,EACT,SAAS,EACT,UAAU,EACb,MAAM,kBAAkB,CAAC;AAE1B,oBAAY,YAAY,GAClB;IACI,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,SAAS,EAAE,CAAC,OAAO,EAAE;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE;YACL,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;YAChB,EAAE,CAAC,EAAE,OAAO,CAAC;YACb;;eAEG;YACH,IAAI,CAAC,EAAE,SAAS,CAAC;YACjB;;eAEG;YACH,QAAQ,CAAC,EAAE,SAAS,CAAC;YACrB,UAAU,CAAC,EAAE,UAAU,CAAC;YACxB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC;YACnB,OAAO,CAAC,EAAE,WAAW,CAAC;YACtB,OAAO,CAAC,EAAE,WAAW,CAAC;YACtB,gBAAgB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;YACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;SACtB,CAAC;QACF,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,IAAI,CAAC,EAAE,SAAS,GAAG;YAAE,gBAAgB,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACjD,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;KACxC,KAAK,GAAG,CAAC;IACV,WAAW,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,CAAC;CAC5C,GACD,SAAS,CAAC;AAEhB,oBAAY,oBAAoB,GAAG;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,CAAC"}