@po-ui/ng-sync 19.26.0 → 20.0.0

package/lib/services/po-schema/po-schema.service.d.ts

@@ -1,98 +0,0 @@
-import { PoStorageService } from '@po-ui/ng-storage';
-import { PoSchemaDefinitionService } from './po-schema-definition/po-schema-definition.service';
-import { PoSyncSchema } from '../po-sync/interfaces/po-sync-schema.interface';
-import * as i0 from "@angular/core";
-/**
- * @docsPrivate
- *
- * @description
- *
- * Serviço que realiza as operações nos `schemas`.
- */
-export declare class PoSchemaService {
-    private poSchemaDefinitionService;
-    private poStorage;
-    constructor(poSchemaDefinitionService: PoSchemaDefinitionService, poStorage: PoStorageService);
-    /**
-     * Retorna o id a partir de uma chave de um *schema*.
-     *
-     * @param {string} schemaKey Chave do *schema* em que será realizada a busca do id.
-     */
-    private static getIdByRecordKey;
-    /**
-     * Retorna a chave do *schema* informado.
-     *
-     * @param {string} schemaName Nome do *schema*.
-     * @param {any} recordId Id do registro.
-     * @param {boolean} isLocalKey Indica se é uma chave local.
-     */
-    private static getRecordKey;
-    /**
-     * Verifica se o dado informado é uma chave de um *schema*.
-     *
-     * @param {string} data Dado que será verificado se é uma chave de um *schema*.
-     * @param {string} schemaName Nome do *schema*.
-     */
-    private static isSchemaKey;
-    /**
-     * Cria um novo registro para o *schema* informado.
-     *
-     * @param {PoSyncSchema} schema **Schema* em que será criado o registro.
-     * @param {object} newRecord Registro que será criado.
-     */
-    create(schema: PoSyncSchema, newRecord: object): Promise<object>;
-    /**
-     * Destrói as chaves do *storage* que contém os registros dos *schemas*.
-     *
-     * @returns {Promise<void>} Promessa que é resolvida quando as chaves referentes aos *schemas* forem destruídas.
-     */
-    destroySchemasRecords(): Promise<void>;
-    /**
-     * Retorna o registro referente ao *schema* informado.
-     *
-     * @param {string} schemaName Nome do *schema*.
-     * @param {any} recordId Id do registro.
-     */
-    get(schemaName: string, recordId: any): Promise<object>;
-    /**
-     * Retorna todos os registros referente ao *schema* informado.
-     *
-     * @param {string} schemaName Nome do *schema*.
-     */
-    getAll(schemaName: string): Promise<Array<object>>;
-    /**
-     * Aguarda a liberação do recurso limitado, posteriormente o envolve em um comportamento
-     * de bloqueio e desbloqueio.
-     *
-     * @param {Function} limitedResource Função que será envolvida no comportamento de bloqueio e desbloqueio.
-     */
-    limitedCallWrap(limitedResource: Function): Promise<any>;
-    /**
-     * Remove um registro de um *schema* informado.
-     *
-     * @param {string} schemaName Nome do *schema*.
-     * @param {any} recordId Id do registro.
-     */
-    remove(schemaName: string, recordId: any): Promise<any>;
-    /**
-     * Atualiza um registro de um *schema* informado.
-     *
-     * @param {PoSyncSchema} schema **Schema* referente ao registro que será alterado.
-     * @param {object} record Registro que será atualizado.
-     * @param {any} recordId Id do registro que deseja ser alterado. Deve ser utilizado em casos em que o id foi alterado.
-     */
-    update(schema: PoSyncSchema, record: object, recordId?: any): Promise<object>;
-    /**
-     * Atualiza todos os registros de um *schema*.
-     *
-     * @param {PoSyncSchema} schema **Schema* referente aos registros que serão alterados.
-     * @param {Array<object>} records Lista de registros que serão alterados.
-     */
-    updateAll(schema: PoSyncSchema, records: Array<object>): Promise<void>;
-    private getRecord;
-    private save;
-    private saveLocalFields;
-    private updateRecordId;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PoSchemaService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PoSchemaService>;
-}

package/lib/services/po-sync/interfaces/po-sync-config.interface.d.ts

