@xyo-network/witness 2.22.20

package/dist/esm/Witness/QueryWitness.d.ts

@@ -0,0 +1,9 @@
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload';
+import { XyoAbstractWitness } from './Witness';
+export interface XyoQueryWitnessConfig<Q extends XyoQueryPayload = XyoQueryPayload> {
+    query: Q;
+}
+export declare class XyoQueryWitness<T extends XyoPayload, Q extends XyoQueryPayload = XyoQueryPayload, C extends XyoQueryWitnessConfig<Q> = XyoQueryWitnessConfig<Q>> extends XyoAbstractWitness<T, C> {
+    get targetSchema(): string;
+    observe(fields?: Partial<T>): Promise<T>;
+}

package/dist/esm/Witness/QueryWitness.js

@@ -0,0 +1,11 @@
+import { XyoPayloadBuilder } from '@xyo-network/payload';
+import { XyoAbstractWitness } from './Witness';
+export class XyoQueryWitness extends XyoAbstractWitness {
+    get targetSchema() {
+        return this.config?.query.targetSchema ?? 'network.xyo.payload';
+    }
+    observe(fields) {
+        return Promise.resolve(new XyoPayloadBuilder({ schema: this.targetSchema }).fields(fields).build());
+    }
+}
+//# sourceMappingURL=QueryWitness.js.map

package/dist/esm/Witness/QueryWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryWitness.js","sourceRoot":"","sources":["../../../src/Witness/QueryWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,iBAAiB,EAAmB,MAAM,sBAAsB,CAAA;AAErF,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAM9C,MAAM,OAAO,eAIX,SAAQ,kBAAwB;IAChC,IAAa,YAAY;QACvB,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,IAAI,qBAAqB,CAAA;IACjE,CAAC;IAEM,OAAO,CAAC,MAAmB;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,iBAAiB,CAAI,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;IACxG,CAAC;CACF"}

package/dist/esm/Witness/SimpleWitness.d.ts

@@ -0,0 +1,17 @@
+import { XyoPayload } from '@xyo-network/payload';
+import { XyoAbstractWitness, XyoWitness } from './Witness';
+export interface XyoSimpleWitnessConfig<T extends XyoPayload = XyoPayload> {
+    schema: string;
+    template?: XyoPayload;
+    observer?: () => Promise<T> | T;
+}
+export declare class XyoSimpleWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>> extends XyoAbstractWitness<T, C> implements XyoWitness<T> {
+    previousHash?: string;
+    get targetSchema(): string;
+    observe(fields?: Partial<T>): Promise<T>;
+}
+/** @deprecated Use XyoSimpleWitness */
+export declare class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>> extends XyoSimpleWitness<T, C> {
+}
+/** @deprecated Use XyoSimpleWitnessConfig */
+export declare type XyoWitnessConfig<T extends XyoPayload = XyoPayload> = XyoSimpleWitnessConfig<T>;

package/dist/esm/Witness/SimpleWitness.js

@@ -0,0 +1,18 @@
+import { XyoPayloadBuilder } from '@xyo-network/payload';
+import { XyoAbstractWitness } from './Witness';
+export class XyoSimpleWitness extends XyoAbstractWitness {
+    get targetSchema() {
+        return this.config?.schema ?? 'network.xyo.payload';
+    }
+    async observe(fields) {
+        return new XyoPayloadBuilder({ schema: this.targetSchema })
+            .previousHash(this.previousHash)
+            .fields(await this.config?.observer?.())
+            .fields(fields)
+            .build();
+    }
+}
+/** @deprecated Use XyoSimpleWitness */
+export class XyoLegacyWitness extends XyoSimpleWitness {
+}
+//# sourceMappingURL=SimpleWitness.js.map

