@atcute/cid 1.0.3 → 2.0.1

package/README.md

@@ -1,14 +1,18 @@
 # @atcute/cid
 
-CIDv1 codec library.
+lightweight [DASL CID][dasl-cid] codec library for AT Protocol.
+
+[dasl-cid]: https://dasl.ing/cid.html
 
 ```ts
-const parsed = parse('bafyreihffx5a2e7k5uwrmmgofbvzujc5cmw5h4espouwuxt3liqoflx3ee');
-//    ^? { version: 1, code: 113, digest: { ... }, bytes: Uint8Array(36) }
+import * as CID from '@atcute/cid';
+
+const cid = CID.fromString('bafyreihffx5a2e7k5uwrmmgofbvzujc5cmw5h4espouwuxt3liqoflx3ee');
+//    ^? { version: 1, codec: 113, digest: { ... }, bytes: Uint8Array(36) }
 
 // Creating a CID containing CBOR data
-const cid = await create(0x71, buffer);
+const cid = await CID.create(0x71, buffer);
 
 // Serializing CID into string
-format(cid); // -> bafyrei...
+CID.toString(cid); // -> bafyrei...
 ```

package/dist/cid-link.d.ts

@@ -0,0 +1,13 @@
+import { type Cid } from './codec.js';
+export interface CidLink {
+    $link: string;
+}
+export declare class CidLinkWrapper implements CidLink {
+    bytes: Uint8Array;
+    constructor(bytes: Uint8Array);
+    get $link(): string;
+    toJSON(): CidLink;
+}
+export declare const isCidLink: (value: unknown) => value is CidLink;
+export declare const toCidLink: (cid: Cid) => CidLink;
+export declare const fromCidLink: (link: CidLink) => Cid;

package/dist/cid-link.js

@@ -0,0 +1,30 @@
+import { toBase32 } from '@atcute/multibase';
+import { decode, fromString } from './codec.js';
+export class CidLinkWrapper {
+    bytes;
+    constructor(bytes) {
+        this.bytes = bytes;
+    }
+    get $link() {
+        const encoded = toBase32(this.bytes);
+        return `b${encoded}`;
+    }
+    toJSON() {
+        return { $link: this.$link };
+    }
+}
+export const isCidLink = (value) => {
+    const val = value;
+    return (val instanceof CidLinkWrapper ||
+        (val !== null && typeof val === 'object' && typeof val.$link === 'string'));
+};
+export const toCidLink = (cid) => {
+    return new CidLinkWrapper(cid.bytes);
+};
+export const fromCidLink = (link) => {
+    if (link instanceof CidLinkWrapper) {
+        return decode(link.bytes);
+    }
+    return fromString(link.$link);
+};
+//# sourceMappingURL=cid-link.js.map

package/dist/cid-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cid-link.js","sourceRoot":"","sources":["../lib/cid-link.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,UAAU,EAAY,MAAM,YAAY,CAAC;AAM1D,MAAM,OAAO,cAAc;IACP;IAAnB,YAAmB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAExC,IAAI,KAAK;QACR,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,IAAI,OAAO,EAAE,CAAC;IACtB,CAAC;IAED,MAAM;QACL,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;CACD;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAc,EAAoB,EAAE;IAC7D,MAAM,GAAG,GAAG,KAAY,CAAC;IAEzB,OAAO,CACN,GAAG,YAAY,cAAc;QAC7B,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAC1E,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAQ,EAAW,EAAE;IAC9C,OAAO,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAa,EAAO,EAAE;IACjD,IAAI,IAAI,YAAY,cAAc,EAAE,CAAC;QACpC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC,CAAC"}

package/dist/codec.d.ts

