@oino-ts/common 0.21.2 → 1.0.0

package/src/OINOSwagger.ts

@@ -0,0 +1,213 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import { OINOApi } from "./OINOApi.js"
+import { OINODataField } from "./OINODataField.js"
+
+/**
+ * Static class for Swagger utilities
+ *
+ */
+export class OINOSwagger {
+
+    private static _getSchemaApiMethodParamsQueryId(): any {
+        return {
+            "schema": {
+                "type": "string"
+            },
+            "in": "path",
+            "name": "id",
+            "required": true
+        }
+    }
+
+    private static _getSchemaApiMethodParamsBody(tableName:string): any {
+        return  {
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "$ref": "#/components/schemas/" + tableName
+                    }
+                }
+            }
+        }
+    }
+
+    private static _getSchemaApiMethodDescription(method:string, tableName:string, hasQueryIdParam:boolean): any {
+        if (hasQueryIdParam) {
+            return method.toUpperCase() + " " + tableName + " object"
+        } else {
+            return method.toUpperCase() + " " +tableName + " object array"
+        }
+    }
+
+    private static _getSchemaApiMethodOperationId(method:string, tableName:string, hasQueryIdParam:boolean): any {
+        if (hasQueryIdParam) {
+            return method+tableName
+        } else {
+            return method+tableName+"All"
+        }
+    }
+
+    private static _getSchemaOinoResponse(): any {
+        return {
+            "type": "object",
+            "properties": {
+                "success": {
+                    "type": "boolean"
+                },
+                "status": {
+                    "type": "number"
+                },
+                "statusText": {
+                    "type": "string"
+                },
+                "messages": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "required": [
+                "success",
+                "status",
+                "statusText",
+                "messages"
+            ]
+        }
+    }
+
+    private static _getSchemaFieldType(field:OINODataField): any {
+        let type_string:string
+        if (field.type == "boolean") {
+            type_string = "boolean"
+        } else if (field.type == "integer" || field.type == "number") {
+            type_string = "number"
+        } else {
+            type_string = "string"
+        }
+        if (!field.fieldParams.isNotNull) {
+            return {
+                "anyOf": [
+                    {
+                        "type": type_string
+                    },
+                    {
+                        "type": "null"
+                    }
+                ]
+            }
+        } else {
+            return { type: type_string }
+        }
+    }
+
+    private static _getSwaggerApiType(api:OINOApi):any {
+        let result:any = {
+            type: "object",
+            properties: {},
+            required: []
+        }
+        let field:OINODataField
+        for (field of api.datamodel!.fields) {
+            result.properties[field.name] = this._getSchemaFieldType(field)
+            if (field.fieldParams.isPrimaryKey) {
+                result.required.push(field.name)
+            }
+        }
+        return result
+    }
+
+    private static _getSchemaType(tableName:string, hasQueryIdParam:boolean, hasResultData:boolean) {
+        if (hasResultData && hasQueryIdParam) {
+            return { "$ref": "#/components/schemas/" + tableName }
+
+        } else if (hasResultData) {
+            return { type : "array", items : { "$ref": "#/components/schemas/" + tableName } }
+
+        } else if (hasQueryIdParam) {
+            return { "$ref": "#/components/schemas/OINOResponse" }
+
+        } else {
+            return { "$ref": "#/components/schemas/OINOResponse" }
+        }
+    }
+
+    private static _getSchemaApiMethodParams(hasQueryIdParam:boolean) {
+        if (hasQueryIdParam) {
+            return [ this._getSchemaApiMethodParamsQueryId() ]
+        } else {
+            return [  ]
+        }
+    }
+
+    private static _getSchemaApiMethod(method:string, tableName:string, hasQueryIdParam:boolean, hasBody:boolean, hasResultData:boolean) {
+        const result:any = {
+            responses: {
+                200: { description: this._getSchemaApiMethodDescription(method, tableName, hasQueryIdParam), content: { "application/json": { schema: this._getSchemaType(tableName, hasQueryIdParam, hasResultData) } } }
+            },
+            "operationId": this._getSchemaApiMethodOperationId(method, tableName, hasQueryIdParam),
+            "parameters": this._getSchemaApiMethodParams(hasQueryIdParam)
+        }
+        if (hasBody) {
+            result["requestBody"] = this._getSchemaApiMethodParamsBody(tableName)
+        }
+        return result
+    }
+
+    private static _getSwaggerApiPath(tableName:string, hasQueryIdParam:boolean):any {
+
+        if (hasQueryIdParam) {
+            return { 
+                get: this._getSchemaApiMethod("get", tableName, hasQueryIdParam, false, true), 
+                put: this._getSchemaApiMethod("put", tableName, hasQueryIdParam, true, false), 
+                delete: this._getSchemaApiMethod("delete", tableName, hasQueryIdParam, false, false)
+            }
+        } else {
+            return { 
+                get: this._getSchemaApiMethod("get", tableName, hasQueryIdParam, false, true),
+                post: this._getSchemaApiMethod("post", tableName, hasQueryIdParam, true, false) 
+            }
+        }
+    }
+
+    /**
+     * Returns swagger.json as object of the given API's.
+     * 
+     * @param apis array of API's use for Swagger definition
+     *
+     */
+    static getApiDefinition(apis:OINOApi[]): any {
+        let result:any = {
+            "openapi": "3.1.0",
+            "info": {
+                "title": "",
+                "description": "",
+                "version": ""
+            },
+            "paths": {
+
+            },
+            "components": {
+                "schemas": { 
+                    OINOResponse: this._getSchemaOinoResponse()
+                }
+            }
+        }
+        for (let i=0; i<apis.length; i++) {
+            if (!apis[i].initialized) {
+                throw new Error("API " + apis[i].params.tableName + " is not initialized, cannot create Swagger definition")
+            }
+            const table_name = apis[i].params.tableName
+            result.paths["/" + table_name] = this._getSwaggerApiPath(table_name, false)
+            result.paths["/" + table_name + "/{id}"] = this._getSwaggerApiPath(table_name, true)
+            result.components.schemas[table_name] = this._getSwaggerApiType(apis[i])
+        }
+        return result
+    }
+}

