jsegd-fluig-types 1.0.19 → 1.0.20

package/README.md

@@ -1,6 +1,6 @@
 # jsegd-fluig-types
 
-![Version](https://img.shields.io/badge/version-1.0.19-blue.svg)
+![Version](https://img.shields.io/badge/version-1.0.20-blue.svg)
 ![License](https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-green.svg)
 
 Pacote de tipos TypeScript para desenvolvimento com a plataforma Fluig. Este pacote fornece tipagens completas para APIs do Fluig, facilitando o desenvolvimento tanto no frontend quanto no backend, incluindo suporte para webservices e implementações duais de DatasetFactory.

package/fluig.api.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Parâmetros para a API Fluig - Dataset handle
+ * Endpoint: GET /v2/dataset-handle/search
+ */
+declare global {
+  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[];
+
+    /**
+     * 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;
+
+    /**
+     * 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[];
+
+    /**
+     * Valores iniciais usados para filtrar (mesma ordem de `constraintsField`).
+     */
+    constraintsInitialValue?: 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")[];
+
+    /**
+     * Define se a busca é parcial (LIKE) ou exata.
+     * true → aceita valores parciais (%)
+     * false → exige correspondência exata
+     */
+    constraintsLikeSearch?: boolean[];
+  }
+}
+export {};

package/index.d.ts

@@ -4,3 +4,4 @@ export * from "./fluig.frontend.d";
 export * from "./fluig.backend.d";
 export * from "./fluig.webservice.d";
 export * from "./fluig.dataset.d";
+export * from "./fluig.api.d";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsegd-fluig-types",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "Definições de tipos TypeScript para desenvolvimento na plataforma Fluig - Inclui APIs, SDK, datasets, workflows e webservices",
   "keywords": [
     "fluig",
@@ -21,7 +21,7 @@
   "homepage": "https://www.egd.tec.br/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/egd-tecnologia/jsegd-fluig-types.git"
+    "url": "git+https://github.com/egd-tecnologia/jsegd-fluig-types.git"
   },
   "bugs": {
     "url": "https://github.com/egd-tecnologia/jsegd-fluig-types/issues"
@@ -35,6 +35,7 @@
     "./sdk": "./fluig.sdk.d.ts",
     "./webservice": "./fluig.webservice.d.ts",
     "./dataset": "./fluig.dataset.d.ts",
+    "./api": "./fluig.api.d.ts",
     "./java": "./java.d.ts"
   },
   "typesVersions": {
@@ -58,7 +59,8 @@
     "fluig.backend.d.ts",
     "fluig.webservice.d.ts",
     "fluig.dataset.d.ts",
+    "fluig.api.d.ts",
     "java.d.ts",
     "README.md"
   ]
-}
+}