@picteus/extension-sdk 0.13.1 → 0.14.0

package/dist/picteusExtension.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 // We do not import the "process" package on purpose, otherwise we get the runtime error "process.on is not a function"
 import console from "node:console";
 import { io } from "socket.io-client";
-import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, ManifestFromJSON, MiscellaneousApi, RepositoryApi } from "./index.js";
+import { ApiSecretApi, CollectionApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, ManifestFromJSON, MiscellaneousApi, RepositoryApi } from "./index.js";
 export var NotificationReturnedErrorCause;
 (function (NotificationReturnedErrorCause) {
     NotificationReturnedErrorCause[NotificationReturnedErrorCause["Cancel"] = 0] = "Cancel";
@@ -17,6 +17,7 @@ export class NotificationReturnedError extends Error {
         this.reason = reason;
     }
 }
+// noinspection JSUnusedGlobalSymbols
 export var NotificationEvent;
 (function (NotificationEvent) {
     NotificationEvent["ProcessRunCommand"] = "process.runCommand";
@@ -32,6 +33,7 @@ export var NotificationEvent;
     NotificationEvent["TextComputeEmbeddings"] = "text.computeEmbeddings";
 })(NotificationEvent || (NotificationEvent = {}));
 const extensionSettingsEvent = "extension.settings";
+// noinspection JSUnusedGlobalSymbols
 export class Helper {
     static GENERATION_RECIPE_SCHEMA_VERSION = 1;
 }
@@ -77,7 +79,7 @@ const stringifyWithStrippedBuffers = (object) => {
     const bufferReplacement = "<bytes>";
     return JSON.stringify(object, (_key, value) => {
         // We check if the value is a Buffer
-        if (value !== undefined && value.type === "Buffer" && Array.isArray(value.data) === true) {
+        if (value !== undefined && value !== null && value.type === "Buffer" && Array.isArray(value.data) === true) {
             return bufferReplacement;
         }
         // We also check for native Buffer instances if they haven't been pre-processed
@@ -93,6 +95,7 @@ class MessageSender {
     socket;
     toString;
     contextId;
+    _maximumPayloadSizeInBytes;
     constructor(logger, parameters, socket, toString, contextId) {
         this.logger = logger;
         this.parameters = parameters;
@@ -100,6 +103,9 @@ class MessageSender {
         this.toString = toString;
         this.contextId = contextId;
     }
+    set maximumPayloadSizeInBytes(value) {
+        this._maximumPayloadSizeInBytes = value;
+    }
     sendMessage(channel, body, callback) {
         const contextId = this.contextId;
         this.logger.debug(`Sending the message '${stringifyWithStrippedBuffers(body)}' on channel '${channel}' for ${this.toString()}${contextId === undefined ? "" : ` attached to the context with id '${contextId}'`}${callback === undefined ? "" : " and waiting for a callback"}`);
@@ -134,6 +140,7 @@ export class Communicator {
         this.logger[level](message);
         this.sendMessage(notificationsChannel, { log: { message, level } });
     }
+    // noinspection JSUnusedGlobalSymbols
     sendNotification(value) {
         this.sendMessage(notificationsChannel, { notification: value });
     }
@@ -232,34 +239,43 @@ export class PicteusExtension {
     async initialize() {
         return true;
     }
-    async onReady(communicator) {
+    async onReady(_communicator) {
     }
     async onTerminate() {
     }
-    async onSettings(communicator, value) {
+    async onSettings(_communicator, _value) {
         return Promise.resolve();
     }
-    // noinspection JSUnusedLocalSymbols
-    async onEvent(communicator, event, value) {
+    async onEvent(_communicator, _event, _value) {
     }
+    // noinspection JSUnusedGlobalSymbols
     getMiscellaneousApi() {
         return new MiscellaneousApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
     getApiSecretApi() {
         return new ApiSecretApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
     getExtensionApi() {
         return new ExtensionApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
     getRepositoryApi() {
         return new RepositoryApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
+    getCollectionApi() {
+        return new CollectionApi(this.configuration);
+    }
     getImageApi() {
         return new ImageApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
     getImageAttachmentApi() {
         return new ImageAttachmentApi(this.configuration);
     }
+    // noinspection JSUnusedGlobalSymbols
     async getSettings() {
         return (await new ExtensionApi(this.configuration).extensionGetSettings({ id: this.extensionId })).value;
     }
@@ -280,7 +296,16 @@ export class PicteusExtension {
         this.globalCommunicator = new Communicator(this.logger, globalSender);
         this.socket.on("connect", async () => {
             this.logger.info(`The ${this.toString()} socket is connected`);
-            await this.onReady(this.globalCommunicator);
+            globalSender.sendMessage("connection", {
+                isOpen: true,
+                sdkVersion: PicteusExtension.getSdkVersion(),
+                environment: "node"
+            }, async (result) => {
+                const maximumPayloadSizeInBytes = result.maximumPayloadSizeInBytes;
+                this.logger.debug(`The ${this.toString()} socket has a maximum payload size of ${maximumPayloadSizeInBytes} bytes`);
+                globalSender.maximumPayloadSizeInBytes = maximumPayloadSizeInBytes;
+                await this.onReady(this.globalCommunicator);
+            });
         });
         this.socket.on("connect_error", async () => {
             this.logger.warn(`The ${this.toString()} socket connection failed"`);
@@ -294,6 +319,7 @@ export class PicteusExtension {
             const sender = new MessageSender(this.logger, this.parameters, this.socket, () => {
                 return this.toString();
             }, contextId);
+            sender.maximumPayloadSizeInBytes = globalSender.maximumPayloadSizeInBytes;
             const communicator = new Communicator(this.logger, sender);
             const isRegularEvent = channel !== extensionSettingsEvent;
             let result;
@@ -314,11 +340,6 @@ export class PicteusExtension {
                 onResult(result);
             }
         });
-        globalSender.sendMessage("connection", {
-            isOpen: true,
-            sdkVersion: PicteusExtension.getSdkVersion(),
-            environment: "node"
-        });
     }
     disconnectSocket() {
         if (this.socket !== undefined && this.socket.disconnected === false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picteus/extension-sdk",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "productName": "Picteus TypeScript SDK",
   "description": "The Picteus extension TypeScript SDK.",
   "keywords": [