package/dist/esm/Witness/SimpleWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleWitness.js","sourceRoot":"","sources":["../../../src/Witness/SimpleWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAEpE,OAAO,EAAE,kBAAkB,EAAc,MAAM,WAAW,CAAA;AAQ1D,MAAM,OAAO,gBACX,SAAQ,kBAAwB;IAKhC,IAAa,YAAY;QACvB,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,qBAAqB,CAAA;IACrD,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAmB;QACtC,OAAO,IAAI,iBAAiB,CAAI,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3D,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC;aAC/B,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC;aACvC,MAAM,CAAC,MAAM,CAAC;aACd,KAAK,EAAE,CAAA;IACZ,CAAC;CACF;AAED,uCAAuC;AACvC,MAAM,OAAO,gBAAqH,SAAQ,gBAGzI;CAAG"}

package/dist/esm/Witness/Witness.d.ts

@@ -0,0 +1,17 @@
+import { EmptyObject } from '@xyo-network/core';
+import { WithTimestamp, XyoPayload } from '@xyo-network/payload';
+export interface XyoWitness<T extends XyoPayload = XyoPayload> {
+    targetSchema: string;
+    observe(fields?: Partial<T>): Promise<T>;
+}
+export declare abstract class XyoAbstractWitness<T extends XyoPayload = XyoPayload, C extends EmptyObject = EmptyObject> implements XyoWitness<T> {
+    readonly config?: C;
+    constructor(config?: C);
+    abstract observe(fields?: Partial<T>): Promise<T>;
+    abstract get targetSchema(): string;
+}
+export declare abstract class XyoAbstractTimestampWitness<TTargetPayload extends WithTimestamp<XyoPayload> = WithTimestamp<XyoPayload>, TConfig extends EmptyObject = EmptyObject> extends XyoAbstractWitness<TTargetPayload, TConfig> {
+}
+/** @deprecated use XyoAbstractWitness instead */
+export declare abstract class XyoWitnessBase<T extends XyoPayload = XyoPayload, C extends EmptyObject = EmptyObject> extends XyoAbstractWitness<T, C> {
+}

package/dist/esm/Witness/Witness.js

@@ -0,0 +1,11 @@
+export class XyoAbstractWitness {
+    constructor(config) {
+        this.config = config;
+    }
+}
+export class XyoAbstractTimestampWitness extends XyoAbstractWitness {
+}
+/** @deprecated use XyoAbstractWitness instead */
+export class XyoWitnessBase extends XyoAbstractWitness {
+}
+//# sourceMappingURL=Witness.js.map

package/dist/esm/Witness/Witness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../../src/Witness/Witness.ts"],"names":[],"mappings":"AAQA,MAAM,OAAgB,kBAAkB;IAEtC,YAAY,MAAU;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAGF;AAED,MAAM,OAAgB,2BAGpB,SAAQ,kBAA2C;CAAG;AAExD,iDAAiD;AACjD,MAAM,OAAgB,cAAuF,SAAQ,kBAAwB;CAAG"}

package/dist/esm/Witness/index.d.ts

@@ -0,0 +1,3 @@
+export * from './QueryWitness';
+export * from './SimpleWitness';
+export * from './Witness';

package/dist/esm/Witness/index.js

@@ -0,0 +1,4 @@
+export * from './QueryWitness';
+export * from './SimpleWitness';
+export * from './Witness';
+//# sourceMappingURL=index.js.map

package/dist/esm/Witness/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from './Witness';

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './Witness';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@xyo-network/witness",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/core": "^2.22.20",
+    "@xyo-network/payload": "^2.22.20"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@xylabs/tsconfig": "^2.5.6",
+    "tslib": "^2.4.0"
+  },
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.22.20",
+  "packageManager": "yarn@3.1.1"
+}

package/src/Witness/QueryWitness.ts

@@ -0,0 +1,21 @@
+import { XyoPayload, XyoPayloadBuilder, XyoQueryPayload } from '@xyo-network/payload'
+
+import { XyoAbstractWitness } from './Witness'
+
+export interface XyoQueryWitnessConfig<Q extends XyoQueryPayload = XyoQueryPayload> {
+  query: Q
+}
+
+export class XyoQueryWitness<
+  T extends XyoPayload,
+  Q extends XyoQueryPayload = XyoQueryPayload,
+  C extends XyoQueryWitnessConfig<Q> = XyoQueryWitnessConfig<Q>
+> extends XyoAbstractWitness<T, C> {
+  override get targetSchema() {
+    return this.config?.query.targetSchema ?? 'network.xyo.payload'
+  }
+
+  public observe(fields?: Partial<T>): Promise<T> {
+    return Promise.resolve(new XyoPayloadBuilder<T>({ schema: this.targetSchema }).fields(fields).build())
+  }
+}

