@ngrx-traits/core 12.0.0 → 12.1.2

package/bundles/ngrx-traits-core-testing.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@ngrx-traits/core'), require('@angular/core'), require('@ngrx/effects'), require('@ngrx/store/testing')) :
     typeof define === 'function' && define.amd ? define('@ngrx-traits/core/testing', ['exports', '@ngrx-traits/core', '@angular/core', '@ngrx/effects', '@ngrx/store/testing'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global['ngrx-traits'] = global['ngrx-traits'] || {}, global['ngrx-traits'].core = global['ngrx-traits'].core || {}, global['ngrx-traits'].core.testing = {}), global['ngrx-traits'].core, global.ng.core, global.effects, global.testing));
-}(this, (function (exports, core, core$1, effects, testing) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global["ngrx-traits"] = global["ngrx-traits"] || {}, global["ngrx-traits"].core = global["ngrx-traits"].core || {}, global["ngrx-traits"].core.testing = {}), global["ngrx-traits"].core, global.ng.core, global.effects, global.testing));
+})(this, (function (exports, core, core$1, effects, testing) { 'use strict';
 
     /*
      * NOTE: provideMockStore({initialState}) initialState will be ignored with local traits store!
@@ -48,5 +48,5 @@
 
     Object.defineProperty(exports, '__esModule', { value: true });
 
-})));
+}));
 //# sourceMappingURL=ngrx-traits-core-testing.umd.js.map

package/bundles/ngrx-traits-core-testing.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"ngrx-traits-core-testing.umd.js","sources":["../../../../../libs/ngrx-traits/core/testing/src/provide-mock-local-traits.ts","../../../../../libs/ngrx-traits/core/testing/src/ngrx-traits-core-testing.ts"],"sourcesContent":["import {\n  EntityFeatureFactory,\n  TraitsLocalStore,\n  DISABLE_LOCAL_TRAIT_EFFECTS,\n} from '@ngrx-traits/core';\nimport { Injector, Provider, Type } from '@angular/core';\nimport { EffectSources } from '@ngrx/effects';\nimport { MockStore } from '@ngrx/store/testing';\n\n/*\n * NOTE: provideMockStore({initialState}) initialState will be ignored with local traits store!\n * Override selectors instead\n *\n * You still need to provideMockStore and provideMockActions\n * */\nexport function provideMockLocalTraits<\n  T extends TraitsLocalStore<EntityFeatureFactory<any, any>>\n>({\n  traitFactory,\n  selectors,\n}: {\n  traitFactory: Type<T>;\n  selectors?: {\n    [key in keyof T['localSelectors']]?: ReturnType<T['localSelectors'][key]>;\n  };\n}): Provider[] {\n  return [\n    { provide: DISABLE_LOCAL_TRAIT_EFFECTS, useValue: true },\n    {\n      provide: EffectSources,\n      useValue: {\n        addEffects: () => {\n          return;\n        },\n      },\n    },\n    {\n      provide: traitFactory,\n      deps: [Injector, MockStore],\n      useFactory: (injector: Injector, mockStore: MockStore) => {\n        const trait = new traitFactory(injector);\n        if (selectors) {\n          Object.keys(selectors).forEach(\n            (key) =>\n              trait.localSelectors?.[key] &&\n              mockStore.overrideSelector(\n                trait.localSelectors[key],\n                selectors?.[key]\n              )\n          );\n        }\n        return trait;\n      },\n    },\n  ];\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public_api';\n"],"names":["DISABLE_LOCAL_TRAIT_EFFECTS","EffectSources","Injector","MockStore"],"mappings":";;;;;;IASA;;;;;;aAMgB,sBAAsB,CAEpC,EAQD;YAPC,YAAY,kBAAA,EACZ,SAAS,eAAA;QAOT,OAAO;YACL,EAAE,OAAO,EAAEA,gCAA2B,EAAE,QAAQ,EAAE,IAAI,EAAE;YACxD;gBACE,OAAO,EAAEC,qBAAa;gBACtB,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,OAAO;qBACR;iBACF;aACF;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,IAAI,EAAE,CAACC,eAAQ,EAAEC,iBAAS,CAAC;gBAC3B,UAAU,EAAE,UAAC,QAAkB,EAAE,SAAoB;oBACnD,IAAM,KAAK,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;oBACzC,IAAI,SAAS,EAAE;wBACb,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAC5B,UAAC,GAAG;;4BACF,OAAA,CAAA,MAAA,KAAK,CAAC,cAAc,0CAAG,GAAG,CAAC;gCAC3B,SAAS,CAAC,gBAAgB,CACxB,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EACzB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,CAAC,CACjB,CAAA;yBAAA,CACJ,CAAC;qBACH;oBACD,OAAO,KAAK,CAAC;iBACd;aACF;SACF,CAAC;IACJ;;ICvDA;;;;;;;;;;;;"}
+{"version":3,"file":"ngrx-traits-core-testing.umd.js","sources":["../../../../../libs/ngrx-traits/core/testing/src/provide-mock-local-traits.ts","../../../../../libs/ngrx-traits/core/testing/src/ngrx-traits-core-testing.ts"],"sourcesContent":["import {\n  EntityFeatureFactory,\n  TraitsLocalStore,\n  DISABLE_LOCAL_TRAIT_EFFECTS,\n} from '@ngrx-traits/core';\nimport { Injector, Provider, Type } from '@angular/core';\nimport { EffectSources } from '@ngrx/effects';\nimport { MockStore } from '@ngrx/store/testing';\n\n/*\n * NOTE: provideMockStore({initialState}) initialState will be ignored with local traits store!\n * Override selectors instead\n *\n * You still need to provideMockStore and provideMockActions\n * */\nexport function provideMockLocalTraits<\n  T extends TraitsLocalStore<EntityFeatureFactory<any, any>>\n>({\n  traitFactory,\n  selectors,\n}: {\n  traitFactory: Type<T>;\n  selectors?: {\n    [key in keyof T['localSelectors']]?: ReturnType<T['localSelectors'][key]>;\n  };\n}): Provider[] {\n  return [\n    { provide: DISABLE_LOCAL_TRAIT_EFFECTS, useValue: true },\n    {\n      provide: EffectSources,\n      useValue: {\n        addEffects: () => {\n          return;\n        },\n      },\n    },\n    {\n      provide: traitFactory,\n      deps: [Injector, MockStore],\n      useFactory: (injector: Injector, mockStore: MockStore) => {\n        const trait = new traitFactory(injector);\n        if (selectors) {\n          Object.keys(selectors).forEach(\n            (key) =>\n              trait.localSelectors?.[key] &&\n              mockStore.overrideSelector(\n                trait.localSelectors[key],\n                selectors?.[key]\n              )\n          );\n        }\n        return trait;\n      },\n    },\n  ];\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public_api';\n"],"names":["DISABLE_LOCAL_TRAIT_EFFECTS","EffectSources","Injector","MockStore"],"mappings":";;;;;;IASA;;;;;IAKK;IACC,SAAU,sBAAsB,CAEpC,EAQD,EAAA;YAPC,YAAY,GAAA,EAAA,CAAA,YAAA,EACZ,SAAS,GAAA,EAAA,CAAA,SAAA,CAAA;QAOT,OAAO;IACL,QAAA,EAAE,OAAO,EAAEA,gCAA2B,EAAE,QAAQ,EAAE,IAAI,EAAE;IACxD,QAAA;IACE,YAAA,OAAO,EAAEC,qBAAa;IACtB,YAAA,QAAQ,EAAE;IACR,gBAAA,UAAU,EAAE,YAAA;wBACV,OAAO;qBACR;IACF,aAAA;IACF,SAAA;IACD,QAAA;IACE,YAAA,OAAO,EAAE,YAAY;IACrB,YAAA,IAAI,EAAE,CAACC,eAAQ,EAAEC,iBAAS,CAAC;IAC3B,YAAA,UAAU,EAAE,UAAC,QAAkB,EAAE,SAAoB,EAAA;IACnD,gBAAA,IAAM,KAAK,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;IACzC,gBAAA,IAAI,SAAS,EAAE;wBACb,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAC5B,UAAC,GAAG,EAAA;;4BACF,OAAA,CAAA,CAAA,EAAA,GAAA,KAAK,CAAC,cAAc,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAG,GAAG,CAAC;IAC3B,4BAAA,SAAS,CAAC,gBAAgB,CACxB,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EACzB,SAAS,KAAA,IAAA,IAAT,SAAS,KAAT,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,SAAS,CAAG,GAAG,CAAC,CACjB,CAAA;IAAA,qBAAA,CACJ,CAAC;IACH,iBAAA;IACD,gBAAA,OAAO,KAAK,CAAC;iBACd;IACF,SAAA;SACF,CAAC;IACJ;;ICvDA;;IAEG;;;;;;;;;;"}

package/bundles/ngrx-traits-core.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@ngrx/store'), require('@angular/core'), require('@ngrx/effects'), require('rxjs/operators'), require('rxjs')) :
     typeof define === 'function' && define.amd ? define('@ngrx-traits/core', ['exports', '@ngrx/store', '@angular/core', '@ngrx/effects', 'rxjs/operators', 'rxjs'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global['ngrx-traits'] = global['ngrx-traits'] || {}, global['ngrx-traits'].core = {}), global.i2, global.ng.core, global.i1, global.rxjs.operators, global.rxjs));
-}(this, (function (exports, i2, i0, i1, operators, rxjs) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global["ngrx-traits"] = global["ngrx-traits"] || {}, global["ngrx-traits"].core = {}), global.i2, global.ng.core, global.i1, global.rxjs.operators, global.rxjs));
+})(this, (function (exports, i2, i0, i1, operators, rxjs) { 'use strict';
 
     function _interopNamespace(e) {
         if (e && e.__esModule) return e;
@@ -13,14 +13,12 @@
                     var d = Object.getOwnPropertyDescriptor(e, k);
                     Object.defineProperty(n, k, d.get ? d : {
                         enumerable: true,
-                        get: function () {
-                            return e[k];
-                        }
+                        get: function () { return e[k]; }
                     });
                 }
             });
         }
