@explo-tech/fido-api 0.0.3 → 0.0.5

package/models/DataSourceRequest.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DataSource } from './DataSource';
+
+export type DataSourceRequest = {
+    dataSource: DataSource;
+};
+

package/models/DataSourceResponse.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DataSource } from './DataSource';
+
+export type DataSourceResponse = {
+    dataSource: DataSource;
+};
+

package/models/DataSourceTablePreviewRequest.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DataRequestParameters } from './DataRequestParameters';
+
+export type DataSourceTablePreviewRequest = {
+    tableIdentifier: string;
+    dataRequestParameters: DataRequestParameters;
+};
+

package/models/DatePropertyValue.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { LocalDate } from './LocalDate';
+
+export type DatePropertyValue = {
+    value: LocalDate;
+};
+

package/models/DateTimePropertyValue.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Instant } from './Instant';
+
+export type DateTimePropertyValue = {
+    value: Instant;
+};
+

package/models/DecimalPropertyValue.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DecimalPropertyValue = {
+    value: number;
+};
+

package/models/DoublePropertyValue.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DoublePropertyValue = {
+    value: number;
+};
+

package/models/Duration.ts

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type Duration = string;

package/models/Instant.ts

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type Instant = string;

package/models/IntegerPropertyValue.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type IntegerPropertyValue = {
+    value: number;
+};
+

package/models/LocalDate.ts

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type LocalDate = string;

package/models/Namespace.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { UUID } from './UUID';
+
+export type Namespace = {
+    name: string;
+    id?: UUID | null;
+};
+

package/models/NamespaceRequest.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Namespace } from './Namespace';
+
+export type NamespaceRequest = {
+    namespace: Namespace;
+};
+

package/models/NamespaceResponse.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Namespace } from './Namespace';
+import type { NamespaceResponseMetadata } from './NamespaceResponseMetadata';
+
+export type NamespaceResponse = {
+    namespace: Namespace;
+    meta: NamespaceResponseMetadata | null;
+};
+

package/models/NamespaceResponseMetadata.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DataSource } from './DataSource';
+
+export type NamespaceResponseMetadata = {
+    dataSources: Array<DataSource>;
+};
+

package/models/PagingConfiguration.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type PagingConfiguration = {
+    perPage?: number;
+    page?: number;
+};
+

package/models/PropertySchema.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PropertyType } from './PropertyType';
+
+export type PropertySchema = {
+    array?: boolean;
+    id: string;
+    name?: string | null;
+    type: PropertyType;
+};
+

package/models/PropertyType.ts

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export enum PropertyType {
+    BOOLEAN = 'BOOLEAN',
+    DATE = 'DATE',
+    DATETIME = 'DATETIME',
+    DECIMAL = 'DECIMAL',
+    DOUBLE = 'DOUBLE',
+    INTEGER = 'INTEGER',
+    STRING = 'STRING',
+    UNSUPPORTED = 'UNSUPPORTED',
+}

package/models/PropertyValue.ts

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { BooleanPropertyValue } from './BooleanPropertyValue';
+import type { DatePropertyValue } from './DatePropertyValue';
+import type { DateTimePropertyValue } from './DateTimePropertyValue';
+import type { DecimalPropertyValue } from './DecimalPropertyValue';
+import type { DoublePropertyValue } from './DoublePropertyValue';
+import type { IntegerPropertyValue } from './IntegerPropertyValue';
+import type { StringPropertyValue } from './StringPropertyValue';
+
+export type PropertyValue = (BooleanPropertyValue | DatePropertyValue | DateTimePropertyValue | DecimalPropertyValue | DoublePropertyValue | IntegerPropertyValue | StringPropertyValue);
+

package/models/QueryExecutionResponse.ts

@@ -0,0 +1,15 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DataPage } from './DataPage';
+import type { DataResponseMetadata } from './DataResponseMetadata';
+import type { RequestTelemetry } from './RequestTelemetry';
+
+export type QueryExecutionResponse = {
+    data: DataPage;
+    meta: DataResponseMetadata;
+    tableIdentifier: string;
+    requestTelemetry: RequestTelemetry | null;
+};
+

