@esmj/schema 0.0.2

package/LICENSE

@@ -0,0 +1,8 @@
+
+Copyright 2025 Miroslav Jancarik jancarikmiroslav@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,162 @@
+# Schema
+
+This small library provides a simple schema validation system for JavaScript/TypeScript. The library has basic types with opportunity for extending. 
+
+## Installation
+
+```sh
+npm install @esmj/schema
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { s } from '@esmj/schema';
+
+const schema = s.object({
+  username: s.string().optional(),
+  password: s.string().default('unknown'),
+  account: s.number().default(0),
+  address: s.object({
+    street: s.string(),
+    city: s.string().optional(),
+  }).default({ street: 'unknown' }),
+  records: s.array(s.object({ name: s.string() })).default([]),
+});
+
+const result = schema.parse({
+  username: 'john_doe',
+  address: { city: 'New York' },
+});
+
+console.log(result);
+```
+
+### Schema Types
+
+#### `s.string()`
+
+Creates a string schema.
+
+```typescript
+const stringSchema = s.string();
+```
+
+#### `s.number()`
+
+Creates a number schema.
+
+```typescript
+const numberSchema = s.number();
+```
+
+#### `s.boolean()`
+
+Creates a boolean schema.
+
+```typescript
+const booleanSchema = s.boolean();
+```
+
+#### `s.object(definition)`
+
+Creates an object schema with the given definition.
+
+```typescript
+const objectSchema = s.object({
+  key: s.string(),
+  value: s.number(),
+});
+```
+
+#### `s.array(definition)`
+
+Creates an array schema with the given item definition.
+
+```typescript
+const arraySchema = s.array(s.string());
+```
+
+#### `s.any()`
+
+Creates a schema that accepts any value.
+
+```typescript
+const anySchema = s.any();
+```
+
+### Schema Methods
+
+#### `parse(value)`
+
+Parses the given value according to the schema.
+
+```typescript
+const result = stringSchema.parse('hello');
+```
+
+#### `safeParse(value)`
+
+Safely parses the given value according to the schema, returning a success or error result.
+
+```typescript
+// correct
+const result = stringSchema.safeParse('hello'); // { success: true, data: 'hello' };
+// bad
+const result = stringSchema.safeParse('hello'); // { success: false, error: new Error() };
+```
+
+#### `optional()`
+
+Makes the schema optional.
+
+```typescript
+const optionalSchema = stringSchema.optional();
+```
+
+#### `nullable()`
+
+Makes the schema nullable.
+
+```typescript
+const nullableSchema = stringSchema.nullable();
+```
+
+#### `nullish()`
+
+Makes the schema nullish (nullable and optional).
+
+```typescript
+const nullishSchema = stringSchema.nullish();
+```
+
+#### `default(defaultValue)`
+
+Sets a default value for the schema.
+
+```typescript
+const defaultSchema = stringSchema.default('default value');
+```
+
+### Extending Schemas
+
+You can extend the schema system with custom logic.
+
+```typescript
+import { extend } from '@esmj/schema';
+
+extend((schema, validation, options) => {
+  schema.customMethod = () => {
+    // Custom logic
+  };
+
+  return schema;
+});
+```
+
+## License
+
+MIT
+

package/biome.json

