@xyo-network/node 0.3.1 → 2.26.1

package/dist/esm/Abstract.d.ts

@@ -0,0 +1,20 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness';
+import { XyoModule } from '@xyo-network/module';
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload';
+import { Promisable } from '@xyo-network/promisable';
+import { XyoNode } from './Node';
+export declare abstract class XyoAbstractNode implements XyoNode {
+    attach(module: XyoModule<XyoQueryPayload<XyoPayload<{
+        schema: string;
+    }>>>): void;
+    remove(address: string): void;
+    get<T extends XyoModule<XyoQueryPayload<XyoPayload<{
+        schema: string;
+    }>>>>(address: string): T | undefined;
+    query(query: XyoQueryPayload<XyoPayload<{
+        schema: string;
+    }>>): Promisable<[XyoBoundWitness, XyoPayload<{
+        schema: string;
+    }>[]]>;
+}
+//# sourceMappingURL=Abstract.d.ts.map

package/dist/esm/Abstract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Abstract.d.ts","sourceRoot":"","sources":["../../src/Abstract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEhC,8BAAsB,eAAgB,YAAW,OAAO;IACtD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC,GAAG,IAAI;IAGhF,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAG7B,GAAG,CAAC,CAAC,SAAS,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAGzG,KAAK,CAAC,KAAK,EAAE,eAAe,CAAC,UAAU,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC,CAAC;CAG/H"}

package/dist/esm/Abstract.js

@@ -0,0 +1,15 @@
+export class XyoAbstractNode {
+    attach(module) {
+        throw new Error('Method not implemented.');
+    }
+    remove(address) {
+        throw new Error('Method not implemented.');
+    }
+    get(address) {
+        throw new Error('Method not implemented.');
+    }
+    query(query) {
+        throw new Error('Method not implemented.');
+    }
+}
+//# sourceMappingURL=Abstract.js.map

package/dist/esm/Abstract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Abstract.js","sourceRoot":"","sources":["../../src/Abstract.ts"],"names":[],"mappings":"AAQA,MAAM,OAAgB,eAAe;IACnC,MAAM,CAAC,MAAkE;QACvE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC5C,CAAC;IACD,MAAM,CAAC,OAAe;QACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC5C,CAAC;IACD,GAAG,CAAuE,OAAe;QACvF,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC5C,CAAC;IACD,KAAK,CAAC,KAAsD;QAC1D,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC5C,CAAC;CACF"}

package/dist/esm/Node.d.ts

@@ -0,0 +1,11 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness';
+import { XyoModule } from '@xyo-network/module';
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload';
+import { Promisable } from '@xyo-network/promisable';
+export interface XyoNode {
+    attach(module: XyoModule): void;
+    remove(address: string): void;
+    get<T extends XyoModule>(address: string): T | undefined;
+    query(query: XyoQueryPayload): Promisable<[XyoBoundWitness, XyoPayload[]]>;
+}
+//# sourceMappingURL=Node.d.ts.map

package/dist/esm/Node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Node.d.ts","sourceRoot":"","sources":["../../src/Node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAA;IAC/B,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAA;IACxD,KAAK,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,CAAC,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC,CAAA;CAC3E"}

package/dist/esm/Node.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Node.js.map

package/dist/esm/Node.js.map

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

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Abstract';
+export * from './Node';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export * from './Abstract';
+export * from './Node';
+//# 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,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA"}

package/package.json

@@ -1,23 +1,56 @@
 {
   "name": "@xyo-network/node",
-  "version": "0.3.1",
-  "description": "Implements a node life-cycle loop that can be used / extended to manage how a node in the XYO network behaves in different scenarios.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "author": "Ryan Pillsbury",
-  "license": "MIT",
+  "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/base": "^0.3.1",
-    "@xyo-network/peer-connections": "^0.3.1"
+    "@xyo-network/boundwitness": "^2.26.1",
+    "@xyo-network/module": "^2.26.1",
+    "@xyo-network/payload": "^2.26.1",
+    "@xyo-network/promisable": "^2.26.1",
+    "tslib": "^2.4.0"
   },
+  "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@types/jest": "^23.3.1",
-    "@types/node": "^10.7.1",
-    "jest": "^23.6.0",
-    "ts-jest": "^23.1.3",
-    "ts-node": "^7.0.1",
-    "tslint": "^5.11.0",
-    "typescript": "^3.1.6"
+    "@xylabs/tsconfig": "^2.5.118"
+  },
+  "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"
   },
-  "gitHead": "4d825837b6d6aef1ecded5fd7d6d3ca190c423ae"
-}
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.26.1"
+}