@@ -0,0 +1,31 @@
+export declare const CID_VERSION = 1;
+export declare const HASH_SHA256 = 18;
+export declare const CODEC_RAW = 85;
+export declare const CODEC_DCBOR = 113;
+/**
+ * Represents a Content Identifier (CID), in particular, a limited subset of
+ * CIDv1 as described by DASL specifications.
+ * https://dasl.ing/cid.html
+ */
+export interface Cid {
+    /** CID version, this is always `1` for CIDv1 */
+    version: number;
+    /** Multicodec type for the data, can be `0x55` for raw data or `0x71` for DAG-CBOR */
+    codec: number;
+    /** Digest contents */
+    digest: {
+        /** Multicodec type for the digest, this is always `0x12` for SHA-256 */
+        codec: number;
+        /** Raw hash bytes */
+        contents: Uint8Array;
+    };
+    /** Raw CID bytes */
+    bytes: Uint8Array;
+}
+export declare const create: (codec: 85 | 113, data: Uint8Array) => Promise<Cid>;
+export declare const decodeFirst: (bytes: Uint8Array) => [decoded: Cid, remainder: Uint8Array];
+export declare const decode: (bytes: Uint8Array) => Cid;
+export declare const fromString: (input: string) => Cid;
+export declare const toString: (cid: Cid) => string;
+export declare const fromBinary: (input: Uint8Array) => Cid;
+export declare const toBinary: (cid: Cid) => Uint8Array;

package/dist/codec.js

@@ -0,0 +1,95 @@
+import { fromBase32, toBase32 } from '@atcute/multibase';
+import * as varint from '@atcute/varint';
+export const CID_VERSION = 1;
+export const HASH_SHA256 = 0x12;
+export const CODEC_RAW = 0x55;
+export const CODEC_DCBOR = 0x71;
+export const create = async (codec, data) => {
+    const digest = new Uint8Array(await crypto.subtle.digest('sha-256', data));
+    const digestSize = digest.length;
+    const digestLebSize = varint.encodingLength(digestSize);
+    const bytes = new Uint8Array(3 + digestLebSize + digestSize);
+    bytes[0] = CID_VERSION;
+    bytes[1] = codec;
+    bytes[2] = HASH_SHA256;
+    varint.encode(digestSize, bytes, 3);
+    bytes.set(digest, 3 + digestLebSize);
+    const cid = {
+        version: CID_VERSION,
+        codec: codec,
+        digest: {
+            codec: HASH_SHA256,
+            contents: digest,
+        },
+        bytes: bytes,
+    };
+    return cid;
+};
+export const decodeFirst = (bytes) => {
+    const length = bytes.length;
+    if (length < 5) {
+        throw new RangeError(`cid too short`);
+    }
+    const version = bytes[0];
+    const codec = bytes[1];
+    const digestCodec = bytes[2];
+    if (version !== CID_VERSION) {
+        throw new RangeError(`incorrect cid version (got v${version})`);
+    }
+    if (codec !== CODEC_DCBOR && codec !== CODEC_RAW) {
+        throw new RangeError(`incorrect cid codec (got 0x${codec.toString(16)})`);
+    }
+    if (digestCodec !== HASH_SHA256) {
+        throw new RangeError(`incorrect cid hash type (got 0x${digestCodec.toString(16)})`);
+    }
+    const [digestSize, digestLebSize] = varint.decode(bytes, 3);
+    const digestOffset = 3 + digestLebSize;
+    if (length - digestOffset < digestSize) {
+        throw new RangeError(`digest too short (expected ${digestSize} bytes; got ${length - digestOffset})`);
+    }
+    const remainder = bytes.subarray(digestOffset + digestSize);
+    const cid = {
+        version: CID_VERSION,
+        codec: codec,
+        digest: {
+            codec: digestCodec,
+            contents: bytes.subarray(digestOffset, digestOffset + digestSize),
+        },
+        bytes: bytes.subarray(0, digestOffset + digestSize),
+    };
+    return [cid, remainder];
+};
+export const decode = (bytes) => {
+    const [cid, remainder] = decodeFirst(bytes);
+    if (remainder.length !== 0) {
+        throw new RangeError(`cid bytes includes remainder`);
+    }
+    return cid;
+};
+export const fromString = (input) => {
+    if (input.length < 2 || input[0] !== 'b') {
+        throw new SyntaxError(`not a multibase base32 string`);
+    }
+    const bytes = fromBase32(input.slice(1));
+    return decode(bytes);
+};
+export const toString = (cid) => {
+    const encoded = toBase32(cid.bytes);
+    return `b${encoded}`;
+};
+export const fromBinary = (input) => {
+    if (input.length < 2) {
+        throw new RangeError(`cid bytes too short`);
+    }
+    if (input[0] !== 0) {
+        throw new SyntaxError(`incorrect binary cid`);
+    }
+    const bytes = input.subarray(1);
+    return decode(bytes);
+};
+export const toBinary = (cid) => {
+    const bytes = new Uint8Array(1 + cid.bytes.length);
+    bytes.set(cid.bytes, 1);
+    return bytes;
+};
+//# sourceMappingURL=codec.js.map

