@punica/form 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/dist/controller/index.d.ts +84 -20
  2. package/dist/controller/index.js +217 -129
  3. package/dist/decorator/Readers.d.ts +9 -0
  4. package/dist/decorator/Readers.js +15 -0
  5. package/dist/decorator/Services.d.ts +9 -0
  6. package/dist/decorator/Services.js +15 -0
  7. package/dist/decorator/Starters.d.ts +9 -0
  8. package/dist/decorator/Starters.js +15 -0
  9. package/dist/decorator/index.d.ts +3 -0
  10. package/dist/{model/decorator → decorator}/index.js +3 -8
  11. package/dist/define/FormItem.d.ts +9 -0
  12. package/dist/{model/formItem/define/index.js → define/FormItem.js} +10 -4
  13. package/dist/define/FormItemProperty.d.ts +8 -0
  14. package/dist/define/FormItemProperty.js +21 -0
  15. package/dist/define/FormProperty.d.ts +7 -0
  16. package/dist/define/FormProperty.js +15 -0
  17. package/dist/define/index.d.ts +3 -0
  18. package/dist/define/index.js +12 -0
  19. package/dist/index.d.ts +5 -1
  20. package/dist/index.js +5 -2
  21. package/dist/model/command/index.d.ts +2 -0
  22. package/dist/model/{formItem/base → command}/index.js +2 -8
  23. package/dist/model/command/item.d.ts +7 -0
  24. package/dist/model/{form/IForm.js → command/item.js} +0 -1
  25. package/dist/model/command/service.d.ts +15 -0
  26. package/dist/model/{action/index.js → command/service.js} +0 -1
  27. package/dist/model/constants/index.d.ts +4 -7
  28. package/dist/model/constants/index.js +0 -10
  29. package/dist/model/form/index.d.ts +11 -2
  30. package/dist/model/form/index.js +0 -17
  31. package/dist/model/index.d.ts +6 -7
  32. package/dist/model/index.js +6 -8
  33. package/dist/model/item/index.d.ts +25 -0
  34. package/dist/model/{chapter → item}/index.js +0 -1
  35. package/dist/model/reader/index.d.ts +3 -4
  36. package/dist/model/reader/index.js +0 -1
  37. package/dist/model/service/index.d.ts +20 -0
  38. package/dist/model/{controller → service}/index.js +0 -1
  39. package/dist/model/starter/index.d.ts +13 -0
  40. package/dist/model/{initializer → starter}/index.js +0 -1
  41. package/dist/model/util/GetItem.d.ts +9 -0
  42. package/dist/model/util/GetItem.js +2 -0
  43. package/dist/model/util/WriteItems.d.ts +8 -0
  44. package/dist/model/util/WriteItems.js +2 -0
  45. package/dist/model/util/index.d.ts +2 -0
  46. package/dist/model/{formItem → util}/index.js +0 -13
  47. package/dist/reader/decorators/base/index.d.ts +37 -0
  48. package/dist/reader/decorators/base/index.js +75 -0
  49. package/dist/reader/decorators/readers/FormItemsReader.d.ts +17 -0
  50. package/dist/reader/decorators/readers/FormItemsReader.js +55 -0
  51. package/dist/reader/decorators/readers/ItemDataReader.d.ts +24 -0
  52. package/dist/reader/decorators/readers/ItemDataReader.js +42 -0
  53. package/dist/reader/decorators/readers/ItemInitializerReader.d.ts +16 -0
  54. package/dist/reader/decorators/readers/ItemInitializerReader.js +34 -0
  55. package/dist/reader/decorators/readers/index.d.ts +3 -0
  56. package/dist/reader/decorators/readers/index.js +12 -0
  57. package/dist/reader/index.d.ts +19 -0
  58. package/dist/reader/index.js +30 -0
  59. package/dist/reader/reader/Reader.d.ts +18 -0
  60. package/dist/reader/reader/Reader.js +30 -0
  61. package/dist/reader/reader/index.d.ts +1 -0
  62. package/dist/reader/reader/index.js +8 -0
  63. package/dist/register/index.d.ts +40 -8
  64. package/dist/register/index.js +50 -10
  65. package/dist/utils/index.d.ts +18 -0
  66. package/dist/utils/index.js +82 -0
  67. package/package.json +2 -3
  68. package/dist/controller/index.js.map +0 -1
  69. package/dist/index.js.map +0 -1
  70. package/dist/model/action/index.d.ts +0 -8
  71. package/dist/model/action/index.js.map +0 -1
  72. package/dist/model/chapter/index.d.ts +0 -9
  73. package/dist/model/chapter/index.js.map +0 -1
  74. package/dist/model/constants/index.js.map +0 -1
  75. package/dist/model/controller/index.d.ts +0 -14
  76. package/dist/model/controller/index.js.map +0 -1
  77. package/dist/model/decorator/Actions.d.ts +0 -3
  78. package/dist/model/decorator/Actions.js +0 -12
  79. package/dist/model/decorator/Actions.js.map +0 -1
  80. package/dist/model/decorator/Chapter.d.ts +0 -4
  81. package/dist/model/decorator/Chapter.js +0 -16
  82. package/dist/model/decorator/Chapter.js.map +0 -1
  83. package/dist/model/decorator/Description.d.ts +0 -3
  84. package/dist/model/decorator/Description.js +0 -12
  85. package/dist/model/decorator/Description.js.map +0 -1
  86. package/dist/model/decorator/Initializer.d.ts +0 -4
  87. package/dist/model/decorator/Initializer.js +0 -12
  88. package/dist/model/decorator/Initializer.js.map +0 -1
  89. package/dist/model/decorator/Name.d.ts +0 -3
  90. package/dist/model/decorator/Name.js +0 -12
  91. package/dist/model/decorator/Name.js.map +0 -1
  92. package/dist/model/decorator/Store.d.ts +0 -3
  93. package/dist/model/decorator/Store.js +0 -12
  94. package/dist/model/decorator/Store.js.map +0 -1
  95. package/dist/model/decorator/Title.d.ts +0 -3
  96. package/dist/model/decorator/Title.js +0 -12
  97. package/dist/model/decorator/Title.js.map +0 -1
  98. package/dist/model/decorator/index.d.ts +0 -7
  99. package/dist/model/decorator/index.js.map +0 -1
  100. package/dist/model/form/IForm.d.ts +0 -12
  101. package/dist/model/form/IForm.js.map +0 -1
  102. package/dist/model/form/IItemMap.d.ts +0 -3
  103. package/dist/model/form/IItemMap.js +0 -3
  104. package/dist/model/form/IItemMap.js.map +0 -1
  105. package/dist/model/form/index.js.map +0 -1
  106. package/dist/model/formItem/FormItemControl.d.ts +0 -13
  107. package/dist/model/formItem/FormItemControl.js +0 -3
  108. package/dist/model/formItem/FormItemControl.js.map +0 -1
  109. package/dist/model/formItem/FormItemConverter.d.ts +0 -5
  110. package/dist/model/formItem/FormItemConverter.js +0 -3
  111. package/dist/model/formItem/FormItemConverter.js.map +0 -1
  112. package/dist/model/formItem/FormItemError.d.ts +0 -17
  113. package/dist/model/formItem/FormItemError.js +0 -3
  114. package/dist/model/formItem/FormItemError.js.map +0 -1
  115. package/dist/model/formItem/FormItemGetData.d.ts +0 -3
  116. package/dist/model/formItem/FormItemGetData.js +0 -3
  117. package/dist/model/formItem/FormItemGetData.js.map +0 -1
  118. package/dist/model/formItem/FormItemInitializer.d.ts +0 -13
  119. package/dist/model/formItem/FormItemInitializer.js +0 -3
  120. package/dist/model/formItem/FormItemInitializer.js.map +0 -1
  121. package/dist/model/formItem/FormItemLayout.d.ts +0 -9
  122. package/dist/model/formItem/FormItemLayout.js +0 -3
  123. package/dist/model/formItem/FormItemLayout.js.map +0 -1
  124. package/dist/model/formItem/FormItemSubmit.d.ts +0 -13
  125. package/dist/model/formItem/FormItemSubmit.js +0 -3
  126. package/dist/model/formItem/FormItemSubmit.js.map +0 -1
  127. package/dist/model/formItem/GetItem.d.ts +0 -2
  128. package/dist/model/formItem/GetItem.js +0 -3
  129. package/dist/model/formItem/GetItem.js.map +0 -1
  130. package/dist/model/formItem/IFormItem.d.ts +0 -16
  131. package/dist/model/formItem/IFormItem.js +0 -3
  132. package/dist/model/formItem/IFormItem.js.map +0 -1
  133. package/dist/model/formItem/IFormItemOptions.d.ts +0 -6
  134. package/dist/model/formItem/IFormItemOptions.js +0 -3
  135. package/dist/model/formItem/IFormItemOptions.js.map +0 -1
  136. package/dist/model/formItem/WriteItems.d.ts +0 -2
  137. package/dist/model/formItem/WriteItems.js +0 -3
  138. package/dist/model/formItem/WriteItems.js.map +0 -1
  139. package/dist/model/formItem/base/GetStoreItem.d.ts +0 -1
  140. package/dist/model/formItem/base/GetStoreItem.js +0 -3
  141. package/dist/model/formItem/base/GetStoreItem.js.map +0 -1
  142. package/dist/model/formItem/base/IBaseFormItem.d.ts +0 -18
  143. package/dist/model/formItem/base/IBaseFormItem.js +0 -3
  144. package/dist/model/formItem/base/IBaseFormItem.js.map +0 -1
  145. package/dist/model/formItem/base/Renderer.d.ts +0 -2
  146. package/dist/model/formItem/base/Renderer.js +0 -3
  147. package/dist/model/formItem/base/Renderer.js.map +0 -1
  148. package/dist/model/formItem/base/SetStoreItem.d.ts +0 -1
  149. package/dist/model/formItem/base/SetStoreItem.js +0 -3
  150. package/dist/model/formItem/base/SetStoreItem.js.map +0 -1
  151. package/dist/model/formItem/base/UpdatePropertyValue.d.ts +0 -1
  152. package/dist/model/formItem/base/UpdatePropertyValue.js +0 -3
  153. package/dist/model/formItem/base/UpdatePropertyValue.js.map +0 -1
  154. package/dist/model/formItem/base/UpdateValue.d.ts +0 -1
  155. package/dist/model/formItem/base/UpdateValue.js +0 -3
  156. package/dist/model/formItem/base/UpdateValue.js.map +0 -1
  157. package/dist/model/formItem/base/index.d.ts +0 -7
  158. package/dist/model/formItem/base/index.js.map +0 -1
  159. package/dist/model/formItem/define/index.d.ts +0 -2
  160. package/dist/model/formItem/define/index.js.map +0 -1
  161. package/dist/model/formItem/index.d.ts +0 -14
  162. package/dist/model/formItem/index.js.map +0 -1
  163. package/dist/model/index.js.map +0 -1
  164. package/dist/model/initializer/index.d.ts +0 -3
  165. package/dist/model/initializer/index.js.map +0 -1
  166. package/dist/model/reader/index.js.map +0 -1
  167. package/dist/register/index.js.map +0 -1
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Defines a form property with the specified type.
3
+ * @param {string} type - Type of the form property.
4
+ * @returns {ClassDecorator<T>} - Decorator function.
5
+ */
6
+ declare const defineFormProperty: <T>(type: string) => (data: T) => ClassDecorator;
7
+ export default defineFormProperty;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ /**
4
+ * Defines a form property with the specified type.
5
+ * @param {string} type - Type of the form property.
6
+ * @returns {ClassDecorator<T>} - Decorator function.
7
+ */
8
+ const defineFormProperty = (type) => {
9
+ return (data) => {
10
+ return (target) => {
11
+ Reflect.defineMetadata(type, data, target.prototype);
12
+ };
13
+ };
14
+ };
15
+ exports.default = defineFormProperty;
@@ -0,0 +1,3 @@
1
+ export { default as defineFormItem } from './FormItem';
2
+ export { default as defineFormItemProperty } from './FormItemProperty';
3
+ export { default as defineFormProperty } from './FormProperty';
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.defineFormProperty = exports.defineFormItemProperty = exports.defineFormItem = void 0;
7
+ var FormItem_1 = require("./FormItem");
8
+ Object.defineProperty(exports, "defineFormItem", { enumerable: true, get: function () { return __importDefault(FormItem_1).default; } });
9
+ var FormItemProperty_1 = require("./FormItemProperty");
10
+ Object.defineProperty(exports, "defineFormItemProperty", { enumerable: true, get: function () { return __importDefault(FormItemProperty_1).default; } });
11
+ var FormProperty_1 = require("./FormProperty");
12
+ Object.defineProperty(exports, "defineFormProperty", { enumerable: true, get: function () { return __importDefault(FormProperty_1).default; } });
package/dist/index.d.ts CHANGED
@@ -1,3 +1,7 @@
1
- export * from './controller';
2
1
  export * from './model';