@@ -1,24 +0,0 @@
-import { PoDataTransform } from './../../../models/po-data-transform.model';
-import { PoNetworkType } from './../../../models/po-network-type.enum';
-/**
- * @usedBy PoSyncService
- *
- * @description
- *
- * Interface para a definição das configurações do sincronismo.
- */
-export interface PoSyncConfig {
-    /**
-     * Classe usada para a trasformação dos dados nas requisições.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Adaptando a resposta da API para o padrão do PO UI](/guides/sync-fundamentals).
-     */
-    dataTransform?: PoDataTransform;
-    /**
-     * Tempo em segundos do sicronismo periódico.
-     * Caso não seja definido, o sincronismo periódico estará desabilitado.
-     */
-    period?: number;
-    /** Tipos de conexões permitidas para o sincronismo. */
-    type: PoNetworkType | Array<PoNetworkType>;
-}

package/lib/services/po-sync/interfaces/po-sync-field-options.interface.d.ts

@@ -1,15 +0,0 @@
-/**
- * @usedBy PoSyncService
- *
- * @description
- *
- * Interface que irá mapear as configurações dos campos do `PoSyncSchema`.
- */
-export interface PoSyncFieldOptions {
-    /** Propriedade que informa o nome do campo. */
-    readonly name: string;
-    /** Propriedade que informa se o campo será apenas para armazenamento local
-     * ou se deve ser enviado para o servidor.
-     */
-    readonly local?: boolean;
-}

package/lib/services/po-sync/interfaces/po-sync-response.interface.d.ts

@@ -1,20 +0,0 @@
-import { HttpErrorResponse, HttpResponse } from '@angular/common/http';
-import { PoEventSourcingErrorResponse } from '../../../models/po-event-sourcing-error-response.model';
-import { PoHttpRequestData } from '../../po-http-client/interfaces/po-http-request-data.interface';
-/**
- * @usedBy PoSyncService
- *
- * @description
- *
- * Define a resposta dos eventos enviados ao servidor.
- */
-export interface PoSyncResponse {
-    /** Identificador do evento na fila. */
-    id: number;
-    /** Identificador customizado do registro. */
-    customRequestId?: string;
-    /** Dados da requisição. */
-    request: PoHttpRequestData;
-    /** Resposta retornada após a tentativa de envio para o servidor. */
-    response: HttpResponse<object> | HttpErrorResponse | PoEventSourcingErrorResponse;
-}

package/lib/services/po-sync/interfaces/po-sync-schema.interface.d.ts

@@ -1,37 +0,0 @@
-import { PoSyncFieldOptions } from './po-sync-field-options.interface';
-/**
- * @usedBy PoSyncService
- *
- * @description
- *
- * Interface que irá mapear as informações dos recursos, principalmente sua origem e as informações que serão retornadas.
- */
-export interface PoSyncSchema {
-    /** Nome da propriedade que informa a data de criação do registro. */
-    readonly createdAtField?: string;
-    /** Nome da propriedade que informa a data de deleção. */
-    readonly deletedAtField?: string;
-    /** Nome da propriedade que informa se o registro foi excluído. */
-    readonly deletedField: string;
-    /** Endereço do endpoint para excluir registros. */
-    readonly deleteUrlApi?: string;
-    /** Endereço do endpoint que proverá apenas dados alterados no servidor. */
-    readonly diffUrlApi: string;
-    /** Campos que serão retornados pela API. */
-    readonly fields: Array<string | PoSyncFieldOptions>;
-    /** Endereço do endpoint que utiliza o método GET que proverá os dados. */
-    readonly getUrlApi: string;
-    /** Nome da propriedade referente ao identificador único para os itens do *schema*. */
-    readonly idField: string;
-    /** Identifição para representar o *schema*. */
-    readonly name: string;
-    /** Quantidade de itens por página que será enviado pela API. */
-    readonly pageSize: number;
-    /** Endereço do endpoint que utiliza o método PUT para atualizar registros. */
-    readonly patchUrlApi?: string;
-    /** Endereço do endpoint que utiliza o método POST para incluir os registros. */
-    readonly postUrlApi?: string;
-    /** Nome da propriedade que informa a data de atualização do registro. */
-    readonly updatedAtField?: string;
-    lastSync?: string;
-}

package/lib/services/po-sync/po-sync.service.d.ts

