@botpress/api 1.50.0 → 1.52.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 (19) hide show
  1. package/.turbo/turbo-openapi.log +6 -6
  2. package/dist/index.js +4056 -228
  3. package/dist/src/gen/admin/state.d.ts +1197 -69
  4. package/dist/src/gen/files/state.d.ts +594 -3
  5. package/dist/src/gen/runtime/state.d.ts +910 -14
  6. package/dist/src/gen/state.d.ts +100 -0
  7. package/dist/src/gen/tables/state.d.ts +668 -2
  8. package/dist/src/index.d.ts +134 -39
  9. package/package.json +2 -2
  10. package/src/gen/admin/openapi.json +1 -1
  11. package/src/gen/admin/state.ts +1274 -60
  12. package/src/gen/files/openapi.json +1 -1
  13. package/src/gen/files/state.ts +627 -14
  14. package/src/gen/openapi.json +1 -1
  15. package/src/gen/runtime/openapi.json +1 -1
  16. package/src/gen/runtime/state.ts +1007 -41
  17. package/src/gen/state.ts +382 -82
  18. package/src/gen/tables/openapi.json +1 -1
  19. package/src/gen/tables/state.ts +713 -17
package/dist/src/index.d.ts CHANGED
@@ -1,85 +1,180 @@
1
1
  export * from './gen/state';