package/dist/codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.js","sourceRoot":"","sources":["../lib/codec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAEzC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC;AAC7B,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC;AAEhC,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC;AAuBhC,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,KAAkB,EAAE,IAAgB,EAAgB,EAAE;IAClF,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAE3E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;IAE7D,KAAK,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IACvB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;IACjB,KAAK,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IAEvB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC;IAErC,MAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE;YACP,KAAK,EAAE,WAAW;YAClB,QAAQ,EAAE,MAAM;SAChB;QACD,KAAK,EAAE,KAAK;KACZ,CAAC;IAEF,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAyC,EAAE;IACvF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAE5B,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,UAAU,CAAC,eAAe,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE7B,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;QAC7B,MAAM,IAAI,UAAU,CAAC,+BAA+B,OAAO,GAAG,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAClD,MAAM,IAAI,UAAU,CAAC,8BAA8B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,WAAW,KAAK,WAAW,EAAE,CAAC;QACjC,MAAM,IAAI,UAAU,CAAC,kCAAkC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC5D,MAAM,YAAY,GAAG,CAAC,GAAG,aAAa,CAAC;IAEvC,IAAI,MAAM,GAAG,YAAY,GAAG,UAAU,EAAE,CAAC;QACxC,MAAM,IAAI,UAAU,CAAC,8BAA8B,UAAU,eAAe,MAAM,GAAG,YAAY,GAAG,CAAC,CAAC;IACvG,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,YAAY,GAAG,UAAU,CAAC,CAAC;IAE5D,MAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE;YACP,KAAK,EAAE,WAAW;YAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,UAAU,CAAC;SACjE;QACD,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;KACnD,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAiB,EAAO,EAAE;IAChD,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAO,EAAE;IAChD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QAC1C,MAAM,IAAI,WAAW,CAAC,+BAA+B,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAQ,EAAU,EAAE;IAC5C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,IAAI,OAAO,EAAE,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAO,EAAE;IACpD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAChC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAQ,EAAc,EAAE;IAChD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnD,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAExB,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,67 +1,2 @@
-/**
- * @module
- * Bare minimum implementation for creating, parsing, and formatting
- * AT Protocol-blessed CIDv1 format.
- *
- * As specified by AT Protocol, the blessed format is:
- * - Multibase: `base32` (b)
- * - Multicodec: `dag-cbor` (0x71) for record, `raw` (0x55) for blobs
- * - Multihash: `sha-256` (0x12)
- */
-/**
- * Raw digest information
- */
-export interface Digest {
-    code: number;
-    size: number;
-    digest: Uint8Array;
-    bytes: Uint8Array;
-}
-/**
- * CID information
- */
-export interface CID {
-    version: number;
-    code: number;
-    digest: Digest;
-    bytes: Uint8Array;
-}
-/**
- * Information regarding CID buffer being inspected
- */
-export interface InspectedCID {
-    version: number;
-    codec: number;
-    multihashCode: number;
-    digestSize: number;
-    multihashSize: number;
-    size: number;
-}
-/**
- * Parse a CID string
- */
-export declare const parse: (cid: string) => CID;
-/**
- * Provides information regarding the CID buffer
- */
-export declare const inspect: (initialBytes: Uint8Array) => InspectedCID;
-/**
- * Decode the first CID contained, and return the remainder.
- * @param bytes Buffer to decode
- * @returns A tuple containing the first CID in the buffer, and the remainder
- */
-export declare const decodeFirst: (bytes: Uint8Array) => [cid: CID, remainder: Uint8Array];
-/**
- * Decodes a CID buffer
- */
-export declare const decode: (bytes: Uint8Array) => CID;
-/**
- * Creates a CID
- */
-export declare const create: (code: number, input: Uint8Array) => Promise<CID>;
-/**
- * Serialize CID into a string
- */
-export declare const format: (cid: CID) => string;
-export declare const createDigest: (code: number, digest: Uint8Array) => Digest;
-export declare const encode: (version: number, code: number, multihash: Uint8Array) => Uint8Array;
+export * from './cid-link.js';
+export * from './codec.js';

