@clementine-solutions/jane-io 1.0.1 → 1.0.3

package/dist/core/validators/string/starts-with.js

@@ -0,0 +1,50 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Validators | Starts With
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     Validates that the value is a string beginning with the
+ *                  provided `prefix`.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+import { validationEvent } from '../../pipeline';
+import { detectStructuralType } from '../../pipeline/scan';
+import { safeStringify } from '../../common';
+/* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— *\
+|* Implementation                                                            *|
+\* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— */
+/**
+ * Validates that the value is a string beginning with the provided `prefix`.
+ *
+ * - Non‑string values emit `string.not.string`.
+ * - Strings that do not begin with `prefix` emit `string.must.start-with`.
+ * - 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 startsWith = (prefix) => async (value, path) => {
+    const structuralType = detectStructuralType(value);
+    // ------------------------------------------------------------
+    // Type check
+    // ------------------------------------------------------------
+    if (typeof value !== 'string') {
+        return [
+            validationEvent('error', 'string.not.string', path, `Expected 'string' but received '${structuralType}'.`, `Please provide a valid string.`, { value, expected: 'string', actual: structuralType }),
+        ];
+    }
+    // ------------------------------------------------------------
+    // Starts-with check
+    // ------------------------------------------------------------
+    if (!value.startsWith(prefix)) {
+        return [
+            validationEvent('error', 'string.must.start-with', path, `${safeStringify(value)} must start with ${safeStringify(prefix)}.`, `Please begin the value with ${prefix}.`, { value, expected: `startsWith(${prefix})`, actual: value }),
+        ];
+    }
+    // ------------------------------------------------------------
+    // Valid
+    // ------------------------------------------------------------
+    return [];
+};

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

@@ -0,0 +1,39 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Validators | String
+ * ----------------------------------------------------------------------------
+ * @package         @clementine-solutions/jane
+ * @description     Validates that the value is a string.
+ * @see             https://jane-io.com
+ * ----------------------------------------------------------------------------
+ */
+import { validationEvent } from '../../pipeline';
+import { detectStructuralType } from '../../pipeline/scan';
+/* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— *\
+|* Implementation                                                            *|
+\* ——— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ————— * ——— */
+/**
+ * Validates that the value is a string.
+ *
+ * - Non‑string values emit `string.not.string`.
+ * - Returns an empty array when the value is a valid string.
+ *
+ * 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 string = async (value, path) => {
+    const structuralType = detectStructuralType(value);
+    // ------------------------------------------------------------
+    // Type check
+    // ------------------------------------------------------------
+    if (typeof value !== 'string') {
+        return [
+            validationEvent('error', 'string.not.string', path, `Expected 'string' but received '${structuralType}'.`, `Please enter a valid string.`, { value, expected: 'string', actual: structuralType }),
+        ];
+    }
+    // ------------------------------------------------------------
+    // Valid
+    // ------------------------------------------------------------
+    return [];
+};

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.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/index';
+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/package.json

@@ -2,6 +2,32 @@
     "name": "@clementine-solutions/jane-io",
     "type": "module",
     "main": "dist/index.js",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        },
+        "./core/common": {
+            "import": "./dist/core/common/index.js",
+            "types": "./dist/core/common/index.d.ts"
+        },
+        "./core/common/policy": {
+            "import": "./dist/core/common/policy.js",
+            "types": "./dist/core/common/policy.d.ts"
+        },
+        "./core/shapes": {
+            "import": "./dist/core/shapes/index.js",
+            "types": "./dist/core/shapes/index.d.ts"
+        },
+        "./core/pipeline": {
+            "import": "./dist/core/pipeline/index.js",
+            "types": "./dist/core/pipeline/index.d.ts"
+        },
+        "./core/pipeline/scan": {
+            "import": "./dist/core/pipeline/scan.js",
+            "types": "./dist/core/pipeline/scan.d.ts"
+        }
+    },
     "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>",
@@ -16,8 +42,7 @@
         "test:ci": "vitest --coverage",
         "docs": "mkdocs serve",
         "build": "tsc -p tsconfig.json",
-        "release": "semantic-release",
-        "test:smoke": "tsx src/test.ts"
+        "release": "semantic-release"
     },
     "devDependencies": {
         "@commitlint/cli": "^20.2.0",
@@ -83,5 +108,5 @@
         "access": "public",
         "registry": "https://registry.npmjs.org/"
     },
-    "version": "1.0.1"
+    "version": "1.0.3"
 }

package/dist/test.d.ts

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