2
2
  export declare const api: {
3
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">;
4
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;
5
6
  exportClient: {
6
- (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
7
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>;
8
12
  };
9
- exportTypesBySection: (dir?: string | undefined) => Promise<void>;
10
- exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
11
- exportOpenapi: (dir?: string | undefined) => void;
12
- exportState: (dir?: string | undefined, opts?: Partial<{
13
- importPath: string;
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;
14
24
  }> | undefined) => void;
25
+ exportState: (dir?: string | undefined, opts?: (Partial<{
26
+ importPath: string;
27
+ }> & Partial<{
28
+ ignoreDefaultParameters: boolean;
29
+ ignoreSecurity: boolean;
30
+ }>) | undefined) => void;
15
31
  exportErrors: (dir?: string | undefined) => void;
16
- exportHandler: (dir?: string | undefined) => Promise<void>;
32
+ exportHandler: (dir?: string | undefined, opts?: Partial<{
33
+ ignoreDefaultParameters: boolean;
34
+ ignoreSecurity: boolean;
35
+ }> | undefined) => Promise<void>;
17
36
  };
18
37
  export * as runtime from './gen/runtime/state';
19
38
  export declare const runtimeApi: {
20
39
  getModelRef: (name: "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Workflow") => import("@bpinternal/opapi").OpenApiZodAny;
21
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<string, "user" | "conversation" | "event" | "message" | "state" | "hub" | "action" | "task" | "workflow" | "tag", Path, "zod-schema">) => void;
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;
22
42
  exportClient: {
23
- (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
24
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>;
25
48
  };
26
- exportTypesBySection: (dir?: string | undefined) => Promise<void>;
27
- exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
28
- exportOpenapi: (dir?: string | undefined) => void;
29
- exportState: (dir?: string | undefined, opts?: Partial<{
30
- importPath: string;
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;
31
60
  }> | undefined) => void;
61
+ exportState: (dir?: string | undefined, opts?: (Partial<{
62
+ importPath: string;
63
+ }> & Partial<{
64
+ ignoreDefaultParameters: boolean;
65
+ ignoreSecurity: boolean;
66
+ }>) | undefined) => void;
32
67
  exportErrors: (dir?: string | undefined) => void;
33
- exportHandler: (dir?: string | undefined) => Promise<void>;
68
+ exportHandler: (dir?: string | undefined, opts?: Partial<{
69
+ ignoreDefaultParameters: boolean;
70
+ ignoreSecurity: boolean;
71
+ }> | undefined) => Promise<void>;
34
72
  };
35
73
  export * as admin from './gen/admin/state';
36
74
  export declare const adminApi: {
37
75
  getModelRef: (name: "Bot" | "Integration" | "Interface" | "Plugin" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "Version") => import("@bpinternal/opapi").OpenApiZodAny;
38
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "hub" | "bot" | "integration" | "interface" | "plugin" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity", Path, "zod-schema">) => void;
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;
39
78
  exportClient: {
40
- (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
41
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>;
42
84
  };
43
- exportTypesBySection: (dir?: string | undefined) => Promise<void>;
44
- exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
45
- exportOpenapi: (dir?: string | undefined) => void;
46
- exportState: (dir?: string | undefined, opts?: Partial<{
47
- importPath: string;
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;
48
96
  }> | undefined) => void;
97
+ exportState: (dir?: string | undefined, opts?: (Partial<{
98
+ importPath: string;
99
+ }> & Partial<{
100
+ ignoreDefaultParameters: boolean;
101
+ ignoreSecurity: boolean;
102
+ }>) | undefined) => void;
49
103
  exportErrors: (dir?: string | undefined) => void;
50
- exportHandler: (dir?: string | undefined) => Promise<void>;
104
+ exportHandler: (dir?: string | undefined, opts?: Partial<{
105
+ ignoreDefaultParameters: boolean;
106
+ ignoreSecurity: boolean;
107
+ }> | undefined) => Promise<void>;
51
108
  };
52
109
  export * as files from './gen/files/state';
53
110
  export declare const filesApi: {
54
111
  getModelRef: (name: "File") => import("@bpinternal/opapi").OpenApiZodAny;
55
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<string, "files", Path, "zod-schema">) => void;
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;
56
114
  exportClient: {
57
- (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
58
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>;
59
120
  };
60
- exportTypesBySection: (dir?: string | undefined) => Promise<void>;
61
- exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
62
- exportOpenapi: (dir?: string | undefined) => void;
63
- exportState: (dir?: string | undefined, opts?: Partial<{
64
- importPath: string;
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;
65
132
  }> | undefined) => void;
133
+ exportState: (dir?: string | undefined, opts?: (Partial<{
134
+ importPath: string;
135
+ }> & Partial<{
136
+ ignoreDefaultParameters: boolean;
137
+ ignoreSecurity: boolean;
138
+ }>) | undefined) => void;
66
139
  exportErrors: (dir?: string | undefined) => void;
67
- exportHandler: (dir?: string | undefined) => Promise<void>;
140
+ exportHandler: (dir?: string | undefined, opts?: Partial<{
141
+ ignoreDefaultParameters: boolean;
142
+ ignoreSecurity: boolean;
143
+ }> | undefined) => Promise<void>;
68
144
  };
69
145
  export * as tables from './gen/tables/state';
70
146
  export declare const tablesApi: {
71
147
  getModelRef: (name: "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
72
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<string, "tables", Path, "zod-schema">) => void;
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;
73
150
  exportClient: {
74
- (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
75
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>;
76
156
  };
77
- exportTypesBySection: (dir?: string | undefined) => Promise<void>;
78
- exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
79
- exportOpenapi: (dir?: string | undefined) => void;
80
- exportState: (dir?: string | undefined, opts?: Partial<{
81
- importPath: string;
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;
82
168
  }> | undefined) => void;
169
+ exportState: (dir?: string | undefined, opts?: (Partial<{
170
+ importPath: string;
171
+ }> & Partial<{
172
+ ignoreDefaultParameters: boolean;
173
+ ignoreSecurity: boolean;
174
+ }>) | undefined) => void;
83
175
  exportErrors: (dir?: string | undefined) => void;
84
- exportHandler: (dir?: string | undefined) => Promise<void>;
176
+ exportHandler: (dir?: string | undefined, opts?: Partial<{
177
+ ignoreDefaultParameters: boolean;
178
+ ignoreSecurity: boolean;
179
+ }> | undefined) => Promise<void>;
85
180
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.50.0",
3
+ "version": "1.52.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.16.1"
18
+ "@bpinternal/opapi": "0.18.0"
19
19
  },
20
20
  "scripts": {
21
21
  "openapi": "es-node openapi/generator.ts && pnpm run build",