@datorama/akita-ng-forms-manager
Version:
The best way to manage your Angular form state in Akita
585 lines (551 loc) • 28.6 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@angular/core'), require('@angular/forms'), require('@datorama/akita'), require('rxjs'), require('rxjs/operators')) :
typeof define === 'function' && define.amd ? define('@datorama/akita-ng-forms-manager', ['exports', '@angular/core', '@angular/forms', '@datorama/akita', 'rxjs', 'rxjs/operators'], factory) :
(global = global || self, factory((global.datorama = global.datorama || {}, global.datorama['akita-ng-forms-manager'] = {}), global.ng.core, global.ng.forms, global.akita, global.rxjs, global.rxjs.operators));
}(this, (function (exports, core, forms, akita, rxjs, operators) { 'use strict';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABLITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions
and limitations under the License.
***************************************************************************** */
/* global Reflect, Promise */
var extendStatics = function(d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
function __extends(d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
}
var __assign = function() {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __rest(s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
}
function __decorate(decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
}
function __param(paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); }
}
function __metadata(metadataKey, metadataValue) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
}
function __awaiter(thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
}
function __exportStar(m, exports) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
function __values(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
}
function __read(o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
}
function __spread() {
for (var ar = [], i = 0; i < arguments.length; i++)
ar = ar.concat(__read(arguments[i]));
return ar;
}
function __spreadArrays() {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
function __await(v) {
return this instanceof __await ? (this.v = v, this) : new __await(v);
}
function __asyncGenerator(thisArg, _arguments, generator) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var g = generator.apply(thisArg, _arguments || []), i, q = [];
return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
function fulfill(value) { resume("next", value); }
function reject(value) { resume("throw", value); }
function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
}
function __asyncDelegator(o) {
var i, p;
return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
}
function __asyncValues(o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
}
function __makeTemplateObject(cooked, raw) {
if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
return cooked;
};
function __importStar(mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result.default = mod;
return result;
}
function __importDefault(mod) {
return (mod && mod.__esModule) ? mod : { default: mod };
}
function __classPrivateFieldGet(receiver, privateMap) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to get private field on non-instance");
}
return privateMap.get(receiver);
}
function __classPrivateFieldSet(receiver, privateMap, value) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to set private field on non-instance");
}
privateMap.set(receiver, value);
return value;
}
var FormsQuery = /** @class */ (function (_super) {
__extends(FormsQuery, _super);
function FormsQuery(store) {
return _super.call(this, store) || this;
}
return FormsQuery;
}(akita.Query));
var FormsStore = /** @class */ (function (_super) {
__extends(FormsStore, _super);
function FormsStore(state) {
return _super.call(this, state) || this;
}
FormsStore.ctorParameters = function () { return [
{ type: undefined }
]; };
FormsStore = __decorate([
akita.StoreConfig({
name: 'formsManager'
}),
__metadata("design:paramtypes", [Object])
], FormsStore);
return FormsStore;
}(akita.Store));
var FORMS_MANAGER_OPTIONS = new core.InjectionToken('FormsManagerOptions');
var defaultOptions = {
debounceTime: 300,
updateStoreOnUnsubscribe: false
};
var AkitaNgFormsManager = /** @class */ (function () {
function AkitaNgFormsManager(options) {
if (options === void 0) { options = {}; }
this.valueChanges = {};
this.ngForms = {};
this._options = Object.assign({}, defaultOptions, options);
this._store = new FormsStore({});
this._query = new FormsQuery(this.store);
}
Object.defineProperty(AkitaNgFormsManager.prototype, "query", {
get: function () {
return this._query;
},
enumerable: true,
configurable: true
});
Object.defineProperty(AkitaNgFormsManager.prototype, "store", {
get: function () {
return this._store;
},
enumerable: true,
configurable: true
});
AkitaNgFormsManager.prototype.selectValid = function (formName, path) {
return this.selectControl(formName, path).pipe(operators.map(function (control) { return control.valid; }));
};
AkitaNgFormsManager.prototype.selectDirty = function (formName, path) {
return this.selectControl(formName, path).pipe(operators.map(function (control) { return control.dirty; }));
};
AkitaNgFormsManager.prototype.selectDisabled = function (formName, path) {
return this.selectControl(formName, path).pipe(operators.map(function (control) { return control.disabled; }));
};
AkitaNgFormsManager.prototype.selectValue = function (formName, path) {
return this.selectControl(formName, path).pipe(operators.map(function (control) { return control.value; }));
};
AkitaNgFormsManager.prototype.selectErrors = function (formName, path) {
return this.selectControl(formName, path).pipe(operators.map(function (control) { return control.errors; }));
};
AkitaNgFormsManager.prototype.selectNgForm = function (formName) {
var _this = this;
return this.selectForm(formName, { filterNil: true }).pipe(operators.map(function () { return _this.ngForms[formName]; }));
};
/**
* If no path specified it means that it's a single FormControl or FormArray
*/
AkitaNgFormsManager.prototype.selectControl = function (formName, path) {
var _this = this;
if (!path) {
return this.selectForm(formName);
}
return this.query
.select(function (state) { return state[formName]; })
.pipe(akita.filterNil, operators.map(function (form) { return _this.resolveControl(form, path); }), operators.distinctUntilChanged(function (a, b) { return JSON.stringify(a) === JSON.stringify(b); }));
};
AkitaNgFormsManager.prototype.getControl = function (formName, path) {
if (!path) {
return this.getForm(formName);
}
if (this.hasForm(formName)) {
var form = this.getForm(formName);
return this.resolveControl(form, path);
}
return null;
};
AkitaNgFormsManager.prototype.selectForm = function (formName, options) {
if (options === void 0) { options = { filterNil: true }; }
return this.query.select(function (state) { return state[formName]; }).pipe(options.filterNil ? akita.filterNil : function (s) { return s; });
};
AkitaNgFormsManager.prototype.getForm = function (formName) {
return this.query.getValue()[formName];
};
AkitaNgFormsManager.prototype.getNgForm = function (formName) {
return this.ngForms[formName];
};
AkitaNgFormsManager.prototype.hasForm = function (formName) {
return !!this.getForm(formName);
};
AkitaNgFormsManager.prototype.upsert = function (formName, form, config) {
var _this = this;
if (config === void 0) { config = {}; }
var merged = __assign({ debounceTime: this._options.debounceTime, emitEvent: false }, config);
/** If the form already exist, patch the form with the store value */
if (this.hasForm(formName) === true) {
form.patchValue(this.resolveStoreToForm(formName, form, merged.arrControlFactory), {
emitEvent: merged.emitEvent
});
}
else {
/** else update the store with the current form state */
this.updateStore(formName, form, true);
if (merged.persistForm) {
this.storeFormInstance(formName, form);
}
}
this.valueChanges[formName] = rxjs.merge(form.valueChanges, form.statusChanges.pipe(operators.distinctUntilChanged()))
.pipe(operators.debounceTime(merged.debounceTime))
.subscribe(function () { return _this.updateStore(formName, form); });
return this;
};
AkitaNgFormsManager.prototype.remove = function (formName) {
var e_1, _a;
if (formName) {
this.removeFromStore(formName);
}
else {
var availableForms = Object.keys(this.query.getValue());
try {
for (var availableForms_1 = __values(availableForms), availableForms_1_1 = availableForms_1.next(); !availableForms_1_1.done; availableForms_1_1 = availableForms_1.next()) {
var name_1 = availableForms_1_1.value;
this.removeFromStore(name_1);
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (availableForms_1_1 && !availableForms_1_1.done && (_a = availableForms_1.return)) _a.call(availableForms_1);
}
finally { if (e_1) throw e_1.error; }
}
}
this.unsubscribe(formName);
};
AkitaNgFormsManager.prototype.unsubscribe = function (formName, config) {
var _this = this;
if (config === void 0) { config = {}; }
var e_2, _a;
var _config = __assign({ removeNgForm: true }, { updateStore: this._options.updateStoreOnUnsubscribe }, config);
var _formName = formName;
var removeInstance = function (name) { return (_config.removeNgForm ? _this.removeFormInstance(name) : null); };
if (_formName) {
if (this.valueChanges[_formName]) {
this.valueChanges[_formName].unsubscribe();
delete this.valueChanges[_formName];
if (config.updateStore && this.ngForms[_formName]) {
this.updateStore(_formName, this.getNgForm(_formName));
}
removeInstance(_formName);
}
}
else {
try {
for (var _b = __values(Object.keys(this.valueChanges)), _c = _b.next(); !_c.done; _c = _b.next()) {
var name_2 = _c.value;
this.valueChanges[name_2].unsubscribe();
if (config.updateStore && this.ngForms[name_2]) {
this.updateStore(name_2, this.getNgForm(name_2));
}
removeInstance(name_2);
}
}
catch (e_2_1) { e_2 = { error: e_2_1 }; }
finally {
try {
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
}
finally { if (e_2) throw e_2.error; }
}
this.valueChanges = {};
}
};
AkitaNgFormsManager.prototype.removeFromStore = function (formName) {
var snapshot = this.query.getValue();
var newState = Object.keys(snapshot).reduce(function (acc, currentFormName) {
if (formName !== currentFormName) {
acc[currentFormName] = snapshot[currentFormName];
}
return acc;
}, {});
akita.logAction("Remove " + formName);
this.store._setState(function () { return newState; });
};
AkitaNgFormsManager.prototype.resolveControl = function (form, path) {
var _a = __read(path.split('.')), first = _a[0], rest = _a.slice(1);
if (rest.length === 0) {
return form.controls[first];
}
return this.find(form.controls[first], rest);
};
AkitaNgFormsManager.prototype.find = function (control, path) {
return path.reduce(function (current, name) {
return current.controls.hasOwnProperty(name) ? current.controls[name] : null;
}, control);
};
AkitaNgFormsManager.prototype.resolveStoreToForm = function (formName, control, arrControlFactory) {
var form = this.getForm(formName);
var value = form.value;
/** It means it a single control */
if (!form.controls) {
return value;
}
this.handleFormArray(value, control, arrControlFactory);
return value;
};
AkitaNgFormsManager.prototype.handleFormArray = function (formValue, control, arrControlFactory) {
var _this = this;
if (control instanceof forms.FormArray) {
this.cleanArray(control);
if (!arrControlFactory) {
throw new Error('Please provide arrControlFactory');
}
formValue.forEach(function (v, i) { return control.insert(i, arrControlFactory(v)); });
}
else {
Object.keys(formValue).forEach(function (controlName) {
var value = formValue[controlName];
if (Array.isArray(value) && control.get(controlName) instanceof forms.FormArray === true) {
if (!arrControlFactory || (arrControlFactory && controlName in arrControlFactory === false)) {
throw new Error('Please provide arrControlFactory for ' + controlName);
}
var current_1 = control.get(controlName);
var fc_1 = arrControlFactory[controlName];
_this.cleanArray(current_1);
value.forEach(function (v, i) { return current_1.insert(i, fc_1(v)); });
}
});
}
};
AkitaNgFormsManager.prototype.cleanArray = function (control) {
while (control.length !== 0) {
control.removeAt(0);
}
};
AkitaNgFormsManager.prototype.buildFormStoreState = function (formName, form) {
var e_3, _a;
var value;
if (form instanceof forms.FormControl) {
value = this.resolveFormToStore(form);
}
if (form instanceof forms.FormGroup || form instanceof forms.FormArray) {
// The root form group
value = __assign({}, this.resolveFormToStore(form), { controls: {} });
try {
for (var _b = __values(Object.keys(form.controls)), _c = _b.next(); !_c.done; _c = _b.next()) {
var key = _c.value;
var control = form.controls[key];
if (control instanceof forms.FormGroup || form instanceof forms.FormArray) {
value.controls[key] = this.buildFormStoreState(formName, control);
}
else {
value.controls[key] = this.resolveFormToStore(control);
}
}
}
catch (e_3_1) { e_3 = { error: e_3_1 }; }
finally {
try {
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
}
finally { if (e_3) throw e_3.error; }
}
}
return value;
};
AkitaNgFormsManager.prototype.updateStore = function (formName, form, initial) {
if (initial === void 0) { initial = false; }
var _a;
var value = this.buildFormStoreState(formName, form);
var capitalized = formName[0].toUpperCase() + formName.slice(1);
var action = (initial ? 'Create' : 'Update') + " " + capitalized + " Form";
akita.logAction(action);
this.store.update((_a = {},
_a[formName] = value,
_a));
};
AkitaNgFormsManager.prototype.resolveFormToStore = function (control) {
return {
value: this.cloneValue(control.value),
rawValue: control.getRawValue ? control.getRawValue() : null,
valid: control.valid,
dirty: control.dirty,
invalid: control.invalid,
disabled: control.disabled,
errors: control.errors,
touched: control.touched,
pristine: control.pristine,
pending: control.pending
};
};
AkitaNgFormsManager.prototype.cloneValue = function (value) {
return this.isObject(value) ? __assign({}, value) : Array.isArray(value) ? __spread(value) : value;
};
AkitaNgFormsManager.prototype.isObject = function (val) {
if (val == null) {
return false;
}
if (Array.isArray(val)) {
return false;
}
return typeof val === 'function' || typeof val === 'object';
};
AkitaNgFormsManager.prototype.storeFormInstance = function (formName, form) {
var _a;
var newForms = __assign({}, this.ngForms, (_a = {}, _a[formName] = form, _a));
this.ngForms = newForms;
};
AkitaNgFormsManager.prototype.removeFormInstance = function (formName) {
if (this.ngForms[formName]) {
delete this.ngForms[formName];
}
};
AkitaNgFormsManager.ctorParameters = function () { return [
{ type: undefined, decorators: [{ type: core.Optional }, { type: core.Inject, args: [FORMS_MANAGER_OPTIONS,] }] }
]; };
AkitaNgFormsManager.ɵprov = core["ɵɵdefineInjectable"]({ factory: function AkitaNgFormsManager_Factory() { return new AkitaNgFormsManager(core["ɵɵinject"](FORMS_MANAGER_OPTIONS, 8)); }, token: AkitaNgFormsManager, providedIn: "root" });
AkitaNgFormsManager = __decorate([
core.Injectable({
providedIn: 'root'
}),
__param(0, core.Optional()), __param(0, core.Inject(FORMS_MANAGER_OPTIONS)),
__metadata("design:paramtypes", [Object])
], AkitaNgFormsManager);
return AkitaNgFormsManager;
}());
function setValidators(control, validator) {
control.setValidators(akita.coerceArray(validator));
control.updateValueAndValidity();
}
function setAsyncValidators(control, validator) {
control.setValidators(akita.coerceArray(validator));
control.updateValueAndValidity();
}
exports.AkitaNgFormsManager = AkitaNgFormsManager;
exports.FORMS_MANAGER_OPTIONS = FORMS_MANAGER_OPTIONS;
exports.FormsQuery = FormsQuery;
exports.FormsStore = FormsStore;
exports.setAsyncValidators = setAsyncValidators;
exports.setValidators = setValidators;
Object.defineProperty(exports, '__esModule', { value: true });
})));
//# sourceMappingURL=datorama-akita-ng-forms-manager.umd.js.map