@picteus/extension-sdk 0.8.0 → 0.10.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.9.0
+ * The version of the OpenAPI document: 0.14.1
  * 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.9.0
+ * The version of the OpenAPI document: 0.14.1
  * 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.9.0
+ * The version of the OpenAPI document: 0.14.1
  * 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.9.0
+ * The version of the OpenAPI document: 0.14.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -112,7 +112,7 @@ export class ApiSecretApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
         const response = await this.request({
             path: urlPath,
-            method: 'DELETE',
+            method: 'GET',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);

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

@@ -0,0 +1,167 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.14.1
+ * 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 * as runtime from '../runtime.js';
+import type { Collection, SearchFilter } from '../models/index.js';
+export interface CollectionApiCollectionCreateRequest {
+    name: string;
+    searchFilter: SearchFilter;
+    comment?: string;
+}
+export interface CollectionApiCollectionDeleteRequest {
+    id: number;
+}
+export interface CollectionApiCollectionGetRequest {
+    id: number;
+}
+export interface CollectionApiCollectionUpdateRequest {
+    id: number;
+    name?: string;
+    comment?: string;
+    searchFilter?: SearchFilter;
+}
+/**
+ * CollectionApi - interface
+ *
+ * @export
+ * @interface CollectionApiInterface
+ */
+export interface CollectionApiInterface {
+    /**
+     * Declares a new collection.
+     * @summary Creates a collection
+     * @param {string} name The collection name
+     * @param {SearchFilter} searchFilter The filter
+     * @param {string} [comment] A comment about the collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionApiInterface
+     */
+    collectionCreateRaw(requestParameters: CollectionApiCollectionCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Declares a new collection.
+     * Creates a collection
+     */
+    collectionCreate(requestParameters: CollectionApiCollectionCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+    /**
+     * Once deleted, it cannot be used anymore.
+     * @summary Deletes collection
+     * @param {number} id The collection identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionApiInterface
+     */
+    collectionDeleteRaw(requestParameters: CollectionApiCollectionDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Once deleted, it cannot be used anymore.
+     * Deletes collection
+     */
+    collectionDelete(requestParameters: CollectionApiCollectionDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the details about a collection.
+     * @summary Gets a collection
+     * @param {number} id The collection identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionApiInterface
+     */
+    collectionGetRaw(requestParameters: CollectionApiCollectionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Returns the details about a collection.
+     * Gets a collection
+     */
+    collectionGet(requestParameters: CollectionApiCollectionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+    /**
+     * Returns all the collections.
+     * @summary Lists all collections
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionApiInterface
+     */
+    collectionListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Collection>>>;
+    /**
+     * Returns all the collections.
+     * Lists all collections
+     */
+    collectionList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Collection>>;
+    /**
+     * Enables to modify its name, comment and parameters.
+     * @summary Updates a collection
+     * @param {number} id The collection identifier
+     * @param {string} [name] The collection name
+     * @param {string} [comment] A comment about the collection
+     * @param {SearchFilter} [searchFilter] The filter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionApiInterface
+     */
+    collectionUpdateRaw(requestParameters: CollectionApiCollectionUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Enables to modify its name, comment and parameters.
+     * Updates a collection
+     */
+    collectionUpdate(requestParameters: CollectionApiCollectionUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+}
+/**
+ *
+ */
+export declare class CollectionApi extends runtime.BaseAPI implements CollectionApiInterface {
+    /**
+     * Declares a new collection.
+     * Creates a collection
+     */
+    collectionCreateRaw(requestParameters: CollectionApiCollectionCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Declares a new collection.
+     * Creates a collection
+     */
+    collectionCreate(requestParameters: CollectionApiCollectionCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+    /**
+     * Once deleted, it cannot be used anymore.
+     * Deletes collection
+     */
+    collectionDeleteRaw(requestParameters: CollectionApiCollectionDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Once deleted, it cannot be used anymore.
+     * Deletes collection
+     */
+    collectionDelete(requestParameters: CollectionApiCollectionDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the details about a collection.
+     * Gets a collection
+     */
+    collectionGetRaw(requestParameters: CollectionApiCollectionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Returns the details about a collection.
+     * Gets a collection
+     */
+    collectionGet(requestParameters: CollectionApiCollectionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+    /**
+     * Returns all the collections.
+     * Lists all collections
+     */
+    collectionListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Collection>>>;
+    /**
+     * Returns all the collections.
+     * Lists all collections
+     */
+    collectionList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Collection>>;
+    /**
+     * Enables to modify its name, comment and parameters.
+     * Updates a collection
+     */
+    collectionUpdateRaw(requestParameters: CollectionApiCollectionUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>>;
+    /**
+     * Enables to modify its name, comment and parameters.
+     * Updates a collection
+     */
+    collectionUpdate(requestParameters: CollectionApiCollectionUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+}

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

@@ -0,0 +1,188 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.14.1
+ * 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 * as runtime from '../runtime.js';
+import { CollectionFromJSON, SearchFilterToJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class CollectionApi extends runtime.BaseAPI {
+    /**
+     * Declares a new collection.
+     * Creates a collection
+     */
+    async collectionCreateRaw(requestParameters, initOverrides) {
+        if (requestParameters['name'] == null) {
+            throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling collectionCreate().');
+        }
+        if (requestParameters['searchFilter'] == null) {
+            throw new runtime.RequiredError('searchFilter', 'Required parameter "searchFilter" was null or undefined when calling collectionCreate().');
+        }
+        const queryParameters = {};
+        if (requestParameters['name'] != null) {
+            queryParameters['name'] = requestParameters['name'];
+        }
+        if (requestParameters['comment'] != null) {
+            queryParameters['comment'] = requestParameters['comment'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/collection/create`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SearchFilterToJSON(requestParameters['searchFilter']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+    /**
+     * Declares a new collection.
+     * Creates a collection
+     */
+    async collectionCreate(requestParameters, initOverrides) {
+        const response = await this.collectionCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Once deleted, it cannot be used anymore.
+     * Deletes collection
+     */
+    async collectionDeleteRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling collectionDelete().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/collection/{id}/delete`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Once deleted, it cannot be used anymore.
+     * Deletes collection
+     */
+    async collectionDelete(requestParameters, initOverrides) {
+        await this.collectionDeleteRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Returns the details about a collection.
+     * Gets a collection
+     */
+    async collectionGetRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling collectionGet().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/collection/{id}/get`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+    /**
+     * Returns the details about a collection.
+     * Gets a collection
+     */
+    async collectionGet(requestParameters, initOverrides) {
+        const response = await this.collectionGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns all the collections.
+     * Lists all collections
+     */
+    async collectionListRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/collection/list`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CollectionFromJSON));
+    }
+    /**
+     * Returns all the collections.
+     * Lists all collections
+     */
+    async collectionList(initOverrides) {
+        const response = await this.collectionListRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Enables to modify its name, comment and parameters.
+     * Updates a collection
+     */
+    async collectionUpdateRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling collectionUpdate().');
+        }
+        const queryParameters = {};
+        if (requestParameters['name'] != null) {
+            queryParameters['name'] = requestParameters['name'];
+        }
+        if (requestParameters['comment'] != null) {
+            queryParameters['comment'] = requestParameters['comment'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/collection/{id}/update`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SearchFilterToJSON(requestParameters['searchFilter']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+    /**
+     * Enables to modify its name, comment and parameters.
+     * Updates a collection
+     */
+    async collectionUpdate(requestParameters, initOverrides) {
+        const response = await this.collectionUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}

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

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