@oino-ts/common 0.1.0

package/src/OINOStr.ts

@@ -0,0 +1,254 @@
+import { OINOContentType } from "."
+
+/** Callback to filter data fields */
+export type OINOStrEncoder = (str:string) => string
+
+/**
+ * Static class string utilities.
+ *
+ */
+export class OINOStr {
+
+    /**
+     * Split string by the top level of the given type of brackets.
+     * E.g. splitByBrackets("a(bc(d))ef(gh)kl", true, true, '(', ')') would return ["a", "bc(d)", "ef", "gh", "kl"]
+     * 
+     * @param str string to split
+     * @param includePartsBetweenBlocks whether to include strings between top level brackets
+     * @param includeTrailingUnescapedBlock whether to include final block that is missing necessary end brackets
+     * @param startBracket starting bracket, e.g. '('
+     * @param endBracket ending bracket, e.g. ')'
+     *
+     */
+    static splitByBrackets(str:string, includePartsBetweenBlocks:boolean, includeTrailingUnescapedBlock:boolean, startBracket:string, endBracket:string):string[] {
+
+        let result:string[] = []
+        let parenthesis_count:number = 0
+        let start:number = 0
+        let end:number = 0
+        while (end<str.length) {
+            if (str[end] == startBracket) {
+                if (parenthesis_count == 0) {
+                    if ((end > start) && includePartsBetweenBlocks) { // there is some first level string to add to result
+                        result.push(str.substring(start, end))
+                    }
+                    start = end+1 
+                }
+                parenthesis_count++
+
+            } else if (str[end] == endBracket) {
+                parenthesis_count--
+                if (parenthesis_count == 0) {
+                    if (end >= start) { 
+                        result.push(str.substring(start, end))
+                    }
+                    start = end+1 
+                }
+            }
+            end++
+        }
+        if ((end > start) && ((includePartsBetweenBlocks && (parenthesis_count == 0)) || (includeTrailingUnescapedBlock && (parenthesis_count > 0)))) { // if there is stuff after last block or unfinished block (and those are supported)
+            result.push(str.substring(start, end)) // i == str.length
+        }
+        return result
+    }
+
+    /**
+     * Split string by delimeter excluding delimeters inside given brackets.
+     * E.g. splitExcludingBrackets("a,(bc,d),ef,(g,h),k", ',', '(', ')') would return ["a", "bc,d", "ef", "g,h", "k"]
+     * 
+     * @param str string to split
+     * @param delimeter string to use as delimeter
+     * @param startBracket starting bracket, e.g. '('
+     * @param endBracket ending bracket, e.g. ')'
+     */
+    static splitExcludingBrackets(str:string, delimeter:string, startBracket:string, endBracket:string):string[] {
+        let result:string[] = []
+        let bracket_level:number = 0
+        let start:number = 0
+        let end:number = 0
+        while (end<str.length) {
+            if (str[end] == startBracket) {
+                bracket_level++
+            } else if (str[end] == endBracket) {
+                bracket_level--
+            } else if ((str[end] == delimeter) && (bracket_level==0)) { // only delimeters at top level will break 
+                result.push(str.substring(start, end))
+                start = end+1
+            }
+            end++
+        }
+        if (end > start) {
+            result.push(str.substring(start, end)) // i == str.length
+        }
+        return result
+    }
+
+    /**
+     * Encode OINO serialized strings as valid JSON.
+     * 
+     * @param str string to encode
+     * @param valueType wether it is a value type
+     */
+    static encodeJSON(str:string|null|undefined, valueType:boolean = false):string {
+        if (str === undefined) { // no undefined literal in JSON
+            return "null"
+        } else if (str === null) {
+            return "null"
+        } else {
+            if (valueType) {
+                return str
+            } else {
+                return JSON.stringify(str)
+            }       
+        } 
+    }
+
+    /**
+     * Decode JSON string as OINO serialization.
+     * 
+     * @param str string to decode
+     */
+    static decodeJSON(str:string):string {
+        return str // JSON parsing using JS methods, no need to decode anything
+    }
+
+    /**
+     * Encode OINO serialized strings as valid CSV.
+     * 
+     * @param str string to encode
+     */
+    static encodeCSV(str:string|null|undefined):string {
+        if (str === undefined) { 
+            return ""
+        } else if (str === null) {
+            return "null"
+        } else {
+            return "\"" + str.replaceAll("\"", "\"\"") + "\"";
+        }
+    }
+
+    /**
+     * Decode CSV string as OINO serialization.
+     * 
+     * @param str string to decode
+     */
+    static decodeCSV(str:string):string {
+        return str.replaceAll("\"\"", "\"")
+    }
+    
+    /**
+     * Encode OINO serialized strings as valid Formdata.
+     * 
+     * @param str string to encode
+     */
+    static encodeFormdata(str:string|null|undefined):string {
+        if (str === undefined) { 
+            return ""
+        } else if (str === null) {
+            return ""
+        } else {
+            return str
+        }
+    }
+
+    /**
+     * Decode Formdata string as OINO serialization.
+     * 
+     * @param str string to decode
+     */
+    static decodeFormdata(str:string):string {
+        return str
+    }
+    /**
+     * Encode OINO serialized strings as valid Urlencode.
+     * 
+     * @param str string to encode
+     */
+    static encodeUrlencode(str:string|null|undefined):string {
+        if (str === undefined) { 
+            return ""
+        } else if (str === null) {
+            return "null"
+        } else {
+            return encodeURIComponent(str)
+        }
+    }
+
+    /**
+     * Decode Urlencode string as OINO serialization.
+     * 
+     * @param str string to decode
+     */
+    static decodeUrlencode(str:string):string {
+        return decodeURIComponent(str)
+    }
+
+    /**
+     * Encode OINO serialized strings as valid HTML content.
+     * 
+     * @param str string to encode
+     */
+    static encodeHtml(str:string|null|undefined):string {
+        if (str === undefined) { 
+            return ""
+        } else if (str === null) {
+            return ""
+        } else {
+            return str.replaceAll('&', '&amp;').replaceAll('<', '&lt;').replaceAll('>', '&gt;').replaceAll('"', '&quot;').replaceAll("'", '&#039;')
+        }
+    }
+
+    /**
+     * Decode HTML string as OINO serialization.
+     * 
+     * @param str string to encode
+     */
+    static decodeHtml(str:string):string {
+        return str.replaceAll('&amp;', '&').replaceAll('&lt;', '<').replaceAll('&gt;', '>').replaceAll('&quot;', '"').replaceAll('&#039;', "'")
+    }
+    /**
+     * Decode content type formatted string as OINO serialization.
+     * 
+     * @param str string to decode
+     * @param contentType content type for serialization
+     * 
+     */
+    static decode(str:string, contentType:OINOContentType):string {
+        if (contentType == OINOContentType.csv) {
+            return this.decodeCSV(str)
+        } else if (contentType == OINOContentType.json) {
+            return this.decodeJSON(str)
+        } else if (contentType == OINOContentType.formdata) {
+            return this.decodeFormdata(str)
+        } else if (contentType == OINOContentType.urlencode) {
+            return this.decodeUrlencode(str)
+        } else if (contentType == OINOContentType.html) {
+            return str 
+        } else {
+            return str
+        }
+    }
+    /**
+     * Encode OINO serialized string to the content type formatting.
+     * 
+     * @param str string to encode
+     * @param contentType content type for serialization
+     * 
+     */
+    static encode(str:string|null|undefined, contentType:OINOContentType):string {
+        if (contentType == OINOContentType.csv) {
+            return this.encodeCSV(str)
+        } else if (contentType == OINOContentType.json) {
+            return this.encodeJSON(str)
+        } else if (contentType == OINOContentType.formdata) {
+            return this.encodeFormdata(str)
+        } else if (contentType == OINOContentType.urlencode) {
+            return this.encodeUrlencode(str)
+        } else if (contentType == OINOContentType.html) {
+            return this.encodeHtml(str)
+        } else {
+            return str || ""
+        }
+    }
+}

package/src/index.ts

@@ -0,0 +1,31 @@
+export { OINOBenchmark } from "./OINOBenchmark.js"
+export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js"
+export { OINOResult, OINOHttpResult } from "./OINOResult.js"
+export { OINOStr } from "./OINOStr.js"
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.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"
+
+/** 
+ * 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' 
+}
+