2
+ export * from './define';
3
+ export * from './decorator';
3
4
  export * from './register';
5
+ export * from './reader';
6
+ export * from './controller';
7
+ export * from './utils';
package/dist/index.js CHANGED
@@ -14,7 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./controller"), exports);
18
17
  __exportStar(require("./model"), exports);
18
+ __exportStar(require("./define"), exports);
19
+ __exportStar(require("./decorator"), exports);
19
20
  __exportStar(require("./register"), exports);
20
- //# sourceMappingURL=index.js.map
21
+ __exportStar(require("./reader"), exports);
22
+ __exportStar(require("./controller"), exports);
23
+ __exportStar(require("./utils"), exports);
@@ -0,0 +1,2 @@
1
+ export * from './item';
2
+ export * from './service';
@@ -14,11 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./Renderer"), exports);
18
- __exportStar(require("./UpdatePropertyValue"), exports);
19
- __exportStar(require("./UpdateValue"), exports);
20
- __exportStar(require("./GetStoreItem"), exports);
21
- __exportStar(require("./SetStoreItem"), exports);
22
- __exportStar(require("./UpdateValue"), exports);
23
- __exportStar(require("./IBaseFormItem"), exports);
24
- //# sourceMappingURL=index.js.map
17
+ __exportStar(require("./item"), exports);
18
+ __exportStar(require("./service"), exports);
@@ -0,0 +1,7 @@
1
+ import { FormItem } from '..';
2
+ export interface CommandItem<E, F extends FormItem<E>> {
3
+ formItem: F;
4
+ initialEntity?: E;
5
+ getItem?: (property: keyof E) => F;
6
+ [key: string]: any;
7
+ }
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IForm.js.map
@@ -0,0 +1,15 @@
1
+ import { Form, FormEvents, FormItem } from '..';
2
+ import { CommandItem } from '.';
3
+ /**
4
+ * Defines the structure of the CommandService.
5
+ */
6
+ export type CommandService<E, F extends FormItem<E>> = {
7
+ initialForm: Form<E, F>;
8
+ initialEntity: E;
9
+ form: Form<E, F>;
10
+ itemsMap: Record<keyof E, number>;
11
+ createCommandItem: (item: F) => Promise<CommandItem<E, F>>;
12
+ fireEvent: (eventType: FormEvents, data: any) => void;
13
+ getItem: (property: keyof E) => F;
14
+ writeItems: (items: Array<FormItem<E>>) => Promise<void>;
15
+ };
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=index.js.map
@@ -1,7 +1,4 @@
1
- export declare enum FormEvents {
2
- UPDATE = "UPDATE",
3
- RESET = "RESET",
4
- REGISTER_ITEMS = "REGISTER_ITEMS",
5
- UPDATE_ITEM = "UPDATE_ITEM",
6
- UPDATE_PROPERTY_VALUE = "UPDATE_PROPERTY_VALUE"
7
- }
1
+ /**
2
+ * Type representing various events that can occur in a form.
3
+ */
4
+ export type FormEvents = 'UPDATE_FORM' | 'RESET' | 'REGISTER_ITEMS' | 'UPDATE_ITEM';
@@ -1,12 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FormEvents = void 0;
4
- var FormEvents;
5
- (function (FormEvents) {
6
- FormEvents["UPDATE"] = "UPDATE";
7
- FormEvents["RESET"] = "RESET";
8
- FormEvents["REGISTER_ITEMS"] = "REGISTER_ITEMS";
9
- FormEvents["UPDATE_ITEM"] = "UPDATE_ITEM";
10
- FormEvents["UPDATE_PROPERTY_VALUE"] = "UPDATE_PROPERTY_VALUE";
11
- })(FormEvents = exports.FormEvents || (exports.FormEvents = {}));
12
- //# sourceMappingURL=index.js.map
@@ -1,2 +1,11 @@
1
- export * from './IItemMap';
2
- export * from './IForm';
1
+ import { FormItem, IReader, IService, IStarter } from '../..';
2
+ export type Form<E, F extends FormItem<E> = any> = {
3
+ itemsMap: {
4
+ [key in keyof E]: number;
5
+ };
6
+ items: Array<F>;
7
+ services?: Array<IService>;
8
+ readers?: Array<IReader<E, F>>;
9
+ starters?: Array<IStarter<E, F>>;
10
+ [key: string]: any;
11
+ };
@@ -1,19 +1,2 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
2
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./IItemMap"), exports);
18
- __exportStar(require("./IForm"), exports);
19
- //# sourceMappingURL=index.js.map
@@ -1,9 +1,8 @@
1
- export * from './action';
2
- export * from './chapter';
1
+ export * from './command';
3
2
  export * from './constants';
