@botpress/api 1.73.3 → 1.74.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 (6) hide show
  1. package/.eslintrc.js +0 -1
  2. package/dist/index.js +152 -1049
  3. package/dist/src/gen/runtime/state.d.ts +8 -468
  4. package/dist/src/gen/state.d.ts +34 -377
  5. package/dist/src/gen/tables/state.d.ts +26 -0
  6. package/package.json +7 -7
package/dist/src/gen/state.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -255,6 +255,8 @@ export declare const state: {
255
255
  properties: {
256
256
  currentTaskId: {
257
257
  type: "string";
258
+ deprecated: true;
259
+ description: string;
258
260
  };
259
261
  tags: {
260
262
  type: "object";
@@ -2027,282 +2029,6 @@ export declare const state: {
2027
2029
  tags: string[];
2028
2030
  parameters: {};
2029
2031
  };
2030
- getTask: {
2031
- name: string;
2032
- description: string;
2033
- method: "get";
2034
- path: string;
2035
- parameters: {
2036
- id: {
2037
- in: "path";
2038
- type: "string";
2039
- description: string;
2040
- };
2041
- };
2042
- section: "task";
2043
- response: {
2044
- description: string;
2045
- schema: {
2046
- type: "object";
2047
- properties: {
2048
- task: {
2049
- $ref: string;
2050
- };
2051
- };
2052
- required: string[];
2053
- title: string;
2054
- additionalProperties: false;
2055
- };
2056
- };
2057
- };
2058
- createTask: {
2059
- name: string;
2060
- description: string;
2061
- method: "post";
2062
- path: string;
2063
- requestBody: {
2064
- description: string;
2065
- schema: {
2066
- type: "object";
2067
- properties: {
2068
- title: {
2069
- type: "string";
2070
- maxLength: number;
2071
- description: string;
2072
- };
2073
- description: {
2074
- type: "string";
2075
- maxLength: number;
2076
- description: string;
2077
- };
2078
- type: {
2079
- type: "string";
2080
- maxLength: number;
2081
- description: string;
2082
- };
2083
- data: {
2084
- type: "object";
2085
- additionalProperties: true;
2086
- description: string;
2087
- };
2088
- parentTaskId: {
2089
- type: "string";
2090
- description: string;
2091
- };
2092
- conversationId: {
2093
- type: "string";
2094
- description: string;
2095
- };
2096
- userId: {
2097
- type: "string";
2098
- description: string;
2099
- };
2100
- timeoutAt: {
2101
- type: "string";
2102
- format: string;
2103
- description: string;
2104
- };
2105
- tags: {
2106
- type: "object";
2107
- additionalProperties: {
2108
- type: "string";
2109
- maxLength: number;
2110
- };
2111
- description: string;
2112
- };
2113
- };
2114
- required: string[];
2115
- title: string;
2116
- additionalProperties: false;
2117
- };
2118
- };
2119
- section: "task";
2120
- response: {
2121
- description: string;
2122
- status: 201;
2123
- schema: {
2124
- type: "object";
2125
- properties: {
2126
- task: {
2127
- $ref: string;
2128
- };
2129
- };
2130
- required: string[];
2131
- title: string;
2132
- additionalProperties: false;
2133
- };
2134
- };
2135
- parameters: {};
2136
- };
2137
- updateTask: {
2138
- name: string;
2139
- description: string;
2140
- method: "put";
2141
- path: string;
2142
- parameters: {
2143
- id: {
2144
- in: "path";
2145
- type: "string";
2146
- description: string;
2147
- };
2148
- };
2149
- requestBody: {
2150
- description: string;
2151
- schema: {
2152
- type: "object";
2153
- properties: {
2154
- title: {
2155
- type: "string";
2156
- description: string;
2157
- };
2158
- description: {
2159
- type: "string";
2160
- description: string;
2161
- };
2162
- data: {
2163
- type: "object";
2164
- additionalProperties: true;
2165
- description: string;
2166
- };
2167
- timeoutAt: {
2168
- type: "string";
2169
- format: string;
2170
- description: string;
2171
- };
2172
- status: {
2173
- type: "string";
2174
- enum: string[];
2175
- description: string;
2176
- };
2177
- tags: {
2178
- type: "object";
2179
- additionalProperties: {
2180
- type: "string";
2181
- maxLength: number;
2182
- };
2183
- description: string;
2184
- };
2185
- };
2186
- title: string;
2187
- additionalProperties: false;
2188
- };
2189
- };
2190
- section: "task";
2191
- response: {
2192
- description: string;
2193
- schema: {
2194
- type: "object";
2195
- properties: {
2196
- task: {
2197
- $ref: string;
2198
- };
2199
- };
2200
- required: string[];
2201
- title: string;
2202
- additionalProperties: false;
2203
- };
2204
- };
2205
- };
2206
- deleteTask: {
2207
- name: string;
2208
- description: string;
2209
- method: "delete";
2210
- path: string;
2211
- parameters: {
2212
- id: {
2213
- in: "path";
2214
- type: "string";
2215
- description: string;
2216
- };
2217
- };
2218
- section: "task";
2219
- response: {
2220
- description: string;
2221
- schema: {
2222
- type: "object";
2223
- title: string;
2224
- additionalProperties: false;
2225
- };
2226
- };
2227
- };
2228
- listTasks: {
2229
- name: string;
2230
- description: string;
2231
- method: "get";
2232
- path: string;
2233
- parameters: {
2234
- nextToken: {
2235
- in: "query";
2236
- description: string;
2237
- type: "string";
2238
- };
2239
- tags: {
2240
- in: "query";
2241
- type: "object";
2242
- schema: {
2243
- type: "object";
2244
- additionalProperties: {
2245
- type: "string";
2246
- };
2247
- };
2248
- description: string;
2249
- };
2250
- conversationId: {
2251
- in: "query";
2252
- type: "string";
2253
- description: string;
2254
- };
2255
- userId: {
2256
- in: "query";
2257
- type: "string";
2258
- description: string;
2259
- };
2260
- parentTaskId: {
2261
- in: "query";
2262
- type: "string";
2263
- description: string;
2264
- };
2265
- status: {
2266
- in: "query";
2267
- type: "string[]";
2268
- description: string;
2269
- enum: string[];
2270
- };
2271
- type: {
2272
- in: "query";
2273
- type: "string";
2274
- description: string;
2275
- };
2276
- };
2277
- section: "task";
2278
- response: {
2279
- description: string;
2280
- schema: {
2281
- type: "object";
2282
- properties: {
2283
- tasks: {
2284
- type: "array";
2285
- items: {
2286
- $ref: string;
2287
- };
2288
- };
2289
- meta: {
2290
- type: "object";
2291
- properties: {
2292
- nextToken: {
2293
- type: "string";
2294
- description: string;
2295
- };
2296
- };
2297
- additionalProperties: false;
2298
- };
2299
- };
2300
- required: string[];
2301
- title: string;
2302
- additionalProperties: false;
2303
- };
2304
- };
2305
- };
2306
2032
  createWorkflow: {
2307
2033
  name: string;
2308
2034
  description: string;
@@ -2775,6 +2501,10 @@ export declare const state: {
2775
2501
  schema: {
2776
2502
  type: "object";
2777
2503
  properties: {
2504
+ id: {
2505
+ type: "string";
2506
+ description: string;
2507
+ };
2778
2508
  name: {
2779
2509
  type: "string";
2780
2510
  description: string;
@@ -17375,6 +17105,19 @@ export declare const state: {
17375
17105
  type: "number";
17376
17106
  description: string;
17377
17107
  };
17108
+ job: {
17109
+ type: "object";
17110
+ properties: {
17111
+ id: {
17112
+ type: "string";
17113
+ };
17114
+ status: {
17115
+ type: "string";
17116
+ };
17117
+ };
17118
+ required: string[];
17119
+ additionalProperties: false;
17120
+ };
17378
17121
  };
17379
17122
  required: string[];
17380
17123
  title: string;
@@ -18042,6 +17785,19 @@ export declare const state: {
18042
17785
  deletedRows: {
18043
17786
  type: "number";
18044
17787
  };
17788
+ job: {
17789
+ type: "object";
17790
+ properties: {
17791
+ id: {
17792
+ type: "string";
17793
+ };
17794
+ status: {
17795
+ type: "string";
17796
+ };
17797
+ };
17798
+ required: string[];
17799
+ additionalProperties: false;
17800
+ };
18045
17801
  };
18046
17802
  required: string[];
18047
17803
  title: string;
@@ -18300,8 +18056,6 @@ export declare const state: {
18300
18056
  patchStateBody: true;
18301
18057
  callActionBody: true;
18302
18058
  configureIntegrationBody: true;
18303
- createTaskBody: true;
18304
- updateTaskBody: true;
18305
18059
  createWorkflowBody: true;
18306
18060
  updateWorkflowBody: true;
18307
18061
  getOrCreateWorkflowBody: true;
@@ -18396,11 +18150,6 @@ export declare const state: {
18396
18150
  patchStateResponse: true;
18397
18151
  callActionResponse: true;
18398
18152
  configureIntegrationResponse: true;
18399
- getTaskResponse: true;
18400
- createTaskResponse: true;
18401
- updateTaskResponse: true;
18402
- deleteTaskResponse: true;
18403
- listTasksResponse: true;
18404
18153
  createWorkflowResponse: true;
18405
18154
  getWorkflowResponse: true;
18406
18155
  updateWorkflowResponse: true;
@@ -18571,7 +18320,6 @@ export declare const state: {
18571
18320
  Event: true;
18572
18321
  Message: true;
18573
18322
  State: true;
18574
- Task: true;
18575
18323
  Workflow: true;
18576
18324
  Table: true;
18577
18325
  Column: true;
@@ -20722,6 +20470,7 @@ export declare const state: {
20722
20470
  type: "string";
20723
20471
  minLength: number;
20724
20472
  maxLength: number;
20473
+ deprecated: true;
20725
20474
  description: string;
20726
20475
  };
20727
20476
  currentWorkflowId: {
@@ -20947,92 +20696,6 @@ export declare const state: {
20947
20696
  additionalProperties: false;
20948
20697
  };
20949
20698
  };
20950
- Task: {
20951
- section: "task";
20952
- schema: {
20953
- type: "object";
20954
- properties: {
20955
- id: {
20956
- type: "string";
20957
- minLength: number;
20958
- maxLength: number;
20959
- description: string;
20960
- };
20961
- title: {
20962
- type: "string";
20963
- maxLength: number;
20964
- description: string;
20965
- };
20966
- description: {
20967
- type: "string";
20968
- maxLength: number;
20969
- description: string;
20970
- };
20971
- type: {
20972
- type: "string";
20973
- description: string;
20974
- };
20975
- data: {
20976
- type: "object";
20977
- additionalProperties: true;
20978
- description: string;
20979
- };
20980
- status: {
20981
- type: "string";
20982
- enum: string[];
20983
- description: string;
20984
- };
20985
- parentTaskId: {
20986
- type: "string";
20987
- minLength: number;
20988
- maxLength: number;
20989
- description: string;
20990
- };
20991
- conversationId: {
20992
- type: "string";
20993
- minLength: number;
20994
- maxLength: number;
20995
- description: string;
20996
- };
20997
- userId: {
20998
- type: "string";
20999
- minLength: number;
21000
- maxLength: number;
21001
- description: string;
21002
- };
21003
- timeoutAt: {
21004
- type: "string";
21005
- format: string;
21006
- description: string;
21007
- };
21008
- createdAt: {
21009
- type: "string";
21010
- format: string;
21011
- description: string;
21012
- };
21013
- updatedAt: {
21014
- type: "string";
21015
- format: string;
21016
- description: string;
21017
- };
21018
- failureReason: {
21019
- type: "string";
21020
- maxLength: number;
21021
- description: string;
21022
- };
21023
- tags: {
21024
- type: "object";
21025
- additionalProperties: {
21026
- type: "string";
21027
- };
21028
- description: string;
21029
- };
21030
- };
21031
- required: string[];
21032
- description: string;
21033
- additionalProperties: false;
21034
- };
21035
- };
21036
20699
  Workflow: {
21037
20700
  section: "workflow";
21038
20701
  schema: {
@@ -21635,12 +21298,6 @@ export declare const state: {
21635
21298
  name: "action";
21636
21299
  operations: string[];
21637
21300
  schema?: undefined;
21638
- } | {
21639
- description: string;
21640
- title: string;
21641
- name: "task";
21642
- operations: string[];
21643
- schema: string;
21644
21301
  } | {
21645
21302
  description: string;
21646
21303
  title: string;
package/dist/src/gen/tables/state.d.ts CHANGED
@@ -469,6 +469,19 @@ export declare const state: {
469
469
  type: "number";
470
470
  description: string;
471
471
  };
472
+ job: {
473
+ type: "object";
474
+ properties: {
475
+ id: {
476
+ type: "string";
477
+ };
478
+ status: {
479
+ type: "string";
480
+ };
481
+ };
482
+ required: string[];
483
+ additionalProperties: false;
484
+ };
472
485
  };
473
486
  required: string[];
474
487
  title: string;
@@ -1496,6 +1509,19 @@ export declare const state: {
1496
1509
  deletedRows: {
1497
1510
  type: "number";
1498
1511
  };
1512
+ job: {
1513
+ type: "object";
1514
+ properties: {
1515
+ id: {
1516
+ type: "string";
1517
+ };
1518
+ status: {
1519
+ type: "string";
1520
+ };
1521
+ };
1522
+ required: string[];
1523
+ additionalProperties: false;
1524
+ };
1499
1525
  };
1500
1526
  required: string[];
1501
1527
  title: string;
package/package.json CHANGED
@@ -1,23 +1,23 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.73.3",
3
+ "version": "1.74.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
+ "dependencies": {
7
+ "@bpinternal/opapi": "1.0.0"
8
+ },
6
9
  "devDependencies": {
7
10
  "@bpinternal/es-node": "0.0.3",
8
11
  "esbuild": "0.27.1",
9
- "zod": "^3.24.4",
10
12
  "typescript": "5.9.3",
13
+ "zod": "^3.24.4",
11
14
  "@botpress/bridge": "1.8.1",
12
15
  "@botpress/cloud-manager": "0.2.0",
13
16
  "@botpress/common": "0.5.0",
14
17
  "@botpress/files-api": "0.18.0",
15
- "@bpinternal/const": "0.4.2",
16
18
  "@botpress/smaug": "1.0.1",
17
- "@bpinternal/tables-api": "0.17.2"
18
- },
19
- "dependencies": {
20
- "@bpinternal/opapi": "1.0.0"
19
+ "@bpinternal/tables-api": "0.17.2",
20
+ "@bpinternal/const": "0.4.2"
21
21
  },
22
22
  "scripts": {
23
23
  "openapi": "es-node openapi/generator.ts && pnpm run build",