@aerogel/core 0.0.0-next.9a1c5ba39a454b316eba36ec7bdf579fed3d95d2 → 0.0.0-next.9aa7c279868edbedbcee075aef52212597d803fb

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 (154) hide show
  1. package/dist/aerogel-core.d.ts +1283 -1588
  2. package/dist/aerogel-core.js +2496 -1994
  3. package/dist/aerogel-core.js.map +1 -1
  4. package/package.json +10 -2
  5. package/src/components/AppLayout.vue +14 -0
  6. package/src/components/{AGAppModals.vue → AppModals.vue} +2 -3
  7. package/src/components/AppOverlays.vue +9 -0
  8. package/src/components/AppToasts.vue +16 -0
  9. package/src/components/contracts/AlertModal.ts +8 -0
  10. package/src/components/contracts/Button.ts +16 -0
  11. package/src/components/contracts/ConfirmModal.ts +46 -0
  12. package/src/components/contracts/DropdownMenu.ts +20 -0
  13. package/src/components/{modals/AGErrorReportModal.ts → contracts/ErrorReportModal.ts} +5 -22
  14. package/src/components/contracts/Input.ts +26 -0
  15. package/src/components/contracts/LoadingModal.ts +26 -0
  16. package/src/components/contracts/Modal.ts +15 -10
  17. package/src/components/contracts/PromptModal.ts +34 -0
  18. package/src/components/contracts/Select.ts +45 -0
  19. package/src/components/contracts/Toast.ts +15 -0
  20. package/src/components/contracts/index.ts +10 -1
  21. package/src/components/headless/HeadlessButton.vue +51 -0
  22. package/src/components/headless/HeadlessInput.vue +59 -0
  23. package/src/components/headless/{forms/AGHeadlessInputDescription.vue → HeadlessInputDescription.vue} +6 -7
  24. package/src/components/headless/{forms/AGHeadlessInputError.vue → HeadlessInputError.vue} +2 -6
  25. package/src/components/headless/{forms/AGHeadlessInputInput.vue → HeadlessInputInput.vue} +16 -25
  26. package/src/components/headless/{forms/AGHeadlessInputLabel.vue → HeadlessInputLabel.vue} +2 -6
  27. package/src/components/headless/{forms/AGHeadlessInputTextArea.vue → HeadlessInputTextArea.vue} +9 -12
  28. package/src/components/headless/HeadlessModal.vue +57 -0
  29. package/src/components/headless/HeadlessModalContent.vue +30 -0
  30. package/src/components/headless/HeadlessModalDescription.vue +12 -0
  31. package/src/components/headless/HeadlessModalOverlay.vue +12 -0
  32. package/src/components/headless/HeadlessModalTitle.vue +12 -0
  33. package/src/components/headless/HeadlessSelect.vue +120 -0
  34. package/src/components/headless/{forms/AGHeadlessSelectError.vue → HeadlessSelectError.vue} +3 -4
  35. package/src/components/headless/HeadlessSelectLabel.vue +25 -0
  36. package/src/components/headless/HeadlessSelectOption.vue +34 -0
  37. package/src/components/headless/HeadlessSelectOptions.vue +42 -0
  38. package/src/components/headless/HeadlessSelectTrigger.vue +22 -0
  39. package/src/components/headless/HeadlessSelectValue.vue +18 -0
  40. package/src/components/headless/HeadlessToast.vue +18 -0
  41. package/src/components/headless/HeadlessToastAction.vue +13 -0
  42. package/src/components/headless/index.ts +19 -3
  43. package/src/components/index.ts +5 -10
  44. package/src/components/ui/AdvancedOptions.vue +18 -0
  45. package/src/components/ui/AlertModal.vue +14 -0
  46. package/src/components/ui/Button.vue +98 -0
  47. package/src/components/ui/Checkbox.vue +56 -0
  48. package/src/components/ui/ConfirmModal.vue +45 -0
  49. package/src/components/ui/DropdownMenu.vue +32 -0
  50. package/src/components/ui/DropdownMenuOption.vue +14 -0
  51. package/src/components/ui/DropdownMenuOptions.vue +27 -0
  52. package/src/components/ui/EditableContent.vue +82 -0
  53. package/src/components/ui/ErrorMessage.vue +15 -0
  54. package/src/components/ui/ErrorReportModal.vue +67 -0
  55. package/src/components/{modals/AGErrorReportModalButtons.vue → ui/ErrorReportModalButtons.vue} +28 -21
  56. package/src/components/ui/ErrorReportModalTitle.vue +24 -0
  57. package/src/components/{forms/AGForm.vue → ui/Form.vue} +4 -5
  58. package/src/components/ui/Input.vue +56 -0
  59. package/src/components/ui/Link.vue +12 -0
  60. package/src/components/ui/LoadingModal.vue +34 -0
  61. package/src/components/ui/Markdown.vue +69 -0
  62. package/src/components/ui/Modal.vue +122 -0
  63. package/src/components/{modals/AGModalContext.vue → ui/ModalContext.vue} +8 -9
  64. package/src/components/ui/ProgressBar.vue +51 -0
  65. package/src/components/ui/PromptModal.vue +38 -0
  66. package/src/components/ui/Select.vue +27 -0
  67. package/src/components/ui/SelectLabel.vue +17 -0
  68. package/src/components/ui/SelectOption.vue +29 -0
  69. package/src/components/ui/SelectOptions.vue +35 -0
  70. package/src/components/ui/SelectTrigger.vue +29 -0
  71. package/src/components/ui/SettingsModal.vue +15 -0
  72. package/src/components/{lib/AGStartupCrash.vue → ui/StartupCrash.vue} +7 -7
  73. package/src/components/ui/Toast.vue +44 -0
  74. package/src/components/ui/index.ts +30 -0
  75. package/src/errors/Errors.ts +7 -16
  76. package/src/forms/{Form.test.ts → FormController.test.ts} +32 -9
  77. package/src/forms/{Form.ts → FormController.ts} +28 -27
  78. package/src/forms/index.ts +2 -3
  79. package/src/forms/utils.ts +35 -35
  80. package/src/index.css +72 -0
  81. package/src/lang/index.ts +4 -0
  82. package/src/lang/settings/Language.vue +48 -0
  83. package/src/lang/settings/index.ts +10 -0
  84. package/src/services/App.state.ts +11 -1
  85. package/src/services/App.ts +9 -1
  86. package/src/services/Events.test.ts +8 -8
  87. package/src/services/Events.ts +2 -8
  88. package/src/services/index.ts +3 -0
  89. package/src/ui/UI.state.ts +7 -12
  90. package/src/ui/UI.ts +102 -103
  91. package/src/ui/index.ts +23 -24
  92. package/src/utils/classes.ts +49 -0
  93. package/src/utils/composition/events.ts +2 -4
  94. package/src/utils/composition/forms.ts +20 -4
  95. package/src/utils/composition/state.ts +11 -2
  96. package/src/utils/index.ts +3 -1
  97. package/src/utils/types.ts +3 -0
  98. package/src/utils/vue.ts +22 -128
  99. package/src/components/AGAppLayout.vue +0 -16
  100. package/src/components/AGAppOverlays.vue +0 -41
  101. package/src/components/AGAppSnackbars.vue +0 -13
  102. package/src/components/composition.ts +0 -23
  103. package/src/components/constants.ts +0 -8
  104. package/src/components/contracts/shared.ts +0 -9
  105. package/src/components/forms/AGButton.vue +0 -44
  106. package/src/components/forms/AGCheckbox.vue +0 -42
  107. package/src/components/forms/AGInput.vue +0 -42
  108. package/src/components/forms/AGSelect.story.vue +0 -46
  109. package/src/components/forms/AGSelect.vue +0 -54
  110. package/src/components/forms/index.ts +0 -5
  111. package/src/components/headless/forms/AGHeadlessButton.ts +0 -3
  112. package/src/components/headless/forms/AGHeadlessButton.vue +0 -62
  113. package/src/components/headless/forms/AGHeadlessInput.ts +0 -41
  114. package/src/components/headless/forms/AGHeadlessInput.vue +0 -70
  115. package/src/components/headless/forms/AGHeadlessSelect.ts +0 -42
  116. package/src/components/headless/forms/AGHeadlessSelect.vue +0 -77
  117. package/src/components/headless/forms/AGHeadlessSelectOption.ts +0 -4
  118. package/src/components/headless/forms/AGHeadlessSelectOption.vue +0 -31
  119. package/src/components/headless/forms/AGHeadlessSelectOptions.vue +0 -19
  120. package/src/components/headless/forms/AGHeadlessSelectTrigger.vue +0 -25
  121. package/src/components/headless/forms/composition.ts +0 -10
  122. package/src/components/headless/forms/index.ts +0 -17
  123. package/src/components/headless/modals/AGHeadlessModal.ts +0 -33
  124. package/src/components/headless/modals/AGHeadlessModal.vue +0 -88
  125. package/src/components/headless/modals/AGHeadlessModalContent.vue +0 -25
  126. package/src/components/headless/modals/index.ts +0 -5
  127. package/src/components/headless/snackbars/AGHeadlessSnackbar.vue +0 -10
  128. package/src/components/headless/snackbars/index.ts +0 -40
  129. package/src/components/lib/AGErrorMessage.vue +0 -16
  130. package/src/components/lib/AGLink.vue +0 -9
  131. package/src/components/lib/AGMarkdown.vue +0 -54
  132. package/src/components/lib/AGMeasured.vue +0 -16
  133. package/src/components/lib/AGProgressBar.vue +0 -55
  134. package/src/components/lib/index.ts +0 -6
  135. package/src/components/modals/AGAlertModal.ts +0 -18
  136. package/src/components/modals/AGAlertModal.vue +0 -14
  137. package/src/components/modals/AGConfirmModal.ts +0 -42
  138. package/src/components/modals/AGConfirmModal.vue +0 -27
  139. package/src/components/modals/AGErrorReportModal.vue +0 -54
  140. package/src/components/modals/AGErrorReportModalTitle.vue +0 -25
  141. package/src/components/modals/AGLoadingModal.ts +0 -29
  142. package/src/components/modals/AGLoadingModal.vue +0 -15
  143. package/src/components/modals/AGModal.vue +0 -40
  144. package/src/components/modals/AGModalContext.ts +0 -8
  145. package/src/components/modals/AGModalTitle.vue +0 -9
  146. package/src/components/modals/AGPromptModal.ts +0 -41
  147. package/src/components/modals/AGPromptModal.vue +0 -35
  148. package/src/components/modals/index.ts +0 -16
  149. package/src/components/snackbars/AGSnackbar.vue +0 -36
  150. package/src/components/snackbars/index.ts +0 -3
  151. package/src/components/utils.ts +0 -63
  152. package/src/forms/composition.ts +0 -6
  153. package/src/utils/tailwindcss.test.ts +0 -26
  154. package/src/utils/tailwindcss.ts +0 -7
