@refinedev/core 4.44.2 → 4.44.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/CHANGELOG.md +120 -0
  2. package/dist/contexts/live/ILiveContext.d.ts +9 -0
  3. package/dist/contexts/live/ILiveContext.d.ts.map +1 -1
  4. package/dist/esm/index.js +6 -6
  5. package/dist/esm/index.js.map +1 -1
  6. package/dist/hooks/data/useCreate.d.ts.map +1 -1
  7. package/dist/hooks/data/useCreateMany.d.ts.map +1 -1
  8. package/dist/hooks/data/useDelete.d.ts.map +1 -1
  9. package/dist/hooks/data/useDeleteMany.d.ts.map +1 -1
  10. package/dist/hooks/data/useInfiniteList.d.ts.map +1 -1
  11. package/dist/hooks/data/useList.d.ts.map +1 -1
  12. package/dist/hooks/data/useMany.d.ts.map +1 -1
  13. package/dist/hooks/data/useOne.d.ts.map +1 -1
  14. package/dist/hooks/data/useUpdate.d.ts.map +1 -1
  15. package/dist/hooks/data/useUpdateMany.d.ts.map +1 -1
  16. package/dist/hooks/live/useResourceSubscription/index.d.ts +10 -1
  17. package/dist/hooks/live/useResourceSubscription/index.d.ts.map +1 -1
  18. package/dist/hooks/live/useSubscription/index.d.ts +8 -3
  19. package/dist/hooks/live/useSubscription/index.d.ts.map +1 -1
  20. package/dist/iife/index.js +5 -5
  21. package/dist/iife/index.js.map +1 -1
  22. package/dist/index.js +5 -5
  23. package/dist/index.js.map +1 -1
  24. package/dist/interfaces/live/LiveEvent.d.ts +4 -1
  25. package/dist/interfaces/live/LiveEvent.d.ts.map +1 -1
  26. package/package.json +1 -1
  27. package/src/contexts/live/ILiveContext.ts +7 -0
  28. package/src/hooks/data/useCreate.ts +24 -20
  29. package/src/hooks/data/useCreateMany.ts +24 -21
  30. package/src/hooks/data/useDelete.ts +23 -15
  31. package/src/hooks/data/useDeleteMany.ts +23 -14
  32. package/src/hooks/data/useInfiniteList.ts +4 -0
  33. package/src/hooks/data/useList.ts +4 -0
  34. package/src/hooks/data/useMany.ts +4 -0
  35. package/src/hooks/data/useOne.ts +4 -0
  36. package/src/hooks/data/useUpdate.ts +23 -10
  37. package/src/hooks/data/useUpdateMany.ts +23 -15
  38. package/src/hooks/live/useResourceSubscription/index.ts +19 -2
  39. package/src/hooks/live/useSubscription/index.ts +10 -2
  40. package/src/interfaces/live/LiveEvent.ts +4 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,125 @@
1
1
  # @refinedev/core
2
2
 
