@picteus/extension-sdk 0.9.0 → 0.11.0

package/dist/Intents.d.ts

@@ -0,0 +1,125 @@
+type Json = Record<string, any>;
+export interface IntentIdentity {
+    readonly id: string;
+}
+export interface IntentContext {
+    readonly imageIds?: string[];
+}
+export interface BasisIntent {
+    readonly identity?: IntentIdentity;
+}
+export interface WithContextIntent extends BasisIntent {
+    readonly context?: IntentContext;
+}
+export interface IntentResourceUrl {
+    readonly url: string;
+}
+export interface IntentResourceContent {
+    readonly content: Buffer;
+}
+export type IntentResource = IntentResourceUrl | IntentResourceContent;
+export interface IntentDialogContent {
+    readonly title: string;
+    readonly description: string;
+    readonly details?: string;
+}
+export interface IntentDialogIconContent extends IntentDialogContent {
+    readonly icon?: IntentResource;
+}
+export interface IntentDialogIconSizeContent extends IntentDialogIconContent {
+    readonly size?: "auto" | "xs" | "s" | "m" | "l" | "xl";
+}
+export interface IntentFormContent {
+    readonly parameters: Json;
+    readonly dialogContent?: IntentDialogIconSizeContent;
+}
+export interface FormIntent extends WithContextIntent {
+    readonly form: IntentFormContent;
+}
+export declare enum IntentUiAnchor {
+    Modal = "modal",
+    Sidebar = "sidebar",
+    Window = "window",
+    ImageDetail = "imageDetail"
+}
+export interface IntentUISidebarIntegration {
+    anchor: IntentUiAnchor.Sidebar;
+    isExternal: boolean;
+}
+export interface IntentUIWindowIntegration {
+    anchor: IntentUiAnchor.Window;
+}
+export interface IntentUIModalIntegration {
+    anchor: IntentUiAnchor.Modal;
+}
+export type IntentUIIntegration = IntentUISidebarIntegration | IntentUIWindowIntegration | IntentUIModalIntegration;
+export interface IntentUrlContent {
+    readonly url: string;
+}
+export interface IntentHtmlContent {
+    readonly html: string;
+}
+export type IntentFrameContent = IntentUrlContent | IntentHtmlContent;
+export interface IntentUi {
+    readonly id: string;
+    readonly integration: IntentUIIntegration;
+    readonly frameContent: IntentFrameContent;
+    readonly dialogContent?: IntentDialogIconContent;
+}
+export interface UiIntent extends WithContextIntent {
+    readonly ui: IntentUi;
+}
+export declare enum IntentDialogType {
+    Error = "error",
+    Info = "info",
+    Question = "question"
+}
+export interface IntentFrame {
+    readonly content: IntentFrameContent;
+    readonly height: number;
+}
+export interface IntentDialogButtons {
+    yes: string;
+    no?: string;
+}
+export interface IntentDialog extends IntentDialogIconSizeContent {
+    readonly type: IntentDialogType;
+    readonly frame?: IntentFrame;
+    readonly buttons: IntentDialogButtons;
+}
+export interface DialogIntent extends WithContextIntent {
+    readonly dialog: IntentDialog;
+}
+export interface IntentImage {
+    readonly imageId: string;
+    readonly dialogContent?: IntentDialogContent;
+}
+export interface IntentImages {
+    readonly images: IntentImage[];
+    readonly dialogContent: IntentDialogIconContent;
+}
+export interface ImagesIntent extends WithContextIntent {
+    readonly images: IntentImages;
+}
+export declare enum IntentShowType {
+    Sidebar = "sidebar",
+    ExtensionSettings = "extensionSettings",
+    Image = "image",
+    Repository = "repository"
+}
+export interface IntentShow {
+    readonly type: IntentShowType;
+    readonly id: string;
+}
+export interface ShowIntent extends BasisIntent {
+    readonly show: IntentShow;
+}
+export interface IntentServeBundle {
+    readonly content: Buffer;
+    readonly settings?: Json;
+}
+export interface BundleIntent extends BasisIntent {
+    readonly serveBundle: IntentServeBundle;
+}
+export type Intent = FormIntent | UiIntent | DialogIntent | ImagesIntent | ShowIntent | BundleIntent;
+export {};

package/dist/Intents.js

