@picteus/extension-sdk 0.13.1 → 0.15.0

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -1,9 +1,11 @@
 export * from './ApiSecret.js';
 export * from './ApiSecretSummary.js';
 export * from './ApiSecretType.js';
+export * from './ApplicationConfiguration.js';
 export * from './ApplicationMetadata.js';
 export * from './ApplicationMetadataItem.js';
 export * from './ApplicationMetadataItemValue.js';
+export * from './ApplicationSettings.js';
 export * from './Collection.js';
 export * from './CommandEntity.js';
 export * from './ComputedImageFormat.js';
@@ -15,7 +17,9 @@ export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityKind.js';
 export * from './ExtensionAndManual.js';
+export * from './ExtensionCategory.js';
 export * from './ExtensionGenerationOptions.js';
+export * from './ExtensionIdImageEmbeddingName.js';
 export * from './ExtensionImageEmbeddings.js';
 export * from './ExtensionImageFeature.js';
 export * from './ExtensionImageFeatureName.js';
@@ -31,7 +35,7 @@ export * from './GenerationRecipePrompt.js';
 export * from './Image.js';
 export * from './ImageDimensions.js';
 export * from './ImageDistance.js';
-export * from './ImageEmbeddings.js';
+export * from './ImageEmbedding.js';
 export * from './ImageFeature.js';
 export * from './ImageFeatureFormat.js';
 export * from './ImageFeatureNullValue.js';
@@ -51,6 +55,7 @@ export * from './ManifestExecution.js';
 export * from './ManifestExtensionCommand.js';
 export * from './ManifestExtensionCommandOn.js';
 export * from './ManifestExtensionCommandSpecification.js';
+export * from './ManifestExtensionCommandUi.js';
 export * from './ManifestInstructions.js';
 export * from './ManifestInterfaceElement.js';
 export * from './ManifestInterfaceElementIntegration.js';
@@ -64,6 +69,7 @@ export * from './RepositoryActivity.js';
 export * from './RepositoryActivityKind.js';
 export * from './RepositoryLocationType.js';
 export * from './RepositoryStatus.js';
+export * from './RunCommandParameters.js';
 export * from './SearchCriteria.js';
 export * from './SearchFeatureComparisonOperator.js';
 export * from './SearchFeatureCondition.js';
@@ -89,7 +95,6 @@ export * from './SearchSorting.js';
 export * from './SearchSortingProperty.js';
 export * from './SearchTags.js';
 export * from './SearchTagsResult.js';
-export * from './Settings.js';
 export * from './Software.js';
 export * from './TextualPrompt.js';
 export * from './UserInterfaceAnchor.js';

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

@@ -3,9 +3,11 @@
 export * from './ApiSecret.js';
 export * from './ApiSecretSummary.js';
 export * from './ApiSecretType.js';
+export * from './ApplicationConfiguration.js';
 export * from './ApplicationMetadata.js';
 export * from './ApplicationMetadataItem.js';
 export * from './ApplicationMetadataItemValue.js';
+export * from './ApplicationSettings.js';
 export * from './Collection.js';
 export * from './CommandEntity.js';
 export * from './ComputedImageFormat.js';
@@ -17,7 +19,9 @@ export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityKind.js';
 export * from './ExtensionAndManual.js';
+export * from './ExtensionCategory.js';
 export * from './ExtensionGenerationOptions.js';
+export * from './ExtensionIdImageEmbeddingName.js';
 export * from './ExtensionImageEmbeddings.js';
 export * from './ExtensionImageFeature.js';
 export * from './ExtensionImageFeatureName.js';
@@ -33,7 +37,7 @@ export * from './GenerationRecipePrompt.js';
 export * from './Image.js';
 export * from './ImageDimensions.js';
 export * from './ImageDistance.js';
-export * from './ImageEmbeddings.js';
+export * from './ImageEmbedding.js';
 export * from './ImageFeature.js';
 export * from './ImageFeatureFormat.js';
 export * from './ImageFeatureNullValue.js';
@@ -53,6 +57,7 @@ export * from './ManifestExecution.js';
 export * from './ManifestExtensionCommand.js';
 export * from './ManifestExtensionCommandOn.js';
 export * from './ManifestExtensionCommandSpecification.js';
+export * from './ManifestExtensionCommandUi.js';
 export * from './ManifestInstructions.js';
 export * from './ManifestInterfaceElement.js';
 export * from './ManifestInterfaceElementIntegration.js';
@@ -66,6 +71,7 @@ export * from './RepositoryActivity.js';
 export * from './RepositoryActivityKind.js';
 export * from './RepositoryLocationType.js';
 export * from './RepositoryStatus.js';
+export * from './RunCommandParameters.js';
 export * from './SearchCriteria.js';
 export * from './SearchFeatureComparisonOperator.js';
 export * from './SearchFeatureCondition.js';
@@ -91,7 +97,6 @@ export * from './SearchSorting.js';
 export * from './SearchSortingProperty.js';
 export * from './SearchTags.js';
 export * from './SearchTagsResult.js';
-export * from './Settings.js';
 export * from './Software.js';
 export * from './TextualPrompt.js';
 export * from './UserInterfaceAnchor.js';

