@osaas/client-services 0.12.1 → 0.14.0

package/lib/generated/ablindberg-chaosmaker.js

@@ -0,0 +1,86 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAblindbergChaosmakerInstance = exports.removeAblindbergChaosmakerInstance = exports.createAblindbergChaosmakerInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * @namespace ablindberg-chaosmaker
+ * @description Experience seamless management and enhance video streaming resilience with Chaos Stream Proxy Configurator! Effortlessly handle various network conditions and create chaos configurations through an intuitive interface.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} AblindbergChaosmakerConfig
+ * @property {string} name - Name of chaosmaker
+
+ *
+ */
+/**
+ * @typedef {Object} AblindbergChaosmaker
+ * @property {string} name - Name of the Chaos Maker instance
+ * @property {string} url - URL of the Chaos Maker instance
+ *
+ */
+/**
+ * Create a new Chaos Maker instance
+ *
+ * @memberOf ablindberg-chaosmaker
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {AblindbergChaosmakerConfig} body - Service instance configuration
+ * @returns {AblindbergChaosmaker} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createAblindbergChaosmakerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: AblindbergChaosmakerConfig = { name: 'myinstance', ... };
+ * const instance = await createAblindbergChaosmakerInstance(ctx, body);
+ * console.log(instance.url);
+ */
+async function createAblindbergChaosmakerInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('ablindberg-chaosmaker');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'ablindberg-chaosmaker', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('ablindberg-chaosmaker', instance.name, ctx);
+    return instance;
+}
+exports.createAblindbergChaosmakerInstance = createAblindbergChaosmakerInstance;
+/**
+ * Remove a Chaos Maker instance
+ *
+ * @memberOf ablindberg-chaosmaker
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the chaosmaker to be removed
+ */
+async function removeAblindbergChaosmakerInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('ablindberg-chaosmaker');
+    await (0, client_core_1.removeInstance)(ctx, 'ablindberg-chaosmaker', name, serviceAccessToken);
+}
+exports.removeAblindbergChaosmakerInstance = removeAblindbergChaosmakerInstance;
+/**
+ * Get a Chaos Maker instance
+ *
+ * @memberOf ablindberg-chaosmaker
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the chaosmaker to be retrieved
+ * @returns {AblindbergChaosmaker} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getAblindbergChaosmakerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getAblindbergChaosmakerInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+async function getAblindbergChaosmakerInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('ablindberg-chaosmaker');
+    return await (0, client_core_1.getInstance)(ctx, 'ablindberg-chaosmaker', name, serviceAccessToken);
+}
+exports.getAblindbergChaosmakerInstance = getAblindbergChaosmakerInstance;
+//# sourceMappingURL=ablindberg-chaosmaker.js.map

package/lib/generated/ablindberg-chaosmaker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ablindberg-chaosmaker.js","sourceRoot":"","sources":["../../src/generated/ablindberg-chaosmaker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAigBH,oDAM4B;AAC5B;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,kCAAkC,CACtD,GAAY,EACZ,IAAgC;IAEhC,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,uBAAuB,CACxB,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,uBAAuB,EACvB,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,uBAAuB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACxE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAfD,gFAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kCAAkC,CACtD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,uBAAuB,CACxB,CAAC;IACF,MAAM,IAAA,4BAAc,EAAC,GAAG,EAAE,uBAAuB,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AAC/E,CAAC;AARD,gFAQC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,+BAA+B,CACnD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,uBAAuB,CACxB,CAAC;IACF,OAAO,MAAM,IAAA,yBAAW,EACtB,GAAG,EACH,uBAAuB,EACvB,IAAI,EACJ,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAbD,0EAaC"}

package/lib/generated/ablindberg-osc-vmaf-studio.d.ts

@@ -0,0 +1,585 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Health check endpoint */
+        get: {
+            parameters: {
+                query: {
+                    verbose?: boolean;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: Partial<string> & Partial<{
+                        status: string;
+                        versions: {
+                            '@osaas/orchestrator': string;
+                        };
+                        environment: string;
+                        _links: {
+                            self: {
+                                href: string;
+                            };
+                            api: {
+                                href: string;
+                            };
+                        };
+                    }>;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        status: string;
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/osc-vmaf-studioinstance': {
+        /** List all running osc-vmaf-studio instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: ({
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        oscAccessToken?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    })[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new osc-vmaf-studio instance */
+        post: {
+            parameters: {
+                query: {
+                    beta?: boolean;
+                };
+                body: {
+                    body?: {
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name: string;
+                        oscAccessToken?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        oscAccessToken?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                403: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                409: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/restart/{id}': {
+        /** Restart osc-vmaf-studio */
+        post: {
+            parameters: {
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/osc-vmaf-studioinstance/{id}': {
+        /** Obtain status and resource URLs for an osc-vmaf-studio instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        oscAccessToken?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Stop and remove an osc-vmaf-studio instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Patch osc-vmaf-studio instance with new parameters and restart */
+        patch: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name?: string;
+                        oscAccessToken?: string;
+                    };
+                };
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the osc-vmaf-studio instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        oscAccessToken?: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                400: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of osc-vmaf-studio instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                        images?: string[];
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the osc-vmaf-studio instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/ports/{id}': {
+        /** Return the exposed extra ports for osc-vmaf-studio instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the osc-vmaf-studio instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        externalIp: string;
+                        externalPort: number;
+                        internalPort: number;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface definitions {
+}
+export interface operations {
+}
+export interface external {
+}
+export type AblindbergOscVmafStudio = paths['/osc-vmaf-studioinstance/{id}']['get']['responses']['200']['schema'];
+export type AblindbergOscVmafStudioConfig = paths['/osc-vmaf-studioinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * @namespace ablindberg-osc-vmaf-studio
+ * @description Transform your video quality assessment with OSC VMAF Studio, a cloud-based tool leveraging OSC and Eyevinn EasyVMAF. Enjoy effortless S3 storage management, detailed VMAF analysis, and secure credentials.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} AblindbergOscVmafStudioConfig
+ * @property {string} name - Name of osc-vmaf-studio
+ * @property {string} [oscAccessToken] - Personal Access Token for authenticating with OSC (Open Source Cloud) services, specifically required for accessing Eyevinn EasyVMAF service that performs the VMAF video quality analysis
+
+ *
+ */
+/**
+ * @typedef {Object} AblindbergOscVmafStudio
+ * @property {string} name - Name of the VMAF Studio instance
+ * @property {string} url - URL of the VMAF Studio instance
+ *
+ */
+/**
+ * Create a new VMAF Studio instance
+ *
+ * @memberOf ablindberg-osc-vmaf-studio
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {AblindbergOscVmafStudioConfig} body - Service instance configuration
+ * @returns {AblindbergOscVmafStudio} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createAblindbergOscVmafStudioInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: AblindbergOscVmafStudioConfig = { name: 'myinstance', ... };
+ * const instance = await createAblindbergOscVmafStudioInstance(ctx, body);
+ * console.log(instance.url);
+ */
+export declare function createAblindbergOscVmafStudioInstance(ctx: Context, body: AblindbergOscVmafStudioConfig): Promise<AblindbergOscVmafStudio>;
+/**
+ * Remove a VMAF Studio instance
+ *
+ * @memberOf ablindberg-osc-vmaf-studio
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the vmaf-studio to be removed
+ */
+export declare function removeAblindbergOscVmafStudioInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a VMAF Studio instance
+ *
+ * @memberOf ablindberg-osc-vmaf-studio
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the vmaf-studio to be retrieved
+ * @returns {AblindbergOscVmafStudio} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getAblindbergOscVmafStudioInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getAblindbergOscVmafStudioInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+export declare function getAblindbergOscVmafStudioInstance(ctx: Context, name: string): Promise<AblindbergOscVmafStudio>;
+//# sourceMappingURL=ablindberg-osc-vmaf-studio.d.ts.map