@ipld/garbage 3.0.5

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,80 @@
+# ipld-garbage <!-- omit in toc -->
+
+[![codecov](https://img.shields.io/codecov/c/github/achingbrain/js-ipld-garbage.svg?style=flat-square)](https://codecov.io/gh/achingbrain/js-ipld-garbage)
+[![CI](https://img.shields.io/github/workflow/status/achingbrain/js-ipld-garbage/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/js-ipld-garbage/actions/workflows/js-test-and-release.yml)
+
+> Garbage data generator for the IPLD Data Model
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [API](#api)
+  - [`options`](#options)
+- [License](#license)
+- [Contribute](#contribute)
+
+## Install
+
+```console
+$ npm i ipld-garbage
+```
+
+Based on [substack's "garbage"](https://github.com/substack/node-garbage).
+
+## API
+
+`garbage(count = 200, options)`
+
+Where `count` determines the approximate target number of bytes a garbage object should consume. And `options` allows for a `weight` object that allows you to provide a number for each object type to weight the random garbage generator. By default, all object types are weighted equally (with a value of `1`), providing a number (>= `0`), you can adjust the liklihood that particular types will appear relative to the weights of the other types. A weighting of `0` will turn off that type entirely.
+
+### `options`
+
+- `options.weights` an object with properties matching the IPLD data model types (see below) with numbers (>= `0`) that will weight randomness selection. Default: `{ list: 1, map: 1, string: 1, bytes: 1, boolean: 1, integer: 1, float: 1, null: 1, CID: 1 }`.
+- `options.initialWeights` an object, similar to `options.weights`, that only applies to the initial object. Subsequent object creation will use `options.weights`. This allows for weighting of the container object to be more typical of IPLD data, which is typically some kind of map or list. Default `{ list: 10, map: 10, string: 1, bytes: 1, boolean: 1, integer: 1, float: 1, null: 1, CID: 1 }`.
+
+Where you provide a custom `weights`, it will override `initialWeights`. e.g. `{ weights: { float: 0 } }` will result in no floats at all, even for the initial object.
+
+```js
+import { garbage } from 'ipld-garbage'
+
+console.log(garbage(100, { weights: { float: 0, object: 0 }}))
+```
+
+Might yield:
+
+```js
+{
+  'QbN/}`EO\tb6>\tI,`': 7827882605575541,
+  "~'wD!☺S}<Q|d1$☺": Uint8Array(12) [
+    116,  12, 191, 180, 214,
+      0,  88,  26, 116, 213,
+     88, 109
+  ],
+  'q<': CID(baguqefrapdjrz7rknhnokqxo75ogs2hfpmdqiy7weez55ezaoyh63sd22n4q)
+}
+```
+
+All IPLD Data Model types are within range for random creation, including top-level returns (a single call to `garbage()` might just return a `null`):
+
+- null
+- boolean
+- integer
+- float
+- string
+- bytes
+- list
+- map
+- CID
+
+Use `import { toString } from 'ipld-garbage/to-string'` to import a function that can turn an object returned by `garbage()` to a JavaScript string. This may be useful for generating a fixed set of test fixtures rather than relying on randomness during each run.
+
+## 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
+
+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.

package/dist/index.min.js

@@ -0,0 +1,4 @@
+(function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.IpldGarbage = factory()}(typeof self !== 'undefined' ? self : this, function () {
+"use strict";var IpldGarbage=(()=>{var k=Object.defineProperty;var fe=Object.getOwnPropertyDescriptor;var le=Object.getOwnPropertyNames;var pe=Object.prototype.hasOwnProperty;var ue=(r,e)=>{for(var t in e)k(r,t,{get:e[t],enumerable:!0})},we=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of le(e))!pe.call(r,o)&&o!==t&&k(r,o,{get:()=>e[o],enumerable:!(n=fe(e,o))||n.enumerable});return r};var be=r=>we(k({},"__esModule",{value:!0}),r);var He={};ue(He,{garbage:()=>Ke});var ge=K,X=128,ye=127,me=~ye,xe=Math.pow(2,31);function K(r,e,t){e=e||[],t=t||0;for(var n=t;r>=xe;)e[t++]=r&255|X,r/=128;for(;r&me;)e[t++]=r&255|X,r>>>=7;return e[t]=r|0,K.bytes=t-n+1,e}var ve=F,Ae=128,Q=127;function F(r,n){var t=0,n=n||0,o=0,s=n,i,a=r.length;do{if(s>=a)throw F.bytes=0,new RangeError("Could not decode varint");i=r[s++],t+=o<28?(i&Q)<<o:(i&Q)*Math.pow(2,o),o+=7}while(i>=Ae);return F.bytes=s-n,t}var Ee=Math.pow(2,7),Me=Math.pow(2,14),Se=Math.pow(2,21),ze=Math.pow(2,28),Ue=Math.pow(2,35),Ce=Math.pow(2,42),Oe=Math.pow(2,49),Ne=Math.pow(2,56),Te=Math.pow(2,63),Ie=function(r){return r<Ee?1:r<Me?2:r<Se?3:r<ze?4:r<Ue?5:r<Ce?6:r<Oe?7:r<Ne?8:r<Te?9:10},Le={encode:ge,decode:ve,encodingLength:Ie},Ve=Le,N=Ve;var T=(r,e=0)=>[N.decode(r,e),N.decode.bytes],z=(r,e,t=0)=>(N.encode(r,e,t),e),U=r=>N.encodingLength(r);var tt=new Uint8Array(0);var H=(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},C=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 D=(r,e)=>{let t=e.byteLength,n=U(r),o=n+U(t),s=new Uint8Array(o+t);return z(r,s,0),z(t,s,n),s.set(e,o),new O(r,t,e,s)},Y=r=>{let e=C(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 O(t,o,i,e)},_=(r,e)=>{if(r===e)return!0;{let t=e;return r.code===t.code&&r.size===t.size&&t.bytes instanceof Uint8Array&&H(r.bytes,t.bytes)}},O=class{constructor(e,t,n,o){this.code=e,this.size=t,this.digest=n,this.bytes=o}};function De(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),M=Math.log(a)/Math.log(256),l=Math.log(256)/Math.log(a);function S(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,E=0,u=0,b=c.length;u!==b&&c[u]===0;)u++,f++;for(var g=(b-u)*l+1>>>0,p=new Uint8Array(g);u!==b;){for(var y=c[u],A=0,w=g-1;(y!==0||A<E)&&w!==-1;w--,A++)y+=256*p[w]>>>0,p[w]=y%a>>>0,y=y/a>>>0;if(y!==0)throw new Error("Non-zero carry");E=A,u++}for(var x=g-E;x!==g&&p[x]===0;)x++;for(var B=h.repeat(f);x<g;++x)B+=r.charAt(p[x]);return B}function V(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 E=0,u=0;c[f]===h;)E++,f++;for(var b=(c.length-f)*M+1>>>0,g=new Uint8Array(b);c[f];){var p=t[c.charCodeAt(f)];if(p===255)return;for(var y=0,A=b-1;(p!==0||y<u)&&A!==-1;A--,y++)p+=a*g[A]>>>0,g[A]=p%256>>>0,p=p/256>>>0;if(p!==0)throw new Error("Non-zero carry");u=y,f++}if(c[f]!==" "){for(var w=b-u;w!==b&&g[w]===0;)w++;for(var x=new Uint8Array(E+(b-w)),B=E;w!==b;)x[B++]=g[w++];return x}}}function de(c){var f=V(c);if(f)return f;throw new Error(`Non-${e} character`)}return{encode:S,decodeUnsafe:V,decode:de}}var $e=De,ke=$e,ee=ke;var q=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")}},R=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 te(this,e)}},j=class{constructor(e){this.decoders=e}or(e){return te(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`)}},te=(r,e)=>new j({...r.decoders||{[r.prefix]:r},...e.decoders||{[e.prefix]:e}}),P=class{constructor(e,t,n,o){this.name=e,this.prefix=t,this.baseEncode=n,this.baseDecode=o,this.encoder=new q(e,t,n),this.decoder=new R(e,t,o)}encode(e){return this.encoder.encode(e)}decode(e){return this.decoder.decode(e)}},re=({name:r,prefix:e,encode:t,decode:n})=>new P(r,e,t,n),W=({prefix:r,name:e,alphabet:t})=>{let{encode:n,decode:o}=ee(t,e);return re({prefix:r,name:e,encode:n,decode:s=>C(o(s))})},Fe=(r,e,t,n)=>{let o={};for(let l=0;l<e.length;++l)o[e[l]]=l;let s=r.length;for(;r[s-1]==="=";)--s;let i=new Uint8Array(s*t/8|0),a=0,h=0,M=0;for(let l=0;l<s;++l){let S=o[r[l]];if(S===void 0)throw new SyntaxError(`Non-${n} character`);h=h<<t|S,a+=t,a>=8&&(a-=8,i[M++]=255&h>>a)}if(a>=t||255&h<<8-a)throw new SyntaxError("Unexpected end of data");return i},qe=(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})=>re({prefix:e,name:r,encode(o){return qe(o,n,t)},decode(o){return Fe(o,n,t,r)}});var v=W({name:"base58btc",prefix:"z",alphabet:"123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"}),ht=W({name:"base58flickr",prefix:"Z",alphabet:"123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"});var I=m({prefix:"b",name:"base32",alphabet:"abcdefghijklmnopqrstuvwxyz234567",bitsPerChar:5}),lt=m({prefix:"B",name:"base32upper",alphabet:"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567",bitsPerChar:5}),pt=m({prefix:"c",name:"base32pad",alphabet:"abcdefghijklmnopqrstuvwxyz234567=",bitsPerChar:5}),ut=m({prefix:"C",name:"base32padupper",alphabet:"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567=",bitsPerChar:5}),wt=m({prefix:"v",name:"base32hex",alphabet:"0123456789abcdefghijklmnopqrstuv",bitsPerChar:5}),bt=m({prefix:"V",name:"base32hexupper",alphabet:"0123456789ABCDEFGHIJKLMNOPQRSTUV",bitsPerChar:5}),gt=m({prefix:"t",name:"base32hexpad",alphabet:"0123456789abcdefghijklmnopqrstuv=",bitsPerChar:5}),yt=m({prefix:"T",name:"base32hexpadupper",alphabet:"0123456789ABCDEFGHIJKLMNOPQRSTUV=",bitsPerChar:5}),mt=m({prefix:"h",name:"base32z",alphabet:"ybndrfg8ejkmcpqxot1uwisza345h769",bitsPerChar:5});var Re=(r,e)=>{let{bytes:t,version:n}=r;switch(n){case 0:return Pe(t,J(r),e||v.encoder);default:return We(t,J(r),e||I.encoder)}},ne=new WeakMap,J=r=>{let e=ne.get(r);if(e==null){let t=new Map;return ne.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.asCID=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!==Je)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=D(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&&_(e.multihash,n.multihash)}toString(e){return Re(this,e)}toJSON(){return{code:this.code,version:this.version,hash:this.multihash.bytes}}link(){return this}get[Symbol.toStringTag](){return"CID"}[Symbol.for("nodejs.util.inspect.custom")](){return`CID(${this.toString()})`}static asCID(e){let t=e;if(t instanceof d)return t;if(t!=null&&t.asCID===t){let{version:n,code:o,multihash:s,bytes:i}=t;return new d(n,o,s,i||oe(n,o,s.bytes))}else if(t!=null&&t[Ge]===!0){let{version:n,multihash:o,code:s}=t,i=Y(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=oe(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=C(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 O(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[S,V]=T(e.subarray(t));return t+=V,S},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(),M=t+h,l=M-i;return{version:o,codec:s,multihashCode:a,digestSize:h,multihashSize:l,size:M}}static parse(e,t){let[n,o]=je(e,t),s=d.decode(o);return J(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 I.prefix:{let t=e||I;return[I.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},We=(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,Je=18,oe=(r,e,t)=>{let n=U(r),o=n+U(e),s=new Uint8Array(o+t.byteLength);return z(r,s,0),z(e,s,n),s.set(t,o),s},Ge=Symbol.for("@ipld/js-cid/CID");var Xe=["list","map","string","bytes","boolean","integer","float","null","CID"],se=[85,112,113,297],ie=[[18,256],[22,256],[27,256],[45600,256],[19,512],[21,384],[20,512]],ae=`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\`~!@#$%^&*()-_=+[]{}|\\:;'",.<>?/ 	
+\u263A`,Qe={initialWeights:{map:10,list:10}};function Ke(r=200,e){return e=Object.assign({},Qe,e),G(r,e)[1]}function G(r,e){let t=0,n=Object.assign({},e.initialWeights,e.weights||{});e.initialWeights&&(e=Object.assign(e,{initialWeights:null}));let o=Xe.map(a=>{let h=n&&typeof n[a]=="number"?n[a]:1;if(h<0)throw new TypeError("Cannot have a negative weight");return t+=h,[a,h]});if(t===0)throw new Error("Cannot have a total weight of zero");let s=Math.random()*t,i=0;for(let[a,h]of o)if(i+=h,i>=s)return he[a](r,e);throw new Error("Internal error")}function $(r=5){return Math.abs(Math.floor(5/(1-Math.random()**2)-5+Math.random()*r))}function Ze(){return ae.charAt(Math.floor(Math.random()*ae.length))}function ce(){return Math.floor(Math.random()*256)}var he={list(r,e){let t=[],n=$(),o=0;for(let s=0;s<n&&o<r;s++){let i=G(r-o,e);t.push(i[1]),o+=i[0]}return[o,t]},map(r,e){let t={},n=$(),o=0;for(let s=0;s<n&&o<r;s++){let i=he.string(5)[1],a=G(r-o,e);t[i]=a[1],o+=a[0]+i.length}return[o,t]},string(r=50){let e=$(r),t=[];for(let n=0;n<e;n++)t.push(Ze());return[e,t.join("")]},bytes(r=50){let e=$(r),t=new Uint8Array(e);for(let n=0;n<e;n++)t[n]=ce();return[e,t]},boolean(){return[1,Math.random()>.5]},integer(){return[1,Math.floor(Number.MAX_SAFE_INTEGER*Math.random())*(Math.random()<.5?-1:1)]},float(){return[1,Math.tan((Math.random()-.5)*Math.PI)]},null(){return[1,null]},CID(){let r=ie[Math.floor(Math.random()*ie.length)],e=se[Math.floor(Math.random()*se.length)],t=new Uint8Array(r[1]/8);for(let n=0;n<t.length;n++)t[n]=ce();return[t.length,d.create(1,e,D(r[0],t))]}};return be(He);})();
+return IpldGarbage}));

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {number} [count=200]
+ * @param {import('./interface').GarbageOptions} [options]
+ * @returns {any}
+ */
+export function garbage(count?: number | undefined, options?: import("./interface").GarbageOptions | undefined): any;
+//# 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.js"],"names":[],"mappings":"AASA;;;;GAIG;AACH,iHAFa,GAAG,CAKf"}

package/dist/src/interface.d.ts

@@ -0,0 +1,16 @@
+export interface GarbageWeights {
+    list?: number;
+    map?: number;
+    string?: number;
+    bytes?: number;
+    boolean?: number;
+    integer?: number;
+    float?: number;
+    null?: number;
+    CID?: number;
+}
+export interface GarbageOptions {
+    initialWeights?: GarbageWeights;
+    weights?: GarbageWeights;
+}
+//# sourceMappingURL=interface.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AACD,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB"}

package/dist/src/to-string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @param {any} obj
+ * @returns {string}
+ */
+export function toString(obj: any): string;
+//# sourceMappingURL=to-string.d.ts.map

package/dist/src/to-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-string.d.ts","sourceRoot":"","sources":["../../src/to-string.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,8BAHW,GAAG,GACD,MAAM,CA6BlB"}

package/package.json

@@ -0,0 +1,170 @@
+{
+  "name": "@ipld/garbage",
+  "version": "3.0.5",
+  "description": "Garbage data generator for the IPLD Data Model",
+  "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/achingbrain/js-ipld-garbage#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/achingbrain/js-ipld-garbage.git"
+  },
+  "bugs": {
+    "url": "https://github.com/achingbrain/js-ipld-garbage/issues"
+  },
+  "keywords": [
+    "IPLD",
+    "garbage"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./to-string": {
+      "types": "./src/to-string.d.ts",
+      "import": "./src/to-string.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "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",
+    "build": "aegir build",
+    "release": "aegir release",
+    "test": "npm run lint && aegir test",
+    "test:ts": "npm run test --prefix test/ts-use",
+    "test:node": "aegir test -t node --cov",
+    "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:electron-main": "aegir test -t electron-main",
+    "dep-check": "aegir dep-check"
+  },
+  "dependencies": {
+    "multiformats": "^10.0.1"
+  },
+  "devDependencies": {
+    "@sindresorhus/is": "^5.3.0",
+    "aegir": "^37.5.6"
+  }
+}

package/src/index.js

@@ -0,0 +1,173 @@
+// based on https://github.com/substack/node-garbage/blob/master/index.js
+import { CID } from 'multiformats/cid'
+import { create as createDigest } from 'multiformats/hashes/digest'
+
+const kinds = ['list', 'map', 'string', 'bytes', 'boolean', 'integer', 'float', 'null', 'CID']
+const codecs = [0x55, 0x70, 0x71, 0x0129]
+const hashes = [[0x12, 256], [0x16, 256], [0x1b, 256], [0xb220, 256], [0x13, 512], [0x15, 384], [0x14, 512]]
+const charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789`~!@#$%^&*()-_=+[]{}|\\:;\'",.<>?/ \t\n\u263a'
+const baseOptions = { initialWeights: { map: 10, list: 10 } }
+/**
+ * @param {number} [count=200]
+ * @param {import('./interface').GarbageOptions} [options]
+ * @returns {any}
+ */
+export function garbage (count = 200, options) {
+  options = Object.assign({}, baseOptions, options)
+  return generate(count, options)[1]
+}
+
+/**
+ * @param {number} count
+ * @param {import('./interface').GarbageOptions} options
+ * @returns {any}
+ */
+function generate (count, options) {
+  let totWeight = 0
+  const weights = Object.assign({}, options.initialWeights, options.weights || {})
+  if (options.initialWeights) {
+    options = Object.assign(options, { initialWeights: null })
+  }
+  const types = kinds.map((t) => {
+    /* c8 ignore next 5 */
+    // @ts-ignore not sure why I can't index with [t] from a fixed list of properties
+    const weight = weights && typeof weights[t] === 'number' ? weights[t] : 1
+    if (weight < 0) {
+      throw new TypeError('Cannot have a negative weight')
+    }
+    totWeight += weight
+    return [t, weight]
+  })
+  /* c8 ignore next 3 */
+  if (totWeight === 0) {
+    throw new Error('Cannot have a total weight of zero')
+  }
+  const rnd = Math.random() * totWeight
+  let wacc = 0
+  for (const [type, weight] of types) {
+    wacc += weight
+    if (wacc >= rnd) {
+      // @ts-ignore not sure why I can't index with [t] from a fixed list of properties
+      return generators[type](count, options)
+    }
+  }
+  /* c8 ignore next 1 */
+  throw new Error('Internal error')
+}
+
+function rndSize (bias = 5) {
+  return Math.abs(Math.floor(5 / (1 - (Math.random() ** 2)) - 5 + Math.random() * bias))
+}
+
+function rndChar () {
+  return charset.charAt(Math.floor(Math.random() * charset.length))
+}
+
+function rndByte () {
+  return Math.floor(Math.random() * 256)
+}
+
+const generators = {
+  /**
+   * @param {number} count
+   * @param {import('./interface').GarbageOptions} options
+   * @returns {[number, Array<any>]}
+   */
+  list (count, options) {
+    const res = []
+    const len = rndSize()
+    let size = 0
+    for (let i = 0; i < len && size < count; i++) {
+      const x = generate(count - size, options)
+      res.push(x[1])
+      size += x[0]
+    }
+    return [size, res]
+  },
+
+  /**
+   * @param {number} count
+   * @param {import('./interface').GarbageOptions} options
+   * @returns {[number, {[key: string]: any}]}
+   */
+  map (count, options) {
+    /** @type {{[key: string]: any}} */
+    const res = {}
+    const len = rndSize()
+    let size = 0
+    for (let i = 0; i < len && size < count; i++) {
+      const key = /** @type {keyof typeof res} */ generators.string(5)[1]
+      const x = generate(count - size, options)
+      res[key] = x[1]
+      size += x[0] + key.length
+    }
+    return [size, res]
+  },
+
+  /**
+   * @param {number} [bias=50]
+   * @returns {[number, string]}
+   */
+  string (bias = 50) {
+    const len = rndSize(bias)
+    const res = []
+    for (let i = 0; i < len; i++) {
+      res.push(rndChar())
+    }
+    return [len, res.join('')]
+  },
+
+  /**
+   * @param {number} [bias=50]
+   * @returns {[number, Uint8Array]}
+   */
+  bytes (bias = 50) {
+    const len = rndSize(bias)
+    const res = new Uint8Array(len)
+    for (let i = 0; i < len; i++) {
+      res[i] = rndByte()
+    }
+    return [len, res]
+  },
+
+  /**
+   * @returns {[1, boolean]}
+   */
+  boolean  () {
+    return [1, Math.random() > 0.5]
+  },
+
+  /**
+   * @returns {[1, number]}
+   */
+  integer () {
+    return [1, Math.floor(Number.MAX_SAFE_INTEGER * Math.random()) * (Math.random() < 0.5 ? -1 : 1)]
+  },
+
+  /**
+   * @returns {[1, number]}
+   */
+  float () {
+    return [1, Math.tan((Math.random() - 0.5) * Math.PI)]
+  },
+
+  /**
+   * @returns {[1, null]}
+   */
+  null () {
+    return [1, null]
+  },
+
+  /**
+   * @returns {[number, CID]}
+   */
+  CID () {
+    const hasher = hashes[Math.floor(Math.random() * hashes.length)]
+    const codec = codecs[Math.floor(Math.random() * codecs.length)]
+    const bytes = new Uint8Array(hasher[1] / 8)
+    for (let i = 0; i < bytes.length; i++) {
+      bytes[i] = rndByte()
+    }
+    return [bytes.length, CID.create(1, codec, createDigest(hasher[0], bytes))]
+  }
+}

package/src/interface.ts

@@ -0,0 +1,15 @@
+export interface GarbageWeights {
+  list?: number
+  map?: number
+  string?: number
+  bytes?: number
+  boolean?: number
+  integer?: number
+  float?: number
+  null?: number
+  CID?: number
+}
+export interface GarbageOptions {
+  initialWeights?: GarbageWeights
+  weights?: GarbageWeights
+}

package/src/to-string.js

@@ -0,0 +1,36 @@
+import { CID } from 'multiformats/cid'
+
+/**
+ * @param {any} obj
+ * @returns {string}
+ */
+export function toString (obj) {
+  if (CID.asCID(obj)) {
+    return `CID.parse('${obj.toString()}')`
+  }
+  if (obj === null) {
+    return 'null'
+  }
+  const typ = typeof obj
+  if (typ === 'string') {
+    return `'${JSON.stringify(obj).replace(/^"|"$/g, '').replace(/'/g, '\\\'')}'`
+  }
+  if (typ === 'number' || typ === 'boolean') {
+    return String(obj)
+  }
+  if (Array.isArray(obj)) {
+    return `[${obj.map(toString).join(',')}]`
+  }
+  if (obj instanceof Uint8Array) {
+    return `Uint8Array.from([${obj.join(',')}])`
+  }
+  if (typ === 'object') {
+    const props = Object.entries(obj).map(([key, value]) => {
+      return `[${toString(key)}]: ${toString(value)}`
+    })
+    return `{${props.join(',')}}`
+  }
+  throw new Error(`Invalid IPLD kind: ${Object.prototype.toString.call(obj)}`)
+}
+
+// console.log(toString(garbage(100, { weights: { list: 0 } })))