@punica/form 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/controller/index.d.ts +57 -20
- package/dist/controller/index.js +163 -126
- package/dist/decorator/Services.d.ts +10 -0
- package/dist/decorator/Services.js +12 -0
- package/dist/decorator/Starters.d.ts +10 -0
- package/dist/decorator/Starters.js +12 -0
- package/dist/decorator/index.d.ts +2 -0
- package/dist/{model/decorator → decorator}/index.js +2 -8
- package/dist/define/FormItem.d.ts +9 -0
- package/dist/{model/formItem/define/index.js → define/FormItem.js} +10 -4
- package/dist/define/FormItemProperty.d.ts +8 -0
- package/dist/define/FormItemProperty.js +22 -0
- package/dist/define/FormProperty.d.ts +8 -0
- package/dist/define/FormProperty.js +16 -0
- package/dist/define/index.d.ts +3 -0
- package/dist/define/index.js +12 -0
- package/dist/index.d.ts +5 -1
- package/dist/index.js +5 -2
- package/dist/model/command/index.d.ts +2 -0
- package/dist/model/{formItem/base → command}/index.js +2 -8
- package/dist/model/command/item.d.ts +7 -0
- package/dist/model/{form/IForm.js → command/item.js} +0 -1
- package/dist/model/command/service.d.ts +15 -0
- package/dist/model/{action/index.js → command/service.js} +0 -1
- package/dist/model/constants/index.d.ts +4 -7
- package/dist/model/constants/index.js +0 -10
- package/dist/model/form/index.d.ts +10 -2
- package/dist/model/form/index.js +0 -17
- package/dist/model/index.d.ts +6 -7
- package/dist/model/index.js +6 -8
- package/dist/model/item/index.d.ts +25 -0
- package/dist/model/{chapter → item}/index.js +0 -1
- package/dist/model/reader/index.d.ts +3 -4
- package/dist/model/reader/index.js +0 -1
- package/dist/model/service/index.d.ts +20 -0
- package/dist/model/{controller → service}/index.js +0 -1
- package/dist/model/starter/index.d.ts +13 -0
- package/dist/model/{initializer → starter}/index.js +0 -1
- package/dist/model/util/GetItem.d.ts +9 -0
- package/dist/model/util/GetItem.js +2 -0
- package/dist/model/util/WriteItems.d.ts +8 -0
- package/dist/model/util/WriteItems.js +2 -0
- package/dist/model/util/index.d.ts +2 -0
- package/dist/model/{formItem → util}/index.js +0 -13
- package/dist/reader/decorators/base/index.d.ts +37 -0
- package/dist/reader/decorators/base/index.js +75 -0
- package/dist/reader/decorators/readers/FormItemsReader.d.ts +17 -0
- package/dist/reader/decorators/readers/FormItemsReader.js +56 -0
- package/dist/reader/decorators/readers/ItemDataReader.d.ts +24 -0
- package/dist/reader/decorators/readers/ItemDataReader.js +43 -0
- package/dist/reader/decorators/readers/ItemInitializerReader.d.ts +16 -0
- package/dist/reader/decorators/readers/ItemInitializerReader.js +35 -0
- package/dist/reader/decorators/readers/index.d.ts +3 -0
- package/dist/reader/decorators/readers/index.js +12 -0
- package/dist/reader/index.d.ts +19 -0
- package/dist/reader/index.js +30 -0
- package/dist/reader/reader/Reader.d.ts +20 -0
- package/dist/reader/reader/Reader.js +56 -0
- package/dist/reader/reader/index.d.ts +1 -0
- package/dist/reader/reader/index.js +8 -0
- package/dist/register/index.d.ts +40 -9
- package/dist/register/index.js +51 -13
- package/dist/utils/index.d.ts +18 -0
- package/dist/utils/index.js +82 -0
- package/package.json +3 -4
- package/dist/controller/index.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/model/action/index.d.ts +0 -8
- package/dist/model/action/index.js.map +0 -1
- package/dist/model/chapter/index.d.ts +0 -9
- package/dist/model/chapter/index.js.map +0 -1
- package/dist/model/constants/index.js.map +0 -1
- package/dist/model/controller/index.d.ts +0 -14
- package/dist/model/controller/index.js.map +0 -1
- package/dist/model/decorator/Actions.d.ts +0 -3
- package/dist/model/decorator/Actions.js +0 -12
- package/dist/model/decorator/Actions.js.map +0 -1
- package/dist/model/decorator/Chapter.d.ts +0 -4
- package/dist/model/decorator/Chapter.js +0 -16
- package/dist/model/decorator/Chapter.js.map +0 -1
- package/dist/model/decorator/Description.d.ts +0 -3
- package/dist/model/decorator/Description.js +0 -12
- package/dist/model/decorator/Description.js.map +0 -1
- package/dist/model/decorator/Initializer.d.ts +0 -4
- package/dist/model/decorator/Initializer.js +0 -12
- package/dist/model/decorator/Initializer.js.map +0 -1
- package/dist/model/decorator/Name.d.ts +0 -3
- package/dist/model/decorator/Name.js +0 -12
- package/dist/model/decorator/Name.js.map +0 -1
- package/dist/model/decorator/Store.d.ts +0 -3
- package/dist/model/decorator/Store.js +0 -12
- package/dist/model/decorator/Store.js.map +0 -1
- package/dist/model/decorator/Title.d.ts +0 -3
- package/dist/model/decorator/Title.js +0 -12
- package/dist/model/decorator/Title.js.map +0 -1
- package/dist/model/decorator/index.d.ts +0 -7
- package/dist/model/decorator/index.js.map +0 -1
- package/dist/model/form/IForm.d.ts +0 -12
- package/dist/model/form/IForm.js.map +0 -1
- package/dist/model/form/IItemMap.d.ts +0 -3
- package/dist/model/form/IItemMap.js +0 -3
- package/dist/model/form/IItemMap.js.map +0 -1
- package/dist/model/form/index.js.map +0 -1
- package/dist/model/formItem/FormItemControl.d.ts +0 -13
- package/dist/model/formItem/FormItemControl.js +0 -3
- package/dist/model/formItem/FormItemControl.js.map +0 -1
- package/dist/model/formItem/FormItemConverter.d.ts +0 -5
- package/dist/model/formItem/FormItemConverter.js +0 -3
- package/dist/model/formItem/FormItemConverter.js.map +0 -1
- package/dist/model/formItem/FormItemError.d.ts +0 -17
- package/dist/model/formItem/FormItemError.js +0 -3
- package/dist/model/formItem/FormItemError.js.map +0 -1
- package/dist/model/formItem/FormItemGetData.d.ts +0 -3
- package/dist/model/formItem/FormItemGetData.js +0 -3
- package/dist/model/formItem/FormItemGetData.js.map +0 -1
- package/dist/model/formItem/FormItemInitializer.d.ts +0 -13
- package/dist/model/formItem/FormItemInitializer.js +0 -3
- package/dist/model/formItem/FormItemInitializer.js.map +0 -1
- package/dist/model/formItem/FormItemLayout.d.ts +0 -9
- package/dist/model/formItem/FormItemLayout.js +0 -3
- package/dist/model/formItem/FormItemLayout.js.map +0 -1
- package/dist/model/formItem/FormItemSubmit.d.ts +0 -13
- package/dist/model/formItem/FormItemSubmit.js +0 -3
- package/dist/model/formItem/FormItemSubmit.js.map +0 -1
- package/dist/model/formItem/GetItem.d.ts +0 -2
- package/dist/model/formItem/GetItem.js +0 -3
- package/dist/model/formItem/GetItem.js.map +0 -1
- package/dist/model/formItem/IFormItem.d.ts +0 -16
- package/dist/model/formItem/IFormItem.js +0 -3
- package/dist/model/formItem/IFormItem.js.map +0 -1
- package/dist/model/formItem/IFormItemOptions.d.ts +0 -6
- package/dist/model/formItem/IFormItemOptions.js +0 -3
- package/dist/model/formItem/IFormItemOptions.js.map +0 -1
- package/dist/model/formItem/WriteItems.d.ts +0 -2
- package/dist/model/formItem/WriteItems.js +0 -3
- package/dist/model/formItem/WriteItems.js.map +0 -1
- package/dist/model/formItem/base/GetStoreItem.d.ts +0 -1
- package/dist/model/formItem/base/GetStoreItem.js +0 -3
- package/dist/model/formItem/base/GetStoreItem.js.map +0 -1
- package/dist/model/formItem/base/IBaseFormItem.d.ts +0 -18
- package/dist/model/formItem/base/IBaseFormItem.js +0 -3
- package/dist/model/formItem/base/IBaseFormItem.js.map +0 -1
- package/dist/model/formItem/base/Renderer.d.ts +0 -2
- package/dist/model/formItem/base/Renderer.js +0 -3
- package/dist/model/formItem/base/Renderer.js.map +0 -1
- package/dist/model/formItem/base/SetStoreItem.d.ts +0 -1
- package/dist/model/formItem/base/SetStoreItem.js +0 -3
- package/dist/model/formItem/base/SetStoreItem.js.map +0 -1
- package/dist/model/formItem/base/UpdatePropertyValue.d.ts +0 -1
- package/dist/model/formItem/base/UpdatePropertyValue.js +0 -3
- package/dist/model/formItem/base/UpdatePropertyValue.js.map +0 -1
- package/dist/model/formItem/base/UpdateValue.d.ts +0 -1
- package/dist/model/formItem/base/UpdateValue.js +0 -3
- package/dist/model/formItem/base/UpdateValue.js.map +0 -1
- package/dist/model/formItem/base/index.d.ts +0 -7
- package/dist/model/formItem/base/index.js.map +0 -1
- package/dist/model/formItem/define/index.d.ts +0 -2
- package/dist/model/formItem/define/index.js.map +0 -1
- package/dist/model/formItem/index.d.ts +0 -14
- package/dist/model/formItem/index.js.map +0 -1
- package/dist/model/index.js.map +0 -1
- package/dist/model/initializer/index.d.ts +0 -3
- package/dist/model/initializer/index.js.map +0 -1
- package/dist/model/reader/index.js.map +0 -1
- package/dist/register/index.js.map +0 -1
|
@@ -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
|
+
initialFormData: Form<E, F>;
|
|
8
|
+
initialEntity: E;
|
|
9
|
+
formData: 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,7 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
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,10 @@
|
|
|
1
|
-
|
|
2
|
-
export
|
|
1
|
+
import { FormItem, IService, IStarter } from '../..';
|
|
2
|
+
export type Form<E = any, F extends FormItem<E> = any> = {
|
|
3
|
+
itemsMap: {
|
|
4
|
+
[key in keyof E]: number;
|
|
5
|
+
};
|
|
6
|
+
items: Array<F>;
|
|
7
|
+
services?: Array<IService>;
|
|
8
|
+
starters?: Array<IStarter<E, F>>;
|
|
9
|
+
[key: string]: any;
|
|
10
|
+
};
|
package/dist/model/form/index.js
CHANGED
|
@@ -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
|
package/dist/model/index.d.ts
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
export * from './
|
|
2
|
-
export * from './chapter';
|
|
1
|
+
export * from './command';
|
|
3
2
|
export * from './constants';
|
|
4
|
-
export * from './
|
|
5
|
-
export * from './decorator';
|
|
6
|
-
export * from './formItem';
|
|
7
|
-
export * from './form';
|
|
3
|
+
export * from './item';
|
|
8
4
|
export * from './reader';
|
|
9
|
-
export * from './
|
|
5
|
+
export * from './form';
|
|
6
|
+
export * from './starter';
|
|
7
|
+
export * from './service';
|
|
8
|
+
export * from './util';
|
package/dist/model/index.js
CHANGED
|
@@ -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("./
|
|
18
|
-
__exportStar(require("./chapter"), exports);
|
|
17
|
+
__exportStar(require("./command"), exports);
|
|
19
18
|
__exportStar(require("./constants"), exports);
|
|
20
|
-
__exportStar(require("./
|
|
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("./
|
|
26
|
-
|
|
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 = any> = {
|
|
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,5 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
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, initialFormData?: Form<E, F>): Promise<Form<E, F>>;
|
|
5
4
|
}
|
|
@@ -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
|
+
}
|
|
@@ -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 formData - 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: (formData: Form<E, F>, entity: E) => Promise<Form<E, F>>;
|
|
13
|
+
}
|
|
@@ -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,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>;
|
|
@@ -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
|
+
* @returns {Promise<Form<E, F>>} - Resolves to the form data.
|
|
23
|
+
*/
|
|
24
|
+
read(entity: E): Promise<Form<E, F>>;
|
|
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
|
+
* @returns {Promise<Form<E, F>>} - Resolves to the form data.
|
|
44
|
+
*/
|
|
45
|
+
async read(entity) {
|
|
46
|
+
__classPrivateFieldSet(this, _BaseReader_entity, entity, "f");
|
|
47
|
+
__classPrivateFieldSet(this, _BaseReader_form, await this.reader.read(entity), "f");
|
|
48
|
+
return __classPrivateFieldGet(this, _BaseReader_form, "f");
|
|
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
|
+
* Creates the form from the entity.
|
|
12
|
+
* @param entity - The entity to be read
|
|
13
|
+
* @returns Promise<Form<E, F>> - Created form
|
|
14
|
+
*/
|
|
15
|
+
read(entity: E): Promise<Form<E, F>>;
|
|
16
|
+
}
|
|
17
|
+
export default Reader;
|
|
@@ -0,0 +1,56 @@
|
|
|
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
|
+
* Creates the form from the entity.
|
|
41
|
+
* @param entity - The entity to be read
|
|
42
|
+
* @returns Promise<Form<E, F>> - Created form
|
|
43
|
+
*/
|
|
44
|
+
async read(entity) {
|
|
45
|
+
const form = await super.read(entity);
|
|
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
|
+
return form;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
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 the entity and updates form items with their corresponding data.
|
|
19
|
+
* @param entity - The entity to be read.
|
|
20
|
+
* @returns The form with updated form item values.
|
|
21
|
+
*/
|
|
22
|
+
read(entity: E): Promise<Form<E, F>>;
|
|
23
|
+
}
|
|
24
|
+
export default Reader;
|
|
@@ -0,0 +1,43 @@
|
|
|
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 the entity and updates form items with their corresponding data.
|
|
34
|
+
* @param entity - The entity to be read.
|
|
35
|
+
* @returns The form with updated form item values.
|
|
36
|
+
*/
|
|
37
|
+
async read(entity) {
|
|
38
|
+
const form = await super.read(entity);
|
|
39
|
+
await this.readItemsData(entity, form.items);
|
|
40
|
+
return form;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
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 an entity and updates form items with their corresponding data.
|
|
11
|
+
* @param entity - The entity to be read.
|
|
12
|
+
* @returns The form with updated form item values.
|
|
13
|
+
*/
|
|
14
|
+
read(entity: E): Promise<Form<E, F>>;
|
|
15
|
+
}
|
|
16
|
+
export default Reader;
|
|
@@ -0,0 +1,35 @@
|
|
|
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 base_1 = __importDefault(require("../base"));
|
|
7
|
+
class Reader extends base_1.default {
|
|
8
|
+
/**
|
|
9
|
+
* Reads and initializes form items if they have an 'initialize' function.
|
|
10
|
+
* @param items - Array of form items.
|
|
11
|
+
*/
|
|
12
|
+
async readItemsData(items) {
|
|
13
|
+
for await (const formItem of items) {
|
|
14
|
+
const { initialize } = formItem;
|
|
15
|
+
if (initialize) {
|
|
16
|
+
// Call the 'initialize' function of the form item with a command item.
|
|
17
|
+
const items = await initialize(super.getCommand(formItem));
|
|
18
|
+
// Write the updated items back to the form.
|
|
19
|
+
this.writeItems(items);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Reads an entity and updates form items with their corresponding data.
|
|
25
|
+
* @param entity - The entity to be read.
|
|
26
|
+
* @returns The form with updated form item values.
|
|
27
|
+
*/
|
|
28
|
+
async read(entity) {
|
|
29
|
+
const form = await super.read(entity);
|
|
30
|
+
// Read and initialize form items.
|
|
31
|
+
this.readItemsData(form.items);
|
|
32
|
+
return form;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
exports.default = Reader;
|
|
@@ -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.ItemInitializerReader = exports.ItemDataReader = exports.FormItemsReader = void 0;
|
|
7
|
+
var FormItemsReader_1 = require("./FormItemsReader");
|
|
8
|
+
Object.defineProperty(exports, "FormItemsReader", { enumerable: true, get: function () { return __importDefault(FormItemsReader_1).default; } });
|
|
9
|
+
var ItemDataReader_1 = require("./ItemDataReader");
|
|
10
|
+
Object.defineProperty(exports, "ItemDataReader", { enumerable: true, get: function () { return __importDefault(ItemDataReader_1).default; } });
|
|
11
|
+
var ItemInitializerReader_1 = require("./ItemInitializerReader");
|
|
12
|
+
Object.defineProperty(exports, "ItemInitializerReader", { enumerable: true, get: function () { return __importDefault(ItemInitializerReader_1).default; } });
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { IReader } from '..';
|
|
2
|
+
/**
|
|
3
|
+
* Decorator Design Pattern for a Reader System
|
|
4
|
+
*
|
|
5
|
+
* - The `IReader` interface defines the contract for all types of readers.
|
|
6
|
+
* - The `Reader` class serves as the base reader.
|
|
7
|
+
* - Decorators are implemented as classes (e.g., `FormItemsReader`, `ItemDataReader`, `ItemInitializerReader`) that wrap existing readers and enhance their behavior.
|
|
8
|
+
* - The `createInitialReader` function creates an initial reader object with a chain of decorators applied.
|
|
9
|
+
*
|
|
10
|
+
* - `FormItemsReader` adds functionality related to reading form items.
|
|
11
|
+
* - `ItemDataReader` adds functionality related to reading item data.
|
|
12
|
+
* - `ItemInitializerReader` adds functionality related to initializing items.
|
|
13
|
+
*
|
|
14
|
+
* - The final `itemInitializerReader` returned by `createInitialReader` has all the decorators chained together,
|
|
15
|
+
* creating a powerful reader object that can perform a series of operations in a coordinated way.
|
|
16
|
+
*
|
|
17
|
+
* @returns {IReader<any, any>} - Initial reader object with a chain of decorators.
|
|
18
|
+
*/
|
|
19
|
+
export declare const createInitialReader: () => IReader<any, any>;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createInitialReader = void 0;
|
|
4
|
+
const reader_1 = require("./reader");
|
|
5
|
+
const readers_1 = require("./decorators/readers");
|
|
6
|
+
/**
|
|
7
|
+
* Decorator Design Pattern for a Reader System
|
|
8
|
+
*
|
|
9
|
+
* - The `IReader` interface defines the contract for all types of readers.
|
|
10
|
+
* - The `Reader` class serves as the base reader.
|
|
11
|
+
* - Decorators are implemented as classes (e.g., `FormItemsReader`, `ItemDataReader`, `ItemInitializerReader`) that wrap existing readers and enhance their behavior.
|
|
12
|
+
* - The `createInitialReader` function creates an initial reader object with a chain of decorators applied.
|
|
13
|
+
*
|
|
14
|
+
* - `FormItemsReader` adds functionality related to reading form items.
|
|
15
|
+
* - `ItemDataReader` adds functionality related to reading item data.
|
|
16
|
+
* - `ItemInitializerReader` adds functionality related to initializing items.
|
|
17
|
+
*
|
|
18
|
+
* - The final `itemInitializerReader` returned by `createInitialReader` has all the decorators chained together,
|
|
19
|
+
* creating a powerful reader object that can perform a series of operations in a coordinated way.
|
|
20
|
+
*
|
|
21
|
+
* @returns {IReader<any, any>} - Initial reader object with a chain of decorators.
|
|
22
|
+
*/
|
|
23
|
+
const createInitialReader = () => {
|
|
24
|
+
const reader = new reader_1.Reader();
|
|
25
|
+
const formItemsReader = new readers_1.FormItemsReader(reader);
|
|
26
|
+
const itemDataReader = new readers_1.ItemDataReader(formItemsReader);
|
|
27
|
+
const itemInitializerReader = new readers_1.ItemInitializerReader(itemDataReader);
|
|
28
|
+
return itemInitializerReader;
|
|
29
|
+
};
|
|
30
|
+
exports.createInitialReader = createInitialReader;
|