@picteus/extension-sdk 0.4.0 → 0.5.1

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,7 +11,7 @@
  */
 import type { ManifestRuntimeEnvironment } from './ManifestRuntimeEnvironment.js';
 /**
- *
+ * The options for generating an extension
  * @export
  * @interface ExtensionGenerationOptions
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * Multiple vectorial representations of an image
  * @export
  * @interface ExtensionImageEmbeddings
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@
 import type { ImageFeatureFormat } from './ImageFeatureFormat.js';
 import type { ImageFeatureType } from './ImageFeatureType.js';
 /**
- *
+ * The image features, along with its extension identifier
  * @export
  * @interface ExtensionImageFeature
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * A tag on an image for a given extension
  * @export
  * @interface ExtensionImageTag
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * The instructions of an extension
  * @export
  * @interface ExtensionManual
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * The settings of an extension
  * @export
  * @interface ExtensionSettings
  */

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@
 import type { ConfigurationExtensionCommand } from './ConfigurationExtensionCommand.js';
 import type { ConfigurationCapability } from './ConfigurationCapability.js';
 /**
- *
+ * The extensions' configuration in respect of their capabilities and commands
  * @export
  * @interface ExtensionsConfiguration
  */

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

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

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

@@ -0,0 +1,69 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.5.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 type { GenerationRecipePrompt } from './GenerationRecipePrompt.js';
+/**
+ * The image generation recipe
+ * @export
+ * @interface GenerationRecipe
+ */
+export interface GenerationRecipe {
+    /**
+     * The identifier of the recipe instance
+     * @type {string}
+     * @memberof GenerationRecipe
+     */
+    id?: string;
+    /**
+     * The URL of the recipe instance
+     * @type {string}
+     * @memberof GenerationRecipe
+     */
+    url?: string;
+    /**
+     * The tags of the model generators
+     * @type {Array<string>}
+     * @memberof GenerationRecipe
+     */
+    modelTags: Array<string>;
+    /**
+     * The software that ran the generation
+     * @type {string}
+     * @memberof GenerationRecipe
+     */
+    software?: string;
+    /**
+     * The identifiers or URLs of the input assets
+     * @type {Array<string>}
+     * @memberof GenerationRecipe
+     */
+    inputAssets?: Array<string>;
+    /**
+     * The required image aspect ratio, i.e. the result of its width by its height
+     * @type {number}
+     * @memberof GenerationRecipe
+     */
+    aspectRatio?: number;
+    /**
+     *
+     * @type {GenerationRecipePrompt}
+     * @memberof GenerationRecipe
+     */
+    prompt?: GenerationRecipePrompt;
+}
+/**
+ * Check if a given object implements the GenerationRecipe interface.
+ */
+export declare function instanceOfGenerationRecipe(value: object): value is GenerationRecipe;
+export declare function GenerationRecipeFromJSON(json: any): GenerationRecipe;
+export declare function GenerationRecipeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerationRecipe;
+export declare function GenerationRecipeToJSON(json: any): GenerationRecipe;
+export declare function GenerationRecipeToJSONTyped(value?: GenerationRecipe | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.5.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 { GenerationRecipePromptFromJSON, GenerationRecipePromptToJSON, } from './GenerationRecipePrompt.js';
+/**
+ * Check if a given object implements the GenerationRecipe interface.
+ */
+export function instanceOfGenerationRecipe(value) {
+    if (!('modelTags' in value) || value['modelTags'] === undefined)
+        return false;
+    return true;
+}
+export function GenerationRecipeFromJSON(json) {
+    return GenerationRecipeFromJSONTyped(json, false);
+}
+export function GenerationRecipeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'modelTags': json['modelTags'],
+        'software': json['software'] == null ? undefined : json['software'],
+        'inputAssets': json['inputAssets'] == null ? undefined : json['inputAssets'],
+        'aspectRatio': json['aspectRatio'] == null ? undefined : json['aspectRatio'],
+        'prompt': json['prompt'] == null ? undefined : GenerationRecipePromptFromJSON(json['prompt']),
+    };
+}
+export function GenerationRecipeToJSON(json) {
+    return GenerationRecipeToJSONTyped(json, false);
+}
+export function GenerationRecipeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'url': value['url'],
+        'modelTags': value['modelTags'],
+        'software': value['software'],
+        'inputAssets': value['inputAssets'],
+        'aspectRatio': value['aspectRatio'],
+        'prompt': GenerationRecipePromptToJSON(value['prompt']),
+    };
+}

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

@@ -0,0 +1,22 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.5.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 type { TextualPrompt } from './TextualPrompt.js';
+/**
+ * @type GenerationRecipePrompt
+ * The prompt which enabled to generate the image
+ * @export
+ */
+export type GenerationRecipePrompt = TextualPrompt | object;
+export declare function GenerationRecipePromptFromJSON(json: any): GenerationRecipePrompt;
+export declare function GenerationRecipePromptFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerationRecipePrompt;
+export declare function GenerationRecipePromptToJSON(json: any): any;
+export declare function GenerationRecipePromptToJSONTyped(value?: GenerationRecipePrompt | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.5.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 { instanceOfTextualPrompt, TextualPromptFromJSONTyped, TextualPromptToJSON, } from './TextualPrompt.js';
+export function GenerationRecipePromptFromJSON(json) {
+    return GenerationRecipePromptFromJSONTyped(json, false);
+}
+export function GenerationRecipePromptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfTextualPrompt(json)) {
+        return TextualPromptFromJSONTyped(json, true);
+    }
+    return {};
+}
+export function GenerationRecipePromptToJSON(json) {
+    return GenerationRecipePromptToJSONTyped(json, false);
+}
+export function GenerationRecipePromptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfTextualPrompt(value)) {
+        return TextualPromptToJSON(value);
+    }
+    return {};
+}

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,7 +17,7 @@ import type { ImageGenerator } from './ImageGenerator.js';
 import type { ImageFeature } from './ImageFeature.js';
 import type { ImageFormat } from './ImageFormat.js';
 /**
- *
+ * Comprehensive information about an image
  * @export
  * @interface Image
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * The dimensions of an image
  * @export
  * @interface ImageDimensions
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,7 +11,7 @@
  */
 import type { ImageSummary } from './ImageSummary.js';
 /**
- *
+ * The vectorial distance with a reference image
  * @export
  * @interface ImageDistance
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * 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.
  */
 /**
- *
+ * A vectorial representation of an image
  * @export
  * @interface ImageEmbeddings
  */

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@
 import type { ImageFeatureFormat } from './ImageFeatureFormat.js';
 import type { ImageFeatureType } from './ImageFeatureType.js';
 /**
- *
+ * The image features
  * @export
  * @interface ImageFeature
  */

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

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

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

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

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

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

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

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,6 +16,7 @@
 export declare const ImageFeatureType: {
     readonly Caption: "caption";
     readonly Description: "description";
+    readonly Comment: "comment";
     readonly Metadata: "metadata";
     readonly Recipe: "recipe";
     readonly Other: "other";

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

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.4.0
+ * The version of the OpenAPI document: 0.5.1
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +18,7 @@
 export const ImageFeatureType = {
     Caption: 'caption',
     Description: 'description',
+    Comment: 'comment',
     Metadata: 'metadata',
     Recipe: 'recipe',
     Other: 'other'

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

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

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

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

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

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