@clementine-solutions/jane-io 1.0.0 → 1.0.2

package/dist/core/validators/string/trimmed.d.ts

@@ -0,0 +1,24 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Validators | Trimmed (No Leading Or Trailing Whitespace)
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     Validates that the value is a string with no leading or
+ *                  trailing whitespace.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+import type { ValidationRule } from '../../shapes';
+/**
+ * Validates that the value is a string with no leading or trailing whitespace.
+ *
+ * - Non‑string values emit `type.not.valid`.
+ * - Strings whose trimmed form differs from the original emit
+ *   `string.not.trimmed`.
+ * - Returns an empty array when the value is valid.
+ *
+ * This rule is pure, total, async‑compatible, and returns a readonly array of
+ * JaneEvent objects. It preserves the provided path and supports userMessage
+ * overrides applied at the pipeline level.
+ */
+export declare const trimmed: ValidationRule;

package/dist/core/validators/string/trimmed.js

@@ -0,0 +1,51 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Validators | Trimmed (No Leading Or Trailing Whitespace)
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     Validates that the value is a string with no leading or
+ *                  trailing whitespace.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+import { validationEvent } from '../../pipeline';
+import { safeStringify } from '../../common';
+import { detectStructuralType } from '../../pipeline/scan';
+/* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— *\
+|* Implementation                                                            *|
+\* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— */
+/**
+ * Validates that the value is a string with no leading or trailing whitespace.
+ *
+ * - Non‑string values emit `type.not.valid`.
+ * - Strings whose trimmed form differs from the original emit
+ *   `string.not.trimmed`.
+ * - Returns an empty array when the value is valid.
+ *
+ * This rule is pure, total, async‑compatible, and returns a readonly array of
+ * JaneEvent objects. It preserves the provided path and supports userMessage
+ * overrides applied at the pipeline level.
+ */
+export const trimmed = async (value, path) => {
+    const structuralType = detectStructuralType(value);
+    // ------------------------------------------------------------
+    // Type check
+    // ------------------------------------------------------------
+    if (typeof value !== 'string') {
+        return [
+            validationEvent('error', 'type.not.valid', path, `Expected 'string' but received '${structuralType}'.`, `Please enter a valid string.`, { value, expected: 'string', actual: structuralType }),
+        ];
+    }
+    // ------------------------------------------------------------
+    // Trimmed-edge check
+    // ------------------------------------------------------------
+    if (value !== value.trim()) {
+        return [
+            validationEvent('error', 'string.not.trimmed', path, `${safeStringify(value)} must not have leading or trailing whitespace.`, `Please remove surrounding spaces.`, { value, expected: 'trimmed string', actual: value }),
+        ];
+    }
+    // ------------------------------------------------------------
+    // Valid
+    // ------------------------------------------------------------
+    return [];
+};

package/dist/index.d.ts