@@ -0,0 +1,50 @@
+{
+  "files": {
+    "include": ["src/**/*.mjs", "src/**/*.ts", "utils/**/*.mjs"],
+    "ignore": [".history/**/*"]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 80,
+    "attributePosition": "auto"
+  },
+  "organizeImports": { "enabled": true },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noForEach": "off",
+        "noBannedTypes": "off"
+      },
+      "style": {
+        "noParameterAssign": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "all",
+      "semicolons": "always",
+      "arrowParentheses": "always",
+      "bracketSpacing": true,
+      "bracketSameLine": false,
+      "quoteStyle": "single",
+      "attributePosition": "auto"
+    }
+  },
+  "overrides": [
+    {
+      "include": ["*.json"],
+      "formatter": {
+        "indentWidth": 2
+      }
+    }
+  ]
+}

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+interface SchemaInterface<Input, Output> {
+    parse(value: Input | Partial<Input> | unknown): Output;
+    safeParse(value: Input | Partial<Input> | unknown): {
+        success: true;
+        data: Output;
+    } | {
+        success: false;
+        error: Error;
+    };
+    optional(): SchemaInterface<Input, Partial<Output> | undefined>;
+    nullable(): SchemaInterface<Input, Output | null>;
+    nullish(): SchemaInterface<Input, Output | undefined | null>;
+    default(defaultValue: Partial<Input> | (() => Partial<Input>) | Partial<Output>): SchemaInterface<Input, Output>;
+}
+type SchemaType = SchemaInterface<string, string> | SchemaInterface<string, string | undefined> | SchemaInterface<string, string | null> | SchemaInterface<string, string | undefined | null> | SchemaInterface<object, object> | SchemaInterface<object, object | undefined> | SchemaInterface<object, object | null> | SchemaInterface<object, object | undefined | null> | SchemaInterface<number, number> | SchemaInterface<number, number | undefined> | SchemaInterface<number, number | null> | SchemaInterface<number, number | undefined | null> | SchemaInterface<boolean, boolean> | SchemaInterface<boolean, boolean | undefined> | SchemaInterface<boolean, boolean | null> | SchemaInterface<boolean, boolean | undefined | null> | SchemaInterface<Array<unknown>, Array<unknown>> | SchemaInterface<Array<unknown>, Array<unknown> | undefined> | SchemaInterface<Array<unknown>, Array<unknown> | null> | SchemaInterface<Array<unknown>, Array<unknown> | undefined | null>;
+declare const s: {
+    object<T extends Record<string, SchemaType>>(definition: { [Property in keyof T]: T[Property]; }): SchemaInterface<{ [Property in keyof T]: T[Property]; }, { [Property in keyof T]: ReturnType<T[Property]["parse"]>; }>;
+    string(): SchemaInterface<string, string>;
+    number(): SchemaInterface<number, number>;
+    boolean(): SchemaInterface<boolean, boolean>;
+    array<T extends SchemaType>(definition: T): SchemaInterface<Array<T>, Array<ReturnType<T["parse"]>>>;
+    any(): any;
+};
+declare function extend(callback: Function): void;
+
+export { type SchemaInterface, type SchemaType, extend, s };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+interface SchemaInterface<Input, Output> {
+    parse(value: Input | Partial<Input> | unknown): Output;
+    safeParse(value: Input | Partial<Input> | unknown): {
+        success: true;
+        data: Output;
+    } | {
+        success: false;
+        error: Error;
+    };
+    optional(): SchemaInterface<Input, Partial<Output> | undefined>;
+    nullable(): SchemaInterface<Input, Output | null>;
+    nullish(): SchemaInterface<Input, Output | undefined | null>;
+    default(defaultValue: Partial<Input> | (() => Partial<Input>) | Partial<Output>): SchemaInterface<Input, Output>;
+}
+type SchemaType = SchemaInterface<string, string> | SchemaInterface<string, string | undefined> | SchemaInterface<string, string | null> | SchemaInterface<string, string | undefined | null> | SchemaInterface<object, object> | SchemaInterface<object, object | undefined> | SchemaInterface<object, object | null> | SchemaInterface<object, object | undefined | null> | SchemaInterface<number, number> | SchemaInterface<number, number | undefined> | SchemaInterface<number, number | null> | SchemaInterface<number, number | undefined | null> | SchemaInterface<boolean, boolean> | SchemaInterface<boolean, boolean | undefined> | SchemaInterface<boolean, boolean | null> | SchemaInterface<boolean, boolean | undefined | null> | SchemaInterface<Array<unknown>, Array<unknown>> | SchemaInterface<Array<unknown>, Array<unknown> | undefined> | SchemaInterface<Array<unknown>, Array<unknown> | null> | SchemaInterface<Array<unknown>, Array<unknown> | undefined | null>;
+declare const s: {
+    object<T extends Record<string, SchemaType>>(definition: { [Property in keyof T]: T[Property]; }): SchemaInterface<{ [Property in keyof T]: T[Property]; }, { [Property in keyof T]: ReturnType<T[Property]["parse"]>; }>;
+    string(): SchemaInterface<string, string>;
+    number(): SchemaInterface<number, number>;
+    boolean(): SchemaInterface<boolean, boolean>;
+    array<T extends SchemaType>(definition: T): SchemaInterface<Array<T>, Array<ReturnType<T["parse"]>>>;
+    any(): any;
+};
+declare function extend(callback: Function): void;
+
+export { type SchemaInterface, type SchemaType, extend, s };

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';var l={object(t){let c=s(u=>typeof u=="object"&&u!==null&&!Array.isArray(u),{type:"object"});return i(c,"parse",(u,...o)=>{let e=u(...o);return t&&typeof e=="object"?Object.keys(t).reduce((n,r)=>{if(typeof t[r]?.parse=="function")try{n[r]=t[r].parse(e[r]);}catch(p){throw r=p.cause?.key?`${r}.${p.cause.key}`:r,new Error(`Error parsing key "${r}": ${p.message}`,{cause:{key:r}})}return n},{}):e}),c},string(){return s(a=>typeof a=="string",{type:"string"})},number(){return s(a=>typeof a=="number",{type:"number"})},boolean(){return s(a=>a===true||a===false,{type:"boolean"})},array(t){let c=s(u=>Array.isArray(u),{type:"array"});return i(c,"parse",(u,o)=>(o=u(o),t&&Array.isArray(o)?o.map((e,n)=>{try{return t.parse(e)}catch(r){let p=r.cause?.key?`${n}.${r.cause.key}`:n;throw new Error(`Error parsing index "${n}": ${r.message}`,{cause:{key:p}})}}):o)),c},any(){return s(()=>true)}};function y(t){return a=>`The value "${a}" must be type of ${t} but is type of "${typeof a}".`}function i(t,a,c){let u=t[a];t[a]=(...o)=>c(u,...o);}function s(t,{type:a="any"}={}){let c=y(a),u={message:c,type:a},o={parse(e){if(!t(e))throw new Error(c(e));return e},safeParse(e){try{return {success:!0,data:this.parse(e)}}catch(n){return {success:false,error:n}}},optional(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return}}),this},nullable(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return null}}),this},nullish(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return n==null?n:null}}),this},default(e){return i(this,"parse",(n,r)=>(r===void 0&&(r=e,r=typeof e=="function"?e():e),r=n(r),r)),this}};return f.reduce((e,n)=>n(e,t,u)??e,o)}var f=[];function h(t){f.push(t);}exports.extend=h;exports.s=l;