package/src/index.ts

@@ -1,38 +1,18 @@
-export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js"
-export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js"
-export { OINOResult, OINOHttpResult, type OINOResultInit, type OINOHttpResultInit } from "./OINOResult.js"
-export { OINORequest, OINOHttpRequest, type OINOHttpData, type OINORequestInit, type OINOHttpRequestInit } from "./OINORequest.js"
-export { OINOStr } from "./OINOStr.js"
-export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js"
-export { OINOFormatter, OINO_EMPTY_FORMATTER } from "./OINOFormatter.js"
-export { OINOHeaders, type OINOHeadersInit } from "./OINOHeaders.js"
-
-/** OINO error message prefix */
-export const OINO_ERROR_PREFIX = "OINO ERROR"
-/** OINO warning message prefix */
-export const OINO_WARNING_PREFIX = "OINO WARNING"
-/** OINO info message prefix */
-export const OINO_INFO_PREFIX = "OINO INFO"
-/** OINO debug message prefix */
-export const OINO_DEBUG_PREFIX = "OINO DEBUG"
-/** Name of the OINOContentType-parameter request */
-export const OINO_REQUEST_TYPE_PARAM = "oinorequesttype"
-/** Name of the OINOContentType-parameter request */
-export const OINO_RESPONSE_TYPE_PARAM = "oinoresponsetype"
-
-/** 
- * Supported content format mime-types 
- */
-export enum OINOContentType { 
-    /** JSON encoded data */
-    json='application/json', 
-    /** CSV encoded data */
-    csv='text/csv', 
-    /** Multipart encoded form data */
-    formdata='multipart/form-data', 
-    /** URL encoded form data */
-    urlencode='application/x-www-form-urlencoded', 
-    /** HTML encoded data (output only) */
-    html='text/html' 
-}
-
+export { OINOApi, OINOApiRequest, OINOApiResult, OINOApiHtmlTemplate, type OINOApiParams, type OINOApiData, type OINOApiRequestInit } from "./OINOApi.js"
+export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js"
+export { OINOConfig } from "./OINOConfig.js"
+export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINO_REQUEST_TYPE_PARAM, OINO_RESPONSE_TYPE_PARAM, OINOContentType, type OINODataFieldParams, type OINODataCell, type OINODataRow, OINO_EMPTY_ROW, OINO_EMPTY_ROWS } from "./OINOConstants.js"
+export { OINODataModel } from "./OINODataModel.js"
+export { OINODataSource, OINODataSet, OINOMemoryDataset } from "./OINODataSource.js"
+export { OINODataField, OINOStringDataField, OINONumberDataField, OINOBooleanDataField, OINODatetimeDataField, OINOBlobDataField, type OINODataFieldFilter } from "./OINODataField.js"
+export { OINOFormatter, OINO_EMPTY_FORMATTER } from "./OINOFormatter.js"
+export { OINOHeaders, type OINOHeadersInit } from "./OINOHeaders.js"
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js"
+export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js"
+export { OINOModelSet } from "./OINOModelSet.js"
+export { OINOParser } from "./OINOParser.js"
+export { OINOQueryBooleanOperation, OINOQueryComparison, OINOQueryNullCheck, OINOQueryAggregateFunctions, OINOQuerySelect, OINOQueryFilter, OINOQueryOrder, OINOQueryLimit, OINOQueryAggregate, type OINOQueryParams } from "./OINOQueryParams.js"
+export { OINORequest, OINOHttpRequest, type OINOHttpData, type OINORequestInit, type OINOHttpRequestInit } from "./OINORequest.js"
+export { OINOResult, OINOHttpResult, type OINOResultInit, type OINOHttpResultInit } from "./OINOResult.js"
+export { OINOStr } from "./OINOStr.js"
+export { OINOSwagger } from "./OINOSwagger.js"