package/dist/index.js

@@ -1,133 +1,3 @@
-/**
- * @module
- * Bare minimum implementation for creating, parsing, and formatting
- * AT Protocol-blessed CIDv1 format.
- *
- * As specified by AT Protocol, the blessed format is:
- * - Multibase: `base32` (b)
- * - Multicodec: `dag-cbor` (0x71) for record, `raw` (0x55) for blobs
- * - Multihash: `sha-256` (0x12)
- */
-import { fromBase32, toBase32 } from '@atcute/multibase';
-import * as varint from '@atcute/varint';
-/**
- * Parse a CID string
- */
-export const parse = (cid) => {
-    if (cid[0] !== 'b') {
-        throw new Error(`only base32 cidv1 is supported`);
-    }
-    const bytes = fromBase32(cid.slice(1));
-    return decode(bytes);
-};
-/**
- * Provides information regarding the CID buffer
- */
-export const inspect = (initialBytes) => {
-    let offset = 0;
-    const next = () => {
-        const [i, length] = varint.decode(initialBytes.subarray(offset));
-        offset += length;
-        return i;
-    };
-    let version = next();
-    let codec = 0x70; // dag-pb
-    if (version === 18) {
-        // CIDv0
-        version = 0;
-        offset = 0;
-    }
-    else {
-        codec = next();
-    }
-    if (version !== 1) {
-        throw new RangeError(`only cidv1 is supported`);
-    }
-    const prefixSize = offset;
-    const multihashCode = next();
-    const digestSize = next();
-    const size = offset + digestSize;
-    const multihashSize = size - prefixSize;
-    return { version, codec, multihashCode, digestSize, multihashSize, size };
-};
-/**
- * Decode the first CID contained, and return the remainder.
- * @param bytes Buffer to decode
- * @returns A tuple containing the first CID in the buffer, and the remainder
- */
-export const decodeFirst = (bytes) => {
-    const specs = inspect(bytes);
-    const prefixSize = specs.size - specs.multihashSize;
-    const multihashBytes = bytes.subarray(prefixSize, prefixSize + specs.multihashSize);
-    if (multihashBytes.byteLength !== specs.multihashSize) {
-        throw new RangeError('incorrect cid length');
-    }
-    const digestBytes = multihashBytes.subarray(specs.multihashSize - specs.digestSize);
-    const digest = {
-        code: specs.multihashCode,
-        size: specs.multihashSize,
-        digest: digestBytes,
-        bytes: multihashBytes,
-    };
-    const cid = {
-        version: 1,
-        code: specs.codec,
-        digest: digest,
-        bytes: bytes.subarray(0, specs.size),
-    };
-    return [cid, bytes.subarray(specs.size)];
-};
-/**
- * Decodes a CID buffer
- */
-export const decode = (bytes) => {
-    const [cid, remainder] = decodeFirst(bytes);
-    if (remainder.length !== 0) {
-        throw new Error(`incorrect cid length`);
-    }
-    return cid;
-};
-/**
- * Creates a CID
- */
-export const create = async (code, input) => {
-    const digest = createDigest(0x12, new Uint8Array(await crypto.subtle.digest('sha-256', input)));
-    const bytes = encode(1, code, digest.bytes);
-    return {
-        version: 1,
-        code: code,
-        digest: digest,
-        bytes: bytes,
-    };
-};
-/**
- * Serialize CID into a string
- */
-export const format = (cid) => {
-    return 'b' + toBase32(cid.bytes);
-};
-export const createDigest = (code, digest) => {
-    const size = digest.byteLength;
-    const sizeOffset = varint.encodingLength(code);
-    const digestOffset = sizeOffset + varint.encodingLength(size);
-    const bytes = new Uint8Array(digestOffset + size);
-    varint.encode(code, bytes, 0);
-    varint.encode(size, bytes, sizeOffset);
-    bytes.set(digest, digestOffset);
-    return {
-        code: code,
-        size: size,
-        digest: digest,
-        bytes: bytes,
-    };
-};
-export const encode = (version, code, multihash) => {
-    const codeOffset = varint.encodingLength(version);
-    const hashOffset = codeOffset + varint.encodingLength(code);
-    const bytes = new Uint8Array(hashOffset + multihash.byteLength);
-    varint.encode(version, bytes, 0);
-    varint.encode(code, bytes, codeOffset);
-    bytes.set(multihash, hashOffset);
-    return bytes;
-};
+export * from './cid-link.js';
+export * from './codec.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAkCzC;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,GAAW,EAAO,EAAE;IACzC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,YAAwB,EAAgB,EAAE;IACjE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,IAAI,GAAG,GAAW,EAAE;QACzB,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,MAAM,IAAI,MAAM,CAAC;QACjB,OAAO,CAAC,CAAC;IACV,CAAC,CAAC;IAEF,IAAI,OAAO,GAAG,IAAI,EAAE,CAAC;IACrB,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,SAAS;IAC3B,IAAK,OAAkB,KAAK,EAAE,EAAE,CAAC;QAChC,QAAQ;QACR,OAAO,GAAG,CAAC,CAAC;QACZ,MAAM,GAAG,CAAC,CAAC;IACZ,CAAC;SAAM,CAAC;QACP,KAAK,GAAG,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC;IAC1B,MAAM,aAAa,GAAG,IAAI,EAAE,CAAC;IAC7B,MAAM,UAAU,GAAG,IAAI,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;IACjC,MAAM,aAAa,GAAG,IAAI,GAAG,UAAU,CAAC;IAExC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AAC3E,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAqC,EAAE;IACnF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC;IACpD,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IAEpF,IAAI,cAAc,CAAC,UAAU,KAAK,KAAK,CAAC,aAAa,EAAE,CAAC;QACvD,MAAM,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAEpF,MAAM,MAAM,GAAW;QACtB,IAAI,EAAE,KAAK,CAAC,aAAa;QACzB,IAAI,EAAE,KAAK,CAAC,aAAa;QACzB,MAAM,EAAE,WAAW;QACnB,KAAK,EAAE,cAAc;KACrB,CAAC;IAEF,MAAM,GAAG,GAAQ;QAChB,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,KAAK,CAAC,KAAK;QACjB,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC;KACpC,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAiB,EAAO,EAAE;IAChD,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAAE,KAAiB,EAAgB,EAAE;IAC7E,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,UAAU,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAE5C,OAAO;QACN,OAAO,EAAE,CAAC;QACV,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACZ,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,GAAQ,EAAU,EAAE;IAC1C,OAAO,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,MAAkB,EAAU,EAAE;IACxE,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;IAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAE9D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAClD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAEhC,OAAO;QACN,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,KAAK;KACZ,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,IAAY,EAAE,SAAqB,EAAc,EAAE;IAC1F,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAE5D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAChE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEjC,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/lib/cid-link.ts