package/dist/index.mjs

@@ -0,0 +1 @@
+var l={object(t){let c=s(u=>typeof u=="object"&&u!==null&&!Array.isArray(u),{type:"object"});return i(c,"parse",(u,...o)=>{let e=u(...o);return t&&typeof e=="object"?Object.keys(t).reduce((n,r)=>{if(typeof t[r]?.parse=="function")try{n[r]=t[r].parse(e[r]);}catch(p){throw r=p.cause?.key?`${r}.${p.cause.key}`:r,new Error(`Error parsing key "${r}": ${p.message}`,{cause:{key:r}})}return n},{}):e}),c},string(){return s(a=>typeof a=="string",{type:"string"})},number(){return s(a=>typeof a=="number",{type:"number"})},boolean(){return s(a=>a===true||a===false,{type:"boolean"})},array(t){let c=s(u=>Array.isArray(u),{type:"array"});return i(c,"parse",(u,o)=>(o=u(o),t&&Array.isArray(o)?o.map((e,n)=>{try{return t.parse(e)}catch(r){let p=r.cause?.key?`${n}.${r.cause.key}`:n;throw new Error(`Error parsing index "${n}": ${r.message}`,{cause:{key:p}})}}):o)),c},any(){return s(()=>true)}};function y(t){return a=>`The value "${a}" must be type of ${t} but is type of "${typeof a}".`}function i(t,a,c){let u=t[a];t[a]=(...o)=>c(u,...o);}function s(t,{type:a="any"}={}){let c=y(a),u={message:c,type:a},o={parse(e){if(!t(e))throw new Error(c(e));return e},safeParse(e){try{return {success:!0,data:this.parse(e)}}catch(n){return {success:false,error:n}}},optional(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return}}),this},nullable(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return null}}),this},nullish(){return i(this,"parse",(e,n)=>{try{return e(n)}catch{return n==null?n:null}}),this},default(e){return i(this,"parse",(n,r)=>(r===void 0&&(r=e,r=typeof e=="function"?e():e),r=n(r),r)),this}};return f.reduce((e,n)=>n(e,t,u)??e,o)}var f=[];function h(t){f.push(t);}export{h as extend,l as s};

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@esmj/schema",
+  "version": "0.0.2",
+  "description": "Tiny extendable package for schema validation.",
+  "keywords": [
+    "schema",
+    "validation",
+    "type",
+    "inference",
+    "zod"
+  ],
+  "main": "dist/index",
+  "module": "dist/index",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "typings": "dist/index.d.ts",
+  "scripts": {
+    "lint": "biome check --no-errors-on-unmatched",
+    "lint:fix": "npm run lint -- --fix --unsafe",
+    "dev": "node_modules/.bin/tsup --dts --watch --onSuccess 'node ./dist/index.mjs'",
+    "test": "node --test --experimental-strip-types",
+    "test:watch": "npm run test -- --watchAll",
+    "preversion": "npm test && npm run lint && npm run build",
+    "version": "npm run changelog && git add CHANGELOG.md",
+    "postversion": "git push && git push --tags",
+    "commit": "node_modules/.bin/git-cz",
+    "changelog": "node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
+    "build": "node_modules/.bin/tsup --dts",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mjancarik/esmj-schema.git"
+  },
+  "author": "Miroslav Jancarik",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mjancarik/esmj-schema/issues"
+  },
+  "lint-staged": {
+    "**/*.{ts,js,mjs}": "npm run lint"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "git-cz"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "homepage": "https://github.com/mjancarik/esmj-schema#readme",
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@commitlint/cli": "^19.7.1",
+    "@commitlint/config-conventional": "^19.7.1",
+    "@typescript-eslint/eslint-plugin": "^8.24.0",
+    "@typescript-eslint/parser": "^8.24.0",
+    "commitizen": "^4.3.1",
+    "conventional-changelog-cli": "^5.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "git-cz": "^4.9.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
+    "prettier": "^3.5.0",
+    "tsup": "^8.3.6"
+  }
+}