@oino-ts/types 0.0.11

package/dist/esm/OINOStr.js

@@ -0,0 +1,261 @@
+import { OINOContentType } from ".";
+/**
+ * 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, includePartsBetweenBlocks, includeTrailingUnescapedBlock, startBracket, endBracket) {
+        let result = [];
+        let parenthesis_count = 0;
+        let start = 0;
+        let end = 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, delimeter, startBracket, endBracket) {
+        let result = [];
+        let bracket_level = 0;
+        let start = 0;
+        let end = 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, valueType = false) {
+        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) {
+        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) {
+        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) {
+        return str.replaceAll("\"\"", "\"");
+    }
+    /**
+     * Encode OINO serialized strings as valid Formdata.
+     *
+     * @param str string to encode
+     */
+    static encodeFormdata(str) {
+        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) {
+        return str;
+    }
+    /**
+     * Encode OINO serialized strings as valid Urlencode.
+     *
+     * @param str string to encode
+     */
+    static encodeUrlencode(str) {
+        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) {
+        return decodeURIComponent(str);
+    }
+    /**
+     * Encode OINO serialized strings as valid HTML content.
+     *
+     * @param str string to encode
+     */
+    static encodeHtml(str) {
+        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) {
+        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, contentType) {
+        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, contentType) {
+        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/dist/esm/index.js

@@ -0,0 +1,26 @@
+export { OINOBenchmark } from "./OINOBenchmark.js";
+export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
+export { OINOResult } from "./OINOResult.js";
+export { OINOStr } from "./OINOStr.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 var OINOContentType;
+(function (OINOContentType) {
+    /** JSON encoded data */
+    OINOContentType["json"] = "application/json";
+    /** CSV encoded data */
+    OINOContentType["csv"] = "text/csv";
+    /** Multipart encoded form data */
+    OINOContentType["formdata"] = "multipart/form-data";
+    /** URL encoded form data */
+    OINOContentType["urlencode"] = "application/x-www-form-urlencoded";
+    /** HTML encoded data (output only) */
+    OINOContentType["html"] = "text/html";
+})(OINOContentType || (OINOContentType = {}));

package/dist/types/OINOBenchmark.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Static class for benchmarking functions.
+ *
+ */
+export declare class OINOBenchmark {
+    private static _benchmarkCount;
+    private static _benchmarkData;
+    private static _benchmarkEnabled;
+    private static _benchmarkStart;
+    /**
+     * Reset benchmark data (but not what is enabled).
+     *
+     */
+    static reset(): void;
+    /**
+     *  Set benchmark names that are enabled.
+     *
+     *  @param names array of those benchmarks that are enabled
+     */
+    static setEnabled(names: string[]): void;
+    /**
+     * Start benchmark timing.
+     *
+     * @param name of the benchmark
+     */
+    static start(name: string): void;
+    /**
+     * Complete benchmark timing
+     *
+     * @param name of the benchmark
+     */
+    static end(name: string): number;
+}

package/dist/types/OINOLog.d.ts

@@ -0,0 +1,105 @@
+/** Logging levels */
+export declare enum OINOLogLevel {
+    /** Debug messages */
+    debug = 0,
+    /** Informational messages */
+    info = 1,
+    /** Warning messages */
+    warn = 2,
+    /** Error messages */
+    error = 3
+}
+/**
+ * Abstract base class for logging implementations supporting
+ * - error, warning, info and debug channels
+ * - setting level of logs outputted
+ *
+ */
+export declare abstract class OINOLog {
+    protected static _instance: OINOLog;
+    protected _logLevel: OINOLogLevel;
+    /**
+     * Abstract logging method to implement the actual logging operation.
+     *
+     * @param logLevel level of the log events
+     *
+     */
+    constructor(logLevel?: OINOLogLevel);
+    /**
+     * Abstract logging method to implement the actual logging operation.
+     *
+     * @param levelStr level string of the log event
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    protected abstract _writeLog(levelStr: string, message: string, data?: any): void;
+    /**
+     * Abstract logging method to implement the actual logging operation.
+     *
+     * @param level level of the log event
+     * @param levelStr level string of the log event
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    protected static _log(level: OINOLogLevel, levelStr: string, message: string, data?: any): void;
+    /**
+     * Set active logger and log level.
+     *
+     * @param logger logger instance
+     *
+     */
+    static setLogger(logger: OINOLog): void;
+    /**
+     * Set log level.
+     *
+     * @param logLevel log level to use
+     *
+     */
+    static setLogLevel(logLevel: OINOLogLevel): void;
+    /**
+     * Log error event.
+     *
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    static error(message: string, data?: any): void;
+    /**
+     * Log warning event.
+     *
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    static warning(message: string, data?: any): void;
+    /**
+     * Log info event.
+     *
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    static info(message: string, data?: any): void;
+    /**
+     * Log debug event.
+     *
+     * @param message message of the log event
+     * @param data structured data associated with the log event
+     *
+     */
+    static debug(message: string, data?: any): void;
+}
+/**
+ * Logging implementation based on console.log.
+ *
+ */
+export declare class OINOConsoleLog extends OINOLog {
+    /**
+     * Constructor of `OINOConsoleLog`
+     * @param logLevel logging level
+     */
+    constructor(logLevel?: OINOLogLevel);
+    protected _writeLog(level: string, message: string, data?: any): void;
+}

package/dist/types/OINOResult.d.ts

@@ -0,0 +1,69 @@
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+export declare class OINOResult {
+    /** Wheter request was successfully executed */
+    success: boolean;
+    /** HTTP status code */
+    statusCode: number;
+    /** HTTP status message */
+    statusMessage: string;
+    /** Error / warning messages */
+    messages: string[];
+    /**
+     * Constructor of OINOResult.
+     *
+     */
+    constructor();
+    /**
+     * Set HTTP OK status (does not reset messages).
+     *
+     */
+    setOk(): void;
+    /**
+     * Set HTTP error status using given code and message.
+     *
+     * @param statusCode HTTP status code
+     * @param statusMessage HTTP status message
+     * @param operation operation where error occured
+     *
+     */
+    setError(statusCode: number, statusMessage: string, operation: string): void;
+    /**
+     * Add warning message.
+     *
+     * @param message HTTP status message
+     * @param operation operation where warning occured
+     *
+     */
+    addWarning(message: string, operation: string): void;
+    /**
+     * Add info message.
+     *
+     * @param message HTTP status message
+     * @param operation operation where info occured
+     *
+     */
+    addInfo(message: string, operation: string): void;
+    /**
+     * Add debug message.
+     *
+     * @param message HTTP status message
+     * @param operation operation where debug occured
+     *
+     */
+    addDebug(message: string, operation: string): void;
+    /**
+     * Copy given messages to HTTP headers.
+     *
+     * @param headers HTTP headers
+     * @param copyErrors wether error messages should be copied (default true)
+     * @param copyWarnings wether warning messages should be copied (default false)
+     * @param copyInfos wether info messages should be copied (default false)
+     * @param copyDebug wether debug messages should be copied (default false)
+     *
+     */
+    copyMessagesToHeaders(headers: Headers, copyErrors?: boolean, copyWarnings?: boolean, copyInfos?: boolean, copyDebug?: boolean): void;
+}

package/dist/types/OINOStr.d.ts

@@ -0,0 +1,108 @@
+import { OINOContentType } from ".";
+/** Callback to filter data fields */
+export type OINOStrEncoder = (str: string) => string;
+/**
+ * Static class string utilities.
+ *
+ */
+export declare 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[];
+    /**
+     * 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[];
+    /**
+     * 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): string;
+    /**
+     * Decode JSON string as OINO serialization.
+     *
+     * @param str string to decode
+     */
+    static decodeJSON(str: string): string | null | undefined;
+    /**
+     * Encode OINO serialized strings as valid CSV.
+     *
+     * @param str string to encode
+     */
+    static encodeCSV(str: string | null | undefined): string;
+    /**
+     * Decode CSV string as OINO serialization.
+     *
+     * @param str string to decode
+     */
+    static decodeCSV(str: string): string | null | undefined;
+    /**
+     * Encode OINO serialized strings as valid Formdata.
+     *
+     * @param str string to encode
+     */
+    static encodeFormdata(str: string | null | undefined): string;
+    /**
+     * Decode Formdata string as OINO serialization.
+     *
+     * @param str string to decode
+     */
+    static decodeFormdata(str: string): string | null | undefined;
+    /**
+     * Encode OINO serialized strings as valid Urlencode.
+     *
+     * @param str string to encode
+     */
+    static encodeUrlencode(str: string | null | undefined): string;
+    /**
+     * Decode Urlencode string as OINO serialization.
+     *
+     * @param str string to decode
+     */
+    static decodeUrlencode(str: string): string | null | undefined;
+    /**
+     * Encode OINO serialized strings as valid HTML content.
+     *
+     * @param str string to encode
+     */
+    static encodeHtml(str: string | null | undefined): string;
+    /**
+     * Decode HTML string as OINO serialization.
+     *
+     * @param str string to encode
+     */
+    static decodeHtml(str: string): string | null | undefined;
+    /**
+     * 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 | null | undefined;
+    /**
+     * 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;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,25 @@
+export { OINOBenchmark } from "./OINOBenchmark.js";
+export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
+export { OINOResult } from "./OINOResult.js";
+export { OINOStr } from "./OINOStr.js";
+/** OINO error message prefix */
+export declare const OINO_ERROR_PREFIX = "OINO ERROR";
+/** OINO warning message prefix */
+export declare const OINO_WARNING_PREFIX = "OINO WARNING";
+/** OINO info message prefix */
+export declare const OINO_INFO_PREFIX = "OINO INFO";
+/** OINO debug message prefix */
+export declare const OINO_DEBUG_PREFIX = "OINO DEBUG";
+/** Supported content format mime-types */
+export declare 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"
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@oino-ts/types",
+  "version": "0.0.11",
+  "description": "OINO TS package for types.",
+  "author": "Matias Kiviniemi (pragmatta)",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pragmatta/oino-ts.git"
+  },
+  "keywords": [
+    "types",
+    "typescript",
+    "library"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {
+  },
+  "devDependencies": {
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}