jasone 0.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lukas Heizmann
+
+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,124 @@
+# Jasone
+
+A lightweight, extensible JSON encoder and decoder which supports custom types.
+
+**NOTICE:** Jasone is still in early development and might not be stable yet.
+
+## Features
+
+- 🚀 Fast & Lightweight: Minimal footprint.
+- 🔌 Extensible: Easily add custom types.
+- 💻 TypeScript: Written in TypeScript for type safety and better DX.
+
+## Installation
+
+```bash
+# npm
+npm install jasone
+
+# pnpm
+pnpm add jasone
+
+# yarn
+yarn add jasone
+
+# bun
+bun add jasone
+```
+
+## Basic Usage
+
+### Encoding
+
+```ts
+import { Jasone } from "jasone";
+
+const data = { myDate: new Date("2025-04-05T14:30:00.000+02:00") };
+const encoded = JSON.stringify(Jasone.encode(data));
+
+console.log(encoded); // {"myDate":{"$":1,"timestamp":1743856200000}}
+```
+
+### Decoding
+
+```ts
+import { decode } from "cborkit/decoder";
+
+const encoded = '{"myDate":{"$":1,"timestamp":1743856200000}}';
+const decoded = Jasone.decode(JSON.parse(encoded));
+
+console.log(decoded); // { myDate: new Date("2025-04-05T14:30:00.000+02:00") }
+```
+
+## Advanced Usage
+
+Adding custom types is really easy. You just need to create an transformer object and register it with Jasone.
+
+```ts
+import { Jasone } from "jasone";
+
+class Car {
+  constructor(public brand: string, public model: string) {}
+
+  // ...
+}
+
+// use the `createType` helper
+const myType = createType({
+  // the match function is used to determine if the transformer can encode the given value
+  matches: (value) => value instanceof Car,
+
+  // the type id is used to identify the type on the encoded object
+  // (this needs to be unique and a string, numbers are currently reserved for built-in types)
+  typeId: "Car"
+
+  // the encode function which receives the matched value and need to return an valid JSON object
+  encode: (car) => ({ brand: car.brand, model: car.model }),
+
+  // the decode function which receives the encoded JSON object and needs to return a original value
+  decode: ({brand, model}) => new Car(brand, model),
+});
+```
+
+For classes, you can also use a bit more performant way of creating the transformer object:
+
+```ts
+const myType = createType({
+  // by using the `target` property, under the hood, Jasone will use the constructor to match
+  // the type. Which is more performant than using the `matches` property.
+  target: Car,
+  typeId: "Car",
+  encode: (car) => ({brand: car.brand, model: car.model}),
+  decode: ({brand, model}) => new Car(brand, model),
+});
+```
+
+Now the only thing left is to register the type with Jasone:
+
+```ts
+Jasone.register(myType);
+```
+
+And that's it! If you want multiple instances of Jasone with different types, simply create a new instance like so:
+
+```ts
+const jasone = new Jasone({
+  types: [myType],
+});
+```
+
+Or
+
+```ts
+const jasone = new Jasone();
+
+jasone.register(myType);
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).

package/index.cjs

@@ -0,0 +1 @@
+"use strict";var i=Object.defineProperty;var T=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var m=Object.prototype.hasOwnProperty;var y=(t,e)=>{for(var r in e)i(t,r,{get:e[r],enumerable:!0})},h=(t,e,r,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of f(e))!m.call(t,n)&&n!==r&&i(t,n,{get:()=>e[n],enumerable:!(o=T(e,n))||o.enumerable});return t};var u=t=>h(i({},"__esModule",{value:!0}),t);var E={};y(E,{Jasone:()=>c,createType:()=>s});module.exports=u(E);var a={};y(a,{bigIntType:()=>I,dateType:()=>g,mapType:()=>w,regExpType:()=>x,setType:()=>b,undefinedType:()=>l,urlType:()=>J});var s=t=>t;var l=s({matches:t=>t===void 0,typeId:0,encode:()=>({}),decode:()=>{}});var g=s({target:Date,typeId:1,encode:t=>({timestamp:t.getTime()}),decode:({timestamp:t})=>new Date(t)});var I=s({matches:t=>typeof t=="bigint",typeId:2,encode:t=>({bigint:t.toString()}),decode:({bigint:t})=>BigInt(t)});var x=s({matches:t=>t instanceof RegExp,typeId:3,encode:t=>({source:t.source,flags:t.flags}),decode:({source:t,flags:e})=>new RegExp(t,e)});var b=s({matches:t=>t instanceof Set,typeId:4,encode:(t,e)=>({set:Array.from(t.values().map(r=>e(r)))}),decode:({set:t},e)=>new Set(t.map(r=>e(r)))});var w=s({matches:t=>t instanceof Map,typeId:5,encode:(t,e)=>({map:Array.from(t.entries().map(([r,o])=>[e(r),e(o)]))}),decode:({map:t},e)=>new Map(t.map(([r,o])=>{if(r===void 0||o===void 0)throw new Error("Illegal value received.",{cause:t});return[e(r),e(o)]}))});var J=s({matches:t=>t instanceof URL,typeId:6,encode:t=>({url:t.toString()}),decode:({url:t})=>new URL(t)});var c=class t{#e;#r=new Map;#o=new Map;#n=[];constructor(e={}){this.#e=e.typeIdentifier??"$";for(let r of e.types??[])this.register(r)}register(e){this.#r.set(e.typeId,e.decode),"matches"in e?this.#n.push({matches:e.matches,typeId:e.typeId,encode:e.encode}):this.#o.set(e.target,{typeId:e.typeId,encode:e.encode})}encode(e){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":if(e===null)return null;if(Array.isArray(e))return e.map(n=>this.encode(n));if(Object.getPrototypeOf(e)===Object.prototype){let n=Object.fromEntries(Object.entries(e).map(([d,p])=>[d,this.encode(p)]));return this.#e in n&&(n[this.#e]=[this.encode(n[this.#e])]),n}}let r;if(typeof e=="object"&&e!==null&&(r=this.#o.get(e.constructor)),r||(r=this.#n.find(({matches:n})=>n(e))),!r)throw new Error("No encoder found.",{cause:e});let o=r.encode(e,this.encode.bind(this));return{[this.#e]:r.typeId,...o}}decode(e){return this.#t(e)}#t(e,r=!1){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":if(e===null)return null;if(Array.isArray(e))return e.map(o=>this.#t(o));if(this.#e in e&&!Array.isArray(e)&&!r){let o=e[this.#e];if(Array.isArray(o)){if(o.length!==1)throw new Error("Illegal value received. Escaped type identifiers must have exactly one element.",{cause:e});let[d]=o,p={...e};return p[this.#e]=d,this.#t(p,!0)}let n=this.#r.get(o);if(!n)throw new Error(`No decoder found for type id: ${o}`,{cause:e});return n(e,this.decode.bind(this))}if(Object.getPrototypeOf(e)===Object.prototype)return Object.fromEntries(Object.entries(e).map(([o,n])=>[o,this.#t(n)]));break}throw new Error("Illegal value received.",{cause:e})}static default=new t({types:Object.values(a)});static register=t.default.register.bind(t.default);static encode=t.default.encode.bind(t.default);static decode=t.default.decode.bind(t.default)};0&&(module.exports={Jasone,createType});

package/index.d.cts

@@ -0,0 +1,40 @@
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type TypeId = string | number;
+type TypeEncoder<TType = unknown, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = (value: TType, encode: <T = unknown>(value: T) => JsonValue) => TJson;
+type TypeDecoder<TType = unknown, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = (value: TJson, decode: <T = unknown>(value: JsonValue) => T) => TType;
+type MatchesFn<TType = unknown> = (value: unknown) => value is TType;
+type ClassLike<TInstance> = new (...args: unknown[]) => TInstance;
+declare const typeOf: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+type TypeOf = typeof typeOf;
+
+type TypeMatcher<TType> = {
+    matches: MatchesFn<TType>;
+} | {
+    target: ClassLike<TType>;
+};
+type TypeTransformer<TType, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = TypeMatcher<TType> & {
+    typeId: string | number;
+    encode: TypeEncoder<TType, TJson>;
+    decode: TypeDecoder<TType, TJson>;
+};
+declare const createType: <TType, TJson extends Record<string, JsonValue>>(transformer: TypeTransformer<TType, TJson>) => TypeTransformer<TType, TJson>;
+
+type JasoneOptions = {
+    typeIdentifier?: string;
+    types?: TypeTransformer<any, any>[];
+};
+declare class Jasone {
+    #private;
+    constructor(options?: JasoneOptions);
+    register<TType, TJson extends Record<string, JsonValue>>(type: TypeTransformer<TType, TJson>): void;
+    encode(value: unknown): JsonValue;
+    decode<T = unknown>(value: JsonValue): T;
+    static default: Jasone;
+    static register: <TType, TJson extends Record<string, JsonValue>>(type: TypeTransformer<TType, TJson>) => void;
+    static encode: (value: unknown) => JsonValue;
+    static decode: <T = unknown>(value: JsonValue) => T;
+}
+
+export { type ClassLike, Jasone, type JasoneOptions, type JsonValue, type MatchesFn, type TypeDecoder, type TypeEncoder, type TypeId, type TypeMatcher, type TypeOf, type TypeTransformer, createType };

package/index.d.ts

@@ -0,0 +1,40 @@
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type TypeId = string | number;
+type TypeEncoder<TType = unknown, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = (value: TType, encode: <T = unknown>(value: T) => JsonValue) => TJson;
+type TypeDecoder<TType = unknown, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = (value: TJson, decode: <T = unknown>(value: JsonValue) => T) => TType;
+type MatchesFn<TType = unknown> = (value: unknown) => value is TType;
+type ClassLike<TInstance> = new (...args: unknown[]) => TInstance;
+declare const typeOf: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+type TypeOf = typeof typeOf;
+
+type TypeMatcher<TType> = {
+    matches: MatchesFn<TType>;
+} | {
+    target: ClassLike<TType>;
+};
+type TypeTransformer<TType, TJson extends Record<string, JsonValue> = Record<string, JsonValue>> = TypeMatcher<TType> & {
+    typeId: string | number;
+    encode: TypeEncoder<TType, TJson>;
+    decode: TypeDecoder<TType, TJson>;
+};
+declare const createType: <TType, TJson extends Record<string, JsonValue>>(transformer: TypeTransformer<TType, TJson>) => TypeTransformer<TType, TJson>;
+
+type JasoneOptions = {
+    typeIdentifier?: string;
+    types?: TypeTransformer<any, any>[];
+};
+declare class Jasone {
+    #private;
+    constructor(options?: JasoneOptions);
+    register<TType, TJson extends Record<string, JsonValue>>(type: TypeTransformer<TType, TJson>): void;
+    encode(value: unknown): JsonValue;
+    decode<T = unknown>(value: JsonValue): T;
+    static default: Jasone;
+    static register: <TType, TJson extends Record<string, JsonValue>>(type: TypeTransformer<TType, TJson>) => void;
+    static encode: (value: unknown) => JsonValue;
+    static decode: <T = unknown>(value: JsonValue) => T;
+}
+
+export { type ClassLike, Jasone, type JasoneOptions, type JsonValue, type MatchesFn, type TypeDecoder, type TypeEncoder, type TypeId, type TypeMatcher, type TypeOf, type TypeTransformer, createType };

package/index.js

@@ -0,0 +1 @@
+var a=Object.defineProperty;var y=(t,e)=>{for(var r in e)a(t,r,{get:e[r],enumerable:!0})};var d={};y(d,{bigIntType:()=>m,dateType:()=>f,mapType:()=>l,regExpType:()=>h,setType:()=>u,undefinedType:()=>T,urlType:()=>g});var n=t=>t;var T=n({matches:t=>t===void 0,typeId:0,encode:()=>({}),decode:()=>{}});var f=n({target:Date,typeId:1,encode:t=>({timestamp:t.getTime()}),decode:({timestamp:t})=>new Date(t)});var m=n({matches:t=>typeof t=="bigint",typeId:2,encode:t=>({bigint:t.toString()}),decode:({bigint:t})=>BigInt(t)});var h=n({matches:t=>t instanceof RegExp,typeId:3,encode:t=>({source:t.source,flags:t.flags}),decode:({source:t,flags:e})=>new RegExp(t,e)});var u=n({matches:t=>t instanceof Set,typeId:4,encode:(t,e)=>({set:Array.from(t.values().map(r=>e(r)))}),decode:({set:t},e)=>new Set(t.map(r=>e(r)))});var l=n({matches:t=>t instanceof Map,typeId:5,encode:(t,e)=>({map:Array.from(t.entries().map(([r,o])=>[e(r),e(o)]))}),decode:({map:t},e)=>new Map(t.map(([r,o])=>{if(r===void 0||o===void 0)throw new Error("Illegal value received.",{cause:t});return[e(r),e(o)]}))});var g=n({matches:t=>t instanceof URL,typeId:6,encode:t=>({url:t.toString()}),decode:({url:t})=>new URL(t)});var i=class t{#e;#r=new Map;#o=new Map;#n=[];constructor(e={}){this.#e=e.typeIdentifier??"$";for(let r of e.types??[])this.register(r)}register(e){this.#r.set(e.typeId,e.decode),"matches"in e?this.#n.push({matches:e.matches,typeId:e.typeId,encode:e.encode}):this.#o.set(e.target,{typeId:e.typeId,encode:e.encode})}encode(e){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":if(e===null)return null;if(Array.isArray(e))return e.map(s=>this.encode(s));if(Object.getPrototypeOf(e)===Object.prototype){let s=Object.fromEntries(Object.entries(e).map(([c,p])=>[c,this.encode(p)]));return this.#e in s&&(s[this.#e]=[this.encode(s[this.#e])]),s}}let r;if(typeof e=="object"&&e!==null&&(r=this.#o.get(e.constructor)),r||(r=this.#n.find(({matches:s})=>s(e))),!r)throw new Error("No encoder found.",{cause:e});let o=r.encode(e,this.encode.bind(this));return{[this.#e]:r.typeId,...o}}decode(e){return this.#t(e)}#t(e,r=!1){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":if(e===null)return null;if(Array.isArray(e))return e.map(o=>this.#t(o));if(this.#e in e&&!Array.isArray(e)&&!r){let o=e[this.#e];if(Array.isArray(o)){if(o.length!==1)throw new Error("Illegal value received. Escaped type identifiers must have exactly one element.",{cause:e});let[c]=o,p={...e};return p[this.#e]=c,this.#t(p,!0)}let s=this.#r.get(o);if(!s)throw new Error(`No decoder found for type id: ${o}`,{cause:e});return s(e,this.decode.bind(this))}if(Object.getPrototypeOf(e)===Object.prototype)return Object.fromEntries(Object.entries(e).map(([o,s])=>[o,this.#t(s)]));break}throw new Error("Illegal value received.",{cause:e})}static default=new t({types:Object.values(d)});static register=t.default.register.bind(t.default);static encode=t.default.encode.bind(t.default);static decode=t.default.decode.bind(t.default)};export{i as Jasone,n as createType};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "jasone",
+  "version": "0.0.1",
+  "type": "module",
+  "author": "Lukas Heizmann <lukas@heizmann.dev>",
+  "license": "MIT",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lkwr/jasone.git"
+  },
+  "homepage": "https://github.com/lkwr/jasone",
+  "bugs": {
+    "url": "https://github.com/lkwr/jasone/issues"
+  },
+  "keywords": [
+    "json",
+    "extended",
+    "typed",
+    "custom-types"
+  ]
+}