@po-ui/ng-sync 5.22.2 → 5.22.3

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

@@ -1,95 +1,95 @@
-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';
-/**
- * @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;
-}
+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';
+/**
+ * @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;
+}

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

@@ -1,24 +1,24 @@
-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>;
-}
+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 +1,15 @@
-/**
- * @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;
-}
+/**
+ * @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 +1,20 @@
-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;
-}
+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 +1,37 @@
-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;
-}
+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;
+}