-        n['default'] = e;
+        n["default"] = e;
         return Object.freeze(n);
     }
 
@@ -28,7 +26,7 @@
     var i0__namespace = /*#__PURE__*/_interopNamespace(i0);
     var i1__namespace = /*#__PURE__*/_interopNamespace(i1);
 
-    /*! *****************************************************************************
+    /******************************************************************************
     Copyright (c) Microsoft Corporation.
 
     Permission to use, copy, modify, and/or distribute this software for any
@@ -190,7 +188,11 @@
     var __createBinding = Object.create ? (function (o, m, k, k2) {
         if (k2 === undefined)
             k2 = k;
-        Object.defineProperty(o, k2, { enumerable: true, get: function () { return m[k]; } });
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+            desc = { enumerable: true, get: function () { return m[k]; } };
+        }
+        Object.defineProperty(o, k2, desc);
     }) : (function (o, m, k, k2) {
         if (k2 === undefined)
             k2 = k;
@@ -263,7 +265,7 @@
                     ar[i] = from[i];
                 }
             }
-        return to.concat(ar || from);
+        return to.concat(ar || Array.prototype.slice.call(from));
     }
     function __await(v) {
         return this instanceof __await ? (this.v = v, this) : new __await(v);
@@ -345,6 +347,11 @@
             throw new TypeError("Cannot write private member to an object whose class did not declare it");
         return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
     }
+    function __classPrivateFieldIn(state, receiver) {
+        if (receiver === null || (typeof receiver !== "object" && typeof receiver !== "function"))
+            throw new TypeError("Cannot use 'in' operator on non-object");
+        return typeof state === "function" ? receiver === state : state.has(receiver);
+    }
 
     function insertIf(condition, getElement) {
         return condition ? [getElement()] : [];
@@ -362,10 +369,85 @@
         var result = text.replace(/([A-Z])/g, ' $1');
         return result.charAt(0).toUpperCase() + result.slice(1);
     }
-
-    function createTraitFactory(f) {
-        return f;
+    /**
+     * Set propertyReducer in sourceReducer in a property of the source state,
+     * @param sourceReducer
+     * @param property
+     * @param propertyReducer
+     *
+     * @example
+     *
+     * const newReducer = setPropertyReducer(productsReducer, 'selectedProduct', selectedProductReducer)
+     */
+    function setPropertyReducer(sourceReducer, property, propertyReducer) {
+        return function reducer(state, action) {
+            var _a;
+            var sourceState = sourceReducer(state, action);
+            return Object.assign(Object.assign({}, sourceState), (_a = {}, _a[property] = propertyReducer(sourceState[property], action), _a));
+        };
+    }
+    /**
+     * Set propertyReducers in sourceReducer each in a property of the source state,
+     * @param sourceReducer
+     * @param property
+     * @param propertyReducer
+     *
+     * @example
+     *
+     * const newReducer = setPropertyReducer(productsReducer,
+     * {
+     *    selectedProduct: selectedProductReducer
+     *    favoriteProduct: favoriteProductReducer
+     * })
+     */
+    function setPropertiesReducer(sourceReducer, propertiesReducers) {
+        return function reducer(state, action) {
+            var newState = Object.assign({}, sourceReducer(state, action));
+            for (var property in propertiesReducers) {
+                newState[property] = propertiesReducers[property](newState[property], action);
+            }
+            return newState;
+        };
+    }
+    /**
+     * joins two reducers so the work in the same state
+     * @param firstReducer
+     * @param secondReducer
+     */
+    function joinReducers(firstReducer, secondReducer) {
+        return function reducer(state, action) {
+            var sourceState = firstReducer(state, action);
+            return secondReducer(sourceState, action);
+        };
     }