@@ -0,0 +1,41 @@
+import { toBase32 } from '@atcute/multibase';
+
+import { decode, fromString, type Cid } from './codec.js';
+
+export interface CidLink {
+	$link: string;
+}
+
+export class CidLinkWrapper implements CidLink {
+	constructor(public bytes: Uint8Array) {}
+
+	get $link(): string {
+		const encoded = toBase32(this.bytes);
+		return `b${encoded}`;
+	}
+
+	toJSON(): CidLink {
+		return { $link: this.$link };
+	}
+}
+
+export const isCidLink = (value: unknown): value is CidLink => {
+	const val = value as any;
+
+	return (
+		val instanceof CidLinkWrapper ||
+		(val !== null && typeof val === 'object' && typeof val.$link === 'string')
+	);
+};
+
+export const toCidLink = (cid: Cid): CidLink => {
+	return new CidLinkWrapper(cid.bytes);
+};
+
+export const fromCidLink = (link: CidLink): Cid => {
+	if (link instanceof CidLinkWrapper) {
+		return decode(link.bytes);
+	}
+
+	return fromString(link.$link);
+};

package/lib/codec.ts

@@ -0,0 +1,146 @@
+import { fromBase32, toBase32 } from '@atcute/multibase';
+import * as varint from '@atcute/varint';
+
+export const CID_VERSION = 1;
+export const HASH_SHA256 = 0x12;
+
+export const CODEC_RAW = 0x55;
+export const CODEC_DCBOR = 0x71;
+
+/**
+ * Represents a Content Identifier (CID), in particular, a limited subset of
+ * CIDv1 as described by DASL specifications.
+ * https://dasl.ing/cid.html
+ */
+export interface Cid {
+	/** CID version, this is always `1` for CIDv1 */
+	version: number;
+	/** Multicodec type for the data, can be `0x55` for raw data or `0x71` for DAG-CBOR */
+	codec: number;
+	/** Digest contents */
+	digest: {
+		/** Multicodec type for the digest, this is always `0x12` for SHA-256 */
+		codec: number;
+		/** Raw hash bytes */
+		contents: Uint8Array;
+	};
+	/** Raw CID bytes */
+	bytes: Uint8Array;
+}
+
+export const create = async (codec: 0x55 | 0x71, data: Uint8Array): Promise<Cid> => {
+	const digest = new Uint8Array(await crypto.subtle.digest('sha-256', data));
+
+	const digestSize = digest.length;
+	const digestLebSize = varint.encodingLength(digestSize);
+
+	const bytes = new Uint8Array(3 + digestLebSize + digestSize);
+
+	bytes[0] = CID_VERSION;
+	bytes[1] = codec;
+	bytes[2] = HASH_SHA256;
+
+	varint.encode(digestSize, bytes, 3);
+	bytes.set(digest, 3 + digestLebSize);
+
+	const cid: Cid = {
+		version: CID_VERSION,
+		codec: codec,
+		digest: {
+			codec: HASH_SHA256,
+			contents: digest,
+		},
+		bytes: bytes,
+	};
+
+	return cid;
+};
+
+export const decodeFirst = (bytes: Uint8Array): [decoded: Cid, remainder: Uint8Array] => {
+	const length = bytes.length;
+
+	if (length < 5) {
+		throw new RangeError(`cid too short`);
+	}
+
+	const version = bytes[0];
+	const codec = bytes[1];
+	const digestCodec = bytes[2];
+
+	if (version !== CID_VERSION) {
+		throw new RangeError(`incorrect cid version (got v${version})`);
+	}
+
+	if (codec !== CODEC_DCBOR && codec !== CODEC_RAW) {
+		throw new RangeError(`incorrect cid codec (got 0x${codec.toString(16)})`);
+	}
+
+	if (digestCodec !== HASH_SHA256) {
+		throw new RangeError(`incorrect cid hash type (got 0x${digestCodec.toString(16)})`);
+	}
+
+	const [digestSize, digestLebSize] = varint.decode(bytes, 3);
+	const digestOffset = 3 + digestLebSize;
+
+	if (length - digestOffset < digestSize) {
+		throw new RangeError(`digest too short (expected ${digestSize} bytes; got ${length - digestOffset})`);
+	}
+
+	const remainder = bytes.subarray(digestOffset + digestSize);
+
+	const cid: Cid = {
+		version: CID_VERSION,
+		codec: codec,
+		digest: {
+			codec: digestCodec,
+			contents: bytes.subarray(digestOffset, digestOffset + digestSize),
+		},
+		bytes: bytes.subarray(0, digestOffset + digestSize),
+	};
+
+	return [cid, remainder];
+};
+
+export const decode = (bytes: Uint8Array): Cid => {
+	const [cid, remainder] = decodeFirst(bytes);
+
+	if (remainder.length !== 0) {
+		throw new RangeError(`cid bytes includes remainder`);
+	}
+
+	return cid;
+};
+
+export const fromString = (input: string): Cid => {
+	if (input.length < 2 || input[0] !== 'b') {
+		throw new SyntaxError(`not a multibase base32 string`);
+	}
+
+	const bytes = fromBase32(input.slice(1));
+	return decode(bytes);
+};
+
+export const toString = (cid: Cid): string => {
+	const encoded = toBase32(cid.bytes);
+	return `b${encoded}`;
+};
+
+export const fromBinary = (input: Uint8Array): Cid => {
+	if (input.length < 2) {
+		throw new RangeError(`cid bytes too short`);
+	}
+
+	if (input[0] !== 0) {
+		throw new SyntaxError(`incorrect binary cid`);
+	}
+
+	const bytes = input.subarray(1);
+	return decode(bytes);
+};
+
+export const toBinary = (cid: Cid): Uint8Array => {
+	const bytes = new Uint8Array(1 + cid.bytes.length);
+	bytes.set(cid.bytes, 1);
+
+	return bytes;
+};