package/src/Abstract.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoModule } from '@xyo-network/module'
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload'
+import { Promisable } from '@xyo-network/promisable'
+
+import { XyoNode } from './Node'
+
+export abstract class XyoAbstractNode implements XyoNode {
+  attach(module: XyoModule<XyoQueryPayload<XyoPayload<{ schema: string }>>>): void {
+    throw new Error('Method not implemented.')
+  }
+  remove(address: string): void {
+    throw new Error('Method not implemented.')
+  }
+  get<T extends XyoModule<XyoQueryPayload<XyoPayload<{ schema: string }>>>>(address: string): T | undefined {
+    throw new Error('Method not implemented.')
+  }
+  query(query: XyoQueryPayload<XyoPayload<{ schema: string }>>): Promisable<[XyoBoundWitness, XyoPayload<{ schema: string }>[]]> {
+    throw new Error('Method not implemented.')
+  }
+}

package/src/Node.ts

@@ -0,0 +1,11 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoModule } from '@xyo-network/module'
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload'
+import { Promisable } from '@xyo-network/promisable'
+
+export interface XyoNode {
+  attach(module: XyoModule): void
+  remove(address: string): void
+  get<T extends XyoModule>(address: string): T | undefined
+  query(query: XyoQueryPayload): Promisable<[XyoBoundWitness, XyoPayload[]]>
+}

package/src/index.ts

@@ -1,12 +1,2 @@
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 20th November 2018 10:42:26 am
- * @Email:  developer@xyfindables.com
- * @Filename: index.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Tuesday, 11th December 2018 9:48:30 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-
-export { XyoNode } from './xyo-node'
+export * from './Abstract'
+export * from './Node'

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export { XyoNode } from './xyo-node';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -1,15 +0,0 @@
-"use strict";
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 20th November 2018 10:42:26 am
- * @Email:  developer@xyfindables.com
- * @Filename: index.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Tuesday, 11th December 2018 9:48:30 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-var xyo_node_1 = require("./xyo-node");
-exports.XyoNode = xyo_node_1.XyoNode;
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;AAEH,uCAAoC;AAA3B,6BAAA,OAAO,CAAA"}

package/dist/xyo-node.d.ts

@@ -1,30 +0,0 @@
-import { IXyoPeerConnectionDelegate } from '@xyo-network/peer-connections';
-import { XyoBase } from '@xyo-network/base';
-/**
- * An XyoNode represents a node in the xyo-network system.
- * A node can communicate with other nodes, in general, through
- * bound-witness interactions. What differentiates a sentinel
- * from a bridge from an archivist is their role in the system
- * and what their prerogative is at any given time.
- */
-export declare class XyoNode extends XyoBase {
-    private readonly peerConnectionDelegate;
-    /** Some instance variables for managing the xyo-node loop */
-    private isLooping;
-    private shouldStopLooping;
-    constructor(peerConnectionDelegate: IXyoPeerConnectionDelegate);
-    /**
-     * Calling start will place the xyo-node in loop mode
-     */
-    start(): void;
-    /**
-     * Calling stop will remove the xyo-node from loop mode
-     */
-    stop(): Promise<void>;
-    /**
-     * Defines an xyo-node's in loop. Once an iteration of the loop is completed it will
-     * scheduled immediately for another iteration of the loop unless `stop` is called.
-     */
-    private loop;
-}
-//# sourceMappingURL=xyo-node.d.ts.map

package/dist/xyo-node.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"xyo-node.d.ts","sourceRoot":"","sources":["../src/xyo-node.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C;;;;;;GAMG;AAEH,qBAAa,OAAQ,SAAQ,OAAO;IAMtB,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAJnD,6DAA6D;IAC7D,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,iBAAiB,CAAQ;gBAEJ,sBAAsB,EAAE,0BAA0B;IAI/E;;OAEG;IACI,KAAK;IAIZ;;OAEG;IAEI,IAAI;IAKX;;;OAGG;YAEW,IAAI;CAcnB"}

package/dist/xyo-node.js

@@ -1,71 +0,0 @@
-"use strict";
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 20th November 2018 10:44:20 am
- * @Email:  developer@xyfindables.com
- * @Filename: xyo-node.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Friday, 7th December 2018 11:45:18 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("@xyo-network/base");
-/**
- * An XyoNode represents a node in the xyo-network system.
- * A node can communicate with other nodes, in general, through
- * bound-witness interactions. What differentiates a sentinel
- * from a bridge from an archivist is their role in the system
- * and what their prerogative is at any given time.
- */
-class XyoNode extends base_1.XyoBase {
-    constructor(peerConnectionDelegate) {
-        super();
-        this.peerConnectionDelegate = peerConnectionDelegate;
-        /** Some instance variables for managing the xyo-node loop */
-        this.isLooping = false;
-        this.shouldStopLooping = false;
-    }
-    /**
-     * Calling start will place the xyo-node in loop mode
-     */
-    start() {
-        this.loop();
-    }
-    /**
-     * Calling stop will remove the xyo-node from loop mode
-     */
-    stop() {
-        this.shouldStopLooping = true;
-        return this.peerConnectionDelegate.stopProvidingConnections();
-    }
-    /**
-     * Defines an xyo-node's in loop. Once an iteration of the loop is completed it will
-     * scheduled immediately for another iteration of the loop unless `stop` is called.
-     */
-    loop() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.isLooping && this.shouldStopLooping) {
-                return;
-            }
-            try {
-                const networkPipe = yield this.peerConnectionDelegate.provideConnection();
-                yield this.peerConnectionDelegate.handlePeerConnection(networkPipe);
-            }
-            catch (err) {
-                this.logError(`There was an uncaught error in the xyo-node loop`, err);
-            }
-            setImmediate(this.loop.bind(this));
-        });
-    }
-}
-exports.XyoNode = XyoNode;
-//# sourceMappingURL=xyo-node.js.map

