@botpress/api 1.52.0 → 1.53.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 (16) hide show
  1. package/.turbo/turbo-openapi.log +5 -5
  2. package/dist/index.js +385 -186
  3. package/dist/src/gen/admin/state.d.ts +54 -0
  4. package/dist/src/gen/state.d.ts +54 -0
  5. package/dist/src/index.d.ts +6 -175
  6. package/package.json +2 -2
  7. package/src/gen/admin/openapi.json +1 -1
  8. package/src/gen/admin/state.ts +114 -17
  9. package/src/gen/files/openapi.json +1 -1
  10. package/src/gen/files/state.ts +1 -1
  11. package/src/gen/openapi.json +1 -1
  12. package/src/gen/runtime/openapi.json +1 -1
  13. package/src/gen/runtime/state.ts +1 -1
  14. package/src/gen/state.ts +114 -17
  15. package/src/gen/tables/openapi.json +1 -1
  16. package/src/gen/tables/state.ts +1 -1
package/dist/src/gen/admin/state.d.ts CHANGED
@@ -2067,6 +2067,12 @@ export declare const state: {
2067
2067
  public: {
2068
2068
  type: "boolean";
2069
2069
  description: string;
2070
+ deprecated: true;
2071
+ };
2072
+ visibility: {
2073
+ type: "string";
2074
+ enum: string[];
2075
+ description: string;
2070
2076
  };
2071
2077
  };
2072
2078
  required: string[];
@@ -2422,6 +2428,12 @@ export declare const state: {
2422
2428
  public: {
2423
2429
  type: "boolean";
2424
2430
  description: string;
2431
+ deprecated: true;
2432
+ };
2433
+ visibility: {
2434
+ type: "string";
2435
+ enum: string[];
2436
+ description: string;
2425
2437
  };
2426
2438
  };
2427
2439
  required: string[];
@@ -2781,6 +2793,12 @@ export declare const state: {
2781
2793
  public: {
2782
2794
  type: "boolean";
2783
2795
  description: string;
2796
+ deprecated: true;
2797
+ };
2798
+ visibility: {
2799
+ type: "string";
2800
+ enum: string[];
2801
+ description: string;
2784
2802
  };
2785
2803
  };
2786
2804
  required: string[];
@@ -3131,6 +3149,12 @@ export declare const state: {
3131
3149
  public: {
3132
3150
  type: "boolean";
3133
3151
  description: string;
3152
+ deprecated: true;
3153
+ };
3154
+ visibility: {
3155
+ type: "string";
3156
+ enum: string[];
3157
+ description: string;
3134
3158
  };
3135
3159
  };
3136
3160
  required: string[];
