@akinon/app-shared 0.9.0 → 0.11.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.
Files changed (9) hide show
  1. package/dist/cjs/events.d.ts +15 -9
  2. package/dist/cjs/events.d.ts.map +1 -1
  3. package/dist/cjs/events.js +7 -1
  4. package/dist/cjs/types.d.ts +1 -1
  5. package/dist/esm/events.d.ts +15 -9
  6. package/dist/esm/events.d.ts.map +1 -1
  7. package/dist/esm/events.js +7 -1
  8. package/dist/esm/types.d.ts +1 -1
  9. package/package.json +4 -3
package/dist/cjs/events.d.ts CHANGED
@@ -5,63 +5,69 @@ export declare const EVENTS: {
5
5
  *
6
6
  * AppShell → AppClient
7
7
  */
8
- SET_APP_ID: string;
8
+ readonly SET_APP_ID: "SET_APP_ID";
9
9
  /**
10
10
  * The event that is emitted when client applications
11
11
  * sends their configuration to the AppShell.
12
12
  *
13
13
  * AppClient → AppShell
14
14
  */
15
- SET_CONFIG: string;
15
+ readonly SET_CONFIG: "SET_CONFIG";
16
16
  /**
17
17
  * The event that is emitted when the AppShell sends
18
18
  * data to the client application.
19
19
  *
20
20
  * AppShell → AppClient
21
21
  */
22
- SET_DATA: string;
22
+ readonly SET_DATA: "SET_DATA";
23
23
  /**
24
24
  * The event that is emitted when client applications
25
25
  * loads and sends their css height information to the AppShell.
26
26
  *
27
27
  * AppClient → AppShell
28
28
  */
29
- SET_HEIGHT: string;
29
+ readonly SET_HEIGHT: "SET_HEIGHT";
30
30
  /**
31
31
  * The event that is emitted to client applications when params property
32
32
  * passed to the PluginRenderer component is received or changed.
33
33
  *
34
34
  * AppShell → AppClient
35
35
  */
36
- SET_PARAMS: string;
36
+ readonly SET_PARAMS: "SET_PARAMS";
37
37
  /**
38
38
  * The event that is emitted when client applications trigger
39
39
  * custom actions defined on the AppShell.
40
40
  *
41
41
  * AppClient → AppShell
42
42
  */
43
- INVOKE_ACTION: string;
43
+ readonly INVOKE_ACTION: "INVOKE_ACTION";
44
44
  /**
45
45
  * The event that is emitted when client applications trigger
46
46
  * default actions defined on the AppShell.
47
47
  *
48
48
  * AppClient → AppShell
49
49
  */
50
- INVOKE_DEFAULT_ACTION: string;
50
+ readonly INVOKE_DEFAULT_ACTION: "INVOKE_DEFAULT_ACTION";
51
51
  /**
52
52
  * The event that is emitted when client applications trigger
53
53
  * navigation for their shell application.
54
54
  *
55
55
  * AppClient → AppShell
56
56
  */
57
- NAVIGATE: string;
57
+ readonly NAVIGATE: "NAVIGATE";
58
58
  /**
59
59
  * The event that is emitted when shell applications trigger
60
60
  * navigation for their child applications.
61
61
  *
62
62
  * AppShell → AppClient
63
63
  */
64
- NAVIGATE_CHILD: string;
64
+ readonly NAVIGATE_CHILD: "NAVIGATE_CHILD";
65
+ /**
66
+ * The event that is emitted when the locale changes in the shell application.
67
+ *
68
+ * AppShell → AppClient
69
+ */
70
+ readonly LOCALE_CHANGED: "LOCALE_CHANGED";
65
71
  };
66
72
  export declare const DEFAULT_ACTION_KEYS: {
67
73
  showConfirmationDialog: string;
package/dist/cjs/events.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;IACjB;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;CAEJ,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;IACjB;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;OAIG;;CAEK,CAAC;AAEX,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}
package/dist/cjs/events.js CHANGED
@@ -64,7 +64,13 @@ exports.EVENTS = {
64
64
  *
65
65
  * AppShell → AppClient
66
66
  */
67
- NAVIGATE_CHILD: 'NAVIGATE_CHILD'
67
+ NAVIGATE_CHILD: 'NAVIGATE_CHILD',
68
+ /**
69
+ * The event that is emitted when the locale changes in the shell application.
70
+ *
71
+ * AppShell → AppClient
72
+ */
73
+ LOCALE_CHANGED: 'LOCALE_CHANGED'
68
74
  };