package/dist/xyo-node.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"xyo-node.js","sourceRoot":"","sources":["../src/xyo-node.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;AAGH,4CAA2C;AAE3C;;;;;;GAMG;AAEH,MAAa,OAAQ,SAAQ,cAAO;IAMlC,YAA6B,sBAAkD;QAC7E,KAAK,EAAE,CAAA;QADoB,2BAAsB,GAAtB,sBAAsB,CAA4B;QAJ/E,6DAA6D;QACrD,cAAS,GAAG,KAAK,CAAA;QACjB,sBAAiB,GAAG,KAAK,CAAA;IAIjC,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,EAAE,CAAA;IACb,CAAC;IAED;;OAEG;IAEI,IAAI;QACT,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAA;QAC7B,OAAO,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,EAAE,CAAA;IAC/D,CAAC;IAED;;;OAGG;IAEW,IAAI;;YAChB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC5C,OAAM;aACP;YAED,IAAI;gBACF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,CAAA;gBACzE,MAAM,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAA;aACpE;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,QAAQ,CAAC,kDAAkD,EAAE,GAAG,CAAC,CAAA;aACvE;YAED,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACpC,CAAC;KAAA;CACF;AA7CD,0BA6CC"}

package/src/xyo-node.ts

@@ -1,68 +0,0 @@
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 20th November 2018 10:44:20 am
- * @Email:  developer@xyfindables.com
- * @Filename: xyo-node.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Friday, 7th December 2018 11:45:18 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-
-import { IXyoPeerConnectionDelegate } from '@xyo-network/peer-connections'
-import { XyoBase } from '@xyo-network/base'
-
-/**
- * An XyoNode represents a node in the xyo-network system.
- * A node can communicate with other nodes, in general, through
- * bound-witness interactions. What differentiates a sentinel
- * from a bridge from an archivist is their role in the system
- * and what their prerogative is at any given time.
- */
-
-export class XyoNode extends XyoBase {
-
-  /** Some instance variables for managing the xyo-node loop */
-  private isLooping = false
-  private shouldStopLooping = false
-
-  constructor(private readonly peerConnectionDelegate: IXyoPeerConnectionDelegate) {
-    super()
-  }
-
-  /**
-   * Calling start will place the xyo-node in loop mode
-   */
-  public start() {
-    this.loop()
-  }
-
-  /**
-   * Calling stop will remove the xyo-node from loop mode
-   */
-
-  public stop() {
-    this.shouldStopLooping = true
-    return this.peerConnectionDelegate.stopProvidingConnections()
-  }
-
-  /**
-   * Defines an xyo-node's in loop. Once an iteration of the loop is completed it will
-   * scheduled immediately for another iteration of the loop unless `stop` is called.
-   */
-
-  private async loop() {
-    if (this.isLooping && this.shouldStopLooping) {
-      return
-    }
-
-    try {
-      const networkPipe = await this.peerConnectionDelegate.provideConnection()
-      await this.peerConnectionDelegate.handlePeerConnection(networkPipe)
-    } catch (err) {
-      this.logError(`There was an uncaught error in the xyo-node loop`, err)
-    }
-
-    setImmediate(this.loop.bind(this))
-  }
-}

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-      "target": "es6",
-      "module": "commonjs",
-      "lib": ["esnext"],
-      "declaration": true,
-      "declarationMap": true,
-      "sourceMap": true,
-      "strict": true,
-      "composite": true,
-      "esModuleInterop": true,
-      "noImplicitAny": true,
-      "moduleResolution": "node",
-      "outDir": "dist",
-      "rootDir": "src"
-  },
-  "exclude": [
-    "node_modules",
-    "src/**/test/*",
-    "src/**/spec",
-    "src/**/*.spec.ts"
-  ],
-  "include": ["src/**/*"],
-  "references": [
-    {"path": "../base"},
-    {"path": "../peer-connections"}
-  ]
-}