@xyo-network/huri 2.42.13

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,81 @@
+[![logo][]](https://xyo.network)
+
+# sdk-xyo-client-js
+
+[![main-build][]][main-build-link]
+[![beta-build][]][beta-build-link]
+[![npm-badge][]][npm-link]
+[![bch-badge][]][bch-link]
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
+
+> The XYO Foundation provides this source code available in our efforts to
+> advance the understanding of the XYO Protocol and its possible uses.
+> We continue to maintain this software in the interest of developer education.
+> Usage of this source code is not intended for production.
+
+## Table of Contents
+-   [Title](#sdk-xyo-client-js)
+-   [Table of Contents](#table-of-contents)
+-   [Description](#description)
+-   [Install](#install)
+-   [Maintainers](#maintainers)
+-   [License](#license)
+-   [Credits](#credits)
+
+## Description
+
+> Primary SDK for using the XYO Protocol 2.0 from TypeScript/JavaScript.
+> Designed to work in both browser based and Node JS based solutions.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xyo-network/sdk-xyo-client-js
+```
+
+Using yarn:
+
+```sh
+yarn add @xyo-network/sdk-xyo-client-js
+```
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) [(arietrouw.com)](https://arietrouw.com)
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+
+[main-build]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build-main.yml/badge.svg
+[main-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build-main.yml
+
+[beta-build]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build-beta.yml/badge.svg
+[beta-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build-beta.yml
+
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk-xyo-client-js.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js
+
+[bch-badge]: https://bettercodehub.com/edge/badge/XYOracleNetwork/sdk-xyo-client-js?branch=main
+[bch-link]: https://bettercodehub.com/results/XYOracleNetwork/sdk-xyo-client-js
+
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/ba1f344ae34e4bfe999331cf4e27b9f5
+[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-client-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-client-js&utm_campaign=Badge_Grade
+
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/0e76349c9541f3866948/maintainability
+[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-client-js/maintainability
+
+[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-js?targetFile=package.json

package/dist/cjs/Huri.d.ts

@@ -0,0 +1,32 @@
+import { DataLike } from '@xyo-network/core';
+import { XyoPayload } from '@xyo-network/payload-model';
+export type XyoObjectCategory = 'block' | 'payload';
+export type HuriFetchFunction = (huri: Huri) => Promise<XyoPayload | undefined>;
+export interface HuriOptions {
+    archivistUri?: string;
+}
+export interface FetchedPayload<T extends XyoPayload = XyoPayload> {
+    huri?: Huri;
+    payload: T;
+}
+export declare class Huri<T extends XyoPayload = XyoPayload> {
+    archive?: string;
+    archivist?: string;
+    hash: string;
+    originalHref: string;
+    protocol?: string;
+    private isHuri;
+    constructor(huri: DataLike | Huri, { archivistUri }?: HuriOptions);
+    get href(): string;
+    static fetch<T extends XyoPayload = XyoPayload>(huri: Huri): Promise<T | undefined>;
+    static isHuri(value: unknown): Huri<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+        schema: string;
+    }> | undefined;
+    private static parsePath;
+    private static parseProtocol;
+    fetch(): Promise<T | undefined>;
+    toString(): string;
+    private parsePath;
+    private validateParse;
+}
+//# sourceMappingURL=Huri.d.ts.map

package/dist/cjs/Huri.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Huri.d.ts","sourceRoot":"","sources":["../../src/Huri.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAGvD,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAA;AAEnD,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;AAY/E,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC/D,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,CAAC,CAAA;CACX;AAED,qBAAa,IAAI,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAExB,OAAO,CAAC,MAAM,CAAO;gBAET,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,EAAE,YAAY,EAAE,GAAE,WAAgB;IAuBrE,IAAW,IAAI,WAad;WAEY,KAAK,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;WAI3E,MAAM,CAAC,KAAK,EAAE,OAAO;;;IAOnC,OAAO,CAAC,MAAM,CAAC,SAAS;IAWxB,OAAO,CAAC,MAAM,CAAC,aAAa;IAYf,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAIrC,QAAQ;IAIf,OAAO,CAAC,SAAS;IAwBjB,OAAO,CAAC,aAAa;CAUtB"}

package/dist/cjs/Huri.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Huri = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = require("@xylabs/assert");
+const account_1 = require("@xyo-network/account");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+class Huri {
+    constructor(huri, { archivistUri } = {}) {
+        var _a, _b;
+        this.isHuri = true;
+        const huriString = ((_b = (_a = Huri.isHuri(huri)) === null || _a === void 0 ? void 0 : _a.href) !== null && _b !== void 0 ? _b : typeof huri === 'string') ? huri : new account_1.AddressValue(huri).hex;
+        this.originalHref = huriString;
+        const protocol = Huri.parseProtocol(huriString);
+        this.protocol = protocol !== null && protocol !== void 0 ? protocol : 'https';
+        const path = (0, assert_1.assertEx)(Huri.parsePath(huriString), 'Missing path');
+        this.hash = this.parsePath(path, protocol !== undefined);
+        //if archivistUri sent, overwrite protocol and archivist
+        if (archivistUri) {
+            const archivistUriParts = archivistUri.split('://');
+            this.protocol = archivistUriParts[0];
+            this.archivist = archivistUriParts[1];
+        }
+        this.validateParse();
+    }
+    /*
+    The full href or the hash
+    */
+    get href() {
+        const parts = [];
+        if (this.protocol) {
+            parts.push(`${this.protocol}:/`);
+        }
+        if (this.archive) {
+            parts.push(`${this.archive}`);
+        }
+        if (this.archivist) {
+            parts.push(`${this.archivist}`);
+        }
+        parts.push(this.hash);
+        return parts.join('/');
+    }
+    static fetch(huri) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return (yield axios_1.default.get(huri.href)).data;
+        });
+    }
+    static isHuri(value) {
+        if (typeof value === 'object') {
+            return value.isHuri ? value : undefined;
+        }
+        return undefined;
+    }
+    static parsePath(huri) {
+        const protocolSplit = huri.split('//');
+        (0, assert_1.assertEx)(protocolSplit.length <= 2, `Invalid format [${huri}]`);
+        if (protocolSplit.length === 1) {
+            return huri;
+        }
+        if (protocolSplit.length === 2) {
+            return protocolSplit[1];
+        }
+    }
+    static parseProtocol(huri) {
+        const protocolSplit = huri.split('//');
+        (0, assert_1.assertEx)(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`);
+        const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined;
+        if (rawProtocol) {
+            const protocolParts = rawProtocol === null || rawProtocol === void 0 ? void 0 : rawProtocol.split(':');
+            (0, assert_1.assertEx)(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`);
+            (0, assert_1.assertEx)(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`);
+            return protocolParts.shift();
+        }
+    }
+    fetch() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield Huri.fetch(this);
+        });
+    }
+    toString() {
+        return this.href;
+    }
+    parsePath(path, hasProtocol) {
+        var _a;
+        const pathParts = path.split('/');
+        //if the protocol was found, then there is not allowed to be a leading /
+        (0, assert_1.assertEx)(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol separator');
+        //remove leading '/' if needed
+        pathParts[0].length === 0 ? pathParts.shift() : null;
+        //hash is assumed to be the last part
+        const hash = (0, assert_1.assertEx)(pathParts.pop(), 'No hash specified');
+        //archivist is assumed to be the first part
+        this.archivist = (_a = pathParts.shift()) !== null && _a !== void 0 ? _a : 'api.archivist.xyo.network';
+        //the archive is whatever is left
+        this.archive = pathParts.pop();
+        //after we pull off all the path parts, there should be nothing left
+        (0, assert_1.assertEx)(pathParts.length === 0, 'Too many path parts');
+        return hash;
+    }
+    validateParse() {
+        var _a, _b;
+        //the archivist should not be zero length
+        (0, assert_1.assertEx)(((_a = this.archivist) === null || _a === void 0 ? void 0 : _a.length) !== 0, 'Invalid archivist length');
+        //the archivist should not be zero length (can be undefined)
+        (0, assert_1.assertEx)(((_b = this.archive) === null || _b === void 0 ? void 0 : _b.length) !== 0, 'Invalid archive length');
+        //the archive should not be set if the archivist is not set
+        (0, assert_1.assertEx)(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required');
+    }
+}
+exports.Huri = Huri;
+//# sourceMappingURL=Huri.js.map

package/dist/cjs/Huri.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Huri.js","sourceRoot":"","sources":["../../src/Huri.ts"],"names":[],"mappings":";;;;AAAA,2CAAyC;AACzC,kDAAmD;AAGnD,0DAAyB;AAyBzB,MAAa,IAAI;IASf,YAAY,IAAqB,EAAE,EAAE,YAAY,KAAkB,EAAE;;QAF7D,WAAM,GAAG,IAAI,CAAA;QAGnB,MAAM,UAAU,GAAG,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0CAAE,IAAI,mCAAI,OAAO,IAAI,KAAK,QAAQ,EAAC,CAAC,CAAE,IAAe,CAAC,CAAC,CAAC,IAAI,sBAAY,CAAC,IAAgB,CAAC,CAAC,GAAG,CAAA;QAClI,IAAI,CAAC,YAAY,GAAG,UAAU,CAAA;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,OAAO,CAAA;QAEnC,MAAM,IAAI,GAAG,IAAA,iBAAQ,EAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAA;QACjE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAA;QAExD,wDAAwD;QACxD,IAAI,YAAY,EAAE;YAChB,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACnD,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;YACpC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;SACtC;QAED,IAAI,CAAC,aAAa,EAAE,CAAA;IACtB,CAAC;IAED;;MAEE;IACF,IAAW,IAAI;QACb,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAA;SACjC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;SAC9B;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;SAChC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAO,KAAK,CAAoC,IAAU;;YAC9D,OAAO,CAAC,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;QAC7C,CAAC;KAAA;IAEM,MAAM,CAAC,MAAM,CAAC,KAAc;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAQ,KAAc,CAAC,MAAM,CAAC,CAAC,CAAE,KAAc,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAY;QACnC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACtC,IAAA,iBAAQ,EAAC,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,mBAAmB,IAAI,GAAG,CAAC,CAAA;QAC/D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,OAAO,aAAa,CAAC,CAAC,CAAC,CAAA;SACxB;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,IAAY;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACtC,IAAA,iBAAQ,EAAC,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,4BAA4B,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACpF,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAClF,IAAI,WAAW,EAAE;YACf,MAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,CAAC,GAAG,CAAC,CAAA;YAC7C,IAAA,iBAAQ,EAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,4BAA4B,WAAW,GAAG,CAAC,CAAA;YAChF,IAAA,iBAAQ,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,qCAAqC,WAAW,GAAG,CAAC,CAAA;YAC5F,OAAO,aAAa,CAAC,KAAK,EAAE,CAAA;SAC7B;IACH,CAAC;IAEY,KAAK;;YAChB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAI,IAAI,CAAC,CAAA;QAClC,CAAC;KAAA;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,WAAoB;;QAClD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEjC,wEAAwE;QACxE,IAAA,iBAAQ,EAAC,CAAC,CAAC,WAAW,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAA;QAEnF,8BAA8B;QAC9B,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;QAEpD,qCAAqC;QACrC,MAAM,IAAI,GAAG,IAAA,iBAAQ,EAAC,SAAS,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAA;QAE3D,2CAA2C;QAC3C,IAAI,CAAC,SAAS,GAAG,MAAA,SAAS,CAAC,KAAK,EAAE,mCAAI,2BAA2B,CAAA;QAEjE,iCAAiC;QACjC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,EAAE,CAAA;QAE9B,oEAAoE;QACpE,IAAA,iBAAQ,EAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAEvD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,aAAa;;QACnB,yCAAyC;QACzC,IAAA,iBAAQ,EAAC,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,MAAM,MAAK,CAAC,EAAE,0BAA0B,CAAC,CAAA;QAElE,4DAA4D;QAC5D,IAAA,iBAAQ,EAAC,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,MAAK,CAAC,EAAE,wBAAwB,CAAC,CAAA;QAE9D,2DAA2D;QAC3D,IAAA,iBAAQ,EAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,mDAAmD,CAAC,CAAA;IACnG,CAAC;CACF;AA3HD,oBA2HC"}

package/dist/cjs/index.d.ts

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

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

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

package/dist/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Huri"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

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

package/dist/esm/Huri.d.ts

@@ -0,0 +1,32 @@
+import { DataLike } from '@xyo-network/core';
+import { XyoPayload } from '@xyo-network/payload-model';
+export type XyoObjectCategory = 'block' | 'payload';
+export type HuriFetchFunction = (huri: Huri) => Promise<XyoPayload | undefined>;
+export interface HuriOptions {
+    archivistUri?: string;
+}
+export interface FetchedPayload<T extends XyoPayload = XyoPayload> {
+    huri?: Huri;
+    payload: T;
+}
+export declare class Huri<T extends XyoPayload = XyoPayload> {
+    archive?: string;
+    archivist?: string;
+    hash: string;
+    originalHref: string;
+    protocol?: string;
+    private isHuri;
+    constructor(huri: DataLike | Huri, { archivistUri }?: HuriOptions);
+    get href(): string;
+    static fetch<T extends XyoPayload = XyoPayload>(huri: Huri): Promise<T | undefined>;
+    static isHuri(value: unknown): Huri<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
+        schema: string;
+    }> | undefined;
+    private static parsePath;
+    private static parseProtocol;
+    fetch(): Promise<T | undefined>;
+    toString(): string;
+    private parsePath;
+    private validateParse;
+}
+//# sourceMappingURL=Huri.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Huri.d.ts","sourceRoot":"","sources":["../../src/Huri.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAGvD,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAA;AAEnD,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;AAY/E,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC/D,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,CAAC,CAAA;CACX;AAED,qBAAa,IAAI,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAExB,OAAO,CAAC,MAAM,CAAO;gBAET,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,EAAE,YAAY,EAAE,GAAE,WAAgB;IAuBrE,IAAW,IAAI,WAad;WAEY,KAAK,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;WAI3E,MAAM,CAAC,KAAK,EAAE,OAAO;;;IAOnC,OAAO,CAAC,MAAM,CAAC,SAAS;IAWxB,OAAO,CAAC,MAAM,CAAC,aAAa;IAYf,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAIrC,QAAQ;IAIf,OAAO,CAAC,SAAS;IAwBjB,OAAO,CAAC,aAAa;CAUtB"}

package/dist/esm/Huri.js

@@ -0,0 +1,104 @@
+import { assertEx } from '@xylabs/assert';
+import { AddressValue } from '@xyo-network/account';
+import axios from 'axios';
+export class Huri {
+    archive;
+    archivist;
+    hash;
+    originalHref;
+    protocol;
+    isHuri = true;
+    constructor(huri, { archivistUri } = {}) {
+        const huriString = (Huri.isHuri(huri)?.href ?? typeof huri === 'string') ? huri : new AddressValue(huri).hex;
+        this.originalHref = huriString;
+        const protocol = Huri.parseProtocol(huriString);
+        this.protocol = protocol ?? 'https';
+        const path = assertEx(Huri.parsePath(huriString), 'Missing path');
+        this.hash = this.parsePath(path, protocol !== undefined);
+        //if archivistUri sent, overwrite protocol and archivist
+        if (archivistUri) {
+            const archivistUriParts = archivistUri.split('://');
+            this.protocol = archivistUriParts[0];
+            this.archivist = archivistUriParts[1];
+        }
+        this.validateParse();
+    }
+    /*
+    The full href or the hash
+    */
+    get href() {
+        const parts = [];
+        if (this.protocol) {
+            parts.push(`${this.protocol}:/`);
+        }
+        if (this.archive) {
+            parts.push(`${this.archive}`);
+        }
+        if (this.archivist) {
+            parts.push(`${this.archivist}`);
+        }
+        parts.push(this.hash);
+        return parts.join('/');
+    }
+    static async fetch(huri) {
+        return (await axios.get(huri.href)).data;
+    }
+    static isHuri(value) {
+        if (typeof value === 'object') {
+            return value.isHuri ? value : undefined;
+        }
+        return undefined;
+    }
+    static parsePath(huri) {
+        const protocolSplit = huri.split('//');
+        assertEx(protocolSplit.length <= 2, `Invalid format [${huri}]`);
+        if (protocolSplit.length === 1) {
+            return huri;
+        }
+        if (protocolSplit.length === 2) {
+            return protocolSplit[1];
+        }
+    }
+    static parseProtocol(huri) {
+        const protocolSplit = huri.split('//');
+        assertEx(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`);
+        const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined;
+        if (rawProtocol) {
+            const protocolParts = rawProtocol?.split(':');
+            assertEx(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`);
+            assertEx(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`);
+            return protocolParts.shift();
+        }
+    }
+    async fetch() {
+        return await Huri.fetch(this);
+    }
+    toString() {
+        return this.href;
+    }
+    parsePath(path, hasProtocol) {
+        const pathParts = path.split('/');
+        //if the protocol was found, then there is not allowed to be a leading /
+        assertEx(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol separator');
+        //remove leading '/' if needed
+        pathParts[0].length === 0 ? pathParts.shift() : null;
+        //hash is assumed to be the last part
+        const hash = assertEx(pathParts.pop(), 'No hash specified');
+        //archivist is assumed to be the first part
+        this.archivist = pathParts.shift() ?? 'api.archivist.xyo.network';
+        //the archive is whatever is left
+        this.archive = pathParts.pop();
+        //after we pull off all the path parts, there should be nothing left
+        assertEx(pathParts.length === 0, 'Too many path parts');
+        return hash;
+    }
+    validateParse() {
+        //the archivist should not be zero length
+        assertEx(this.archivist?.length !== 0, 'Invalid archivist length');
+        //the archivist should not be zero length (can be undefined)
+        assertEx(this.archive?.length !== 0, 'Invalid archive length');
+        //the archive should not be set if the archivist is not set
+        assertEx(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required');
+    }
+}
+//# sourceMappingURL=Huri.js.map

package/dist/esm/Huri.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Huri.js","sourceRoot":"","sources":["../../src/Huri.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAGnD,OAAO,KAAK,MAAM,OAAO,CAAA;AAyBzB,MAAM,OAAO,IAAI;IACR,OAAO,CAAS;IAChB,SAAS,CAAS;IAClB,IAAI,CAAQ;IACZ,YAAY,CAAQ;IACpB,QAAQ,CAAS;IAEhB,MAAM,GAAG,IAAI,CAAA;IAErB,YAAY,IAAqB,EAAE,EAAE,YAAY,KAAkB,EAAE;QACnE,MAAM,UAAU,GAAG,CAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAC,CAAC,CAAE,IAAe,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAgB,CAAC,CAAC,GAAG,CAAA;QAClI,IAAI,CAAC,YAAY,GAAG,UAAU,CAAA;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,OAAO,CAAA;QAEnC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAA;QACjE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAA;QAExD,wDAAwD;QACxD,IAAI,YAAY,EAAE;YAChB,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACnD,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;YACpC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;SACtC;QAED,IAAI,CAAC,aAAa,EAAE,CAAA;IACtB,CAAC;IAED;;MAEE;IACF,IAAW,IAAI;QACb,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAA;SACjC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;SAC9B;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;SAChC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAAoC,IAAU;QAC9D,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG,CAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAC7C,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAc;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAQ,KAAc,CAAC,MAAM,CAAC,CAAC,CAAE,KAAc,CAAC,CAAC,CAAC,SAAS,CAAA;SAC5D;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAY;QACnC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACtC,QAAQ,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,mBAAmB,IAAI,GAAG,CAAC,CAAA;QAC/D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,OAAO,aAAa,CAAC,CAAC,CAAC,CAAA;SACxB;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,IAAY;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACtC,QAAQ,CAAC,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,4BAA4B,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACpF,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAClF,IAAI,WAAW,EAAE;YACf,MAAM,aAAa,GAAG,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;YAC7C,QAAQ,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,4BAA4B,WAAW,GAAG,CAAC,CAAA;YAChF,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,qCAAqC,WAAW,GAAG,CAAC,CAAA;YAC5F,OAAO,aAAa,CAAC,KAAK,EAAE,CAAA;SAC7B;IACH,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAI,IAAI,CAAC,CAAA;IAClC,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,WAAoB;QAClD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEjC,wEAAwE;QACxE,QAAQ,CAAC,CAAC,CAAC,WAAW,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAA;QAEnF,8BAA8B;QAC9B,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;QAEpD,qCAAqC;QACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAA;QAE3D,2CAA2C;QAC3C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,2BAA2B,CAAA;QAEjE,iCAAiC;QACjC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,EAAE,CAAA;QAE9B,oEAAoE;QACpE,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAEvD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,aAAa;QACnB,yCAAyC;QACzC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,KAAK,CAAC,EAAE,0BAA0B,CAAC,CAAA;QAElE,4DAA4D;QAC5D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAA;QAE9D,2DAA2D;QAC3D,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,mDAAmD,CAAC,CAAA;IACnG,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Huri';
+//# 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,QAAQ,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './Huri';
+//# 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,QAAQ,CAAA"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@xyo-network/huri",
+  "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": {
+    "@xylabs/assert": "^2.6.11",
+    "@xyo-network/account": "^2.42.14",
+    "@xyo-network/core": "^2.42.14",
+    "@xyo-network/payload-model": "^2.42.13"
+  },
+  "peerDependencies": {
+    "axios": "~1.2.1"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.10.19"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.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.42.13"
+}

package/src/Huri.spec.ts

@@ -0,0 +1,92 @@
+import { delay } from '@xylabs/delay'
+import { XyoPayload } from '@xyo-network/payload-model'
+
+import { Huri } from './Huri'
+
+const hash = 'fb3606d71dcdd49a0aacc9d234e412684d577803c8a9ed9399a9d3776cc88e24'
+
+const valid = [
+  `https://${hash}`,
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `https://api.archivist.xyo.network/${hash}`,
+  `http://api.archivist.xyo.network/${hash}`,
+  `/api.archivist.xyo.network/${hash}`,
+  `//${hash}`,
+  `/${hash}`,
+  `${hash}`,
+]
+
+const validWithTempArchive = [
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `http://api.archivist.xyo.network/temp/${hash}`,
+  `/api.archivist.xyo.network/temp/${hash}`,
+]
+
+const invalid = [`https:///api.archivist.xyo.network/${hash}`, `https://api.archivist.xyo.network//${hash}`]
+
+describe('Huri', () => {
+  describe('Valid Items', () => {
+    valid.map((item) => {
+      test(`valid [${item}]`, () => {
+        try {
+          const huri = new Huri(item)
+          expect(huri.hash).toBe(hash)
+        } catch (ex) {
+          console.error(`Valid Huri failed: [${item}]`)
+          console.error(ex)
+        }
+      })
+    })
+  })
+  describe('Valid Items w/archive', () => {
+    validWithTempArchive.map((item) => {
+      test(`valid w/archive [${item}]`, () => {
+        try {
+          const huri = new Huri(item)
+          expect(huri.hash).toBe(hash)
+          expect(huri.archive).toBe('temp')
+        } catch (ex) {
+          console.error(`Valid Huri w/archive failed: [${item}]`)
+          console.error(ex)
+        }
+      })
+    })
+  })
+  describe('Invalid Items', () => {
+    invalid.map((item) => {
+      test(`invalid [${item}]`, () => {
+        expect(() => new Huri(item)).toThrowError()
+      })
+    })
+  })
+  describe('Api Fetch', () => {
+    it('Valid Huri', async () => {
+      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+      const result = await huri.fetch()
+      expect(result?.schema).toBe('network.xyo.schema')
+    })
+    it('Invalid Huri', async () => {
+      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653bad')
+      await expect(huri.fetch()).rejects.toThrow()
+    })
+  })
+  describe('Fetch Override', () => {
+    invalid.map((item) => {
+      test(`invalid [${item}]`, async () => {
+        const oldFetch = Huri.fetch
+        Huri.fetch = async <T extends XyoPayload = XyoPayload>(huri: Huri): Promise<T | undefined> => {
+          await delay(0)
+          const payload: T = {
+            schema: huri.hash,
+          } as T
+          return payload
+        }
+        const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+        const result = await huri.fetch()
+        Huri.fetch = oldFetch
+        expect(result?.schema).toBe('18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+      })
+    })
+  })
+})

package/src/Huri.ts

@@ -0,0 +1,153 @@
+import { assertEx } from '@xylabs/assert'
+import { AddressValue } from '@xyo-network/account'
+import { DataLike } from '@xyo-network/core'
+import { XyoPayload } from '@xyo-network/payload-model'
+import axios from 'axios'
+
+export type XyoObjectCategory = 'block' | 'payload'
+
+export type HuriFetchFunction = (huri: Huri) => Promise<XyoPayload | undefined>
+
+/* 
+  Valid Huri:
+
+  [<protocol>://][<archivist>/[<archive>/]]<hash>
+
+  defaults:
+    protocol: https
+    archivist: api.archivist.xyo.network
+*/
+
+export interface HuriOptions {
+  archivistUri?: string
+}
+
+export interface FetchedPayload<T extends XyoPayload = XyoPayload> {
+  huri?: Huri
+  payload: T
+}
+
+export class Huri<T extends XyoPayload = XyoPayload> {
+  public archive?: string
+  public archivist?: string
+  public hash: string
+  public originalHref: string
+  public protocol?: string
+
+  private isHuri = true
+
+  constructor(huri: DataLike | Huri, { archivistUri }: HuriOptions = {}) {
+    const huriString = Huri.isHuri(huri)?.href ?? typeof huri === 'string' ? (huri as string) : new AddressValue(huri as DataLike).hex
+    this.originalHref = huriString
+
+    const protocol = Huri.parseProtocol(huriString)
+    this.protocol = protocol ?? 'https'
+
+    const path = assertEx(Huri.parsePath(huriString), 'Missing path')
+    this.hash = this.parsePath(path, protocol !== undefined)
+
+    //if archivistUri sent, overwrite protocol and archivist
+    if (archivistUri) {
+      const archivistUriParts = archivistUri.split('://')
+      this.protocol = archivistUriParts[0]
+      this.archivist = archivistUriParts[1]
+    }
+
+    this.validateParse()
+  }
+
+  /*
+  The full href or the hash
+  */
+  public get href() {
+    const parts: string[] = []
+    if (this.protocol) {
+      parts.push(`${this.protocol}:/`)
+    }
+    if (this.archive) {
+      parts.push(`${this.archive}`)
+    }
+    if (this.archivist) {
+      parts.push(`${this.archivist}`)
+    }
+    parts.push(this.hash)
+    return parts.join('/')
+  }
+
+  static async fetch<T extends XyoPayload = XyoPayload>(huri: Huri): Promise<T | undefined> {
+    return (await axios.get<T>(huri.href)).data
+  }
+
+  public static isHuri(value: unknown) {
+    if (typeof value === 'object') {
+      return (value as Huri).isHuri ? (value as Huri) : undefined
+    }
+    return undefined
+  }
+
+  private static parsePath(huri: string) {
+    const protocolSplit = huri.split('//')
+    assertEx(protocolSplit.length <= 2, `Invalid format [${huri}]`)
+    if (protocolSplit.length === 1) {
+      return huri
+    }
+    if (protocolSplit.length === 2) {
+      return protocolSplit[1]
+    }
+  }
+
+  private static parseProtocol(huri: string) {
+    const protocolSplit = huri.split('//')
+    assertEx(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`)
+    const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined
+    if (rawProtocol) {
+      const protocolParts = rawProtocol?.split(':')
+      assertEx(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`)
+      assertEx(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`)
+      return protocolParts.shift()
+    }
+  }
+
+  public async fetch(): Promise<T | undefined> {
+    return await Huri.fetch<T>(this)
+  }
+
+  public toString() {
+    return this.href
+  }
+
+  private parsePath(path: string, hasProtocol: boolean) {
+    const pathParts = path.split('/')
+
+    //if the protocol was found, then there is not allowed to be a leading /
+    assertEx(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol separator')
+
+    //remove leading '/' if needed
+    pathParts[0].length === 0 ? pathParts.shift() : null
+
+    //hash is assumed to be the last part
+    const hash = assertEx(pathParts.pop(), 'No hash specified')
+
+    //archivist is assumed to be the first part
+    this.archivist = pathParts.shift() ?? 'api.archivist.xyo.network'
+
+    //the archive is whatever is left
+    this.archive = pathParts.pop()
+
+    //after we pull off all the path parts, there should be nothing left
+    assertEx(pathParts.length === 0, 'Too many path parts')
+
+    return hash
+  }
+
+  private validateParse() {
+    //the archivist should not be zero length
+    assertEx(this.archivist?.length !== 0, 'Invalid archivist length')
+
+    //the archivist should not be zero length (can be undefined)
+    assertEx(this.archive?.length !== 0, 'Invalid archive length')
+
+    //the archive should not be set if the archivist is not set
+    assertEx(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required')
+  }
+}

package/src/index.ts

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