npm - @epilot/kanban-client - Versions diffs - 0.1.1 → 0.1.2-0 - Mend

@epilot/kanban-client 0.1.1 → 0.1.2-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/openapi.d.ts CHANGED Viewed

@@ -11,7 +11,7 @@ import type {
 declare namespace Components {
     namespace Schemas {
         export interface Board {
-            id?: string; // uuid
+            id?: string;
             /**
              * example:
              * Board 1
@@ -37,20 +37,25 @@ declare namespace Components {
                 card_config?: {
                     fields?: string[];
                 };
-                board_filters?: BoardFilter[];
+                board_filter?: BoardFilter;
                 sorting?: Sorting;
+                /**
+                 * example:
+                 * task 1
+                 */
+                search_query?: string;
             };
         }
         export interface BoardFilter {
+            items: (FilterItem | FilterGroup)[];
             /**
              * example:
-             * status
+             * OR
              */
-            filter_field: string;
-            filter_values: string[];
+            combination: "AND" | "OR";
         }
         export interface BoardSummary {
-            id?: string; // uuid
+            id?: string;
             /**
              * example:
              * Board 1
@@ -67,6 +72,41 @@ declare namespace Components {
             updated_by?: string;
             shared_with?: string[];
         }
+        export interface FilterGroup {
+            items: FilterItem[];
+            /**
+             * example:
+             * AND
+             */
+            combination: "AND" | "OR";
+        }
+        export interface FilterItem {
+            /**
+             * The field key to filter on
+             * example:
+             * assignee
+             */
+            key: string;
+            operator: /**
+             * The comparison operator for filtering
+             * example:
+             * EQUALS
+             */
+            FilterOperator;
+            value: /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ ValueType;
+            /**
+             * The data type of the field
+             * example:
+             * string
+             */
+            data_type?: "string" | "number" | "boolean" | "date";
+        }
+        /**
+         * The comparison operator for filtering
+         * example:
+         * EQUALS
+         */
+        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";
         export interface Sorting {
             /**
              * example:
@@ -76,13 +116,7 @@ declare namespace Components {
             direction?: "asc" | "desc";
         }
         export interface Swimlane {
-            /**
-             * example:
-             * status
-             */
-            filter_field: string;
-            filter_values: string[];
-            id?: string; // uuid
+            id?: string;
             /**
              * example:
              * Swimlane 1
@@ -93,12 +127,17 @@ declare namespace Components {
              * 1
              */
             position?: number;
+            filter?: BoardFilter;
             /**
              * example:
              * success
              */
             title_chip_variant?: string;
         }
+        /**
+         * The value to compare against - can be a single value (string, number, boolean) or an array of values
+         */
+        export type ValueType = /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ string | number | boolean | (string | number | boolean)[];
     }
 }
 declare namespace Paths {
@@ -118,10 +157,10 @@ declare namespace Paths {
     }
     namespace DeleteKanbanBoard {
         namespace Parameters {
-            export type BoardId = string; // uuid
+            export type BoardId = string;
         }
         export interface PathParameters {
-            boardId: Parameters.BoardId /* uuid */;
+            boardId: Parameters.BoardId;
         }
         namespace Responses {
             export interface $200 {
@@ -138,10 +177,10 @@ declare namespace Paths {
     }
     namespace GetKanbanBoard {
         namespace Parameters {
-            export type BoardId = string; // uuid
+            export type BoardId = string;
         }
         export interface PathParameters {
-            boardId: Parameters.BoardId /* uuid */;
+            boardId: Parameters.BoardId;
         }
         namespace Responses {
             export type $200 = Components.Schemas.Board;
@@ -168,10 +207,10 @@ declare namespace Paths {
     }
     namespace UpdateKanbanBoard {
         namespace Parameters {
-            export type BoardId = string; // uuid
+            export type BoardId = string;
         }
         export interface PathParameters {
-            boardId: Parameters.BoardId /* uuid */;
+            boardId: Parameters.BoardId;
         }
         export type RequestBody = Components.Schemas.Board;
         namespace Responses {
@@ -309,5 +348,9 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 export type Board = Components.Schemas.Board;
 export type BoardFilter = Components.Schemas.BoardFilter;
 export type BoardSummary = Components.Schemas.BoardSummary;
+export type FilterGroup = Components.Schemas.FilterGroup;
+export type FilterItem = Components.Schemas.FilterItem;
+export type FilterOperator = Components.Schemas.FilterOperator;
 export type Sorting = Components.Schemas.Sorting;
 export type Swimlane = Components.Schemas.Swimlane;
+export type ValueType = Components.Schemas.ValueType;

package/dist/openapi.json CHANGED Viewed

@@ -107,8 +107,7 @@
             "in": "path",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           }
         ],
@@ -150,8 +149,7 @@
             "in": "path",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           }
         ],
@@ -205,8 +203,7 @@
             "in": "path",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           }
         ],
@@ -250,8 +247,7 @@
         "type": "object",
         "properties": {
           "id": {
-            "type": "string",
-            "format": "uuid"
+            "type": "string"
           },
           "title": {
             "type": "string",
@@ -316,14 +312,15 @@
                       }
                     }
                   },
-                  "board_filters": {
-                    "type": "array",
-                    "items": {
-                      "$ref": "#/components/schemas/BoardFilter"
-                    }
+                  "board_filter": {
+                    "$ref": "#/components/schemas/BoardFilter"
                   },
                   "sorting": {
                     "$ref": "#/components/schemas/Sorting"
+                  },
+                  "search_query": {
+                    "type": "string",
+                    "example": "task 1"
                   }
                 }
               }
