@c9up/rune 0.1.6 → 0.1.8

package/dist/MessagesProvider.d.ts

@@ -0,0 +1,45 @@
+/**
+ * SimpleMessagesProvider — VineJS-compatible message lookup.
+ *
+ * Resolves an error message for a `(rule, field)` pair using a `'field.rule'`
+ * → template map, human-readable field labels, wildcard (`*`) segments for
+ * array items, and mustache `{{ field }}` interpolation. Mirrors
+ * `@vinejs/vine`'s provider so validators authored against Vine's message
+ * conventions behave identically here.
+ */
+/** Rule name → message template, e.g. `{ required: 'The {{ field }} is required' }`. */
+export type ValidationMessages = Record<string, string>;
+/** Field path → human label, e.g. `{ 'user.email': 'Email address' }`. */
+export type ValidationFields = Record<string, string>;
+/** Interpolation values handed to a message template. */
+export type MessageArgs = Record<string, unknown>;
+/**
+ * Contract any messages provider must satisfy — a single `getMessage` lookup.
+ * Keeping it an interface lets consumers swap in their own (e.g. i18n-backed)
+ * provider without importing the concrete class.
+ */
+export interface MessagesProviderContract {
+    getMessage(rawMessage: string, rule: string, field: string, args?: MessageArgs): string;
+}
+/**
+ * Replace a dotted field path's numeric segments with `*` so array items share
+ * a single wildcard message key — `tags.0.name` → `tags.*.name` (VineJS parity).
+ */
+export declare function toWildcardPath(field: string): string;
+export declare class SimpleMessagesProvider implements MessagesProviderContract {
+    #private;
+    constructor(messages: ValidationMessages, fields?: ValidationFields);
+    /**
+     * Resolve a message. Priority (VineJS order):
+     *   1. field-specific   `user.email.required`
+     *   2. wildcard path     `*.required` / `tags.*.minLength`
+     *   3. generic rule      `required`
+     *   4. raw rule message  (fallback)
+     */
+    getMessage(rawMessage: string, rule: string, field: string, args?: MessageArgs): string;
+    toJSON(): {
+        messages: ValidationMessages;
+        fields: ValidationFields;
+    };
+}
+//# sourceMappingURL=MessagesProvider.d.ts.map

package/dist/MessagesProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagesProvider.d.ts","sourceRoot":"","sources":["../src/MessagesProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,wFAAwF;AACxF,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxD,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtD,yDAAyD;AACzD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAOlD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACxC,UAAU,CACT,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,WAAW,GAChB,MAAM,CAAC;CACV;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAKpD;AAED,qBAAa,sBAAuB,YAAW,wBAAwB;;gBAI1D,QAAQ,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,gBAAgB;IAuBnE;;;;;;OAMG;IACH,UAAU,CACT,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,WAAW,GAChB,MAAM;IAwBT,MAAM,IAAI;QAAE,QAAQ,EAAE,kBAAkB,CAAC;QAAC,MAAM,EAAE,gBAAgB,CAAA;KAAE;CAGpE"}

package/dist/MessagesProvider.js

@@ -0,0 +1,77 @@
+/**
+ * SimpleMessagesProvider — VineJS-compatible message lookup.
+ *
+ * Resolves an error message for a `(rule, field)` pair using a `'field.rule'`
+ * → template map, human-readable field labels, wildcard (`*`) segments for
+ * array items, and mustache `{{ field }}` interpolation. Mirrors
+ * `@vinejs/vine`'s provider so validators authored against Vine's message
+ * conventions behave identically here.
+ */
+/** Narrow to a plain record so dotted-path interpolation can index it. */
+function isRecord(value) {
+    return typeof value === "object" && value !== null;
+}
+/**
+ * Replace a dotted field path's numeric segments with `*` so array items share
+ * a single wildcard message key — `tags.0.name` → `tags.*.name` (VineJS parity).
+ */
+export function toWildcardPath(field) {
+    return field
+        .split(".")
+        .map((segment) => (/^\d+$/.test(segment) ? "*" : segment))
+        .join(".");
+}
+export class SimpleMessagesProvider {
+    #messages;
+    #fields;
+    constructor(messages, fields) {
+        this.#messages = messages;
+        this.#fields = fields ?? {};
+    }
+    /** Mustache-style `{{ token }}` interpolation with dotted-path lookup. */
+    #interpolate(message, data) {
+        if (!message.includes("{{")) {
+            return message;
+        }
+        return message.replace(/{{(.*?)}}/g, (_match, rawKey) => {
+            const tokens = rawKey.trim().split(".");
+            let output = data;
+            for (const token of tokens) {
+                if (!isRecord(output)) {
+                    return "";
+                }
+                output = Object.hasOwn(output, token) ? output[token] : undefined;
+            }
+            return output === undefined || output === null ? "" : String(output);
+        });
+    }
+    /**
+     * Resolve a message. Priority (VineJS order):
+     *   1. field-specific   `user.email.required`
+     *   2. wildcard path     `*.required` / `tags.*.minLength`
+     *   3. generic rule      `required`
+     *   4. raw rule message  (fallback)
+     */
+    getMessage(rawMessage, rule, field, args) {
+        const fieldName = this.#fields[field] ?? field;
+        const data = { field: fieldName, ...args };
+        const fieldMessage = this.#messages[`${field}.${rule}`];
+        if (fieldMessage !== undefined) {
+            return this.#interpolate(fieldMessage, data);
+        }
+        const wildcard = toWildcardPath(field);
+        const wildcardMessage = wildcard !== field ? this.#messages[`${wildcard}.${rule}`] : undefined;
+        if (wildcardMessage !== undefined) {
+            return this.#interpolate(wildcardMessage, data);
+        }
+        const ruleMessage = this.#messages[rule];
+        if (ruleMessage !== undefined) {
+            return this.#interpolate(ruleMessage, data);
+        }
+        return this.#interpolate(rawMessage, data);
+    }
+    toJSON() {
+        return { messages: this.#messages, fields: this.#fields };
+    }
+}
+//# sourceMappingURL=MessagesProvider.js.map

package/dist/MessagesProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessagesProvider.js","sourceRoot":"","sources":["../src/MessagesProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAUH,0EAA0E;AAC1E,SAAS,QAAQ,CAAC,KAAc;IAC/B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACpD,CAAC;AAgBD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC3C,OAAO,KAAK;SACV,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SACzD,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,CAAC;AAED,MAAM,OAAO,sBAAsB;IACzB,SAAS,CAAqB;IAC9B,OAAO,CAAmB;IAEnC,YAAY,QAA4B,EAAE,MAAyB;QAClE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,0EAA0E;IAC1E,YAAY,CAAC,OAAe,EAAE,IAAiB;QAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAc,EAAE,EAAE;YAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,MAAM,GAAY,IAAI,CAAC;YAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACvB,OAAO,EAAE,CAAC;gBACX,CAAC;gBACD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACnE,CAAC;YACD,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACT,UAAkB,EAClB,IAAY,EACZ,KAAa,EACb,IAAkB;QAElB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;QAC/C,MAAM,IAAI,GAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAC;QAExD,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC;QACxD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,eAAe,GACpB,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM;QACL,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;CACD"}