@picteus/extension-sdk 0.3.0 → 0.3.2

package/dist/picteus-ws-client/apis/ExtensionApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { Extension, ExtensionActivity, ExtensionGenerationOptions, ExtensionSettings, ExtensionsConfiguration } from '../models/index.js';
+import type { Extension, ExtensionActivity, ExtensionAndManual, ExtensionGenerationOptions, ExtensionSettings, ExtensionsConfiguration } from '../models/index.js';
+export interface ExtensionApiExtensionBuildRequest {
+    body: Blob;
+}
 export interface ExtensionApiExtensionGenerateRequest {
     withPublicSdk: boolean;
     extensionGenerationOptions: ExtensionGenerationOptions;
@@ -73,6 +76,20 @@ export interface ExtensionApiInterface {
      * Indicates the extension activities
      */
     extensionActivities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ExtensionActivity>>;
+    /**
+     * Compiles and packages an extension from its source code.
+     * @summary Builds an extension
+     * @param {Blob} body The extension archive
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExtensionApiInterface
+     */
+    extensionBuildRaw(requestParameters: ExtensionApiExtensionBuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Compiles and packages an extension from its source code.
+     * Builds an extension
+     */
+    extensionBuild(requestParameters: ExtensionApiExtensionBuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
      * Scaffolds an extension respecting a set of specifications.
      * @summary Generates an extension
@@ -96,12 +113,12 @@ export interface ExtensionApiInterface {
      * @throws {RequiredError}
      * @memberof ExtensionApiInterface
      */
-    extensionGetRaw(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>>;
+    extensionGetRaw(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionAndManual>>;
     /**
      * Returns the details about an extension.
      * Gets an extension
      */
-    extensionGet(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension>;
+    extensionGet(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionAndManual>;
     /**
      * Returns the details in terms of all installed extensions capabilities, i.e. what they can offer, and the command they offer.
      * @summary Provides the extensions configuration
@@ -277,6 +294,16 @@ export declare class ExtensionApi extends runtime.BaseAPI implements ExtensionAp
      * Indicates the extension activities
      */
     extensionActivities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ExtensionActivity>>;
+    /**
+     * Compiles and packages an extension from its source code.
+     * Builds an extension
+     */
+    extensionBuildRaw(requestParameters: ExtensionApiExtensionBuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Compiles and packages an extension from its source code.
+     * Builds an extension
+     */
+    extensionBuild(requestParameters: ExtensionApiExtensionBuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
      * Scaffolds an extension respecting a set of specifications.
      * Generates an extension
@@ -291,12 +318,12 @@ export declare class ExtensionApi extends runtime.BaseAPI implements ExtensionAp
      * Returns the details about an extension.
      * Gets an extension
      */
-    extensionGetRaw(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Extension>>;
+    extensionGetRaw(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionAndManual>>;
     /**
      * Returns the details about an extension.
      * Gets an extension
      */
-    extensionGet(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Extension>;
+    extensionGet(requestParameters: ExtensionApiExtensionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionAndManual>;
     /**
      * Returns the details in terms of all installed extensions capabilities, i.e. what they can offer, and the command they offer.
      * Provides the extensions configuration

package/dist/picteus-ws-client/apis/ExtensionApi.js

@@ -12,7 +12,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import { ExtensionFromJSON, ExtensionActivityFromJSON, ExtensionGenerationOptionsToJSON, ExtensionSettingsFromJSON, ExtensionSettingsToJSON, ExtensionsConfigurationFromJSON, } from '../models/index.js';
+import { ExtensionFromJSON, ExtensionActivityFromJSON, ExtensionAndManualFromJSON, ExtensionGenerationOptionsToJSON, ExtensionSettingsFromJSON, ExtensionSettingsToJSON, ExtensionsConfigurationFromJSON, } from '../models/index.js';
 /**
  *
  */
@@ -44,6 +44,38 @@ export class ExtensionApi extends runtime.BaseAPI {
         const response = await this.extensionActivitiesRaw(initOverrides);
         return await response.value();
     }
+    /**
+     * Compiles and packages an extension from its source code.
+     * Builds an extension
+     */
+    async extensionBuildRaw(requestParameters, initOverrides) {
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling extensionBuild().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/zip';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/build`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.BlobApiResponse(response);
+    }
+    /**
+     * Compiles and packages an extension from its source code.
+     * Builds an extension
+     */
+    async extensionBuild(requestParameters, initOverrides) {
+        const response = await this.extensionBuildRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Scaffolds an extension respecting a set of specifications.
      * Generates an extension
@@ -103,7 +135,7 @@ export class ExtensionApi extends runtime.BaseAPI {
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionAndManualFromJSON(jsonValue));
     }
     /**
      * Returns the details about an extension.

package/dist/picteus-ws-client/models/ExtensionAndManual.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.3.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ExtensionManual } from './ExtensionManual.js';
+import type { ExtensionStatus } from './ExtensionStatus.js';
+import type { Manifest } from './Manifest.js';
+/**
+ *
+ * @export
+ * @interface ExtensionAndManual
+ */
+export interface ExtensionAndManual {
+    /**
+     * The extension manifest
+     * @type {Manifest}
+     * @memberof ExtensionAndManual
+     */
+    manifest: Manifest;
+    /**
+     * The status of the extension
+     * @type {ExtensionStatus}
+     * @memberof ExtensionAndManual
+     */
+    status: ExtensionStatus;
+    /**
+     * The extension manual
+     * @type {ExtensionManual}
+     * @memberof ExtensionAndManual
+     */
+    manual?: ExtensionManual;
+}
+/**
+ * Check if a given object implements the ExtensionAndManual interface.
+ */
+export declare function instanceOfExtensionAndManual(value: object): value is ExtensionAndManual;
+export declare function ExtensionAndManualFromJSON(json: any): ExtensionAndManual;
+export declare function ExtensionAndManualFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtensionAndManual;
+export declare function ExtensionAndManualToJSON(json: any): ExtensionAndManual;
+export declare function ExtensionAndManualToJSONTyped(value?: ExtensionAndManual | null, ignoreDiscriminator?: boolean): any;

package/dist/picteus-ws-client/models/ExtensionAndManual.js

@@ -0,0 +1,52 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.3.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ExtensionManualFromJSON, ExtensionManualToJSON, } from './ExtensionManual.js';
+import { ExtensionStatusFromJSON, ExtensionStatusToJSON, } from './ExtensionStatus.js';
+import { ManifestFromJSON, ManifestToJSON, } from './Manifest.js';
+/**
+ * Check if a given object implements the ExtensionAndManual interface.
+ */
+export function instanceOfExtensionAndManual(value) {
+    if (!('manifest' in value) || value['manifest'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function ExtensionAndManualFromJSON(json) {
+    return ExtensionAndManualFromJSONTyped(json, false);
+}
+export function ExtensionAndManualFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'manifest': ManifestFromJSON(json['manifest']),
+        'status': ExtensionStatusFromJSON(json['status']),
+        'manual': json['manual'] == null ? undefined : ExtensionManualFromJSON(json['manual']),
+    };
+}
+export function ExtensionAndManualToJSON(json) {
+    return ExtensionAndManualToJSONTyped(json, false);
+}
+export function ExtensionAndManualToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'manifest': ManifestToJSON(value['manifest']),
+        'status': ExtensionStatusToJSON(value['status']),
+        'manual': ExtensionManualToJSON(value['manual']),
+    };
+}

package/dist/picteus-ws-client/models/ExtensionManual.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.3.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ExtensionManual
+ */
+export interface ExtensionManual {
+    /**
+     * The instructions
+     * @type {string}
+     * @memberof ExtensionManual
+     */
+    instructions: string;
+}
+/**
+ * Check if a given object implements the ExtensionManual interface.
+ */
+export declare function instanceOfExtensionManual(value: object): value is ExtensionManual;
+export declare function ExtensionManualFromJSON(json: any): ExtensionManual;
+export declare function ExtensionManualFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtensionManual;
+export declare function ExtensionManualToJSON(json: any): ExtensionManual;
+export declare function ExtensionManualToJSONTyped(value?: ExtensionManual | null, ignoreDiscriminator?: boolean): any;

package/dist/picteus-ws-client/models/ExtensionManual.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.3.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ExtensionManual interface.
+ */
+export function instanceOfExtensionManual(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+export function ExtensionManualFromJSON(json) {
+    return ExtensionManualFromJSONTyped(json, false);
+}
+export function ExtensionManualFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+    };
+}
+export function ExtensionManualToJSON(json) {
+    return ExtensionManualToJSONTyped(json, false);
+}
+export function ExtensionManualToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+    };
+}

package/dist/picteus-ws-client/models/index.d.ts

@@ -8,10 +8,12 @@ export * from './Dates.js';
 export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityKind.js';
+export * from './ExtensionAndManual.js';
 export * from './ExtensionGenerationOptions.js';
 export * from './ExtensionImageEmbeddings.js';
 export * from './ExtensionImageFeature.js';
 export * from './ExtensionImageTag.js';
+export * from './ExtensionManual.js';
 export * from './ExtensionSettings.js';
 export * from './ExtensionStatus.js';
 export * from './ExtensionsConfiguration.js';

package/dist/picteus-ws-client/models/index.js

@@ -10,10 +10,12 @@ export * from './Dates.js';
 export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityKind.js';
+export * from './ExtensionAndManual.js';
 export * from './ExtensionGenerationOptions.js';
 export * from './ExtensionImageEmbeddings.js';
 export * from './ExtensionImageFeature.js';
 export * from './ExtensionImageTag.js';
+export * from './ExtensionManual.js';
 export * from './ExtensionSettings.js';
 export * from './ExtensionStatus.js';
 export * from './ExtensionsConfiguration.js';

package/dist/picteusExtension.d.ts

@@ -93,7 +93,7 @@ export declare class Logger {
     readonly error: LeveledLogMethod;
 }
 declare class ExtensionParameters {
-    readonly apiKey: string;
+    readonly apiKey?: string;
     readonly extensionId: string;
     readonly webServicesBaseUrl: string;
     constructor(parameters: Record<string, any>);
@@ -116,6 +116,7 @@ export declare class Communicator {
     launchIntent<T>(intent: NotificationsIntent): Promise<T>;
     private sendMessage;
 }
+export type SettingsValue = Record<string, any>;
 export declare class PicteusExtension {
     static getSdkVersion(): string;
     protected readonly logger: Logger;
@@ -132,11 +133,12 @@ export declare class PicteusExtension {
     protected initialize(): Promise<boolean>;
     protected onReady(communicator?: Communicator): Promise<void>;
     protected onTerminate(): Promise<void>;
+    protected onSettings(communicator: Communicator, value: SettingsValue): Promise<void>;
     protected onEvent(communicator: Communicator, event: string, value: NotificationValue): Promise<any>;
     protected getRepositoryApi(): RepositoryApi;
     protected getImageApi(): ImageApi;
     protected getImageAttachmentApi(): ImageAttachmentApi;
-    protected getSettings(): Promise<Record<string, any>>;
+    protected getSettings(): Promise<SettingsValue>;
     private getParameters;
     private connectSocket;
     private disconnectSocket;

package/dist/picteusExtension.js

@@ -48,6 +48,7 @@ export var NotificationEvent;
     NotificationEvent["ImageRunCommand"] = "image.runCommand";
     NotificationEvent["TextComputeEmbeddings"] = "text.computeEmbeddings";
 })(NotificationEvent || (NotificationEvent = {}));
+const extensionSettingsEvent = "extension.settings";
 const dateToString = (date) => {
     function padNumber(number, length) {
         return number.toString().padStart(length, "0");
@@ -64,7 +65,7 @@ const computeLeveledLogMethod = (logger, level) => {
     };
 };
 export class Logger {
-    debug = computeLeveledLogMethod(this, "debug");
+    debug = computeLeveledLogMethod(this, "log");
     info = computeLeveledLogMethod(this, "info");
     warn = computeLeveledLogMethod(this, "warn");
     error = computeLeveledLogMethod(this, "error");
@@ -96,10 +97,13 @@ class MessageSender {
         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"}`);
         const value = {
-            apiKey: this.parameters.apiKey,
             extensionId: this.parameters.extensionId,
             ...body
         };
+        // If there is no API key, we do not set it
+        if (this.parameters.apiKey !== undefined) {
+            value.apiKey = this.parameters.apiKey;
+        }
         if (contextId !== undefined) {
             value.contextId = contextId;
         }
@@ -215,6 +219,9 @@ export class PicteusExtension {
     }
     async onTerminate() {
     }
+    async onSettings(communicator, value) {
+        return Promise.resolve();
+    }
     // noinspection JSUnusedLocalSymbols
     async onEvent(communicator, event, value) {
     }
@@ -262,10 +269,11 @@ export class PicteusExtension {
                 return this.toString();
             }, contextId);
             const communicator = new Communicator(this.logger, sender);
+            const isRegularEvent = channel !== extensionSettingsEvent;
             let result;
             let success = false;
             try {
-                result = await this.onEvent(communicator, channel, value);
+                result = await (isRegularEvent === true ? this.onEvent(communicator, channel, value) : this.onSettings(communicator, value.value));
                 success = true;
             }
             catch (error) {
@@ -277,7 +285,7 @@ export class PicteusExtension {
             finally {
                 sender.sendMessage(notificationsChannel, { acknowledgment: { success } });
             }
-            if (result !== undefined && onResult !== undefined) {
+            if (isRegularEvent === true && result !== undefined && onResult !== undefined) {
                 onResult(result);
             }
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picteus/extension-sdk",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "productName": "Picteus TypeScript SDK",
   "description": "The Picteus extension TypeScript SDK.",
   "keywords": [
@@ -16,7 +16,7 @@
   "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!",
   "private": false,
   "engines": {
-    "node": ">=20"
+    "node": ">=22.17.1"
   },
   "homepage": "https://github.com/picteus/Picteus.git",
   "repository": {
@@ -38,8 +38,8 @@
     "./dist"
   ],
   "scripts": {
-    "compile": "tsc && tsc-alias",
-    "build": "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",
+    "compileWithTsup": "tsup src/index.ts --tsconfig tsconfig.json --format cjs,esm --dts --clean --minify-whitespace --minify-identifiers --minify-syntax"
   },
   "devDependencies": {
     "typescript": "5.9.2",