mikel 0.24.0 → 0.25.1

package/index.d.ts

@@ -1,57 +1,57 @@
-declare type HelperFunction = (params: {
+export type MikelHelper = (params: {
     args: any[];
     opt: Record<string, any>;
-    context: Record<string, any>;
+    tokens: string[];
     data: Record<string, any>;
-    fn: (context?: Record<string, any>, vars?: Record<string, any>, output?: string[]) => string;
+    variables: Record<string, any>;
+    fn: (blockData?: Record<string, any>, blockVars?: Record<string, any>, blockOutput?: 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;
-}
+export type MikelPartial = {
+    body: string;
+    data: Record<string, any>;
+};
 
-declare interface Variables {
-    [key: string]: any;
-}
+export type MikelFunction = (params: {
+    args: any[];
+    opt: Record<string, any>;
+    data: Record<string, any>;
+    variables: Record<string, any>;
+}) => string | void;
+
+export type MikelContext = {
+    helpers: Record<string, MikelHelper>;
+    partials: Record<string, string | MikelPartial>;
+    functions: Record<string, MikelFunction>;
+    variables: Record<string, any>;
+};
 
-declare interface MikelOptions {
-    helpers?: Helpers;
-    partials?: Partials;
-    functions?: Functions;
-    variables?: Variables;
-}
+export type MikelOptions = {
+    helpers?: Record<string, MikelHelper>;
+    partials?: Record<string, string | MikelPartial>;
+    functions?: Record<string, MikelFunction>;
+    variables?: Record<string, any>;
+};
 
-declare interface MikelInstance {
+export type Mikel = {
     (template: string, data?: any): string;
-    use(options: Partial<MikelOptions>): MikelTemplate;
-    addHelper(name: string, fn: HelperFunction): void;
+    use(options: Partial<MikelOptions> | ((ctx: MikelContext) => void)): Mikel;
+    addHelper(name: string, fn: MikelHelper): void;
     removeHelper(name: string): void;
-    addFunction(name: string, fn: (params: any) => string | void): void;
+    addFunction(name: string, fn: MikelFunction): void;
     removeFunction(name: string): void;
-    addPartial(name: string, partial: string): void;
+    addPartial(name: string, partial: string | MikelPartial): void;
     removePartial(name: string): void;
 }
 
 declare const mikel: {
     (template: string, data?: any, options?: Partial<MikelOptions>): string;
-    create(options?: Partial<MikelOptions>): MikelInstance;
+    create(options?: Partial<MikelOptions>): Mikel;
     escape(str: string): string;
     get(context: any, path: string): any;
     parse(value: string, context?: any, vars?: any): any;
-    tokenize(value: string): string[];
-    untokenize(value: string[]): string;
+    tokenize(str: string): string[];
+    untokenize(tokens: string[], start?: string, end?: string): string;
 };
 
 export default mikel;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel",
     "description": "Micro templating library with zero dependencies",
-    "version": "0.24.0",
+    "version": "0.25.1",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",