69
75
  exports.DEFAULT_ACTION_KEYS = {
70
76
  showConfirmationDialog: 'showConfirmationDialog',
package/dist/cjs/types.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  import { UUID } from 'crypto';
3
3
  /**
4
4
  * Represents the type of a registered application within the system.
5
- * @typedef {('fullpage' | 'plugin')} RegisteredAppType
5
+ * @typedef {('full_page' | 'plugin')} RegisteredAppType
6
6
  */
7
7
  export type RegisteredAppType = 'full_page' | 'plugin';
8
8
  /**
package/dist/esm/events.d.ts CHANGED
@@ -5,63 +5,69 @@ export declare const EVENTS: {
5
5
  *
6
6
  * AppShell → AppClient
7
7
  */
8
- SET_APP_ID: string;
8
+ readonly SET_APP_ID: "SET_APP_ID";
9
9
  /**
10
10
  * The event that is emitted when client applications
11
11
  * sends their configuration to the AppShell.
12
12
  *
13
13
  * AppClient → AppShell
14
14
  */
15
- SET_CONFIG: string;
15
+ readonly SET_CONFIG: "SET_CONFIG";
16
16
  /**
17
17
  * The event that is emitted when the AppShell sends
18
18
  * data to the client application.
19
19
  *
20
20
  * AppShell → AppClient
21
21
  */
22
- SET_DATA: string;
22
+ readonly SET_DATA: "SET_DATA";
23
23
  /**
24
24
  * The event that is emitted when client applications
25
25
  * loads and sends their css height information to the AppShell.
26
26
  *
27
27
  * AppClient → AppShell
28
28
  */
29
- SET_HEIGHT: string;
29
+ readonly SET_HEIGHT: "SET_HEIGHT";
30
30
  /**
31
31
  * The event that is emitted to client applications when params property
32
32
  * passed to the PluginRenderer component is received or changed.
33
33
  *
34
34
  * AppShell → AppClient
35
35
  */
36
- SET_PARAMS: string;
36
+ readonly SET_PARAMS: "SET_PARAMS";
37
37
  /**
38
38
  * The event that is emitted when client applications trigger
39
39
  * custom actions defined on the AppShell.
40
40
  *
41
41
  * AppClient → AppShell
42
42
  */
43
- INVOKE_ACTION: string;
43
+ readonly INVOKE_ACTION: "INVOKE_ACTION";
44
44
  /**
45
45
  * The event that is emitted when client applications trigger
46
46
  * default actions defined on the AppShell.
47
47
  *
48
48
  * AppClient → AppShell
49
49
  */
50
- INVOKE_DEFAULT_ACTION: string;
50
+ readonly INVOKE_DEFAULT_ACTION: "INVOKE_DEFAULT_ACTION";
51
51
  /**
52
52
  * The event that is emitted when client applications trigger
53
53
  * navigation for their shell application.
54
54
  *
55
55
  * AppClient → AppShell
56
56
  */
57
- NAVIGATE: string;
57
+ readonly NAVIGATE: "NAVIGATE";
58
58
  /**
59
59
  * The event that is emitted when shell applications trigger
60
60
  * navigation for their child applications.
61
61
  *
62
62
  * AppShell → AppClient
63
63
  */
64
- NAVIGATE_CHILD: string;
64
+ readonly NAVIGATE_CHILD: "NAVIGATE_CHILD";
65
+ /**
66
+ * The event that is emitted when the locale changes in the shell application.
67
+ *
68
+ * AppShell → AppClient
69
+ */
70
+ readonly LOCALE_CHANGED: "LOCALE_CHANGED";
65
71
  };
66
72
  export declare const DEFAULT_ACTION_KEYS: {
67
73
  showConfirmationDialog: string;
package/dist/esm/events.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;IACjB;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;CAEJ,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;IACjB;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;OAIG;;CAEK,CAAC;AAEX,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}
package/dist/esm/events.js CHANGED
@@ -61,7 +61,13 @@ export const EVENTS = {
61
61
  *
62
62
  * AppShell → AppClient
63
63
  */
64
- NAVIGATE_CHILD: 'NAVIGATE_CHILD'
64
+ NAVIGATE_CHILD: 'NAVIGATE_CHILD',
65
+ /**
66
+ * The event that is emitted when the locale changes in the shell application.
67
+ *
68
+ * AppShell → AppClient
69
+ */
70
+ LOCALE_CHANGED: 'LOCALE_CHANGED'
65
71
  };
66
72
  export const DEFAULT_ACTION_KEYS = {
67
73
  showConfirmationDialog: 'showConfirmationDialog',
package/dist/esm/types.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  import { UUID } from 'crypto';
3
3
  /**
4
4
  * Represents the type of a registered application within the system.
5
- * @typedef {('fullpage' | 'plugin')} RegisteredAppType
5
+ * @typedef {('full_page' | 'plugin')} RegisteredAppType
6
6
  */
7
7
  export type RegisteredAppType = 'full_page' | 'plugin';
8
8
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@akinon/app-shared",
3
3
  "description": "Shared utilities and helper functions for app-shell and app-client packages.",
4
- "version": "0.9.0",
4
+ "version": "0.11.0",
5
5
  "private": false,
6
6
  "type": "module",
7
7
  "main": "dist/esm/index.js",
@@ -15,9 +15,9 @@
15
15
  "copyfiles": "^2.4.1",
16
16
  "rimraf": "^5.0.5",
17
17
  "typescript": "^5.2.2",
18
- "@akinon/typescript-config": "0.2.0",
18
+ "@akinon/vite-config": "0.4.0",
19
19
  "@akinon/eslint-config": "0.1.0",
20
- "@akinon/vite-config": "0.4.0"
20
+ "@akinon/typescript-config": "0.2.0"
21
21
  },
22
22
  "clean-package": "../../clean-package.config.json",
23
23
  "types": "dist/esm/index.d.ts",
@@ -37,6 +37,7 @@
37
37
  "clean": "rimraf dist/",
38
38
  "lint": "eslint *.ts*",
39
39
  "test": "vitest run",
40
+ "test:coverage": "vitest run --coverage",
40
41
  "test:ui": "vitest --ui",
41
42
  "test:watch": "vitest watch",
42
43
  "typecheck": "tsc --noEmit"