@teemill/schema 0.1.2

package/README.md

@@ -0,0 +1,46 @@
+## @teemill/schema@0.1.2
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @teemill/schema@0.1.2 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```

package/api.ts

@@ -0,0 +1,347 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Schema API
+ * View PodOS API Schemas  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.2
+ * Contact: hello@podos.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
+import type { RequestArgs } from './base';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
+
+/**
+ * 
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ * 
+ * @export
+ * @interface Schema
+ */
+export interface Schema {
+    /**
+     * 
+     * @type {string}
+     * @memberof Schema
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Schema
+     */
+    'description': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Schema
+     */
+    'version': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof Schema
+     */
+    'paths': Array<string>;
+    /**
+     * 
+     * @type {object}
+     * @memberof Schema
+     */
+    'schema'?: object;
+}
+/**
+ * 
+ * @export
+ * @interface Schemas
+ */
+export interface Schemas {
+    /**
+     * 
+     * @type {Array<Schema>}
+     * @memberof Schemas
+     */
+    'schemas': Array<Schema>;
+}
+/**
+ * 
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ValidationError
+     */
+    'message': string;
+    /**
+     * 
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof ValidationError
+     */
+    'errors': { [key: string]: Array<string>; };
+}
+
+/**
+ * SchemasApi - axios parameter creator
+ * @export
+ */
+export const SchemasApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get an API schema
+         * @summary Get schema
+         * @param {string} api API name
+         * @param {string} [project] Project unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSchema: async (api: string, project?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'api' is not null or undefined
+            assertParamExists('getSchema', 'api', api)
+            const localVarPath = `/{api}`
+                .replace(`{${"api"}}`, encodeURIComponent(String(api)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List all available schemas
+         * @summary List schemas
+         * @param {string} [project] Project unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSchemas: async (project?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SchemasApi - functional programming interface
+ * @export
+ */
+export const SchemasApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SchemasApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get an API schema
+         * @summary Get schema
+         * @param {string} api API name
+         * @param {string} [project] Project unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSchema(api: string, project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schemas>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSchema(api, project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SchemasApi.getSchema']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List all available schemas
+         * @summary List schemas
+         * @param {string} [project] Project unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSchemas(project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schema>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSchemas(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SchemasApi.listSchemas']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * SchemasApi - factory interface
+ * @export
+ */
+export const SchemasApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SchemasApiFp(configuration)
+    return {
+        /**
+         * Get an API schema
+         * @summary Get schema
+         * @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<Schemas> {
+            return localVarFp.getSchema(requestParameters.api, requestParameters.project, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List all available schemas
+         * @summary List schemas
+         * @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSchemas(requestParameters: SchemasApiListSchemasRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<Schema> {
+            return localVarFp.listSchemas(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getSchema operation in SchemasApi.
+ * @export
+ * @interface SchemasApiGetSchemaRequest
+ */
+export interface SchemasApiGetSchemaRequest {
+    /**
+     * API name
+     * @type {string}
+     * @memberof SchemasApiGetSchema
+     */
+    readonly api: string
+
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof SchemasApiGetSchema
+     */
+    readonly project?: string
+}
+
+/**
+ * Request parameters for listSchemas operation in SchemasApi.
+ * @export
+ * @interface SchemasApiListSchemasRequest
+ */
+export interface SchemasApiListSchemasRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof SchemasApiListSchemas
+     */
+    readonly project?: string
+}
+
+/**
+ * SchemasApi - object-oriented interface
+ * @export
+ * @class SchemasApi
+ * @extends {BaseAPI}
+ */
+export class SchemasApi extends BaseAPI {
+    /**
+     * Get an API schema
+     * @summary Get schema
+     * @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    public getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig) {
+        return SchemasApiFp(this.configuration).getSchema(requestParameters.api, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List all available schemas
+     * @summary List schemas
+     * @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    public listSchemas(requestParameters: SchemasApiListSchemasRequest = {}, options?: RawAxiosRequestConfig) {
+        return SchemasApiFp(this.configuration).listSchemas(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+

package/base.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Schema API
+ * View PodOS API Schemas  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.2
+ * Contact: hello@podos.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://localhost:8080/v1/schema".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

package/common.ts

@@ -0,0 +1,150 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Schema API
+ * View PodOS API Schemas  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.2
+ * Contact: hello@podos.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
+        } 
+        else {
+            Object.keys(parameter).forEach(currentKey => 
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    } 
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        } 
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = decodeURIComponent(searchParams.toString());
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}