@@ -1,162 +0,0 @@
-import { Observable } from 'rxjs';
-import { PoEntity } from '../../models';
-import { PoEventSourcingService } from '../po-event-sourcing/po-event-sourcing.service';
-import { PoHttpClientService } from '../po-http-client/po-http-client.service';
-import { PoHttpRequestData } from '../po-http-client/interfaces/po-http-request-data.interface';
-import { PoNetworkService } from '../po-network/po-network.service';
-import { PoSchemaDefinitionService } from './../po-schema/po-schema-definition/po-schema-definition.service';
-import { PoSchemaService } from './../po-schema/po-schema.service';
-import { PoSyncConfig } from './interfaces/po-sync-config.interface';
-import { PoSyncResponse } from '../po-sync/interfaces/po-sync-response.interface';
-import { PoSyncSchema } from './interfaces/po-sync-schema.interface';
-import * as i0 from "@angular/core";
-/**
- * @description
- *
- * O `PoSyncService` é utilizado para configurar toda a base de dados que receberá as informações que serão
- * armazenadas *offline* vindas do servidor. Nele ocorre toda a preparação dos modelos de dados retornados por
- * cada consulta.
- */
-export declare class PoSyncService {
-    private poEventSourcingService;
-    private poHttpClient;
-    private poNetworkService;
-    private poSchemaDefinitionService;
-    private poSchemaService;
-    models: Array<PoEntity>;
-    private config;
-    private emitter;
-    private eventSub;
-    private finishSyncSubject;
-    private isSyncEnabled;
-    private schemas;
-    private subscription;
-    private syncing;
-    private timer;
-    constructor(poEventSourcingService: PoEventSourcingService, poHttpClient: PoHttpClientService, poNetworkService: PoNetworkService, poSchemaDefinitionService: PoSchemaDefinitionService, poSchemaService: PoSchemaService);
-    /**
-     * Destrói todas as chaves do *storage* referentes ao `po-sync`, ou seja,
-     * as definições dos *schemas*, os registros de cada *schema* e a fila
-     * de eventos que estão para ser enviados ao servidor *(EventSourcing)*.
-     *
-     * > Para que não venham ocorrer erros em ações que dependam das definições dos *schemas*,
-     * recomenda-se utilizar o método `prepare()` em seguida.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Alterando as definições dos schemas](/guides/sync-fundamentals).
-     *
-     * @returns {Promise<any>} Promessa que é resolvida quando as chaves referentes ao `po-sync` forem destruídas.
-     */
-    destroy(): Promise<any>;
-    /**
-     * Desabilita todos os tipos de sincronização de dados (periódica, reativa e manual).
-     *
-     * > Para habilitar novamente a sincronização utilize o método [`PoSyncService.enableSync()`](documentation/po-sync#enable-sync).
-     */
-    disableSync(): void;
-    /**
-     * <a id="enable-sync"></a>
-     * Habilita todos os tipos de sincronização de dados (periódica, reativa e manual).
-     *
-     * Por padrão, sempre que se inicializa uma aplicação com PO Sync as sincronizações já estão habilitadas.
-     */
-    enableSync(): void;
-    /**
-     * Método que disponibiliza a partir de sua inscrição o evento de retorno das operações da fila de eventos que
-     * foram enviadas ao servidor. A cada operação enviada para o servidor, será disparado um evento para a inscrição
-     * deste método.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Capturando respostas da sincronização](/guides/sync-fundamentals).
-     *
-     * @returns {Observable<PoSyncResponse>} Observable com um objeto do tipo `PoSyncResponse`.
-     */
-    getResponses(): Observable<PoSyncResponse>;
-    /**
-     * Retorna uma instância de `PoEntity` para um determinado *schema*.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Manipulando os registros de um schema](/guides/sync-fundamentals).
-     *
-     * @param {string} schemaName Nome do *schema*.
-     * @returns {PoEntity} Objeto para efetuar consultas e alterações nos dados.
-     */
-    getModel(schemaName: string): PoEntity;
-    /**
-     * Insere uma requisição HTTP na fila de eventos do `po-sync`.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Inserindo requisições HTTP na fila de eventos](/guides/sync-fundamentals).
-     *
-     * @param {PoHttpRequestData} poHttpRequestData Dados da requisição HTTP.
-     * @param {string} customRequestId Identificador customizado da requisição HTTP.
-     * @returns {Promise<number>} Promessa com o identificador da requisição HTTP criada.
-     */
-    insertHttpCommand(requestData: PoHttpRequestData, customRequestId?: string): Promise<number>;
-    /**
-     * Efetua uma chamada na API do servidor para realizar a carga inicial dos dados. Deve ser chamado apenas uma vez
-     * na aplicação, após a preparação dos *schemas* realizada através do método `PoSyncService.prepare()`.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Carga inicial dos dados](/guides/sync-fundamentals).
-     *
-     * @returns {Observable<Array<{ entity: string, data: Array<any> }>>} Observable que notificará quando a
-     * carga inicial for concluída.
-     */
-    loadData(): Observable<Array<{
-        entity: string;
-        data: Array<any>;
-    }>>;
-    /**
-     * Responsável por notificar sempre que houver sincronismo.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Notificação pós-sincronização](/guides/sync-fundamentals).
-     *
-     * @returns {Observable<any>} Observable que é disparado a cada sincronismo realizado.
-     */
-    onSync(): Observable<any>;
-    /**
-     * Prepara a aplicação criando os schemas e aplica as configurações.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Preparando a aplicação](/guides/sync-fundamentals).
-     *
-     * @param {Array<PoSyncSchema>} schemas Lista de *schemas* a serem preparados.
-     * @param {PoSyncConfig} config Configurações adicionais.
-     * @returns {Promise<any>} Promessa que é resolvida quando a aplicação estiver preparada para a utilização do `po-sync`.
-     */
-    prepare(schemas: Array<PoSyncSchema>, config?: PoSyncConfig): Promise<any>;
-    /**
-     * Remove um item da fila de eventos que espera a sincronização.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Capturando respostas da sincronização](/guides/sync-fundamentals).
-     *
-     * @param {any} idEventSourcing Identificador do item da fila de eventos.
-     * @returns {Promise<any>} Promessa que é resolvida quando o item da fila de eventos é removido.
-     */
-    removeItemOfSync(idEventSourcing: any): Promise<any>;
-    /**
-     * Reenvia os comandos pendentes na fila (inclusão, alteração e exclusão) e busca novos dados do servidor.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Capturando respostas da sincronização](/guides/sync-fundamentals).
-     *
-     * @returns {Promise<any>} Promessa que resolve o sincronismo disparado.
-     */
-    resumeSync(): Promise<any>;
-    /**
-     * Dispara o sincronismo enviando os eventos pendentes (inclusão, alteração e exclusão) e buscando novos dados do servidor.
-     *
-     * O sincronismo somente será executado depois que o acesso a base de dados local do dispositivo for liberada.
-     *
-     * > Veja mais detalhes em [Fundamentos do PO Sync - Sincronização manual](/guides/sync-fundamentals).
-     *
-     * @returns {Promise<any>} Promessa que é resolvida quando o sincronismo for finalizado.
-     */
-    sync(): Promise<any>;
-    private canSync;
-    private createSubscribe;
-    private finishSync;
-    private getOnePage;
-    private loadEntityData;
-    private reactiveSync;
-    private saveSchemas;
-    private startSync;
-    private startTimer;
-    private syncError;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PoSyncService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PoSyncService>;
-}

