@picteus/extension-sdk 0.8.0 → 0.10.0

package/dist/picteusExtension.d.ts

@@ -1,5 +1,6 @@
 import { Socket } from "socket.io-client";
-import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, Json, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
+import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
+import { Intent } from "./intents.js";
 export type NotificationValue = Record<string, any>;
 export declare enum NotificationReturnedErrorCause {
     Cancel = 0,
@@ -9,71 +10,12 @@ export declare class NotificationReturnedError extends Error {
     readonly reason: NotificationReturnedErrorCause;
     constructor(message: string, reason: NotificationReturnedErrorCause);
 }
-export interface NotificationsParametersIntent {
-    readonly parameters: Json;
-}
-export declare enum NotificationsUiAnchor {
-    Modal = "modal",
-    Sidebar = "sidebar",
-    ImageDetail = "imageDetail"
-}
-export interface NotificationsUi {
-    readonly anchor: NotificationsUiAnchor;
-    readonly url: string;
-}
-export interface NotificationsUiIntent {
-    readonly ui: NotificationsUi;
-}
-export declare enum NotificationsDialogType {
-    Error = "Error",
-    Info = "Info",
-    Question = "Question"
-}
-export interface NotificationsDialog {
-    readonly type: NotificationsDialogType;
-    readonly title: string;
-    readonly description: string;
-    readonly details?: string;
-    readonly buttons: {
-        yes: string;
-        no?: string;
-    };
-}
-export interface NotificationsDialogIntent {
-    readonly dialog: NotificationsDialog;
-}
-export interface NotificationsImage {
-    readonly imageId: string;
-    readonly title?: string;
-    readonly description?: string;
-    readonly details?: string;
-}
-export interface NotificationsImages {
-    readonly images: NotificationsImage[];
-    readonly title?: string;
-    readonly description?: string;
-    readonly details?: string;
-}
-export interface NotificationsImagesIntent {
-    readonly images: NotificationsImages;
-}
-export declare enum NotificationsShowType {
-    ExtensionSettings = "ExtensionSettings",
-    Image = "Image",
-    Repository = "Repository"
-}
-export interface NotificationsShow {
-    readonly type: NotificationsShowType;
-    readonly id: string;
-}
-export interface NotificationsShowIntent {
-    readonly show: NotificationsShow;
-}
-export type NotificationsIntent = NotificationsParametersIntent | NotificationsUiIntent | NotificationsDialogIntent | NotificationsImagesIntent | NotificationsShowIntent;
 export declare enum NotificationEvent {
     ProcessRunCommand = "process.runCommand",
     ImageCreated = "image.created",
     ImageUpdated = "image.updated",
+    ImageTagsUpdated = "image.tags.updated",
+    ImageFeaturesUpdated = "image.features.updated",
     ImageDeleted = "image.deleted",
     ImageComputeFeatures = "image.computeFeatures",
     ImageComputeEmbeddings = "image.computeEmbeddings",
@@ -125,7 +67,7 @@ export declare class Communicator {
     constructor(logger: Logger, sender: MessageSender);
     sendLog(message: string, level: "debug" | "info" | "warn" | "error"): void;
     sendNotification(value: Record<string, any>): void;
-    launchIntent<T>(intent: NotificationsIntent): Promise<T>;
+    launchIntent<T>(intent: Intent): Promise<T>;
     private sendMessage;
 }
 export type SettingsValue = Record<string, any>;
@@ -134,6 +76,7 @@ export declare class PicteusExtension {
     static getSdkVersion(): string;
     static getCacheDirectoryPath(): string;
     static getExtensionHomeDirectoryPath(): string;
+    static readonly SOFTWARE: string;
     protected readonly logger: Logger;
     protected readonly parameters: ExtensionParameters;
     protected readonly extensionId: string;

package/dist/picteusExtension.js

@@ -17,30 +17,13 @@ export class NotificationReturnedError extends Error {
         this.reason = reason;
     }
 }
-export var NotificationsUiAnchor;
-(function (NotificationsUiAnchor) {
-    // noinspection JSUnusedGlobalSymbols
-    NotificationsUiAnchor["Modal"] = "modal";
-    NotificationsUiAnchor["Sidebar"] = "sidebar";
-    NotificationsUiAnchor["ImageDetail"] = "imageDetail";
-})(NotificationsUiAnchor || (NotificationsUiAnchor = {}));
-export var NotificationsDialogType;
-(function (NotificationsDialogType) {
-    NotificationsDialogType["Error"] = "Error";
-    NotificationsDialogType["Info"] = "Info";
-    NotificationsDialogType["Question"] = "Question";
-})(NotificationsDialogType || (NotificationsDialogType = {}));
-export var NotificationsShowType;
-(function (NotificationsShowType) {
-    NotificationsShowType["ExtensionSettings"] = "ExtensionSettings";
-    NotificationsShowType["Image"] = "Image";
-    NotificationsShowType["Repository"] = "Repository";
-})(NotificationsShowType || (NotificationsShowType = {}));
 export var NotificationEvent;
 (function (NotificationEvent) {
     NotificationEvent["ProcessRunCommand"] = "process.runCommand";
     NotificationEvent["ImageCreated"] = "image.created";
     NotificationEvent["ImageUpdated"] = "image.updated";
+    NotificationEvent["ImageTagsUpdated"] = "image.tags.updated";
+    NotificationEvent["ImageFeaturesUpdated"] = "image.features.updated";
     NotificationEvent["ImageDeleted"] = "image.deleted";
     NotificationEvent["ImageComputeFeatures"] = "image.computeFeatures";
     NotificationEvent["ImageComputeEmbeddings"] = "image.computeEmbeddings";
@@ -90,6 +73,20 @@ class ExtensionParameters {
         this.webServicesBaseUrl = parameters.webServicesBaseUrl;
     }
 }
+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) {
+            return bufferReplacement;
+        }
+        // We also check for native Buffer instances if they haven't been pre-processed
+        if (Buffer.isBuffer(value) === true) {
+            return bufferReplacement;
+        }
+        return value;
+    }, 0);
+};
 class MessageSender {
     logger;
     parameters;
@@ -105,7 +102,7 @@ class MessageSender {
     }
     sendMessage(channel, body, callback) {
         const contextId = this.contextId;
-        this.logger.debug(`Sending the message '${JSON.stringify(body)}' on channel '${channel}' for ${this.toString()}${contextId === undefined ? "" : ` attached to the context with id '${contextId}'`}${callback === undefined ? "" : " and waiting for a callback"}`);
+        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"}`);
         const value = {
             extensionId: this.parameters.extensionId,
             ...body
@@ -143,7 +140,7 @@ export class Communicator {
     async launchIntent(intent) {
         return await new Promise((resolve, reject) => {
             this.sendMessage(notificationsChannel, { intent }, async ({ value, cancel, error }) => {
-                this.logger.debug(`Received a result related to the intent '${JSON.stringify(intent)}' for ${this.sender.toString()}`);
+                this.logger.debug(`Received a result related to the intent '${stringifyWithStrippedBuffers(intent)}' for ${this.sender.toString()}`);
                 if (cancel !== undefined) {
                     reject(new NotificationReturnedError(cancel, NotificationReturnedErrorCause.Cancel));
                 }
@@ -173,6 +170,7 @@ export class PicteusExtension {
     static getExtensionHomeDirectoryPath() {
         return path.resolve(process.cwd());
     }
+    static SOFTWARE = "picteus";
     logger = new Logger();
     parameters;
     extensionId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picteus/extension-sdk",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "productName": "Picteus TypeScript SDK",
   "description": "The Picteus extension TypeScript SDK.",
   "keywords": [
@@ -13,15 +13,15 @@
     "email": "edouard@koppasoft.com",
     "url": "https://github.com/edouardmercier"
   },
-  "license": "Copyright (C) 2024 KoppaSoft. The code hereby is the private full property of the KoppaSoft company, Paris, France. You have no right to re-use or modify it. There are no open-source, nor free license attached to it!",
+  "license": "GNU Affero General Public License",
   "private": false,
   "engines": {
     "node": ">=22.17.1"
   },
-  "homepage": "https://github.com/picteus/Picteus.git",
+  "homepage": "https://github.com/picteus/picteus.git",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/picteus/Picteus.git"
+    "url": "git+https://github.com/picteus/picteus.git"
   },
   "bugs": {
     "url": "https://github.com/picteus/Picteus/issues"