@epilot/kanban-client 1.2.1-0 → 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 epilot GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={390:function(e,r,a){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(a(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/kanban/board":{"post":{"operationId":"createKanbanBoard","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/kanban/boards":{"get":{"operationId":"getKanbanBoards","parameters":[{"name":"filter","in":"query","required":false}],"responses":{}}},"/v1/kanban/board/{boardId}":{"get":{"operationId":"getKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}}},"/v1/kanban/org/default-board":{"put":{"operationId":"setDefaultKanbanBoard","parameters":[{"name":"boardId","in":"query","required":true}],"responses":{}},"delete":{"operationId":"clearDefaultKanbanBoard","responses":{}}},"/v1/kanban/query/flows:autocomplete":{"get":{"operationId":"flowsAutocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}}},"/v1/kanban/query/flows:execute":{"post":{"operationId":"executeFlowsQuery","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{},"servers":[{"url":"https://kanban.sls.epilot.io"}]}')}},r={},a=function a(t){var n=r[t];if(void 0!==n)return n.exports;var o=r[t]={exports:{}};return e[t].call(o.exports,o,o.exports,a),o.exports}(390),t=exports;for(var n in a)t[n]=a[n];a.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={330(e,r,a){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(a(466));r.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/kanban/board":{"post":{"operationId":"createKanbanBoard","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/kanban/boards":{"get":{"operationId":"getKanbanBoards","parameters":[{"name":"filter","in":"query","required":false}],"responses":{}}},"/v1/kanban/board/{boardId}":{"get":{"operationId":"getKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}}},"/v1/kanban/org/default-board":{"put":{"operationId":"setDefaultKanbanBoard","parameters":[{"name":"boardId","in":"query","required":true}],"responses":{}},"delete":{"operationId":"clearDefaultKanbanBoard","responses":{}}},"/v1/kanban/query/flows:autocomplete":{"get":{"operationId":"flowsAutocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}}},"/v1/kanban/query/flows:execute":{"post":{"operationId":"executeFlowsQuery","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{},"servers":[{"url":"https://kanban.sls.epilot.io"}]}')}},r={},a=function a(t){var n=r[t];if(void 0!==n)return n.exports;var o=r[t]={exports:{}};return e[t].call(o.exports,o,o.exports,a),o.exports}(330),t=exports;for(var n in a)t[n]=a[n];a.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();

package/dist/openapi.d.ts

@@ -46,6 +46,7 @@ declare namespace Components {
                 };
                 board_filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
                 sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+                group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
                 /**
                  * example:
                  * task 1
@@ -148,7 +149,7 @@ declare namespace Components {
          */
         export type FilterOperator = "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL";
         /**
-         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination.
+         * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.
          */
         export interface FlowsQueryRequest {
             /**
@@ -159,6 +160,10 @@ declare namespace Components {
              * Sort the results by a specific field and direction.
              */
             sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
+            /**
+             * Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set.
+             */
+            group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
             /**
              * Zero-based offset for pagination. Use with `size` to paginate through results.
              * example:
@@ -208,6 +213,15 @@ declare namespace Components {
              */
             total_pages?: number;
         }
+        /**
+         * Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.
+         */
+        export interface GroupBy {
+            /**
+             * Property to group tasks by within each swimlane
+             */
+            field: "context_entity" | "phase";
+        }
         /**
          * Defines how query results should be sorted. Specify a field name and sort direction.
          */
@@ -286,7 +300,7 @@ declare namespace Paths {
         }
     }
     namespace ExecuteFlowsQuery {
-        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
+        export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
         namespace Responses {
             export type $200 = /* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration. */ Components.Schemas.FlowsQueryResult;
             export type $400 = /* Standard error response */ Components.Schemas.Error;
@@ -741,6 +755,7 @@ export type FilterItem = Components.Schemas.FilterItem;
 export type FilterOperator = Components.Schemas.FilterOperator;
 export type FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
 export type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
+export type GroupBy = Components.Schemas.GroupBy;
 export type Sorting = Components.Schemas.Sorting;
 export type Swimlane = Components.Schemas.Swimlane;
 export type ValueType = Components.Schemas.ValueType;

package/dist/openapi.json

@@ -1184,6 +1184,9 @@
                   "sorting": {
                     "$ref": "#/components/schemas/Sorting"
                   },
+                  "group_by": {
+                    "$ref": "#/components/schemas/GroupBy"
+                  },
                   "search_query": {
                     "type": "string",
                     "example": "task 1"
@@ -1243,6 +1246,23 @@
           "field"
         ]
       },
+      "GroupBy": {
+        "type": "object",
+        "description": "Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.",
+        "required": [
+          "field"
+        ],
+        "properties": {
+          "field": {
+            "type": "string",
+            "enum": [
+              "context_entity",
+              "phase"
+            ],
+            "description": "Property to group tasks by within each swimlane"
+          }
+        }
+      },
       "BoardFilter": {
         "type": "object",
         "description": "A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR).",
@@ -1381,7 +1401,7 @@
       },
       "FlowsQueryRequest": {
         "type": "object",
-        "description": "Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, and offset-based pagination.",
+        "description": "Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.",
         "properties": {
           "filters": {
             "$ref": "#/components/schemas/BoardFilter",
@@ -1391,6 +1411,10 @@
             "$ref": "#/components/schemas/Sorting",
             "description": "Sort the results by a specific field and direction."
           },
+          "group_by": {
+            "$ref": "#/components/schemas/GroupBy",
+            "description": "Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set."
+          },
           "from": {
             "type": "number",
             "default": 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/kanban-client",
-  "version": "1.2.1-0",
+  "version": "1.4.0",
   "description": "Client library for epilot Kanban API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,18 +21,6 @@
     "sdk",
     "kanban"
   ],
-  "scripts": {
-    "test": "vitest",
-    "typescript": "tsc",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/kanban.yaml",
-    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
-    "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
-    "build:watch": "npm run build && tsc -w",
-    "prepublishOnly": "npm run typegen && npm run build",
-    "lint": "biome check src"
-  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -68,5 +56,16 @@
     "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
+  },
+  "scripts": {
+    "test": "vitest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/kanban.yaml",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:watch": "npm run build && tsc -w",
+    "lint": "biome check src"
   }
-}
+}