@xyo-network/payload-mongodb 4.0.3 → 4.1.0

package/dist/node/index.d.ts

@@ -0,0 +1,34 @@
+import { StorageMeta, Payload, WithStorageMeta } from '@xyo-network/payload-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+
+interface PayloadMongoMeta extends StorageMeta {
+    __archive?: string;
+    __client?: string;
+    __observeDuration?: number;
+    __schemaValid?: boolean;
+    __sources?: Payload[];
+    __timestamp: number;
+    __user_agent?: string;
+}
+
+type PayloadWithMongoMeta<T extends Payload = Payload> = T & PayloadMongoMeta;
+type PayloadWithPartialMongoMeta<T extends Payload = Payload> = T & Partial<PayloadMongoMeta>;
+
+type BoundWitnessMongoMeta<P extends Payload = Payload> = PayloadWithMongoMeta<P & {
+    __source_ip?: string;
+    __user_agent?: string;
+}>;
+
+type BoundWitnessWithMongoMeta<T extends BoundWitness = BoundWitness, P extends PayloadWithPartialMongoMeta<T> = PayloadWithPartialMongoMeta<T>> = T & BoundWitnessMongoMeta<P>;
+type BoundWitnessWithPartialMongoMeta<T extends BoundWitness = BoundWitness, P extends PayloadWithPartialMongoMeta<T> = PayloadWithPartialMongoMeta<T>> = T & Partial<BoundWitnessMongoMeta<P>>;
+
+declare const payloadFromDbRepresentation: <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>) => WithStorageMeta<T>;
+declare const boundWitnessFromDbRepresentation: <T extends BoundWitness = BoundWitness>(value: BoundWitnessWithMongoMeta<T>) => WithStorageMeta<T>;
+declare const fromDbRepresentation: <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>) => WithStorageMeta<T>;
+
+declare const payloadToDbRepresentation: <T extends Payload>(payload: WithStorageMeta<T>) => PayloadWithMongoMeta<WithStorageMeta<T>>;
+declare const boundWitnessToDbRepresentation: <T extends BoundWitness>(bw: WithStorageMeta<T>) => BoundWitnessMongoMeta<WithStorageMeta<T>>;
+declare const toDbRepresentation: <T extends Payload | BoundWitness>(value: WithStorageMeta<T>) => PayloadWithMongoMeta<WithStorageMeta<T>>;
+
+export { boundWitnessFromDbRepresentation, boundWitnessToDbRepresentation, fromDbRepresentation, payloadFromDbRepresentation, payloadToDbRepresentation, toDbRepresentation };
+export type { BoundWitnessMongoMeta, BoundWitnessWithMongoMeta, BoundWitnessWithPartialMongoMeta, PayloadMongoMeta, PayloadWithMongoMeta, PayloadWithPartialMongoMeta };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-mongodb",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,32 +21,30 @@
   "type": "module",
   "exports": {
     ".": {
-      "browser": {
-        "types": "./dist/types/index.d.ts",
-        "default": "./dist/browser/index.mjs"
-      },
+      "browser": {},
       "node": {
-        "types": "./dist/types/index.d.ts",
+        "types": "./dist/node/index.d.ts",
         "default": "./dist/node/index.mjs"
-      },
-      "types": "./dist/types/index.d.ts",
-      "default": "./dist/node/index.mjs"
+      }
     },
     "./package.json": "./package.json"
   },
   "module": "dist/node/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/node/index.d.ts",
   "dependencies": {
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/payload-builder": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3"
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/object": "^4.13.4",
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/object": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
+  "engines": {
+    "node": ">=16"
+  },
   "publishConfig": {
     "access": "public"
   }

package/xy.config.ts

@@ -0,0 +1,11 @@
+import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    entryMode: 'custom',
+    neutral: {},
+    browser: {},
+    node: { src: { entry: ['index.ts'] } },
+  },
+}
+
+export default config

package/dist/browser/index.mjs

