ngx-sp-auth 4.3.6 → 4.3.7

package/lib/services/indexed-db.service.d.ts

@@ -0,0 +1,78 @@
+import { IDBPDatabase } from 'idb';
+import { LibCustomEnvironmentService } from '../custom/lib-custom-environment.service';
+import * as i0 from "@angular/core";
+/**
+ * Tipo estruturado que deve ser enviado e recebido quando utilizar o armazenamento de valores no IndexedDB
+*/
+export type ObjectToStore<T> = {
+    /** Valor da chave-única para diferenciar entre outros valores salvos */
+    key: string;
+    /** Contexto da tela em que a implementação está inserida */
+    context: string;
+    /**
+     * Corpo do que será de fato armazenado, filtros, formulários, etc.
+     * O tipo usado é genérico e deve ser informado caso deseje utilizar este tipo no seu componente.
+    */
+    payload?: T;
+};
+export declare class IndexedDBService {
+    private _customEnvironment;
+    private _restored?;
+    private _dbName;
+    protected database?: IDBDatabase;
+    protected request?: IDBPDatabase<unknown>;
+    constructor(_customEnvironment: LibCustomEnvironmentService);
+    /**
+     * Cria um registro dentro de um objectStore.
+     * O valor a ser inserido precisa ser um objeto com pelo **menos a propriedade `key`**, ela é a nossa *chave-primária* dos registros
+     *
+     * @param value Valor a ser inserido
+     */
+    add(value: ObjectToStore<any>): Promise<void>;
+    /**
+     * Busca um valor na base dentro de um objectStore.
+     *
+     * @param storeName Nome do objectStore
+     * @param key Valor da chave única
+     * @returns Promise<> com o valor encontrado ou undefined se não encontrar
+     */
+    get(key: string): Promise<ObjectToStore<any>>;
+    /**
+     * Atualiza o valor de um registro dentro de um objectStore.
+     *
+     * @param value Valor atualizado
+     */
+    update(value: ObjectToStore<any>): Promise<void>;
+    /**
+     * Exclui um registro na base dentro de um objectStore.
+     *
+     * @param key Valor da chave única
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Inicializa as configurações iniciais do IndexedDB e já cria o objectStore que será utilizado caso não exista.
+     *
+     * O object store que será criado terá sua chave inline na propriedade `key` e o índice será a propriedade `context`, portanto todos os valores que forem inseridos **DEVEM** ser um objeto com pelo menos a propriedade `key` e `context`.
+     * Deve ser chamado no constructor do seu componente para garantir inicialização correta pelo componente
+     *
+     * @param dbName Nome da base de dados que será usada
+    */
+    initializeDatabase(dbName?: string): Promise<void>;
+    /**
+     * Exclui uma database do IndexedDB com base no nome.
+     *
+     * @param name Nome da database
+    */
+    deleteDatabase(name: string): Promise<void>;
+    /**
+     * Valida se já existe um valor cadastrado na base com a chave-única que foi informada, se houver retorna ele, caso contrário cria um registro placeholder para poder atualizar depois.
+     *
+     * @param key Valor da chave única
+     * @param value (opcional) Valor placeholder caso não exista um valor previamente criado
+     *
+     * @returns Estrutura encontrada no objectStore com a chave-única informada
+    */
+    validate(key: string, value?: ObjectToStore<any> | null): Promise<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IndexedDBService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<IndexedDBService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-sp-auth",
-  "version": "4.3.6",
+  "version": "4.3.7",
   "description": "Biblioteca de utilitários de autenticação.",
   "author": "P&D",
   "keywords": [
@@ -22,7 +22,8 @@
   "peerDependencies": {
     "@azure/msal-angular": "^4.0.16",
     "@azure/msal-browser": "^4.18.0",
-    "ngx-sp-infra": "^6.5.9",
+    "idb": "^8.0.3",
+    "ngx-sp-infra": "^6.5.10",
     "ngx-toastr": "^19.0.0"
   },
   "sideEffects": false,

package/public-api.d.ts

@@ -8,6 +8,7 @@ export * from './lib/custom/lib-custom-login.service';
 export * from './lib/custom/lib-custom-menu.service';
 export * from './lib/custom/lib-custom-storage.service';
 export * from './lib/custom/lib-menu-config.service';
+export * from './lib/services/indexed-db.service';
 export * from './lib/services/pesquisa-telas-global.service';
 export * from './lib/storage/auth-storage.service';
 /** Components */