@aerogel/core 0.0.0-next.c4825c5cbe0fe3257e478c2a7ec8df27d5a72305 → 0.0.0-next.d197d66a9d339318d752a1d8a96b2919faba3003

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 (194) hide show
  1. package/dist/aerogel-core.d.ts +1873 -1949
  2. package/dist/aerogel-core.js +3268 -0
  3. package/dist/aerogel-core.js.map +1 -0
  4. package/package.json +31 -37
  5. package/src/bootstrap/bootstrap.test.ts +4 -7
  6. package/src/bootstrap/index.ts +14 -15
  7. package/src/bootstrap/options.ts +1 -1
  8. package/src/components/AppLayout.vue +14 -0
  9. package/src/components/{AGAppModals.vue → AppModals.vue} +3 -4
  10. package/src/components/AppOverlays.vue +9 -0
  11. package/src/components/AppToasts.vue +16 -0
  12. package/src/components/contracts/AlertModal.ts +8 -0
  13. package/src/components/contracts/Button.ts +16 -0
  14. package/src/components/contracts/ConfirmModal.ts +46 -0
  15. package/src/components/contracts/DropdownMenu.ts +20 -0
  16. package/src/components/contracts/ErrorReportModal.ts +32 -0
  17. package/src/components/contracts/Input.ts +26 -0
  18. package/src/components/contracts/LoadingModal.ts +26 -0
  19. package/src/components/contracts/Modal.ts +21 -0
  20. package/src/components/contracts/PromptModal.ts +34 -0
  21. package/src/components/contracts/Select.ts +45 -0
  22. package/src/components/contracts/Toast.ts +15 -0
  23. package/src/components/contracts/index.ts +11 -0
  24. package/src/components/headless/HeadlessButton.vue +51 -0
  25. package/src/components/headless/HeadlessInput.vue +59 -0
  26. package/src/components/headless/{forms/AGHeadlessInputDescription.vue → HeadlessInputDescription.vue} +7 -8
  27. package/src/components/headless/{forms/AGHeadlessInputError.vue → HeadlessInputError.vue} +4 -8
  28. package/src/components/headless/{forms/AGHeadlessInputInput.vue → HeadlessInputInput.vue} +16 -25
  29. package/src/components/headless/{forms/AGHeadlessInputLabel.vue → HeadlessInputLabel.vue} +3 -7
  30. package/src/components/headless/{forms/AGHeadlessInputTextArea.vue → HeadlessInputTextArea.vue} +10 -13
  31. package/src/components/headless/HeadlessModal.vue +57 -0
  32. package/src/components/headless/HeadlessModalContent.vue +30 -0
  33. package/src/components/headless/HeadlessModalDescription.vue +12 -0
  34. package/src/components/headless/HeadlessModalOverlay.vue +12 -0
  35. package/src/components/headless/HeadlessModalTitle.vue +12 -0
  36. package/src/components/headless/HeadlessSelect.vue +120 -0
  37. package/src/components/headless/{forms/AGHeadlessSelectError.vue → HeadlessSelectError.vue} +5 -6
  38. package/src/components/headless/HeadlessSelectLabel.vue +25 -0
  39. package/src/components/headless/HeadlessSelectOption.vue +34 -0
  40. package/src/components/headless/HeadlessSelectOptions.vue +42 -0
  41. package/src/components/headless/HeadlessSelectTrigger.vue +22 -0
  42. package/src/components/headless/HeadlessSelectValue.vue +18 -0
  43. package/src/components/headless/HeadlessToast.vue +18 -0
  44. package/src/components/headless/HeadlessToastAction.vue +13 -0
  45. package/src/components/headless/index.ts +19 -3
  46. package/src/components/index.ts +6 -11
  47. package/src/components/ui/AdvancedOptions.vue +18 -0
  48. package/src/components/ui/AlertModal.vue +14 -0
  49. package/src/components/ui/Button.vue +98 -0
  50. package/src/components/ui/Checkbox.vue +56 -0
  51. package/src/components/ui/ConfirmModal.vue +45 -0
  52. package/src/components/ui/DropdownMenu.vue +32 -0
  53. package/src/components/ui/DropdownMenuOption.vue +14 -0
  54. package/src/components/ui/DropdownMenuOptions.vue +27 -0
  55. package/src/components/ui/EditableContent.vue +82 -0
  56. package/src/components/ui/ErrorMessage.vue +15 -0
  57. package/src/components/ui/ErrorReportModal.vue +67 -0
  58. package/src/components/{modals/AGErrorReportModalButtons.vue → ui/ErrorReportModalButtons.vue} +34 -27
  59. package/src/components/ui/ErrorReportModalTitle.vue +24 -0
  60. package/src/components/{forms/AGForm.vue → ui/Form.vue} +4 -5
  61. package/src/components/ui/Input.vue +56 -0
  62. package/src/components/ui/Link.vue +12 -0
  63. package/src/components/ui/LoadingModal.vue +34 -0
  64. package/src/components/ui/Markdown.vue +69 -0
  65. package/src/components/ui/Modal.vue +122 -0
  66. package/src/components/{modals/AGModalContext.vue → ui/ModalContext.vue} +8 -9
  67. package/src/components/ui/ProgressBar.vue +51 -0
  68. package/src/components/ui/PromptModal.vue +38 -0
  69. package/src/components/ui/Select.vue +27 -0
  70. package/src/components/ui/SelectLabel.vue +17 -0
  71. package/src/components/ui/SelectOption.vue +29 -0
  72. package/src/components/ui/SelectOptions.vue +35 -0
  73. package/src/components/ui/SelectTrigger.vue +29 -0
  74. package/src/components/ui/SettingsModal.vue +15 -0
  75. package/src/components/{lib/AGStartupCrash.vue → ui/StartupCrash.vue} +8 -8
  76. package/src/components/ui/Toast.vue +44 -0
  77. package/src/components/ui/index.ts +30 -0
  78. package/src/directives/index.ts +9 -5
  79. package/src/directives/measure.ts +1 -1
  80. package/src/errors/Errors.state.ts +1 -1
  81. package/src/errors/Errors.ts +14 -23
  82. package/src/errors/index.ts +9 -6
  83. package/src/errors/utils.ts +1 -1
  84. package/src/forms/{Form.test.ts → FormController.test.ts} +32 -8
  85. package/src/forms/{Form.ts → FormController.ts} +42 -38
  86. package/src/forms/index.ts +2 -3
  87. package/src/forms/utils.ts +35 -35
  88. package/src/index.css +72 -0
  89. package/src/jobs/Job.ts +2 -2
  90. package/src/jobs/listeners.ts +1 -1
  91. package/src/lang/DefaultLangProvider.ts +7 -4
  92. package/src/lang/Lang.state.ts +1 -1
  93. package/src/lang/Lang.ts +1 -1
  94. package/src/lang/index.ts +12 -6
  95. package/src/lang/settings/Language.vue +48 -0
  96. package/src/lang/settings/index.ts +10 -0
  97. package/src/plugins/Plugin.ts +1 -1
  98. package/src/plugins/index.ts +10 -7
  99. package/src/services/App.state.ts +15 -4
  100. package/src/services/App.ts +12 -4
  101. package/src/services/Cache.ts +1 -1
  102. package/src/services/Events.test.ts +8 -8
  103. package/src/services/Events.ts +4 -10
  104. package/src/services/Service.ts +21 -21
  105. package/src/services/Storage.ts +3 -3
  106. package/src/services/index.ts +8 -4
  107. package/src/services/utils.ts +2 -2
  108. package/src/testing/index.ts +4 -3
  109. package/src/testing/setup.ts +3 -19
  110. package/src/ui/UI.state.ts +8 -13
  111. package/src/ui/UI.ts +124 -111
  112. package/src/ui/index.ts +27 -28
  113. package/src/utils/classes.ts +49 -0
  114. package/src/utils/composition/events.ts +4 -6
  115. package/src/utils/composition/forms.ts +20 -4
  116. package/src/utils/composition/state.ts +11 -2
  117. package/src/utils/index.ts +4 -1
  118. package/src/utils/markdown.ts +3 -5
  119. package/src/utils/types.ts +3 -0
  120. package/src/utils/vue.ts +25 -136
  121. package/dist/aerogel-core.cjs.js +0 -2
  122. package/dist/aerogel-core.cjs.js.map +0 -1
  123. package/dist/aerogel-core.esm.js +0 -2
  124. package/dist/aerogel-core.esm.js.map +0 -1
  125. package/histoire.config.ts +0 -7
  126. package/noeldemartin.config.js +0 -5
  127. package/postcss.config.js +0 -6
  128. package/src/assets/histoire.css +0 -3
  129. package/src/components/AGAppLayout.vue +0 -16
  130. package/src/components/AGAppOverlays.vue +0 -41
  131. package/src/components/AGAppSnackbars.vue +0 -13
  132. package/src/components/composition.ts +0 -23
  133. package/src/components/constants.ts +0 -8
  134. package/src/components/forms/AGButton.vue +0 -44
  135. package/src/components/forms/AGCheckbox.vue +0 -41
  136. package/src/components/forms/AGInput.vue +0 -40
  137. package/src/components/forms/AGSelect.story.vue +0 -46
  138. package/src/components/forms/AGSelect.vue +0 -60
  139. package/src/components/forms/index.ts +0 -5
  140. package/src/components/headless/forms/AGHeadlessButton.ts +0 -3
  141. package/src/components/headless/forms/AGHeadlessButton.vue +0 -62
  142. package/src/components/headless/forms/AGHeadlessInput.ts +0 -34
  143. package/src/components/headless/forms/AGHeadlessInput.vue +0 -70
  144. package/src/components/headless/forms/AGHeadlessSelect.ts +0 -42
  145. package/src/components/headless/forms/AGHeadlessSelect.vue +0 -77
  146. package/src/components/headless/forms/AGHeadlessSelectButton.vue +0 -24
  147. package/src/components/headless/forms/AGHeadlessSelectLabel.vue +0 -24
  148. package/src/components/headless/forms/AGHeadlessSelectOption.ts +0 -4
  149. package/src/components/headless/forms/AGHeadlessSelectOption.vue +0 -39
  150. package/src/components/headless/forms/AGHeadlessSelectOptions.ts +0 -3
  151. package/src/components/headless/forms/composition.ts +0 -10
  152. package/src/components/headless/forms/index.ts +0 -18
  153. package/src/components/headless/modals/AGHeadlessModal.ts +0 -36
  154. package/src/components/headless/modals/AGHeadlessModal.vue +0 -92
  155. package/src/components/headless/modals/AGHeadlessModalPanel.vue +0 -32
  156. package/src/components/headless/modals/AGHeadlessModalTitle.vue +0 -23
  157. package/src/components/headless/modals/index.ts +0 -4
  158. package/src/components/headless/snackbars/AGHeadlessSnackbar.vue +0 -10
  159. package/src/components/headless/snackbars/index.ts +0 -40
  160. package/src/components/interfaces.ts +0 -24
  161. package/src/components/lib/AGErrorMessage.vue +0 -16
  162. package/src/components/lib/AGLink.vue +0 -9
  163. package/src/components/lib/AGMarkdown.vue +0 -54
  164. package/src/components/lib/AGMeasured.vue +0 -16
  165. package/src/components/lib/AGProgressBar.vue +0 -30
  166. package/src/components/lib/index.ts +0 -6
  167. package/src/components/modals/AGAlertModal.ts +0 -18
  168. package/src/components/modals/AGAlertModal.vue +0 -14
  169. package/src/components/modals/AGConfirmModal.ts +0 -42
  170. package/src/components/modals/AGConfirmModal.vue +0 -26
  171. package/src/components/modals/AGErrorReportModal.ts +0 -49
  172. package/src/components/modals/AGErrorReportModal.vue +0 -54
  173. package/src/components/modals/AGErrorReportModalTitle.vue +0 -25
  174. package/src/components/modals/AGLoadingModal.ts +0 -29
  175. package/src/components/modals/AGLoadingModal.vue +0 -15
  176. package/src/components/modals/AGModal.ts +0 -11
  177. package/src/components/modals/AGModal.vue +0 -39
  178. package/src/components/modals/AGModalContext.ts +0 -8
  179. package/src/components/modals/AGModalTitle.vue +0 -9
  180. package/src/components/modals/AGPromptModal.ts +0 -41
  181. package/src/components/modals/AGPromptModal.vue +0 -34
  182. package/src/components/modals/index.ts +0 -17
  183. package/src/components/snackbars/AGSnackbar.vue +0 -36
  184. package/src/components/snackbars/index.ts +0 -3
  185. package/src/components/utils.ts +0 -10
  186. package/src/directives/initial-focus.ts +0 -11
  187. package/src/forms/composition.ts +0 -6
  188. package/src/main.histoire.ts +0 -1
  189. package/src/utils/tailwindcss.test.ts +0 -26
  190. package/src/utils/tailwindcss.ts +0 -7
  191. package/tailwind.config.js +0 -4
  192. package/tsconfig.json +0 -11
  193. package/vite.config.ts +0 -17
  194. /package/src/{main.ts → index.ts} +0 -0
