ngx-webstorage
Version:
### Local and session storage - Angular service This library provides an easy to use service to manage the web storages (local and session) from your Angular application. It provides also two decorators to synchronize the component attributes and the web
85 lines • 12.5 kB
JavaScript
import { APP_INITIALIZER, inject, InjectionToken, makeEnvironmentProviders } from '@angular/core';
import { StrategyIndex } from '../public_api';
import { InMemoryStorageStrategyProvider, LocalStorageStrategyProvider, SessionStorageStrategyProvider } from './strategies';
import { LocalStorageProvider, SessionStorageProvider } from './core/nativeStorage';
import { LocalStorageServiceProvider } from './services/localStorage';
import { SessionStorageServiceProvider } from './services/sessionStorage';
import { DefaultIsCaseSensitive, DefaultPrefix, DefaultSeparator } from './constants/config';
import { StorageKeyManager } from './helpers/storageKeyManager';
export const LIB_CONFIG = new InjectionToken('ngx_webstorage_config');
export var InternalNgxWebstorageFeatureKind;
(function (InternalNgxWebstorageFeatureKind) {
InternalNgxWebstorageFeatureKind[InternalNgxWebstorageFeatureKind["Config"] = 1] = "Config";
InternalNgxWebstorageFeatureKind[InternalNgxWebstorageFeatureKind["LocalStorage"] = 2] = "LocalStorage";
InternalNgxWebstorageFeatureKind[InternalNgxWebstorageFeatureKind["SessionStorage"] = 3] = "SessionStorage";
})(InternalNgxWebstorageFeatureKind || (InternalNgxWebstorageFeatureKind = {}));
function appInit() {
const config = inject(LIB_CONFIG);
const index = inject(StrategyIndex);
return () => {
StorageKeyManager.consumeConfiguration(config);
index.indexStrategies();
};
}
/**
* Provide ngx-webstorage basic features.
*
* - You can customise the configuration with the `withConfiguration` feature.
* - You can enable the `LocalStorage` features with the `withLocalStorage` feature.
* - You can enable the `SessionStorage` features with the `withSessionStorage` feature.
*
* @default config { prefix: 'ngx-webstorage', separator: '|', caseSensitive: false }
*/
export function provideNgxWebstorage(...features) {
const { configProvider, featureProviders } = parseFeatures(features);
return makeEnvironmentProviders([
configProvider,
InMemoryStorageStrategyProvider,
{ provide: APP_INITIALIZER, useFactory: appInit, multi: true },
...featureProviders,
]);
}
function parseFeatures(features) {
let configProvider;
const featureProviders = [];
const parsedFeatures = new Set();
for (const feature of features) {
if (parsedFeatures.has(feature.kind))
throw new Error(`Feature ${feature.kind} is already provided.`);
if (feature.kind === InternalNgxWebstorageFeatureKind.Config) {
configProvider = feature.providers[0];
}
else
featureProviders.push(...feature.providers);
parsedFeatures.add(feature.kind);
}
return {
configProvider: configProvider ?? {
provide: LIB_CONFIG,
useValue: { prefix: DefaultPrefix, separator: DefaultSeparator, caseSensitive: DefaultIsCaseSensitive }
},
featureProviders
};
}
export function makeNgxWebstorageFeature(kind, providers) {
return { kind, providers };
}
export function withNgxWebstorageConfig(config) {
return makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.Config, [{ provide: LIB_CONFIG, useValue: config }]);
}
/** Provides everything necessary to use the `LocalStorage` features. */
export function withLocalStorage() {
return makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.LocalStorage, [
LocalStorageProvider,
LocalStorageServiceProvider,
LocalStorageStrategyProvider,
]);
}
export function withSessionStorage() {
return makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.SessionStorage, [
SessionStorageProvider,
SessionStorageServiceProvider,
SessionStorageStrategyProvider,
]);
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../../../projects/ngx-webstorage/src/lib/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,wBAAwB,EAAW,MAAM,eAAe,CAAC;AAE1G,OAAO,EAAC,aAAa,EAAC,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAC,+BAA+B,EAAE,4BAA4B,EAAE,8BAA8B,EAAC,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAC,oBAAoB,EAAE,sBAAsB,EAAC,MAAM,sBAAsB,CAAC;AAClF,OAAO,EAAC,2BAA2B,EAAC,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAC,6BAA6B,EAAC,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAC,sBAAsB,EAAE,aAAa,EAAE,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EAAC,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AAE9D,MAAM,CAAC,MAAM,UAAU,GAA+C,IAAI,cAAc,CAA6B,uBAAuB,CAAC,CAAC;AAE9I,MAAM,CAAN,IAAY,gCAIX;AAJD,WAAY,gCAAgC;IAC3C,2FAAU,CAAA;IACV,uGAAgB,CAAA;IAChB,2GAAkB,CAAA;AACnB,CAAC,EAJW,gCAAgC,KAAhC,gCAAgC,QAI3C;AASD,SAAS,OAAO;IACf,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IACpC,OAAO,GAAG,EAAE;QACX,iBAAiB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC/C,KAAK,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAG,QAA0D;IACjG,MAAM,EAAC,cAAc,EAAE,gBAAgB,EAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACnE,OAAO,wBAAwB,CAAC;QAC/B,cAAc;QACd,+BAA+B;QAC/B,EAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAC;QAC5D,GAAG,gBAAgB;KACnB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,QAA0D;IAChF,IAAI,cAAwB,CAAC;IAC7B,MAAM,gBAAgB,GAAe,EAAE,CAAC;IAExC,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4B,CAAC;IAE3D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,CAAC,IAAI,uBAAuB,CAAC,CAAC;QAEtG,IAAI,OAAO,CAAC,IAAI,KAAK,gCAAgC,CAAC,MAAM,EAAE,CAAC;YAC9D,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC;;YAAM,gBAAgB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QAEnD,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,OAAO;QACN,cAAc,EAAE,cAAc,IAAI;YACjC,OAAO,EAAE,UAAU;YACnB,QAAQ,EAAE,EAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,sBAAsB,EAAC;SACrG;QACD,gBAAgB;KAChB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CAA+C,IAAiB,EAAE,SAAqB;IAC9H,OAAO,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,MAAkC;IACzE,OAAO,wBAAwB,CAAC,gCAAgC,CAAC,MAAM,EAAE,CAAC,EAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC;AACrH,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,gBAAgB;IAC/B,OAAO,wBAAwB,CAAC,gCAAgC,CAAC,YAAY,EAAE;QAC9E,oBAAoB;QACpB,2BAA2B;QAC3B,4BAA4B;KAC5B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB;IACjC,OAAO,wBAAwB,CAAC,gCAAgC,CAAC,cAAc,EAAE;QAChF,sBAAsB;QACtB,6BAA6B;QAC7B,8BAA8B;KAC9B,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {APP_INITIALIZER, inject, InjectionToken, makeEnvironmentProviders, Provider} from '@angular/core';\nimport {NgxWebstorageConfiguration} from './config';\nimport {StrategyIndex} from '../public_api';\nimport {InMemoryStorageStrategyProvider, LocalStorageStrategyProvider, SessionStorageStrategyProvider} from './strategies';\nimport {LocalStorageProvider, SessionStorageProvider} from './core/nativeStorage';\nimport {LocalStorageServiceProvider} from './services/localStorage';\nimport {SessionStorageServiceProvider} from './services/sessionStorage';\nimport {DefaultIsCaseSensitive, DefaultPrefix, DefaultSeparator} from './constants/config';\nimport {StorageKeyManager} from './helpers/storageKeyManager';\n\nexport const LIB_CONFIG: InjectionToken<NgxWebstorageConfiguration> = new InjectionToken<NgxWebstorageConfiguration>('ngx_webstorage_config');\n\nexport enum InternalNgxWebstorageFeatureKind {\n\tConfig = 1,\n\tLocalStorage = 2,\n\tSessionStorage = 3,\n}\n\nexport type NgxWebstorageFeatureKind = string | InternalNgxWebstorageFeatureKind;\n\nexport type NgxWebstorageFeature<FeatureKind extends NgxWebstorageFeatureKind> = {\n\tkind: FeatureKind;\n\tproviders: Provider[];\n};\n\nfunction appInit() {\n\tconst config = inject(LIB_CONFIG);\n\tconst index = inject(StrategyIndex);\n\treturn () => {\n\t\tStorageKeyManager.consumeConfiguration(config);\n\t\tindex.indexStrategies();\n\t};\n}\n\n/**\n * Provide ngx-webstorage basic features.\n *\n * - You can customise the configuration with the `withConfiguration` feature.\n * - You can enable the `LocalStorage` features with the `withLocalStorage` feature.\n * - You can enable the `SessionStorage` features with the `withSessionStorage` feature.\n *\n * @default config { prefix: 'ngx-webstorage', separator: '|', caseSensitive: false }\n */\nexport function provideNgxWebstorage(...features: NgxWebstorageFeature<NgxWebstorageFeatureKind>[]) {\n\tconst {configProvider, featureProviders} = parseFeatures(features);\n\treturn makeEnvironmentProviders([\n\t\tconfigProvider,\n\t\tInMemoryStorageStrategyProvider,\n\t\t{provide: APP_INITIALIZER, useFactory: appInit, multi: true},\n\t\t...featureProviders,\n\t]);\n}\n\nfunction parseFeatures(features: NgxWebstorageFeature<NgxWebstorageFeatureKind>[]) {\n\tlet configProvider: Provider;\n\tconst featureProviders: Provider[] = [];\n\n\tconst parsedFeatures = new Set<NgxWebstorageFeatureKind>();\n\n\tfor (const feature of features) {\n\t\tif (parsedFeatures.has(feature.kind)) throw new Error(`Feature ${feature.kind} is already provided.`);\n\n\t\tif (feature.kind === InternalNgxWebstorageFeatureKind.Config) {\n\t\t\tconfigProvider = feature.providers[0];\n\t\t} else featureProviders.push(...feature.providers);\n\n\t\tparsedFeatures.add(feature.kind);\n\t}\n\n\treturn {\n\t\tconfigProvider: configProvider ?? {\n\t\t\tprovide: LIB_CONFIG,\n\t\t\tuseValue: {prefix: DefaultPrefix, separator: DefaultSeparator, caseSensitive: DefaultIsCaseSensitive}\n\t\t},\n\t\tfeatureProviders\n\t};\n}\n\nexport function makeNgxWebstorageFeature<FeatureKind extends NgxWebstorageFeatureKind>(kind: FeatureKind, providers: Provider[]): NgxWebstorageFeature<FeatureKind> {\n\treturn {kind, providers};\n}\n\nexport function withNgxWebstorageConfig(config: NgxWebstorageConfiguration) {\n\treturn makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.Config, [{provide: LIB_CONFIG, useValue: config}]);\n}\n\n/** Provides everything necessary to use the `LocalStorage` features. */\nexport function withLocalStorage() {\n\treturn makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.LocalStorage, [\n\t\tLocalStorageProvider,\n\t\tLocalStorageServiceProvider,\n\t\tLocalStorageStrategyProvider,\n\t]);\n}\n\nexport function withSessionStorage() {\n\treturn makeNgxWebstorageFeature(InternalNgxWebstorageFeatureKind.SessionStorage, [\n\t\tSessionStorageProvider,\n\t\tSessionStorageServiceProvider,\n\t\tSessionStorageStrategyProvider,\n\t]);\n}\n"]}