@botpress/client - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

dist/gen/client.d.ts

 import { AxiosInstance } from 'axios';
 import type { Merge, Except } from 'type-fest';
-import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
+import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiListWorkspacesRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
 export declare class ApiClient {
@@ -50,2 +50,3 @@ private _innerClient;
     deleteIntegration: (props: DeleteIntegrationProps) => Promise<object>;
+    listWorkspaces: (props: ListWorkspacesProps) => Promise<import("./api").ListWorkspacesResponse>;
     introspect: (introspectBody: IntrospectProps) => Promise<import("./api").IntrospectResponse>;
@@ -101,2 +102,3 @@ createFile: (createFileBody: CreateFileProps) => Promise<import("./api").CreateFileResponse>;
 export type DeleteIntegrationProps = Merge<DefaultApiDeleteIntegrationRequest, {}>;
+export type ListWorkspacesProps = Merge<DefaultApiListWorkspacesRequest, {}>;
 export type IntrospectProps = Merge<Except<DefaultApiIntrospectRequest, 'introspectBody'>, NonNullable<DefaultApiIntrospectRequest['introspectBody']>>;
@@ -103,0 +105,0 @@ export type CreateFileProps = Merge<Except<DefaultApiCreateFileRequest, 'createFileBody'>, NonNullable<DefaultApiCreateFileRequest['createFileBody']>>;

dist/gen/errors.d.ts

@@ -20,2 +20,3 @@ declare const codes: {
     readonly error?: Error | undefined;
+    readonly isApiError = true;
     constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined);
@@ -43,2 +44,9 @@ toJSON(): {
 }
+type UnauthorizedType = 'Unauthorized';
+/**
+ *  The request requires to be authenticated.
+ */
+export declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
+    constructor(message: string, error?: Error);
+}
 type ForbiddenType = 'Forbidden';
@@ -51,2 +59,9 @@ /**
 }
+type PayloadTooLargeType = 'PayloadTooLarge';
+/**
+ *  The request payload is too large.
+ */
+export declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
+    constructor(message: string, error?: Error);
+}
 type InvalidPayloadType = 'InvalidPayload';
@@ -115,5 +130,12 @@ /**
 }
-export type ErrorType = 'Unknown' | 'Internal' | 'Forbidden' | 'InvalidPayload' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceNotFound' | 'InvalidQuery';
-export type ApiError = UnknownError | InternalError | ForbiddenError | InvalidPayloadError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceNotFoundError | InvalidQueryError;
+type RuntimeType = 'Runtime';
+/**
+ *  An error happened during the execution of a runtime (bot or integration).
+ */
+export declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
+    constructor(message: string, error?: Error);
+}
+export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime';
+export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError;
 export declare const errorFrom: (err: unknown) => ApiError;
 export {};

dist/index.d.ts

@@ -0,7 +1,8 @@
+export * as axios from 'axios';
 import { ClientProps } from './config';
 export type { Message, Conversation, User, State, Event, ModelFile as File, Bot, Integration } from './gen';
+export * from './gen/errors';
 import { ApiClient as AutoGeneratedClient } from './gen/client';
-export { ApiError, isApiError } from './gen/errors';
 export declare class Client extends AutoGeneratedClient {
     constructor(clientProps?: ClientProps);
 }

package.json

 {
   "name": "@botpress/client",
-  "version": "0.0.6",
-  "description": "",
+  "version": "0.0.7",
+  "description": "Botpress Client",
   "main": "./dist/index.cjs",
@@ -12,7 +12,7 @@ "module": "./dist/index.mjs",
     "build:browser": "esbuild --bundle --external:axios --external:browser-or-node --platform=browser --format=esm --minify --outfile=dist/index.mjs src/index.ts",
-    "build:node": "esbuild --bundle --external:axios --external:browser-or-node --platform=node --minify --outfile=dist/index.cjs src/index.ts",
+    "build:node": "esbuild --bundle --external:axios --external:browser-or-node --platform=node --minify --sourcemap --outfile=dist/index.cjs src/index.ts",
     "build": "pnpm build:type && pnpm build:node && pnpm build:browser"
   },
   "dependencies": {
-    "axios": "^1.2.5",
+    "axios": "1.2.5",
     "browser-or-node": "^2.1.1"
@@ -19,0 +19,0 @@ },

readme.md

@@ -5,2 +5,6 @@ # Botpress Client
 
+## Disclaimer ⚠️
+
+This package is still in development and is not ready for production use. Use it at your own risk.
+
 ## Installation
@@ -7,0 +11,0 @@

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 6 instances in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 6 instances in 1 package

Improved metrics

Total package byte prevSize

698538

142.45%

Number of package files

15

7.14%

Lines of code

6250

5.75%

Number of lines in readme file

42

10.53%

Dependency changes

• + Added

  axios@1.2.5
  (transitive)

• - Removed

  axios@1.10.0
  (transitive)

• Updated

  axios@1.2.5