@po-ui/ng-sync 5.22.2 → 5.22.3

package/lib/services/po-http-client/interfaces/po-response-api.interface.d.ts

@@ -1,14 +1,14 @@
-/**
- * @usedBy PoQueryBuilder
- *
- * @description
- *
- * Interface que representa a estrutura de resposta de uma coleção de itens.
- *
- */
-export interface PoResponseApi {
-    /** Lista de itens retornados. */
-    items: Array<object>;
-    /** Indica se existe uma próxima página com mais registros para aquela coleção de itens. */
-    hasNext: boolean;
-}
+/**
+ * @usedBy PoQueryBuilder
+ *
+ * @description
+ *
+ * Interface que representa a estrutura de resposta de uma coleção de itens.
+ *
+ */
+export interface PoResponseApi {
+    /** Lista de itens retornados. */
+    items: Array<object>;
+    /** Indica se existe uma próxima página com mais registros para aquela coleção de itens. */
+    hasNext: boolean;
+}

package/lib/services/po-http-client/po-http-client.service.d.ts

@@ -1,75 +1,75 @@
-import { HttpClient, HttpResponse } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { PoHttpHeaderOption } from './interfaces/po-http-header-option.interface';
-import { PoHttpRequestData } from './interfaces/po-http-request-data.interface';
-/**
- * @docsPrivate
- *
- * @description
- *
- * Serviço para execução de requisições HTTP.
- */
-export declare class PoHttpClientService {
-    private httpClient;
-    constructor(httpClient: HttpClient);
-    /**
-     * Constrói uma requisição HTTP personalizada.
-     *
-     * @param {PoHttpRequestData} poHttpOperationData Parâmetros para a construção
-     * da requisição.
-     */
-    createRequest(poHttpOperationData: PoHttpRequestData): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `delete`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    delete(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `get`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    get(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `head`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    head(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `options`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    options(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `patch`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {any} body Corpo da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    patch(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `post`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {any} body Corpo da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    post(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    /**
-     * Constrói uma requisição com o método `put`.
-     *
-     * @param {string} url URL da requisição.
-     * @param {any} body Corpo da requisição.
-     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
-     */
-    put(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
-    private createHttpHeaders;
-}
+import { HttpClient, HttpResponse } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { PoHttpHeaderOption } from './interfaces/po-http-header-option.interface';
+import { PoHttpRequestData } from './interfaces/po-http-request-data.interface';
+/**
+ * @docsPrivate
+ *
+ * @description
+ *
+ * Serviço para execução de requisições HTTP.
+ */
+export declare class PoHttpClientService {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Constrói uma requisição HTTP personalizada.
+     *
+     * @param {PoHttpRequestData} poHttpOperationData Parâmetros para a construção
+     * da requisição.
+     */
+    createRequest(poHttpOperationData: PoHttpRequestData): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `delete`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    delete(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `get`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    get(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `head`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    head(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `options`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    options(url: string, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `patch`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {any} body Corpo da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    patch(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `post`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {any} body Corpo da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    post(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    /**
+     * Constrói uma requisição com o método `put`.
+     *
+     * @param {string} url URL da requisição.
+     * @param {any} body Corpo da requisição.
+     * @param {Array<PoHeaderOption>} httpHeaders Cabeçalhos da requisição.
+     */
+    put(url: string, body?: any, httpHeaders?: Array<PoHttpHeaderOption>): Observable<HttpResponse<Object>>;
+    private createHttpHeaders;
+}

package/lib/services/po-http-client/po-http-request-type.enum.d.ts

@@ -1,23 +1,23 @@
-/**
- * @usedBy PoHttpClientService, PoHttpCommandResponse, PoSyncService
- *
- * @description
- *
- * Define o método de requisição HTTP.
- */
-export declare enum PoHttpRequestType {
-    /** Método `delete` do protocolo HTTP. */
-    DELETE = "DELETE",
-    /** Método `get` do protocolo HTTP. */
-    GET = "GET",
-    /** Método `head` do protocolo HTTP. */
-    HEAD = "HEAD",
-    /** Método `options` do protocolo HTTP. */
-    OPTIONS = "OPTIONS",
-    /** Método `patch` do protocolo HTTP. */
-    PATCH = "PATCH",
-    /** Método `post` do protocolo HTTP. */
-    POST = "POST",
-    /** Método `put` do protocolo HTTP. */
-    PUT = "PUT"
-}
+/**
+ * @usedBy PoHttpClientService, PoHttpCommandResponse, PoSyncService
+ *
+ * @description
+ *
+ * Define o método de requisição HTTP.
+ */
+export declare enum PoHttpRequestType {
+    /** Método `delete` do protocolo HTTP. */
+    DELETE = "DELETE",
+    /** Método `get` do protocolo HTTP. */
+    GET = "GET",
+    /** Método `head` do protocolo HTTP. */
+    HEAD = "HEAD",
+    /** Método `options` do protocolo HTTP. */
+    OPTIONS = "OPTIONS",
+    /** Método `patch` do protocolo HTTP. */
+    PATCH = "PATCH",
+    /** Método `post` do protocolo HTTP. */
+    POST = "POST",
+    /** Método `put` do protocolo HTTP. */
+    PUT = "PUT"
+}

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

@@ -1,33 +1,33 @@
-import { Observable } from 'rxjs';
-import { Network } from '@ionic-native/network/ngx';
-import { PoNetworkStatus } from './../../models';
-/**
- * @description
- *
- * O `PoNetworkService` é utilizado para verificar o status e o tipo da conexão de rede do dispositivo.
- */
-export declare class PoNetworkService {
-    private networkType;
-    private networkTypeNow;
-    private poNetworkStatus;
-    constructor(network: Network);
-    /**
-     * Retorna as propriedades tipo e status da conexão do dispositivo no momento da chamada.
-     *
-     * @returns {PoNetworkStatus} Instância de [PoNetworkStatus](/documentation/po-network-status) com as
-     * propriedades da conexão.
-     */
-    getConnectionStatus(): PoNetworkStatus;
-    /**
-     * Notifica as mudanças no tipo de conexão de rede do dispositivo.
-     *
-     * @returns {Observable<{ status: boolean, type: string }>} Observable com as propriedades da conexão.
-     */
-    onChange(): Observable<{
-        status: boolean;
-        type: string;
-    }>;
-    private getNavigatorStatus;
-    private initNetwork;
-    private initSubscriber;
-}
+import { Observable } from 'rxjs';
+import { Network } from '@ionic-native/network/ngx';
+import { PoNetworkStatus } from './../../models';
+/**
+ * @description
+ *
+ * O `PoNetworkService` é utilizado para verificar o status e o tipo da conexão de rede do dispositivo.
+ */
+export declare class PoNetworkService {
+    private networkType;
+    private networkTypeNow;
+    private poNetworkStatus;
+    constructor(network: Network);
+    /**
+     * Retorna as propriedades tipo e status da conexão do dispositivo no momento da chamada.
+     *
+     * @returns {PoNetworkStatus} Instância de [PoNetworkStatus](/documentation/po-network-status) com as
+     * propriedades da conexão.
+     */
+    getConnectionStatus(): PoNetworkStatus;
+    /**
+     * Notifica as mudanças no tipo de conexão de rede do dispositivo.
+     *
+     * @returns {Observable<{ status: boolean, type: string }>} Observable com as propriedades da conexão.
+     */
+    onChange(): Observable<{
+        status: boolean;
+        type: string;
+    }>;
+    private getNavigatorStatus;
+    private initNetwork;
+    private initSubscriber;
+}

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

@@ -1,3 +1,3 @@
-export * from './po-schema-definition/po-schema-definition.service';
-export * from './po-schema.service';
-export * from './po-schema-util/po-schema-util.model';
+export * from './po-schema-definition/po-schema-definition.service';
+export * from './po-schema.service';
+export * from './po-schema-util/po-schema-util.model';

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

@@ -1,48 +1,48 @@
-import { PoStorageService } from '@po-ui/ng-storage';
-import { PoSyncSchema } from './../../po-sync/interfaces/po-sync-schema.interface';
-/**
- * @docsPrivate
- *
- * @description
- *
- * Serviço que disponibiliza métodos que permite operar sobre as definições dos *schemas*.
- */
-export declare class PoSchemaDefinitionService {
-    private poStorage;
-    constructor(poStorage: PoStorageService);
-    /**
-     * Destrói a chave do *storage* que contém as definições dos *schemas*.
-     *
-     * > 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.
-     *
-     * @returns {Promise<void>} Promessa que é resolvida quando a chave referente as definições dos *schemas* for destruída.
-     */
-    destroy(): Promise<void>;
-    /**
-     * Busca um *schema* a partir do nome informado.
-     *
-     * @param {string} schemaName Nome do *schema*.
-     * @returns {Promise<PoSyncSchema>} Promessa que é resolvida quando o *schema* for retornado.
-     */
-    get(schemaName: string): Promise<PoSyncSchema>;
-    /**
-     * Retorna uma promessa com a lista dos *schemas* definidos.
-     *
-     * @returns {Promise<Array<PoSyncSchema>>} Promessa que é resolvida quando a lista dos *schemas* definidos for retornada.
-     */
-    getAll(): Promise<Array<PoSyncSchema>>;
-    /**
-     * Salva uma lista de *schemas*.
-     *
-     * @param {Array<PoSyncSchema>} schemas Lista de schemas que serão salvos.
-     * @returns {Promise<Array<PoSyncSchema>>} Promessa que é resolvida quando a lista de *schemas* for salva.
-     */
-    saveAll(schemas: Array<PoSyncSchema>): Promise<Array<PoSyncSchema>>;
-    /**
-     * Atualiza um *schema* a partir do *schema name*.
-     *
-     * @param {PoSyncSchema} updatedSchema **Schema* que será atualizado.
-     */
-    update(updatedSchema: PoSyncSchema): Promise<PoSyncSchema[]>;
-}
+import { PoStorageService } from '@po-ui/ng-storage';
+import { PoSyncSchema } from './../../po-sync/interfaces/po-sync-schema.interface';
+/**
+ * @docsPrivate
+ *
+ * @description
+ *
+ * Serviço que disponibiliza métodos que permite operar sobre as definições dos *schemas*.
+ */
+export declare class PoSchemaDefinitionService {
+    private poStorage;
+    constructor(poStorage: PoStorageService);
+    /**
+     * Destrói a chave do *storage* que contém as definições dos *schemas*.
+     *
+     * > 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.
+     *
+     * @returns {Promise<void>} Promessa que é resolvida quando a chave referente as definições dos *schemas* for destruída.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Busca um *schema* a partir do nome informado.
+     *
+     * @param {string} schemaName Nome do *schema*.
+     * @returns {Promise<PoSyncSchema>} Promessa que é resolvida quando o *schema* for retornado.
+     */
+    get(schemaName: string): Promise<PoSyncSchema>;
+    /**
+     * Retorna uma promessa com a lista dos *schemas* definidos.
+     *
+     * @returns {Promise<Array<PoSyncSchema>>} Promessa que é resolvida quando a lista dos *schemas* definidos for retornada.
+     */
+    getAll(): Promise<Array<PoSyncSchema>>;
+    /**
+     * Salva uma lista de *schemas*.
+     *
+     * @param {Array<PoSyncSchema>} schemas Lista de schemas que serão salvos.
+     * @returns {Promise<Array<PoSyncSchema>>} Promessa que é resolvida quando a lista de *schemas* for salva.
+     */
+    saveAll(schemas: Array<PoSyncSchema>): Promise<Array<PoSyncSchema>>;
+    /**
+     * Atualiza um *schema* a partir do *schema name*.
+     *
+     * @param {PoSyncSchema} updatedSchema **Schema* que será atualizado.
+     */
+    update(updatedSchema: PoSyncSchema): Promise<PoSyncSchema[]>;
+}

package/lib/services/po-schema/po-schema-util/po-schema-util.model.d.ts

@@ -1,79 +1,79 @@
-import { PoRequestType } from '../../../models/po-request-type.enum';
-import { PoSyncSchema } from '../../po-sync/interfaces/po-sync-schema.interface';
-/**
- * @docsPrivate
- *
- * @description
- *
- * Serviço utilitário para operações no PoSyncSchema.
- */
-export declare class PoSchemaUtil {
-    /** Valor `default` para o campo `lastSync`. */
-    static readonly defaultLastSync: string;
-    /** Nome da chave do identificador interno do sync. */
-    static readonly syncInternalIdFieldName: string;
-    /** Nome da chave no `storage` para os Schemas. */
-    static readonly syncSchemasName: string;
-    /**
-     * Verica se existem campos locais no *schema* informado.
-     *
-     * @param {PoSyncSchema} schema **Schema* a ser processado.
-     *
-     * @returns {boolean} Valor do tipo *boolean* que indica se existem campos locais no *schema* informado.
-     */
-    static containsLocalFields(schema: PoSyncSchema): boolean;
-    /**
-     * Retorna o valor atual do `lastSync` para determinado *schema*.
-     *
-     * @param {Array<PoSyncSchema>} storageSchemas Lista de *schemas* a serem pesquisados.
-     * @param {string} schemaName Nome do *schema* que se deseja ler o lastSync.
-     *
-     * @returns {string} Retorna uma *string* com o valor da última sincronização.
-     */
-    static getLastSync(storageSchemas: Array<PoSyncSchema>, schemaName: string): string;
-    /**
-     * Retorna a lista de campos locais definidos no *schema*.
-     *
-     * @param {PoSyncSchema} schema **Schema* a ser processado.
-     */
-    static getLocalFieldNames(schema: PoSyncSchema): Array<string>;
-    /**
-     * Retorna a lista de campos não locais definidos no *schema*.
-     *
-     * @param {PoSyncSchema} schema **Schema* a ser processado.
-     */
-    static getNonLocalFieldNames(schema: PoSyncSchema): Array<string>;
-    /**
-     * Retorna o `id` referente ao registro do *schema* informado.
-     *
-     * @param {object} record Registro que será buscado o id.
-     * @param {PoSyncSchema} schema **Schema* a ser processado.
-     */
-    static getRecordId(record: object, schema: PoSyncSchema): any;
-    /**
-     * Retorna a url correspondente do `PoSyncSchema` dependendo do tipo da requisição `PoRequestType`.
-     *
-     * @param {PoSyncSchema} schema **Schema* a ser processado.
-     * @param {PoRequestType} requestType Tipo da requisição.
-     */
-    static getUrl(schema: PoSyncSchema, requestType: PoRequestType): string;
-    /**
-     * Compara se dois objetos são iguais baseado na lista de campos.
-     *
-     * @param {Array<string>} fields Lista de campos a serem considerados na comparação.
-     * @param {any} model1 Objeto 1 a ser comparado.
-     * @param {any} model2 Objeto 2 a ser comparado.
-     */
-    static isModelsEqual(fields: Array<string>, model1: any, model2: any): boolean;
-    /**
-     * Retorna uma lista com dois objetos referentes ao registro informado.
-     * O primeiro é o registro com os campos que vão para o servidor e o segundo é com os campos locais.
-     *
-     * @param {PoSyncSchema} schema **Schema* do registro.
-     * @param {object} record Registro que será realizada a separação dos campos locais e do servidor.
-     */
-    static separateSchemaFields(schema: PoSyncSchema, record: object): {
-        serverRecord: object;
-        localRecord: object;
-    };
-}
+import { PoRequestType } from '../../../models/po-request-type.enum';
+import { PoSyncSchema } from '../../po-sync/interfaces/po-sync-schema.interface';
+/**
+ * @docsPrivate
+ *
+ * @description
+ *
+ * Serviço utilitário para operações no PoSyncSchema.
+ */
+export declare class PoSchemaUtil {
+    /** Valor `default` para o campo `lastSync`. */
+    static readonly defaultLastSync: string;
+    /** Nome da chave do identificador interno do sync. */
+    static readonly syncInternalIdFieldName: string;
+    /** Nome da chave no `storage` para os Schemas. */
+    static readonly syncSchemasName: string;
+    /**
+     * Verica se existem campos locais no *schema* informado.
+     *
+     * @param {PoSyncSchema} schema **Schema* a ser processado.
+     *
+     * @returns {boolean} Valor do tipo *boolean* que indica se existem campos locais no *schema* informado.
+     */
+    static containsLocalFields(schema: PoSyncSchema): boolean;
+    /**
+     * Retorna o valor atual do `lastSync` para determinado *schema*.
+     *
+     * @param {Array<PoSyncSchema>} storageSchemas Lista de *schemas* a serem pesquisados.
+     * @param {string} schemaName Nome do *schema* que se deseja ler o lastSync.
+     *
+     * @returns {string} Retorna uma *string* com o valor da última sincronização.
+     */
+    static getLastSync(storageSchemas: Array<PoSyncSchema>, schemaName: string): string;
+    /**
+     * Retorna a lista de campos locais definidos no *schema*.
+     *
+     * @param {PoSyncSchema} schema **Schema* a ser processado.
+     */
+    static getLocalFieldNames(schema: PoSyncSchema): Array<string>;
+    /**
+     * Retorna a lista de campos não locais definidos no *schema*.
+     *
+     * @param {PoSyncSchema} schema **Schema* a ser processado.
+     */
+    static getNonLocalFieldNames(schema: PoSyncSchema): Array<string>;
+    /**
+     * Retorna o `id` referente ao registro do *schema* informado.
+     *
+     * @param {object} record Registro que será buscado o id.
+     * @param {PoSyncSchema} schema **Schema* a ser processado.
+     */
+    static getRecordId(record: object, schema: PoSyncSchema): any;
+    /**
+     * Retorna a url correspondente do `PoSyncSchema` dependendo do tipo da requisição `PoRequestType`.
+     *
+     * @param {PoSyncSchema} schema **Schema* a ser processado.
+     * @param {PoRequestType} requestType Tipo da requisição.
+     */
+    static getUrl(schema: PoSyncSchema, requestType: PoRequestType): string;
+    /**
+     * Compara se dois objetos são iguais baseado na lista de campos.
+     *
+     * @param {Array<string>} fields Lista de campos a serem considerados na comparação.
+     * @param {any} model1 Objeto 1 a ser comparado.
+     * @param {any} model2 Objeto 2 a ser comparado.
+     */
+    static isModelsEqual(fields: Array<string>, model1: any, model2: any): boolean;
+    /**
+     * Retorna uma lista com dois objetos referentes ao registro informado.
+     * O primeiro é o registro com os campos que vão para o servidor e o segundo é com os campos locais.
+     *
+     * @param {PoSyncSchema} schema **Schema* do registro.
+     * @param {object} record Registro que será realizada a separação dos campos locais e do servidor.
+     */
+    static separateSchemaFields(schema: PoSyncSchema, record: object): {
+        serverRecord: object;
+        localRecord: object;
+    };
+}