schemind 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) kpietraszko
+
+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,28 @@
+![NPM Version](https://img.shields.io/npm/v/schemind)
+![Code Coverage](https://raw.githubusercontent.com/kpietraszko/schemind/refs/heads/main/badge.svg)
+
+# schemind
+Read and write to messages serialized as arrays (aka indexed keys) by defining a schema.
+
+## What?
+TODO
+
+## Installation
+
+```shell
+npm install schemind
+```
+
+## Usage
+TODO
+
+## FAQ 
+TODO
+
+## Related work
+* https://github.com/MessagePack-CSharp/MessagePack-CSharp#use-indexed-keys-instead-of-string-keys-contractless
+* https://aarnott.github.io/Nerdbank.MessagePack/docs/customizing-serialization.html?q=indexed#serialize-objects-with-indexes-for-keys
+
+
+* https://github.com/Idein/msgpack-schema
+* https://github.com/serde-rs/serde/issues/959

package/dist/schemind.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function h(e){return t=>t?(c(t,e),t):{indexesPathReversed:[e],fieldType:void 0}}function i(e){return Object.hasOwn(e,"fieldType")}function c(e,t){if(!i(e))for(const[o,s]of Object.entries(e)){const n=s;i(n)?n.indexesPathReversed.push(t):c(n,t)}}function f(e,t){const o=t.indexesPathReversed;let s=e;for(let r=t.indexesPathReversed.length-1;r>=1;r--)s=s[o[r]];const n=o[0];return s[n]}function a(e,t,o){const s=t.indexesPathReversed;let n=e;for(let d=t.indexesPathReversed.length-1;d>=1;d--)n[s[d]]===void 0&&(n[s[d]]=[]),n=n[s[d]];const r=s[0];n[r]=o}function l(e,t){const o={};for(const[s,n]of Object.entries(t)){const r=n;let d;i(r)?d=f(e,r):d=l(e,r),o[s]=d}return o}function x(e,t){const o=[];return u(o,e,t),o}function u(e,t,o){for(const[s,n]of Object.entries(o)){const r=n,d=t[s];i(r)?a(e,r,d):u(e,d,r)}}exports.get=f;exports.set=a;exports.toIndexedKeysMessage=x;exports.toPlainObject=l;exports.withIndex=h;

package/dist/schemind.d.ts

@@ -0,0 +1,28 @@
+import { NonNegativeInteger } from 'type-fest';
+
+export declare function get<const TField>(message: readonly unknown[], schemaField: SchemaLeaf<TField>): TField;
+
+declare type IndexedKeysMessageSchema<TSchema> = {
+    [K in keyof TSchema]: TSchema[K] extends SchemaLeaf<infer TField> ? SchemaLeaf<TField> : IndexedKeysMessageSchema<TSchema[K]>;
+};
+
+declare type PlainObjectOfSchema<TSchema> = TSchema extends IndexedKeysMessageSchema<unknown> ? {
+    [K in keyof TSchema]: TSchema[K] extends SchemaLeaf<infer TField> ? TField : PlainObjectOfSchema<TSchema[K]>;
+} : never;
+
+declare type ReturnedSchemaNode<TField, TNestedSchema> = TNestedSchema extends undefined ? SchemaLeaf<TField> : TNestedSchema;
+
+declare type SchemaLeaf<TField> = {
+    indexesPathReversed: number[];
+    fieldType: TField;
+};
+
+export declare function set<const TField>(targetMessage: unknown[], schemaField: SchemaLeaf<TField>, value: TField): void;
+
+export declare function toIndexedKeysMessage<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(plainObject: PlainObjectOfSchema<TSchema>, schema: TSchema): unknown[];
+
+export declare function toPlainObject<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(message: readonly unknown[], schema: TSchema): PlainObjectOfSchema<TSchema>;
+
+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>;
+
+export { }

package/dist/schemind.iife.js

@@ -0,0 +1 @@
+var Schemind=function(i){"use strict";function v(e){return t=>t?(f(t,e),t):{indexesPathReversed:[e],fieldType:void 0}}function c(e){return Object.hasOwn(e,"fieldType")}function f(e,t){if(!c(e))for(const[d,s]of Object.entries(e)){const n=s;c(n)?n.indexesPathReversed.push(t):f(n,t)}}function a(e,t){const d=t.indexesPathReversed;let s=e;for(let o=t.indexesPathReversed.length-1;o>=1;o--)s=s[d[o]];const n=d[0];return s[n]}function u(e,t,d){const s=t.indexesPathReversed;let n=e;for(let r=t.indexesPathReversed.length-1;r>=1;r--)n[s[r]]===void 0&&(n[s[r]]=[]),n=n[s[r]];const o=s[0];n[o]=d}function l(e,t){const d={};for(const[s,n]of Object.entries(t)){const o=n;let r;c(o)?r=a(e,o):r=l(e,o),d[s]=r}return d}function I(e,t){const d=[];return h(d,e,t),d}function h(e,t,d){for(const[s,n]of Object.entries(d)){const o=n,r=t[s];c(o)?u(e,o,r):h(e,r,o)}}return i.get=a,i.set=u,i.toIndexedKeysMessage=I,i.toPlainObject=l,i.withIndex=v,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"}),i}({});

package/dist/schemind.js

@@ -0,0 +1,58 @@
+function h(e) {
+  return (t) => t ? (c(t, e), t) : {
+    indexesPathReversed: [e],
+    fieldType: void 0
+  };
+}
+function i(e) {
+  return Object.hasOwn(e, "fieldType");
+}
+function c(e, t) {
+  if (!i(e))
+    for (const [o, s] of Object.entries(e)) {
+      const n = s;
+      i(n) ? n.indexesPathReversed.push(t) : c(n, t);
+    }
+}
+function a(e, t) {
+  const o = t.indexesPathReversed;
+  let s = e;
+  for (let r = t.indexesPathReversed.length - 1; r >= 1; r--)
+    s = s[o[r]];
+  const n = o[0];
+  return s[n];
+}
+function l(e, t, o) {
+  const s = t.indexesPathReversed;
+  let n = e;
+  for (let d = t.indexesPathReversed.length - 1; d >= 1; d--)
+    n[s[d]] === void 0 && (n[s[d]] = []), n = n[s[d]];
+  const r = s[0];
+  n[r] = o;
+}
+function u(e, t) {
+  const o = {};
+  for (const [s, n] of Object.entries(t)) {
+    const r = n;
+    let d;
+    i(r) ? d = a(e, r) : d = u(e, r), o[s] = d;
+  }
+  return o;
+}
+function x(e, t) {
+  const o = [];
+  return f(o, e, t), o;
+}
+function f(e, t, o) {
+  for (const [s, n] of Object.entries(o)) {
+    const r = n, d = t[s];
+    i(r) ? l(e, r, d) : f(e, d, r);
+  }
+}
+export {
+  a as get,
+  l as set,
+  x as toIndexedKeysMessage,
+  u as toPlainObject,
+  h as withIndex
+};

package/dist/schemind.umd.cjs

@@ -0,0 +1 @@
+(function(f,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(f=typeof globalThis<"u"?globalThis:f||self,r(f.Schemind={}))})(this,function(f){"use strict";function r(e){return t=>t?(u(t,e),t):{indexesPathReversed:[e],fieldType:void 0}}function c(e){return Object.hasOwn(e,"fieldType")}function u(e,t){if(!c(e))for(const[o,s]of Object.entries(e)){const n=s;c(n)?n.indexesPathReversed.push(t):u(n,t)}}function a(e,t){const o=t.indexesPathReversed;let s=e;for(let d=t.indexesPathReversed.length-1;d>=1;d--)s=s[o[d]];const n=o[0];return s[n]}function l(e,t,o){const s=t.indexesPathReversed;let n=e;for(let i=t.indexesPathReversed.length-1;i>=1;i--)n[s[i]]===void 0&&(n[s[i]]=[]),n=n[s[i]];const d=s[0];n[d]=o}function h(e,t){const o={};for(const[s,n]of Object.entries(t)){const d=n;let i;c(d)?i=a(e,d):i=h(e,d),o[s]=i}return o}function x(e,t){const o=[];return v(o,e,t),o}function v(e,t,o){for(const[s,n]of Object.entries(o)){const d=n,i=t[s];c(d)?l(e,d,i):v(e,i,d)}}f.get=a,f.set=l,f.toIndexedKeysMessage=x,f.toPlainObject=h,f.withIndex=r,Object.defineProperty(f,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "schemind",
+  "version": "0.0.2",
+  "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",
+    "schema",
+    "index",
+    "indexed keys",
+    "array",
+    "msgpack",
+    "pack",
+    "packed"
+  ],
+  "license": "MIT",
+  "author": "kpietraszko",
+  "homepage": "https://github.com/kpietraszko/schemind",
+  "repository": {
+    "type": "git",
+    "url": "git:kpietraszko/schemind"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/schemind.js",
+      "require": "./dist/schemind.cjs"
+    }
+  },
+  "main": "./dist/schemind.cjs",
+  "module": "./dist/schemind.js",
+  "types": "./dist/schemind.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "type-fest": "^4.30.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@types/node": "^22.10.1",
+    "camelcase": "^8.0.0",
+    "changelogen": "^0.5.7",
+    "husky": "^9.1.7",
+    "typescript": "~5.7.2",
+    "vite": "^6.0.3",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "2.1.8",
+    "@vitest/coverage-v8": "2.1.8"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "release": "pnpm test && pnpm build && changelogen --release --push && pnpm publish",
+    "test": "vitest --run --typecheck",
+    "test:watch": "vitest",
+    "test:coverage": "vitest --run --typecheck --coverage"
+  }
+}