@epilot/kanban-client 0.1.2-0 → 0.1.4-0

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":{}},"patch":{"operationId":"patchKanbanBoard","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":{},"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})})();

package/dist/openapi-runtime.json

@@ -50,6 +50,22 @@
         },
         "responses": {}
       },
+      "patch": {
+        "operationId": "patchKanbanBoard",
+        "parameters": [
+          {
+            "name": "boardId",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      },
       "delete": {
         "operationId": "deleteKanbanBoard",
         "parameters": [
@@ -61,6 +77,38 @@
         ],
         "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": {},

package/dist/openapi.d.ts

@@ -25,8 +25,10 @@ declare namespace Components {
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: string;
+            org_id?: string;
             updated_by?: string;
             shared_with?: string[];
+            shared_with_org?: boolean;
             config: {
                 /**
                  * example:
@@ -69,8 +71,10 @@ declare namespace Components {
             created_at?: string; // date-time
             updated_at?: string; // date-time
             created_by?: string;
+            org_id?: string;
             updated_by?: string;
             shared_with?: string[];
+            shared_with_org?: boolean;
         }
         export interface FilterGroup {
             items: FilterItem[];
@@ -93,7 +97,7 @@ declare namespace Components {
              * EQUALS
              */
             FilterOperator;
-            value: /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ ValueType;
+            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:
@@ -107,10 +111,26 @@ declare namespace Components {
          * 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;
+            page_number?: number;
+            page_size?: number;
+            total_pages?: number;
+        }
         export interface Sorting {
             /**
              * example:
-             * createdAt
+             * created_at
              */
             field: string;
             direction?: "asc" | "desc";
@@ -175,6 +195,45 @@ 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;
@@ -205,6 +264,41 @@ declare namespace Paths {
             }
         }
     }
+    namespace PatchKanbanBoard {
+        namespace Parameters {
+            export type BoardId = string;
+        }
+        export interface PathParameters {
+            boardId: Parameters.BoardId;
+        }
+        export interface RequestBody {
+            /**
+             * example:
+             * Board 1
+             */
+            title?: string;
+            /**
+             * example:
+             * Board description
+             */
+            description?: string;
+            shared_with?: string[];
+            shared_with_org?: boolean;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Board;
+            export interface $400 {
+            }
+            export interface $401 {
+            }
+            export interface $403 {
+            }
+            export interface $404 {
+            }
+            export interface $500 {
+            }
+        }
+    }
     namespace UpdateKanbanBoard {
         namespace Parameters {
             export type BoardId = string;
@@ -271,6 +365,16 @@ export interface OperationMethods {
     data?: Paths.UpdateKanbanBoard.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
+  /**
+   * patchKanbanBoard - Patch a Kanban board
+   * 
+   * Patch a Kanban board
+   */
+  'patchKanbanBoard'(
+    parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
+    data?: Paths.PatchKanbanBoard.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
   /**
    * deleteKanbanBoard - Delete a Kanban board
    * 
@@ -281,6 +385,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 {
@@ -329,6 +454,16 @@ export interface PathsDictionary {
       data?: Paths.UpdateKanbanBoard.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
+    /**
+     * patchKanbanBoard - Patch a Kanban board
+     * 
+     * Patch a Kanban board
+     */
+    'patch'(
+      parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
+      data?: Paths.PatchKanbanBoard.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
     /**
      * deleteKanbanBoard - Delete a Kanban board
      * 
@@ -340,6 +475,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>
@@ -351,6 +511,8 @@ 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

@@ -190,6 +190,79 @@
           }
         }
       },
+      "patch": {
+        "operationId": "patchKanbanBoard",
+        "summary": "Patch a Kanban board",
+        "description": "Patch a Kanban board",
+        "tags": [
+          "Kanban"
+        ],
+        "parameters": [
+          {
+            "name": "boardId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "type": "string",
+                    "example": "Board 1"
+                  },
+                  "description": {
+                    "type": "string",
+                    "example": "Board description"
+                  },
+                  "shared_with": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "shared_with_org": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successfully patched board",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Board"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request - Invalid input data"
+          },
+          "401": {
+            "description": "Unauthorized - Authentication required"
+          },
+          "403": {
+            "description": "Forbidden - Insufficient permissions"
+          },
+          "404": {
+            "description": "Board not found"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
       "delete": {
         "operationId": "deleteKanbanBoard",
         "summary": "Delete a Kanban board",
@@ -225,6 +298,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": {
@@ -234,12 +413,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": {
@@ -268,6 +441,9 @@
           "created_by": {
             "type": "string"
           },
+          "org_id": {
+            "type": "string"
+          },
           "updated_by": {
             "type": "string"
           },
@@ -276,6 +452,9 @@
             "items": {
               "type": "string"
             }
+          },
+          "shared_with_org": {
+            "type": "boolean"
           }
         }
       },
@@ -360,7 +539,7 @@
         "properties": {
           "field": {
             "type": "string",
-            "example": "createdAt"
+            "example": "created_at"
           },
           "direction": {
             "type": "string",
@@ -486,6 +665,50 @@
         ],
         "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"
+          },
+          "page_number": {
+            "type": "number"
+          },
+          "page_size": {
+            "type": "number"
+          },
+          "total_pages": {
+            "type": "number"
+          }
+        },
+        "additionalProperties": true
+      },
       "FilterItem": {
         "type": "object",
         "properties": {
@@ -514,8 +737,7 @@
         },
         "required": [
           "key",
-          "operator",
-          "value"
+          "operator"
         ]
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/kanban-client",
-  "version": "0.1.2-0",
+  "version": "0.1.4-0",
   "description": "Client library for epilot Kanban API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,7 +31,7 @@
     "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",