@@ -2,15 +2,12 @@ import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty
2
2
 
3
3
  import App from '@aerogel/core/services/App';
4
4
  import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
5
- import UI, { UIComponents } from '@aerogel/core/ui/UI';
5
+ import UI from '@aerogel/core/ui/UI';
6
6
  import { translateWithDefault } from '@aerogel/core/lang/utils';
7
+ import { Events } from '@aerogel/core/services';
7
8
 
8
9
  import Service from './Errors.state';
9
- import { Colors } from '@aerogel/core/components/constants';
10
- import { Events } from '@aerogel/core/services';
11
- import type { AGErrorReportModalProps } from '@aerogel/core/components/modals/AGErrorReportModal';
12
10
  import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
13
- import type { ModalComponent } from '@aerogel/core/ui/UI.state';
14
11
 
15
12
  export class ErrorsService extends Service {
16
13
 
@@ -34,9 +31,7 @@ export class ErrorsService extends Service {
34
31
  return;
35
32
  }
36
33
 
37
- UI.openModal<ModalComponent<AGErrorReportModalProps>>(UI.requireComponent(UIComponents.ErrorReportModal), {
38
- reports,
39
- });
34
+ UI.openModal(UI.requireComponent('error-report-modal'), { reports });
40
35
  }
41
36
 