@@ -0,0 +1,44 @@
1
+ <template>
2
+ <HeadlessToast :class="renderedClasses">
3
+ <Markdown v-if="message" :text="message" inline />
4
+
5
+ <Button
6
+ v-for="(action, key) of actions"
7
+ :key
8
+ :action
9
+ :variant
10
+ :as="HeadlessToastAction"
11
+ />
12
+ </HeadlessToast>
13
+ </template>
14
+
15
+ <script setup lang="ts">
16
+ import type { HTMLAttributes } from 'vue';
17
+
18
+ import Button from '@aerogel/core/components/ui/Button.vue';
19
+ import Markdown from '@aerogel/core/components/ui/Markdown.vue';
20
+ import HeadlessToast from '@aerogel/core/components/headless/HeadlessToast.vue';
21
+ import HeadlessToastAction from '@aerogel/core/components/headless/HeadlessToastAction.vue';
22
+ import { computedVariantClasses } from '@aerogel/core/utils/classes';
23
+ import type { ToastExpose, ToastProps } from '@aerogel/core/components/contracts/Toast';
24
+ import type { Variants } from '@aerogel/core/utils/classes';
25
+
26
+ const { class: baseClasses, variant = 'secondary' } = defineProps<ToastProps & { class?: HTMLAttributes['class'] }>();
27
+ const renderedClasses = computedVariantClasses<Variants<Pick<ToastProps, 'variant'>>>(
28
+ { baseClasses, variant },
29
+ {
30
+ baseClasses: 'flex items-center gap-2 rounded-md p-2 ring-1 shadow-lg border-gray-200',
31
+ variants: {
32
+ variant: {
33
+ secondary: 'bg-gray-900 text-white ring-black',
34
+ danger: 'bg-red-50 text-red-900 ring-red-100',
35
+ },
36
+ },
37
+ defaultVariants: {
38
+ variant: 'secondary',
39
+ },
40
+ },
41
+ );
42
+
43
+ defineExpose<ToastExpose>();
44
+ </script>
@@ -0,0 +1,30 @@
1
+ export { default as AdvancedOptions } from './AdvancedOptions.vue';
2
+ export { default as AlertModal } from './AlertModal.vue';
3
+ export { default as Button } from './Button.vue';
4
+ export { default as Checkbox } from './Checkbox.vue';
5
+ export { default as ConfirmModal } from './ConfirmModal.vue';
6
+ export { default as DropdownMenu } from './DropdownMenu.vue';
7
+ export { default as DropdownMenuOption } from './DropdownMenuOption.vue';
8
+ export { default as DropdownMenuOptions } from './DropdownMenuOptions.vue';
9
+ export { default as EditableContent } from './EditableContent.vue';
10
+ export { default as ErrorMessage } from './ErrorMessage.vue';
11
+ export { default as ErrorReportModal } from './ErrorReportModal.vue';
12
+ export { default as ErrorReportModalButtons } from './ErrorReportModalButtons.vue';
13
+ export { default as ErrorReportModalTitle } from './ErrorReportModalTitle.vue';
14
+ export { default as Form } from './Form.vue';
15
+ export { default as Input } from './Input.vue';
16
+ export { default as Link } from './Link.vue';
17
+ export { default as LoadingModal } from './LoadingModal.vue';
18
+ export { default as Markdown } from './Markdown.vue';
19
+ export { default as Modal } from './Modal.vue';
20
+ export { default as ModalContext } from './ModalContext.vue';
21
+ export { default as ProgressBar } from './ProgressBar.vue';
22
+ export { default as PromptModal } from './PromptModal.vue';
23
+ export { default as Select } from './Select.vue';
24
+ export { default as SelectLabel } from './SelectLabel.vue';
25
+ export { default as SelectOption } from './SelectOption.vue';
26
+ export { default as SelectOptions } from './SelectOptions.vue';
27
+ export { default as SelectTrigger } from './SelectTrigger.vue';
28
+ export { default as SettingsModal } from './SettingsModal.vue';
29
+ export { default as StartupCrash } from './StartupCrash.vue';
30
+ export { default as Toast } from './Toast.vue';
@@ -1,13 +1,11 @@
1
1
  import type { Directive } from 'vue';
