@picteus/extension-sdk 0.13.1 → 0.15.0

package/dist/intents.d.ts

@@ -69,6 +69,12 @@ export interface IntentUi {
 export interface UiIntent extends WithContextIntent {
     readonly ui: IntentUi;
 }
+export interface IntentOpenBrowser {
+    readonly url: string;
+}
+export interface OpenBrowserIntent extends BasisIntent {
+    readonly openBrowser: IntentOpenBrowser;
+}
 export declare enum IntentDialogType {
     Error = "error",
     Info = "info",
@@ -114,6 +120,46 @@ export interface IntentShow {
 export interface ShowIntent extends BasisIntent {
     readonly show: IntentShow;
 }
+export declare enum IntentToastType {
+    Info = "info",
+    Cancel = "cancel",
+    Error = "error"
+}
+export interface IntentToast {
+    readonly type: IntentToastType;
+    readonly title?: string;
+    readonly subtitle: string;
+}
+export interface ToastIntent extends WithContextIntent {
+    readonly toast: IntentToast;
+}
+export interface IntentNotification {
+    readonly title: string;
+    readonly subtitle: string;
+    readonly body: string;
+    readonly silent: boolean;
+    readonly icon?: Buffer;
+    readonly isNative: boolean;
+}
+export interface NotificationIntent extends WithContextIntent {
+    readonly notification: IntentNotification;
+}
+export interface IntentProcessCommand {
+    readonly extensionId: string;
+    readonly commandId: string;
+}
+export interface ProcessCommandIntent extends WithContextIntent {
+    readonly processCommand: IntentProcessCommand;
+}
+export interface IntentAction {
+    readonly intent: ShowIntent | UiIntent | OpenBrowserIntent | ProcessCommandIntent;
+    readonly dialogContent: IntentDialogIconSizeContent;
+    readonly label?: string;
+}
+export interface ActionIntent extends WithContextIntent {
+    readonly action: IntentAction;
+}
+export type FrontIntent = FormIntent | UiIntent | OpenBrowserIntent | DialogIntent | ImagesIntent | ShowIntent | ToastIntent | NotificationIntent | ActionIntent;
 export interface IntentServeBundle {
     readonly content: Buffer;
     readonly settings?: Json;
@@ -121,5 +167,22 @@ export interface IntentServeBundle {
 export interface BundleIntent extends BasisIntent {
     readonly serveBundle: IntentServeBundle;
 }
-export type Intent = FormIntent | UiIntent | DialogIntent | ImagesIntent | ShowIntent | BundleIntent;
+export interface IntentReadFile {
+    readonly extensions?: string[];
+    readonly message: string;
+}
+export interface ReadFileIntent extends WithContextIntent {
+    readonly readFile: IntentReadFile;
+}
+export interface IntentWriteFile {
+    readonly content: Buffer;
+    readonly name: string;
+    readonly extension: string;
+    readonly message: string;
+}
+export interface WriteFileIntent extends WithContextIntent {
+    readonly writeFile: IntentWriteFile;
+}
+export type BackIntent = BundleIntent | ReadFileIntent | WriteFileIntent;
+export type Intent = FrontIntent | BackIntent;
 export {};

package/dist/intents.js

@@ -18,3 +18,9 @@ export var IntentShowType;
     IntentShowType["Image"] = "image";
     IntentShowType["Repository"] = "repository";
 })(IntentShowType || (IntentShowType = {}));
+export var IntentToastType;
+(function (IntentToastType) {
+    IntentToastType["Info"] = "info";
+    IntentToastType["Cancel"] = "cancel";
+    IntentToastType["Error"] = "error";
+})(IntentToastType || (IntentToastType = {}));

package/dist/picteus-ws-client/apis/AdministrationApi.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/apis/AdministrationApi.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/apis/ApiSecretApi.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/apis/ApiSecretApi.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/apis/CollectionApi.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/apis/CollectionApi.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/apis/ExtensionApi.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).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { Extension, ExtensionActivity, ExtensionAndManual, ExtensionGenerationOptions, ExtensionSettings, ExtensionsConfiguration } from '../models/index.js';
+import type { Extension, ExtensionActivity, ExtensionAndManual, ExtensionGenerationOptions, ExtensionSettings, ExtensionsConfiguration, RunCommandParameters } from '../models/index.js';
 export interface ExtensionApiExtensionBuildRequest {
     body: Blob;
 }
@@ -36,11 +36,13 @@ export interface ExtensionApiExtensionPauseOrResumeRequest {
     id: string;
     isPause: boolean;
 }
+export interface ExtensionApiExtensionResetSettingsRequest {
+    id: string;
+}
 export interface ExtensionApiExtensionRunImageCommandRequest {
     id: string;
     commandId: string;
-    imageIds: Array<string>;
-    body?: object;
+    runCommandParameters: RunCommandParameters;
 }
 export interface ExtensionApiExtensionRunProcessCommandRequest {
     id: string;
@@ -210,19 +212,32 @@ export interface ExtensionApiInterface {
      */
     extensionPauseOrResume(requestParameters: ExtensionApiExtensionPauseOrResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Reverts the settings of an extension to its default value.
+     * @summary Resets the settings of an extension
+     * @param {string} id The extension identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExtensionApiInterface
+     */
+    extensionResetSettingsRaw(requestParameters: ExtensionApiExtensionResetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionSettings>>;
+    /**
+     * Reverts the settings of an extension to its default value.
+     * Resets the settings of an extension
+     */
+    extensionResetSettings(requestParameters: ExtensionApiExtensionResetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionSettings>;
+    /**
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * @summary Runs a command exposed by an extension, on images
      * @param {string} id The extension identifier
      * @param {string} commandId The identifier of the command
-     * @param {Array<string>} imageIds The identifiers of the images the command should be run against
-     * @param {object} [body] The command parameters
+     * @param {RunCommandParameters} runCommandParameters The parameters containing the instructions for running the command
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ExtensionApiInterface
      */
     extensionRunImageCommandRaw(requestParameters: ExtensionApiExtensionRunImageCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * Runs a command exposed by an extension, on images
      */
     extensionRunImageCommand(requestParameters: ExtensionApiExtensionRunImageCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -406,12 +421,22 @@ export declare class ExtensionApi extends runtime.BaseAPI implements ExtensionAp
      */
     extensionPauseOrResume(requestParameters: ExtensionApiExtensionPauseOrResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Reverts the settings of an extension to its default value.
+     * Resets the settings of an extension
+     */
+    extensionResetSettingsRaw(requestParameters: ExtensionApiExtensionResetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionSettings>>;
+    /**
+     * Reverts the settings of an extension to its default value.
+     * Resets the settings of an extension
+     */
+    extensionResetSettings(requestParameters: ExtensionApiExtensionResetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionSettings>;
+    /**
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * Runs a command exposed by an extension, on images
      */
     extensionRunImageCommandRaw(requestParameters: ExtensionApiExtensionRunImageCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * Runs a command exposed by an extension, on images
      */
     extensionRunImageCommand(requestParameters: ExtensionApiExtensionRunImageCommandRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

package/dist/picteus-ws-client/apis/ExtensionApi.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).
@@ -12,7 +12,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import { ExtensionFromJSON, ExtensionActivityFromJSON, ExtensionAndManualFromJSON, ExtensionGenerationOptionsToJSON, ExtensionSettingsFromJSON, ExtensionSettingsToJSON, ExtensionsConfigurationFromJSON, } from '../models/index.js';
+import { ExtensionFromJSON, ExtensionActivityFromJSON, ExtensionAndManualFromJSON, ExtensionGenerationOptionsToJSON, ExtensionSettingsFromJSON, ExtensionSettingsToJSON, ExtensionsConfigurationFromJSON, RunCommandParametersToJSON, } from '../models/index.js';
 /**
  *
  */
@@ -340,7 +340,38 @@ export class ExtensionApi extends runtime.BaseAPI {
         await this.extensionPauseOrResumeRaw(requestParameters, initOverrides);
     }
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Reverts the settings of an extension to its default value.
+     * Resets the settings of an extension
+     */
+    async extensionResetSettingsRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionResetSettings().');
+        }
+        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 = `/extension/{id}/resetSettings`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionSettingsFromJSON(jsonValue));
+    }
+    /**
+     * Reverts the settings of an extension to its default value.
+     * Resets the settings of an extension
+     */
+    async extensionResetSettings(requestParameters, initOverrides) {
+        const response = await this.extensionResetSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * Runs a command exposed by an extension, on images
      */
     async extensionRunImageCommandRaw(requestParameters, initOverrides) {
@@ -350,16 +381,13 @@ export class ExtensionApi extends runtime.BaseAPI {
         if (requestParameters['commandId'] == null) {
             throw new runtime.RequiredError('commandId', 'Required parameter "commandId" was null or undefined when calling extensionRunImageCommand().');
         }
-        if (requestParameters['imageIds'] == null) {
-            throw new runtime.RequiredError('imageIds', 'Required parameter "imageIds" was null or undefined when calling extensionRunImageCommand().');
+        if (requestParameters['runCommandParameters'] == null) {
+            throw new runtime.RequiredError('runCommandParameters', 'Required parameter "runCommandParameters" was null or undefined when calling extensionRunImageCommand().');
         }
         const queryParameters = {};
         if (requestParameters['commandId'] != null) {
             queryParameters['commandId'] = requestParameters['commandId'];
         }
-        if (requestParameters['imageIds'] != null) {
-            queryParameters['imageIds'] = requestParameters['imageIds'];
-        }
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
         if (this.configuration && this.configuration.apiKey) {
@@ -372,12 +400,12 @@ export class ExtensionApi extends runtime.BaseAPI {
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['body'],
+            body: RunCommandParametersToJSON(requestParameters['runCommandParameters']),
         }, initOverrides);
         return new runtime.VoidApiResponse(response);
     }
     /**
-     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Runs the command specified for images, by triggering the relevant event to the extension to images matching search parameters.
      * Runs a command exposed by an extension, on images
      */
     async extensionRunImageCommand(requestParameters, initOverrides) {