package/dist/picteus-ws-client/runtime.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/runtime.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.17.1
+ * The version of the OpenAPI document: 0.19.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteusExtension.d.ts

@@ -1,28 +1,35 @@
 import { Socket } from "socket.io-client";
-import { ApiSecretApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
+import { ApiSecretApi, CollectionApi, 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,
-    Error = 1
+export type EventValue = Record<string, any>;
+export declare const InstructionReturnedErrorCause: {
+    readonly Cancel: 0;
+    readonly Error: 1;
+};
+export type InstructionReturnedErrorCause = (typeof InstructionReturnedErrorCause)[keyof typeof InstructionReturnedErrorCause];
+export declare class InstructionReturnedError extends Error {
+    readonly reason: InstructionReturnedErrorCause;
+    constructor(message: string, reason: InstructionReturnedErrorCause);
 }
-export declare class NotificationReturnedError extends Error {
-    readonly reason: NotificationReturnedErrorCause;
-    constructor(message: string, reason: NotificationReturnedErrorCause);
-}
-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",
-    ImageComputeTags = "image.computeTags",
-    ImageRunCommand = "image.runCommand",
-    TextComputeEmbeddings = "text.computeEmbeddings"
+export type CommandParameters = Record<string, any>;
+export declare class CommandError extends Error {
+    static fromError(error: CommandParameters): CommandError;
+    constructor(message: string);
 }
+export declare const EventName: {
+    readonly ProcessRunCommand: "process.runCommand";
+    readonly ImageCreated: "image.created";
+    readonly ImageUpdated: "image.updated";
+    readonly ImageTagsUpdated: "image.tags.updated";
+    readonly ImageFeaturesUpdated: "image.features.updated";
+    readonly ImageDeleted: "image.deleted";
+    readonly ImageComputeFeatures: "image.computeFeatures";
+    readonly ImageComputeEmbeddings: "image.computeEmbeddings";
+    readonly ImageComputeTags: "image.computeTags";
+    readonly ImageRunCommand: "image.runCommand";
+    readonly TextComputeEmbeddings: "text.computeEmbeddings";
+};
+export type EventName = (typeof EventName)[keyof typeof EventName];
 export declare class Helper {
     static readonly GENERATION_RECIPE_SCHEMA_VERSION = 1;
 }
@@ -58,8 +65,10 @@ declare class MessageSender {
     private readonly socket;
     readonly toString: () => string;
     private readonly contextId?;
+    private _maximumPayloadSizeInBytes?;
     constructor(logger: Logger, parameters: ExtensionParameters, socket: Socket, toString: () => string, contextId?: string);
-    sendMessage(channel: string, body: Record<string, any>, callback?: (result: any) => Promise<void>): void;
+    set maximumPayloadSizeInBytes(value: number);
+    sendMessage(event: string, body: Record<string, any>, callback?: (result: any) => Promise<void>): void;
 }
 export declare class Communicator {
     private readonly logger;
@@ -71,6 +80,10 @@ export declare class Communicator {
     private sendMessage;
 }
 export type SettingsValue = Record<string, any>;
+export type Versions = {
+    previous: string | undefined;
+    current: string;
+};
 export declare class PicteusExtension {
     static getManifest(): Manifest;
     static getSdkVersion(): string;
@@ -84,25 +97,38 @@ export declare class PicteusExtension {
     protected readonly apiKey: string;
     protected readonly configuration: Configuration;
     private socket?;
-    private globalCommunicator?;
     constructor();
     run(): Promise<void>;
     protected toString(): string;
     protected initialize(): Promise<boolean>;
-    protected onReady(communicator?: Communicator): Promise<void>;
+    protected onUpgrade(_communicator: Communicator, _versions: Versions): Promise<void>;
+    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 onSettings(_communicator: Communicator, _value: SettingsValue): Promise<void>;
+    protected onEvent(communicator: Communicator, event: EventName, value: EventValue): Promise<any>;
+    protected onImageCreated(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onImageUpdated(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onImageDeleted(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onImageTagsUpdated(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onImageFeaturesUpdated(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onComputeImageTags(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onComputeImageFeatures(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onComputeImageEmbeddings(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onImagesCommand(_communicator: Communicator, _commandId: string, _imageIds: string[], _parameters: CommandParameters): Promise<void>;
+    protected onProcessCommand(_communicator: Communicator, _commandId: string, _parameters: CommandParameters): Promise<void>;
+    protected onComputeTextEmbeddings(_communicator: Communicator, _text: string): Promise<number[]>;
     protected getMiscellaneousApi(): MiscellaneousApi;
     protected getApiSecretApi(): ApiSecretApi;
     protected getExtensionApi(): ExtensionApi;
     protected getRepositoryApi(): RepositoryApi;
+    protected getCollectionApi(): CollectionApi;
     protected getImageApi(): ImageApi;
     protected getImageAttachmentApi(): ImageAttachmentApi;
     protected getSettings(): Promise<SettingsValue>;
     private getParameters;
     private connectSocket;
     private disconnectSocket;
+    private exit;
     private getApiConfiguration;
 }
 export {};