2
2
 
3
- import { definePlugin } from '@/plugins';
3
+ import { definePlugin } from '@aerogel/core/plugins';
4
4
 
5
- import initialFocus from './initial-focus';
6
5
  import measure from './measure';
7
6
 
8
7
  const builtInDirectives: Record<string, Directive> = {
9
- 'initial-focus': initialFocus,
10
- 'measure': measure,
8
+ measure: measure,
11
9
  };
12
10
 
13
11
  export * from './measure';
@@ -25,8 +23,14 @@ export default definePlugin({
25
23
  },
26
24
  });
27
25
 
28
- declare module '@/bootstrap/options' {
26
+ declare module '@aerogel/core/bootstrap/options' {
29
27
  export interface AerogelOptions {
30
28
  directives?: Record<string, Directive>;
31
29
  }
32
30
  }
31
+
32
+ declare module 'vue' {
33
+ interface ComponentCustomDirectives {
34
+ measure: Directive<string, string>;
35
+ }
36
+ }
@@ -1,4 +1,4 @@
1
- import { defineDirective } from '@/utils/vue';
1
+ import { defineDirective } from '@aerogel/core/utils/vue';
2
2
  import { tap } from '@noeldemartin/utils';
3
3
 
4
4
  const resizeObservers: WeakMap<HTMLElement, ResizeObserver> = new WeakMap();
@@ -1,6 +1,6 @@
1
1
  import type { JSError } from '@noeldemartin/utils';
2
2
 
3
- import { defineServiceState } from '@/services';
3
+ import { defineServiceState } from '@aerogel/core/services';
4
4
 
5
5
  export type ErrorSource = string | Error | JSError | unknown;
6
6
 
@@ -1,16 +1,13 @@
1
- import { JSError, facade, isObject, objectWithoutEmpty, toString } from '@noeldemartin/utils';
1
+ import { JSError, facade, isDevelopment, isObject, isTesting, objectWithoutEmpty, toString } from '@noeldemartin/utils';
2
2
 
3
- import App from '@/services/App';
4
- import ServiceBootError from '@/errors/ServiceBootError';
5
- import UI, { UIComponents } from '@/ui/UI';
6
- import { translateWithDefault } from '@/lang/utils';
3
+ import App from '@aerogel/core/services/App';
4
+ import ServiceBootError from '@aerogel/core/errors/ServiceBootError';
5
+ import UI from '@aerogel/core/ui/UI';
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 '@/components/constants';
10
- import { Events } from '@/services';
11
- import type { AGErrorReportModalProps } from '@/components/modals/AGErrorReportModal';
12
10
  import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
13
- import type { ModalComponent } from '@/ui/UI.state';
14
11
 
15
12
  export class ErrorsService extends Service {
16
13
 
@@ -34,19 +31,17 @@ 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.modal(UI.requireComponent('error-report-modal'), { reports });
40
35
  }
41
36
 
42
37
  public async report(error: ErrorSource, message?: string): Promise<void> {
43
38
  await Events.emit('error', { error, message });
44
39
 
45
- if (App.testing) {
40
+ if (isTesting('unit')) {
46
41
  throw error;
47
42
  }
48
43
 
49
- if (App.development) {
44
+ if (isDevelopment()) {
50
45
  this.logError(error);
51
46
  }
52
47
 
@@ -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.modal(UI.requireComponent('error-report-modal'), { reports: [report] }),
88
79
  },
89
80
  ],
90
81
  },
@@ -178,7 +169,7 @@ export class ErrorsService extends Service {
178
169
 
179
170
  export default facade(ErrorsService);
180
171
 
181
- declare module '@/services/Events' {
172
+ declare module '@aerogel/core/services/Events' {
182
173
  export interface EventsPayload {
183
174
  error: { error: ErrorSource; message?: string };
184
175
  }
@@ -1,13 +1,16 @@
1
1
  import type { App } from 'vue';
2
2
 
3
- import { bootServices } from '@/services';
4
- import { definePlugin } from '@/plugins';
3
+ import { bootServices } from '@aerogel/core/services';
4
+ import { definePlugin } from '@aerogel/core/plugins';
5
5
 
6
6
  import Errors from './Errors';
7
- import { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
7
+ import type { ErrorReport, ErrorReportLog, ErrorSource } from './Errors.state';
8
8
 
9
9
  export * from './utils';
10
- export { Errors, ErrorSource, ErrorReport, ErrorReportLog };
10
+ export { Errors };
11
+ export { default as JobCancelledError } from './JobCancelledError';
12
+ export { default as ServiceBootError } from './ServiceBootError';
13
+ export type { ErrorSource, ErrorReport, ErrorReportLog };
11
14
 
12
15
  const services = { $errors: Errors };
13
16
  const frameworkHandler: ErrorHandler = (error) => {
@@ -35,12 +38,12 @@ export default definePlugin({
35
38
  },
36
39
  });
37
40
 
38
- declare module '@/bootstrap/options' {
41
+ declare module '@aerogel/core/bootstrap/options' {
39
42
  export interface AerogelOptions {
40
43
  handleError?(error: ErrorSource): boolean;
41
44
  }
42
45
  }
43
46
 
44
- declare module '@/services' {
47
+ declare module '@aerogel/core/services' {
45
48
  export interface Services extends ErrorsServices {}
46
49
  }
@@ -1,5 +1,5 @@
1
1
  import { JSError, isObject, toString } from '@noeldemartin/utils';
2
- import { translateWithDefault } from '@/lang/utils';
2
+ import { translateWithDefault } from '@aerogel/core/lang/utils';
3
3
  import type { ErrorSource } from './Errors.state';
4
4
 
5
5
  const handlers: ErrorHandler[] = [];
@@ -1,10 +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 './composition';
4
- import { FormFieldTypes } from '@/main';
5
- import { numberInput, requiredStringInput } from '@/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';
6
14
 
7
- describe('Form', () => {
15
+ describe('FormController', () => {
8
16
 
9
17
  it('defines magic fields', () => {
10
18
  const form = useForm({
@@ -20,7 +28,7 @@ describe('Form', () => {
20
28
  // Arrange
21
29
  const form = useForm({
22
30
  name: {
23
- type: FormFieldTypes.String,
31
+ type: 'string',
24
32
  rules: 'required',
25
33
  },
26
34
  });
@@ -38,7 +46,7 @@ describe('Form', () => {
38
46
  // Arrange
39
47
  const form = useForm({
40
48
  name: {
41
- type: FormFieldTypes.String,
49
+ type: 'string',
42
50
  rules: 'required',
43
51
  },
44
52
  });
@@ -59,11 +67,11 @@ describe('Form', () => {
59
67
  // Arrange
60
68
  const form = useForm({
61
69
  trimmed: {
62
- type: FormFieldTypes.String,
70
+ type: 'string',
63
71
  rules: 'required',
64
72
  },
65
73
  untrimmed: {
66
- type: FormFieldTypes.String,
74
+ type: 'string',
67
75
  rules: 'required',
68
76
  trim: false,
69
77
  },
@@ -83,4 +91,20 @@ describe('Form', () => {
83
91
  expect(form.errors).toEqual({ trimmed: ['required'], untrimmed: null });
84
92
  });
85
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
+
86
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
41
- ? number
42
- : TType extends typeof FormFieldTypes.Boolean
43
- ? boolean
44
- : TType extends typeof FormFieldTypes.Object
45
- ? object
46
- : TType extends typeof FormFieldTypes.Date
47
- ? Date
48
- : never;
49
-
50
- const validForms: WeakMap<Form, ComputedRef<boolean>> = new WeakMap();
39
+ : TType extends 'number'
40
+ ? number
41
+ : TType extends 'boolean'
42
+ ? boolean
43
+ : TType extends 'object'
44
+ ? TObjectType extends object
45
+ ? TObjectType
46
+ : object
47
+ : TType extends 'date'
48
+ ? Date
49
+ : never;
50
+
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
 
@@ -113,11 +114,14 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
113
114
  }
114
115
 
115
116
  public validate(): boolean {
116
- const errors = Object.entries(this._fields).reduce((formErrors, [name, definition]) => {
117
- formErrors[name] = this.getFieldErrors(name, definition);
117
+ const errors = Object.entries(this._fields).reduce(
118
+ (formErrors, [name, definition]) => {
119
+ formErrors[name] = this.getFieldErrors(name, definition);
118
120
 
119
- return formErrors;
120
- }, {} as Record<string, string[] | null>);
121
+ return formErrors;
122
+ },
123
+ {} as Record<string, string[] | null>,
124
+ );
121
125
 
122
126
  this.resetErrors(errors);
123
127
 
@@ -165,7 +169,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
165
169
  this._listeners['focus']?.forEach((listener) => listener(input));
166
170
  }
167
171
 
168
- protected __get(property: string): unknown {
172
+ protected override __get(property: string): unknown {
169
173
  if (!(property in this._fields)) {
170
174
  return super.__get(property);
171
175
  }
@@ -173,7 +177,7 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
173
177
  return this.getFieldValue(property);
174
178
  }
175
179
 
176
- protected __set(property: string, value: unknown): void {
180
+ protected override __set(property: string, value: unknown): void {
177
181
  if (!(property in this._fields)) {
178
182
  super.__set(property, value);
179
183
 
@@ -204,10 +208,10 @@ export default class Form<Fields extends FormFieldDefinitions = FormFieldDefinit
204
208
  return {} as FormData<Fields>;
205
209
  }
206
210
 
207
- const data = Object.entries(fields).reduce((formData, [name, definition]) => {
208
- 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];
209
213
 
210
- return formData;
214
+ return initialData;
211
215
  }, {} as FormData<Fields>);
212
216
 
213
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
+ }