jsegd-fluig-types 1.0.30 → 1.0.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsegd-fluig-types",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "description": "Definições de tipos TypeScript para desenvolvimento na plataforma Fluig - Inclui APIs, SDK, datasets, workflows e webservices",
   "keywords": [
     "fluig",

package/types/fluig/fluig.api.d.ts

@@ -3,64 +3,64 @@
  * Endpoint: GET /v2/dataset-handle/search
  */
 declare global {
-  interface SearchDatasetValuesParams {
-    /**
-     * Dataset code to be used as a filter.
-     * (Obrigatório)
-     */
-    datasetId: string;
+    interface SearchDatasetValuesParams {
+        /**
+         * Dataset code to be used as a filter.
+         * (Obrigatório)
+         */
+        datasetId: string
 
-    /**
-     * Dataset fields that will be returned.
-     * Se não informado, todos os campos serão retornados.
-     */
-    field?: string[];
+        /**
+         * Dataset fields that will be returned.
+         * Se não informado, todos os campos serão retornados.
+         */
+        field?: string[]
 
-    /**
-     * Quantos registros serão ignorados antes de retornar os valores.
-     * Usado em conjunto com `limit` para paginação.
-     */
-    offset?: number;
+        /**
+         * Quantos registros serão ignorados antes de retornar os valores.
+         * Usado em conjunto com `limit` para paginação.
+         */
+        offset?: number
 
-    /**
-     * Número máximo de registros retornados.
-     * Padrão: 300. Use 0 para buscar todos (não recomendado).
-     */
-    limit?: number;
+        /**
+         * Número máximo de registros retornados.
+         * Padrão: 300. Use 0 para buscar todos (não recomendado).
+         */
+        limit?: number
 
-    /**
-     * Campo para ordenação dos resultados.
-     * Pode incluir "_ASC" ou "_DESC" para definir a ordem.
-     */
-    orderby?: string;
+        /**
+         * Campo para ordenação dos resultados.
+         * Pode incluir "_ASC" ou "_DESC" para definir a ordem.
+         */
+        orderby?: string
 
-    /**
-     * Nome dos campos usados como filtros (constraints).
-     * É possível informar vários campos.
-     */
-    constraintsField?: string[];
+        /**
+         * Nome dos campos usados como filtros (constraints).
+         * É possível informar vários campos.
+         */
+        constraintsField?: string[]
 
-    /**
-     * Valores iniciais usados para filtrar (mesma ordem de `constraintsField`).
-     */
-    constraintsInitialValue?: string[];
+        /**
+         * Valores iniciais usados para filtrar (mesma ordem de `constraintsField`).
+         */
+        constraintsInitialValue?: string[]
 
-    /**
-     * Valores finais usados para filtros por faixa (mesma ordem de `constraintsField`).
-     */
-    constraintsFinalValue?: string[];
+        /**
+         * Valores finais usados para filtros por faixa (mesma ordem de `constraintsField`).
+         */
+        constraintsFinalValue?: string[]
 
-    /**
-     * Tipo de restrição — valores permitidos: "MUST", "MUST_NOT", "SHOULD".
-     */
-    constraintsType?: ("MUST" | "MUST_NOT" | "SHOULD")[];
+        /**
+         * Tipo de restrição — valores permitidos: "MUST", "MUST_NOT", "SHOULD".
+         */
+        constraintsType?: ('MUST' | 'MUST_NOT' | 'SHOULD')[]
 
-    /**
-     * Define se a busca é parcial (LIKE) ou exata.
-     * true → aceita valores parciais (%)
-     * false → exige correspondência exata
-     */
-    constraintsLikeSearch?: boolean[];
-  }
+        /**
+         * Define se a busca é parcial (LIKE) ou exata.
+         * true → aceita valores parciais (%)
+         * false → exige correspondência exata
+         */
+        constraintsLikeSearch?: boolean[]
+    }
 }
-export {};
+export {}

package/types/fluig/fluig.backend.d.ts

@@ -90,7 +90,7 @@ declare global {
     function getValue(key: 'WKCompany'): string
     function getValue(key: 'WKUser'): string
     function getValue(key: 'WKUserComment'): string
-    function getValue(key: 'WKCompletTask'): boolean
+    function getValue(key: 'WKCompletTask'): string
     function getValue(key: 'WKNextState'): string
     function getValue(key: 'WKCardId'): string
     function getValue(key: 'WKFormId'): string
@@ -204,10 +204,10 @@ declare global {
     class customHTML {
         append(html: string): void
     }
-    export type DisplayFieldsHandler = (form: FormController, customHTML: customHTML) => void;
-    export type EnableFieldsHandler  = (form: FormController) => void;
-    export type InputFieldsHandler   = (form: FormController) => void;
-    export type ValidateFormHandler  = (form: FormController) => void;
+    export type DisplayFieldsHandler = (form: FormController, customHTML: customHTML) => void
+    export type EnableFieldsHandler = (form: FormController) => void
+    export type InputFieldsHandler = (form: FormController) => void
+    export type ValidateFormHandler = (form: FormController) => void
 
     // #########################################################################
     // ####################### Definição de Log ################################
@@ -226,11 +226,11 @@ declare global {
 
     // Mapeamento de classes Java comuns no Fluig
     interface ClassNameMap {
-        'java.util.ArrayList': java.util.ArrayList<any>
-        'java.util.HashMap': java.util.HashMap<any, any>
-        'java.util.List': java.util.List<any>
-        'java.util.Collection': java.util.Collection<any>
-        'java.util.Map': java.util.Map<any, any>
+        'java.util.ArrayList': java.util.ArrayList<unknown>
+        'java.util.HashMap': java.util.HashMap<unknown, unknown>
+        'java.util.List': java.util.List<unknown>
+        'java.util.Collection': java.util.Collection<unknown>
+        'java.util.Map': java.util.Map<unknown, unknown>
         'java.lang.String': java.lang.String
         'java.lang.Integer': java.lang.Integer
         'java.lang.Long': java.lang.Long
@@ -267,7 +267,7 @@ declare global {
              * workflowService.startProcess(...); // Métodos do ECMWorkflowEngineService disponíveis
              */
             instantiate<T extends keyof ClassNameMap>(className: T): ClassNameMap[T]
-            instantiate<T = any>(className: string): T
+            instantiate<T = unknown>(className: string): T
         }
     }
     /**

package/types/fluig/fluig.dataset.d.ts

@@ -1,201 +1,184 @@
 declare global {
-  enum DatasetFieldType {
-    NUMBER = "NUMBER",
-    DATE = "DATE",
-    BOOLEAN = "BOOLEAN",
-    STRING = "STRING",
-    TEXT = "TEXT",
-  }
-
-  enum ConstraintType {
-    MUST = 1,
-    SHOULD = 2,
-    MUST_NOT = 3,
-  }
-
-  interface SearchConstraintBase {
-    fieldName: string;
-    initialValue: string;
-    finalValue: string;
-    constraintType: ConstraintType;
-    likeSearch: boolean;
-  }
-
-  interface SearchConstraintBackend extends SearchConstraintBase {
-    setLikeSearch(likeSearch: boolean): void;
-  }
-
-  type SearchConstraint = typeof window extends undefined
-    ? SearchConstraintBackend
-    : SearchConstraintBase;
-
-  interface DatasetRequest {
-    name: string;
-    fields: string[];
-    constraints: SearchConstraint[];
-    order: string[];
-  }
-  interface ErrorDetail {
-    code: string;
-    message: string;
-    type?: "validation" | "business" | "system" | "network" | "auth";
-    details?: string;
-  }
-  interface DatasetResponseValues {
-    status: number;
-    message: string;
-    data?: unknown;
-    errors?: ErrorDetail[];
-    timestamp: number;
-  }
-  interface DatasetResponse {
-    response: DatasetResponseValues;
-  }
-
-  interface ServiceRequestParams {
-    serviceCode: string;
-    endpoint: string;
-    method?: string;
-    timeoutService?: string | number;
-    options?: Record<string, unknown>;
-    headers?: Record<string, string>;
-    params?: unknown;
-    strParams?: string;
-  }
-  interface DatasetWcmResult<T = unknown> {
-    columns: string[];
-    values: T[];
-  }
-
-  interface DatasetCallback {
-    success: (data: DatasetWcmResult) => void;
-    error?: (jqXHR?: any, textStatus?: string, errorThrown?: any) => void;
-  }
-
-  // Classe que representa um Dataset padrão do Fluig
-  class DefaultDataset {
-    rowsCount: number;
-    // Implementação para adicionar uma coluna ao Dataset
-    addColumn(colName: keyof DatasetResponse): void;
-    addColumn(colName: java.lang.String): void;
-
-    // Implementação para adicionar uma linha ao Dataset
-    addRow(values: DatasetResponse): void;
-    addRow(values: java.lang.Object[]): void;
-
-    // Implementação para atualizar uma linha do Dataset
-    updateRow(values: java.lang.Object[]): void;
-
-    // Implementação para adicionar ou atualizar uma linha do Dataset
-    addOrUpdateRow(values: java.lang.Object[]): void;
-
-    // Implementação para remover uma linha do Dataset
-    deleteRow(values: java.lang.Object[]): void;
-
-    // Implementação para retornar o nome de uma coluna do Dataset
-    getColumnName(colNum: number): java.lang.String;
-
-    // Implementação para retornar os nomes das colunas do Dataset
-    getColumnsName(): java.lang.String[];
-
-    // Implementação para retornar a quantidade de colunas de um Dataset
-    getColumnsCount(): number;
-
-    // Implementação para retornar os valores do Dataset na forma de uma lista contendo mapas
-    getMap(): java.util.ArrayList<
-      java.util.HashMap<java.lang.String, java.lang.Object>
-    >;
-
-    // Implementação para retornar a quantidade de linhas disponíveis no Dataset
-    getRowsCount(): number;
-
-    // Implementação para retornar um subconjunto dos dados do Dataset, na forma de um novo Dataset
-    getSubDataset(
-      field: java.lang.String,
-      value: java.lang.Object,
-    ): DefaultDataset;
-
-    // Implementação para retornar o valor armazenado no Dataset, na linha e coluna passadas por parâmetro
-    getValue(row: number, col: number): java.lang.Object;
-
-    // Implementação para retornar o valor armazenado no Dataset, na linha passada e campo passados por parâmetro
-    getValue(row: number, colName: java.lang.String): java.lang.Object;
-
-    // Implementação para retornar todos os valores de um Dataset, na forma de um array bidimensional
-    getValues(): java.lang.Object[][];
-
-    // Implementação para retornar um ResultSet contendo os dados do Dataset.
-    toResultSet(): java.sql.ResultSet;
-  }
-
-  // Cria uma nova instância do DatasetBuilder
-  class DatasetBuilder {
-    // Cria um novo Dataset
-    static newDataset(): DefaultDataset;
-  }
-
-  class DatasetFactory {
-    // backend
-    static createConstraint(
-      field: java.lang.String,
-      initialValue: java.lang.String,
-      finalValue: java.lang.String,
-      type: ConstraintType,
-    ): SearchConstraint;
-    // frontend
-    static createConstraint(
-      field: string,
-      initialValue: string,
-      finalValue: string,
-      type: ConstraintType,
-      likeSearch?: boolean,
-    ): SearchConstraint;
-
-    // backend
-    static getDataset(
-      name: java.lang.String,
-      fields: java.lang.String[],
-      constraints: SearchConstraint[],
-      order: java.lang.String[],
-    ): DefaultDataset;
-    // frontend
-    static getDataset(
-      name: string,
-      fields: string[],
-      constraints: SearchConstraint[],
-      order: string[],
-      callback?: DatasetCallback,
-    ): DatasetWcmResult<unknown>;
-
-    getAvailableDatasets(): java.util.List<java.lang.String>;
-  }
-
-  // Cria um campo na tabela com o nome e tipo informados. O nome sempre deve ser informado em caracteres maiúsculos. O tipo de campo pode ser omitido e neste caso o campo será criado com o tipo String
-  function AddColumn(field: java.lang.String, type: DatasetFieldType): void;
-
-  // Determina quais são os campos chaves para o dataset. No banco de dados será criado um índice utilizando os campos informados neste método. Esses campos serão utilizados na localização dos registros para atualização ou remoção das linhas através dos métodos updateRow e deleteRow. Importante informar apenas campos que foram previamente definidos com a função addColumn. Devem ser informados em caracteres maiúsculos.
-  function setKey(fields: java.lang.String[]): void;
-
-  // Permite adicionar mais índices para obtenção de maior performance nas consultas do dataset. Devem ser informados em caracteres maiúsculos.
-  function addIndex(fields: java.lang.String[]): void;
-
-  /**
-   * Define a estrutura do dataset.
-   * @example
-   * function defineStructure(): void{
-   *    AddColumn("NOME", DatasetFieldType.STRING);
-   *    AddColumn("IDADE", DatasetFieldType.NUMBER);
-   *    setKey(["NOME"]);
-   *    addIndex(["IDADE"]);
-   * };
-   */
-  function defineStructure(): void;
-  function onSync(lastSyncDate: Date): DefaultDataset;
-  function createDataset(
-    fields: string[],
-    constraints: SearchConstraint[],
-    sortFields: string[],
-  ): DefaultDataset;
-  function onMobileSync(user: string): void;
+    enum DatasetFieldType {
+        NUMBER = 'NUMBER',
+        DATE = 'DATE',
+        BOOLEAN = 'BOOLEAN',
+        STRING = 'STRING',
+        TEXT = 'TEXT',
+    }
+
+    enum ConstraintType {
+        MUST = 1,
+        SHOULD = 2,
+        MUST_NOT = 3,
+    }
+
+    interface SearchConstraintBase {
+        fieldName: string
+        initialValue: string
+        finalValue: string
+        constraintType: ConstraintType
+        likeSearch: boolean
+    }
+
+    interface SearchConstraintBackend extends SearchConstraintBase {
+        setLikeSearch(likeSearch: boolean): void
+    }
+
+    type SearchConstraint = typeof window extends undefined ? SearchConstraintBackend : SearchConstraintBase
+
+    interface DatasetRequest {
+        name: string
+        fields: string[]
+        constraints: SearchConstraint[]
+        order: string[]
+    }
+    interface ErrorDetail {
+        code: string
+        message: string
+        type?: 'validation' | 'business' | 'system' | 'network' | 'auth'
+        details?: string
+    }
+    interface DatasetResponseValues {
+        status: number
+        message: string
+        data?: unknown
+        errors?: ErrorDetail[]
+        timestamp: number
+    }
+    interface DatasetResponse {
+        response: DatasetResponseValues
+    }
+
+    interface ServiceRequestParams {
+        serviceCode: string
+        endpoint: string
+        method?: string
+        timeoutService?: string | number
+        options?: Record<string, unknown>
+        headers?: Record<string, string>
+        params?: unknown
+        strParams?: string
+    }
+    interface DatasetWcmResult<T = unknown> {
+        columns: string[]
+        values: T[]
+    }
+
+    interface DatasetCallback {
+        success: (data: DatasetWcmResult) => void
+        error?: (jqXHR?: unknown, textStatus?: string, errorThrown?: unknown) => void
+    }
+
+    // Classe que representa um Dataset padrão do Fluig
+    class DefaultDataset {
+        rowsCount: number
+        // Implementação para adicionar uma coluna ao Dataset
+        addColumn(colName: keyof DatasetResponse): void
+        addColumn(colName: java.lang.String): void
+
+        // Implementação para adicionar uma linha ao Dataset
+        addRow(values: DatasetResponse): void
+        addRow(values: java.lang.Object[]): void
+
+        // Implementação para atualizar uma linha do Dataset
+        updateRow(values: java.lang.Object[]): void
+
+        // Implementação para adicionar ou atualizar uma linha do Dataset
+        addOrUpdateRow(values: java.lang.Object[]): void
+
+        // Implementação para remover uma linha do Dataset
+        deleteRow(values: java.lang.Object[]): void
+
+        // Implementação para retornar o nome de uma coluna do Dataset
+        getColumnName(colNum: number): java.lang.String
+
+        // Implementação para retornar os nomes das colunas do Dataset
+        getColumnsName(): java.lang.String[]
+
+        // Implementação para retornar a quantidade de colunas de um Dataset
+        getColumnsCount(): number
+
+        // Implementação para retornar os valores do Dataset na forma de uma lista contendo mapas
+        getMap(): java.util.ArrayList<java.util.HashMap<java.lang.String, java.lang.Object>>
+
+        // Implementação para retornar a quantidade de linhas disponíveis no Dataset
+        getRowsCount(): number
+
+        // Implementação para retornar um subconjunto dos dados do Dataset, na forma de um novo Dataset
+        getSubDataset(field: java.lang.String, value: java.lang.Object): DefaultDataset
+
+        // Implementação para retornar o valor armazenado no Dataset, na linha e coluna passadas por parâmetro
+        getValue(row: number, col: number): java.lang.Object
+
+        // Implementação para retornar o valor armazenado no Dataset, na linha passada e campo passados por parâmetro
+        getValue(row: number, colName: java.lang.String): java.lang.Object
+
+        // Implementação para retornar todos os valores de um Dataset, na forma de um array bidimensional
+        getValues(): java.lang.Object[][]
+
+        // Implementação para retornar um ResultSet contendo os dados do Dataset.
+        toResultSet(): java.sql.ResultSet
+    }
+
+    // Cria uma nova instância do DatasetBuilder
+    class DatasetBuilder {
+        // Cria um novo Dataset
+        static newDataset(): DefaultDataset
+    }
+
+    class DatasetFactory {
+        // backend
+        static createConstraint(
+            field: java.lang.String,
+            initialValue: java.lang.String,
+            finalValue: java.lang.String,
+            type: ConstraintType
+        ): SearchConstraint
+        // frontend
+        static createConstraint(field: string, initialValue: string, finalValue: string, type: ConstraintType, likeSearch?: boolean): SearchConstraint
+
+        // backend
+        static getDataset(
+            name: java.lang.String,
+            fields: java.lang.String[],
+            constraints: SearchConstraint[],
+            order: java.lang.String[]
+        ): DefaultDataset
+        // frontend
+        static getDataset(
+            name: string,
+            fields: string[],
+            constraints: SearchConstraint[],
+            order: string[],
+            callback?: DatasetCallback
+        ): DatasetWcmResult<unknown>
+
+        getAvailableDatasets(): java.util.List<java.lang.String>
+    }
+
+    // Cria um campo na tabela com o nome e tipo informados. O nome sempre deve ser informado em caracteres maiúsculos. O tipo de campo pode ser omitido e neste caso o campo será criado com o tipo String
+    function AddColumn(field: java.lang.String, type: DatasetFieldType): void
+
+    // Determina quais são os campos chaves para o dataset. No banco de dados será criado um índice utilizando os campos informados neste método. Esses campos serão utilizados na localização dos registros para atualização ou remoção das linhas através dos métodos updateRow e deleteRow. Importante informar apenas campos que foram previamente definidos com a função addColumn. Devem ser informados em caracteres maiúsculos.
+    function setKey(fields: java.lang.String[]): void
+
+    // Permite adicionar mais índices para obtenção de maior performance nas consultas do dataset. Devem ser informados em caracteres maiúsculos.
+    function addIndex(fields: java.lang.String[]): void
+
+    /**
+     * Define a estrutura do dataset.
+     * @example
+     * function defineStructure(): void{
+     *    AddColumn("NOME", DatasetFieldType.STRING);
+     *    AddColumn("IDADE", DatasetFieldType.NUMBER);
+     *    setKey(["NOME"]);
+     *    addIndex(["IDADE"]);
+     * };
+     */
+    function defineStructure(): void
+    function onSync(lastSyncDate: Date): DefaultDataset
+    function createDataset(fields: string[], constraints: SearchConstraint[], sortFields: string[]): DefaultDataset
+    function onMobileSync(user: string): void
 }
-export {};
+export {}