+
+    /**
+     * Creates a function that when execute will combine all the traits, and return a EntityFeatureFactory
+     * which combines all the traits actions, selectors , reducers and effects,
+     * the names param will replace any action and selector with the word Entity or Entities,
+     * with the corresponding entityName and  entitiesName param (entityName+'s' if entitiesName is omitted).
+     * @param namesConfig - Optional Names for entities
+     * @param namesConfig.entityName - singular name for entity
+     * @param [namesConfig.entitiesName] - plural name for entities, defaults to entityName + 's'
+     * @param traits set of traits to be combined
+     *
+     * @example
+     *
+     * const featureFactory = createEntityFeatureFactory(
+     *   { entityName: 'product' },
+     *   addLoadEntitiesTrait<Product>(),
+     *   addSelectEntityTrait<Product>(),
+     *   addAsyncActionTrait({
+     *     name: 'checkout',
+     *     actionSuccessProps: props<{ orderId: string }>(),
+     *   })
+     * );
+     *
+     * export const productsFeature = featureFactory({
+     *   actionsGroupKey: '[Products]',
+     *   featureSelector: 'products',
+     * });
+     */
     function createEntityFeatureFactory(namesOrFactory) {
         var traits = [];
         for (var _i = 1; _i < arguments.length; _i++) {
@@ -565,28 +647,45 @@
         }
         return ss;
     }