3
+ ## 4.44.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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.
8
+ From now on, you can use `meta` to distinguish between methods by `meta`.
9
+
10
+ `meta` type:
11
+
12
+ ```ts
13
+ import { QueryFunctionContext } from "@tanstack/react-query";
14
+
15
+ type Fields = Array<string | object | NestedField>;
16
+
17
+ type VariableOptions =
18
+ | {
19
+ type?: string;
20
+ name?: string;
21
+ value: any;
22
+ list?: boolean;
23
+ required?: boolean;
24
+ }
25
+ | { [k: string]: any };
26
+
27
+ type Meta = {
28
+ dataProviderName?: string;
29
+ operation?: string;
30
+ fields?: Fields;
31
+ variables?: VariableOptions;
32
+ queryContext?: QueryFunctionContext;
33
+ [k: string]: any;
34
+ };
35
+ ```
36
+
37
+ #### Usage
38
+
39
+ ```ts
40
+ import { LiveProvider, LiveEvent } from "@refinedev/core";
41
+
42
+ export const liveProvider = (client: any): LiveProvider => {
43
+ return {
44
+ subscribe: ({ channel, types, params, callback, meta }) => {
45
+ console.log({ meta });
46
+ },
47
+
48
+ publish: ({ channel, type, payload, date, meta }: LiveEvent) => {
49
+ console.log({ meta });
50
+ },
51
+ };
52
+ };
53
+ ```
54
+
55
+ ## 4.44.3
56
+
57
+ ### Patch Changes
58
+
59
+ - [#5050](https://github.com/refinedev/refine/pull/5050) [`613af0021f6`](https://github.com/refinedev/refine/commit/613af0021f6a48be3e048678102738c912ee981f) Thanks [@alicanerdurmaz](https://github.com/alicanerdurmaz)! - feat: pass `dataProviderName` to `liveProvider.subscribe` method.
60
+ From now on, you can use `dataProviderName` to distinguish between different data providers in live provider.
61
+
62
+ [Refer to documentation for more info about multiple data providers ->](https://refine.dev/docs/api-reference/core/providers/data-provider/#multiple-data-providers)
63
+
64
+ #### Usage
65
+
66
+ ```ts
67
+ import { useForm, useList } from "@refinedev/core";
68
+
69
+ useList({
70
+ dataProviderName: "first-data-provider",
71
+ });
72
+
73
+ useForm({
74
+ dataProviderName: "second-data-provider",
75
+ });
76
+ ```
77
+
78
+ ```ts
79
+ import { LiveProvider } from "@refinedev/core";
80
+
81
+ export const liveProvider = (client: any): LiveProvider => {
82
+ return {
83
+ subscribe: ({
84
+ channel,
85
+ types,
86
+ params,
87
+ callback,
88
+ dataProviderName,
89
+ }) => {
90
+ console.log({ dataProviderName }); // "second-data-provider"
91
+ },
92
+ };
93
+ };
94
+ ```
95
+
96
+ - [#5053](https://github.com/refinedev/refine/pull/5053) [`857d4020a30`](https://github.com/refinedev/refine/commit/857d4020a30d518178fa4f3bce8eeb509c9bb6d2) Thanks [@alicanerdurmaz](https://github.com/alicanerdurmaz)! - feat: The parameter types of data provider methods have been exported.
97
+ From now on, you can use the parameter types of Data Provider methods.
98
+
99
+ ```ts
100
+ import type {
101
+ DataProvider,
102
+ GetListResponse
103
+ // new exported types
104
+ GetListParams,
105
+ GetManyParams,
106
+ GetOneParams,
107
+ CreateParams,
108
+ CreateManyParams,
109
+ UpdateParams,
110
+ UpdateManyParams,
111
+ DeleteOneParams,
112
+ DeleteManyParams,
113
+ CustomParams,
114
+ } from "@refinedev/core";
115
+
116
+ const myDataProvider: DataProvider = {
117
+ getList: async (params: GetListParams): Promise<GetListResponse<any>> => {
118
+ return { data: [], total: 0 };
119
+ },
120
+ };
121
+ ```
122
+
3
123
  ## 4.44.2
4
124
 
5
125
  ### Patch Changes
@@ -7,6 +7,9 @@ export declare type ILiveContext = {
7
7
  params?: {
8
8
  ids?: BaseKey[];
9
9
  id?: BaseKey;
10
+ /**
11
+ * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
12
+ */
10
13
  meta?: MetaQuery;
11
14
  /**
12
15
  * @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 = {
28
31
  [key: string]: any;
29
32
  };
30
33
  types: LiveEvent["type"][];
34
+ /**
35
+ * @deprecated use `meta.dataProviderName` instead.
36
+ */
31
37
  dataProviderName?: string;
38
+ meta?: MetaQuery & {
39
+ dataProviderName?: string;
40
+ };
32
41
  callback: (event: LiveEvent) => void;
33
42
  }) => any;
34
43
  unsubscribe: (subscription: any) => void;
@@ -1 +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"}
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;;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"}