4
- export * from './initializer';
5
- export * from './decorator';
6
- export * from './formItem';
7
- export * from './form';
3
+ export * from './item';
8
4
  export * from './reader';
9
- export * from './controller';
5
+ export * from './form';
6
+ export * from './starter';
7
+ export * from './service';
8
+ export * from './util';
@@ -14,13 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./action"), exports);
18
- __exportStar(require("./chapter"), exports);
17
+ __exportStar(require("./command"), exports);
19
18
  __exportStar(require("./constants"), exports);
20
- __exportStar(require("./initializer"), exports);
21
- __exportStar(require("./decorator"), exports);
22
- __exportStar(require("./formItem"), exports);
23
- __exportStar(require("./form"), exports);
19
+ __exportStar(require("./item"), exports);
24
20
  __exportStar(require("./reader"), exports);
25
- __exportStar(require("./controller"), exports);
26
- //# sourceMappingURL=index.js.map
21
+ __exportStar(require("./form"), exports);
22
+ __exportStar(require("./starter"), exports);
23
+ __exportStar(require("./service"), exports);
24
+ __exportStar(require("./util"), exports);
@@ -0,0 +1,25 @@
1
+ import { CommandItem } from '../command';
2
+ export type FormItem<E> = {
3
+ property: keyof E;
4
+ path?: string;
5
+ label: string;
6
+ required?: boolean;
7
+ type?: string;
8
+ value?: any;
9
+ error?: boolean;
10
+ errorMessages?: Array<string>;
11
+ disabled?: boolean;
12
+ hidden?: boolean;
13
+ getData?: (params?: any) => Promise<any>;
14
+ setValue?: (property: keyof E, value: any) => void;
15
+ control?: (command: CommandItem<E, any>) => Promise<Array<FormItem<E>>>;
16
+ submitted?: (command: CommandItem<E, any>) => Promise<void>;
17
+ initialize?: (command: CommandItem<E, any>) => Promise<Array<FormItem<E>>>;
18
+ validation?: (command: CommandItem<E, any>) => Promise<ErrorDetail>;
19
+ [key: string]: any;
20
+ };
21
+ export type ErrorDetail = {
22
+ error: boolean;
23
+ errorMessages?: Array<string>;
24
+ [key: string]: any;
25
+ };
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=index.js.map
@@ -1,5 +1,4 @@
1
- import { IEntity } from '@punica/common';
2
- import { IForm, IFormItem } from '..';
3
- export interface IReader<E extends IEntity, F extends IFormItem> {
4
- read(entity: E): Promise<IForm<F>>;
1
+ import { Form, FormItem } from '..';
2
+ export interface IReader<E, F extends FormItem<E>> {
3
+ read(entity: E, form: Form<E, F>): Promise<void>;
5
4
  }
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=index.js.map
@@ -0,0 +1,20 @@
1
+ import { CommandService, Form, FormItem } from '..';
2
+ export interface IService {
3
+ get name(): string;
4
+ }
5
+ export interface IServiceInitialize<E, F extends FormItem<E>> extends IService {
6
+ initialize: (command: CommandService<E, F>) => void;
7
+ }
8
+ export interface IServiceControl<T = any> extends IService {
9
+ run: (...args: any[]) => Promise<T>;
10
+ }
11
+ export interface IServiceCommand extends IService {
12
+ addCustomFeaturesForCommandItem: () => {
13
+ [key: string]: any;
14
+ };
15
+ }
16
+ export interface IServiceStartup<E, F extends FormItem<E>> extends IService {
17
+ start: (entity: E, form: Form<E, F>) => {
18
+ [key: string]: any;
19
+ };
20
+ }
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=index.js.map
@@ -0,0 +1,13 @@
1
+ import { Form, FormItem } from '..';
2
+ /**
3
+ * Interface representing a Starter for initializing form data.
4
+ */
5
+ export interface IStarter<E, F extends FormItem<E>> {
6
+ /**
7
+ * Function to run the starter logic.
8
+ * @param form - The current form data.
9
+ * @param entity - The entity associated with the form.
10
+ * @returns A Promise that resolves to the updated form data after initialization.
11
+ */
12
+ run: (form: Form<E, F>, entity: E) => Promise<Form<E, F>>;
13
+ }
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=index.js.map
@@ -0,0 +1,9 @@
1
+ import { FormItem } from '..';
2
+ /**
3
+ * Type alias for a function that retrieves a specific form item based on a property key.
4
+ * @param E - The type of the entity
5
+ * @param F - The type of the form item
6
+ * @param property - The property key to retrieve the form item
7
+ * @returns The form item corresponding to the property key
8
+ */
9
+ export type GetItem<E, F extends FormItem<E>> = (property: keyof E) => F;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,8 @@
1
+ import { FormItem } from '..';
2
+ /**
3
+ * Type alias for a function that writes form items to a storage.
4
+ * @param E - The type of the entity
5
+ * @param items - Array of form items to be written
6
+ * @returns A Promise that resolves once the items are written
7
+ */
8
+ export type WriteItems<E> = (items: Array<FormItem<E>>) => Promise<void>;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,2 @@
1
+ export * from './GetItem';
2
+ export * from './WriteItems';
@@ -14,18 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./base"), exports);
18
- __exportStar(require("./define"), exports);
19
- __exportStar(require("./FormItemSubmit"), exports);
20
- __exportStar(require("./FormItemError"), exports);
21
- __exportStar(require("./FormItemControl"), exports);
22
17
  __exportStar(require("./GetItem"), exports);
23
18
  __exportStar(require("./WriteItems"), exports);
24
- __exportStar(require("./base/IBaseFormItem"), exports);
25
- __exportStar(require("./FormItemConverter"), exports);
26
- __exportStar(require("./FormItemLayout"), exports);
27
- __exportStar(require("./FormItemGetData"), exports);
28
- __exportStar(require("./FormItemInitializer"), exports);
29
- __exportStar(require("./IFormItem"), exports);
30
- __exportStar(require("./IFormItemOptions"), exports);
31
- //# sourceMappingURL=index.js.map
@@ -0,0 +1,37 @@
1
+ import { Form, FormItem, IReader, CommandItem } from '../../../';
2
+ /**
3
+ * Abstract base class for reading form data.
4
+ */
5
+ declare abstract class BaseReader<E, F extends FormItem<E>> implements IReader<E, F> {
6
+ #private;
7
+ protected reader: IReader<E, F>;
8
+ /**
9
+ * Creates an instance of BaseReader.
10
+ * @param {IReader<E, F>} reader - The reader to be used for reading form data.
11
+ */
12
+ constructor(reader: IReader<E, F>);
13
+ /**
14
+ * Gets a command item for a form item.
15
+ * @param {F} item - The form item.
16
+ * @returns {CommandItem<E, F>} - The command item.
17
+ */
18
+ protected getCommand(item: F): CommandItem<E, F>;
19
+ /**
20
+ * Reads form data from the entity.
21
+ * @param {E} entity - The entity to read form data from.
22
+ * @param form
23
+ */
24
+ read(entity: E, form: Form<E, F>): Promise<void>;
25
+ /**
26
+ * Gets a form item by property.
27
+ * @param {keyof E} property - The property of the form item.
28
+ * @returns {F} - The form item.
29
+ */
30
+ protected getItem(property: keyof E): F;
31
+ /**
32
+ * Writes form items.
33
+ * @param {Array<FormItem<E>>} items - The form items to be written.
34
+ */
35
+ protected writeItems(items: Array<FormItem<E>>): Promise<void>;
36
+ }
37
+ export default BaseReader;
@@ -0,0 +1,75 @@
1
+ "use strict";
2
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
4
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
5
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
6
+ };
7
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
8
+ if (kind === "m") throw new TypeError("Private method is not writable");
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
10
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
11
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
+ };
13
+ var _BaseReader_form, _BaseReader_entity;
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ /**
16
+ * Abstract base class for reading form data.
17
+ */
18
+ class BaseReader {
19
+ /**
20
+ * Creates an instance of BaseReader.
21
+ * @param {IReader<E, F>} reader - The reader to be used for reading form data.
22
+ */
23
+ constructor(reader) {
24
+ _BaseReader_form.set(this, void 0);
25
+ _BaseReader_entity.set(this, void 0);
26
+ this.reader = reader;
27
+ }
28
+ /**
29
+ * Gets a command item for a form item.
30
+ * @param {F} item - The form item.
31
+ * @returns {CommandItem<E, F>} - The command item.
32
+ */
33
+ getCommand(item) {
34
+ return {
35
+ formItem: item,
36
+ initialEntity: __classPrivateFieldGet(this, _BaseReader_entity, "f"),
37
+ getItem: this.getItem
38
+ };
39
+ }
40
+ /**
41
+ * Reads form data from the entity.
42
+ * @param {E} entity - The entity to read form data from.
43
+ * @param form
44
+ */
45
+ async read(entity, form) {
46
+ __classPrivateFieldSet(this, _BaseReader_entity, entity, "f");
47
+ __classPrivateFieldSet(this, _BaseReader_form, form, "f");
48
+ await this.reader.read(entity, form);
49
+ }
50
+ /**
51
+ * Gets a form item by property.
52
+ * @param {keyof E} property - The property of the form item.
53
+ * @returns {F} - The form item.
54
+ */
55
+ getItem(property) {
56
+ const { items, itemsMap } = __classPrivateFieldGet(this, _BaseReader_form, "f");
57
+ const index = itemsMap[property];
58
+ const item = items[index];
59
+ return item;
60
+ }
61
+ /**
62
+ * Writes form items.
63
+ * @param {Array<FormItem<E>>} items - The form items to be written.
64
+ */
65
+ async writeItems(items) {
66
+ for (const item of items) {
67
+ const { itemsMap } = __classPrivateFieldGet(this, _BaseReader_form, "f");
68
+ const { property } = item;
69
+ const index = itemsMap[property];
70
+ __classPrivateFieldGet(this, _BaseReader_form, "f").items[index] = item;
71
+ }
72
+ }
73
+ }
74
+ _BaseReader_form = new WeakMap(), _BaseReader_entity = new WeakMap();
75
+ exports.default = BaseReader;
@@ -0,0 +1,17 @@
1
+ import { Form, FormItem } from '../../..';
2
+ import BaseReader from '../base';
3
+ declare class Reader<E, F extends FormItem<E>> extends BaseReader<E, F> {
4
+ /**
5
+ * Creates form items from the entity.
6
+ * @param entity - The entity to be read
7
+ * @returns Promise<Array<F>> - Created form items
8
+ */
9
+ private createFormItemsFromEntity;
10
+ /**
11
+ * Reads form data from the entity.
12
+ * @param {E} entity - The entity to read form data from.
13
+ * @param form
14
+ */
15
+ read(entity: E, form: Form<E, F>): Promise<void>;
16
+ }
17
+ export default Reader;
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const __1 = require("../../..");
7
+ const base_1 = __importDefault(require("../base"));
8
+ class Reader extends base_1.default {
9
+ /**
10
+ * Creates form items from the entity.
11
+ * @param entity - The entity to be read
12
+ * @returns Promise<Array<F>> - Created form items
13
+ */
14
+ createFormItemsFromEntity(entity) {
15
+ return new Promise(async (resolve) => {
16
+ const items = new Array();
17
+ const keys = Object.keys(entity);
18
+ const formItemPool = {};
19
+ const registeredItems = __1.FormItemRegister.getInstance().getItemKeys();
20
+ // Read metadata from the entity and create form items
21
+ for (const property of registeredItems) {
22
+ const formItems = Reflect.getMetadata(property, entity);
23
+ for (const key in formItems) {
24
+ formItemPool[key] = { ...formItems[key] };
25
+ }
26
+ }
27
+ for (let i = 0; i < keys.length; i++) {
28
+ const key = keys[i];
29
+ const formItem = formItemPool[key];
30
+ if (!formItem) {
31
+ continue;
32
+ }
33
+ formItem.property = key;
34
+ items.push(formItem);
35
+ }
36
+ resolve(items);
37
+ });
38
+ }
39
+ /**
40
+ * Reads form data from the entity.
41
+ * @param {E} entity - The entity to read form data from.
42
+ * @param form
43
+ */
44
+ async read(entity, form) {
45
+ await super.read(entity, form);
46
+ // Create form items from the entity
47
+ form.items = await this.createFormItemsFromEntity(entity);
48
+ form.itemsMap = {};
49
+ // Create a map of form items
50
+ form.items.forEach((item, index) => {
51
+ form.itemsMap[item.property] = index;
52
+ });
53
+ }
54
+ }
55
+ exports.default = Reader;
@@ -0,0 +1,24 @@
1
+ import { Form, FormItem } from '../../..';
2
+ import BaseReader from '../base';
3
+ declare class Reader<E, F extends FormItem<E>> extends BaseReader<E, F> {
4
+ /**
5
+ * Retrieves the data for a specific property of the entity.
6
+ * @param entity - The entity from which to retrieve data.
7
+ * @param item - The form item that specifies the property and path.
8
+ * @returns The data for the specified property.
9
+ */
10
+ private getPropertyData;
11
+ /**
12
+ * Reads data for each form item and updates their values.
13
+ * @param entity - The entity from which to read data.
14
+ * @param items - The array of form items to update.
15
+ */
16
+ private readItemsData;
17
+ /**
18
+ * Reads form data from the entity.
19
+ * @param {E} entity - The entity to read form data from.
20
+ * @param form
21
+ */
22
+ read(entity: E, form: Form<E, F>): Promise<void>;
23
+ }
24
+ export default Reader;
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const util_1 = require("@punica/util");
7
+ const base_1 = __importDefault(require("../base"));
8
+ class Reader extends base_1.default {
9
+ /**
10
+ * Retrieves the data for a specific property of the entity.
11
+ * @param entity - The entity from which to retrieve data.
12
+ * @param item - The form item that specifies the property and path.
13
+ * @returns The data for the specified property.
14
+ */
15
+ getPropertyData(entity, item) {
16
+ const { property, path } = item;
17
+ if (path)
18
+ return (0, util_1.ReadPropertyPath)(entity, property);
19
+ return entity[property];
20
+ }
21
+ /**
22
+ * Reads data for each form item and updates their values.
23
+ * @param entity - The entity from which to read data.
24
+ * @param items - The array of form items to update.
25
+ */
26
+ async readItemsData(entity, items) {
27
+ for await (const item of items) {
28
+ const data = this.getPropertyData(entity, item);
29
+ item.value = data;
30
+ }
31
+ }
32
+ /**
33
+ * Reads form data from the entity.
34
+ * @param {E} entity - The entity to read form data from.
35
+ * @param form
36
+ */
37
+ async read(entity, form) {
38
+ await super.read(entity, form);
39
+ await this.readItemsData(entity, form.items);
40
+ }
41
+ }
42
+ exports.default = Reader;
@@ -0,0 +1,16 @@
1
+ import { Form, FormItem } from '../../..';
2
+ import BaseReader from '../base';
3
+ declare class Reader<E, F extends FormItem<E>> extends BaseReader<E, F> {
4
+ /**
5
+ * Reads and initializes form items if they have an 'initialize' function.
6
+ * @param items - Array of form items.
7
+ */
8
+ private readItemsData;
9
+ /**
10
+ * Reads form data from the entity.
11
+ * @param {E} entity - The entity to read form data from.
12
+ * @param form
13
+ */
14
+ read(entity: E, form: Form<E, F>): Promise<void>;
15
+ }
16
+ export default Reader;