@osaas/client-services 0.4.0 → 0.6.0

package/lib/generated/searxng-searxng.d.ts

@@ -0,0 +1,312 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Say hello */
+        get: {
+            responses: {
+                /** The magical words! */
+                200: {
+                    schema: string;
+                };
+            };
+        };
+    };
+    '/searxnginstance': {
+        /** List all running searxng instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the searxng 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;
+                            };
+                        };
+                        AutoComplete?: string;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new searxng instance */
+        post: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the searxng instance */
+                        name: string;
+                        AutoComplete?: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the searxng 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;
+                            };
+                        };
+                        AutoComplete?: 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;
+                    };
+                };
+            };
+        };
+    };
+    '/searxnginstance/{id}': {
+        /** Obtain status and resource URLs for an searxng instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the searxng instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the searxng 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;
+                            };
+                        };
+                        AutoComplete?: 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 searxng instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the searxng instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of searxng instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the searxng instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the searxng instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the searxng 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 searxng instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the searxng 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 SearxngSearxng = paths['/searxnginstance/{id}']['get']['responses']['200']['schema'];
+export type SearxngSearxngConfig = paths['/searxnginstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * Create a new SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {SearxngSearxngConfig}} body - Service instance configuration
+ * @returns {SearxngSearxng} - Service instance
+ * @example
+ * import { Context, createSearxngSearxngInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createSearxngSearxngInstance(ctx, { name: 'myinstance' });
+ * console.log(instance.url);
+ */
+export declare function createSearxngSearxngInstance(ctx: Context, body: SearxngSearxngConfig): Promise<SearxngSearxng>;
+/**
+ * Remove a SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the searxng to be removed
+ */
+export declare function removeSearxngSearxngInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the searxng to be retrieved
+ * @returns {SearxngSearxng} - Service instance
+ */
+export declare function getSearxngSearxngInstance(ctx: Context, name: string): Promise<SearxngSearxng>;
+//# sourceMappingURL=searxng-searxng.d.ts.map

package/lib/generated/searxng-searxng.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searxng-searxng.d.ts","sourceRoot":"","sources":["../../src/generated/searxng-searxng.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE;QACH,gBAAgB;QAChB,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,yBAAyB;gBACzB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,kBAAkB,EAAE;QAClB,yCAAyC;QACzC,GAAG,EAAE;YACH,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,gDAAgD;wBAChD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;wBACF,YAAY,CAAC,EAAE,MAAM,CAAC;qBACvB,EAAE,CAAC;iBACL,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,oCAAoC;QACpC,IAAI,EAAE;YACJ,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,CAAC,EAAE;wBACL,gDAAgD;wBAChD,IAAI,EAAE,MAAM,CAAC;wBACb,YAAY,CAAC,EAAE,MAAM,CAAC;qBACvB,CAAC;iBACH,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,gDAAgD;wBAChD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;wBACF,YAAY,CAAC,EAAE,MAAM,CAAC;qBACvB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,uBAAuB,EAAE;QACvB,8DAA8D;QAC9D,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,mCAAmC;oBACnC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,gDAAgD;wBAChD,IAAI,EAAE,MAAM,CAAC;wBACb,uCAAuC;wBACvC,GAAG,EAAE,MAAM,CAAC;wBACZ,SAAS,EAAE;4BACT,OAAO,EAAE;gCACP,8CAA8C;gCAC9C,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,OAAO,CAAC,EAAE;gCACR,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;4BACF,GAAG,CAAC,EAAE;gCACJ,qDAAqD;gCACrD,GAAG,EAAE,MAAM,CAAC;6BACb,CAAC;yBACH,CAAC;wBACF,YAAY,CAAC,EAAE,MAAM,CAAC;qBACvB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,0CAA0C;QAC1C,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,mCAAmC;oBACnC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,cAAc,EAAE;QACd,wCAAwC;QACxC,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,mCAAmC;oBACnC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,qBAAqB;wBACrB,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;qBACnE,CAAC;iBACH,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,YAAY,EAAE;QACZ,uDAAuD;QACvD,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,UAAU,CAAC,EAAE,OAAO,CAAC;oBACrB,YAAY,CAAC,EAAE,MAAM,CAAC;iBACvB,CAAC;gBACF,IAAI,EAAE;oBACJ,mCAAmC;oBACnC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,aAAa,EAAE;QACb,0DAA0D;QAC1D,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,mCAAmC;oBACnC,EAAE,EAAE,MAAM,CAAC;iBACZ,CAAC;aACH,CAAC;YACF,SAAS,EAAE;gBACT,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,UAAU,EAAE,MAAM,CAAC;wBACnB,YAAY,EAAE,MAAM,CAAC;wBACrB,YAAY,EAAE,MAAM,CAAC;qBACtB,EAAE,CAAC;iBACL,CAAC;gBACF,uBAAuB;gBACvB,GAAG,EAAE;oBACH,MAAM,EAAE;wBACN,+CAA+C;wBAC/C,MAAM,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,WAAW;CAAG;AAE/B,MAAM,WAAW,UAAU;CAAG;AAE9B,MAAM,WAAW,QAAQ;CAAG;AAE5B,MAAM,MAAM,cAAc,GACxB,KAAK,CAAC,uBAAuB,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEtE,MAAM,MAAM,oBAAoB,GAC9B,KAAK,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,OAAO,EACL,OAAO,EAKR,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;GAaG;AACH,wBAAsB,4BAA4B,CAChD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,cAAc,CAAC,CAUzB;AAED;;;;;;GAMG;AACH,wBAAsB,4BAA4B,CAChD,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;;;GAOG;AACH,wBAAsB,yBAAyB,CAC7C,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,cAAc,CAAC,CAGzB"}

package/lib/generated/searxng-searxng.js

@@ -0,0 +1,55 @@
+"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.getSearxngSearxngInstance = exports.removeSearxngSearxngInstance = exports.createSearxngSearxngInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * Create a new SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {SearxngSearxngConfig}} body - Service instance configuration
+ * @returns {SearxngSearxng} - Service instance
+ * @example
+ * import { Context, createSearxngSearxngInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await createSearxngSearxngInstance(ctx, { name: 'myinstance' });
+ * console.log(instance.url);
+ */
+async function createSearxngSearxngInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('searxng-searxng');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'searxng-searxng', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('searxng-searxng', instance.name, ctx);
+    return instance;
+}
+exports.createSearxngSearxngInstance = createSearxngSearxngInstance;
+/**
+ * Remove a SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the searxng to be removed
+ */
+async function removeSearxngSearxngInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('searxng-searxng');
+    await (0, client_core_1.removeInstance)(ctx, 'searxng-searxng', name, serviceAccessToken);
+}
+exports.removeSearxngSearxngInstance = removeSearxngSearxngInstance;
+/**
+ * Get a SearXNG instance
+ *
+ * @description Experience the power of privacy with SearXNG, a customizable metasearch engine delivering unmatched confidentiality. Explore the web securely with our easy setup and extensive admin tools.
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the searxng to be retrieved
+ * @returns {SearxngSearxng} - Service instance
+ */
+async function getSearxngSearxngInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('searxng-searxng');
+    return await (0, client_core_1.getInstance)(ctx, 'searxng-searxng', name, serviceAccessToken);
+}
+exports.getSearxngSearxngInstance = getSearxngSearxngInstance;
+//# sourceMappingURL=searxng-searxng.js.map

package/lib/generated/searxng-searxng.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searxng-searxng.js","sourceRoot":"","sources":["../../src/generated/searxng-searxng.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAyRH,oDAM4B;AAE5B;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,4BAA4B,CAChD,GAAY,EACZ,IAA0B;IAE1B,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,iBAAiB,EACjB,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,iBAAiB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAClE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAbD,oEAaC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,4BAA4B,CAChD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;IAC9E,MAAM,IAAA,4BAAc,EAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACzE,CAAC;AAND,oEAMC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,yBAAyB,CAC7C,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;IAC9E,OAAO,MAAM,IAAA,yBAAW,EAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AAC7E,CAAC;AAND,8DAMC"}