@helia/json 0.0.0

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,59 @@
+<p align="center">
+  <a href="https://github.com/ipfs/helia" title="Helia">
+    <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
+  </a>
+</p>
+
+# @helia/json <!-- omit in toc -->
+
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-json.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-json)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-json/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-json/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+
+> Add/get IPLD blocks containing strings with your Helia node
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
+- [API Docs](#api-docs)
+- [License](#license)
+- [Contribute](#contribute)
+
+## Install
+
+```console
+$ npm i @helia/json
+```
+
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `HeliaStrings` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@helia/json/dist/index.min.js"></script>
+```
+
+## API Docs
+
+- <https://ipfs.github.io/helia-json/modules/_helia_strings.html>
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribute
+
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-json/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

package/dist/index.min.js

@@ -0,0 +1,3 @@
+(function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.HeliaJson = factory()}(typeof self !== 'undefined' ? self : this, function () {
+"use strict";var HeliaJson=(()=>{var k=Object.defineProperty;var le=Object.getOwnPropertyDescriptor;var we=Object.getOwnPropertyNames;var be=Object.prototype.hasOwnProperty;var ge=(r,e)=>{for(var t in e)k(r,t,{get:e[t],enumerable:!0})},xe=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of we(e))!be.call(r,o)&&o!==t&&k(r,o,{get:()=>e[o],enumerable:!(n=le(e,o))||n.enumerable});return r};var me=r=>xe(k({},"__esModule",{value:!0}),r);var Ye={};ge(Ye,{json:()=>Ze});var ye=W,K=128,ve=127,Ae=~ve,Se=Math.pow(2,31);function W(r,e,t){e=e||[],t=t||0;for(var n=t;r>=Se;)e[t++]=r&255|K,r/=128;for(;r&Ae;)e[t++]=r&255|K,r>>>=7;return e[t]=r|0,W.bytes=t-n+1,e}var Ee=I,Ue=128,H=127;function I(r,n){var t=0,n=n||0,o=0,s=n,i,a=r.length;do{if(s>=a)throw I.bytes=0,new RangeError("Could not decode varint");i=r[s++],t+=o<28?(i&H)<<o:(i&H)*Math.pow(2,o),o+=7}while(i>=Ue);return I.bytes=s-n,t}var ze=Math.pow(2,7),Ce=Math.pow(2,14),Me=Math.pow(2,21),Ne=Math.pow(2,28),Oe=Math.pow(2,35),Te=Math.pow(2,42),Ve=Math.pow(2,49),De=Math.pow(2,56),Le=Math.pow(2,63),Be=function(r){return r<ze?1:r<Ce?2:r<Me?3:r<Ne?4:r<Oe?5:r<Te?6:r<Ve?7:r<De?8:r<Le?9:10},$e={encode:ye,decode:Ee,encodingLength:Be},ke=$e,O=ke;var T=(r,e=0)=>[O.decode(r,e),O.decode.bytes],z=(r,e,t=0)=>(O.encode(r,e,t),e),C=r=>O.encodingLength(r);var rt=new Uint8Array(0);var Y=(r,e)=>{if(r===e)return!0;if(r.byteLength!==e.byteLength)return!1;for(let t=0;t<r.byteLength;t++)if(r[t]!==e[t])return!1;return!0},M=r=>{if(r instanceof Uint8Array&&r.constructor.name==="Uint8Array")return r;if(r instanceof ArrayBuffer)return new Uint8Array(r);if(ArrayBuffer.isView(r))return new Uint8Array(r.buffer,r.byteOffset,r.byteLength);throw new Error("Unknown type, must be binary type")};var V=(r,e)=>{let t=e.byteLength,n=C(r),o=n+C(t),s=new Uint8Array(o+t);return z(r,s,0),z(t,s,n),s.set(e,o),new N(r,t,e,s)},_=r=>{let e=M(r),[t,n]=T(e),[o,s]=T(e.subarray(n)),i=e.subarray(n+s);if(i.byteLength!==o)throw new Error("Incorrect length");return new N(t,o,i,e)},ee=(r,e)=>{if(r===e)return!0;{let t=e;return r.code===t.code&&r.size===t.size&&t.bytes instanceof Uint8Array&&Y(r.bytes,t.bytes)}},N=class{constructor(e,t,n,o){this.code=e,this.size=t,this.digest=n,this.bytes=o}};function Ie(r,e){if(r.length>=255)throw new TypeError("Alphabet too long");for(var t=new Uint8Array(256),n=0;n<t.length;n++)t[n]=255;for(var o=0;o<r.length;o++){var s=r.charAt(o),i=s.charCodeAt(0);if(t[i]!==255)throw new TypeError(s+" is ambiguous");t[i]=o}var a=r.length,h=r.charAt(0),E=Math.log(a)/Math.log(256),p=Math.log(256)/Math.log(a);function U(c){if(c instanceof Uint8Array||(ArrayBuffer.isView(c)?c=new Uint8Array(c.buffer,c.byteOffset,c.byteLength):Array.isArray(c)&&(c=Uint8Array.from(c))),!(c instanceof Uint8Array))throw new TypeError("Expected Uint8Array");if(c.length===0)return"";for(var f=0,S=0,l=0,b=c.length;l!==b&&c[l]===0;)l++,f++;for(var g=(b-l)*p+1>>>0,u=new Uint8Array(g);l!==b;){for(var x=c[l],A=0,w=g-1;(x!==0||A<S)&&w!==-1;w--,A++)x+=256*u[w]>>>0,u[w]=x%a>>>0,x=x/a>>>0;if(x!==0)throw new Error("Non-zero carry");S=A,l++}for(var y=g-S;y!==g&&u[y]===0;)y++;for(var $=h.repeat(f);y<g;++y)$+=r.charAt(u[y]);return $}function B(c){if(typeof c!="string")throw new TypeError("Expected String");if(c.length===0)return new Uint8Array;var f=0;if(c[f]!==" "){for(var S=0,l=0;c[f]===h;)S++,f++;for(var b=(c.length-f)*E+1>>>0,g=new Uint8Array(b);c[f];){var u=t[c.charCodeAt(f)];if(u===255)return;for(var x=0,A=b-1;(u!==0||x<l)&&A!==-1;A--,x++)u+=a*g[A]>>>0,g[A]=u%256>>>0,u=u/256>>>0;if(u!==0)throw new Error("Non-zero carry");l=x,f++}if(c[f]!==" "){for(var w=b-l;w!==b&&g[w]===0;)w++;for(var y=new Uint8Array(S+(b-w)),$=S;w!==b;)y[$++]=g[w++];return y}}}function ue(c){var f=B(c);if(f)return f;throw new Error(`Non-${e} character`)}return{encode:U,decodeUnsafe:B,decode:ue}}var Fe=Ie,je=Fe,re=je;var F=class{constructor(e,t,n){this.name=e,this.prefix=t,this.baseEncode=n}encode(e){if(e instanceof Uint8Array)return`${this.prefix}${this.baseEncode(e)}`;throw Error("Unknown type, must be binary type")}},j=class{constructor(e,t,n){if(this.name=e,this.prefix=t,t.codePointAt(0)===void 0)throw new Error("Invalid prefix character");this.prefixCodePoint=t.codePointAt(0),this.baseDecode=n}decode(e){if(typeof e=="string"){if(e.codePointAt(0)!==this.prefixCodePoint)throw Error(`Unable to decode multibase string ${JSON.stringify(e)}, ${this.name} decoder only supports inputs prefixed with ${this.prefix}`);return this.baseDecode(e.slice(this.prefix.length))}else throw Error("Can only multibase decode strings")}or(e){return ne(this,e)}},q=class{constructor(e){this.decoders=e}or(e){return ne(this,e)}decode(e){let t=e[0],n=this.decoders[t];if(n)return n.decode(e);throw RangeError(`Unable to decode multibase string ${JSON.stringify(e)}, only inputs prefixed with ${Object.keys(this.decoders)} are supported`)}},ne=(r,e)=>new q({...r.decoders||{[r.prefix]:r},...e.decoders||{[e.prefix]:e}}),R=class{constructor(e,t,n,o){this.name=e,this.prefix=t,this.baseEncode=n,this.baseDecode=o,this.encoder=new F(e,t,n),this.decoder=new j(e,t,o)}encode(e){return this.encoder.encode(e)}decode(e){return this.decoder.decode(e)}},oe=({name:r,prefix:e,encode:t,decode:n})=>new R(r,e,t,n),J=({prefix:r,name:e,alphabet:t})=>{let{encode:n,decode:o}=re(t,e);return oe({prefix:r,name:e,encode:n,decode:s=>M(o(s))})},qe=(r,e,t,n)=>{let o={};for(let p=0;p<e.length;++p)o[e[p]]=p;let s=r.length;for(;r[s-1]==="=";)--s;let i=new Uint8Array(s*t/8|0),a=0,h=0,E=0;for(let p=0;p<s;++p){let U=o[r[p]];if(U===void 0)throw new SyntaxError(`Non-${n} character`);h=h<<t|U,a+=t,a>=8&&(a-=8,i[E++]=255&h>>a)}if(a>=t||255&h<<8-a)throw new SyntaxError("Unexpected end of data");return i},Re=(r,e,t)=>{let n=e[e.length-1]==="=",o=(1<<t)-1,s="",i=0,a=0;for(let h=0;h<r.length;++h)for(a=a<<8|r[h],i+=8;i>t;)i-=t,s+=e[o&a>>i];if(i&&(s+=e[o&a<<t-i]),n)for(;s.length*t&7;)s+="=";return s},m=({name:r,prefix:e,bitsPerChar:t,alphabet:n})=>oe({prefix:e,name:r,encode(o){return Re(o,n,t)},decode(o){return qe(o,n,t,r)}});var v=J({name:"base58btc",prefix:"z",alphabet:"123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"}),ht=J({name:"base58flickr",prefix:"Z",alphabet:"123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"});var D=m({prefix:"b",name:"base32",alphabet:"abcdefghijklmnopqrstuvwxyz234567",bitsPerChar:5}),ut=m({prefix:"B",name:"base32upper",alphabet:"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567",bitsPerChar:5}),lt=m({prefix:"c",name:"base32pad",alphabet:"abcdefghijklmnopqrstuvwxyz234567=",bitsPerChar:5}),wt=m({prefix:"C",name:"base32padupper",alphabet:"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567=",bitsPerChar:5}),bt=m({prefix:"v",name:"base32hex",alphabet:"0123456789abcdefghijklmnopqrstuv",bitsPerChar:5}),gt=m({prefix:"V",name:"base32hexupper",alphabet:"0123456789ABCDEFGHIJKLMNOPQRSTUV",bitsPerChar:5}),xt=m({prefix:"t",name:"base32hexpad",alphabet:"0123456789abcdefghijklmnopqrstuv=",bitsPerChar:5}),mt=m({prefix:"T",name:"base32hexpadupper",alphabet:"0123456789ABCDEFGHIJKLMNOPQRSTUV=",bitsPerChar:5}),yt=m({prefix:"h",name:"base32z",alphabet:"ybndrfg8ejkmcpqxot1uwisza345h769",bitsPerChar:5});var se=(r,e)=>{let{bytes:t,version:n}=r;switch(n){case 0:return Pe(t,P(r),e||v.encoder);default:return Qe(t,P(r),e||D.encoder)}};var ie=new WeakMap,P=r=>{let e=ie.get(r);if(e==null){let t=new Map;return ie.set(r,t),t}return e},d=class{constructor(e,t,n,o){this.code=t,this.version=e,this.multihash=n,this.bytes=o,this["/"]=o}get asCID(){return this}get byteOffset(){return this.bytes.byteOffset}get byteLength(){return this.bytes.byteLength}toV0(){switch(this.version){case 0:return this;case 1:{let{code:e,multihash:t}=this;if(e!==L)throw new Error("Cannot convert a non dag-pb CID to CIDv0");if(t.code!==Ge)throw new Error("Cannot convert non sha2-256 multihash CID to CIDv0");return d.createV0(t)}default:throw Error(`Can not convert CID version ${this.version} to version 0. This is a bug please report`)}}toV1(){switch(this.version){case 0:{let{code:e,digest:t}=this.multihash,n=V(e,t);return d.createV1(this.code,n)}case 1:return this;default:throw Error(`Can not convert CID version ${this.version} to version 1. This is a bug please report`)}}equals(e){return d.equals(this,e)}static equals(e,t){let n=t;return n&&e.code===n.code&&e.version===n.version&&ee(e.multihash,n.multihash)}toString(e){return se(this,e)}toJSON(){return{"/":se(this)}}link(){return this}get[Symbol.toStringTag](){return"CID"}[Symbol.for("nodejs.util.inspect.custom")](){return`CID(${this.toString()})`}static asCID(e){if(e==null)return null;let t=e;if(t instanceof d)return t;if(t["/"]!=null&&t["/"]===t.bytes||t.asCID===t){let{version:n,code:o,multihash:s,bytes:i}=t;return new d(n,o,s,i||ce(n,o,s.bytes))}else if(t[Xe]===!0){let{version:n,multihash:o,code:s}=t,i=_(o);return d.create(n,s,i)}else return null}static create(e,t,n){if(typeof t!="number")throw new Error("String codecs are no longer supported");if(!(n.bytes instanceof Uint8Array))throw new Error("Invalid digest");switch(e){case 0:{if(t!==L)throw new Error(`Version 0 CID must use dag-pb (code: ${L}) block encoding`);return new d(e,t,n,n.bytes)}case 1:{let o=ce(e,t,n.bytes);return new d(e,t,n,o)}default:throw new Error("Invalid version")}}static createV0(e){return d.create(0,L,e)}static createV1(e,t){return d.create(1,e,t)}static decode(e){let[t,n]=d.decodeFirst(e);if(n.length)throw new Error("Incorrect length");return t}static decodeFirst(e){let t=d.inspectBytes(e),n=t.size-t.multihashSize,o=M(e.subarray(n,n+t.multihashSize));if(o.byteLength!==t.multihashSize)throw new Error("Incorrect length");let s=o.subarray(t.multihashSize-t.digestSize),i=new N(t.multihashCode,t.digestSize,s,o);return[t.version===0?d.createV0(i):d.createV1(t.codec,i),e.subarray(t.size)]}static inspectBytes(e){let t=0,n=()=>{let[U,B]=T(e.subarray(t));return t+=B,U},o=n(),s=L;if(o===18?(o=0,t=0):s=n(),o!==0&&o!==1)throw new RangeError(`Invalid CID version ${o}`);let i=t,a=n(),h=n(),E=t+h,p=E-i;return{version:o,codec:s,multihashCode:a,digestSize:h,multihashSize:p,size:E}}static parse(e,t){let[n,o]=Je(e,t),s=d.decode(o);if(s.version===0&&e[0]!=="Q")throw Error("Version 0 CID string must not include multibase prefix");return P(s).set(n,e),s}},Je=(r,e)=>{switch(r[0]){case"Q":{let t=e||v;return[v.prefix,t.decode(`${v.prefix}${r}`)]}case v.prefix:{let t=e||v;return[v.prefix,t.decode(r)]}case D.prefix:{let t=e||D;return[D.prefix,t.decode(r)]}default:{if(e==null)throw Error("To parse non base32 or base58btc encoded CID multibase decoder must be provided");return[r[0],e.decode(r)]}}},Pe=(r,e,t)=>{let{prefix:n}=t;if(n!==v.prefix)throw Error(`Cannot string encode V0 in ${t.name} encoding`);let o=e.get(n);if(o==null){let s=t.encode(r).slice(1);return e.set(n,s),s}else return o},Qe=(r,e,t)=>{let{prefix:n}=t,o=e.get(n);if(o==null){let s=t.encode(r);return e.set(n,s),s}else return o},L=112,Ge=18,ce=(r,e,t)=>{let n=C(r),o=n+C(e),s=new Uint8Array(o+t.byteLength);return z(r,s,0),z(e,s,n),s.set(t,o),s},Xe=Symbol.for("@ipld/js-cid/CID");var Ke=new TextEncoder,He=new TextDecoder;var ae=512,de=r=>Ke.encode(JSON.stringify(r)),he=r=>JSON.parse(He.decode(r));var G=({name:r,code:e,encode:t})=>new Q(r,e,t),Q=class{constructor(e,t,n){this.name=e,this.code=t,this.encode=n}digest(e){if(e instanceof Uint8Array){let t=this.encode(e);return t instanceof Uint8Array?V(this.code,t):t.then(n=>V(this.code,n))}else throw Error("Unknown type, must be binary type")}};var fe=r=>async e=>new Uint8Array(await crypto.subtle.digest(r,e)),pe=G({name:"sha2-256",code:18,encode:fe("SHA-256")}),Nt=G({name:"sha2-512",code:19,encode:fe("SHA-512")});var X=class{components;constructor(e){this.components=e}async add(e,t={}){let n=de(e),o=await(t.hasher??pe).digest(n),s=d.createV1(ae,o);return await this.components.blockstore.put(s,n,t),s}async get(e,t={}){let n=await this.components.blockstore.get(e,t);return he(n)}};function Ze(r){return new X(r)}return me(Ye);})();
+return HeliaJson}));

package/dist/src/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @packageDocumentation
+ *
+ * `@helia/json` makes working with strings {@link https://github.com/ipfs/helia Helia} simple & straightforward.
+ *
+ * See the {@link Strings Strings interface} for all available operations.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createHelia } from 'helia'
+ * import { json } from '@helia/json'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const j = json(helia)
+ * const cid = await j.put({
+ *   hello: 'world'
+ * })
+ * const obj = await j.get(cid)
+ *
+ * console.info(obj)
+ * // { hello: 'world' }
+ * ```
+ */
+import { CID } from 'multiformats/cid';
+import type { Blocks, GetBlockProgressEvents, PutBlockProgressEvents } from '@helia/interface/blocks';
+import type { AbortOptions } from '@libp2p/interfaces';
+import type { BlockCodec } from 'multiformats/codecs/interface';
+import type { MultihashHasher } from 'multiformats/hashes/interface';
+import type { ProgressOptions } from 'progress-events';
+export interface JSONComponents {
+    blockstore: Blocks;
+}
+export interface AddOptions extends AbortOptions, ProgressOptions<PutBlockProgressEvents> {
+    hasher: MultihashHasher;
+}
+export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents> {
+    codec: BlockCodec<any, unknown>;
+}
+/**
+ * The JSON interface provides a simple and intuitive way to add/get objects
+ * with your Helia node and is a great place to start learning about IPFS.
+ */
+export interface JSON {
+    /**
+     * Add an object to your Helia node and get a CID that refers to the block the
+     * object has been stored as.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { json } from '@helia/json'
+     *
+     * const j = json(helia)
+     * const cid = await str.add({ hello: 'world' })
+     *
+     * console.info(cid)
+     * // CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+     * ```
+     */
+    add: (str: unknown, options?: Partial<AddOptions>) => Promise<CID>;
+    /**
+     * Get an object from your Helia node, either previously added to it or to
+     * another node on the network.
+     *
+     * @example
+     *
+     * ```typescript
+     * import { json } from '@helia/json'
+     * import { CID } from 'multiformats/cid'
+     *
+     * const j = json(helia)
+     * const cid = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
+     * const obj = await j.get(cid)
+     *
+     * console.info(obj)
+     * // { hello: 'world' }
+     * ```
+     */
+    get: <T>(cid: CID, options?: Partial<GetOptions>) => Promise<T>;
+}
+/**
+ * Create a {@link JSON} instance for use with {@link https://github.com/ipfs/helia Helia}
+ */
+export declare function json(helia: {
+    blockstore: Blocks;
+}): JSON;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAGtC,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AACrG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC;IACvF,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,sBAAsB,CAAC;IACvF,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;;;;;;;;;;;;;;OAeG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAElE;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,EAAE,CAAC,CAAC,EAAG,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;CACjE;AA0BD;;GAEG;AACH,wBAAgB,IAAI,CAAE,KAAK,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAEzD"}

package/dist/src/index.js

@@ -0,0 +1,51 @@
+/**
+ * @packageDocumentation
+ *
+ * `@helia/json` makes working with strings {@link https://github.com/ipfs/helia Helia} simple & straightforward.
+ *
+ * See the {@link Strings Strings interface} for all available operations.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createHelia } from 'helia'
+ * import { json } from '@helia/json'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const j = json(helia)
+ * const cid = await j.put({
+ *   hello: 'world'
+ * })
+ * const obj = await j.get(cid)
+ *
+ * console.info(obj)
+ * // { hello: 'world' }
+ * ```
+ */
+import { CID } from 'multiformats/cid';
+import * as jsonCodec from 'multiformats/codecs/json';
+import { sha256 } from 'multiformats/hashes/sha2';
+class DefaultJSON {
+    components;
+    constructor(components) {
+        this.components = components;
+    }
+    async add(obj, options = {}) {
+        const buf = jsonCodec.encode(obj);
+        const hash = await (options.hasher ?? sha256).digest(buf);
+        const cid = CID.createV1(jsonCodec.code, hash);
+        await this.components.blockstore.put(cid, buf, options);
+        return cid;
+    }
+    async get(cid, options = {}) {
+        const buf = await this.components.blockstore.get(cid, options);
+        return jsonCodec.decode(buf);
+    }
+}
+/**
+ * Create a {@link JSON} instance for use with {@link https://github.com/ipfs/helia Helia}
+ */
+export function json(helia) {
+    return new DefaultJSON(helia);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAA;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AA+DjD,MAAM,WAAW;IACE,UAAU,CAAgB;IAE3C,YAAa,UAA0B;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,GAAQ,EAAE,UAA+B,EAAE;QACpD,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACzD,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAE9C,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QAEvD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,GAAG,CAAM,GAAQ,EAAE,UAA+B,EAAE;QACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAE9D,OAAO,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,IAAI,CAAE,KAA6B;IACjD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA;AAC/B,CAAC"}

package/package.json

@@ -0,0 +1,156 @@
+{
+  "name": "@helia/json",
+  "version": "0.0.0",
+  "description": "Add/get IPLD blocks containing json with your Helia node",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/helia-json/tree/master/packages/strings#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/helia-json.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs/helia-json/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "aegir build",
+    "docs": "aegir docs",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main",
+    "release": "aegir release"
+  },
+  "dependencies": {
+    "@helia/interface": "^1.0.0",
+    "@libp2p/interfaces": "^3.3.1",
+    "interface-blockstore": "^5.0.0",
+    "multiformats": "^11.0.1",
+    "progress-events": "^1.0.0",
+    "uint8arrays": "^4.0.3"
+  },
+  "devDependencies": {
+    "aegir": "^39.0.3",
+    "blockstore-core": "^4.0.1"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
+  }
+}

package/src/index.ts

@@ -0,0 +1,120 @@
+/**
+ * @packageDocumentation
+ *
+ * `@helia/json` makes working with strings {@link https://github.com/ipfs/helia Helia} simple & straightforward.
+ *
+ * See the {@link Strings Strings interface} for all available operations.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createHelia } from 'helia'
+ * import { json } from '@helia/json'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const j = json(helia)
+ * const cid = await j.put({
+ *   hello: 'world'
+ * })
+ * const obj = await j.get(cid)
+ *
+ * console.info(obj)
+ * // { hello: 'world' }
+ * ```
+ */
+
+import { CID } from 'multiformats/cid'
+import * as jsonCodec from 'multiformats/codecs/json'
+import { sha256 } from 'multiformats/hashes/sha2'
+import type { Blocks, GetBlockProgressEvents, PutBlockProgressEvents } from '@helia/interface/blocks'
+import type { AbortOptions } from '@libp2p/interfaces'
+import type { BlockCodec } from 'multiformats/codecs/interface'
+import type { MultihashHasher } from 'multiformats/hashes/interface'
+import type { ProgressOptions } from 'progress-events'
+
+export interface JSONComponents {
+  blockstore: Blocks
+}
+
+export interface AddOptions extends AbortOptions, ProgressOptions<PutBlockProgressEvents> {
+  hasher: MultihashHasher
+}
+
+export interface GetOptions extends AbortOptions, ProgressOptions<GetBlockProgressEvents> {
+  codec: BlockCodec<any, unknown>
+}
+
+/**
+ * The JSON interface provides a simple and intuitive way to add/get objects
+ * with your Helia node and is a great place to start learning about IPFS.
+ */
+export interface JSON {
+  /**
+   * Add an object to your Helia node and get a CID that refers to the block the
+   * object has been stored as.
+   *
+   * @example
+   *
+   * ```typescript
+   * import { json } from '@helia/json'
+   *
+   * const j = json(helia)
+   * const cid = await str.add({ hello: 'world' })
+   *
+   * console.info(cid)
+   * // CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+   * ```
+   */
+  add: (str: unknown, options?: Partial<AddOptions>) => Promise<CID>
+
+  /**
+   * Get an object from your Helia node, either previously added to it or to
+   * another node on the network.
+   *
+   * @example
+   *
+   * ```typescript
+   * import { json } from '@helia/json'
+   * import { CID } from 'multiformats/cid'
+   *
+   * const j = json(helia)
+   * const cid = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
+   * const obj = await j.get(cid)
+   *
+   * console.info(obj)
+   * // { hello: 'world' }
+   * ```
+   */
+  get: <T> (cid: CID, options?: Partial<GetOptions>) => Promise<T>
+}
+
+class DefaultJSON implements JSON {
+  private readonly components: JSONComponents
+
+  constructor (components: JSONComponents) {
+    this.components = components
+  }
+
+  async add (obj: any, options: Partial<AddOptions> = {}): Promise<CID> {
+    const buf = jsonCodec.encode(obj)
+    const hash = await (options.hasher ?? sha256).digest(buf)
+    const cid = CID.createV1(jsonCodec.code, hash)
+
+    await this.components.blockstore.put(cid, buf, options)
+
+    return cid
+  }
+
+  async get <T> (cid: CID, options: Partial<GetOptions> = {}): Promise<T> {
+    const buf = await this.components.blockstore.get(cid, options)
+
+    return jsonCodec.decode(buf)
+  }
+}
+
+/**
+ * Create a {@link JSON} instance for use with {@link https://github.com/ipfs/helia Helia}
+ */
+export function json (helia: { blockstore: Blocks }): JSON {
+  return new DefaultJSON(helia)
+}