@@ -336,32 +333,27 @@
         ]
       },
       "Swimlane": {
-        "allOf": [
-          {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string",
+            "example": "Swimlane 1"
+          },
+          "position": {
+            "type": "number",
+            "example": 1
+          },
+          "filter": {
             "$ref": "#/components/schemas/BoardFilter"
           },
-          {
-            "type": "object",
-            "properties": {
-              "id": {
-                "type": "string",
-                "format": "uuid"
-              },
-              "title": {
-                "type": "string",
-                "example": "Swimlane 1"
-              },
-              "position": {
-                "type": "number",
-                "example": 1
-              },
-              "title_chip_variant": {
-                "type": "string",
-                "example": "success"
-              }
-            }
+          "title_chip_variant": {
+            "type": "string",
+            "example": "success"
           }
-        ]
+        }
       },
       "Sorting": {
         "type": "object",
@@ -386,21 +378,144 @@
       "BoardFilter": {
         "type": "object",
         "properties": {
-          "filter_field": {
-            "type": "string",
-            "example": "status"
+          "items": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/FilterItem"
+                },
+                {
+                  "$ref": "#/components/schemas/FilterGroup"
+                }
+              ]
+            }
           },
-          "filter_values": {
+          "combination": {
+            "type": "string",
+            "enum": [
+              "AND",
+              "OR"
+            ],
+            "example": "OR"
+          }
+        },
+        "required": [
+          "items",
+          "combination"
+        ]
+      },
+      "FilterGroup": {
+        "type": "object",
+        "properties": {
+          "items": {
             "type": "array",
             "items": {
-              "type": "string",
-              "example": "SKIPPED"
+              "$ref": "#/components/schemas/FilterItem"
             }
+          },
+          "combination": {
+            "type": "string",
+            "enum": [
+              "AND",
+              "OR"
+            ],
+            "example": "AND"
+          }
+        },
+        "required": [
+          "items",
+          "combination"
+        ]
+      },
+      "FilterOperator": {
+        "type": "string",
+        "enum": [
+          "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"
+        ],
+        "example": "EQUALS",
+        "description": "The comparison operator for filtering"
+      },
+      "ValueType": {
+        "oneOf": [
+          {
+            "type": "string",
+            "example": "100020"
+          },
+          {
+            "type": "number",
+            "example": 42
+          },
+          {
+            "type": "boolean",
+            "example": true
+          },
+          {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                }
+              ]
+            },
+            "example": [
+              "value1",
+              "value2",
+              123,
+              true
+            ]
+          }
+        ],
+        "description": "The value to compare against - can be a single value (string, number, boolean) or an array of values"
+      },
+      "FilterItem": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "example": "assignee",
+            "description": "The field key to filter on"
+          },
+          "operator": {
+            "$ref": "#/components/schemas/FilterOperator"
+          },
+          "value": {
+            "$ref": "#/components/schemas/ValueType"
+          },
+          "data_type": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "boolean",
+              "date"
+            ],
+            "example": "string",
+            "description": "The data type of the field"
           }
         },
         "required": [
-          "filter_field",
-          "filter_values"
+          "key",
+          "operator",
+          "value"
         ]
       }
     }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/kanban-client",
-  "version": "0.1.1",
+  "version": "0.1.2-0",
   "description": "Client library for epilot Kanban API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",