-    function setPropertyReducer(sourceReducer, property, propertyReducer) {
-        return function reducer(state, action) {
-            var _d;
-            var sourceState = sourceReducer(state, action);
-            return Object.assign(Object.assign({}, sourceState), (_d = {}, _d[property] = propertyReducer(sourceState[property], action), _d));
-        };
-    }
-    function setPropertiesReducer(sourceReducer, propertiesReducers) {
-        return function reducer(state, action) {
-            var newState = Object.assign({}, sourceReducer(state, action));
-            for (var property in propertiesReducers) {
-                newState[property] = propertiesReducers[property](newState[property], action);
-            }
-            return newState;
-        };
-    }
-    function joinReducers(firstReducer, secondReducer) {
-        return function reducer(state, action) {
-            var sourceState = firstReducer(state, action);
-            return secondReducer(sourceState, action);
-        };
-    }
+    /**
+     * Combine a map entityFeatureFactories into one,
+     * grouping the actions and selectors by the key of the respective entityFeatureFactory
+     * @param traitFactoriesMap
+     *
+     * @example
+     *
+     * const clientsFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'client', entitiesName: 'clients' },
+     *   addLoadEntitiesTrait<Client>(),
+     *   addCrudEntitiesTrait<Client>()
+     * );
+     *
+     * const productOrderFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'productOrder' },
+     *   addLoadEntitiesTrait<ProductOrder>(),
+     *   addSelectEntitiesTrait<ProductOrder>()
+     * );
+     *
+     * const productFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'product' },
+     *   addLoadEntitiesTrait<Product>(),
+     *   addSelectEntitiesTrait<Product>()
+     * );
+     *
+     * const productCombinedFactory = combineEntityFeatures({
+     *   products: productFeatureFactory,
+     *   productOrders: productOrderFeatureFactory,
+     *   clients: clientsFeatureFactory,
+     * });
+     *
+     * const combinedFeature = productCombinedFactory({
+     *     actionsGroupKey: '[Combined]',
+     *     featureSelector: 'combined',
+     *   });
+     *
+     *   combinedFeature.actions.client.loadClients();
+     *   combinedFeature.actions.product.loadProducts();
+     */
     function combineEntityFeatures(traitFactoriesMap) {
         return (function (config) {
             var e_3, _d;
@@ -629,6 +728,45 @@
             };
         });
     }
