@aerogel/core 0.0.0-next.d7394c3aa6aac799b0971e63819a8713d05a5123 → 0.0.0-next.e4c0d5bd2801fbe93545477ea515af53df69b522
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/aerogel-core.css +1 -0
- package/dist/aerogel-core.d.ts +2038 -1801
- package/dist/aerogel-core.js +3432 -0
- package/dist/aerogel-core.js.map +1 -0
- package/package.json +31 -37
- package/src/bootstrap/bootstrap.test.ts +4 -7
- package/src/bootstrap/index.ts +25 -16
- package/src/bootstrap/options.ts +1 -1
- package/src/components/AppLayout.vue +14 -0
- package/src/components/{AGAppModals.vue → AppModals.vue} +3 -4
- package/src/components/AppOverlays.vue +9 -0
- package/src/components/AppToasts.vue +16 -0
- package/src/components/contracts/AlertModal.ts +19 -0
- package/src/components/contracts/Button.ts +16 -0
- package/src/components/contracts/ConfirmModal.ts +48 -0
- package/src/components/contracts/DropdownMenu.ts +25 -0
- package/src/components/contracts/ErrorReportModal.ts +33 -0
- package/src/components/contracts/Input.ts +26 -0
- package/src/components/contracts/LoadingModal.ts +26 -0
- package/src/components/contracts/Modal.ts +21 -0
- package/src/components/contracts/PromptModal.ts +34 -0
- package/src/components/contracts/Select.ts +45 -0
- package/src/components/contracts/Toast.ts +15 -0
- package/src/components/contracts/index.ts +11 -0
- package/src/components/headless/HeadlessButton.vue +51 -0
- package/src/components/headless/HeadlessInput.vue +59 -0
- package/src/components/headless/{forms/AGHeadlessInputDescription.vue → HeadlessInputDescription.vue} +7 -8
- package/src/components/headless/{forms/AGHeadlessInputError.vue → HeadlessInputError.vue} +4 -8
- package/src/components/headless/{forms/AGHeadlessInputInput.vue → HeadlessInputInput.vue} +16 -25
- package/src/components/headless/{forms/AGHeadlessInputLabel.vue → HeadlessInputLabel.vue} +3 -7
- package/src/components/headless/{forms/AGHeadlessInputTextArea.vue → HeadlessInputTextArea.vue} +10 -13
- package/src/components/headless/HeadlessModal.vue +57 -0
- package/src/components/headless/HeadlessModalContent.vue +30 -0
- package/src/components/headless/HeadlessModalDescription.vue +12 -0
- package/src/components/headless/HeadlessModalOverlay.vue +12 -0
- package/src/components/headless/HeadlessModalTitle.vue +12 -0
- package/src/components/headless/HeadlessSelect.vue +120 -0
- package/src/components/headless/{forms/AGHeadlessSelectError.vue → HeadlessSelectError.vue} +5 -6
- package/src/components/headless/HeadlessSelectLabel.vue +25 -0
- package/src/components/headless/HeadlessSelectOption.vue +34 -0
- package/src/components/headless/HeadlessSelectOptions.vue +42 -0
- package/src/components/headless/HeadlessSelectTrigger.vue +22 -0
- package/src/components/headless/HeadlessSelectValue.vue +18 -0
- package/src/components/headless/HeadlessToast.vue +18 -0
- package/src/components/headless/HeadlessToastAction.vue +13 -0
- package/src/components/headless/index.ts +19 -3
- package/src/components/index.ts +6 -11
- package/src/components/ui/AdvancedOptions.vue +18 -0
- package/src/components/ui/AlertModal.vue +17 -0
- package/src/components/ui/Button.vue +100 -0
- package/src/components/ui/Checkbox.vue +56 -0
- package/src/components/ui/ConfirmModal.vue +50 -0
- package/src/components/ui/DropdownMenu.vue +32 -0
- package/src/components/ui/DropdownMenuOption.vue +22 -0
- package/src/components/ui/DropdownMenuOptions.vue +44 -0
- package/src/components/ui/EditableContent.vue +82 -0
- package/src/components/ui/ErrorLogs.vue +19 -0
- package/src/components/ui/ErrorLogsModal.vue +48 -0
- package/src/components/ui/ErrorMessage.vue +15 -0
- package/src/components/ui/ErrorReportModal.vue +73 -0
- package/src/components/{modals/AGErrorReportModalButtons.vue → ui/ErrorReportModalButtons.vue} +34 -27
- package/src/components/ui/ErrorReportModalTitle.vue +24 -0
- package/src/components/{forms/AGForm.vue → ui/Form.vue} +4 -5
- package/src/components/ui/Input.vue +56 -0
- package/src/components/ui/Link.vue +12 -0
- package/src/components/ui/LoadingModal.vue +34 -0
- package/src/components/ui/Markdown.vue +97 -0
- package/src/components/ui/Modal.vue +123 -0
- package/src/components/ui/ModalContext.vue +31 -0
- package/src/components/ui/ProgressBar.vue +51 -0
- package/src/components/ui/PromptModal.vue +38 -0
- package/src/components/ui/Select.vue +27 -0
- package/src/components/ui/SelectLabel.vue +17 -0
- package/src/components/ui/SelectOption.vue +29 -0
- package/src/components/ui/SelectOptions.vue +35 -0
- package/src/components/ui/SelectTrigger.vue +29 -0
- package/src/components/ui/SettingsModal.vue +15 -0
- package/src/components/{lib/AGStartupCrash.vue → ui/StartupCrash.vue} +8 -8
- package/src/components/ui/Toast.vue +46 -0
- package/src/components/ui/index.ts +32 -0
- package/src/directives/index.ts +9 -5
- package/src/directives/measure.ts +12 -6
- package/src/errors/Errors.state.ts +1 -1
- package/src/errors/Errors.ts +29 -27
- package/src/errors/JobCancelledError.ts +3 -0
- package/src/errors/index.ts +9 -6
- package/src/errors/utils.ts +17 -1
- package/src/forms/{Form.test.ts → FormController.test.ts} +32 -8
- package/src/forms/{Form.ts → FormController.ts} +51 -40
- package/src/forms/index.ts +3 -3
- package/src/forms/utils.ts +40 -24
- package/src/forms/validation.ts +19 -0
- package/src/index.css +73 -0
- package/src/jobs/Job.ts +144 -2
- package/src/jobs/index.ts +4 -1
- package/src/jobs/listeners.ts +3 -0
- package/src/jobs/status.ts +4 -0
- package/src/lang/DefaultLangProvider.ts +7 -4
- package/src/lang/Lang.state.ts +1 -1
- package/src/lang/Lang.ts +5 -1
- package/src/lang/index.ts +12 -6
- package/src/lang/settings/Language.vue +48 -0
- package/src/lang/settings/index.ts +10 -0
- package/src/plugins/Plugin.ts +1 -1
- package/src/plugins/index.ts +10 -7
- package/src/services/App.state.ts +23 -4
- package/src/services/App.ts +16 -3
- package/src/services/Cache.ts +1 -1
- package/src/services/Events.test.ts +8 -8
- package/src/services/Events.ts +16 -12
- package/src/services/Service.ts +116 -53
- package/src/services/Storage.ts +20 -0
- package/src/services/index.ts +14 -5
- package/src/services/utils.ts +18 -0
- package/src/testing/index.ts +4 -3
- package/src/testing/setup.ts +5 -19
- package/src/ui/UI.state.ts +8 -13
- package/src/ui/UI.ts +222 -128
- package/src/ui/index.ts +27 -28
- package/src/ui/utils.ts +1 -1
- package/src/utils/classes.ts +41 -0
- package/src/utils/composition/events.ts +4 -6
- package/src/utils/composition/forms.ts +20 -4
- package/src/utils/composition/persistent.test.ts +33 -0
- package/src/utils/composition/persistent.ts +11 -0
- package/src/utils/composition/state.test.ts +47 -0
- package/src/utils/composition/state.ts +33 -0
- package/src/utils/index.ts +5 -1
- package/src/utils/markdown.test.ts +50 -0
- package/src/utils/markdown.ts +53 -6
- package/src/utils/types.ts +3 -0
- package/src/utils/vue.ts +38 -134
- package/dist/aerogel-core.cjs.js +0 -2
- package/dist/aerogel-core.cjs.js.map +0 -1
- package/dist/aerogel-core.esm.js +0 -2
- package/dist/aerogel-core.esm.js.map +0 -1
- package/histoire.config.ts +0 -7
- package/noeldemartin.config.js +0 -5
- package/postcss.config.js +0 -6
- package/src/assets/histoire.css +0 -3
- package/src/components/AGAppLayout.vue +0 -16
- package/src/components/AGAppOverlays.vue +0 -41
- package/src/components/AGAppSnackbars.vue +0 -13
- package/src/components/composition.ts +0 -23
- package/src/components/constants.ts +0 -8
- package/src/components/forms/AGButton.vue +0 -44
- package/src/components/forms/AGCheckbox.vue +0 -41
- package/src/components/forms/AGInput.vue +0 -40
- package/src/components/forms/AGSelect.story.vue +0 -46
- package/src/components/forms/AGSelect.vue +0 -60
- package/src/components/forms/index.ts +0 -5
- package/src/components/headless/forms/AGHeadlessButton.ts +0 -3
- package/src/components/headless/forms/AGHeadlessButton.vue +0 -62
- package/src/components/headless/forms/AGHeadlessInput.ts +0 -34
- package/src/components/headless/forms/AGHeadlessInput.vue +0 -70
- package/src/components/headless/forms/AGHeadlessSelect.ts +0 -42
- package/src/components/headless/forms/AGHeadlessSelect.vue +0 -77
- package/src/components/headless/forms/AGHeadlessSelectButton.vue +0 -24
- package/src/components/headless/forms/AGHeadlessSelectLabel.vue +0 -24
- package/src/components/headless/forms/AGHeadlessSelectOption.ts +0 -4
- package/src/components/headless/forms/AGHeadlessSelectOption.vue +0 -39
- package/src/components/headless/forms/AGHeadlessSelectOptions.ts +0 -3
- package/src/components/headless/forms/composition.ts +0 -10
- package/src/components/headless/forms/index.ts +0 -18
- package/src/components/headless/modals/AGHeadlessModal.ts +0 -34
- package/src/components/headless/modals/AGHeadlessModal.vue +0 -86
- package/src/components/headless/modals/AGHeadlessModalPanel.vue +0 -28
- package/src/components/headless/modals/AGHeadlessModalTitle.vue +0 -13
- package/src/components/headless/modals/index.ts +0 -4
- package/src/components/headless/snackbars/AGHeadlessSnackbar.vue +0 -10
- package/src/components/headless/snackbars/index.ts +0 -40
- package/src/components/interfaces.ts +0 -24
- package/src/components/lib/AGErrorMessage.vue +0 -16
- package/src/components/lib/AGLink.vue +0 -9
- package/src/components/lib/AGMarkdown.vue +0 -41
- package/src/components/lib/AGMeasured.vue +0 -16
- package/src/components/lib/index.ts +0 -5
- package/src/components/modals/AGAlertModal.ts +0 -15
- package/src/components/modals/AGAlertModal.vue +0 -14
- package/src/components/modals/AGConfirmModal.ts +0 -33
- package/src/components/modals/AGConfirmModal.vue +0 -26
- package/src/components/modals/AGErrorReportModal.ts +0 -46
- package/src/components/modals/AGErrorReportModal.vue +0 -54
- package/src/components/modals/AGErrorReportModalTitle.vue +0 -25
- package/src/components/modals/AGLoadingModal.ts +0 -23
- package/src/components/modals/AGLoadingModal.vue +0 -15
- package/src/components/modals/AGModal.ts +0 -10
- package/src/components/modals/AGModal.vue +0 -39
- package/src/components/modals/AGModalContext.ts +0 -8
- package/src/components/modals/AGModalContext.vue +0 -22
- package/src/components/modals/AGModalTitle.vue +0 -9
- package/src/components/modals/AGPromptModal.ts +0 -36
- package/src/components/modals/AGPromptModal.vue +0 -34
- package/src/components/modals/index.ts +0 -17
- package/src/components/snackbars/AGSnackbar.vue +0 -36
- package/src/components/snackbars/index.ts +0 -3
- package/src/components/utils.ts +0 -10
- package/src/directives/initial-focus.ts +0 -11
- package/src/forms/composition.ts +0 -6
- package/src/main.histoire.ts +0 -1
- package/src/utils/tailwindcss.test.ts +0 -26
- package/src/utils/tailwindcss.ts +0 -7
- package/tailwind.config.js +0 -4
- package/tsconfig.json +0 -11
- package/vite.config.ts +0 -17
- /package/src/{main.ts → index.ts} +0 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
<template>
|
|
2
|
+
<Select
|
|
3
|
+
v-model="$lang.locale"
|
|
4
|
+
class="flex flex-col items-start md:flex-row"
|
|
5
|
+
as="div"
|
|
6
|
+
:options
|
|
7
|
+
:render-option="renderLocale"
|
|
8
|
+
>
|
|
9
|
+
<div class="grow">
|
|
10
|
+
<SelectLabel>
|
|
11
|
+
{{ $td('settings.locale', 'Language') }}
|
|
12
|
+
</SelectLabel>
|
|
13
|
+
<Markdown
|
|
14
|
+
lang-key="settings.localeDescription"
|
|
15
|
+
lang-default="Choose the application's language."
|
|
16
|
+
class="mt-1 text-sm text-gray-500"
|
|
17
|
+
/>
|
|
18
|
+
</div>
|
|
19
|
+
<Button variant="ghost" :as="SelectTrigger" class="grid w-auto outline-none" />
|
|
20
|
+
<SelectOptions />
|
|
21
|
+
</Select>
|
|
22
|
+
</template>
|
|
23
|
+
|
|
24
|
+
<script setup lang="ts">
|
|
25
|
+
import Aerogel from 'virtual:aerogel';
|
|
26
|
+
|
|
27
|
+
import { computed } from 'vue';
|
|
28
|
+
|
|
29
|
+
import Markdown from '@aerogel/core/components/ui/Markdown.vue';
|
|
30
|
+
import Button from '@aerogel/core/components/ui/Button.vue';
|
|
31
|
+
import Select from '@aerogel/core/components/ui/Select.vue';
|
|
32
|
+
import SelectLabel from '@aerogel/core/components/ui/SelectLabel.vue';
|
|
33
|
+
import SelectTrigger from '@aerogel/core/components/ui/SelectTrigger.vue';
|
|
34
|
+
import SelectOptions from '@aerogel/core/components/ui/SelectOptions.vue';
|
|
35
|
+
import { Lang, translateWithDefault } from '@aerogel/core/lang';
|
|
36
|
+
|
|
37
|
+
const browserLocale = Lang.getBrowserLocale();
|
|
38
|
+
const options = computed(() => [null, ...Lang.locales]);
|
|
39
|
+
|
|
40
|
+
function renderLocale(locale: string | null): string {
|
|
41
|
+
return (
|
|
42
|
+
(locale && Aerogel.locales[locale]) ??
|
|
43
|
+
translateWithDefault('settings.localeDefault', '{locale} (default)', {
|
|
44
|
+
locale: Aerogel.locales[browserLocale] ?? browserLocale,
|
|
45
|
+
})
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
</script>
|
package/src/plugins/Plugin.ts
CHANGED
package/src/plugins/index.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { GetClosureArgs } from '@noeldemartin/utils';
|
|
2
2
|
|
|
3
|
-
import App from '
|
|
3
|
+
import App from '@aerogel/core/services/App';
|
|
4
4
|
|
|
5
5
|
import type { Plugin } from './Plugin';
|
|
6
6
|
|
|
@@ -13,13 +13,16 @@ export function definePlugin<T extends Plugin>(plugin: T): T {
|
|
|
13
13
|
export async function installPlugins(plugins: Plugin[], ...args: GetClosureArgs<Plugin['install']>): Promise<void> {
|
|
14
14
|
App.setState(
|
|
15
15
|
'plugins',
|
|
16
|
-
plugins.reduce(
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
plugins.reduce(
|
|
17
|
+
(pluginsMap, plugin) => {
|
|
18
|
+
if (plugin.name) {
|
|
19
|
+
pluginsMap[plugin.name] = plugin;
|
|
20
|
+
}
|
|
20
21
|
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
return pluginsMap;
|
|
23
|
+
},
|
|
24
|
+
{} as Record<string, Plugin>,
|
|
25
|
+
),
|
|
23
26
|
);
|
|
24
27
|
|
|
25
28
|
await Promise.all(plugins.map((plugin) => plugin.install(...args)) ?? []);
|
|
@@ -1,30 +1,49 @@
|
|
|
1
1
|
import Aerogel from 'virtual:aerogel';
|
|
2
2
|
|
|
3
|
-
import {
|
|
4
|
-
import type {
|
|
3
|
+
import { getEnv } from '@noeldemartin/utils';
|
|
4
|
+
import type { App, Component } from 'vue';
|
|
5
|
+
|
|
6
|
+
import { defineServiceState } from '@aerogel/core/services/Service';
|
|
7
|
+
import type { Plugin } from '@aerogel/core/plugins/Plugin';
|
|
8
|
+
|
|
9
|
+
export interface AppSetting {
|
|
10
|
+
component: Component;
|
|
11
|
+
priority: number;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export function defineSettings<T extends AppSetting[]>(settings: T): T {
|
|
15
|
+
return settings;
|
|
16
|
+
}
|
|
5
17
|
|
|
6
18
|
export default defineServiceState({
|
|
7
19
|
name: 'app',
|
|
8
20
|
initialState: {
|
|
9
21
|
plugins: {} as Record<string, Plugin>,
|
|
10
|
-
|
|
22
|
+
instance: null as App | null,
|
|
23
|
+
environment: getEnv() ?? 'development',
|
|
11
24
|
version: Aerogel.version,
|
|
12
25
|
sourceUrl: Aerogel.sourceUrl,
|
|
26
|
+
settings: [] as AppSetting[],
|
|
13
27
|
},
|
|
14
28
|
computed: {
|
|
15
29
|
development: (state) => state.environment === 'development',
|
|
30
|
+
staging: (state) => state.environment === 'staging',
|
|
16
31
|
testing: (state) => state.environment === 'test' || state.environment === 'testing',
|
|
17
32
|
versionName(state): string {
|
|
18
33
|
if (this.development) {
|
|
19
34
|
return 'dev.' + Aerogel.sourceHash.toString().substring(0, 7);
|
|
20
35
|
}
|
|
21
36
|
|
|
37
|
+
if (this.staging) {
|
|
38
|
+
return 'staging.' + Aerogel.sourceHash.toString().substring(0, 7);
|
|
39
|
+
}
|
|
40
|
+
|
|
22
41
|
return `v${state.version}`;
|
|
23
42
|
},
|
|
24
43
|
versionUrl(state): string {
|
|
25
44
|
return (
|
|
26
45
|
state.sourceUrl +
|
|
27
|
-
(this.development ? `/tree/${Aerogel.sourceHash}` : `/releases/tag/${this.versionName}`)
|
|
46
|
+
(this.development || this.staging ? `/tree/${Aerogel.sourceHash}` : `/releases/tag/${this.versionName}`)
|
|
28
47
|
);
|
|
29
48
|
},
|
|
30
49
|
},
|
package/src/services/App.ts
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import Aerogel from 'virtual:aerogel';
|
|
2
2
|
|
|
3
3
|
import { PromisedValue, facade, forever, updateLocationQueryParameters } from '@noeldemartin/utils';
|
|
4
|
+
import { markRaw } from 'vue';
|
|
4
5
|
|
|
5
|
-
import Events from '
|
|
6
|
-
import type { Plugin } from '
|
|
6
|
+
import Events from '@aerogel/core/services/Events';
|
|
7
|
+
import type { Plugin } from '@aerogel/core/plugins';
|
|
8
|
+
import type { AppSetting, Services } from '@aerogel/core/services';
|
|
7
9
|
|
|
8
10
|
import Service from './App.state';
|
|
9
11
|
|
|
12
|
+
export { defineSettings } from './App.state';
|
|
13
|
+
export type { AppSetting } from './App.state';
|
|
14
|
+
|
|
10
15
|
export class AppService extends Service {
|
|
11
16
|
|
|
12
17
|
public readonly name = Aerogel.name;
|
|
@@ -21,6 +26,10 @@ export class AppService extends Service {
|
|
|
21
26
|
return this.mounted.isResolved();
|
|
22
27
|
}
|
|
23
28
|
|
|
29
|
+
public addSetting(setting: AppSetting): void {
|
|
30
|
+
this.settings.push(markRaw(setting));
|
|
31
|
+
}
|
|
32
|
+
|
|
24
33
|
public async whenReady<T>(callback: () => T): Promise<T> {
|
|
25
34
|
const result = await this.ready.then(callback);
|
|
26
35
|
|
|
@@ -40,7 +49,11 @@ export class AppService extends Service {
|
|
|
40
49
|
return (this.plugins[name] as T) ?? null;
|
|
41
50
|
}
|
|
42
51
|
|
|
43
|
-
|
|
52
|
+
public service<T extends keyof Services>(name: T): Services[T] | null {
|
|
53
|
+
return this.instance?.config.globalProperties[name] ?? null;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
protected override async boot(): Promise<void> {
|
|
44
57
|
Events.once('application-ready', () => this.ready.resolve());
|
|
45
58
|
Events.once('application-mounted', () => this.mounted.resolve());
|
|
46
59
|
}
|
package/src/services/Cache.ts
CHANGED
|
@@ -10,12 +10,12 @@ describe('Events', () => {
|
|
|
10
10
|
// Arrange
|
|
11
11
|
let counter = 0;
|
|
12
12
|
|
|
13
|
-
Events.on('
|
|
13
|
+
Events.on('application-mounted', () => counter++);
|
|
14
14
|
|
|
15
15
|
// Act
|
|
16
|
-
await Events.emit('
|
|
17
|
-
await Events.emit('
|
|
18
|
-
await Events.emit('
|
|
16
|
+
await Events.emit('application-mounted');
|
|
17
|
+
await Events.emit('application-mounted');
|
|
18
|
+
await Events.emit('application-mounted');
|
|
19
19
|
|
|
20
20
|
// Assert
|
|
21
21
|
expect(counter).toEqual(3);
|
|
@@ -25,12 +25,12 @@ describe('Events', () => {
|
|
|
25
25
|
// Arrange
|
|
26
26
|
const storage: string[] = [];
|
|
27
27
|
|
|
28
|
-
Events.on('
|
|
29
|
-
Events.on('
|
|
30
|
-
Events.on('
|
|
28
|
+
Events.on('application-mounted', () => storage.push('second'));
|
|
29
|
+
Events.on('application-mounted', { priority: EventListenerPriorities.Low }, () => storage.push('third'));
|
|
30
|
+
Events.on('application-mounted', { priority: EventListenerPriorities.High }, () => storage.push('first'));
|
|
31
31
|
|
|
32
32
|
// Act
|
|
33
|
-
await Events.emit('
|
|
33
|
+
await Events.emit('application-mounted');
|
|
34
34
|
|
|
35
35
|
// Assert
|
|
36
36
|
expect(storage).toEqual(['first', 'second', 'third']);
|
package/src/services/Events.ts
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
import { arrayRemove, facade, fail, tap } from '@noeldemartin/utils';
|
|
2
2
|
|
|
3
|
-
import Service from '
|
|
3
|
+
import Service from '@aerogel/core/services/Service';
|
|
4
4
|
|
|
5
5
|
export interface EventsPayload {}
|
|
6
6
|
export interface EventListenerOptions {
|
|
7
|
-
priority:
|
|
7
|
+
priority: EventListenerPriority;
|
|
8
8
|
}
|
|
9
9
|
export type AerogelGlobalEvents = Partial<{ [Event in EventWithoutPayload]: () => unknown }> &
|
|
10
10
|
Partial<{ [Event in EventWithPayload]: EventListener<EventsPayload[Event]> }>;
|
|
11
11
|
|
|
12
12
|
export type EventListener<T = unknown> = (payload: T) => unknown;
|
|
13
|
-
export type UnknownEvent<T> = T extends keyof EventsPayload ? never : T;
|
|
14
13
|
|
|
15
14
|
export type EventWithoutPayload = {
|
|
16
15
|
[K in keyof EventsPayload]: EventsPayload[K] extends void ? K : never;
|
|
@@ -26,18 +25,20 @@ export const EventListenerPriorities = {
|
|
|
26
25
|
High: 256,
|
|
27
26
|
} as const;
|
|
28
27
|
|
|
28
|
+
export type EventListenerPriority = (typeof EventListenerPriorities)[keyof typeof EventListenerPriorities];
|
|
29
|
+
|
|
29
30
|
export class EventsService extends Service {
|
|
30
31
|
|
|
31
32
|
private listeners: Record<string, { priorities: number[]; handlers: Record<number, EventListener[]> }> = {};
|
|
32
33
|
|
|
33
|
-
protected async boot(): Promise<void> {
|
|
34
|
+
protected override async boot(): Promise<void> {
|
|
34
35
|
Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
|
|
35
|
-
|
|
36
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
37
|
+
this.on(event as any, listener as EventListener));
|
|
36
38
|
}
|
|
37
39
|
|
|
38
40
|
public emit<Event extends EventWithoutPayload>(event: Event): Promise<void>;
|
|
39
41
|
public emit<Event extends EventWithPayload>(event: Event, payload: EventsPayload[Event]): Promise<void>;
|
|
40
|
-
public emit<Event extends string>(event: UnknownEvent<Event>, payload?: unknown): Promise<void>;
|
|
41
42
|
public async emit(event: string, payload?: unknown): Promise<void> {
|
|
42
43
|
const listeners = this.listeners[event] ?? { priorities: [], handlers: {} };
|
|
43
44
|
|
|
@@ -48,19 +49,24 @@ export class EventsService extends Service {
|
|
|
48
49
|
|
|
49
50
|
/* eslint-disable max-len */
|
|
50
51
|
public on<Event extends EventWithoutPayload>(event: Event, listener: () => unknown): () => void;
|
|
52
|
+
public on<Event extends EventWithoutPayload>(event: Event, priority: EventListenerPriority, listener: () => unknown): () => void; // prettier-ignore
|
|
51
53
|
public on<Event extends EventWithoutPayload>(event: Event, options: Partial<EventListenerOptions>, listener: () => unknown): () => void; // prettier-ignore
|
|
52
54
|
public on<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
|
|
55
|
+
public on<Event extends EventWithPayload>(event: Event, priority: EventListenerPriority, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
|
|
53
56
|
public on<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
|
|
54
|
-
public on<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
|
|
55
|
-
public on<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
|
|
56
57
|
/* eslint-enable max-len */
|
|
57
58
|
|
|
58
59
|
public on(
|
|
59
60
|
event: string,
|
|
60
|
-
optionsOrListener: Partial<EventListenerOptions> | EventListener,
|
|
61
|
+
optionsOrListener: Partial<EventListenerOptions> | EventListenerPriority | EventListener,
|
|
61
62
|
listener?: EventListener,
|
|
62
63
|
): () => void {
|
|
63
|
-
const options =
|
|
64
|
+
const options =
|
|
65
|
+
typeof optionsOrListener === 'function'
|
|
66
|
+
? {}
|
|
67
|
+
: typeof optionsOrListener === 'number'
|
|
68
|
+
? { priority: optionsOrListener }
|
|
69
|
+
: optionsOrListener;
|
|
64
70
|
const handler = typeof optionsOrListener === 'function' ? optionsOrListener : (listener as EventListener);
|
|
65
71
|
|
|
66
72
|
this.registerListener(event, options, handler);
|
|
@@ -73,8 +79,6 @@ export class EventsService extends Service {
|
|
|
73
79
|
public once<Event extends EventWithoutPayload>(event: Event, options: Partial<EventListenerOptions>, listener: () => unknown): () => void; // prettier-ignore
|
|
74
80
|
public once<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
|
|
75
81
|
public once<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
|
|
76
|
-
public once<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
|
|
77
|
-
public once<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
|
|
78
82
|
/* eslint-enable max-len */
|
|
79
83
|
|
|
80
84
|
public once(
|
package/src/services/Service.ts
CHANGED
|
@@ -1,49 +1,68 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import {
|
|
2
|
+
MagicObject,
|
|
3
|
+
PromisedValue,
|
|
4
|
+
Storage,
|
|
5
|
+
arrayFrom,
|
|
6
|
+
fail,
|
|
7
|
+
isEmpty,
|
|
8
|
+
objectDeepClone,
|
|
9
|
+
objectOnly,
|
|
10
|
+
} from '@noeldemartin/utils';
|
|
11
|
+
import type { Constructor, Nullable } from '@noeldemartin/utils';
|
|
4
12
|
import type { Store } from 'pinia';
|
|
5
13
|
|
|
6
|
-
import ServiceBootError from '
|
|
7
|
-
import { defineServiceStore } from '
|
|
14
|
+
import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
|
|
15
|
+
import { defineServiceStore } from '@aerogel/core/services/store';
|
|
16
|
+
import type { Unref } from '@aerogel/core/utils/vue';
|
|
8
17
|
|
|
9
18
|
export type ServiceState = Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
10
19
|
export type DefaultServiceState = any; // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
11
20
|
export type ServiceConstructor<T extends Service = Service> = Constructor<T> & typeof Service;
|
|
12
|
-
export type UnrefServiceState<State extends ServiceState> = {
|
|
13
|
-
[K in keyof State]: State[K] extends MaybeRef<infer T> ? T : State[K];
|
|
14
|
-
};
|
|
15
21
|
|
|
16
22
|
export type ComputedStateDefinition<TState extends ServiceState, TComputedState extends ServiceState> = {
|
|
17
|
-
[K in keyof TComputedState]: (state:
|
|
23
|
+
[K in keyof TComputedState]: (state: Unref<TState>) => TComputedState[K];
|
|
18
24
|
} & ThisType<{
|
|
19
25
|
readonly [K in keyof TComputedState]: TComputedState[K];
|
|
20
26
|
}>;
|
|
21
27
|
|
|
28
|
+
export type StateWatchers<TService extends Service, TState extends ServiceState> = {
|
|
29
|
+
[K in keyof TState]?: (this: TService, value: TState[K], oldValue: TState[K]) => unknown;
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
export type ServiceWithState<
|
|
33
|
+
State extends ServiceState = ServiceState,
|
|
34
|
+
ComputedState extends ServiceState = {},
|
|
35
|
+
ServiceStorage = Partial<State>,
|
|
36
|
+
> = Constructor<Unref<State>> &
|
|
37
|
+
Constructor<ComputedState> &
|
|
38
|
+
Constructor<Service<Unref<State>, ComputedState, Unref<ServiceStorage>>>;
|
|
39
|
+
|
|
22
40
|
export function defineServiceState<
|
|
23
41
|
State extends ServiceState = ServiceState,
|
|
24
|
-
ComputedState extends ServiceState = {}
|
|
42
|
+
ComputedState extends ServiceState = {},
|
|
43
|
+
ServiceStorage = Partial<State>,
|
|
25
44
|
>(options: {
|
|
26
45
|
name: string;
|
|
27
46
|
initialState: State | (() => State);
|
|
28
47
|
persist?: (keyof State)[];
|
|
48
|
+
watch?: StateWatchers<Service, State>;
|
|
29
49
|
computed?: ComputedStateDefinition<State, ComputedState>;
|
|
30
|
-
serialize?: (state: Partial<State>) =>
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
return class extends Service<UnrefServiceState<State>, ComputedState> {
|
|
50
|
+
serialize?: (state: Partial<State>) => ServiceStorage;
|
|
51
|
+
restore?: (state: ServiceStorage) => Partial<State>;
|
|
52
|
+
}): ServiceWithState<State, ComputedState, ServiceStorage> {
|
|
53
|
+
return class extends Service<Unref<State>, ComputedState, ServiceStorage> {
|
|
35
54
|
|
|
36
|
-
public static persist = (options.persist as string[]) ?? [];
|
|
55
|
+
public static override persist = (options.persist as string[]) ?? [];
|
|
37
56
|
|
|
38
|
-
protected usesStore(): boolean {
|
|
57
|
+
protected override usesStore(): boolean {
|
|
39
58
|
return true;
|
|
40
59
|
}
|
|
41
60
|
|
|
42
|
-
protected getName(): string | null {
|
|
61
|
+
protected override getName(): string | null {
|
|
43
62
|
return options.name ?? null;
|
|
44
63
|
}
|
|
45
64
|
|
|
46
|
-
protected getInitialState():
|
|
65
|
+
protected override getInitialState(): Unref<State> {
|
|
47
66
|
if (typeof options.initialState === 'function') {
|
|
48
67
|
return options.initialState();
|
|
49
68
|
}
|
|
@@ -64,26 +83,32 @@ export function defineServiceState<
|
|
|
64
83
|
state[key as keyof State] = value;
|
|
65
84
|
|
|
66
85
|
return state;
|
|
67
|
-
}, {} as
|
|
86
|
+
}, {} as Unref<State>);
|
|
68
87
|
}
|
|
69
88
|
|
|
70
|
-
protected getComputedStateDefinition(): ComputedStateDefinition<
|
|
71
|
-
return (options.computed ?? {}) as ComputedStateDefinition<
|
|
89
|
+
protected override getComputedStateDefinition(): ComputedStateDefinition<Unref<State>, ComputedState> {
|
|
90
|
+
return (options.computed ?? {}) as ComputedStateDefinition<Unref<State>, ComputedState>;
|
|
72
91
|
}
|
|
73
92
|
|
|
74
|
-
protected
|
|
75
|
-
return options.
|
|
93
|
+
protected override getStateWatchers(): StateWatchers<Service, Unref<State>> {
|
|
94
|
+
return (options.watch ?? {}) as StateWatchers<Service, Unref<State>>;
|
|
76
95
|
}
|
|
77
96
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
97
|
+
protected override serializePersistedState(state: Partial<State>): ServiceStorage {
|
|
98
|
+
return options.serialize?.(state) ?? (state as ServiceStorage);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
protected override deserializePersistedState(state: ServiceStorage): Partial<State> {
|
|
102
|
+
return options.restore?.(state) ?? (state as Partial<State>);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
} as unknown as ServiceWithState<State, ComputedState, ServiceStorage>;
|
|
81
106
|
}
|
|
82
107
|
|
|
83
108
|
export default class Service<
|
|
84
109
|
State extends ServiceState = DefaultServiceState,
|
|
85
110
|
ComputedState extends ServiceState = {},
|
|
86
|
-
ServiceStorage
|
|
111
|
+
ServiceStorage = Partial<State>,
|
|
87
112
|
> extends MagicObject {
|
|
88
113
|
|
|
89
114
|
public static persist: string[] = [];
|
|
@@ -91,6 +116,7 @@ export default class Service<
|
|
|
91
116
|
protected _name: string;
|
|
92
117
|
private _booted: PromisedValue<void>;
|
|
93
118
|
private _computedStateKeys: Set<keyof State>;
|
|
119
|
+
private _watchers: StateWatchers<Service, State>;
|
|
94
120
|
private _store: Store<string, State, ComputedState, {}> | false;
|
|
95
121
|
|
|
96
122
|
constructor() {
|
|
@@ -101,6 +127,7 @@ export default class Service<
|
|
|
101
127
|
this._name = this.getName() ?? new.target.name;
|
|
102
128
|
this._booted = new PromisedValue();
|
|
103
129
|
this._computedStateKeys = new Set(Object.keys(getters));
|
|
130
|
+
this._watchers = this.getStateWatchers();
|
|
104
131
|
this._store =
|
|
105
132
|
this.usesStore() &&
|
|
106
133
|
defineServiceStore(this._name, {
|
|
@@ -115,6 +142,12 @@ export default class Service<
|
|
|
115
142
|
return this._booted;
|
|
116
143
|
}
|
|
117
144
|
|
|
145
|
+
public override static<T extends typeof Service>(): T;
|
|
146
|
+
public override static<T extends typeof Service, K extends keyof T>(property: K): T[K];
|
|
147
|
+
public override static<T extends typeof Service, K extends keyof T>(property?: K): T | T[K] {
|
|
148
|
+
return super.static<T, K>(property as K);
|
|
149
|
+
}
|
|
150
|
+
|
|
118
151
|
public launch(): Promise<void> {
|
|
119
152
|
const handleError = (error: unknown) => this._booted.reject(new ServiceBootError(this._name, error));
|
|
120
153
|
|
|
@@ -149,10 +182,10 @@ export default class Service<
|
|
|
149
182
|
const store = this._store as any;
|
|
150
183
|
|
|
151
184
|
if (property) {
|
|
152
|
-
return store ? store[property] : undefined;
|
|
185
|
+
return store ? store[property] : (undefined as State[P]);
|
|
153
186
|
}
|
|
154
187
|
|
|
155
|
-
return store ? store : {};
|
|
188
|
+
return store ? store : ({} as State);
|
|
156
189
|
}
|
|
157
190
|
|
|
158
191
|
public setState<P extends keyof State>(property: P, value: State[P]): void;
|
|
@@ -162,16 +195,31 @@ export default class Service<
|
|
|
162
195
|
return;
|
|
163
196
|
}
|
|
164
197
|
|
|
165
|
-
const
|
|
166
|
-
|
|
167
|
-
) as Partial<State>;
|
|
198
|
+
const update = typeof stateOrProperty === 'string' ? { [stateOrProperty]: value } : stateOrProperty;
|
|
199
|
+
const old = objectOnly(this._store.$state as State, Object.keys(update));
|
|
168
200
|
|
|
169
|
-
Object.assign(this._store.$state,
|
|
201
|
+
Object.assign(this._store.$state, update);
|
|
202
|
+
this.onStateUpdated(update as Partial<State>, old as Partial<State>);
|
|
203
|
+
}
|
|
170
204
|
|
|
171
|
-
|
|
205
|
+
public updatePersistedState<T extends keyof State>(key: T): void;
|
|
206
|
+
public updatePersistedState<T extends keyof State>(keys: T[]): void;
|
|
207
|
+
public updatePersistedState<T extends keyof State>(keyOrKeys: T | T[]): void {
|
|
208
|
+
if (!this._store) {
|
|
209
|
+
return;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const keys = arrayFrom(keyOrKeys) as Array<keyof State>;
|
|
213
|
+
const state = objectOnly(this._store.$state as State, keys);
|
|
214
|
+
|
|
215
|
+
if (isEmpty(state)) {
|
|
216
|
+
return;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
this.onPersistentStateUpdated(state);
|
|
172
220
|
}
|
|
173
221
|
|
|
174
|
-
protected __get(property: string): unknown {
|
|
222
|
+
protected override __get(property: string): unknown {
|
|
175
223
|
if (this.hasState(property)) {
|
|
176
224
|
return this.getState(property);
|
|
177
225
|
}
|
|
@@ -179,19 +227,29 @@ export default class Service<
|
|
|
179
227
|
return super.__get(property);
|
|
180
228
|
}
|
|
181
229
|
|
|
182
|
-
protected __set(property: string, value: unknown): void {
|
|
230
|
+
protected override __set(property: string, value: unknown): void {
|
|
183
231
|
this.setState({ [property]: value } as Partial<State>);
|
|
184
232
|
}
|
|
185
233
|
|
|
186
|
-
protected onStateUpdated(
|
|
187
|
-
|
|
188
|
-
const persist = (this.constructor as unknown as { persist: string[] }).persist;
|
|
189
|
-
const persisted = objectOnly(state, persist);
|
|
234
|
+
protected onStateUpdated(update: Partial<State>, old: Partial<State>): void {
|
|
235
|
+
const persisted = objectOnly(update, this.static('persist'));
|
|
190
236
|
|
|
191
|
-
if (isEmpty(persisted)) {
|
|
192
|
-
|
|
237
|
+
if (!isEmpty(persisted)) {
|
|
238
|
+
this.onPersistentStateUpdated(persisted as Partial<State>);
|
|
193
239
|
}
|
|
194
240
|
|
|
241
|
+
for (const property in update) {
|
|
242
|
+
const watcher = this._watchers[property] as Nullable<(value: unknown, oldValue: unknown) => unknown>;
|
|
243
|
+
|
|
244
|
+
if (!watcher || update[property] === old[property]) {
|
|
245
|
+
continue;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
watcher.call(this, update[property], old[property]);
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
protected onPersistentStateUpdated(persisted: Partial<State>): void {
|
|
195
253
|
const storage = Storage.get<ServiceStorage>(this._name);
|
|
196
254
|
|
|
197
255
|
if (!storage) {
|
|
@@ -220,34 +278,39 @@ export default class Service<
|
|
|
220
278
|
return {} as ComputedStateDefinition<State, ComputedState>;
|
|
221
279
|
}
|
|
222
280
|
|
|
223
|
-
protected
|
|
224
|
-
return
|
|
281
|
+
protected getStateWatchers(): StateWatchers<Service, State> {
|
|
282
|
+
return {};
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
protected serializePersistedState(state: Partial<State>): ServiceStorage {
|
|
286
|
+
return state as ServiceStorage;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
protected deserializePersistedState(state: ServiceStorage): Partial<State> {
|
|
290
|
+
return state as Partial<State>;
|
|
225
291
|
}
|
|
226
292
|
|
|
227
293
|
protected async frameworkBoot(): Promise<void> {
|
|
228
|
-
this.
|
|
294
|
+
this.restorePersistedState();
|
|
229
295
|
}
|
|
230
296
|
|
|
231
297
|
protected async boot(): Promise<void> {
|
|
232
298
|
// Placeholder for overrides, don't place any functionality here.
|
|
233
299
|
}
|
|
234
300
|
|
|
235
|
-
protected
|
|
236
|
-
|
|
237
|
-
const persist = (this.constructor as unknown as { persist: string[] }).persist;
|
|
238
|
-
|
|
239
|
-
if (!this.usesStore() || isEmpty(persist)) {
|
|
301
|
+
protected restorePersistedState(): void {
|
|
302
|
+
if (!this.usesStore() || isEmpty(this.static('persist'))) {
|
|
240
303
|
return;
|
|
241
304
|
}
|
|
242
305
|
|
|
243
306
|
if (Storage.has(this._name)) {
|
|
244
307
|
const persisted = Storage.require<ServiceStorage>(this._name);
|
|
245
|
-
this.setState(persisted);
|
|
308
|
+
this.setState(this.deserializePersistedState(persisted));
|
|
246
309
|
|
|
247
310
|
return;
|
|
248
311
|
}
|
|
249
312
|
|
|
250
|
-
Storage.set(this._name, objectOnly(this.getState(), persist));
|
|
313
|
+
Storage.set(this._name, objectOnly(this.getState(), this.static('persist')));
|
|
251
314
|
}
|
|
252
315
|
|
|
253
316
|
protected requireStore(): Store<string, State, ComputedState, {}> {
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { facade } from '@noeldemartin/utils';
|
|
2
|
+
|
|
3
|
+
import Events from '@aerogel/core/services/Events';
|
|
4
|
+
import Service from '@aerogel/core/services/Service';
|
|
5
|
+
|
|
6
|
+
export class StorageService extends Service {
|
|
7
|
+
|
|
8
|
+
public async purge(): Promise<void> {
|
|
9
|
+
await Events.emit('purge-storage');
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export default facade(StorageService);
|
|
15
|
+
|
|
16
|
+
declare module '@aerogel/core/services/Events' {
|
|
17
|
+
export interface EventsPayload {
|
|
18
|
+
'purge-storage': void;
|
|
19
|
+
}
|
|
20
|
+
}
|