@@ -1,51 +0,0 @@
-// src/Mappings/fromDbRepresentation.ts
-import { isBoundWitness } from "@xyo-network/boundwitness-model";
-import { PayloadBuilder } from "@xyo-network/payload-builder";
-var payloadFromDbRepresentation = (value) => {
-  const clone = structuredClone(value);
-  const metaNormalized = {};
-  for (const key of Object.keys(clone)) {
-    if (key.startsWith("_$")) {
-      metaNormalized[key.slice(1)] = clone[key];
-    } else if (key !== "_id") {
-      metaNormalized[key] = clone[key];
-    }
-  }
-  return PayloadBuilder.omitPrivateStorageMeta(metaNormalized);
-};
-var boundWitnessFromDbRepresentation = (value) => {
-  return payloadFromDbRepresentation(value);
-};
-var fromDbRepresentation = (value) => {
-  return isBoundWitness(value) ? boundWitnessFromDbRepresentation(value) : payloadFromDbRepresentation(value);
-};
-
-// src/Mappings/toDbRepresentation.ts
-import { isBoundWitness as isBoundWitness2 } from "@xyo-network/boundwitness-model";
-var payloadToDbRepresentation = (payload) => {
-  const clone = structuredClone(payload);
-  const metaNormalized = {};
-  for (const key of Object.keys(clone)) {
-    if (key.startsWith("$")) {
-      metaNormalized[`_${key}`] = clone[key];
-    } else {
-      metaNormalized[key] = clone[key];
-    }
-  }
-  return metaNormalized;
-};
-var boundWitnessToDbRepresentation = (bw) => {
-  return payloadToDbRepresentation(bw);
-};
-var toDbRepresentation = (value) => {
-  return isBoundWitness2(value) ? boundWitnessToDbRepresentation(value) : payloadToDbRepresentation(value);
-};
-export {
-  boundWitnessFromDbRepresentation,
-  boundWitnessToDbRepresentation,
-  fromDbRepresentation,
-  payloadFromDbRepresentation,
-  payloadToDbRepresentation,
-  toDbRepresentation
-};
-//# sourceMappingURL=index.mjs.map