+    /**
+     * Mix a map entityFeatureFactories into one, different from combine the actions and selectors a mix, not group by key like in combine, the keys are still use
+     * internal in the reducers and selector to separate the state
+     * @param traitFactoriesMap
+     *
+     * @example
+     *
+     * const clientsFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'client', entitiesName: 'clients' },
+     *   addLoadEntitiesTrait<Client>(),
+     *   addCrudEntitiesTrait<Client>()
+     * );
+     *
+     * const productOrderFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'productOrder' },
+     *   addLoadEntitiesTrait<ProductOrder>(),
+     *   addSelectEntitiesTrait<ProductOrder>()
+     * );
+     *
+     * const productFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'product' },
+     *   addLoadEntitiesTrait<Product>(),
+     *   addSelectEntitiesTrait<Product>()
+     * );
+     *
+     * const productMixedFactory = mixEntityFeatures({
+     *   products: productFeatureFactory,
+     *   productOrders: productOrderFeatureFactory,
+     *   clients: clientsFeatureFactory,
+     * });
+     *
+     * const mixedFeature = productMixedFactory({
+     *     actionsGroupKey: '[Mixed]',
+     *     featureSelector: 'mixed',
+     *   });
+     * mixedFeature.actions.loadClients();
+     * mixedFeature.actions.loadProducts();
+     *
+     */
     function mixEntityFeatures(traitFactoriesMap) {
         return (function (config) {
             var e_4, _d;
@@ -671,6 +809,49 @@
             };
         });
     }
+    /**
+     * Combines targetTraitFactory with the traitFactoriesMap using the keys as props for the targetTraitFactory state,
+     * and grouping the combined actions by key
+     * @param targetTraitFactory
+     * @param traitFactoriesMap
+     *
+     * @example
+     *
+     * const clientsFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'client', entitiesName: 'clients' },
+     *   addLoadEntitiesTrait<Client>(),
+     *   addCrudEntitiesTrait<Client>()
+     * );
+     *
+     * const productOrderFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'productOrder' },
+     *   addLoadEntitiesTrait<ProductOrder>(),
+     *   addSelectEntitiesTrait<ProductOrder>()
+     * );
+     *
+     * const productFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'product' },
+     *   addLoadEntitiesTrait<Product>(),
+     *   addSelectEntitiesTrait<Product>()
+     * );
+     *
+     * const productAddEntityPropertiesFactory = addEntityFeaturesProperties(
+     *   productFeatureFactory,
+     *   {
+     *     productOrders: productOrderFeatureFactory,
+     *     clients: clientsFeatureFactory,
+     *   }
+     * );
+     *
+     * const combinedFeature = productAddEntityPropertiesFactory({
+     *     actionsGroupKey: '[addEntityFeatures]',
+     *     featureSelector: 'addEntityFeatures',
+     *   });
+     *
+     *   combinedFeature.actions.loadProducts();
+     *   combinedFeature.actions.clients.loadClients();
+     *   combinedFeature.actions.productOrders.loadProductOrders();
+     */
     function addEntityFeaturesProperties(targetTraitFactory, traitFactoriesMap) {
         return (function (config) {
             var e_5, _d;
@@ -717,38 +898,13 @@
             };
         });
     }