package/models/Record.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PropertyValue } from './PropertyValue';
+
+export type Record = {
+    propertyValues: Record<string, Array<PropertyValue>>;
+};
+

package/models/RequestTelemetry.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Duration } from './Duration';
+
+export type RequestTelemetry = {
+    requestTime?: Duration | null;
+    queryTime?: Duration | null;
+    processingTime?: Duration | null;
+};
+

package/models/StringPropertyValue.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type StringPropertyValue = {
+    value: string;
+};
+

package/models/Tunnel.ts

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type Tunnel = Record<string, any>;

package/models/UUID.ts

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type UUID = string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@explo-tech/fido-api",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Fido api",
   "homepage": "https://github.com/trust-kaz/fido",
   "license": "MIT",

package/services/DatasourceResourceService.ts

@@ -0,0 +1,106 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DataSourceRequest } from '../models/DataSourceRequest';
+import type { DataSourceResponse } from '../models/DataSourceResponse';
+import type { UUID } from '../models/UUID';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class DatasourceResourceService {
+
+    /**
+     * Gets a data source
+     * @param id
+     * @param namespaceId
+     * @returns DataSourceResponse The requested data source
+     * @throws ApiError
+     */
+    public static getDataSource(
+        id: UUID,
+        namespaceId: UUID,
+    ): CancelablePromise<DataSourceResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+        });
+    }
+
+    /**
+     * Updates a data source's metadata
+     * @param id
+     * @param namespaceId
+     * @param requestBody
+     * @returns DataSourceResponse The updated data source
+     * @throws ApiError
+     */
+    public static updateDataSource(
+        id: UUID,
+        namespaceId: UUID,
+        requestBody?: DataSourceRequest,
+    ): CancelablePromise<DataSourceResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Creates a data source
+     * @param id
+     * @param namespaceId
+     * @param requestBody
+     * @returns DataSourceResponse The requested data source
+     * @throws ApiError
+     */
+    public static createDataSource(
+        id: UUID,
+        namespaceId: UUID,
+        requestBody?: DataSourceRequest,
+    ): CancelablePromise<DataSourceResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Deletes a data source
+     * @param id
+     * @param namespaceId
+     * @returns any 200 if the data source was deleted properly
+     * @throws ApiError
+     */
+    public static deleteDataSource(
+        id: UUID,
+        namespaceId: UUID,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+        });
+    }
+
+}

package/services/HealthResourceService.ts

@@ -0,0 +1,45 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { UUID } from '../models/UUID';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class HealthResourceService {
+
+    /**
+     * Returns the entire state of the FIDO application
+     * @returns any A response with the current status of the FIDO
+     * @throws ApiError
+     */
+    public static getFidoHealth(): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/health',
+        });
+    }
+
+    /**
+     * Verifies that the DataSourceConnection verticle is alive
+     * @param dataSourceId
+     * @param namespaceId
+     * @returns any A response with the current status of the verticle
+     * @throws ApiError
+     */
+    public static getDataSourceConnectionHealth(
+        dataSourceId: UUID,
+        namespaceId: UUID,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/health/data-source-connection/{namespaceId}/{dataSourceId}',
+            path: {
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+            },
+        });
+    }
+
+}

package/services/NamespaceResourceService.ts