package/src/Witness/SimpleWitness.ts

@@ -0,0 +1,37 @@
+import { XyoPayload, XyoPayloadBuilder } from '@xyo-network/payload'
+
+import { XyoAbstractWitness, XyoWitness } from './Witness'
+
+export interface XyoSimpleWitnessConfig<T extends XyoPayload = XyoPayload> {
+  schema: string
+  template?: XyoPayload
+  observer?: () => Promise<T> | T
+}
+
+export class XyoSimpleWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>>
+  extends XyoAbstractWitness<T, C>
+  implements XyoWitness<T>
+{
+  public previousHash?: string
+
+  override get targetSchema() {
+    return this.config?.schema ?? 'network.xyo.payload'
+  }
+
+  public async observe(fields?: Partial<T>) {
+    return new XyoPayloadBuilder<T>({ schema: this.targetSchema })
+      .previousHash(this.previousHash)
+      .fields(await this.config?.observer?.())
+      .fields(fields)
+      .build()
+  }
+}
+
+/** @deprecated Use XyoSimpleWitness */
+export class XyoLegacyWitness<T extends XyoPayload = XyoPayload, C extends XyoSimpleWitnessConfig<T> = XyoSimpleWitnessConfig<T>> extends XyoSimpleWitness<
+  T,
+  C
+> {}
+
+/** @deprecated Use XyoSimpleWitnessConfig */
+export type XyoWitnessConfig<T extends XyoPayload = XyoPayload> = XyoSimpleWitnessConfig<T>

package/src/Witness/Witness.spec.ts

@@ -0,0 +1,13 @@
+import { XyoSimpleWitness } from './SimpleWitness'
+
+describe('XyoWitness', () => {
+  test('valid-instantiation', () => {
+    const template = {
+      schema: 'network.xyo.foo',
+    }
+    const witness = new XyoSimpleWitness({ schema: 'network.xyo.payload', template })
+    expect(witness).toBeTruthy()
+    expect(witness.config?.schema).toBe('network.xyo.payload')
+    expect(witness.config?.template).toBe(template)
+  })
+})

package/src/Witness/Witness.ts

@@ -0,0 +1,24 @@
+import { EmptyObject } from '@xyo-network/core'
+import { WithTimestamp, XyoPayload } from '@xyo-network/payload'
+
+export interface XyoWitness<T extends XyoPayload = XyoPayload> {
+  targetSchema: string
+  observe(fields?: Partial<T>): Promise<T>
+}
+
+export abstract class XyoAbstractWitness<T extends XyoPayload = XyoPayload, C extends EmptyObject = EmptyObject> implements XyoWitness<T> {
+  public readonly config?: C
+  constructor(config?: C) {
+    this.config = config
+  }
+  abstract observe(fields?: Partial<T>): Promise<T>
+  abstract get targetSchema(): string
+}
+
+export abstract class XyoAbstractTimestampWitness<
+  TTargetPayload extends WithTimestamp<XyoPayload> = WithTimestamp<XyoPayload>,
+  TConfig extends EmptyObject = EmptyObject
+> extends XyoAbstractWitness<TTargetPayload, TConfig> {}
+
+/** @deprecated use XyoAbstractWitness instead */
+export abstract class XyoWitnessBase<T extends XyoPayload = XyoPayload, C extends EmptyObject = EmptyObject> extends XyoAbstractWitness<T, C> {}

package/src/Witness/index.ts

@@ -0,0 +1,3 @@
+export * from './QueryWitness'
+export * from './SimpleWitness'
+export * from './Witness'

package/src/index.ts

@@ -0,0 +1 @@
+export * from './Witness'