-    // export
-    /// products:{actions, selectors, }, orders: {actions,slectors}
-    /// { actions: {ProductActions, OrderActions}, selectors: {ProductSelectors, OrderSelectors}
-    // TODO finish implementing combineTrais and addPropertiesTraits
-    // TODO finish renaming traits
-
-    // type G = ReplaceProps<
-    //   ReplaceProps<
-    //     {
-    //       loadEntities: 1;
-    //       loadEntitiesSuccess: 2;
-    //       selectEntities: 3;
-    //       selectEntity: 4;
-    //     },
-    //     'Entities',
-    //     'products'
-    //   >,
-    //   'Entity',
-    //   'product'
-    // >;
-    //
-    // const g: G = {};
-    // // g.
-    //   type F= ReplaceEntityNames<{
-    //   loadEntities: 1;
-    //   loadEntitiesSuccess: 2;
-    //   selectEntities: 3;
-    //   selectEntity: 4;
-    // }, 'product','products'>;
-    // const f: F = {};
-    // f.
-    // TODO clean up file
+    /**
+     * Helper function to create an implementation  a TraitFactory
+     * @param f TraitFactory implementation
+     */
+    function createTraitFactory(f) {
+        return f;
+    }
 
     var TraitEffect = /** @class */ (function () {
         function TraitEffect(actions$, store) {
@@ -767,9 +923,9 @@
         };
         return TraitEffect;
     }());
-    TraitEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitEffect, deps: [{ token: i1__namespace.Actions }, { token: i2__namespace.Store }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
-    TraitEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitEffect });
-    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitEffect, decorators: [{
+    TraitEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitEffect, deps: [{ token: i1__namespace.Actions }, { token: i2__namespace.Store }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
+    TraitEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitEffect });
+    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitEffect, decorators: [{
                 type: i0.Injectable
             }], ctorParameters: function () { return [{ type: i1__namespace.Actions }, { type: i2__namespace.Store }]; } });
     function getDestroyActionName(id) {
@@ -777,6 +933,7 @@
     }
 
     /**
+     * @ignore
      * @internal
      */
     var DISABLE_LOCAL_TRAIT_EFFECTS = new i0.InjectionToken('disableLocalTraitEffects');
@@ -785,6 +942,18 @@
     function uniqueComponentId() {
         return id++;
     }
+    /**
+     * Builds traitFactory and registers effects and reducers with
+     * a generated component id, returns build actions and selectors
+     * and a destroy method that will unergister the effects and reducers
+     * when called, and a addEffect which can be use to register extra effects
+     *
+     * Used inside TraitsLocalStore, can be used to create your
+     * own Component Service without extending TraitsLocalStore
+     * @param injector
+     * @param componentName
+     * @param traitFactory
+     */
     function buildLocalTraits(injector, componentName, traitFactory) {
         var _a;
         var reducers = injector.get(i2.ReducerManager);
@@ -831,6 +1000,67 @@
             },
         };
     }
