@punica/form 1.2.0 → 2.0.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.
- package/dist/controller/index.d.ts +43 -53
- package/dist/decorator/Readers.d.ts +2 -2
- package/dist/decorator/Services.d.ts +2 -2
- package/dist/decorator/Starters.d.ts +2 -2
- package/dist/define/FormItem.d.ts +12 -6
- package/dist/define/FormItemProperty.d.ts +5 -5
- package/dist/define/FormProperty.d.ts +5 -4
- package/dist/define/decorator.d.ts +16 -0
- package/dist/define/index.d.ts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +495 -21
- package/dist/index.mjs +450 -0
- package/dist/metadata/index.d.ts +20 -0
- package/dist/model/command/item.d.ts +11 -5
- package/dist/model/command/service.d.ts +19 -10
- package/dist/model/constants/index.d.ts +13 -2
- package/dist/model/form/index.d.ts +8 -4
- package/dist/model/index.d.ts +0 -1
- package/dist/model/item/index.d.ts +27 -12
- package/dist/model/reader/index.d.ts +5 -1
- package/dist/model/service/index.d.ts +28 -10
- package/dist/reader/index.d.ts +8 -16
- package/dist/register/index.d.ts +26 -39
- package/dist/utils/deepCopy.d.ts +1 -1
- package/dist/utils/devtools.d.ts +11 -70
- package/dist/utils/index.d.ts +1 -1
- package/package.json +19 -7
- package/dist/controller/index.js +0 -238
- package/dist/decorator/Readers.js +0 -15
- package/dist/decorator/Services.js +0 -15
- package/dist/decorator/Starters.js +0 -15
- package/dist/decorator/index.js +0 -19
- package/dist/define/FormItem.js +0 -26
- package/dist/define/FormItemProperty.js +0 -21
- package/dist/define/FormProperty.js +0 -15
- package/dist/define/index.js +0 -12
- package/dist/model/command/index.js +0 -18
- package/dist/model/command/item.js +0 -2
- package/dist/model/command/service.js +0 -2
- package/dist/model/constants/index.js +0 -2
- package/dist/model/form/index.js +0 -2
- package/dist/model/index.js +0 -24
- package/dist/model/item/index.js +0 -2
- package/dist/model/reader/index.js +0 -2
- package/dist/model/service/index.js +0 -2
- package/dist/model/starter/index.js +0 -2
- package/dist/model/util/GetItem.d.ts +0 -9
- package/dist/model/util/GetItem.js +0 -2
- package/dist/model/util/WriteItems.d.ts +0 -8
- package/dist/model/util/WriteItems.js +0 -2
- package/dist/model/util/index.d.ts +0 -2
- package/dist/model/util/index.js +0 -18
- package/dist/reader/decorators/base/index.d.ts +0 -35
- package/dist/reader/decorators/base/index.js +0 -82
- package/dist/reader/decorators/readers/FormItemsReader.d.ts +0 -17
- package/dist/reader/decorators/readers/FormItemsReader.js +0 -42
- package/dist/reader/decorators/readers/ItemDataReader.d.ts +0 -24
- package/dist/reader/decorators/readers/ItemDataReader.js +0 -42
- package/dist/reader/decorators/readers/ItemInitializerReader.d.ts +0 -16
- package/dist/reader/decorators/readers/ItemInitializerReader.js +0 -34
- package/dist/reader/decorators/readers/index.d.ts +0 -3
- package/dist/reader/decorators/readers/index.js +0 -12
- package/dist/reader/index.js +0 -30
- package/dist/reader/reader/Reader.d.ts +0 -13
- package/dist/reader/reader/Reader.js +0 -19
- package/dist/reader/reader/index.d.ts +0 -1
- package/dist/reader/reader/index.js +0 -8
- package/dist/register/index.js +0 -72
- package/dist/utils/deepCopy.js +0 -45
- package/dist/utils/devtools.js +0 -136
- package/dist/utils/index.js +0 -18
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,450 @@
|
|
|
1
|
+
var __typeError = (msg) => {
|
|
2
|
+
throw TypeError(msg);
|
|
3
|
+
};
|
|
4
|
+
var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
|
|
5
|
+
var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
|
|
6
|
+
var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
7
|
+
var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
|
|
8
|
+
var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
|
|
9
|
+
|
|
10
|
+
// lib/metadata/index.ts
|
|
11
|
+
var formProperties = /* @__PURE__ */ new WeakMap();
|
|
12
|
+
var formItemProperties = /* @__PURE__ */ new WeakMap();
|
|
13
|
+
var classesOf = (entity) => {
|
|
14
|
+
const classes = [];
|
|
15
|
+
let current = Object.getPrototypeOf(entity);
|
|
16
|
+
while (current && current !== Object.prototype) {
|
|
17
|
+
classes.unshift(current.constructor);
|
|
18
|
+
current = Object.getPrototypeOf(current);
|
|
19
|
+
}
|
|
20
|
+
return classes;
|
|
21
|
+
};
|
|
22
|
+
var setFormProperty = (target, key, data) => {
|
|
23
|
+
if (!formProperties.has(target)) {
|
|
24
|
+
formProperties.set(target, /* @__PURE__ */ new Map());
|
|
25
|
+
}
|
|
26
|
+
formProperties.get(target)?.set(key, data);
|
|
27
|
+
};
|
|
28
|
+
var setFormItemProperty = (target, key, property, data) => {
|
|
29
|
+
if (!formItemProperties.has(target)) {
|
|
30
|
+
formItemProperties.set(target, /* @__PURE__ */ new Map());
|
|
31
|
+
}
|
|
32
|
+
const properties = formItemProperties.get(target);
|
|
33
|
+
properties?.set(key, { ...properties.get(key), [property]: data });
|
|
34
|
+
};
|
|
35
|
+
var getFormProperty = (entity, key) => {
|
|
36
|
+
return classesOf(entity).reduce((found, target) => {
|
|
37
|
+
const properties = formProperties.get(target);
|
|
38
|
+
return properties?.has(key) ? properties.get(key) : found;
|
|
39
|
+
}, void 0);
|
|
40
|
+
};
|
|
41
|
+
var getFormItemProperties = (entity, key) => {
|
|
42
|
+
return classesOf(entity).reduce((found, target) => {
|
|
43
|
+
return {
|
|
44
|
+
...found,
|
|
45
|
+
...formItemProperties.get(target)?.get(key)
|
|
46
|
+
};
|
|
47
|
+
}, {});
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
// lib/register/index.ts
|
|
51
|
+
var _items;
|
|
52
|
+
var FormItemRegister = class {
|
|
53
|
+
constructor() {
|
|
54
|
+
__privateAdd(this, _items, /* @__PURE__ */ new Map());
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Registers the renderer of a type. The first registration of a type wins.
|
|
58
|
+
*/
|
|
59
|
+
register(type, renderer) {
|
|
60
|
+
if (!__privateGet(this, _items).has(type)) {
|
|
61
|
+
__privateGet(this, _items).set(type, renderer);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
unregister(type) {
|
|
65
|
+
__privateGet(this, _items).delete(type);
|
|
66
|
+
}
|
|
67
|
+
/** The renderer of a type. */
|
|
68
|
+
getItem(type) {
|
|
69
|
+
return __privateGet(this, _items).get(type);
|
|
70
|
+
}
|
|
71
|
+
/** The registered types. */
|
|
72
|
+
getItemKeys() {
|
|
73
|
+
return [...__privateGet(this, _items).keys()];
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
_items = new WeakMap();
|
|
77
|
+
var createFormItemRegister = () => {
|
|
78
|
+
return new FormItemRegister();
|
|
79
|
+
};
|
|
80
|
+
var defaultFormItemRegister = createFormItemRegister();
|
|
81
|
+
|
|
82
|
+
// lib/define/decorator.ts
|
|
83
|
+
var propertyDecorator = (register) => {
|
|
84
|
+
return (target, context) => {
|
|
85
|
+
if (typeof context === "object") {
|
|
86
|
+
context.addInitializer(function() {
|
|
87
|
+
register(this.constructor, String(context.name));
|
|
88
|
+
});
|
|
89
|
+
} else {
|
|
90
|
+
register(target.constructor, String(context));
|
|
91
|
+
}
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
// lib/define/FormItem.ts
|
|
96
|
+
var FORM_ITEMS = "form-items";
|
|
97
|
+
var defineFormItem = (type, renderer, options = {}) => {
|
|
98
|
+
(options.register ?? defaultFormItemRegister).register(type, renderer);
|
|
99
|
+
return (data) => propertyDecorator(
|
|
100
|
+
(target, property) => setFormItemProperty(target, FORM_ITEMS, property, { ...data, type })
|
|
101
|
+
);
|
|
102
|
+
};
|
|
103
|
+
var FormItem_default = defineFormItem;
|
|
104
|
+
|
|
105
|
+
// lib/define/FormItemProperty.ts
|
|
106
|
+
var defineFormItemProperty = (key) => {
|
|
107
|
+
return (data) => propertyDecorator(
|
|
108
|
+
(target, property) => setFormItemProperty(target, key, property, data)
|
|
109
|
+
);
|
|
110
|
+
};
|
|
111
|
+
var FormItemProperty_default = defineFormItemProperty;
|
|
112
|
+
|
|
113
|
+
// lib/define/FormProperty.ts
|
|
114
|
+
var defineFormProperty = (key) => {
|
|
115
|
+
return (data) => (target) => setFormProperty(target, key, data);
|
|
116
|
+
};
|
|
117
|
+
var FormProperty_default = defineFormProperty;
|
|
118
|
+
|
|
119
|
+
// lib/decorator/Readers.ts
|
|
120
|
+
var DECORATOR_READERS = "form-readers";
|
|
121
|
+
var Readers = (data) => {
|
|
122
|
+
return FormProperty_default(DECORATOR_READERS)(data);
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
// lib/decorator/Starters.ts
|
|
126
|
+
var DECORATOR_STARTERS = "form-starters";
|
|
127
|
+
var Starters = (data) => {
|
|
128
|
+
return FormProperty_default(DECORATOR_STARTERS)(data);
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
// lib/decorator/Services.ts
|
|
132
|
+
var DECORATOR_SERVICES = "form-services";
|
|
133
|
+
var Services = (data) => {
|
|
134
|
+
return FormProperty_default(DECORATOR_SERVICES)(data);
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
// lib/reader/index.ts
|
|
138
|
+
import { readPropertyPath } from "@punica/util";
|
|
139
|
+
var createInitialReader = () => ({
|
|
140
|
+
async read(entity, form) {
|
|
141
|
+
form.services = getFormProperty(entity, DECORATOR_SERVICES);
|
|
142
|
+
form.readers = getFormProperty(entity, DECORATOR_READERS);
|
|
143
|
+
form.starters = getFormProperty(entity, DECORATOR_STARTERS);
|
|
144
|
+
const definitions = getFormItemProperties(entity, FORM_ITEMS);
|
|
145
|
+
form.items = Object.keys(entity).filter((property) => definitions[property]).map((property) => {
|
|
146
|
+
const item = { ...definitions[property], property };
|
|
147
|
+
return {
|
|
148
|
+
...item,
|
|
149
|
+
value: item.path ? readPropertyPath(entity, item.path) : entity[property]
|
|
150
|
+
};
|
|
151
|
+
});
|
|
152
|
+
const getItem = (property) => {
|
|
153
|
+
return form.items.find((item) => item.property === property);
|
|
154
|
+
};
|
|
155
|
+
for (const { property, initialize } of form.items) {
|
|
156
|
+
if (!initialize) continue;
|
|
157
|
+
const initialized = await initialize({
|
|
158
|
+
formItem: getItem(property),
|
|
159
|
+
initialEntity: entity,
|
|
160
|
+
getItem
|
|
161
|
+
});
|
|
162
|
+
for (const item of initialized) {
|
|
163
|
+
const index = form.items.findIndex((i) => i.property === item.property);
|
|
164
|
+
if (index >= 0) form.items[index] = item;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
// lib/utils/devtools.ts
|
|
171
|
+
var DEVTOOLS_MESSAGE_SOURCE = "punica-form-devtools";
|
|
172
|
+
var DEVTOOLS_PROTOCOL_VERSION = 2;
|
|
173
|
+
var enabled = false;
|
|
174
|
+
var enableDevTools = () => {
|
|
175
|
+
enabled = true;
|
|
176
|
+
};
|
|
177
|
+
var disableDevTools = () => {
|
|
178
|
+
enabled = false;
|
|
179
|
+
};
|
|
180
|
+
var isDevToolsEnabled = () => {
|
|
181
|
+
return enabled && typeof window !== "undefined";
|
|
182
|
+
};
|
|
183
|
+
var sendToDevTools = (formId, type, data, formItemKey) => {
|
|
184
|
+
if (!isDevToolsEnabled()) {
|
|
185
|
+
return;
|
|
186
|
+
}
|
|
187
|
+
try {
|
|
188
|
+
window.postMessage(
|
|
189
|
+
{
|
|
190
|
+
source: DEVTOOLS_MESSAGE_SOURCE,
|
|
191
|
+
version: DEVTOOLS_PROTOCOL_VERSION,
|
|
192
|
+
formId,
|
|
193
|
+
type,
|
|
194
|
+
data: JSON.stringify(data),
|
|
195
|
+
formItemKey
|
|
196
|
+
},
|
|
197
|
+
window.location.origin
|
|
198
|
+
);
|
|
199
|
+
} catch {
|
|
200
|
+
}
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
// lib/controller/index.ts
|
|
204
|
+
var formCount = 0;
|
|
205
|
+
var _form, _initialItems, _itemsMap, _services, _subscribers, _listeners, _initialEntity, _register, _name, _FormController_instances, mapItems_fn, _getItem, _setItems, _emit, _createCommandItem, _createCommandService, sendEntityToDevTools_fn;
|
|
206
|
+
var _FormController = class _FormController {
|
|
207
|
+
constructor(form, entity, options) {
|
|
208
|
+
__privateAdd(this, _FormController_instances);
|
|
209
|
+
__privateAdd(this, _form);
|
|
210
|
+
__privateAdd(this, _initialItems, []);
|
|
211
|
+
__privateAdd(this, _itemsMap, /* @__PURE__ */ new Map());
|
|
212
|
+
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
213
|
+
__privateAdd(this, _services, /* @__PURE__ */ new Map());
|
|
214
|
+
__privateAdd(this, _subscribers, /* @__PURE__ */ new Set());
|
|
215
|
+
__privateAdd(this, _listeners, /* @__PURE__ */ new Map());
|
|
216
|
+
__privateAdd(this, _initialEntity);
|
|
217
|
+
__privateAdd(this, _register);
|
|
218
|
+
__privateAdd(this, _name);
|
|
219
|
+
/**
|
|
220
|
+
* The current form. It is never changed: after a change this returns a
|
|
221
|
+
* new object.
|
|
222
|
+
*/
|
|
223
|
+
this.getForm = () => {
|
|
224
|
+
return __privateGet(this, _form);
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* Calls the listener after every change of the form.
|
|
228
|
+
* @returns A function that removes the listener
|
|
229
|
+
*/
|
|
230
|
+
this.subscribe = (listener) => {
|
|
231
|
+
__privateGet(this, _subscribers).add(listener);
|
|
232
|
+
return () => __privateGet(this, _subscribers).delete(listener);
|
|
233
|
+
};
|
|
234
|
+
__privateAdd(this, _getItem, (property) => {
|
|
235
|
+
const index = __privateGet(this, _itemsMap).get(property);
|
|
236
|
+
return index === void 0 ? void 0 : __privateGet(this, _form).items[index];
|
|
237
|
+
});
|
|
238
|
+
/** The only place the form changes after it was started. */
|
|
239
|
+
__privateAdd(this, _setItems, (items) => {
|
|
240
|
+
const next = [...__privateGet(this, _form).items];
|
|
241
|
+
let changed = false;
|
|
242
|
+
for (const item of items) {
|
|
243
|
+
const index = __privateGet(this, _itemsMap).get(item.property);
|
|
244
|
+
if (index !== void 0) {
|
|
245
|
+
next[index] = item;
|
|
246
|
+
changed = true;
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
if (!changed) {
|
|
250
|
+
return;
|
|
251
|
+
}
|
|
252
|
+
__privateSet(this, _form, { ...__privateGet(this, _form), items: next });
|
|
253
|
+
__privateGet(this, _subscribers).forEach((listener) => listener());
|
|
254
|
+
__privateGet(this, _emit).call(this, "UPDATE_FORM", __privateGet(this, _form));
|
|
255
|
+
__privateMethod(this, _FormController_instances, sendEntityToDevTools_fn).call(this);
|
|
256
|
+
});
|
|
257
|
+
__privateAdd(this, _emit, (event, payload) => {
|
|
258
|
+
__privateGet(this, _listeners).get(event)?.forEach((handler) => handler(payload));
|
|
259
|
+
if (event === "UPDATE_ITEM") {
|
|
260
|
+
for (const item of payload) {
|
|
261
|
+
sendToDevTools(__privateGet(this, _name), event, item, String(item.property));
|
|
262
|
+
}
|
|
263
|
+
} else {
|
|
264
|
+
sendToDevTools(__privateGet(this, _name), event, payload);
|
|
265
|
+
}
|
|
266
|
+
});
|
|
267
|
+
__privateAdd(this, _createCommandItem, (item) => {
|
|
268
|
+
const features = (__privateGet(this, _form).services ?? []).reduce(
|
|
269
|
+
(all, service) => ({
|
|
270
|
+
...all,
|
|
271
|
+
...service.addCustomFeaturesForCommandItem?.()
|
|
272
|
+
}),
|
|
273
|
+
{}
|
|
274
|
+
);
|
|
275
|
+
return {
|
|
276
|
+
...features,
|
|
277
|
+
formItem: { ...item },
|
|
278
|
+
initialEntity: __privateGet(this, _initialEntity),
|
|
279
|
+
getItem: (property) => {
|
|
280
|
+
const found = __privateGet(this, _getItem).call(this, property);
|
|
281
|
+
return found && { ...found };
|
|
282
|
+
}
|
|
283
|
+
};
|
|
284
|
+
});
|
|
285
|
+
__privateAdd(this, _createCommandService, () => ({
|
|
286
|
+
initialEntity: __privateGet(this, _initialEntity),
|
|
287
|
+
getForm: this.getForm,
|
|
288
|
+
getInitialItems: () => __privateGet(this, _initialItems),
|
|
289
|
+
getItem: __privateGet(this, _getItem),
|
|
290
|
+
setItems: __privateGet(this, _setItems),
|
|
291
|
+
emit: __privateGet(this, _emit),
|
|
292
|
+
createCommandItem: __privateGet(this, _createCommandItem)
|
|
293
|
+
}));
|
|
294
|
+
__privateSet(this, _form, form);
|
|
295
|
+
__privateSet(this, _initialEntity, entity);
|
|
296
|
+
__privateSet(this, _register, options.register ?? defaultFormItemRegister);
|
|
297
|
+
__privateSet(this, _name, `${options.name ?? entity.constructor.name}#${++formCount}`);
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
* Creates a controller for a form that is described as data.
|
|
301
|
+
*/
|
|
302
|
+
static async fromForm(form, options = {}) {
|
|
303
|
+
return new _FormController(form, {}, {
|
|
304
|
+
name: "Form",
|
|
305
|
+
...options
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Creates a controller for an instance of a decorated form class.
|
|
310
|
+
*/
|
|
311
|
+
static async fromEntity(entity, options = {}) {
|
|
312
|
+
const form = { items: [] };
|
|
313
|
+
await createInitialReader().read(entity, form);
|
|
314
|
+
return new _FormController(form, entity, options);
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Listens to an event of the form.
|
|
318
|
+
* @returns A function that removes the handler
|
|
319
|
+
*/
|
|
320
|
+
on(event, handler) {
|
|
321
|
+
const handlers = __privateGet(this, _listeners).get(event) ?? /* @__PURE__ */ new Set();
|
|
322
|
+
__privateGet(this, _listeners).set(event, handlers.add(handler));
|
|
323
|
+
return () => handlers.delete(handler);
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* The service of a class listed in `@Services`.
|
|
327
|
+
* @throws When the form has no service of the class
|
|
328
|
+
*/
|
|
329
|
+
getService(service) {
|
|
330
|
+
const instance = __privateGet(this, _services).get(service);
|
|
331
|
+
if (!instance) {
|
|
332
|
+
throw new Error(
|
|
333
|
+
`Service not found: ${service.name}. Add it to @Services.`
|
|
334
|
+
);
|
|
335
|
+
}
|
|
336
|
+
return instance;
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Starts the form: runs its readers and starters and initializes its
|
|
340
|
+
* services.
|
|
341
|
+
* @returns The form
|
|
342
|
+
*/
|
|
343
|
+
async start() {
|
|
344
|
+
__privateGet(this, _emit).call(this, "REGISTER_ITEMS", __privateGet(this, _register).getItemKeys());
|
|
345
|
+
for (const reader of __privateGet(this, _form).readers ?? []) {
|
|
346
|
+
await reader.read(__privateGet(this, _initialEntity), __privateGet(this, _form));
|
|
347
|
+
}
|
|
348
|
+
for (const starter of __privateGet(this, _form).starters ?? []) {
|
|
349
|
+
__privateSet(this, _form, await starter.run(__privateGet(this, _form), __privateGet(this, _initialEntity)));
|
|
350
|
+
}
|
|
351
|
+
__privateMethod(this, _FormController_instances, mapItems_fn).call(this);
|
|
352
|
+
const command = __privateGet(this, _createCommandService).call(this);
|
|
353
|
+
for (const service of __privateGet(this, _form).services ?? []) {
|
|
354
|
+
__privateGet(this, _services).set(service.constructor, service);
|
|
355
|
+
await service.initialize?.(
|
|
356
|
+
command
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
__privateSet(this, _initialItems, deepCopy(__privateGet(this, _form).items));
|
|
360
|
+
sendToDevTools(__privateGet(this, _name), "@@INIT", __privateGet(this, _form));
|
|
361
|
+
__privateMethod(this, _FormController_instances, sendEntityToDevTools_fn).call(this);
|
|
362
|
+
return __privateGet(this, _form);
|
|
363
|
+
}
|
|
364
|
+
};
|
|
365
|
+
_form = new WeakMap();
|
|
366
|
+
_initialItems = new WeakMap();
|
|
367
|
+
_itemsMap = new WeakMap();
|
|
368
|
+
_services = new WeakMap();
|
|
369
|
+
_subscribers = new WeakMap();
|
|
370
|
+
_listeners = new WeakMap();
|
|
371
|
+
_initialEntity = new WeakMap();
|
|
372
|
+
_register = new WeakMap();
|
|
373
|
+
_name = new WeakMap();
|
|
374
|
+
_FormController_instances = new WeakSet();
|
|
375
|
+
mapItems_fn = function() {
|
|
376
|
+
__privateSet(this, _itemsMap, new Map(
|
|
377
|
+
__privateGet(this, _form).items.map((item, index) => [item.property, index])
|
|
378
|
+
));
|
|
379
|
+
};
|
|
380
|
+
_getItem = new WeakMap();
|
|
381
|
+
_setItems = new WeakMap();
|
|
382
|
+
_emit = new WeakMap();
|
|
383
|
+
_createCommandItem = new WeakMap();
|
|
384
|
+
_createCommandService = new WeakMap();
|
|
385
|
+
/** Developer tools show the entity as the `getValues` service returns it. */
|
|
386
|
+
sendEntityToDevTools_fn = function() {
|
|
387
|
+
const getValues = [...__privateGet(this, _services).values()].find(
|
|
388
|
+
(service) => service.name === "getValues"
|
|
389
|
+
);
|
|
390
|
+
getValues?.run().then((entity) => sendToDevTools(__privateGet(this, _name), "ENTITY", entity)).catch(() => void 0);
|
|
391
|
+
};
|
|
392
|
+
var FormController = _FormController;
|
|
393
|
+
|
|
394
|
+
// lib/utils/deepCopy.ts
|
|
395
|
+
var deepCopy = (value, seen = /* @__PURE__ */ new WeakMap()) => {
|
|
396
|
+
if (typeof value !== "object" || value === null) {
|
|
397
|
+
return value;
|
|
398
|
+
}
|
|
399
|
+
if (seen.has(value)) {
|
|
400
|
+
return seen.get(value);
|
|
401
|
+
}
|
|
402
|
+
if (value instanceof Date) {
|
|
403
|
+
return new Date(value.getTime());
|
|
404
|
+
}
|
|
405
|
+
if (value instanceof RegExp) {
|
|
406
|
+
return new RegExp(value.source, value.flags);
|
|
407
|
+
}
|
|
408
|
+
if (value instanceof Map) {
|
|
409
|
+
const copy2 = /* @__PURE__ */ new Map();
|
|
410
|
+
seen.set(value, copy2);
|
|
411
|
+
value.forEach((v, k) => copy2.set(deepCopy(k, seen), deepCopy(v, seen)));
|
|
412
|
+
return copy2;
|
|
413
|
+
}
|
|
414
|
+
if (value instanceof Set) {
|
|
415
|
+
const copy2 = /* @__PURE__ */ new Set();
|
|
416
|
+
seen.set(value, copy2);
|
|
417
|
+
value.forEach((v) => copy2.add(deepCopy(v, seen)));
|
|
418
|
+
return copy2;
|
|
419
|
+
}
|
|
420
|
+
const copy = Array.isArray(value) ? [] : Object.create(Object.getPrototypeOf(value));
|
|
421
|
+
seen.set(value, copy);
|
|
422
|
+
for (const key of Object.keys(value)) {
|
|
423
|
+
copy[key] = deepCopy(value[key], seen);
|
|
424
|
+
}
|
|
425
|
+
return copy;
|
|
426
|
+
};
|
|
427
|
+
export {
|
|
428
|
+
DECORATOR_READERS,
|
|
429
|
+
DECORATOR_SERVICES,
|
|
430
|
+
DECORATOR_STARTERS,
|
|
431
|
+
DEVTOOLS_MESSAGE_SOURCE,
|
|
432
|
+
DEVTOOLS_PROTOCOL_VERSION,
|
|
433
|
+
FormController,
|
|
434
|
+
FormItemRegister,
|
|
435
|
+
Readers,
|
|
436
|
+
Services,
|
|
437
|
+
Starters,
|
|
438
|
+
createFormItemRegister,
|
|
439
|
+
createInitialReader,
|
|
440
|
+
deepCopy,
|
|
441
|
+
defaultFormItemRegister,
|
|
442
|
+
FormItem_default as defineFormItem,
|
|
443
|
+
FormItemProperty_default as defineFormItemProperty,
|
|
444
|
+
FormProperty_default as defineFormProperty,
|
|
445
|
+
disableDevTools,
|
|
446
|
+
enableDevTools,
|
|
447
|
+
getFormItemProperties,
|
|
448
|
+
getFormProperty,
|
|
449
|
+
isDevToolsEnabled
|
|
450
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The metadata decorators attach to form classes. It is kept per class, so
|
|
3
|
+
* no reflection polyfill is needed.
|
|
4
|
+
*/
|
|
5
|
+
export declare const setFormProperty: (target: object, key: string, data: unknown) => void;
|
|
6
|
+
export declare const setFormItemProperty: (target: object, key: string, property: string, data: unknown) => void;
|
|
7
|
+
/**
|
|
8
|
+
* Reads what a decorator created with `defineFormProperty` stored on the
|
|
9
|
+
* class of the entity. A class overrides its base classes.
|
|
10
|
+
* @param entity - An instance of the form class
|
|
11
|
+
* @param key - The key the decorator was defined with
|
|
12
|
+
*/
|
|
13
|
+
export declare const getFormProperty: <T>(entity: object, key: string) => T | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* Reads what a decorator created with `defineFormItemProperty` stored for
|
|
16
|
+
* the properties of the entity, keyed by property name.
|
|
17
|
+
* @param entity - An instance of the form class
|
|
18
|
+
* @param key - The key the decorator was defined with
|
|
19
|
+
*/
|
|
20
|
+
export declare const getFormItemProperties: <T>(entity: object, key: string) => Record<string, T>;
|
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
import { FormItem } from '..';
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* What the functions of a form item (initialize, control, validation) receive.
|
|
4
|
+
* `C` holds the features services add, such as the functions of `Store`.
|
|
5
|
+
*/
|
|
6
|
+
export type CommandItem<E, F extends FormItem<E>, C = Record<string, unknown>> = {
|
|
7
|
+
/** A copy of the item the function belongs to. */
|
|
3
8
|
formItem: F;
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
9
|
+
/** The entity the form was created from. */
|
|
10
|
+
initialEntity: E;
|
|
11
|
+
/** A copy of another item of the form. */
|
|
12
|
+
getItem: (property: keyof E) => F | undefined;
|
|
13
|
+
} & C;
|
|
@@ -1,15 +1,24 @@
|
|
|
1
|
-
import { Form,
|
|
2
|
-
import { CommandItem } from '.';
|
|
1
|
+
import { CommandItem, Form, FormEventMap, FormItem } from '..';
|
|
3
2
|
/**
|
|
4
|
-
*
|
|
3
|
+
* What a service receives when it is initialized: the only way to read and
|
|
4
|
+
* change the state of the form.
|
|
5
5
|
*/
|
|
6
6
|
export type CommandService<E, F extends FormItem<E>> = {
|
|
7
|
-
|
|
7
|
+
/** The entity the form was created from. */
|
|
8
8
|
initialEntity: E;
|
|
9
|
-
form
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
9
|
+
/** The current form. */
|
|
10
|
+
getForm: () => Form<E, F>;
|
|
11
|
+
/** The items as they were when the form was started. */
|
|
12
|
+
getInitialItems: () => F[];
|
|
13
|
+
/** The current item of a property. */
|
|
14
|
+
getItem: (property: keyof E) => F | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* Replaces the items with the same properties. The form gets a new
|
|
17
|
+
* reference and UPDATE_FORM is fired. Unknown properties are ignored.
|
|
18
|
+
*/
|
|
19
|
+
setItems: (items: Array<FormItem<E>>) => void;
|
|
20
|
+
/** Fires an event of the controller. */
|
|
21
|
+
emit: <K extends keyof FormEventMap<E, F>>(event: K, payload: FormEventMap<E, F>[K]) => void;
|
|
22
|
+
/** Creates what the functions of a form item receive. */
|
|
23
|
+
createCommandItem: (item: F) => CommandItem<E, F>;
|
|
15
24
|
};
|
|
@@ -1,4 +1,15 @@
|
|
|
1
|
+
import { Form, FormItem } from '..';
|
|
1
2
|
/**
|
|
2
|
-
*
|
|
3
|
+
* The events of a form controller, mapped to the payload of each event.
|
|
3
4
|
*/
|
|
4
|
-
export type
|
|
5
|
+
export type FormEventMap<E, F extends FormItem<E>> = {
|
|
6
|
+
/** The form changed. Fired after every change of the state. */
|
|
7
|
+
UPDATE_FORM: Form<E, F>;
|
|
8
|
+
/** The form was reset to its initial state. Fired after UPDATE_FORM. */
|
|
9
|
+
RESET: Form<E, F>;
|
|
10
|
+
/** A value was set: the changed item, then the items its control returned. */
|
|
11
|
+
UPDATE_ITEM: F[];
|
|
12
|
+
/** The registered form item types. Fired at the beginning of start(). */
|
|
13
|
+
REGISTER_ITEMS: string[];
|
|
14
|
+
};
|
|
15
|
+
export type FormEvents = keyof FormEventMap<unknown, FormItem<unknown>>;
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
import { FormItem, IReader, IService, IStarter } from '../..';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
/**
|
|
3
|
+
* The state of a form. Readers and starters may attach their own properties
|
|
4
|
+
* (a title, a layout, …), which are read back as `unknown`.
|
|
5
|
+
*/
|
|
6
|
+
export type Form<E, F extends FormItem<E> = FormItem<E>> = {
|
|
7
|
+
items: F[];
|
|
8
|
+
services?: IService[];
|
|
5
9
|
readers?: Array<IReader<E, F>>;
|
|
6
10
|
starters?: Array<IStarter<E, F>>;
|
|
7
|
-
[key: string]:
|
|
11
|
+
[key: string]: unknown;
|
|
8
12
|
};
|
package/dist/model/index.d.ts
CHANGED
|
@@ -1,25 +1,40 @@
|
|
|
1
1
|
import { CommandItem } from '../command';
|
|
2
|
+
/**
|
|
3
|
+
* A field of a form. Extend it with the properties of your own form system:
|
|
4
|
+
* `type AppItem<E> = FormItem<E> & { layout?: Layout }`.
|
|
5
|
+
*/
|
|
2
6
|
export type FormItem<E> = {
|
|
7
|
+
/** The property of the entity this item belongs to. */
|
|
3
8
|
property: keyof E;
|
|
9
|
+
/** Path of the value inside the entity, for nested values (`address/city`). */
|
|
4
10
|
path?: string;
|
|
11
|
+
/** The label or display text of the item. */
|
|
5
12
|
label: string;
|
|
6
|
-
|
|
13
|
+
/** The form item type the item was created with. */
|
|
7
14
|
type?: string;
|
|
15
|
+
/**
|
|
16
|
+
* The value of the item. Deliberately `any`: its type depends on the
|
|
17
|
+
* property and on the form item type.
|
|
18
|
+
*/
|
|
8
19
|
value?: any;
|
|
9
|
-
|
|
10
|
-
errorMessages?: Array<string>;
|
|
20
|
+
required?: boolean;
|
|
11
21
|
disabled?: boolean;
|
|
12
22
|
hidden?: boolean;
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
23
|
+
/** Whether the last validation of the item failed. */
|
|
24
|
+
error?: boolean;
|
|
25
|
+
/** The messages of the last failed validation. */
|
|
26
|
+
errorMessages?: string[];
|
|
27
|
+
/** Runs once while the form is created; the returned items are written to the form. */
|
|
28
|
+
initialize?: (command: CommandItem<E, FormItem<E>>) => Promise<Array<FormItem<E>>>;
|
|
29
|
+
/** Runs after the value of the item was set; the returned items are written to the form. */
|
|
30
|
+
control?: (command: CommandItem<E, FormItem<E>>) => Promise<Array<FormItem<E>>>;
|
|
31
|
+
/** Validates the item. */
|
|
32
|
+
validation?: (command: CommandItem<E, FormItem<E>>) => Promise<ErrorDetail>;
|
|
20
33
|
};
|
|
34
|
+
/**
|
|
35
|
+
* The result of a validation.
|
|
36
|
+
*/
|
|
21
37
|
export type ErrorDetail = {
|
|
22
38
|
error: boolean;
|
|
23
|
-
errorMessages?:
|
|
24
|
-
[key: string]: any;
|
|
39
|
+
errorMessages?: string[];
|
|
25
40
|
};
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
import { Form, FormItem } from '..';
|
|
2
|
+
/**
|
|
3
|
+
* Reads metadata of the entity into the form while the form is started.
|
|
4
|
+
* A reader changes the form it is given.
|
|
5
|
+
*/
|
|
2
6
|
export interface IReader<E, F extends FormItem<E>> {
|
|
3
|
-
read(entity: E, form: Form<E, F
|
|
7
|
+
read(entity: E, form: Form<E, F>): void | Promise<void>;
|
|
4
8
|
}
|
|
@@ -1,20 +1,38 @@
|
|
|
1
|
-
import { CommandService,
|
|
1
|
+
import { CommandService, FormItem } from '..';
|
|
2
|
+
/**
|
|
3
|
+
* A service of a form. Register it with `@Services` and read it back with
|
|
4
|
+
* `controller.getService(Class)`.
|
|
5
|
+
*/
|
|
2
6
|
export interface IService {
|
|
7
|
+
/** A label for the service, shown by developer tools. */
|
|
3
8
|
get name(): string;
|
|
4
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* A service that reads or changes the form.
|
|
12
|
+
*/
|
|
5
13
|
export interface IServiceInitialize<E, F extends FormItem<E>> extends IService {
|
|
6
|
-
|
|
14
|
+
/** Called once when the form is started. */
|
|
15
|
+
initialize: (command: CommandService<E, F>) => void | Promise<void>;
|
|
7
16
|
}
|
|
8
|
-
|
|
17
|
+
/**
|
|
18
|
+
* A service that is executed.
|
|
19
|
+
*/
|
|
20
|
+
export interface IServiceControl<T = unknown> extends IService {
|
|
9
21
|
run: (...args: any[]) => Promise<T>;
|
|
10
22
|
}
|
|
23
|
+
/**
|
|
24
|
+
* A service that adds features to what the functions of form items receive.
|
|
25
|
+
*/
|
|
11
26
|
export interface IServiceCommand extends IService {
|
|
12
|
-
addCustomFeaturesForCommandItem: () =>
|
|
13
|
-
[key: string]: any;
|
|
14
|
-
};
|
|
27
|
+
addCustomFeaturesForCommandItem: () => Record<string, unknown>;
|
|
15
28
|
}
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
29
|
+
/**
|
|
30
|
+
* The services `controller.getService` knows the types of. Packages add
|
|
31
|
+
* theirs by declaration merging, which binds them to the entity of the form:
|
|
32
|
+
*
|
|
33
|
+
* declare module '@punica/form' {
|
|
34
|
+
* interface ServiceRegistry<E, F> { myService: MyService<E, F> }
|
|
35
|
+
* }
|
|
36
|
+
*/
|
|
37
|
+
export interface ServiceRegistry<E, F extends FormItem<E>> {
|
|
20
38
|
}
|