@@ -0,0 +1,20 @@
+export var IntentUiAnchor;
+(function (IntentUiAnchor) {
+    IntentUiAnchor["Modal"] = "modal";
+    IntentUiAnchor["Sidebar"] = "sidebar";
+    IntentUiAnchor["Window"] = "window";
+    IntentUiAnchor["ImageDetail"] = "imageDetail";
+})(IntentUiAnchor || (IntentUiAnchor = {}));
+export var IntentDialogType;
+(function (IntentDialogType) {
+    IntentDialogType["Error"] = "error";
+    IntentDialogType["Info"] = "info";
+    IntentDialogType["Question"] = "question";
+})(IntentDialogType || (IntentDialogType = {}));
+export var IntentShowType;
+(function (IntentShowType) {
+    IntentShowType["Sidebar"] = "sidebar";
+    IntentShowType["ExtensionSettings"] = "extensionSettings";
+    IntentShowType["Image"] = "image";
+    IntentShowType["Repository"] = "repository";
+})(IntentShowType || (IntentShowType = {}));

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * from "./intents.js";
 export * from "./picteusExtension.js";
 export * from "./picteus-ws-client/index.js";

package/dist/index.js

@@ -1,2 +1,3 @@
+export * from "./intents.js";
 export * from "./picteusExtension.js";
 export * from "./picteus-ws-client/index.js";

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.10.0
+ * The version of the OpenAPI document: 0.15.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { ComputedImageFormat, ExtensionImageEmbeddings, ExtensionImageFeature, ExtensionImageTag, GenerationRecipe, Image, ImageDistance, ImageEmbeddings, ImageFeature, ImageFormat, ImageMediaUrl, ImageMetadata, ImageResizeRender, ImageSummaryList, SearchFilter, SearchRange } from '../models/index.js';
+import type { ComputedImageFormat, ExtensionImageEmbeddings, ExtensionImageFeature, ExtensionImageTag, GenerationRecipe, Image, ImageDistance, ImageEmbeddings, ImageFeature, ImageFormat, ImageMediaUrl, ImageMetadata, ImageResizeRender, SearchFeaturesResult, SearchImageIdResult, SearchImageResult, SearchImageSummaryResult, SearchMediaUrlResult, SearchParameters, SearchTagsResult } from '../models/index.js';
 export interface ImageApiImageClosestEmbeddingsImagesRequest {
     extensionId: string;
     count: number;
@@ -86,10 +86,29 @@ export interface ImageApiImageModifyRequest {
     id: string;
     body: Blob;
 }
-export interface ImageApiImageSearchRequest {
-    filter?: SearchFilter;
-    collectionId?: number;
-    range?: SearchRange;
+export interface ImageApiImageSearchFeaturesRequest {
+    searchParameters: SearchParameters;
+    extensionIds?: Array<string>;
+}
+export interface ImageApiImageSearchIdsRequest {
+    searchParameters: SearchParameters;
+}
+export interface ImageApiImageSearchImagesRequest {
+    searchParameters: SearchParameters;
+}
+export interface ImageApiImageSearchMediaUrlRequest {
+    searchParameters: SearchParameters;
+    format?: ImageFormat;
+    width?: number;
+    height?: number;
+    resizeRender?: ImageResizeRender;
+}
+export interface ImageApiImageSearchSummariesRequest {
+    searchParameters: SearchParameters;
+}
+export interface ImageApiImageSearchTagsRequest {
+    searchParameters: SearchParameters;
+    extensionIds?: Array<string>;
 }
 export interface ImageApiImageSetEmbeddingsRequest {
     id: string;
@@ -362,7 +381,7 @@ export interface ImageApiInterface {
      */
     imageGetTags(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * @summary Gets an URL of the image
      * @param {string} id The image identifier
      * @param {ImageFormat} [format] The image format
@@ -375,7 +394,7 @@ export interface ImageApiInterface {
      */
     imageMediaUrlRaw(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageMediaUrl>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrl(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMediaUrl>;
@@ -395,21 +414,95 @@ export interface ImageApiInterface {
      */
     imageModify(requestParameters: ImageApiImageModifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Image>;
     /**
-     * Searches for images, given criteria.
-     * @summary Searches images
-     * @param {SearchFilter} [filter] The filter which will be used to narrow down the returned items
-     * @param {number} [collectionId] The collection identifier to filter with to narrow down the returned items
-     * @param {SearchRange} [range] The range of items to consider following the search
+     * Retrieves image features following search parameters.
+     * @summary Retrieves image features
+     * @param {SearchParameters} searchParameters
+     * @param {Array<string>} [extensionIds] The extension identifiers the features must belong to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchFeaturesRaw(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchFeaturesResult>>;
+    /**
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeatures(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchFeaturesResult>;
+    /**
+     * Retrieves image ids following search parameters.
+     * @summary Retrieves image ids
+     * @param {SearchParameters} searchParameters
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchIdsRaw(requestParameters: ImageApiImageSearchIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageIdResult>>;
+    /**
+     * Retrieves image ids following search parameters.
+     * Retrieves image ids
+     */
+    imageSearchIds(requestParameters: ImageApiImageSearchIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageIdResult>;
+    /**
+     * Retrieves image details following search parameters.
+     * @summary Retrieves image details
+     * @param {SearchParameters} searchParameters
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchImagesRaw(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageResult>>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImages(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageResult>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * @summary Retrieves image media URLs
+     * @param {SearchParameters} searchParameters
+     * @param {ImageFormat} [format] The image format
+     * @param {number} [width] The image maximum width ; if not defined, the original width is used
+     * @param {number} [height] The image maximum height ; if not defined, the original height is used
+     * @param {ImageResizeRender} [resizeRender] The way the image should be resized
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchMediaUrlRaw(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchMediaUrlResult>>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrl(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchMediaUrlResult>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * @summary Retrieves image summaries
+     * @param {SearchParameters} searchParameters
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ImageApiInterface
      */
-    imageSearchRaw(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageSummaryList>>;
+    imageSearchSummariesRaw(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageSummaryResult>>;
     /**
-     * Searches for images, given criteria.
-     * Searches images
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
      */
-    imageSearch(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageSummaryList>;
+    imageSearchSummaries(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageSummaryResult>;
+    /**
+     * Retrieves image tags following search parameters.
+     * @summary Retrieves image tags
+     * @param {SearchParameters} searchParameters
+     * @param {Array<string>} [extensionIds] The extension identifiers the tags must belong to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImageApiInterface
+     */
+    imageSearchTagsRaw(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchTagsResult>>;
+    /**
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
+     */
+    imageSearchTags(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchTagsResult>;
     /**
      * Sets the computed embeddings of an image for a given extension.
      * @summary Sets the embeddings of an image
@@ -654,12 +747,12 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      */
     imageGetTags(requestParameters: ImageApiImageGetTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrlRaw(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageMediaUrl>>;
     /**
-     * Returns the URL of the image, given for some given dimensions and format, which may used to display it.
+     * Returns the URL of the image, given some given dimensions and format, which may used to display it.
      * Gets an URL of the image
      */
     imageMediaUrl(requestParameters: ImageApiImageMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageMediaUrl>;
@@ -674,15 +767,65 @@ export declare class ImageApi extends runtime.BaseAPI implements ImageApiInterfa
      */
     imageModify(requestParameters: ImageApiImageModifyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Image>;
     /**
-     * Searches for images, given criteria.
-     * Searches images
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeaturesRaw(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchFeaturesResult>>;
+    /**
+     * Retrieves image features following search parameters.
+     * Retrieves image features
+     */
+    imageSearchFeatures(requestParameters: ImageApiImageSearchFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchFeaturesResult>;
+    /**
+     * Retrieves image ids following search parameters.
+     * Retrieves image ids
+     */
+    imageSearchIdsRaw(requestParameters: ImageApiImageSearchIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageIdResult>>;
+    /**
+     * Retrieves image ids following search parameters.
+     * Retrieves image ids
+     */
+    imageSearchIds(requestParameters: ImageApiImageSearchIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageIdResult>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImagesRaw(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageResult>>;
+    /**
+     * Retrieves image details following search parameters.
+     * Retrieves image details
+     */
+    imageSearchImages(requestParameters: ImageApiImageSearchImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageResult>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrlRaw(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchMediaUrlResult>>;
+    /**
+     * Retrieves image media URLs following search parameters.
+     * Retrieves image media URLs
+     */
+    imageSearchMediaUrl(requestParameters: ImageApiImageSearchMediaUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchMediaUrlResult>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
+     */
+    imageSearchSummariesRaw(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchImageSummaryResult>>;
+    /**
+     * Retrieves image summaries following search parameters.
+     * Retrieves image summaries
+     */
+    imageSearchSummaries(requestParameters: ImageApiImageSearchSummariesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchImageSummaryResult>;
+    /**
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
      */
-    imageSearchRaw(requestParameters: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageSummaryList>>;
+    imageSearchTagsRaw(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchTagsResult>>;
     /**
-     * Searches for images, given criteria.
-     * Searches images
+     * Retrieves image tags following search parameters.
+     * Retrieves image tags
      */
-    imageSearch(requestParameters?: ImageApiImageSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageSummaryList>;
+    imageSearchTags(requestParameters: ImageApiImageSearchTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchTagsResult>;
     /**
      * Sets the computed embeddings of an image for a given extension.
      * Sets the embeddings of an image