package/dist/browser/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/Mappings/fromDbRepresentation.ts","../../src/Mappings/toDbRepresentation.ts"],"sourcesContent":["import type { JsonObject } from '@xylabs/object'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { BoundWitnessWithMongoMeta } from '../BoundWitness/index.ts'\nimport type { PayloadWithMongoMeta } from '../Payload/index.js'\n\nexport const payloadFromDbRepresentation = <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>): WithStorageMeta<T> => {\n  const clone: JsonObject = structuredClone(value) as unknown as JsonObject\n  const metaNormalized: JsonObject = {}\n  for (const key of Object.keys(clone)) {\n    if (key.startsWith('_$')) {\n      // remove _ from _$ fields\n      metaNormalized[key.slice(1)] = clone[key]\n    } else if (key !== '_id') {\n      // special case for _id, which is reserved by MongoDB\n      metaNormalized[key] = clone[key]\n    }\n  }\n  return PayloadBuilder.omitPrivateStorageMeta(metaNormalized as Payload) as WithStorageMeta<T>\n}\n\nexport const boundWitnessFromDbRepresentation = <T extends BoundWitness = BoundWitness>(value: BoundWitnessWithMongoMeta<T>): WithStorageMeta<T> => {\n  return payloadFromDbRepresentation(value)\n}\n\nexport const fromDbRepresentation = <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>): WithStorageMeta<T> => {\n  return isBoundWitness(value)\n    ? (boundWitnessFromDbRepresentation(value))\n    : (payloadFromDbRepresentation(value))\n}\n","import type { JsonObject } from '@xylabs/object'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport type { Payload, WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { BoundWitnessMongoMeta } from '../BoundWitness/index.js'\nimport type { PayloadWithMongoMeta } from '../Payload/index.js'\n\nexport const payloadToDbRepresentation = <T extends Payload>(payload: WithStorageMeta<T>): PayloadWithMongoMeta<WithStorageMeta<T>> => {\n  const clone: JsonObject = structuredClone(payload) as unknown as JsonObject\n  const metaNormalized: JsonObject = {}\n  for (const key of Object.keys(clone)) {\n    if (key.startsWith('$')) {\n      metaNormalized[`_${key}`] = clone[key]\n    } else {\n      metaNormalized[key] = clone[key]\n    }\n  }\n  return (metaNormalized as unknown as PayloadWithMongoMeta<T>)\n}\n\nexport const boundWitnessToDbRepresentation = <T extends BoundWitness>(bw: WithStorageMeta<T>): BoundWitnessMongoMeta<WithStorageMeta<T>> => {\n  return payloadToDbRepresentation(bw) as BoundWitnessMongoMeta<WithStorageMeta<T>>\n}\n\nexport const toDbRepresentation = <T extends Payload | BoundWitness>(value: WithStorageMeta<T>) => {\n  return isBoundWitness(value) ? boundWitnessToDbRepresentation(value) : payloadToDbRepresentation(value)\n}\n"],"mappings":";AAEA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAMxB,IAAM,8BAA8B,CAA8B,UAAuD;AAC9H,QAAM,QAAoB,gBAAgB,KAAK;AAC/C,QAAM,iBAA6B,CAAC;AACpC,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,IAAI,WAAW,IAAI,GAAG;AAExB,qBAAe,IAAI,MAAM,CAAC,CAAC,IAAI,MAAM,GAAG;AAAA,IAC1C,WAAW,QAAQ,OAAO;AAExB,qBAAe,GAAG,IAAI,MAAM,GAAG;AAAA,IACjC;AAAA,EACF;AACA,SAAO,eAAe,uBAAuB,cAAyB;AACxE;AAEO,IAAM,mCAAmC,CAAwC,UAA4D;AAClJ,SAAO,4BAA4B,KAAK;AAC1C;AAEO,IAAM,uBAAuB,CAA8B,UAAuD;AACvH,SAAO,eAAe,KAAK,IACtB,iCAAiC,KAAK,IACtC,4BAA4B,KAAK;AACxC;;;AC9BA,SAAS,kBAAAA,uBAAsB;AAMxB,IAAM,4BAA4B,CAAoB,YAA0E;AACrI,QAAM,QAAoB,gBAAgB,OAAO;AACjD,QAAM,iBAA6B,CAAC;AACpC,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,IAAI,WAAW,GAAG,GAAG;AACvB,qBAAe,IAAI,GAAG,EAAE,IAAI,MAAM,GAAG;AAAA,IACvC,OAAO;AACL,qBAAe,GAAG,IAAI,MAAM,GAAG;AAAA,IACjC;AAAA,EACF;AACA,SAAQ;AACV;AAEO,IAAM,iCAAiC,CAAyB,OAAsE;AAC3I,SAAO,0BAA0B,EAAE;AACrC;AAEO,IAAM,qBAAqB,CAAmC,UAA8B;AACjG,SAAOA,gBAAe,KAAK,IAAI,+BAA+B,KAAK,IAAI,0BAA0B,KAAK;AACxG;","names":["isBoundWitness"]}

package/dist/neutral/index.mjs

@@ -1,51 +0,0 @@
-// src/Mappings/fromDbRepresentation.ts
-import { isBoundWitness } from "@xyo-network/boundwitness-model";
-import { PayloadBuilder } from "@xyo-network/payload-builder";
-var payloadFromDbRepresentation = (value) => {
-  const clone = structuredClone(value);
-  const metaNormalized = {};
-  for (const key of Object.keys(clone)) {
-    if (key.startsWith("_$")) {
-      metaNormalized[key.slice(1)] = clone[key];
-    } else if (key !== "_id") {
-      metaNormalized[key] = clone[key];
-    }
-  }
-  return PayloadBuilder.omitPrivateStorageMeta(metaNormalized);
-};
-var boundWitnessFromDbRepresentation = (value) => {
-  return payloadFromDbRepresentation(value);
-};
-var fromDbRepresentation = (value) => {
-  return isBoundWitness(value) ? boundWitnessFromDbRepresentation(value) : payloadFromDbRepresentation(value);
-};
-
-// src/Mappings/toDbRepresentation.ts
-import { isBoundWitness as isBoundWitness2 } from "@xyo-network/boundwitness-model";
-var payloadToDbRepresentation = (payload) => {
-  const clone = structuredClone(payload);
-  const metaNormalized = {};
-  for (const key of Object.keys(clone)) {
-    if (key.startsWith("$")) {
-      metaNormalized[`_${key}`] = clone[key];
-    } else {
-      metaNormalized[key] = clone[key];
-    }
-  }
-  return metaNormalized;
-};
-var boundWitnessToDbRepresentation = (bw) => {
-  return payloadToDbRepresentation(bw);
-};
-var toDbRepresentation = (value) => {
-  return isBoundWitness2(value) ? boundWitnessToDbRepresentation(value) : payloadToDbRepresentation(value);
-};
-export {
-  boundWitnessFromDbRepresentation,
-  boundWitnessToDbRepresentation,
-  fromDbRepresentation,
-  payloadFromDbRepresentation,
-  payloadToDbRepresentation,
-  toDbRepresentation
-};
-//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/Mappings/fromDbRepresentation.ts","../../src/Mappings/toDbRepresentation.ts"],"sourcesContent":["import type { JsonObject } from '@xylabs/object'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { BoundWitnessWithMongoMeta } from '../BoundWitness/index.ts'\nimport type { PayloadWithMongoMeta } from '../Payload/index.js'\n\nexport const payloadFromDbRepresentation = <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>): WithStorageMeta<T> => {\n  const clone: JsonObject = structuredClone(value) as unknown as JsonObject\n  const metaNormalized: JsonObject = {}\n  for (const key of Object.keys(clone)) {\n    if (key.startsWith('_$')) {\n      // remove _ from _$ fields\n      metaNormalized[key.slice(1)] = clone[key]\n    } else if (key !== '_id') {\n      // special case for _id, which is reserved by MongoDB\n      metaNormalized[key] = clone[key]\n    }\n  }\n  return PayloadBuilder.omitPrivateStorageMeta(metaNormalized as Payload) as WithStorageMeta<T>\n}\n\nexport const boundWitnessFromDbRepresentation = <T extends BoundWitness = BoundWitness>(value: BoundWitnessWithMongoMeta<T>): WithStorageMeta<T> => {\n  return payloadFromDbRepresentation(value)\n}\n\nexport const fromDbRepresentation = <T extends Payload = Payload>(value: PayloadWithMongoMeta<T>): WithStorageMeta<T> => {\n  return isBoundWitness(value)\n    ? (boundWitnessFromDbRepresentation(value))\n    : (payloadFromDbRepresentation(value))\n}\n","import type { JsonObject } from '@xylabs/object'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitness } from '@xyo-network/boundwitness-model'\nimport type { Payload, WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { BoundWitnessMongoMeta } from '../BoundWitness/index.js'\nimport type { PayloadWithMongoMeta } from '../Payload/index.js'\n\nexport const payloadToDbRepresentation = <T extends Payload>(payload: WithStorageMeta<T>): PayloadWithMongoMeta<WithStorageMeta<T>> => {\n  const clone: JsonObject = structuredClone(payload) as unknown as JsonObject\n  const metaNormalized: JsonObject = {}\n  for (const key of Object.keys(clone)) {\n    if (key.startsWith('$')) {\n      metaNormalized[`_${key}`] = clone[key]\n    } else {\n      metaNormalized[key] = clone[key]\n    }\n  }\n  return (metaNormalized as unknown as PayloadWithMongoMeta<T>)\n}\n\nexport const boundWitnessToDbRepresentation = <T extends BoundWitness>(bw: WithStorageMeta<T>): BoundWitnessMongoMeta<WithStorageMeta<T>> => {\n  return payloadToDbRepresentation(bw) as BoundWitnessMongoMeta<WithStorageMeta<T>>\n}\n\nexport const toDbRepresentation = <T extends Payload | BoundWitness>(value: WithStorageMeta<T>) => {\n  return isBoundWitness(value) ? boundWitnessToDbRepresentation(value) : payloadToDbRepresentation(value)\n}\n"],"mappings":";AAEA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAMxB,IAAM,8BAA8B,CAA8B,UAAuD;AAC9H,QAAM,QAAoB,gBAAgB,KAAK;AAC/C,QAAM,iBAA6B,CAAC;AACpC,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,IAAI,WAAW,IAAI,GAAG;AAExB,qBAAe,IAAI,MAAM,CAAC,CAAC,IAAI,MAAM,GAAG;AAAA,IAC1C,WAAW,QAAQ,OAAO;AAExB,qBAAe,GAAG,IAAI,MAAM,GAAG;AAAA,IACjC;AAAA,EACF;AACA,SAAO,eAAe,uBAAuB,cAAyB;AACxE;AAEO,IAAM,mCAAmC,CAAwC,UAA4D;AAClJ,SAAO,4BAA4B,KAAK;AAC1C;AAEO,IAAM,uBAAuB,CAA8B,UAAuD;AACvH,SAAO,eAAe,KAAK,IACtB,iCAAiC,KAAK,IACtC,4BAA4B,KAAK;AACxC;;;AC9BA,SAAS,kBAAAA,uBAAsB;AAMxB,IAAM,4BAA4B,CAAoB,YAA0E;AACrI,QAAM,QAAoB,gBAAgB,OAAO;AACjD,QAAM,iBAA6B,CAAC;AACpC,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,IAAI,WAAW,GAAG,GAAG;AACvB,qBAAe,IAAI,GAAG,EAAE,IAAI,MAAM,GAAG;AAAA,IACvC,OAAO;AACL,qBAAe,GAAG,IAAI,MAAM,GAAG;AAAA,IACjC;AAAA,EACF;AACA,SAAQ;AACV;AAEO,IAAM,iCAAiC,CAAyB,OAAsE;AAC3I,SAAO,0BAA0B,EAAE;AACrC;AAEO,IAAM,qBAAqB,CAAmC,UAA8B;AACjG,SAAOA,gBAAe,KAAK,IAAI,+BAA+B,KAAK,IAAI,0BAA0B,KAAK;AACxG;","names":["isBoundWitness"]}