@osaas/client-services 0.11.6 → 0.12.0

package/lib/generated/birme-vacay-planner.js

@@ -0,0 +1,88 @@
+"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.getBirmeVacayPlannerInstance = exports.removeBirmeVacayPlannerInstance = exports.createBirmeVacayPlannerInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * @namespace birme-vacay-planner
+ * @description Simplify team trips with Vacation Planner, a seamless web app for scheduling and managing vacations. Enjoy easy calendar integration, real-time updates, and role-based access control for a stress-free planning experience.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2025 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} BirmeVacayPlannerConfig
+ * @property {string} name - Name of vacay-planner
+ * @property {string} DbUrl - DbUrl
+ * @property {string} JwtSecret - Enter a secret key for encryption
+
+ *
+ */
+/**
+ * @typedef {Object} BirmeVacayPlanner
+ * @property {string} name - Name of the Vacay Planner instance
+ * @property {string} url - URL of the Vacay Planner instance
+ *
+ */
+/**
+ * Create a new Vacay Planner instance
+ *
+ * @memberOf birme-vacay-planner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {BirmeVacayPlannerConfig} body - Service instance configuration
+ * @returns {BirmeVacayPlanner} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createBirmeVacayPlannerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: BirmeVacayPlannerConfig = { name: 'myinstance', ... };
+ * const instance = await createBirmeVacayPlannerInstance(ctx, body);
+ * console.log(instance.url);
+ */
+async function createBirmeVacayPlannerInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('birme-vacay-planner');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'birme-vacay-planner', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('birme-vacay-planner', instance.name, ctx);
+    return instance;
+}
+exports.createBirmeVacayPlannerInstance = createBirmeVacayPlannerInstance;
+/**
+ * Remove a Vacay Planner instance
+ *
+ * @memberOf birme-vacay-planner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the vacay-planner to be removed
+ */
+async function removeBirmeVacayPlannerInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('birme-vacay-planner');
+    await (0, client_core_1.removeInstance)(ctx, 'birme-vacay-planner', name, serviceAccessToken);
+}
+exports.removeBirmeVacayPlannerInstance = removeBirmeVacayPlannerInstance;
+/**
+ * Get a Vacay Planner instance
+ *
+ * @memberOf birme-vacay-planner
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the vacay-planner to be retrieved
+ * @returns {BirmeVacayPlanner} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getBirmeVacayPlannerInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getBirmeVacayPlannerInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+async function getBirmeVacayPlannerInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('birme-vacay-planner');
+    return await (0, client_core_1.getInstance)(ctx, 'birme-vacay-planner', name, serviceAccessToken);
+}
+exports.getBirmeVacayPlannerInstance = getBirmeVacayPlannerInstance;
+//# sourceMappingURL=birme-vacay-planner.js.map

package/lib/generated/birme-vacay-planner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"birme-vacay-planner.js","sourceRoot":"","sources":["../../src/generated/birme-vacay-planner.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA6fH,oDAM4B;AAC5B;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,+BAA+B,CACnD,GAAY,EACZ,IAA6B;IAE7B,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,qBAAqB,EACrB,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAfD,0EAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,+BAA+B,CACnD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,MAAM,IAAA,4BAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AAC7E,CAAC;AARD,0EAQC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,4BAA4B,CAChD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,OAAO,MAAM,IAAA,yBAAW,EACtB,GAAG,EACH,qBAAqB,EACrB,IAAI,EACJ,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAbD,oEAaC"}

package/lib/generated/birme-video-uploader.d.ts

@@ -0,0 +1,587 @@
+/**
+ * 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;
+                    };
+                };
+            };
+        };
+    };
+    '/video-uploaderinstance': {
+        /** List all running video-uploader instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: ({
+                        /** @description Name of the video-uploader 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;
+                            };
+                        };
+                        s3Endpoint?: string;
+                        s3AccessKey: string;
+                        s3SecretKey: string;
+                        s3AwsRegion?: 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;
+                            };
+                        };
+                    })[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new video-uploader instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the video-uploader instance */
+                        name: string;
+                        s3Endpoint?: string;
+                        s3AccessKey: string;
+                        s3SecretKey: string;
+                        s3AwsRegion?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the video-uploader 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;
+                            };
+                        };
+                        s3Endpoint?: string;
+                        s3AccessKey: string;
+                        s3SecretKey: string;
+                        s3AwsRegion?: 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;
+                            };
+                        };
+                    };
+                };
+                /** 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 video-uploader */
+        post: {
+            parameters: {
+                path: {
+                    /** Name of the video-uploader instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/video-uploaderinstance/{id}': {
+        /** Obtain status and resource URLs for an video-uploader instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the video-uploader instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the video-uploader 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;
+                            };
+                        };
+                        s3Endpoint?: string;
+                        s3AccessKey: string;
+                        s3SecretKey: string;
+                        s3AwsRegion?: 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;
+                            };
+                        };
+                    };
+                };
+                /** 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 video-uploader instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the video-uploader instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Patch video-uploader instance with new parameters and restart */
+        patch: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the video-uploader instance */
+                        name?: string;
+                        s3Endpoint?: string;
+                        s3AccessKey?: string;
+                        s3SecretKey?: string;
+                        s3AwsRegion?: string;
+                    };
+                };
+                path: {
+                    /** Name of the video-uploader instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the video-uploader 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;
+                            };
+                        };
+                        s3Endpoint?: string;
+                        s3AccessKey: string;
+                        s3SecretKey: string;
+                        s3AwsRegion?: 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;
+                            };
+                        };
+                    };
+                };
+                /** 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 video-uploader instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the video-uploader 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 video-uploader instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the video-uploader 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 video-uploader instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the video-uploader 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 BirmeVideoUploader = paths['/video-uploaderinstance/{id}']['get']['responses']['200']['schema'];
+export type BirmeVideoUploaderConfig = paths['/video-uploaderinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * @namespace birme-video-uploader
+ * @description Effortlessly upload and manage your videos with our intuitive Video Uploader. Enjoy seamless drag-and-drop functionality, real-time upload tracking, and support for large files, all on your preferred S3-compatible storage.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2025 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} BirmeVideoUploaderConfig
+ * @property {string} name - Name of video-uploader
+ * @property {string} [s3Endpoint] - S3Endpoint
+ * @property {string} s3AccessKey - S3AccessKey
+ * @property {string} s3SecretKey - S3SecretKey
+ * @property {string} [s3AwsRegion] - S3AwsRegion
+
+ *
+ */
+/**
+ * @typedef {Object} BirmeVideoUploader
+ * @property {string} name - Name of the S3 Video Uploader instance
+ * @property {string} url - URL of the S3 Video Uploader instance
+ *
+ */
+/**
+ * Create a new S3 Video Uploader instance
+ *
+ * @memberOf birme-video-uploader
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {BirmeVideoUploaderConfig} body - Service instance configuration
+ * @returns {BirmeVideoUploader} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createBirmeVideoUploaderInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: BirmeVideoUploaderConfig = { name: 'myinstance', ... };
+ * const instance = await createBirmeVideoUploaderInstance(ctx, body);
+ * console.log(instance.url);
+ */
+export declare function createBirmeVideoUploaderInstance(ctx: Context, body: BirmeVideoUploaderConfig): Promise<BirmeVideoUploader>;
+/**
+ * Remove a S3 Video Uploader instance
+ *
+ * @memberOf birme-video-uploader
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the uploader to be removed
+ */
+export declare function removeBirmeVideoUploaderInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a S3 Video Uploader instance
+ *
+ * @memberOf birme-video-uploader
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the uploader to be retrieved
+ * @returns {BirmeVideoUploader} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getBirmeVideoUploaderInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getBirmeVideoUploaderInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+export declare function getBirmeVideoUploaderInstance(ctx: Context, name: string): Promise<BirmeVideoUploader>;
+//# sourceMappingURL=birme-video-uploader.d.ts.map