@epilot/kanban-client 0.1.1 → 0.1.3

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914: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 o=t(a(240));r.default=o.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/kanban/board":{"post":{"operationId":"createKanbanBoard","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/kanban/boards":{"get":{"operationId":"getKanbanBoards","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":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://kanban.sls.epilot.io"}]}')}},r={},a=function a(t){var o=r[t];if(void 0!==o)return o.exports;var n=r[t]={exports:{}};return e[t].call(n.exports,n,n.exports,a),n.exports}(914),t=exports;for(var o in a)t[o]=a[o];a.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914: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 o=t(a(240));r.default=o.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/kanban/board":{"post":{"operationId":"createKanbanBoard","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/kanban/boards":{"get":{"operationId":"getKanbanBoards","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":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}}},"/v1/kanban/query/flows:autocomplete":{"get":{"operationId":"flowsAutocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"size","in":"query"}],"responses":{}}},"/v1/kanban/query/flows:execute":{"post":{"operationId":"executeFlowsQuery","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{}}')}},r={},a=function a(t){var o=r[t];if(void 0!==o)return o.exports;var n=r[t]={exports:{}};return e[t].call(n.exports,n,n.exports,a),n.exports}(914),t=exports;for(var o in a)t[o]=a[o];a.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -61,12 +61,39 @@
         ],
         "responses": {}
       }
+    },
+    "/v1/kanban/query/flows:autocomplete": {
+      "get": {
+        "operationId": "flowsAutocomplete",
+        "parameters": [
+          {
+            "name": "input",
+            "in": "query"
+          },
+          {
+            "name": "attribute",
+            "in": "query",
+            "required": true
+          },
+          {
+            "name": "size",
+            "in": "query"
+          }
+        ],
+        "responses": {}
+      }
+    },
+    "/v1/kanban/query/flows:execute": {
+      "post": {
+        "operationId": "executeFlowsQuery",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
     }
   },
-  "components": {},
-  "servers": [
-    {
-      "url": "https://kanban.sls.epilot.io"
-    }
-  ]
+  "components": {}
 }

package/dist/openapi.d.ts

