@akinon/app-client 1.2.1 → 1.3.0-rc.0
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.
- package/dist/cjs/app-client-provider.d.ts +12 -2
- package/dist/cjs/app-client-provider.d.ts.map +1 -1
- package/dist/cjs/app-client-provider.js +19 -2
- package/dist/esm/app-client-provider.d.ts +12 -2
- package/dist/esm/app-client-provider.d.ts.map +1 -1
- package/dist/esm/app-client-provider.js +19 -2
- package/package.json +4 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ApplicationData, ApplicationModalSize,
|
|
1
|
+
import type { ApplicationData, ApplicationModalSize, ApplicationParams, ApplicationToastType, FullpageApplicationConfig, PluginApplicationConfig, ShellNavigationPayload } from '@akinon/app-shared';
|
|
2
2
|
import Framebus from 'framebus';
|
|
3
3
|
import React from 'react';
|
|
4
4
|
/**
|
|
@@ -104,6 +104,16 @@ interface AppClientContextState {
|
|
|
104
104
|
* Context data for the modal.
|
|
105
105
|
*/
|
|
106
106
|
modalContext?: unknown;
|
|
107
|
+
/**
|
|
108
|
+
* Method to remove search params from the URL.
|
|
109
|
+
* @param {string | string[]} keys - The keys of the search params to remove.
|
|
110
|
+
*/
|
|
111
|
+
removeSearchParams?: (keys: string | string[]) => void;
|
|
112
|
+
/**
|
|
113
|
+
* Method to set search params in the URL.
|
|
114
|
+
* @param {Record<string, string | number>} searchParams - The search params to set.
|
|
115
|
+
*/
|
|
116
|
+
setSearchParams?: (searchParams: Record<string, string | number>) => void;
|
|
107
117
|
}
|
|
108
118
|
/**
|
|
109
119
|
* Props for the AppClientProvider component.
|
|
@@ -141,5 +151,5 @@ declare let contextValue: AppClientContextState;
|
|
|
141
151
|
*/
|
|
142
152
|
declare const AppClientProvider: ({ children, config, eventBus }: AppClientProviderProps) => React.JSX.Element;
|
|
143
153
|
export { AppClientProvider, contextValue, defaultContextState, useAppClient };
|
|
144
|
-
export type { ApplicationNavigation, ApplicationNavigationPayload, FullpageApplicationConfig, PluginApplicationConfig, RegisteredApp, RegisteredAppType, ShellNavigation };
|
|
154
|
+
export type { ApplicationNavigation, ApplicationNavigationPayload, FullpageApplicationConfig, PluginApplicationConfig, RegisteredApp, RegisteredAppType, ShellNavigation } from '@akinon/app-shared';
|
|
145
155
|
//# sourceMappingURL=app-client-provider.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app-client-provider.d.ts","sourceRoot":"","sources":["../../src/app-client-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,
|
|
1
|
+
{"version":3,"file":"app-client-provider.d.ts","sourceRoot":"","sources":["../../src/app-client-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAO5B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAON,MAAM,OAAO,CAAC;AAEf;;;;GAIG;AACH,UAAU,qBAAqB;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KACpB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACpD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE;QAC1B,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;KACvB,KAAK,OAAO,CAAC;IACd;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE;QACjC,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;KACvB,KAAK,OAAO,CAAC;IACd;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC;IACrE;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/D;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,EACjB,IAAI,CAAC,EAAE,oBAAoB,EAC3B,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,EAAE,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;IAChE;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;IACvD;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC;CAC3E;AAED;;GAEG;AACH,UAAU,sBAAsB;IAC9B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,yBAAyB,GAAG,uBAAuB,CAAC;IAC5D;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,QAAA,MAAM,mBAAmB,EAAE,qBAc1B,CAAC;AAQF;;;;GAIG;AACH,QAAA,MAAM,YAAY,QAAO,qBAAqD,CAAC;AAE/E,QAAA,IAAI,YAAY,EAAE,qBAAqB,CAAC;AAExC;;;;;GAKG;AACH,QAAA,MAAM,iBAAiB,GAAI,gCAIxB,sBAAsB,sBA0RxB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,CAAC;AAC9E,YAAY,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,yBAAyB,EACzB,uBAAuB,EACvB,aAAa,EACb,iBAAiB,EACjB,eAAe,EAChB,MAAM,oBAAoB,CAAC"}
|
|
@@ -18,7 +18,9 @@ const defaultContextState = {
|
|
|
18
18
|
locale: 'en',
|
|
19
19
|
onLocaleChange: () => {
|
|
20
20
|
return;
|
|
21
|
-
}
|
|
21
|
+
},
|
|
22
|
+
removeSearchParams: () => { },
|
|
23
|
+
setSearchParams: () => { }
|
|
22
24
|
};
|
|
23
25
|
exports.defaultContextState = defaultContextState;
|
|
24
26
|
/**
|
|
@@ -240,7 +242,22 @@ const AppClientProvider = ({ children, config, eventBus }) => {
|
|
|
240
242
|
}, []),
|
|
241
243
|
locale,
|
|
242
244
|
onLocaleChange,
|
|
243
|
-
modalContext
|
|
245
|
+
modalContext,
|
|
246
|
+
removeSearchParams: (0, react_1.useCallback)((_keys) => {
|
|
247
|
+
var _a;
|
|
248
|
+
const keys = Array.isArray(_keys) ? _keys : [_keys];
|
|
249
|
+
(_a = busRef.current) === null || _a === void 0 ? void 0 : _a.emit(app_shared_1.EVENTS.INVOKE_DEFAULT_ACTION, {
|
|
250
|
+
actionKey: app_shared_1.DEFAULT_ACTION_KEYS.removeSearchParams,
|
|
251
|
+
args: [keys]
|
|
252
|
+
});
|
|
253
|
+
}, []),
|
|
254
|
+
setSearchParams: (0, react_1.useCallback)((searchParams) => {
|
|
255
|
+
var _a;
|
|
256
|
+
(_a = busRef.current) === null || _a === void 0 ? void 0 : _a.emit(app_shared_1.EVENTS.INVOKE_DEFAULT_ACTION, {
|
|
257
|
+
actionKey: app_shared_1.DEFAULT_ACTION_KEYS.setSearchParams,
|
|
258
|
+
args: [searchParams]
|
|
259
|
+
});
|
|
260
|
+
}, [])
|
|
244
261
|
};
|
|
245
262
|
return (react_1.default.createElement(AppClientContext.Provider, { value: contextValue }, children));
|
|
246
263
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ApplicationData, ApplicationModalSize,
|
|
1
|
+
import type { ApplicationData, ApplicationModalSize, ApplicationParams, ApplicationToastType, FullpageApplicationConfig, PluginApplicationConfig, ShellNavigationPayload } from '@akinon/app-shared';
|
|
2
2
|
import Framebus from 'framebus';
|
|
3
3
|
import React from 'react';
|
|
4
4
|
/**
|
|
@@ -104,6 +104,16 @@ interface AppClientContextState {
|
|
|
104
104
|
* Context data for the modal.
|
|
105
105
|
*/
|
|
106
106
|
modalContext?: unknown;
|
|
107
|
+
/**
|
|
108
|
+
* Method to remove search params from the URL.
|
|
109
|
+
* @param {string | string[]} keys - The keys of the search params to remove.
|
|
110
|
+
*/
|
|
111
|
+
removeSearchParams?: (keys: string | string[]) => void;
|
|
112
|
+
/**
|
|
113
|
+
* Method to set search params in the URL.
|
|
114
|
+
* @param {Record<string, string | number>} searchParams - The search params to set.
|
|
115
|
+
*/
|
|
116
|
+
setSearchParams?: (searchParams: Record<string, string | number>) => void;
|
|
107
117
|
}
|
|
108
118
|
/**
|
|
109
119
|
* Props for the AppClientProvider component.
|
|
@@ -141,5 +151,5 @@ declare let contextValue: AppClientContextState;
|
|
|
141
151
|
*/
|
|
142
152
|
declare const AppClientProvider: ({ children, config, eventBus }: AppClientProviderProps) => React.JSX.Element;
|
|
143
153
|
export { AppClientProvider, contextValue, defaultContextState, useAppClient };
|
|
144
|
-
export type { ApplicationNavigation, ApplicationNavigationPayload, FullpageApplicationConfig, PluginApplicationConfig, RegisteredApp, RegisteredAppType, ShellNavigation };
|
|
154
|
+
export type { ApplicationNavigation, ApplicationNavigationPayload, FullpageApplicationConfig, PluginApplicationConfig, RegisteredApp, RegisteredAppType, ShellNavigation } from '@akinon/app-shared';
|
|
145
155
|
//# sourceMappingURL=app-client-provider.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app-client-provider.d.ts","sourceRoot":"","sources":["../../src/app-client-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,
|
|
1
|
+
{"version":3,"file":"app-client-provider.d.ts","sourceRoot":"","sources":["../../src/app-client-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAO5B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAON,MAAM,OAAO,CAAC;AAEf;;;;GAIG;AACH,UAAU,qBAAqB;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KACpB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACpD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE;QAC1B,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;KACvB,KAAK,OAAO,CAAC;IACd;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE;QACjC,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;KACvB,KAAK,OAAO,CAAC;IACd;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC;IACrE;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/D;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,EACjB,IAAI,CAAC,EAAE,oBAAoB,EAC3B,cAAc,CAAC,EAAE,MAAM,KACpB,OAAO,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,EAAE,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;IAChE;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;IACvD;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC;CAC3E;AAED;;GAEG;AACH,UAAU,sBAAsB;IAC9B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,yBAAyB,GAAG,uBAAuB,CAAC;IAC5D;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,QAAA,MAAM,mBAAmB,EAAE,qBAc1B,CAAC;AAQF;;;;GAIG;AACH,QAAA,MAAM,YAAY,QAAO,qBAAqD,CAAC;AAE/E,QAAA,IAAI,YAAY,EAAE,qBAAqB,CAAC;AAExC;;;;;GAKG;AACH,QAAA,MAAM,iBAAiB,GAAI,gCAIxB,sBAAsB,sBA0RxB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,CAAC;AAC9E,YAAY,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,yBAAyB,EACzB,uBAAuB,EACvB,aAAa,EACb,iBAAiB,EACjB,eAAe,EAChB,MAAM,oBAAoB,CAAC"}
|
|
@@ -15,7 +15,9 @@ const defaultContextState = {
|
|
|
15
15
|
locale: 'en',
|
|
16
16
|
onLocaleChange: () => {
|
|
17
17
|
return;
|
|
18
|
-
}
|
|
18
|
+
},
|
|
19
|
+
removeSearchParams: () => { },
|
|
20
|
+
setSearchParams: () => { }
|
|
19
21
|
};
|
|
20
22
|
/**
|
|
21
23
|
* Context for the AppClient, providing access to application state and methods.
|
|
@@ -235,7 +237,22 @@ const AppClientProvider = ({ children, config, eventBus }) => {
|
|
|
235
237
|
}, []),
|
|
236
238
|
locale,
|
|
237
239
|
onLocaleChange,
|
|
238
|
-
modalContext
|
|
240
|
+
modalContext,
|
|
241
|
+
removeSearchParams: useCallback((_keys) => {
|
|
242
|
+
var _a;
|
|
243
|
+
const keys = Array.isArray(_keys) ? _keys : [_keys];
|
|
244
|
+
(_a = busRef.current) === null || _a === void 0 ? void 0 : _a.emit(EVENTS.INVOKE_DEFAULT_ACTION, {
|
|
245
|
+
actionKey: DEFAULT_ACTION_KEYS.removeSearchParams,
|
|
246
|
+
args: [keys]
|
|
247
|
+
});
|
|
248
|
+
}, []),
|
|
249
|
+
setSearchParams: useCallback((searchParams) => {
|
|
250
|
+
var _a;
|
|
251
|
+
(_a = busRef.current) === null || _a === void 0 ? void 0 : _a.emit(EVENTS.INVOKE_DEFAULT_ACTION, {
|
|
252
|
+
actionKey: DEFAULT_ACTION_KEYS.setSearchParams,
|
|
253
|
+
args: [searchParams]
|
|
254
|
+
});
|
|
255
|
+
}, [])
|
|
239
256
|
};
|
|
240
257
|
return (React.createElement(AppClientContext.Provider, { value: contextValue }, children));
|
|
241
258
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@akinon/app-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0-rc.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Akinon AppClient library. This library is used to create a new plugin or an application which will reside in Akinon's applications.",
|
|
6
6
|
"type": "module",
|
|
@@ -11,15 +11,15 @@
|
|
|
11
11
|
],
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"framebus": "^6.0.3",
|
|
14
|
-
"@akinon/app-shared": "1.2.
|
|
14
|
+
"@akinon/app-shared": "1.2.2"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
17
|
"clean-package": "2.2.0",
|
|
18
18
|
"copyfiles": "^2.4.1",
|
|
19
19
|
"rimraf": "^5.0.5",
|
|
20
20
|
"typescript": "*",
|
|
21
|
-
"@akinon/
|
|
22
|
-
"@akinon/
|
|
21
|
+
"@akinon/vitest-config": "1.1.1",
|
|
22
|
+
"@akinon/typescript-config": "1.1.1"
|
|
23
23
|
},
|
|
24
24
|
"peerDependencies": {
|
|
25
25
|
"react": "^18 || ^19",
|