42
37
  public async report(error: ErrorSource, message?: string): Promise<void> {
@@ -71,20 +66,16 @@ export class ErrorsService extends Service {
71
66
  date: new Date(),
72
67
  };
73
68
 
74
- UI.showSnackbar(
69
+ UI.toast(
75
70
  message ??
76
71
  translateWithDefault('errors.notice', 'Something went wrong, but it\'s not your fault. Try again!'),
77
72
  {
78
- color: Colors.Danger,
73
+ variant: 'danger',
79
74
  actions: [
80
75
  {
81
- text: translateWithDefault('errors.viewDetails', 'View details'),
76
+ label: translateWithDefault('errors.viewDetails', 'View details'),
82
77
  dismiss: true,
83
- handler: () =>
84
- UI.openModal<ModalComponent<AGErrorReportModalProps>>(
85
- UI.requireComponent(UIComponents.ErrorReportModal),
86
- { reports: [report] },
87
- ),
78
+ click: () => UI.openModal(UI.requireComponent('error-report-modal'), { reports: [report] }),
88
79
  },
89
80
  ],
90
81
  },
@@ -1,11 +1,18 @@
1
1
  import { describe, expect, expectTypeOf, it } from 'vitest';
2
+ import { tt } from '@noeldemartin/testing';
3
+ import type { Equals } from '@noeldemartin/utils';
4
+ import type { Expect } from '@noeldemartin/testing';
2
5
 
3
- import { useForm } from '@aerogel/core/forms/composition';
4
- import { numberInput, requiredStringInput } from '@aerogel/core/forms/utils';
6
+ import {
7
+ numberInput,
8
+ objectInput,
9
+ requiredObjectInput,
10
+ requiredStringInput,
11
+ stringInput,
12
+ } from '@aerogel/core/forms/utils';
13
+ import { useForm } from '@aerogel/core/utils/composition/forms';
5
14
 
6
- import { FormFieldTypes } from './Form';
7
-
8
- describe('Form', () => {
15
+ describe('FormController', () => {
9
16
 
10
17
  it('defines magic fields', () => {
11
18
  const form = useForm({
@@ -21,7 +28,7 @@ describe('Form', () => {
21
28
  // Arrange
22
29
  const form = useForm({
23
30
  name: {
24
- type: FormFieldTypes.String,
31
+ type: 'string',
25
32
  rules: 'required',
26
33
  },
27
34
  });
@@ -39,7 +46,7 @@ describe('Form', () => {
39
46
  // Arrange
40
47
  const form = useForm({
41
48
  name: {
42
- type: FormFieldTypes.String,
49
+ type: 'string',
43
50
  rules: 'required',
44
51
  },
45
52
  });
@@ -60,11 +67,11 @@ describe('Form', () => {
60
67
  // Arrange
61
68
  const form = useForm({
62
69
  trimmed: {
63
- type: FormFieldTypes.String,
70
+ type: 'string',
64
71
  rules: 'required',
65
72
  },
66
73
  untrimmed: {
67
- type: FormFieldTypes.String,
74
+ type: 'string',
68
75
  rules: 'required',
69
76
  trim: false,
70
77
  },
@@ -84,4 +91,20 @@ describe('Form', () => {
84
91
  expect(form.errors).toEqual({ trimmed: ['required'], untrimmed: null });
85
92
  });
86
93
 
94
+ it('infers field types', () => {
95
+ const form = useForm({
96
+ one: stringInput(),
97
+ two: requiredStringInput(),
98
+ three: objectInput(),
99
+ four: requiredObjectInput<{ foo: string; bar?: number }>(),
100
+ });
101
+
102
+ tt<
103
+ | Expect<Equals<typeof form.one, string | null>>
104
+ | Expect<Equals<typeof form.two, string>>
105
+ | Expect<Equals<typeof form.three, object | null>>
106
+ | Expect<Equals<typeof form.four, { foo: string; bar?: number }>>
107
+ >();
108
+ });
109
+
87
110
  });
@@ -1,33 +1,32 @@
1
1
  import { computed, nextTick, reactive, readonly, ref } from 'vue';
2
2
  import { MagicObject, arrayRemove, fail, toString } from '@noeldemartin/utils';
3
- import { validate } from './validation';
4
- import type { ObjectValues } from '@noeldemartin/utils';
5
3
  import type { ComputedRef, DeepReadonly, Ref, UnwrapNestedRefs } from 'vue';
6
4
 
7
- export const FormFieldTypes = {
8
- String: 'string',
9
- Number: 'number',
10
- Boolean: 'boolean',
11
- Object: 'object',
12
- Date: 'date',
13
- } as const;
5
+ import { validate } from './validation';
6
+
7
+ export const __objectType: unique symbol = Symbol();
14
8
 
15
- export interface FormFieldDefinition<TType extends FormFieldType = FormFieldType, TRules extends string = string> {
9
+ export interface FormFieldDefinition<
10
+ TType extends FormFieldType = FormFieldType,
11
+ TRules extends string = string,
12
+ TObjectType = object,
13
+ > {
16
14
  type: TType;
17
15
  trim?: boolean;
18
16
  default?: GetFormFieldValue<TType>;
19
17
  rules?: TRules;
18
+ [__objectType]?: TObjectType;
20
19
  }
21
20
 
22
- export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
23
- export type FormFieldType = ObjectValues<typeof FormFieldTypes>;
21
+ export type FormFieldType = 'string' | 'number' | 'boolean' | 'object' | 'date';
24
22
  export type FormFieldValue = GetFormFieldValue<FormFieldType>;
23
+ export type FormFieldDefinitions = Record<string, FormFieldDefinition>;
25
24
 
26
25
  export type FormData<T> = {
27
- -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules>
26
+ -readonly [k in keyof T]: T[k] extends FormFieldDefinition<infer TType, infer TRules, infer TObjectType>
28
27
  ? TRules extends 'required'
29
- ? GetFormFieldValue<TType>
30
- : GetFormFieldValue<TType> | null
28
+ ? GetFormFieldValue<TType, TObjectType>
29
+ : GetFormFieldValue<TType, TObjectType> | null
31
30
  : never;
32
31
  };
33
32
 
@@ -35,24 +34,26 @@ export type FormErrors<T> = {
35
34
  [k in keyof T]: string[] | null;
36
35
  };
37
36
 
38
- export type GetFormFieldValue<TType> = TType extends typeof FormFieldTypes.String
37
+ export type GetFormFieldValue<TType, TObjectType = object> = TType extends 'string'
39
38
  ? string
40
- : TType extends typeof FormFieldTypes.Number
39
+ : TType extends 'number'
41
40
  ? number
42
- : TType extends typeof FormFieldTypes.Boolean
41
+ : TType extends 'boolean'
43
42
  ? boolean
44
- : TType extends typeof FormFieldTypes.Object
45
- ? object
46
- : TType extends typeof FormFieldTypes.Date
43
+ : TType extends 'object'
44
+ ? TObjectType extends object
45
+ ? TObjectType
46
+ : object
47
+ : TType extends 'date'
47
48
  ? Date
48
49
  : never;
49
50
 
50
- const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
51
+ const validForms: WeakMap<FormController, ComputedRef<boolean>> = new WeakMap();
51
52
 
52
53
  export type SubmitFormListener = () => unknown;
53
54
  export type FocusFormListener = (input: string) => unknown;
54
55
 
55
- export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
56
+ export default class FormController<Fields extends FormFieldDefinitions = FormFieldDefinitions> extends MagicObject {
56
57
 
57
58
  public errors: DeepReadonly<UnwrapNestedRefs<FormErrors<Fields>>>;
58
59
 
@@ -91,7 +92,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
91
92
  this._fields[field] ?? fail<FormFieldDefinition>(`Trying to set undefined '${toString(field)}' field`);
92
93
 
93
94
  this._data[field] =
94
- definition.type === FormFieldTypes.String && (definition.trim ?? true)
95
+ definition.type === 'string' && (definition.trim ?? true)
95
96
  ? (toString(value).trim() as FormData<Fields>[T])
96
97
  : value;
97
98
 
@@ -207,10 +208,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
207
208
  return {} as FormData<Fields>;
208
209
  }
209
210
 
210
- const data = Object.entries(fields).reduce((formData, [name, definition]) => {
211
- formData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
211
+ const data = Object.entries(fields).reduce((initialData, [name, definition]) => {
212
+ initialData[name as keyof Fields] = (definition.default ?? null) as FormData<Fields>[keyof Fields];
212
213
 
213
- return formData;
214
+ return initialData;
214
215
  }, {} as FormData<Fields>);
215
216
 
216
217
  return reactive(data) as FormData<Fields>;
@@ -1,5 +1,4 @@
1
- export * from './composition';
2
- export * from './Form';
1
+ export * from './FormController';
3
2
  export * from './utils';
4
3
  export * from './validation';
5
- export { default as Form } from './Form';
4
+ export { default as FormController } from './FormController';
@@ -1,84 +1,84 @@
1
- import { FormFieldTypes } from './Form';
2
- import type { FormFieldDefinition } from './Form';
1
+ import type { FormFieldDefinition } from './FormController';
3
2
 
4
- export function booleanInput(
5
- defaultValue?: boolean,
6
- options: { rules?: string } = {},
7
- ): FormFieldDefinition<typeof FormFieldTypes.Boolean> {
3
+ export function booleanInput(defaultValue?: boolean, options: { rules?: string } = {}): FormFieldDefinition<'boolean'> {
8
4
  return {
9
5
  default: defaultValue,
10
- type: FormFieldTypes.Boolean,
6
+ type: 'boolean',
11
7
  rules: options.rules,
12
8
  };
13
9
  }
14
10
 
15
- export function dateInput(
16
- defaultValue?: Date,
17
- options: { rules?: string } = {},
18
- ): FormFieldDefinition<typeof FormFieldTypes.Date> {
11
+ export function dateInput(defaultValue?: Date, options: { rules?: string } = {}): FormFieldDefinition<'date'> {
19
12
  return {
20
13
  default: defaultValue,
21
- type: FormFieldTypes.Date,
14
+ type: 'date',
22
15
  rules: options.rules,
23
16
  };
24
17
  }
25
18
 
26
- export function requiredBooleanInput(
27
- defaultValue?: boolean,
28
- ): FormFieldDefinition<typeof FormFieldTypes.Boolean, 'required'> {
19
+ export function requiredBooleanInput(defaultValue?: boolean): FormFieldDefinition<'boolean', 'required'> {
29
20
  return {
30
21
  default: defaultValue,
31
- type: FormFieldTypes.Boolean,
22
+ type: 'boolean',
32
23
  rules: 'required',
33
24
  };
34
25
  }
35
26
 
36
- export function requiredDateInput(defaultValue?: Date): FormFieldDefinition<typeof FormFieldTypes.Date> {
27
+ export function requiredDateInput(defaultValue?: Date): FormFieldDefinition<'date', 'required'> {
37
28
  return {
38
29
  default: defaultValue,
39
- type: FormFieldTypes.Date,
30
+ type: 'date',
40
31
  rules: 'required',
41
32
  };
42
33
  }
43
34
 
44
- export function requiredNumberInput(
45
- defaultValue?: number,
46
- ): FormFieldDefinition<typeof FormFieldTypes.Number, 'required'> {
35
+ export function requiredNumberInput(defaultValue?: number): FormFieldDefinition<'number', 'required'> {
47
36
  return {
48
37
  default: defaultValue,
49
- type: FormFieldTypes.Number,
38
+ type: 'number',
50
39
  rules: 'required',
51
40
  };
52
41
  }
53
42
 
54
- export function requiredStringInput(
55
- defaultValue?: string,
56
- ): FormFieldDefinition<typeof FormFieldTypes.String, 'required'> {
43
+ export function requiredObjectInput<T extends object>(defaultValue?: T): FormFieldDefinition<'object', 'required', T> {
57
44
  return {
58
45
  default: defaultValue,
59
- type: FormFieldTypes.String,
46
+ type: 'object',
60
47
  rules: 'required',
61
48
  };
62
49
  }
63
50
 
64
- export function numberInput(
65
- defaultValue?: number,
66
- options: { rules?: string } = {},
67
- ): FormFieldDefinition<typeof FormFieldTypes.Number> {
51
+ export function requiredStringInput(defaultValue?: string): FormFieldDefinition<'string', 'required'> {
68
52
  return {
69
53
  default: defaultValue,
70
- type: FormFieldTypes.Number,
54
+ type: 'string',
55
+ rules: 'required',
56
+ };
57
+ }
58
+
59
+ export function numberInput(defaultValue?: number, options: { rules?: string } = {}): FormFieldDefinition<'number'> {
60
+ return {
61
+ default: defaultValue,
62
+ type: 'number',
71
63
  rules: options.rules,
72
64
  };
73
65
  }
74
66
 
75
- export function stringInput(
76
- defaultValue?: string,
67
+ export function objectInput<T extends object>(
68
+ defaultValue?: T,
77
69
  options: { rules?: string } = {},
78
- ): FormFieldDefinition<typeof FormFieldTypes.String> {
70
+ ): FormFieldDefinition<'object', string, T> {
71
+ return {
72
+ default: defaultValue,
73
+ type: 'object',
74
+ rules: options.rules,
75
+ };
76
+ }
77
+
78
+ export function stringInput(defaultValue?: string, options: { rules?: string } = {}): FormFieldDefinition<'string'> {
79
79
  return {
80
80
  default: defaultValue,
81
- type: FormFieldTypes.String,
81
+ type: 'string',
82
82
  rules: options.rules,
83
83
  };
84
84
  }
package/src/index.css ADDED
@@ -0,0 +1,72 @@
1
+ @import 'tailwindcss';
2
+
3
+ @plugin '@tailwindcss/forms';
4
+ @plugin '@tailwindcss/typography';
5
+
6
+ @source './';
7
+
8
+ @theme {
9
+ --color-background: oklch(1 0 0);
10
+
11
+ --color-primary: oklch(0.205 0 0);
12
+ --color-primary-50: color-mix(in oklab, var(--color-primary-600) 5%, transparent);
13
+ --color-primary-100: color-mix(in oklab, var(--color-primary-600) 15%, transparent);
14
+ --color-primary-200: color-mix(in oklab, var(--color-primary-600) 30%, transparent);
15
+ --color-primary-300: color-mix(in oklab, var(--color-primary-600) 50%, transparent);
16
+ --color-primary-400: color-mix(in oklab, var(--color-primary-600) 65%, transparent);
17
+ --color-primary-500: color-mix(in oklab, var(--color-primary-600) 80%, transparent);
18
+ --color-primary-600: var(--color-primary);
19
+ --color-primary-700: color-mix(in oklab, var(--color-primary-600) 90%, black);
20
+ --color-primary-800: color-mix(in oklab, var(--color-primary-600) 80%, black);
21
+ --color-primary-900: color-mix(in oklab, var(--color-primary-600) 70%, black);
22
+ --color-primary-950: color-mix(in oklab, var(--color-primary-600) 50%, black);
23
+ }
24
+
25
+ .clickable {
26
+ position: relative;
27
+ }
28
+
29
+ .clickable::after {
30
+ --clickable-size: 44px;
31
+ --clickable-inset-by: min(0px, calc((100% - var(--clickable-size)) / 2));
32
+
33
+ content: '';
34
+ position: absolute;
35
+ top: var(--clickable-inset-by);
36
+ left: var(--clickable-inset-by);
37
+ right: var(--clickable-inset-by);
38
+ bottom: var(--clickable-inset-by);
39
+ }
40
+
41
+ input[type='number'].appearance-textfield {
42
+ appearance: textfield;
43
+ }
44
+
45
+ input[type='number'].appearance-textfield::-webkit-outer-spin-button,
46
+ input[type='number'].appearance-textfield::-webkit-inner-spin-button {
47
+ appearance: none;
48
+ }
49
+
50
+ button[data-markdown-action] {
51
+ color: var(--tw-prose-links);
52
+ text-decoration: underline;
53
+ font-weight: 500;
54
+ }
55
+
56
+ @keyframes fade-in {
57
+ 0% {
58
+ opacity: 0;
59
+ }
60
+ 100% {
61
+ opacity: 1;
62
+ }
63
+ }
64
+
65
+ @keyframes grow {
66
+ 0% {
67
+ scale: 0;
68
+ }
69
+ 100% {
70
+ opacity: 1;
71
+ }
72
+ }
package/src/lang/index.ts CHANGED
@@ -1,7 +1,9 @@
1
+ import App from '@aerogel/core/services/App';
1
2
  import { bootServices } from '@aerogel/core/services';
2
3
  import { definePlugin } from '@aerogel/core/plugins';
3
4
 
4
5
  import Lang from './Lang';
6
+ import settings from './settings';
5
7
  import type { LangProvider } from './Lang';
6
8
  import { translate, translateWithDefault } from './utils';
7
9
 
@@ -17,6 +19,8 @@ export default definePlugin({
17
19
  app.config.globalProperties.$t ??= translate;
18
20
  app.config.globalProperties.$td = translateWithDefault;
19
21
 
22
+ settings.forEach((setting) => App.addSetting(setting));
23
+
20
24
  await bootServices(app, services);
21
25
  },
22
26
  });
@@ -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>
@@ -0,0 +1,10 @@
1
+ import { defineSettings } from '@aerogel/core/services';
2
+
3
+ import Language from './Language.vue';
4
+
5
+ export default defineSettings([
6
+ {
7
+ priority: 100,
8
+ component: Language,
9
+ },
10
+ ]);
@@ -1,11 +1,20 @@
1
1
  import Aerogel from 'virtual:aerogel';
2
2
 
3
3
  import { getEnv } from '@noeldemartin/utils';
4
- import type { App } from 'vue';
4
+ import type { App, Component } from 'vue';
5
5
 
6
6
  import { defineServiceState } from '@aerogel/core/services/Service';
7
7
  import type { Plugin } from '@aerogel/core/plugins/Plugin';
8
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
+ }
17
+
9
18
  export default defineServiceState({
10
19
  name: 'app',
11
20
  initialState: {
@@ -14,6 +23,7 @@ export default defineServiceState({
14
23
  environment: getEnv() ?? 'development',
15
24
  version: Aerogel.version,
16
25
  sourceUrl: Aerogel.sourceUrl,
26
+ settings: [] as AppSetting[],
17
27
  },
18
28
  computed: {
19
29
  development: (state) => state.environment === 'development',
@@ -1,13 +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
6
  import Events from '@aerogel/core/services/Events';
6
7
  import type { Plugin } from '@aerogel/core/plugins';
7
- import type { Services } from '@aerogel/core/services';
8
+ import type { AppSetting, Services } from '@aerogel/core/services';
8
9
 
9
10
  import Service from './App.state';
10
11
 
12
+ export { defineSettings } from './App.state';
13
+ export type { AppSetting } from './App.state';
14
+
11
15
  export class AppService extends Service {
12
16
 
13
17
  public readonly name = Aerogel.name;
@@ -22,6 +26,10 @@ export class AppService extends Service {
22
26
  return this.mounted.isResolved();
23
27
  }
24
28
 
29
+ public addSetting(setting: AppSetting): void {
30
+ this.settings.push(markRaw(setting));
31
+ }
32
+
25
33
  public async whenReady<T>(callback: () => T): Promise<T> {
26
34
  const result = await this.ready.then(callback);
27
35
 
@@ -10,12 +10,12 @@ describe('Events', () => {
10
10
  // Arrange
11
11
  let counter = 0;
12
12
 
13
- Events.on('trigger', () => counter++);
13
+ Events.on('application-mounted', () => counter++);
14
14
 
15
15
  // Act
16
- await Events.emit('trigger');
17
- await Events.emit('trigger');
18
- await Events.emit('trigger');
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('trigger', () => storage.push('second'));
29
- Events.on('trigger', { priority: EventListenerPriorities.Low }, () => storage.push('third'));
30
- Events.on('trigger', { priority: EventListenerPriorities.High }, () => storage.push('first'));
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('trigger');
33
+ await Events.emit('application-mounted');
34
34
 
35
35
  // Assert
36
36
  expect(storage).toEqual(['first', 'second', 'third']);
@@ -10,7 +10,6 @@ export type AerogelGlobalEvents = Partial<{ [Event in EventWithoutPayload]: () =
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;
@@ -34,12 +33,12 @@ export class EventsService extends Service {
34
33
 
35
34
  protected override async boot(): Promise<void> {
36
35
  Object.entries(globalThis.__aerogelEvents__ ?? {}).forEach(([event, listener]) =>
37
- this.on(event as string, listener as EventListener));
36
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
37
+ this.on(event as any, listener as EventListener));
38
38
  }
39
39
 
40
40
  public emit<Event extends EventWithoutPayload>(event: Event): Promise<void>;
41
41
  public emit<Event extends EventWithPayload>(event: Event, payload: EventsPayload[Event]): Promise<void>;
42
- public emit<Event extends string>(event: UnknownEvent<Event>, payload?: unknown): Promise<void>;
43
42
  public async emit(event: string, payload?: unknown): Promise<void> {
44
43
  const listeners = this.listeners[event] ?? { priorities: [], handlers: {} };
45
44
 
@@ -55,9 +54,6 @@ export class EventsService extends Service {
55
54
  public on<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
56
55
  public on<Event extends EventWithPayload>(event: Event, priority: EventListenerPriority, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
57
56
  public on<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
58
- public on<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
59
- public on<Event extends string>(event: UnknownEvent<Event>, priority: EventListenerPriority, listener: EventListener): () => void; // prettier-ignore
60
- public on<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
61
57
  /* eslint-enable max-len */
62
58
 
63
59
  public on(
@@ -83,8 +79,6 @@ export class EventsService extends Service {
83
79
  public once<Event extends EventWithoutPayload>(event: Event, options: Partial<EventListenerOptions>, listener: () => unknown): () => void; // prettier-ignore
84
80
  public once<Event extends EventWithPayload>(event: Event, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
85
81
  public once<Event extends EventWithPayload>(event: Event, options: Partial<EventListenerOptions>, listener: EventListener<EventsPayload[Event]>): () => void | void; // prettier-ignore
86
- public once<Event extends string>(event: UnknownEvent<Event>, listener: EventListener): () => void;
87
- public once<Event extends string>(event: UnknownEvent<Event>, options: Partial<EventListenerOptions>, listener: EventListener): () => void; // prettier-ignore
88
82
  /* eslint-enable max-len */
89
83
 
90
84
  public once(