mikel 0.17.0 → 0.18.0

package/README.md

@@ -161,6 +161,35 @@ const result = m("{{>>foo}}Bob{{/foo}}", {}, options);
 // Output: 'Hello Bob!'
 ```
 
+#### Partials data
+
+> This feature was added in `v0.18.0`.
+
+Partials allows you to define custom data. Instead of providing a string with the partial content, you can provide an object with the following keys:
+
+- `body`: a string with the partial content.
+- `data`: an object with your custom data for the partial. You can also use `attributes` as an alias.
+
+Custom data will be available in the partial content as a variable `@partial`.
+
+Example:
+
+```javascript
+const options = {
+    partials: {
+        foo: {
+            body: "Hello {{@partial.name}}!",
+            data: {
+                name: "Bob",
+            },
+        },
+    },
+};
+
+const result = m("{{> foo}}", {}, options);
+// Output: 'Hello Bob!'
+```
+
 ### Inline partials
 
 > This feature was added in `v0.16.0`.

package/index.d.ts

@@ -0,0 +1,48 @@
+declare type HelperFunction = (params: {
+    args: any[];
+    opt: Record<string, any>;
+    context: Record<string, any>;
+    fn: (context?: Record<string, any>, vars?: Record<string, any>, output?: string[]) => string;
+}) => string;
+
+declare interface Helpers {
+    [key: string]: HelperFunction;
+}
+
+declare interface Partials {
+    [key: string]: string;
+}
+
+declare interface Functions {
+    [key: string]: (params: {
+        args: any[];
+        opt: Record<string, any>;
+        context: Record<string, any>;
+    }) => string | void;
+}
+
+declare interface MikelOptions {
+    helpers?: Helpers;
+    partials?: Partials;
+    functions?: Functions;
+}
+
+declare interface MikelTemplate {
+    (data?: any): string;
+    addHelper(name: string, fn: HelperFunction): void;
+    removeHelper(name: string): void;
+    addFunction(name: string, fn: (params: any) => string | void): void;
+    removeFunction(name: string): void;
+    addPartial(name: string, partial: string): void;
+    removePartial(name: string): void;
+}
+
+declare const mikel: {
+    (template: string, data?: any, options?: Partial<MikelOptions>): string;
+    create(template: string, options?: Partial<MikelOptions>): MikelTemplate;
+    escape(str: string): string;
+    get(context: any, path: string): any;
+    parse(value: string, context?: any, vars?: any): any;
+};
+
+export default mikel;

package/index.js

@@ -124,10 +124,14 @@ const create = (template = "", options = {}) => {
                 if (tokens[i].startsWith(">>")) {
                     i = compile(tokens, blockContent, context, vars, i + 1, t);
                 }
-                if (typeof partials[t] === "string") {
+                if (typeof partials[t] === "string" || typeof partials[t]?.body === "string") {
                     const newCtx = args.length > 0 ? args[0] : (Object.keys(opt).length > 0 ? opt : context);
-                    const newVars = {...vars, content: blockContent.join("")};
-                    compile(tokenize(partials[t]), output, newCtx, newVars, 0, "");
+                    const newVars = {
+                        ...vars,
+                        content: blockContent.join(""),
+                        partial: partials[t]?.attributes || partials[t]?.data || {},
+                    };
+                    compile(tokenize(partials[t]?.body || partials[t]), output, newCtx, newVars, 0, "");
                 }
             }
             else if (tokens[i].startsWith("=")) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel",
     "description": "Micro templating library with zero dependencies",
-    "version": "0.17.0",
+    "version": "0.18.0",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",
@@ -12,12 +12,12 @@
     "bugs": "https://github.com/jmjuanes/mikel/issues",
     "main": "index.js",
     "module": "index.js",
+    "types": "index.d.ts",
     "exports": {
         ".": "./index.js",
         "./package.json": "./package.json"
     },
     "scripts": {
-        "release": "node scripts/release.js",
         "test": "node test.js"
     },
     "keywords": [
@@ -27,6 +27,7 @@
     "files": [
         "README.md",
         "LICENSE",
-        "index.js"
+        "index.js",
+        "index.d.ts"
     ]
 }