package/lib/index.ts

@@ -1,189 +1,2 @@
-/**
- * @module
- * Bare minimum implementation for creating, parsing, and formatting
- * AT Protocol-blessed CIDv1 format.
- *
- * As specified by AT Protocol, the blessed format is:
- * - Multibase: `base32` (b)
- * - Multicodec: `dag-cbor` (0x71) for record, `raw` (0x55) for blobs
- * - Multihash: `sha-256` (0x12)
- */
-
-import { fromBase32, toBase32 } from '@atcute/multibase';
-import * as varint from '@atcute/varint';
-
-/**
- * Raw digest information
- */
-export interface Digest {
-	code: number;
-	size: number;
-	digest: Uint8Array;
-	bytes: Uint8Array;
-}
-
-/**
- * CID information
- */
-export interface CID {
-	version: number;
-	code: number;
-	digest: Digest;
-	bytes: Uint8Array;
-}
-
-/**
- * Information regarding CID buffer being inspected
- */
-export interface InspectedCID {
-	version: number;
-	codec: number;
-	multihashCode: number;
-	digestSize: number;
-	multihashSize: number;
-	size: number;
-}
-
-/**
- * Parse a CID string
- */
-export const parse = (cid: string): CID => {
-	if (cid[0] !== 'b') {
-		throw new Error(`only base32 cidv1 is supported`);
-	}
-
-	const bytes = fromBase32(cid.slice(1));
-	return decode(bytes);
-};
-
-/**
- * Provides information regarding the CID buffer
- */
-export const inspect = (initialBytes: Uint8Array): InspectedCID => {
-	let offset = 0;
-	const next = (): number => {
-		const [i, length] = varint.decode(initialBytes.subarray(offset));
-		offset += length;
-		return i;
-	};
-
-	let version = next();
-	let codec = 0x70; // dag-pb
-	if ((version as number) === 18) {
-		// CIDv0
-		version = 0;
-		offset = 0;
-	} else {
-		codec = next();
-	}
-
-	if (version !== 1) {
-		throw new RangeError(`only cidv1 is supported`);
-	}
-
-	const prefixSize = offset;
-	const multihashCode = next();
-	const digestSize = next();
-	const size = offset + digestSize;
-	const multihashSize = size - prefixSize;
-
-	return { version, codec, multihashCode, digestSize, multihashSize, size };
-};
-
-/**
- * Decode the first CID contained, and return the remainder.
- * @param bytes Buffer to decode
- * @returns A tuple containing the first CID in the buffer, and the remainder
- */
-export const decodeFirst = (bytes: Uint8Array): [cid: CID, remainder: Uint8Array] => {
-	const specs = inspect(bytes);
-	const prefixSize = specs.size - specs.multihashSize;
-	const multihashBytes = bytes.subarray(prefixSize, prefixSize + specs.multihashSize);
-
-	if (multihashBytes.byteLength !== specs.multihashSize) {
-		throw new RangeError('incorrect cid length');
-	}
-
-	const digestBytes = multihashBytes.subarray(specs.multihashSize - specs.digestSize);
-
-	const digest: Digest = {
-		code: specs.multihashCode,
-		size: specs.multihashSize,
-		digest: digestBytes,
-		bytes: multihashBytes,
-	};
-
-	const cid: CID = {
-		version: 1,
-		code: specs.codec,
-		digest: digest,
-		bytes: bytes.subarray(0, specs.size),
-	};
-
-	return [cid, bytes.subarray(specs.size)];
-};
-
-/**
- * Decodes a CID buffer
- */
-export const decode = (bytes: Uint8Array): CID => {
-	const [cid, remainder] = decodeFirst(bytes);
-
-	if (remainder.length !== 0) {
-		throw new Error(`incorrect cid length`);
-	}
-
-	return cid;
-};
-
-/**
- * Creates a CID
- */
-export const create = async (code: number, input: Uint8Array): Promise<CID> => {
-	const digest = createDigest(0x12, new Uint8Array(await crypto.subtle.digest('sha-256', input)));
-	const bytes = encode(1, code, digest.bytes);
-
-	return {
-		version: 1,
-		code: code,
-		digest: digest,
-		bytes: bytes,
-	};
-};
-
-/**
- * Serialize CID into a string
- */
-export const format = (cid: CID): string => {
-	return 'b' + toBase32(cid.bytes);
-};
-
-export const createDigest = (code: number, digest: Uint8Array): Digest => {
-	const size = digest.byteLength;
-	const sizeOffset = varint.encodingLength(code);
-	const digestOffset = sizeOffset + varint.encodingLength(size);
-
-	const bytes = new Uint8Array(digestOffset + size);
-	varint.encode(code, bytes, 0);
-	varint.encode(size, bytes, sizeOffset);
-	bytes.set(digest, digestOffset);
-
-	return {
-		code: code,
-		size: size,
-		digest: digest,
-		bytes: bytes,
-	};
-};
-
-export const encode = (version: number, code: number, multihash: Uint8Array): Uint8Array => {
-	const codeOffset = varint.encodingLength(version);
-	const hashOffset = codeOffset + varint.encodingLength(code);
-
-	const bytes = new Uint8Array(hashOffset + multihash.byteLength);
-	varint.encode(version, bytes, 0);
-	varint.encode(code, bytes, codeOffset);
-	bytes.set(multihash, hashOffset);
-
-	return bytes;
-};
+export * from './cid-link.js';
+export * from './codec.js';

package/package.json

@@ -1,8 +1,13 @@
 {
   "type": "module",
   "name": "@atcute/cid",
-  "version": "1.0.3",
-  "description": "create and parse AT Protocol-blessed CIDv1 format",
+  "version": "2.0.1",
+  "description": "lightweight DASL CID codec library for AT Protocol",
+  "keywords": [
+    "atproto",
+    "dasl",
+    "cid"
+  ],
   "license": "MIT",
   "repository": {
     "url": "https://github.com/mary-ext/atcute",
@@ -19,11 +24,11 @@
   },
   "sideEffects": false,
   "devDependencies": {
-    "@types/bun": "^1.1.12"
+    "@types/bun": "^1.1.14"
   },
   "dependencies": {
-    "@atcute/multibase": "^1.0.0",
-    "@atcute/varint": "^1.0.1"
+    "@atcute/multibase": "^1.0.1",
+    "@atcute/varint": "^1.0.2"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",