schemind 0.1.0 → 0.2.0

package/README.md

@@ -27,7 +27,7 @@ In formats like JSON, a message normally looks something like this:
 ```
 *I'm using JSON as an example here, but schemind is essentially protocol-agnostic. I use it with MessagePack.*
 
-If you desperately need to make this message more compact, you could alternatively serialize it as such:
+If you desperately need to make this message more compact, you could alternatively serialize it like so:
 ```json
 [
   1,
@@ -49,10 +49,11 @@ If you desperately need to make this message more compact, you could alternative
 
 This is sometimes referred to as a message with *indexed keys*.
 
-*Note that this obviously has some drawbacks: [recommended reading about the pros and cons of this format](https://github.com/MessagePack-CSharp/MessagePack-CSharp#use-indexed-keys-instead-of-string-keys-contractless).*
-
 **Schemind** helps you create and read such messages, if your (de)serializer doesn't support this technique.
 
+
+*Note that this format obviously has some drawbacks: [recommended reading about the pros and cons](https://github.com/MessagePack-CSharp/MessagePack-CSharp#use-indexed-keys-instead-of-string-keys-contractless).*
+
 ## Installation
 
 ```shell

package/dist/schemind.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=Symbol("isSchemaLeaf");class r extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function P(e){return h(e,[],0),e}function h(e,t,s){for(const[o,d]of Object.entries(e)){const n=d;i(n)?I(n,t,s):h(n,t,s+1)}}function I(e,t,s){if(t.some(n=>n.length===e.indexesPathReversed.length&&n.every((a,S)=>a===e.indexesPathReversed[S])))throw new r;if(t.push(e.indexesPathReversed),e.indexesPathReversed.length!==s+1)throw new r}function b(e){return t=>t?(l(t,e),t):{indexesPathReversed:[e],fieldType:void 0,[c]:!0}}function i(e){return Object.hasOwn(e,c)}function l(e,t){for(const[s,o]of Object.entries(e)){const d=o;i(d)?d.indexesPathReversed.push(t):l(d,t)}}function f(e,t){const s=t.indexesPathReversed;let o=e;for(let n=t.indexesPathReversed.length-1;n>=1;n--)o=o[s[n]];const d=s[0];return o[d]}function u(e,t,s){const o=t.indexesPathReversed;let d=e;for(let a=t.indexesPathReversed.length-1;a>=1;a--)d[o[a]]===void 0&&(d[o[a]]=[]),d=d[o[a]];const n=o[0];d[n]=s}function v(e,t){const s={};for(const[o,d]of Object.entries(t)){const n=d;let a;i(n)?a=f(e,n):a=v(e,n),s[o]=a}return s}function g(e,t){const s=[];return x(s,e,t),s}function x(e,t,s){for(const[o,d]of Object.entries(s)){const n=d,a=t[o];i(n)?u(e,n,a):x(e,a,n)}}exports.InvalidSchemaError=r;exports.get=f;exports.set=u;exports.toIndexedKeysMessage=g;exports.toPlainObject=v;exports.validateSchema=P;exports.withIndex=b;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function h(e,t){const o=t[i];let s=e;for(let c=t[i].length-1;c>=1;c--)s=s[o[c]];const r=o[0];return s[r]}function f(e,t,o){const s=t[i];let r=e;for(let n=t[i].length-1;n>=1;n--)r[s[n]]===void 0&&(r[s[n]]=[]),r=r[s[n]];const c=s[0];r[c]=o}const i=Symbol("indexesPathReversed"),g=Symbol("fieldType"),u=Symbol("isSchemaLeaf");class l extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function m(e){return S(e,e,[],0),e}function S(e,t,o,s){for(const[r,c]of Object.entries(t)){const n=c;d(n)?(p(n,o,s),n.get=a=>h(a,n),n.set=(a,x)=>f(a,n,x)):S(e,n,o,s+1)}}function p(e,t,o){if(t.some(c=>c.length===e[i].length&&c.every((n,a)=>n===e[i][a])))throw new l;if(t.push(e[i]),e[i].length!==o+1)throw new l}function y(e){return t=>t?(b(t,e),t):{[i]:[e],[g]:void 0,[u]:!0}}function d(e){return Object.hasOwn(e,u)}function b(e,t){for(const[o,s]of Object.entries(e)){const r=s;d(r)?r[i].push(t):b(r,t)}}function v(e,t){const o={};for(const[s,r]of Object.entries(t)){const c=r;let n;d(c)?n=h(e,c):n=v(e,c),o[s]=n}return o}function O(e,t){const o=[];return I(o,e,t),o}function I(e,t,o){for(const[s,r]of Object.entries(o)){const c=r,n=t[s];d(c)?f(e,c,n):I(e,n,c)}}exports.InvalidSchemaError=l;exports.buildSchema=m;exports.get=h;exports.set=f;exports.toIndexedKeysMessage=O;exports.toPlainObject=v;exports.withIndex=y;

package/dist/schemind.d.ts

@@ -1,5 +1,9 @@
 import { NonNegativeInteger } from 'type-fest';
 
+export declare function buildSchema<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(schema: TSchema): ToValidIndexedKeysMessageSchema<TSchema>;
+
+declare const fieldType: unique symbol;
+
 export declare function get<const TField>(message: readonly unknown[], schemaField: ValidSchemaLeaf<TField>): TField;
 
 declare type IndexedKeysMessageSchema<TSchema> = {
@@ -8,6 +12,8 @@ declare type IndexedKeysMessageSchema<TSchema> = {
 
 declare type IndexesPath = number[];
 
+declare const indexesPathReversed: unique symbol;
+
 declare type Invalid<T extends string> = {
     [invalid]: T;
 };
@@ -20,7 +26,7 @@ export declare class InvalidSchemaError extends Error {
 
 declare const isSchemaLeafTag: unique symbol;
 
-declare const isValidSchemaLeaf: unique symbol;
+declare const isValidSchemaLeafTag: unique symbol;
 
 declare type PlainObjectOfSchema<TSchema> = TSchema extends ValidIndexedKeysMessageSchema<unknown> ? {
     [K in keyof TSchema]: TSchema[K] extends ValidSchemaLeaf<infer TField> ? TField : TSchema[K] extends SchemaLeaf<unknown> ? Invalid<"Schema needs to be validated before you use it!"> : PlainObjectOfSchema<TSchema[K]>;
@@ -29,8 +35,8 @@ declare type PlainObjectOfSchema<TSchema> = TSchema extends ValidIndexedKeysMess
 declare type ReturnedSchemaNode<TField, TNestedSchema> = TNestedSchema extends undefined ? SchemaLeaf<TField> : TNestedSchema;
 
 declare type SchemaLeaf<TField> = {
-    indexesPathReversed: IndexesPath;
-    fieldType: TField;
+    [indexesPathReversed]: IndexesPath;
+    [fieldType]: TField;
     [isSchemaLeafTag]: true;
 };
 
@@ -44,14 +50,14 @@ declare type ToValidIndexedKeysMessageSchema<TSchema> = {
     [K in keyof TSchema]: TSchema[K] extends SchemaLeaf<infer TField> ? ValidSchemaLeaf<TField> : ToValidIndexedKeysMessageSchema<TSchema[K]>;
 };
 
-export declare function validateSchema<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(schema: TSchema): ToValidIndexedKeysMessageSchema<TSchema>;
-
 export declare type ValidIndexedKeysMessageSchema<TSchema> = {
-    [K in keyof TSchema]: TSchema[K] extends ValidSchemaLeaf<infer TField> ? ValidSchemaLeaf<TField> : TSchema[K] extends SchemaLeaf<unknown> ? Invalid<"Schema needs to be validated before you use it, did you forget to call validateSchema()?"> : ToValidIndexedKeysMessageSchema<TSchema[K]>;
+    [K in keyof TSchema]: TSchema[K] extends ValidSchemaLeaf<infer TField> ? ValidSchemaLeaf<TField> : TSchema[K] extends SchemaLeaf<unknown> ? Invalid<"Schema needs to be built before you use it, did you forget to call buildSchema()?"> : ToValidIndexedKeysMessageSchema<TSchema[K]>;
 };
 
 declare type ValidSchemaLeaf<TField> = SchemaLeaf<TField> & {
-    [isValidSchemaLeaf]: true;
+    [isValidSchemaLeafTag]: true;
+    get: (message: unknown[]) => TField;
+    set: (message: unknown[], value: TField) => void;
 };
 
 export declare function withIndex<const TIndex extends number>(index: NonNegativeInteger<TIndex>): <const TField = undefined, TNestedSchema extends IndexedKeysMessageSchema<TNestedSchema> | undefined = undefined>(nestedSchema?: TNestedSchema) => ReturnedSchemaNode<TField, TNestedSchema>;

package/dist/schemind.iife.js

@@ -1 +1 @@
-var Schemind=function(o){"use strict";const h=Symbol("isSchemaLeaf");class r extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function x(e){return l(e,[],0),e}function l(e,t,s){for(const[i,d]of Object.entries(e)){const n=d;c(n)?I(n,t,s):l(n,t,s+1)}}function I(e,t,s){if(t.some(n=>n.length===e.indexesPathReversed.length&&n.every((a,R)=>a===e.indexesPathReversed[R])))throw new r;if(t.push(e.indexesPathReversed),e.indexesPathReversed.length!==s+1)throw new r}function b(e){return t=>t?(f(t,e),t):{indexesPathReversed:[e],fieldType:void 0,[h]:!0}}function c(e){return Object.hasOwn(e,h)}function f(e,t){for(const[s,i]of Object.entries(e)){const d=i;c(d)?d.indexesPathReversed.push(t):f(d,t)}}function u(e,t){const s=t.indexesPathReversed;let i=e;for(let n=t.indexesPathReversed.length-1;n>=1;n--)i=i[s[n]];const d=s[0];return i[d]}function v(e,t,s){const i=t.indexesPathReversed;let d=e;for(let a=t.indexesPathReversed.length-1;a>=1;a--)d[i[a]]===void 0&&(d[i[a]]=[]),d=d[i[a]];const n=i[0];d[n]=s}function S(e,t){const s={};for(const[i,d]of Object.entries(t)){const n=d;let a;c(n)?a=u(e,n):a=S(e,n),s[i]=a}return s}function g(e,t){const s=[];return P(s,e,t),s}function P(e,t,s){for(const[i,d]of Object.entries(s)){const n=d,a=t[i];c(n)?v(e,n,a):P(e,a,n)}}return o.InvalidSchemaError=r,o.get=u,o.set=v,o.toIndexedKeysMessage=g,o.toPlainObject=S,o.validateSchema=x,o.withIndex=b,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),o}({});
+var Schemind=function(d){"use strict";function h(e,t){const o=t[a];let s=e;for(let c=t[a].length-1;c>=1;c--)s=s[o[c]];const i=o[0];return s[i]}function u(e,t,o){const s=t[a];let i=e;for(let n=t[a].length-1;n>=1;n--)i[s[n]]===void 0&&(i[s[n]]=[]),i=i[s[n]];const c=s[0];i[c]=o}const a=Symbol("indexesPathReversed"),m=Symbol("fieldType"),S=Symbol("isSchemaLeaf");class f extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function y(e){return v(e,e,[],0),e}function v(e,t,o,s){for(const[i,c]of Object.entries(t)){const n=c;l(n)?(O(n,o,s),n.get=r=>h(r,n),n.set=(r,P)=>u(r,n,P)):v(e,n,o,s+1)}}function O(e,t,o){if(t.some(c=>c.length===e[a].length&&c.every((n,r)=>n===e[a][r])))throw new f;if(t.push(e[a]),e[a].length!==o+1)throw new f}function j(e){return t=>t?(b(t,e),t):{[a]:[e],[m]:void 0,[S]:!0}}function l(e){return Object.hasOwn(e,S)}function b(e,t){for(const[o,s]of Object.entries(e)){const i=s;l(i)?i[a].push(t):b(i,t)}}function I(e,t){const o={};for(const[s,i]of Object.entries(t)){const c=i;let n;l(c)?n=h(e,c):n=I(e,c),o[s]=n}return o}function w(e,t){const o=[];return g(o,e,t),o}function g(e,t,o){for(const[s,i]of Object.entries(o)){const c=i,n=t[s];l(c)?u(e,c,n):g(e,n,c)}}return d.InvalidSchemaError=f,d.buildSchema=y,d.get=h,d.set=u,d.toIndexedKeysMessage=w,d.toPlainObject=I,d.withIndex=j,Object.defineProperty(d,Symbol.toStringTag,{value:"Module"}),d}({});

package/dist/schemind.js

@@ -1,81 +1,81 @@
-const c = Symbol("isSchemaLeaf");
-class a extends Error {
+function f(e, t) {
+  const o = t[i];
+  let s = e;
+  for (let c = t[i].length - 1; c >= 1; c--)
+    s = s[o[c]];
+  const r = o[0];
+  return s[r];
+}
+function h(e, t, o) {
+  const s = t[i];
+  let r = e;
+  for (let n = t[i].length - 1; n >= 1; n--)
+    r[s[n]] === void 0 && (r[s[n]] = []), r = r[s[n]];
+  const c = s[0];
+  r[c] = o;
+}
+const i = Symbol("indexesPathReversed"), b = Symbol("fieldType"), u = Symbol("isSchemaLeaf");
+class l extends Error {
   constructor() {
     super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."), this.name = "InvalidSchemaError";
   }
 }
-function I(e) {
-  return h(e, [], 0), e;
+function m(e) {
+  return v(e, e, [], 0), e;
 }
-function h(e, t, s) {
-  for (const [o, d] of Object.entries(e)) {
-    const n = d;
-    r(n) ? v(n, t, s) : h(n, t, s + 1);
+function v(e, t, o, s) {
+  for (const [r, c] of Object.entries(t)) {
+    const n = c;
+    d(n) ? (p(n, o, s), n.get = (a) => f(a, n), n.set = (a, I) => h(a, n, I)) : v(e, n, o, s + 1);
   }
 }
-function v(e, t, s) {
-  if (t.some((n) => n.length === e.indexesPathReversed.length && n.every((i, u) => i === e.indexesPathReversed[u])))
-    throw new a();
-  if (t.push(e.indexesPathReversed), e.indexesPathReversed.length !== s + 1)
-    throw new a();
+function p(e, t, o) {
+  if (t.some((c) => c.length === e[i].length && c.every((n, a) => n === e[i][a])))
+    throw new l();
+  if (t.push(e[i]), e[i].length !== o + 1)
+    throw new l();
 }
-function R(e) {
-  return (t) => t ? (l(t, e), t) : {
-    indexesPathReversed: [e],
-    fieldType: void 0,
-    [c]: !0
+function y(e) {
+  return (t) => t ? (S(t, e), t) : {
+    [i]: [e],
+    [b]: void 0,
+    [u]: !0
   };
 }
-function r(e) {
-  return Object.hasOwn(e, c);
+function d(e) {
+  return Object.hasOwn(e, u);
 }
-function l(e, t) {
-  for (const [s, o] of Object.entries(e)) {
-    const d = o;
-    r(d) ? d.indexesPathReversed.push(t) : l(d, t);
+function S(e, t) {
+  for (const [o, s] of Object.entries(e)) {
+    const r = s;
+    d(r) ? r[i].push(t) : S(r, t);
   }
 }
-function x(e, t) {
-  const s = t.indexesPathReversed;
-  let o = e;
-  for (let n = t.indexesPathReversed.length - 1; n >= 1; n--)
-    o = o[s[n]];
-  const d = s[0];
-  return o[d];
-}
-function P(e, t, s) {
-  const o = t.indexesPathReversed;
-  let d = e;
-  for (let i = t.indexesPathReversed.length - 1; i >= 1; i--)
-    d[o[i]] === void 0 && (d[o[i]] = []), d = d[o[i]];
-  const n = o[0];
-  d[n] = s;
-}
-function S(e, t) {
-  const s = {};
-  for (const [o, d] of Object.entries(t)) {
-    const n = d;
-    let i;
-    r(n) ? i = x(e, n) : i = S(e, n), s[o] = i;
+function g(e, t) {
+  const o = {};
+  for (const [s, r] of Object.entries(t)) {
+    const c = r;
+    let n;
+    d(c) ? n = f(e, c) : n = g(e, c), o[s] = n;
   }
-  return s;
+  return o;
 }
-function p(e, t) {
-  const s = [];
-  return f(s, e, t), s;
+function O(e, t) {
+  const o = [];
+  return x(o, e, t), o;
 }
-function f(e, t, s) {
-  for (const [o, d] of Object.entries(s)) {
-    const n = d, i = t[o];
-    r(n) ? P(e, n, i) : f(e, i, n);
+function x(e, t, o) {
+  for (const [s, r] of Object.entries(o)) {
+    const c = r, n = t[s];
+    d(c) ? h(e, c, n) : x(e, n, c);
   }
 }
 export {
-  a as InvalidSchemaError,
-  x as get,
-  P as set,
-  p as toIndexedKeysMessage,
-  S as toPlainObject,
-  I as validateSchema,
-  R as withIndex
+  l as InvalidSchemaError,
+  m as buildSchema,
+  f as get,
+  h as set,
+  O as toIndexedKeysMessage,
+  g as toPlainObject,
+  y as withIndex
 };

package/dist/schemind.umd.cjs

@@ -1 +1 @@
-(function(a,c){typeof exports=="object"&&typeof module<"u"?c(exports):typeof define=="function"&&define.amd?define(["exports"],c):(a=typeof globalThis<"u"?globalThis:a||self,c(a.Schemind={}))})(this,function(a){"use strict";const c=Symbol("isSchemaLeaf");class h extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function P(e){return f(e,[],0),e}function f(e,t,s){for(const[i,d]of Object.entries(e)){const n=d;r(n)?I(n,t,s):f(n,t,s+1)}}function I(e,t,s){if(t.some(n=>n.length===e.indexesPathReversed.length&&n.every((o,g)=>o===e.indexesPathReversed[g])))throw new h;if(t.push(e.indexesPathReversed),e.indexesPathReversed.length!==s+1)throw new h}function b(e){return t=>t?(l(t,e),t):{indexesPathReversed:[e],fieldType:void 0,[c]:!0}}function r(e){return Object.hasOwn(e,c)}function l(e,t){for(const[s,i]of Object.entries(e)){const d=i;r(d)?d.indexesPathReversed.push(t):l(d,t)}}function u(e,t){const s=t.indexesPathReversed;let i=e;for(let n=t.indexesPathReversed.length-1;n>=1;n--)i=i[s[n]];const d=s[0];return i[d]}function v(e,t,s){const i=t.indexesPathReversed;let d=e;for(let o=t.indexesPathReversed.length-1;o>=1;o--)d[i[o]]===void 0&&(d[i[o]]=[]),d=d[i[o]];const n=i[0];d[n]=s}function x(e,t){const s={};for(const[i,d]of Object.entries(t)){const n=d;let o;r(n)?o=u(e,n):o=x(e,n),s[i]=o}return s}function m(e,t){const s=[];return S(s,e,t),s}function S(e,t,s){for(const[i,d]of Object.entries(s)){const n=d,o=t[i];r(n)?v(e,n,o):S(e,o,n)}}a.InvalidSchemaError=h,a.get=u,a.set=v,a.toIndexedKeysMessage=m,a.toPlainObject=x,a.validateSchema=P,a.withIndex=b,Object.defineProperty(a,Symbol.toStringTag,{value:"Module"})});
+(function(c,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(c=typeof globalThis<"u"?globalThis:c||self,r(c.Schemind={}))})(this,function(c){"use strict";function r(e,t){const o=t[a];let s=e;for(let i=t[a].length-1;i>=1;i--)s=s[o[i]];const d=o[0];return s[d]}function u(e,t,o){const s=t[a];let d=e;for(let n=t[a].length-1;n>=1;n--)d[s[n]]===void 0&&(d[s[n]]=[]),d=d[s[n]];const i=s[0];d[i]=o}const a=Symbol("indexesPathReversed"),g=Symbol("fieldType"),S=Symbol("isSchemaLeaf");class h extends Error{constructor(){super("Invalid schema. Make sure there are no duplicate indexes, and that nested objects are also wrapped with withIndex."),this.name="InvalidSchemaError"}}function y(e){return b(e,e,[],0),e}function b(e,t,o,s){for(const[d,i]of Object.entries(t)){const n=i;f(n)?(p(n,o,s),n.get=l=>r(l,n),n.set=(l,O)=>u(l,n,O)):b(e,n,o,s+1)}}function p(e,t,o){if(t.some(i=>i.length===e[a].length&&i.every((n,l)=>n===e[a][l])))throw new h;if(t.push(e[a]),e[a].length!==o+1)throw new h}function x(e){return t=>t?(v(t,e),t):{[a]:[e],[g]:void 0,[S]:!0}}function f(e){return Object.hasOwn(e,S)}function v(e,t){for(const[o,s]of Object.entries(e)){const d=s;f(d)?d[a].push(t):v(d,t)}}function I(e,t){const o={};for(const[s,d]of Object.entries(t)){const i=d;let n;f(i)?n=r(e,i):n=I(e,i),o[s]=n}return o}function j(e,t){const o=[];return m(o,e,t),o}function m(e,t,o){for(const[s,d]of Object.entries(o)){const i=d,n=t[s];f(i)?u(e,i,n):m(e,n,i)}}c.InvalidSchemaError=h,c.buildSchema=y,c.get=r,c.set=u,c.toIndexedKeysMessage=j,c.toPlainObject=I,c.withIndex=x,Object.defineProperty(c,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schemind",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Read and write to messages serialized as arrays (indexed keys) by defining a schema, \nenabling smaller message size when using protocols such as msgpack or JSON.",
   "keywords": [
     "serialization",
@@ -17,7 +17,7 @@
   "homepage": "https://github.com/kpietraszko/schemind",
   "repository": {
     "type": "git",
-    "url": "git:kpietraszko/schemind"
+    "url": "git+https://github.com/kpietraszko/schemind.git"
   },
   "type": "module",
   "exports": {
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.10.3",
     "camelcase": "^8.0.0",
     "changelogen": "^0.5.7",
     "husky": "^9.1.7",