@@ -0,0 +1,99 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { NamespaceRequest } from '../models/NamespaceRequest';
+import type { NamespaceResponse } from '../models/NamespaceResponse';
+import type { UUID } from '../models/UUID';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class NamespaceResourceService {
+
+    /**
+     * Gets a namespace and its associated data sources
+     * @param id
+     * @param includeDataSources
+     * @returns NamespaceResponse The requested namespace, along with its associated data sources
+     * @throws ApiError
+     */
+    public static getNamespace(
+        id: UUID,
+        includeDataSources: boolean = false,
+    ): CancelablePromise<NamespaceResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/namespaces/{id}',
+            path: {
+                'id': id,
+            },
+            query: {
+                'includeDataSources': includeDataSources,
+            },
+        });
+    }
+
+    /**
+     * Updates a namespace's metadata
+     * @param id
+     * @param requestBody
+     * @returns NamespaceResponse The updated namespace, along with its associated data sources
+     * @throws ApiError
+     */
+    public static updateNamespace(
+        id: UUID,
+        requestBody?: NamespaceRequest,
+    ): CancelablePromise<NamespaceResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/v1/namespaces/{id}',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Creates a namespace and optionally a data source associated with it
+     * @param id
+     * @param requestBody
+     * @returns NamespaceResponse The requested namespace, along with its associated data source if applicable
+     * @throws ApiError
+     */
+    public static createNamespace(
+        id: UUID,
+        requestBody?: NamespaceRequest,
+    ): CancelablePromise<NamespaceResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{id}',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Deletes a namespace, cascading to its associated resources
+     * @param id
+     * @returns any 200 if the namespace was deleted properly
+     * @throws ApiError
+     */
+    public static deleteNamespace(
+        id: UUID,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/v1/namespaces/{id}',
+            path: {
+                'id': id,
+            },
+        });
+    }
+
+}

package/services/QueryResourceService.ts

@@ -0,0 +1,65 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ComputedViewRunRequest } from '../models/ComputedViewRunRequest';
+import type { DataSourceTablePreviewRequest } from '../models/DataSourceTablePreviewRequest';
+import type { QueryExecutionResponse } from '../models/QueryExecutionResponse';
+import type { UUID } from '../models/UUID';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class QueryResourceService {
+
+    /**
+     * Gets a preview of a specified table in a Data Source
+     * @param dataSourceId
+     * @param namespaceId
+     * @param requestBody
+     * @returns QueryExecutionResponse A DataPage of the resulting Data Source's data
+     * @throws ApiError
+     */
+    public static getDatasourceTablePreview(
+        dataSourceId: UUID,
+        namespaceId: UUID,
+        requestBody?: DataSourceTablePreviewRequest,
+    ): CancelablePromise<QueryExecutionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{dataSourceId}/_preview',
+            path: {
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Runs a provided query against the provided data source
+     * @param dataSourceId
+     * @param namespaceId
+     * @param requestBody
+     * @returns QueryExecutionResponse A DataPage of the resulting Data Source's data
+     * @throws ApiError
+     */
+    public static runComputedView(
+        dataSourceId: UUID,
+        namespaceId: UUID,
+        requestBody?: ComputedViewRunRequest,
+    ): CancelablePromise<QueryExecutionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{dataSourceId}/_run',
+            path: {
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+}

package/.openapi-generator/FILES

@@ -1,32 +0,0 @@
-.gitignore
-api.ts
-api/apis.ts
-api/datasourceResourceApi.ts
-api/healthResourceApi.ts
-api/namespaceResourceApi.ts
-api/queryResourceApi.ts
-git_push.sh
-model/clientError.ts
-model/computedViewRunRequest.ts
-model/dataPage.ts
-model/dataRequestParameters.ts
-model/dataResponseMetadata.ts
-model/dataSchema.ts
-model/dataSource.ts
-model/dataSourceConfiguration.ts
-model/dataSourceRequest.ts
-model/dataSourceResponse.ts
-model/dataSourceTablePreviewRequest.ts
-model/models.ts
-model/namespace.ts
-model/namespaceRequest.ts
-model/namespaceResponse.ts
-model/namespaceResponseMeta.ts
-model/namespaceResponseMetadata.ts
-model/pagingConfiguration.ts
-model/propertySchema.ts
-model/propertyType.ts
-model/queryExecutionResponse.ts
-model/queryExecutionResponseRequestTelemetry.ts
-model/record.ts
-model/requestTelemetry.ts

package/.openapi-generator/VERSION

@@ -1 +0,0 @@
-6.5.0

package/.openapi-generator-ignore

@@ -1,23 +0,0 @@
-# OpenAPI Generator Ignore
-# Generated by openapi-generator https://github.com/openapitools/openapi-generator
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md

package/.tool-versions

@@ -1 +0,0 @@
-nodejs 16.17.1