@picteus/extension-sdk 0.18.0 → 0.20.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -0,0 +1,24 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.24.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.
+ */
+/**
+ * The tags placeholder to be used in questions for eligible tags
+ * @export
+ */
+export declare const TagsPlaceholder: {
+    readonly Tags: "{tags}";
+};
+export type TagsPlaceholder = typeof TagsPlaceholder[keyof typeof TagsPlaceholder];
+export declare function instanceOfTagsPlaceholder(value: any): boolean;
+export declare function TagsPlaceholderFromJSON(json: any): TagsPlaceholder;
+export declare function TagsPlaceholderFromJSONTyped(json: any, ignoreDiscriminator: boolean): TagsPlaceholder;
+export declare function TagsPlaceholderToJSON(value?: TagsPlaceholder | null): any;
+export declare function TagsPlaceholderToJSONTyped(value: any, ignoreDiscriminator: boolean): TagsPlaceholder;

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

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.24.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.
+ */
+/**
+ * The tags placeholder to be used in questions for eligible tags
+ * @export
+ */
+export const TagsPlaceholder = {
+    Tags: '{tags}'
+};
+export function instanceOfTagsPlaceholder(value) {
+    for (const key in TagsPlaceholder) {
+        if (Object.prototype.hasOwnProperty.call(TagsPlaceholder, key)) {
+            if (TagsPlaceholder[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function TagsPlaceholderFromJSON(json) {
+    return TagsPlaceholderFromJSONTyped(json, false);
+}
+export function TagsPlaceholderFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function TagsPlaceholderToJSON(value) {
+    return value;
+}
+export function TagsPlaceholderToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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,3 +1,4 @@
+export * from './AiModel.js';
 export * from './ApiSecret.js';
 export * from './ApiSecretSummary.js';
 export * from './ApiSecretType.js';
@@ -6,6 +7,7 @@ export * from './ApplicationMetadata.js';
 export * from './ApplicationMetadataItem.js';
 export * from './ApplicationMetadataItemValue.js';
 export * from './ApplicationSettings.js';
+export * from './CaptionInstruction.js';
 export * from './Collection.js';
 export * from './CommandEntity.js';
 export * from './ComputedImageFormat.js';
@@ -13,9 +15,11 @@ export * from './ConfigurationCapability.js';
 export * from './ConfigurationExtensionCommand.js';
 export * from './ConstantsRegistry.js';
 export * from './Dates.js';
+export * from './EligibleTagsInstruction.js';
 export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityState.js';
+export * from './ExtensionAiModel.js';
 export * from './ExtensionAndManual.js';
 export * from './ExtensionCategory.js';
 export * from './ExtensionGenerationOptions.js';
@@ -32,6 +36,7 @@ export * from './ExtensionState.js';
 export * from './ExtensionsConfiguration.js';
 export * from './GenerationRecipe.js';
 export * from './GenerationRecipePrompt.js';
+export * from './GenerationRecipeVersion.js';
 export * from './Image.js';
 export * from './ImageDimensions.js';
 export * from './ImageDistance.js';
@@ -49,6 +54,8 @@ export * from './ImageSummary.js';
 export * from './InstructionsPrompt.js';
 export * from './Manifest.js';
 export * from './ManifestCapability.js';
+export * from './ManifestCapabilityCaptionsDetails.js';
+export * from './ManifestCapabilityEligibleTagsDetails.js';
 export * from './ManifestCapabilityId.js';
 export * from './ManifestEvent.js';
 export * from './ManifestExecution.js';
@@ -56,7 +63,10 @@ export * from './ManifestExtensionCommand.js';
 export * from './ManifestExtensionCommandOn.js';
 export * from './ManifestExtensionCommandSpecification.js';
 export * from './ManifestExtensionCommandUi.js';
+export * from './ManifestImageFeaturesCapability.js';
+export * from './ManifestImageTagsCapability.js';
 export * from './ManifestInstructions.js';
+export * from './ManifestInstructionsCapabilitiesInner.js';
 export * from './ManifestInterfaceElement.js';
 export * from './ManifestInterfaceElementIntegration.js';
 export * from './ManifestRuntime.js';
@@ -96,6 +106,7 @@ export * from './SearchSortingProperty.js';
 export * from './SearchTags.js';
 export * from './SearchTagsResult.js';
 export * from './Software.js';
+export * from './TagsPlaceholder.js';
 export * from './TextualPrompt.js';
 export * from './UserInterfaceAnchor.js';
 export * from './UserInterfaceSidebarIntegration.js';

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

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AiModel.js';
 export * from './ApiSecret.js';
 export * from './ApiSecretSummary.js';
 export * from './ApiSecretType.js';
@@ -8,6 +9,7 @@ export * from './ApplicationMetadata.js';
 export * from './ApplicationMetadataItem.js';
 export * from './ApplicationMetadataItemValue.js';
 export * from './ApplicationSettings.js';
+export * from './CaptionInstruction.js';
 export * from './Collection.js';
 export * from './CommandEntity.js';
 export * from './ComputedImageFormat.js';
@@ -15,9 +17,11 @@ export * from './ConfigurationCapability.js';
 export * from './ConfigurationExtensionCommand.js';
 export * from './ConstantsRegistry.js';
 export * from './Dates.js';
+export * from './EligibleTagsInstruction.js';
 export * from './Extension.js';
 export * from './ExtensionActivity.js';
 export * from './ExtensionActivityState.js';
+export * from './ExtensionAiModel.js';
 export * from './ExtensionAndManual.js';
 export * from './ExtensionCategory.js';
 export * from './ExtensionGenerationOptions.js';
@@ -34,6 +38,7 @@ export * from './ExtensionState.js';
 export * from './ExtensionsConfiguration.js';
 export * from './GenerationRecipe.js';
 export * from './GenerationRecipePrompt.js';
+export * from './GenerationRecipeVersion.js';
 export * from './Image.js';
 export * from './ImageDimensions.js';
 export * from './ImageDistance.js';
@@ -51,6 +56,8 @@ export * from './ImageSummary.js';
 export * from './InstructionsPrompt.js';
 export * from './Manifest.js';
 export * from './ManifestCapability.js';
+export * from './ManifestCapabilityCaptionsDetails.js';
+export * from './ManifestCapabilityEligibleTagsDetails.js';
 export * from './ManifestCapabilityId.js';
 export * from './ManifestEvent.js';
 export * from './ManifestExecution.js';
@@ -58,7 +65,10 @@ export * from './ManifestExtensionCommand.js';
 export * from './ManifestExtensionCommandOn.js';
 export * from './ManifestExtensionCommandSpecification.js';
 export * from './ManifestExtensionCommandUi.js';
+export * from './ManifestImageFeaturesCapability.js';
+export * from './ManifestImageTagsCapability.js';
 export * from './ManifestInstructions.js';
+export * from './ManifestInstructionsCapabilitiesInner.js';
 export * from './ManifestInterfaceElement.js';
 export * from './ManifestInterfaceElementIntegration.js';
 export * from './ManifestRuntime.js';
@@ -98,6 +108,7 @@ export * from './SearchSortingProperty.js';
 export * from './SearchTags.js';
 export * from './SearchTagsResult.js';
 export * from './Software.js';
+export * from './TagsPlaceholder.js';
 export * from './TextualPrompt.js';
 export * from './UserInterfaceAnchor.js';
 export * from './UserInterfaceSidebarIntegration.js';

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteusExtension.d.ts

@@ -1,6 +1,6 @@
 import { Socket } from "socket.io-client";
-import { ApiSecretApi, CollectionApi, Configuration, ExtensionApi, ImageApi, ImageAttachmentApi, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
-import { Intent } from "./intents.js";
+import { AiModel, ApiSecretApi, BackIntent, CollectionApi, Configuration, ExtensionApi, FrontIntent, ImageApi, ImageAttachmentApi, Manifest, MiscellaneousApi, RepositoryApi } from "./index.js";
+export type Intent = FrontIntent | BackIntent;
 export type EventValue = Record<string, any>;
 export declare const InstructionReturnedErrorCause: {
     readonly Cancel: 0;
@@ -12,6 +12,15 @@ export declare class InstructionReturnedError extends Error {
     constructor(message: string, reason: InstructionReturnedErrorCause);
 }
 export type CommandParameters = Record<string, any>;
+export type ComputeImageCaption = {
+    aiModel: AiModel;
+    question: string;
+};
+export type ComputeImageEligibleTags = {
+    aiModel: AiModel;
+    question: string;
+    tags: string[];
+};
 export declare class CommandError extends Error {
     static fromError(error: CommandParameters): CommandError;
     constructor(message: string);
@@ -30,8 +39,14 @@ export declare const EventName: {
     readonly TextComputeEmbeddings: "text.computeEmbeddings";
 };
 export type EventName = (typeof EventName)[keyof typeof EventName];
+export type Entity = {
+    type: "image" | "repository" | "collection";
+    id: string | number;
+};
 export declare class Helper {
-    static readonly GENERATION_RECIPE_SCHEMA_VERSION = 2;
+    static readonly SOFTWARE: string;
+    static readonly GENERATION_RECIPE_SCHEMA_VERSION: number;
+    static readonly TAGS_PLACEHOLDER: string;
 }
 export interface ApiCallErrorDetails {
     status: number;
@@ -73,8 +88,10 @@ declare class MessageSender {
 export declare class Communicator {
     private readonly logger;
     private readonly sender;
-    constructor(logger: Logger, sender: MessageSender);
-    sendLog(message: string, level: "debug" | "info" | "warn" | "error"): void;
+    private entity;
+    constructor(logger: Logger, sender: MessageSender, entity?: Entity);
+    forEntity(entity: Entity): this;
+    sendLog(message: string, level: "debug" | "info" | "warn" | "error", entity?: Entity): void;
     sendNotification(value: Record<string, any>): void;
     launchIntent<T>(intent: Intent): Promise<T>;
     private sendMessage;
@@ -112,7 +129,9 @@ export declare class PicteusExtension {
     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 onComputeImageEligibleTags(_communicator: Communicator, _imageId: string, _eligibleTags: ComputeImageEligibleTags[]): Promise<void>;
     protected onComputeImageFeatures(_communicator: Communicator, _imageId: string): Promise<void>;
+    protected onComputeImageCaptions(_communicator: Communicator, _imageId: string, _captions: ComputeImageCaption[]): 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>;
@@ -130,5 +149,8 @@ export declare class PicteusExtension {
     private disconnectSocket;
     private exit;
     private getApiConfiguration;
+    private computeEventEntity;
+    private extractEventValueId;
+    private extractEventCommandId;
 }
 export {};