@picteus/extension-sdk 0.18.0 → 0.20.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, CollectionApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, IntentToastType, ManifestFromJSON, MiscellaneousApi, RepositoryApi } from "./index.js";
+import { ApiSecretApi, CollectionApi, Configuration, ExtensionApi, GenerationRecipeVersion, ImageApi, ImageAttachmentApi, IntentToastType, ManifestFromJSON, MiscellaneousApi, RepositoryApi, Software, TagsPlaceholder } from "./index.js";
 export const InstructionReturnedErrorCause = { Cancel: 0, Error: 1 };
 export class InstructionReturnedError extends Error {
     reason;
@@ -39,7 +39,9 @@ const extensionReadyChannel = "extension.ready";
 const extensionSettingsChannel = "extension.settings";
 // noinspection JSUnusedGlobalSymbols
 export class Helper {
-    static GENERATION_RECIPE_SCHEMA_VERSION = 2;
+    static SOFTWARE = Software.Picteus;
+    static GENERATION_RECIPE_SCHEMA_VERSION = GenerationRecipeVersion.NUMBER_2;
+    static TAGS_PLACEHOLDER = TagsPlaceholder.Tags;
 }
 export class ApiCallError extends Error {
     details;
@@ -136,13 +138,21 @@ const instructionsEvent = "instructions";
 export class Communicator {
     logger;
     sender;
-    constructor(logger, sender) {
+    entity;
+    constructor(logger, sender, entity) {
         this.logger = logger;
         this.sender = sender;
+        this.entity = entity;
     }
-    sendLog(message, level) {
+    forEntity(entity) {
+        this.entity = entity;
+        return this;
+    }
+    sendLog(message, level, entity) {
         this.logger[level](message);
-        this.sendMessage(instructionsEvent, { log: { message, level } });
+        const actualEntity = entity ?? this.entity;
+        const log = actualEntity === undefined ? { message, level } : { message, level, entity: actualEntity };
+        this.sendMessage(instructionsEvent, { log });
     }
     // noinspection JSUnusedGlobalSymbols
     sendNotification(value) {
@@ -182,7 +192,7 @@ export class PicteusExtension {
     static getExtensionHomeDirectoryPath() {
         return path.resolve(process.cwd());
     }
-    static SOFTWARE = "picteus";
+    static SOFTWARE = Software.Picteus;
     logger = new Logger();
     parameters;
     extensionId;
@@ -246,47 +256,45 @@ export class PicteusExtension {
     }
     async onEvent(communicator, event, value) {
         if (event === EventName.ImageCreated) {
-            const imageId = value["id"];
-            return await this.onImageCreated(communicator, imageId);
+            return await this.onImageCreated(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageUpdated) {
-            const imageId = value["id"];
-            return await this.onImageUpdated(communicator, imageId);
+            return await this.onImageUpdated(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageDeleted) {
-            const imageId = value["id"];
-            return await this.onImageDeleted(communicator, imageId);
+            return await this.onImageDeleted(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageTagsUpdated) {
-            const imageId = value["id"];
-            return await this.onImageTagsUpdated(communicator, imageId);
+            return await this.onImageTagsUpdated(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageFeaturesUpdated) {
-            const imageId = value["id"];
-            return await this.onImageFeaturesUpdated(communicator, imageId);
+            return await this.onImageFeaturesUpdated(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageComputeTags) {
-            const imageId = value["id"];
-            return await this.onComputeImageTags(communicator, imageId);
+            const eligibleTags = value["eligibleTags"];
+            if (eligibleTags !== undefined) {
+                return await this.onComputeImageEligibleTags(communicator, this.extractEventValueId(value), eligibleTags);
+            }
+            return await this.onComputeImageTags(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageComputeFeatures) {
-            const imageId = value["id"];
-            return await this.onComputeImageFeatures(communicator, imageId);
+            const captions = value["captions"];
+            if (captions !== undefined) {
+                return await this.onComputeImageCaptions(communicator, this.extractEventValueId(value), captions);
+            }
+            return await this.onComputeImageFeatures(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageComputeEmbeddings) {
-            const imageId = value["id"];
-            return await this.onComputeImageEmbeddings(communicator, imageId);
+            return await this.onComputeImageEmbeddings(communicator, this.extractEventValueId(value));
         }
         else if (event === EventName.ImageRunCommand) {
-            const commandId = value["commandId"];
             const imageIds = value["imageIds"];
             const parameters = value["parameters"] ?? {};
-            return await this.onImagesCommand(communicator, commandId, imageIds, parameters);
+            return await this.onImagesCommand(communicator, this.extractEventCommandId(value), imageIds, parameters);
         }
         else if (event === EventName.ProcessRunCommand) {
-            const commandId = value["commandId"];
             const parameters = value["parameters"] ?? {};
-            return await this.onProcessCommand(communicator, commandId, parameters);
+            return await this.onProcessCommand(communicator, this.extractEventCommandId(value), parameters);
         }
         else if (event === EventName.TextComputeEmbeddings) {
             const text = value["text"];
@@ -305,8 +313,12 @@ export class PicteusExtension {
     }
     async onComputeImageTags(_communicator, _imageId) {
     }
+    async onComputeImageEligibleTags(_communicator, _imageId, _eligibleTags) {
+    }
     async onComputeImageFeatures(_communicator, _imageId) {
     }
+    async onComputeImageCaptions(_communicator, _imageId, _captions) {
+    }
     async onComputeImageEmbeddings(_communicator, _imageId) {
     }
     async onImagesCommand(_communicator, _commandId, _imageIds, _parameters) {
@@ -386,7 +398,8 @@ export class PicteusExtension {
                 return this.toString();
             }, contextId);
             sender.maximumPayloadSizeInBytes = globalSender.maximumPayloadSizeInBytes;
-            const communicator = new Communicator(this.logger, sender);
+            const entity = this.computeEventEntity(channel, value);
+            const communicator = new Communicator(this.logger, sender, entity);
             const requiresResult = channel !== extensionSettingsChannel;
             let result;
             let success = false;
@@ -486,4 +499,26 @@ export class PicteusExtension {
             ]
         });
     }
+    computeEventEntity(channel, value) {
+        const imageComputationEvents = new Set([
+            EventName.ImageCreated,
+            EventName.ImageUpdated,
+            EventName.ImageTagsUpdated,
+            EventName.ImageFeaturesUpdated,
+            EventName.ImageDeleted,
+            EventName.ImageComputeTags,
+            EventName.ImageComputeFeatures,
+            EventName.ImageComputeEmbeddings
+        ]);
+        if (imageComputationEvents.has(channel) === false) {
+            return undefined;
+        }
+        return { type: "image", id: this.extractEventValueId(value) };
+    }
+    extractEventValueId(value) {
+        return value["id"];
+    }
+    extractEventCommandId(value) {
+        return value["commandId"];
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picteus/extension-sdk",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "productName": "Picteus TypeScript SDK",
   "description": "The Picteus extension TypeScript SDK.",
   "keywords": [
@@ -38,14 +38,12 @@
     "./dist"
   ],
   "scripts": {
-    "compile": "tsc && tsc-alias --resolve-full-paths",
-    "compileWithTsup": "tsup src/index.ts --tsconfig tsconfig.json --format cjs,esm --dts --clean --minify-whitespace --minify-identifiers --minify-syntax"
+    "compile": "tsc && tsc-alias --resolve-full-paths"
   },
   "devDependencies": {
     "typescript": "5.9.2",
-    "@types/node": "20.19.0",
-    "tsc-alias": "1.8.17",
-    "tsup": "8.5.1"
+    "@types/node": "22.17.1",
+    "tsc-alias": "1.8.17"
   },
   "dependencies": {
     "socket.io-client": "4.8.3"