+    /**
+     * Class used to create local traits service, receives a trait factory, which will be
+     * built and its reducers and effect register using a dynamic id when the service is built
+     * and get destroyed when the onDestroy lifecycle method of the service is called, if the service
+     * has effects this.traits.addEffects(this) should be call in the constructor
+     *
+     * @example
+     * const productFeatureFactory = createEntityFeatureFactory(
+     *   { entityName: 'product' },
+     *   addLoadEntitiesTrait<Product>(),
+     *   addSelectEntityTrait<Product>(),
+     * );
+     *
+     * Injectable()
+     * export class ProductsLocalTraits extends TraitsLocalStore<
+     *   typeof productFeatureFactory
+     * > {
+     *   loadProducts$ = createEffect(() =>
+     *     this.actions$.pipe(
+     *       ofType(this.localActions.loadProducts),
+     *       switchMap(() =>
+     *         //call your service to get the products data
+     *         this.productService.getProducts().pipe(
+     *           map((res) =>
+     *             this.localActions.loadProductsSuccess({ entities: res.resultList })
+     *           ),
+     *           catchError(() => of(this.localActions.loadProductsFail()))
+     *         )
+     *       )
+     *     )
+     *   );
+     *
+     *   constructor(injector: Injector, private productService: ProductService) {
+     *     super(injector);
+     *     this.traits.addEffects(this); // IMPORTANT! add this line if the service has effects
+     *   }
+     *
+     *   setup(): LocalTraitsConfig<typeof productFeatureFactory> {
+     *     return {
+     *       componentName: 'ProductsPickerComponent',
+     *       traitsFactory: productFeatureFactory,
+     *     };
+     *   }
+     * }
+     *
+     * // use in component later
+     *
+     * Component({
+     *   selector: 'some-component',
+     *   template: `<div> some content</div> `,
+     *   providers: [ProductsLocalTraits],
+     *   changeDetection: ChangeDetectionStrategy.OnPush,
+     * })
+     * export class ProductSelectDialogComponent implements OnInit {
+     *   constructor(private store: Store, private traits: ProductsLocalTraits) {}
+     *
+     *   ngOnInit() {
+     *     this.store.dispatch(this.traits.localActions.loadProducts());
+     *   }
+     * }
+     */
     var TraitsLocalStore = /** @class */ (function (_super) {
         __extends(TraitsLocalStore, _super);
         function TraitsLocalStore(injector) {
@@ -847,9 +1077,9 @@
         };
         return TraitsLocalStore;
     }(TraitEffect));
-    TraitsLocalStore.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitsLocalStore, deps: [{ token: i0__namespace.Injector }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
-    TraitsLocalStore.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitsLocalStore });
-    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: TraitsLocalStore, decorators: [{
+    TraitsLocalStore.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitsLocalStore, deps: [{ token: i0__namespace.Injector }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
+    TraitsLocalStore.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitsLocalStore });
+    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: TraitsLocalStore, decorators: [{
                 type: i0.Injectable
             }], ctorParameters: function () { return [{ type: i0__namespace.Injector }]; } });
 
@@ -1166,10 +1396,10 @@
         }
         return CacheModule;
     }());
-    CacheModule.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: CacheModule, deps: [], target: i0__namespace.ɵɵFactoryTarget.NgModule });
-    CacheModule.ɵmod = i0__namespace.ɵɵngDeclareNgModule({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: CacheModule, imports: [i2__namespace.StoreFeatureModule] });
-    CacheModule.ɵinj = i0__namespace.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: CacheModule, providers: [], imports: [[i2.StoreModule.forFeature('cache', cacheReducer)]] });
-    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: CacheModule, decorators: [{
+    CacheModule.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: CacheModule, deps: [], target: i0__namespace.ɵɵFactoryTarget.NgModule });
+    CacheModule.ɵmod = i0__namespace.ɵɵngDeclareNgModule({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: CacheModule, imports: [i2__namespace.StoreFeatureModule] });
+    CacheModule.ɵinj = i0__namespace.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: CacheModule, providers: [], imports: [[i2.StoreModule.forFeature('cache', cacheReducer)]] });
+    i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: CacheModule, decorators: [{
                 type: i0.NgModule,
                 args: [{
                         imports: [i2.StoreModule.forFeature('cache', cacheReducer)],
@@ -1208,5 +1438,5 @@
 
     Object.defineProperty(exports, '__esModule', { value: true });
 
-})));
+}));
 //# sourceMappingURL=ngrx-traits-core.umd.js.map