package/lib/utils/utils.d.ts

@@ -1,36 +0,0 @@
-/**
- * Retorna um *array* contendo os pares `[chave, valor]` do objeto.
- *
- * Semelhante ao método `Object.entries()` nativo do javascript.
- *
- * > Veja mais em: https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Global_Objects/Object/entries
- *
- * @param object Objeto que será extraído os pares [chave, valor].
- */
-export declare const getObjectEntries: (object: object) => any[];
-/**
- * Recebe um objeto e valida se o seu valor é diferente de *undefined* ou *null*.
- *
- * @param {object} parameter Objeto contento o nome do parâmetro que está sendo validado
- * e o seu valor.
- */
-export declare const validateParameter: (parameter: object) => void;
-/**
- * Recebe um objeto e valida se o seu valor é uma instância de *Array* e se não
- * está vazio.
- *
- * @param value Objeto contento o nome da propriedade que está sendo validada e o seu valor.
- */
-export declare const validateArray: (value: object) => void;
-/**
- * Recebe um arquivo e converte para uma string base64
- *
- * @param Objeto do tipo file.
- */
-export declare const toBase64: (file: File) => Promise<string>;
-/**
- * Recebe uma string base64 e converte para um arquivo
- *
- * @param string base64.
- */
-export declare const toFile: (url: string, fileName: string, mimeType: string) => Promise<File>;

package/public-api.d.ts

@@ -1 +0,0 @@
-export * from './lib/index';