ventojs 2.0.0-canary.0 → 2.0.0-canary.2

package/types/core/environment.d.ts

@@ -3,20 +3,17 @@ export interface TemplateResult {
     content: string;
     [key: string]: unknown;
 }
-export interface Template {
-    (data?: Record<string, unknown>): Promise<TemplateResult>;
+export interface TemplateContext {
     source: string;
     code: string;
-    file?: string;
+    path?: string;
+    defaults?: Record<string, unknown>;
 }
-export interface TemplateSync {
-    (data?: Record<string, unknown>): TemplateResult;
-    source: string;
-    code: string;
-    file?: string;
+export interface Template extends TemplateContext {
+    (data?: Record<string, unknown>): Promise<TemplateResult>;
 }
 export type TokenPreprocessor = (env: Environment, tokens: Token[], path?: string) => Token[] | void;
-export type Tag = (env: Environment, code: string, output: string, tokens: Token[]) => string | undefined;
+export type Tag = (env: Environment, token: Token, output: string, tokens: Token[]) => string | undefined;
 export type FilterThis = {
     data: Record<string, unknown>;
     env: Environment;
@@ -27,8 +24,9 @@ export interface TemplateSource {
     source: string;
     data?: Record<string, unknown>;
 }
+export type PrecompiledTemplate = (env: Environment) => Template;
 export interface Loader {
-    load(file: string): Promise<TemplateSource>;
+    load(file: string): Promise<TemplateSource | PrecompiledTemplate>;
     resolve(from: string, file: string): string;
 }
 export interface Options {
@@ -46,13 +44,13 @@ export declare class Environment {
     utils: Record<string, unknown>;
     constructor(options: Options);
     use(plugin: Plugin): void;
-    run(file: string, data?: Record<string, unknown>, from?: string): Promise<TemplateResult>;
+    run(file: string, data?: Record<string, unknown>, from?: string, position?: number): Promise<TemplateResult>;
     runString(source: string, data?: Record<string, unknown>, file?: string): Promise<TemplateResult>;
-    runStringSync(source: string, data?: Record<string, unknown>): TemplateResult;
-    compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: false): Template;
-    compile(source: string, path?: string, defaults?: Record<string, unknown>, sync?: true): TemplateSync;
+    compile(source: string, path?: string, defaults?: Record<string, unknown>): Template;
     tokenize(source: string, path?: string): Token[];
-    load(file: string, from?: string): Promise<Template>;
-    compileTokens(tokens: Token[], outputVar?: string, stopAt?: string[]): string[];
+    load(file: string, from?: string, position?: number): Promise<Template>;
+    compileTokens(tokens: Token[], outputVar?: string, closeToken?: string): string[];
     compileFilters(tokens: Token[], output: string, autoescape?: boolean): string;
 }
+export declare class SafeString extends String {
+}

package/types/core/errors.d.ts

@@ -1,16 +1,46 @@
-declare class VentoBaseError extends Error {
-    name: string;
+import type { TemplateContext } from "./environment.d.ts";
+export interface ErrorContext {
+    type: string;
+    message: string;
+    source?: string;
+    position?: number;
+    code?: string;
+    line?: number;
+    column?: number;
+    file?: string;
 }
-export declare class TemplateError extends VentoBaseError {
-    path: string;
-    source: string;
-    position: number;
-    constructor(path?: string, source?: string, position?: number, cause?: Error);
+export declare abstract class VentoError extends Error {
+    abstract getContext(): ErrorContext | Promise<ErrorContext>;
 }
-/** Returns the number and code of the errored line */
-export declare function errorLine(source: string, position: number): {
-    line: number;
-    column: number;
-    code: string;
-};
+export declare class SourceError extends VentoError {
+    position?: number;
+    file?: string;
+    source?: string;
+    constructor(message: string, position?: number, file?: string, source?: string);
+    getContext(): {
+        type: string;
+        message: string;
+        position: number;
+        file: string;
+        source: string;
+    };
+}
+export declare class RuntimeError extends VentoError {
+    #private;
+    position?: number;
+    constructor(error: Error, context: TemplateContext, position?: number);
+    getContext(): Promise<ErrorContext>;
+}
+/** Create or complete VentoError with extra info from the template */
+export declare function createError(error: Error, context: TemplateContext, position?: number): VentoError;
+export interface ErrorFormat {
+    number: (n: string) => string;
+    dim: (line: string) => string;
+    error: (msg: string) => string;
+}
+declare const formats: Record<string, ErrorFormat>;
+/** Prints an error to the console in a formatted way. */
+export declare function printError(error: unknown, format?: ErrorFormat | keyof typeof formats): Promise<void>;
+/** Converts an error context into a formatted string representation. */
+export declare function stringifyError(context: ErrorContext, format?: ErrorFormat): string;
 export {};

package/types/core/tokenizer.d.ts

@@ -1,5 +1,5 @@
 export type TokenType = "string" | "tag" | "filter" | "comment";
-export type Token = [TokenType, string, number?];
+export type Token = [TokenType, string, number];
 export default function tokenize(source: string): Token[];
 /**
  * Parse a tag and return the indexes of the start and end brackets, and the filters between.

package/types/loaders/file.d.ts

@@ -1,7 +1,7 @@
 import type { Loader, TemplateSource } from "../core/environment.d.ts";
 /**
  * Vento file loader for loading templates from the file system.
- * Used by JS runtimes like Node, Deno, and Bun.
+ * Used by Node-like runtimes (Node, Deno, Bun, ...)
  */
 export declare class FileLoader implements Loader {
     #private;

package/types/loaders/filesystem.d.ts

@@ -0,0 +1,12 @@
+import type { Loader, TemplateSource } from "../core/environment.d.ts";
+/**
+ * Vento FileSystem API loader for loading templates.
+ * Used by browser environments.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/File_System_API
+ */
+export declare class FileSystemLoader implements Loader {
+    #private;
+    constructor(handle: FileSystemDirectoryHandle);
+    load(file: string): Promise<TemplateSource>;
+    resolve(from: string, file: string): string;
+}

package/types/loaders/memory.d.ts

@@ -4,7 +4,7 @@ import type { Loader, TemplateSource } from "../core/environment.d.ts";
  * Used for testing or in-memory operations.
  */
 export declare class MemoryLoader implements Loader {
-    files: Record<string, string>;
+    files: Map<string, string>;
     constructor(files: Record<string, string>);
     load(file: string): Promise<TemplateSource>;
     resolve(from: string, file: string): string;

package/types/loaders/module.d.ts

@@ -0,0 +1,19 @@
+import type { Loader, PrecompiledTemplate, Template } from "../core/environment.d.ts";
+/**
+ * Vento loader for loading templates from a ES modules.
+ * Used to load precompiled templates.
+ */
+export declare class ModuleLoader implements Loader {
+    #private;
+    constructor(root: URL);
+    load(file: string): Promise<PrecompiledTemplate>;
+    resolve(from: string, file: string): string;
+}
+export interface ExportOptions {
+    source?: boolean;
+}
+/**
+ * Exports a template as a string that can be used in an ES module.
+ * This is useful for precompiled templates.
+ */
+export declare function exportTemplate(template: Template, options?: ExportOptions): string;

package/types/loaders/utils.d.ts

@@ -0,0 +1 @@
+export declare function join(...paths: string[]): string;