@@ -0,0 +1,83 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Public | Jane
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     The public entry point for creating and running Jane
+ *                  boundaries.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+/**
+ * The default Jane instance configured with the library’s built‑in policy.
+ *
+ * Exposes the full public API—value(), boundary(), and withPolicy()—and
+ * serves as the primary entry point for consumers who do not need custom
+ * policy configuration.
+ */
+export declare const jane: {
+    value(raw: unknown, path?: import("./core/shapes").FieldPath, options?: {
+        inputName?: string;
+    }): import("./core/shapes").PublicPipeline;
+    boundary<TShape extends Record<string, import("./core/shapes").PublicPipeline>>(shape: TShape): Promise<{
+        policy: import("./core/shapes").Policy;
+        ok: boolean;
+        issues?: readonly import("./core/shapes").JaneEvent[];
+        events?: readonly import("./core/shapes").JaneEvent[];
+        values?: Record<string, unknown> | undefined;
+        fields: Record<string, import("./core/shapes").JaneResult<unknown>>;
+        metadata: {
+            runId?: string;
+            startedAt?: string;
+            finishedAt?: string;
+            durationMs?: number;
+            fields: Record<string, import("./core/shapes").FieldMetadata>;
+        };
+    }>;
+    withPolicy(input: import("./core/shapes").PolicyInput): /*elided*/ any;
+    strictBoundary<TShape extends Record<string, import("./core/shapes").PublicPipeline>>(shape: TShape): Promise<{
+        policy: import("./core/shapes").Policy;
+        ok: boolean;
+        issues?: readonly import("./core/shapes").JaneEvent[];
+        events?: readonly import("./core/shapes").JaneEvent[];
+        values?: Record<string, unknown> | undefined;
+        fields: Record<string, import("./core/shapes").JaneResult<unknown>>;
+        metadata: {
+            runId?: string;
+            startedAt?: string;
+            finishedAt?: string;
+            durationMs?: number;
+            fields: Record<string, import("./core/shapes").FieldMetadata>;
+        };
+    }>;
+    laxBoundary<TShape extends Record<string, import("./core/shapes").PublicPipeline>>(shape: TShape): Promise<{
+        policy: import("./core/shapes").Policy;
+        ok: boolean;
+        issues?: readonly import("./core/shapes").JaneEvent[];
+        events?: readonly import("./core/shapes").JaneEvent[];
+        values?: Record<string, unknown> | undefined;
+        fields: Record<string, import("./core/shapes").JaneResult<unknown>>;
+        metadata: {
+            runId?: string;
+            startedAt?: string;
+            finishedAt?: string;
+            durationMs?: number;
+            fields: Record<string, import("./core/shapes").FieldMetadata>;
+        };
+    }>;
+    defaultBoundary<TShape extends Record<string, import("./core/shapes").PublicPipeline>>(shape: TShape): Promise<{
+        policy: import("./core/shapes").Policy;
+        ok: boolean;
+        issues?: readonly import("./core/shapes").JaneEvent[];
+        events?: readonly import("./core/shapes").JaneEvent[];
+        values?: Record<string, unknown> | undefined;
+        fields: Record<string, import("./core/shapes").JaneResult<unknown>>;
+        metadata: {
+            runId?: string;
+            startedAt?: string;
+            finishedAt?: string;
+            durationMs?: number;
+            fields: Record<string, import("./core/shapes").FieldMetadata>;
+        };
+    }>;
+};

package/dist/index.js

@@ -0,0 +1,26 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Public | Jane
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     The public entry point for creating and running Jane
+ *                  boundaries.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+/* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— *\
+|* Internal Modules                                                          *|
+\* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— */
+import { createJane } from './core/common';
+import { defaultPolicy } from './core/common/policy';
+/* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— *\
+|* Jane                                                                      *|
+\* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— */
+/**
+ * The default Jane instance configured with the library’s built‑in policy.
+ *
+ * Exposes the full public API—value(), boundary(), and withPolicy()—and
+ * serves as the primary entry point for consumers who do not need custom
+ * policy configuration.
+ */
+export const jane = createJane(defaultPolicy);

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,12 @@
+import { jane } from '.';
+const input = {
+    name: 'John Doe',
+    age: 37,
+    email: 'john.doe@example.com',
+};
+const result = await jane.boundary({
+    name: jane.value(input.name).string().nonEmpty(),
+    age: jane.value(input.age).parse('numeric').positive(),
+    email: jane.value(input.email).nonEmpty().isEmail(),
+});
+console.dir(result, { depth: null, colors: true });

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@clementine-solutions/jane-io",
     "type": "module",
-    "main": "index.js",
+    "main": "dist/index.js",
     "description": "A clarity-first boundary system for shaping, validating, and transforming data with full introspection and policy control.",
     "license": "Apache-2.0",
     "author": "Clementine Solutions <develop.clementine@outlook.com>",
@@ -83,5 +83,5 @@
         "access": "public",
         "registry": "https://registry.npmjs.org/"
     },
-    "version": "1.0.0"
+    "version": "1.0.2"
 }