@@ -12243,6 +12267,12 @@ export declare const state: {
12243
12267
  public: {
12244
12268
  type: "boolean";
12245
12269
  description: string;
12270
+ deprecated: true;
12271
+ };
12272
+ visibility: {
12273
+ type: "string";
12274
+ enum: string[];
12275
+ description: string;
12246
12276
  };
12247
12277
  dependencies: {
12248
12278
  type: "object";
@@ -12727,6 +12757,12 @@ export declare const state: {
12727
12757
  public: {
12728
12758
  type: "boolean";
12729
12759
  description: string;
12760
+ deprecated: true;
12761
+ };
12762
+ visibility: {
12763
+ type: "string";
12764
+ enum: string[];
12765
+ description: string;
12730
12766
  };
12731
12767
  dependencies: {
12732
12768
  type: "object";
@@ -12928,6 +12964,12 @@ export declare const state: {
12928
12964
  public: {
12929
12965
  type: "boolean";
12930
12966
  description: string;
12967
+ deprecated: true;
12968
+ };
12969
+ visibility: {
12970
+ type: "string";
12971
+ enum: string[];
12972
+ description: string;
12931
12973
  };
12932
12974
  };
12933
12975
  required: string[];
@@ -13980,6 +14022,12 @@ export declare const state: {
13980
14022
  public: {
13981
14023
  type: "boolean";
13982
14024
  description: string;
14025
+ deprecated: true;
14026
+ };
14027
+ visibility: {
14028
+ type: "string";
14029
+ enum: string[];
14030
+ description: string;
13983
14031
  };
13984
14032
  };
13985
14033
  required: string[];
@@ -15451,6 +15499,12 @@ export declare const state: {
15451
15499
  public: {
15452
15500
  type: "boolean";
15453
15501
  description: string;
15502
+ deprecated: true;
15503
+ };
15504
+ visibility: {
15505
+ type: "string";
15506
+ enum: string[];
15507
+ description: string;
15454
15508
  };
15455
15509
  };
15456
15510
  required: string[];
package/dist/src/gen/state.d.ts CHANGED
@@ -4412,6 +4412,12 @@ export declare const state: {
4412
4412
  public: {
4413
4413
  type: "boolean";
4414
4414
  description: string;
4415
+ deprecated: true;
4416
+ };
4417
+ visibility: {
4418
+ type: "string";
4419
+ enum: string[];
4420
+ description: string;
4415
4421
  };
4416
4422
  };
4417
4423
  required: string[];
@@ -4761,6 +4767,12 @@ export declare const state: {
4761
4767
  public: {
4762
4768
  type: "boolean";
4763
4769
  description: string;
4770
+ deprecated: true;
4771
+ };
4772
+ visibility: {
4773
+ type: "string";
4774
+ enum: string[];
4775
+ description: string;
4764
4776
  };
4765
4777
  };
4766
4778
  required: string[];
@@ -5114,6 +5126,12 @@ export declare const state: {
5114
5126
  public: {
5115
5127
  type: "boolean";
5116
5128
  description: string;
5129
+ deprecated: true;
5130
+ };
5131
+ visibility: {
5132
+ type: "string";
5133
+ enum: string[];
5134
+ description: string;
5117
5135
  };
5118
5136
  };
5119
5137
  required: string[];
@@ -5458,6 +5476,12 @@ export declare const state: {
5458
5476
  public: {
5459
5477
  type: "boolean";
5460
5478
  description: string;
5479
+ deprecated: true;
5480
+ };
5481
+ visibility: {
5482
+ type: "string";
5483
+ enum: string[];
5484
+ description: string;
5461
5485
  };
5462
5486
  };
5463
5487
  required: string[];
@@ -13772,6 +13796,12 @@ export declare const state: {
13772
13796
  public: {
13773
13797
  type: "boolean";
13774
13798
  description: string;
13799
+ deprecated: true;
13800
+ };
13801
+ visibility: {
13802
+ type: "string";
13803
+ enum: string[];
13804
+ description: string;
13775
13805
  };
13776
13806
  dependencies: {
13777
13807
  type: "object";
@@ -14208,6 +14238,12 @@ export declare const state: {
14208
14238
  public: {
14209
14239
  type: "boolean";
14210
14240
  description: string;
14241
+ deprecated: true;
14242
+ };
14243
+ visibility: {
14244
+ type: "string";
14245
+ enum: string[];
14246
+ description: string;
14211
14247
  };
14212
14248
  dependencies: {
14213
14249
  type: "object";
@@ -14385,6 +14421,12 @@ export declare const state: {
14385
14421
  public: {
14386
14422
  type: "boolean";
14387
14423
  description: string;
14424
+ deprecated: true;
14425
+ };
14426
+ visibility: {
14427
+ type: "string";
14428
+ enum: string[];
14429
+ description: string;
14388
14430
  };
14389
14431
  };
14390
14432
  required: string[];
@@ -18129,6 +18171,12 @@ export declare const state: {
18129
18171
  public: {
18130
18172
  type: "boolean";
18131
18173
  description: string;
18174
+ deprecated: true;
18175
+ };
18176
+ visibility: {
18177
+ type: "string";
18178
+ enum: string[];
18179
+ description: string;
18132
18180
  };
18133
18181
  };
18134
18182
  required: string[];
@@ -19600,6 +19648,12 @@ export declare const state: {
19600
19648
  public: {
19601
19649
  type: "boolean";
19602
19650
  description: string;
19651
+ deprecated: true;
19652
+ };
19653
+ visibility: {
19654
+ type: "string";
19655
+ enum: string[];
19656
+ description: string;
19603
19657
  };
19604
19658
  };
19605
19659
  required: string[];
package/dist/src/index.d.ts CHANGED
@@ -1,180 +1,11 @@
1
+ import { OpenApi } from '@bpinternal/opapi';
1
2
  export * from './gen/state';
2
- export declare const api: {
3
- getModelRef: (name: "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow" | "Bot" | "Integration" | "Interface" | "Plugin" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version" | "File" | "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
4
- getState: () => import("@bpinternal/opapi").State<"User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow" | "Bot" | "Integration" | "Interface" | "Plugin" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version" | "File" | "Table" | "Column" | "Row", "x-workspace-id", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "tag" | "bot" | "integration" | "interface" | "plugin" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "files" | "tables">;
5
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "tag" | "bot" | "integration" | "interface" | "plugin" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "files" | "tables", Path, "zod-schema">) => void;
6
- exportClient: {
7
- (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
8
- (dir: string, openapiGeneratorEndpoint: string, props?: (import("@bpinternal/opapi").OpenApiPostProcessors & Partial<{
9
- ignoreDefaultParameters: boolean;
10
- ignoreSecurity: boolean;
11
- }>) | undefined): Promise<void>;
12
- };
13
- exportTypesBySection: (dir?: string | undefined, opts?: Partial<{
14
- ignoreDefaultParameters: boolean;
15
- ignoreSecurity: boolean;
16
- }> | undefined) => Promise<void>;
17
- exportServer: (dir: string | undefined, useExpressTypes: boolean, opts?: Partial<{
18
- ignoreDefaultParameters: boolean;
19
- ignoreSecurity: boolean;
20
- }> | undefined) => Promise<void>;
21
- exportOpenapi: (dir?: string | undefined, opts?: Partial<{
22
- ignoreDefaultParameters: boolean;
23
- ignoreSecurity: boolean;
24
- }> | undefined) => void;
25
- exportState: (dir?: string | undefined, opts?: (Partial<{
26
- importPath: string;
27
- }> & Partial<{
28
- ignoreDefaultParameters: boolean;
29
- ignoreSecurity: boolean;
30
- }>) | undefined) => void;
31
- exportErrors: (dir?: string | undefined) => void;
32
- exportHandler: (dir?: string | undefined, opts?: Partial<{
33
- ignoreDefaultParameters: boolean;
34
- ignoreSecurity: boolean;
35
- }> | undefined) => Promise<void>;
36
- };
3
+ export declare const api: OpenApi<string, string, string>;
37
4
  export * as runtime from './gen/runtime/state';
38
- export declare const runtimeApi: {
39
- getModelRef: (name: "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow") => import("@bpinternal/opapi").OpenApiZodAny;
40
- getState: () => import("@bpinternal/opapi").State<"User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow", "x-bot-id" | "x-integration-id" | "x-integration-alias", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "tag">;
41
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-bot-id" | "x-integration-id" | "x-integration-alias", "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "tag", Path, "zod-schema">) => void;
42
- exportClient: {
43
- (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
44
- (dir: string, openapiGeneratorEndpoint: string, props?: (import("@bpinternal/opapi").OpenApiPostProcessors & Partial<{
45
- ignoreDefaultParameters: boolean;
46
- ignoreSecurity: boolean;
47
- }>) | undefined): Promise<void>;
48
- };
49
- exportTypesBySection: (dir?: string | undefined, opts?: Partial<{
50
- ignoreDefaultParameters: boolean;
51
- ignoreSecurity: boolean;
52
- }> | undefined) => Promise<void>;
53
- exportServer: (dir: string | undefined, useExpressTypes: boolean, opts?: Partial<{
54
- ignoreDefaultParameters: boolean;
55
- ignoreSecurity: boolean;
56
- }> | undefined) => Promise<void>;
57
- exportOpenapi: (dir?: string | undefined, opts?: Partial<{
58
- ignoreDefaultParameters: boolean;
59
- ignoreSecurity: boolean;
60
- }> | undefined) => void;
61
- exportState: (dir?: string | undefined, opts?: (Partial<{
62
- importPath: string;
63
- }> & Partial<{
64
- ignoreDefaultParameters: boolean;
65
- ignoreSecurity: boolean;
66
- }>) | undefined) => void;
67
- exportErrors: (dir?: string | undefined) => void;
68
- exportHandler: (dir?: string | undefined, opts?: Partial<{
69
- ignoreDefaultParameters: boolean;
70
- ignoreSecurity: boolean;
71
- }> | undefined) => Promise<void>;
72
- };
5
+ export declare const runtimeApi: OpenApi<string, string, string>;
73
6
  export * as admin from './gen/admin/state';
74
- export declare const adminApi: {
75
- getModelRef: (name: "Bot" | "Integration" | "Interface" | "Plugin" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version") => import("@bpinternal/opapi").OpenApiZodAny;
76
- getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Interface" | "Plugin" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version", "x-workspace-id" | "x-multiple-integrations", "hub" | "bot" | "integration" | "interface" | "plugin" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity">;
77
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id" | "x-multiple-integrations", "hub" | "bot" | "integration" | "interface" | "plugin" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity", Path, "zod-schema">) => void;
78
- exportClient: {
79
- (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
80
- (dir: string, openapiGeneratorEndpoint: string, props?: (import("@bpinternal/opapi").OpenApiPostProcessors & Partial<{
81
- ignoreDefaultParameters: boolean;
82
- ignoreSecurity: boolean;
83
- }>) | undefined): Promise<void>;
84
- };
85
- exportTypesBySection: (dir?: string | undefined, opts?: Partial<{
86
- ignoreDefaultParameters: boolean;
87
- ignoreSecurity: boolean;
88
- }> | undefined) => Promise<void>;
89
- exportServer: (dir: string | undefined, useExpressTypes: boolean, opts?: Partial<{
90
- ignoreDefaultParameters: boolean;
91
- ignoreSecurity: boolean;
92
- }> | undefined) => Promise<void>;
93
- exportOpenapi: (dir?: string | undefined, opts?: Partial<{
94
- ignoreDefaultParameters: boolean;
95
- ignoreSecurity: boolean;
96
- }> | undefined) => void;
97
- exportState: (dir?: string | undefined, opts?: (Partial<{
98
- importPath: string;
99
- }> & Partial<{
100
- ignoreDefaultParameters: boolean;
101
- ignoreSecurity: boolean;
102
- }>) | undefined) => void;
103
- exportErrors: (dir?: string | undefined) => void;
104
- exportHandler: (dir?: string | undefined, opts?: Partial<{
105
- ignoreDefaultParameters: boolean;
106
- ignoreSecurity: boolean;
107
- }> | undefined) => Promise<void>;
108
- };
7
+ export declare const adminApi: OpenApi<string, string, string>;
109
8
  export * as files from './gen/files/state';
110
- export declare const filesApi: {
111
- getModelRef: (name: "File") => import("@bpinternal/opapi").OpenApiZodAny;
112
- getState: () => import("@bpinternal/opapi").State<"File", "x-bot-id" | "x-integration-id" | "x-integration-alias" | "x-integration-name" | "x-user-id" | "x-user-role", "files">;
113
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-bot-id" | "x-integration-id" | "x-integration-alias" | "x-integration-name" | "x-user-id" | "x-user-role", "files", Path, "zod-schema">) => void;
114
- exportClient: {
115
- (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
116
- (dir: string, openapiGeneratorEndpoint: string, props?: (import("@bpinternal/opapi").OpenApiPostProcessors & Partial<{
117
- ignoreDefaultParameters: boolean;
118
- ignoreSecurity: boolean;
119
- }>) | undefined): Promise<void>;
120
- };
121
- exportTypesBySection: (dir?: string | undefined, opts?: Partial<{
122
- ignoreDefaultParameters: boolean;
123
- ignoreSecurity: boolean;
124
- }> | undefined) => Promise<void>;
125
- exportServer: (dir: string | undefined, useExpressTypes: boolean, opts?: Partial<{
126
- ignoreDefaultParameters: boolean;
127
- ignoreSecurity: boolean;
128
- }> | undefined) => Promise<void>;
129
- exportOpenapi: (dir?: string | undefined, opts?: Partial<{
130
- ignoreDefaultParameters: boolean;
131
- ignoreSecurity: boolean;
132
- }> | undefined) => void;
133
- exportState: (dir?: string | undefined, opts?: (Partial<{
134
- importPath: string;
135
- }> & Partial<{
136
- ignoreDefaultParameters: boolean;
137
- ignoreSecurity: boolean;
138
- }>) | undefined) => void;
139
- exportErrors: (dir?: string | undefined) => void;
140
- exportHandler: (dir?: string | undefined, opts?: Partial<{
141
- ignoreDefaultParameters: boolean;
142
- ignoreSecurity: boolean;
143
- }> | undefined) => Promise<void>;
144
- };
9
+ export declare const filesApi: OpenApi<string, string, string>;
145
10
  export * as tables from './gen/tables/state';
146
- export declare const tablesApi: {
147
- getModelRef: (name: "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
148
- getState: () => import("@bpinternal/opapi").State<"Table" | "Column" | "Row", "x-bot-id" | "x-integration-id" | "x-integration-alias" | "x-integration-name" | "x-user-id" | "x-user-role", "tables">;
149
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-bot-id" | "x-integration-id" | "x-integration-alias" | "x-integration-name" | "x-user-id" | "x-user-role", "tables", Path, "zod-schema">) => void;
150
- exportClient: {
151
- (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
152
- (dir: string, openapiGeneratorEndpoint: string, props?: (import("@bpinternal/opapi").OpenApiPostProcessors & Partial<{
153
- ignoreDefaultParameters: boolean;
154
- ignoreSecurity: boolean;
155
- }>) | undefined): Promise<void>;
156
- };
157
- exportTypesBySection: (dir?: string | undefined, opts?: Partial<{
158
- ignoreDefaultParameters: boolean;
159
- ignoreSecurity: boolean;
160
- }> | undefined) => Promise<void>;
161
- exportServer: (dir: string | undefined, useExpressTypes: boolean, opts?: Partial<{
162
- ignoreDefaultParameters: boolean;
163
- ignoreSecurity: boolean;
164
- }> | undefined) => Promise<void>;
165
- exportOpenapi: (dir?: string | undefined, opts?: Partial<{
166
- ignoreDefaultParameters: boolean;
167
- ignoreSecurity: boolean;
168
- }> | undefined) => void;
169
- exportState: (dir?: string | undefined, opts?: (Partial<{
170
- importPath: string;
171
- }> & Partial<{
172
- ignoreDefaultParameters: boolean;
173
- ignoreSecurity: boolean;
174
- }>) | undefined) => void;
175
- exportErrors: (dir?: string | undefined) => void;
176
- exportHandler: (dir?: string | undefined, opts?: Partial<{
177
- ignoreDefaultParameters: boolean;
178
- ignoreSecurity: boolean;
179
- }> | undefined) => Promise<void>;
180
- };
11
+ export declare const tablesApi: OpenApi<string, string, string>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.52.0",
3
+ "version": "1.53.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "devDependencies": {
@@ -15,7 +15,7 @@
15
15
  "@bpinternal/tables-api": "0.17.2"
16
16
  },
17
17
  "dependencies": {
18
- "@bpinternal/opapi": "0.18.0"
18
+ "@bpinternal/opapi": "1.0.0"
19
19
  },
20
20
  "scripts": {
21
21
  "openapi": "es-node openapi/generator.ts && pnpm run build",