@codady/utils 0.0.1

package/src/renderTpl.ts

@@ -0,0 +1,86 @@
+/**
+ * @since Last modified: 2025/11/15 16:24:20
+ * @function renderTpl
+ * @description Get template string through parameters.Cut the template strings into fragments through labels, and put into the array through the PUSH method, and finally merge into a new string.
+ * @param {string} html - Text string with variables, for example: html=`I like {{this.name}}, she is {{this.age}} years old`.
+ * @param {object|array} data - Variable key-value pairs, for example: data={name:'Lily',age:20} or [{name:'Lily'},{name:'Mark'}].
+ * @param {Object} [options] - Configuration options to control the rendering behavior:
+ * @param {boolean} [options.safe=false] - If true, HTML special characters in the template will be escaped to prevent XSS attacks. Default is `false`.
+ * @param {boolean} [options.strict=false] - If true, the template engine will require using `this` to access properties, especially for arrays. Default is `false`.
+ * @param {string} [options.start='{{'] - The opening delimiter for template variables. Default is `{{`.
+ * @param {string} [options.end='}}'] - The closing delimiter for template variables. Default is `}}`.
+ * @param {string} [options.suffix='/'] - The suffix for ending script-like expressions. Default is `/`. This is used to close template expressions like `{{this.fn() /}}`.
+ * @returns {string}  - The string after the variables are replaced with data.
+ */
+'use strict';
+import { T_obj } from "../types/utils";
+import { escapeHTML } from "./escapeHTML";
+import requireTypes from "./requireTypes";
+type options = {
+    safe?: boolean,
+    strict?: boolean,
+    start?:string,
+    end?:string,
+    suffix?:string,
+}
+const renderTpl = (html: string, data: T_obj | any[], options: options = {}): string => {
+    requireTypes(html, 'string', (error) => {
+        //不符合要求的类型
+        console.error(error);
+        return '';
+    });
+
+    if (!html.trim()) return '';
+
+    let dataType = requireTypes(data, ['array', 'object'], (error) => {
+        //不符合要求的类型
+        console.error(error);
+        return html;
+    });
+
+    //data={}/[]
+    if (Object.keys(data).length === 0) {
+        console.warn('Data is empty ({}/[]), no rendering performed, original text outputted.');
+        return html;
+    }
+    let opts = Object.assign({ safe: false, strict: false, start: '{{', end: '}}', suffix: '/' }, options),
+        tplStr = opts.safe ? escapeHTML(html) : html,
+        //regStart='\\{\\{'
+        regStart = opts.start.split('').map(k => '\\' + k).join(''),
+        //regEnd='\\}\\}'
+        regEnd = opts.end.split('').map(k => '\\' + k).join(''),
+        tplReg = new RegExp(`${regStart}([\\s\\S]+?)?${regEnd}`, 'g'),
+        code = '"use strict";let str=[];\n',
+        cursor = 0,
+        match: any,
+        result = '',
+        add = (fragment: string, isScript?: boolean) => {
+            isScript ? (code += (fragment.endsWith(opts.suffix) ? fragment.replace('=>', '=>').slice(0, -1) + '\n' : 'str.push(' + fragment + ');\n'))
+                : (code += (fragment !== '' ? 'str.push("' + fragment.replace(/"/g, '\\"') + '");\n' : ''));
+            return add;
+        }
+    while (match = tplReg.exec(tplStr)) {
+        add(tplStr.slice(cursor, match.index))(match[1], true);
+        cursor = match.index + match[0].length;
+    }
+    add(tplStr.slice(cursor));
+    code += `return str.join('');`;
+    try {
+        if (opts.strict || dataType === 'Array') {
+            //严格模式，或者是数组数据，则必须使用this
+            result = new Function(code.replace(/[\r\t\n]/g, '')).apply(data);
+        } else {
+            ////非严格模式，且是对象，则可省略this
+            let keys = Object.keys(data),
+                values = Object.values(data),
+                //keys传参,this依然可指向data
+                tmp = new Function(...keys, code.replace(/[\r\t\n]/g, '')).bind(data);
+            //执行时以value赋值
+            result = tmp(...values);
+        }
+    } catch (err: any) {
+        console.error(`'${err.message}'`, ' in \n', code, '\n');
+    }
+    return result;
+}
+export default renderTpl;

package/src/requireTypes.js

@@ -0,0 +1,48 @@
+/**
+ * @since Last modified: 2025/12/16 09:06:26
+ * @function requireTypes
+ * @description Ensures that the provided data matches one of the required types.
+ *              If the data does not match, it throws an error or calls the callback with the error.
+ * @param {*} data - The data to check.
+ * @param {(string | string[])} require - The required types (single or array of types).Optional values are:Array,Object,Function,String,Number,Boolean,Date,Symbol,Null,Undefined,Element(not case sensitive)
+ * @param {(error?: Error,type?:string) => void} [cb] - Optional callback function to handle errors.
+ * @returns {string} - The type of data.
+ * @throws {TypeError} Throws an error if the data type does not match the required types and no callback is provided.
+ */
+'use strict';
+import getDataType from './getDataType';
+/**
+ * Type-checking function that ensures the provided data matches one of the required types.
+ *
+ * @param {any} data - Data to check.
+ * @param {(string | string[])} require - The required types (single or array of types).
+ * @param {(error?: Error,type?:string) => void} [cb] - Optional callback function to handle errors.
+ * @throws {TypeError} Throws an error if the data type does not match the required types.
+ */
+const requireTypes = (data, require, cb) => {
+    // Normalize the input types (convert to array if it's a single type)
+    let requiredTypes = Array.isArray(require) ? require : [require], dataType = getDataType(data), typeLower = dataType.toLowerCase(), 
+    // Normalize the type names (to lower case)
+    normalizedTypes = requiredTypes.map((type) => type.toLowerCase()), 
+    // Check if the type is an HTML element (more specific than just 'html')
+    normalizedDataType = typeLower.includes('html') ? 'element' : typeLower;
+    // If callback exists, handle error through callback
+    if (cb) {
+        try {
+            if (!normalizedTypes.includes(normalizedDataType)) {
+                throw new TypeError(`Expected data type(s): [${normalizedTypes.join(', ')}], but got: ${normalizedDataType}`);
+            }
+        }
+        catch (error) {
+            cb(error, dataType);
+        }
+    }
+    else {
+        // If no callback is provided, throw an error directly
+        if (!normalizedTypes.includes(normalizedDataType)) {
+            throw new TypeError(`Expected data type(s): [${normalizedTypes.join(', ')}], but got: ${normalizedDataType}`);
+        }
+    }
+    return dataType;
+};
+export default requireTypes;

package/src/requireTypes.ts

@@ -0,0 +1,54 @@
+/**
+ * @since Last modified: 2025/12/16 09:06:26
+ * @function requireTypes
+ * @description Ensures that the provided data matches one of the required types. 
+ *              If the data does not match, it throws an error or calls the callback with the error.
+ * @param {*} data - The data to check.
+ * @param {(string | string[])} require - The required types (single or array of types).Optional values are:Array,Object,Function,String,Number,Boolean,Date,Symbol,Null,Undefined,Element(not case sensitive)
+ * @param {(error?: Error,type?:string) => void} [cb] - Optional callback function to handle errors.
+ * @returns {string} - The type of data.
+ * @throws {TypeError} Throws an error if the data type does not match the required types and no callback is provided.
+ */
+'use strict';
+
+import getDataType from './getDataType';
+
+/**
+ * Type-checking function that ensures the provided data matches one of the required types.
+ * 
+ * @param {any} data - Data to check.
+ * @param {(string | string[])} require - The required types (single or array of types).
+ * @param {(error?: Error,type?:string) => void} [cb] - Optional callback function to handle errors.
+ * @throws {TypeError} Throws an error if the data type does not match the required types.
+ */
+const requireTypes = (data: any, require: string | string[], cb?: (error?: Error, type?: string) => void): string => {
+    // Normalize the input types (convert to array if it's a single type)
+    let requiredTypes = Array.isArray(require) ? require : [require],
+        dataType = getDataType(data),
+        typeLower = dataType.toLowerCase(),
+
+        // Normalize the type names (to lower case)
+        normalizedTypes = requiredTypes.map((type: string) => type.toLowerCase()),
+
+        // Check if the type is an HTML element (more specific than just 'html')
+        normalizedDataType = typeLower.includes('html') ? 'element' : typeLower;
+
+    // If callback exists, handle error through callback
+    if (cb) {
+        try {
+            if (!normalizedTypes.includes(normalizedDataType)) {
+                throw new TypeError(`Expected data type(s): [${normalizedTypes.join(', ')}], but got: ${normalizedDataType}`);
+            }
+        } catch (error) {
+            cb(error as Error, dataType);
+        }
+    } else {
+        // If no callback is provided, throw an error directly
+        if (!normalizedTypes.includes(normalizedDataType)) {
+            throw new TypeError(`Expected data type(s): [${normalizedTypes.join(', ')}], but got: ${normalizedDataType}`);
+        }
+    }
+    return dataType;
+};
+
+export default requireTypes;

package/tsconfig.json

@@ -0,0 +1,108 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    //"lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+    /* Modules */
+    "module": "es2020", /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+     "types": ["node"],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    "removeComments": false,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true, /* Skip type checking all .d.ts files. */
+  },
+ // "include": [
+    //"src/",
+    //"types/",
+  //], /*Only compile files in the 'src/scripts' directory 仅编译'src/scripts'目录中的文件*/
+  "exclude": [
+    "node_modules"
+  ],
+}