@@ -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,22 +72,64 @@ 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 FlowsQueryRequest {
+            filters?: BoardFilter;
+            sorting?: Sorting;
+            from?: number;
+            size?: number;
+        }
+        export interface FlowsQueryResult {
+            [name: string]: any;
+            results?: {
+                [name: string]: any;
+            }[];
+            hits?: number;
+        }
         export interface Sorting {
             /**
              * example:
-             * createdAt
+             * created_at
              */
             field: string;
             direction?: "asc" | "desc";
         }
         export interface Swimlane {
-            /**
-             * example:
-             * status
-             */
-            filter_field: string;
-            filter_values: string[];
-            id?: string; // uuid
+            id?: string;
             /**
              * example:
              * Swimlane 1
@@ -93,12 +140,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 +170,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 {
@@ -136,12 +188,51 @@ declare namespace Paths {
             }
         }
     }
+    namespace ExecuteFlowsQuery {
+        export type RequestBody = Components.Schemas.FlowsQueryRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.FlowsQueryResult;
+        }
+    }
+    namespace FlowsAutocomplete {
+        namespace Parameters {
+            /**
+             * example:
+             * name
+             */
+            export type Attribute = string;
+            export type Input = string;
+            export type Size = number;
+        }
+        export interface QueryParameters {
+            input?: Parameters.Input;
+            attribute: /**
+             * example:
+             * name
+             */
+            Parameters.Attribute;
+            size?: Parameters.Size;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * [
+                 *   "value"
+                 * ]
+                 */
+                results?: (string | boolean | {
+                    [name: string]: any;
+                })[];
+            }
+        }
+    }
     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 +259,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 {
@@ -242,6 +333,27 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
+  /**
+   * flowsAutocomplete - flowsAutocomplete
+   * 
+   * Autocomplete flows data
+   * 
+   */
+  'flowsAutocomplete'(
+    parameters?: Parameters<Paths.FlowsAutocomplete.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.FlowsAutocomplete.Responses.$200>
+  /**
+   * executeFlowsQuery - executeFlowsQuery
+   * 
+   * Query Flows Data for Kanban View.
+   */
+  'executeFlowsQuery'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.ExecuteFlowsQuery.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ExecuteFlowsQuery.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -301,6 +413,31 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
   }
+  ['/v1/kanban/query/flows:autocomplete']: {
+    /**
+     * flowsAutocomplete - flowsAutocomplete
+     * 
+     * Autocomplete flows data
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.FlowsAutocomplete.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.FlowsAutocomplete.Responses.$200>
+  }
+  ['/v1/kanban/query/flows:execute']: {
+    /**
+     * executeFlowsQuery - executeFlowsQuery
+     * 
+     * Query Flows Data for Kanban View.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.ExecuteFlowsQuery.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ExecuteFlowsQuery.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -309,5 +446,11 @@ 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 FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
+export type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
 export type Sorting = Components.Schemas.Sorting;
 export type Swimlane = Components.Schemas.Swimlane;
+export type ValueType = Components.Schemas.ValueType;

package/dist/openapi.json

@@ -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"
             }
           }
         ],
@@ -228,6 +225,112 @@
           }
         }
       }
+    },
+    "/v1/kanban/query/flows:autocomplete": {
+      "get": {
+        "operationId": "flowsAutocomplete",
+        "summary": "flowsAutocomplete",
+        "description": "Autocomplete flows data\n",
+        "tags": [
+          "Query"
+        ],
+        "parameters": [
+          {
+            "name": "input",
+            "in": "query",
+            "description": "Input to autocomplete",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "attribute",
+            "in": "query",
+            "description": "Autocomplete attribute",
+            "schema": {
+              "type": "string",
+              "example": "name"
+            },
+            "required": true
+          },
+          {
+            "name": "size",
+            "in": "query",
+            "description": "Maximum number of results to return",
+            "schema": {
+              "type": "integer",
+              "default": 25,
+              "minimum": 1,
+              "maximum": 250
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "boolean"
+                          },
+                          {
+                            "type": "object",
+                            "additionalProperties": true
+                          }
+                        ]
+                      },
+                      "example": [
+                        "value"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/kanban/query/flows:execute": {
+      "post": {
+        "operationId": "executeFlowsQuery",
+        "summary": "executeFlowsQuery",
+        "description": "Query Flows Data for Kanban View.",
+        "tags": [
+          "Query"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/FlowsQueryRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Query results",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FlowsQueryResult"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -237,12 +340,6 @@
         "scheme": "bearer",
         "description": "Authorization header with epilot OAuth2 bearer token",
         "bearerFormat": "JWT"
-      },
-      "EpilotPublicAuth": {
-        "type": "http",
-        "scheme": "bearer",
-        "description": "Authorization header with epilot public access token",
-        "bearerFormat": "JWT"
       }
     },
     "schemas": {
@@ -250,8 +347,7 @@
         "type": "object",
         "properties": {
           "id": {
-            "type": "string",
-            "format": "uuid"
+            "type": "string"
           },
           "title": {
             "type": "string",
@@ -316,14 +412,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,39 +433,34 @@
         ]
       },
       "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",
         "properties": {
           "field": {
             "type": "string",
-            "example": "createdAt"
+            "example": "created_at"
           },
           "direction": {
             "type": "string",
@@ -386,28 +478,181 @@
       "BoardFilter": {
         "type": "object",
         "properties": {
-          "filter_field": {
+          "items": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/FilterItem"
+                },
+                {
+                  "$ref": "#/components/schemas/FilterGroup"
+                }
+              ]
+            }
+          },
+          "combination": {
             "type": "string",
-            "example": "status"
+            "enum": [
+              "AND",
+              "OR"
+            ],
+            "example": "OR"
+          }
+        },
+        "required": [
+          "items",
+          "combination"
+        ]
+      },
+      "FilterGroup": {
+        "type": "object",
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$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"
           },
-          "filter_values": {
+          {
+            "type": "number",
+            "example": 42
+          },
+          {
+            "type": "boolean",
+            "example": true
+          },
+          {
             "type": "array",
             "items": {
-              "type": "string",
-              "example": "SKIPPED"
+              "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"
+      },
+      "FlowsQueryRequest": {
+        "type": "object",
+        "properties": {
+          "filters": {
+            "$ref": "#/components/schemas/BoardFilter"
+          },
+          "sorting": {
+            "$ref": "#/components/schemas/Sorting"
+          },
+          "from": {
+            "type": "number",
+            "default": 0
+          },
+          "size": {
+            "type": "number",
+            "default": 10
+          }
+        }
+      },
+      "FlowsQueryResult": {
+        "type": "object",
+        "properties": {
+          "results": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": true
             }
+          },
+          "hits": {
+            "type": "number"
+          }
+        },
+        "additionalProperties": true
+      },
+      "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"
         ]
       }
     }
-  },
-  "servers": [
-    {
-      "url": "https://kanban.sls.epilot.io"
-    }
-  ]
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/kanban-client",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Client library for epilot Kanban API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,13 +25,13 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/kanban.yaml",
+    "openapi": "node ../../scripts/update-openapi.js /Users/sureshs/workspace/kanban-api/lambda/ApiHandlerFunction/openapi.yml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > 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": "../../node_modules/eslint/bin/eslint.js src"
+    "lint": "pnpm exec eslint src"
   },
   "files": [
     "*.js",
@@ -53,7 +53,7 @@
     "@dazn/lambda-powertools-correlation-ids": "^1.28.1",
     "buffer": "^6.0.3",
     "https-browserify": "^1.0.0",
-    "openapi-client-axios": "^7.5.1",
+    "openapi-client-axios": "^7.6.0",
     "stream-http": "^3.1.1",
     "url": "^0.11.0",
     "util": "^0.12.3"
@@ -64,7 +64,7 @@
     "copy-webpack-plugin": "^7.0.0",
     "jest": "^26.6.3",
     "json-loader": "^0.5.7",
-    "openapicmd": "^2.6.2",
+    "openapicmd": "^2.7.0",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",