@kubun/id 0.1.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/README.md

@@ -0,0 +1,11 @@
+# Kubun identifiers
+
+## Installation
+
+```sh
+npm install @kubun/id
+```
+
+## License
+
+[Prosperity Public License 3.0.0](LICENSE.md)

package/lib/attachment.d.ts

@@ -0,0 +1,19 @@
+import { AttachmentType, KubunID } from './base.js';
+import { CID } from './common.js';
+import type { SHA256Digest } from './types.js';
+export type AttachmentCID = CID<Uint8Array, 85, 18, 1>;
+export declare function digestAttachment(value: Uint8Array): SHA256Digest;
+export declare function createAttachmentCID(digest: SHA256Digest): AttachmentCID;
+export declare class AttachmentID extends KubunID<AttachmentType.BINARY> {
+    #private;
+    static create(value: Uint8Array, mimeType?: string): AttachmentID;
+    static fromBytes(input: Uint8Array): AttachmentID;
+    static fromDigest(digest: SHA256Digest, contentLength: number, mimeType?: string): AttachmentID;
+    static fromString(input: string): AttachmentID;
+    static from(input: AttachmentID | Uint8Array | string): AttachmentID;
+    constructor(cid: CID, contentLength: number, mimeType?: string);
+    get cid(): CID;
+    get contentLength(): number;
+    get mimeType(): string;
+}
+//# sourceMappingURL=attachment.d.ts.map

package/lib/attachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachment.d.ts","sourceRoot":"","sources":["../src/attachment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAA;AACnE,OAAO,EAAE,GAAG,EAAmD,MAAM,aAAa,CAAA;AAClF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAK9C,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;AAEtD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY,CAGhE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,CAEvE;AAED,qBAAa,YAAa,SAAQ,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC;;IAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,YAAY;IAKjE,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY;IA0CjD,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,YAAY;IAK/F,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAI9C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,YAAY;gBAiBxD,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,SAAoB;IAoBzE,IAAI,GAAG,IAAI,GAAG,CAEb;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;CACF"}

package/lib/attachment.js

@@ -0,0 +1,109 @@
+import { AttachmentType, KubunID, NAMESPACE_CODE } from './base.js';
+import { CID, base36, concat, decodeDigest, encodeRaw, varint } from './common.js';
+import { decodeUTF8, encodeUTF8, encodeVarint, toSHA256Digest } from './utils.js';
+const DEFAULT_MIME_TYPE = 'application/octet-stream';
+export function digestAttachment(value) {
+    const bytes = encodeRaw(value);
+    return toSHA256Digest(bytes);
+}
+export function createAttachmentCID(digest) {
+    return CID.createV1(85, digest);
+}
+export class AttachmentID extends KubunID {
+    static create(value, mimeType) {
+        const digest = digestAttachment(value);
+        return AttachmentID.fromDigest(digest, value.byteLength, mimeType);
+    }
+    static fromBytes(input) {
+        let offset = 0;
+        // Check namespace = is it a KubunID?
+        const [namespace, namespaceLength] = varint.decode(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        offset += namespaceLength;
+        // Check type matches
+        const [type, typeLength] = varint.decode(input, offset);
+        if (type !== AttachmentType.BINARY) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        offset += typeLength;
+        // Decode digest
+        const [digestByteLength, digestVarintLength] = varint.decode(input, offset);
+        offset += digestVarintLength;
+        const digestBytes = input.slice(offset, offset + digestByteLength);
+        offset += digestByteLength;
+        const digest = decodeDigest(digestBytes);
+        // Extract content length
+        const [contentLength, contentVarintLength] = varint.decode(input, offset);
+        offset += contentVarintLength;
+        // Check if MIME type is provided
+        const [mimeTypeBytesLength, mimeTypeVarintLength] = varint.decode(input, offset);
+        if (mimeTypeBytesLength === 0) {
+            // No MIME type encoded, use default
+            return AttachmentID.fromDigest(digest, contentLength);
+        }
+        // Decode MIME type value
+        offset += mimeTypeVarintLength;
+        const mimeTypeBytes = input.slice(offset, offset + mimeTypeBytesLength);
+        const mimeType = decodeUTF8(mimeTypeBytes);
+        return AttachmentID.fromDigest(digest, contentLength, mimeType);
+    }
+    static fromDigest(digest, contentLength, mimeType) {
+        const cid = createAttachmentCID(digest);
+        return new AttachmentID(cid, contentLength, mimeType);
+    }
+    static fromString(input) {
+        return AttachmentID.fromBytes(base36.decode(input));
+    }
+    static from(input) {
+        if (input instanceof AttachmentID) {
+            return input;
+        }
+        if (input instanceof Uint8Array) {
+            return AttachmentID.fromBytes(input);
+        }
+        if (typeof input === 'string') {
+            return AttachmentID.fromString(input);
+        }
+        throw new Error('Unsupported input type');
+    }
+    #cid;
+    #contentLength;
+    #mimeType;
+    constructor(cid, contentLength, mimeType = DEFAULT_MIME_TYPE){
+        let data;
+        const digestBytes = cid.multihash.bytes;
+        const baseData = concat([
+            encodeVarint(digestBytes.byteLength),
+            digestBytes,
+            encodeVarint(contentLength)
+        ]);
+        if (mimeType === DEFAULT_MIME_TYPE) {
+            data = concat([
+                baseData,
+                encodeVarint(0)
+            ]);
+        } else {
+            const typeBytes = encodeUTF8(mimeType);
+            data = concat([
+                baseData,
+                encodeVarint(typeBytes.byteLength),
+                typeBytes
+            ]);
+        }
+        super(AttachmentType.BINARY, data);
+        this.#cid = cid;
+        this.#contentLength = contentLength;
+        this.#mimeType = mimeType;
+    }
+    get cid() {
+        return this.#cid;
+    }
+    get contentLength() {
+        return this.#contentLength;
+    }
+    get mimeType() {
+        return this.#mimeType;
+    }
+}

package/lib/base.d.ts

@@ -0,0 +1,25 @@
+export declare function encodeVarint(value: number): Uint8Array;
+export declare const NAMESPACE_CODE = 2794;
+export declare enum AttachmentType {
+    BINARY = 1
+}
+export declare enum ModelType {
+    SCALAR = 10,
+    SHAPE = 11,
+    GRAPH = 20
+}
+export declare enum DocumentType {
+    MERGE_DOCUMENT = 30
+}
+export type KubunType = AttachmentType | ModelType | DocumentType;
+export declare class KubunID<T extends KubunType = KubunType> {
+    #private;
+    constructor(type: T, dataBytes: Uint8Array);
+    get type(): T;
+    get data(): Uint8Array;
+    get bytes(): Uint8Array;
+    equals(other: KubunID): boolean;
+    toBytes(): Uint8Array;
+    toString(): string;
+}
+//# sourceMappingURL=base.d.ts.map

package/lib/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAEA,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEtD;AAED,eAAO,MAAM,cAAc,OAAQ,CAAA;AAInC,oBAAY,cAAc;IACxB,MAAM,IAAI;CACX;AACD,oBAAY,SAAS;IAEnB,MAAM,KAAK;IACX,KAAK,KAAK;IAEV,KAAK,KAAK;CACX;AAED,oBAAY,YAAY;IACtB,cAAc,KAAK;CACpB;AAED,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,YAAY,CAAA;AAEjE,qBAAa,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;;gBAMtC,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,UAAU;IAK1C,IAAI,IAAI,IAAI,CAAC,CAEZ;IAED,IAAI,IAAI,IAAI,UAAU,CAErB;IAED,IAAI,KAAK,IAAI,UAAU,CAOtB;IAED,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAI/B,OAAO,IAAI,UAAU;IAIrB,QAAQ;CAUT"}

package/lib/base.js

@@ -0,0 +1,65 @@
+import { base36, concat, equals, varint } from './common.js';
+export function encodeVarint(value) {
+    return varint.encodeTo(value, new Uint8Array(varint.encodingLength(value)));
+}
+export const NAMESPACE_CODE = 0xaea;
+const NAMESPACE_BYTES = encodeVarint(NAMESPACE_CODE);
+export var AttachmentType;
+(function(AttachmentType) {
+    AttachmentType[AttachmentType["BINARY"] = 1] = "BINARY";
+})(AttachmentType || (AttachmentType = {}));
+export var ModelType;
+(function(ModelType) {
+    // DAG-only
+    ModelType[ModelType["SCALAR"] = 10] = "SCALAR";
+    ModelType[ModelType["SHAPE"] = 11] = "SHAPE";
+    // Circular
+    ModelType[ModelType["GRAPH"] = 20] = "GRAPH";
+})(ModelType || (ModelType = {}));
+export var DocumentType;
+(function(DocumentType) {
+    DocumentType[DocumentType["MERGE_DOCUMENT"] = 30] = "MERGE_DOCUMENT";
+})(DocumentType || (DocumentType = {}));
+export class KubunID {
+    #type;
+    #dataBytes;
+    #idBytes;
+    #string;
+    constructor(type, dataBytes){
+        this.#type = type;
+        this.#dataBytes = dataBytes;
+    }
+    get type() {
+        return this.#type;
+    }
+    get data() {
+        return this.#dataBytes;
+    }
+    get bytes() {
+        if (this.#idBytes == null) {
+            const bytes = this.toBytes();
+            this.#idBytes = bytes;
+            return bytes;
+        }
+        return this.#idBytes;
+    }
+    equals(other) {
+        return other instanceof KubunID && other.type === this.type && equals(other.data, this.data);
+    }
+    toBytes() {
+        return concat([
+            NAMESPACE_BYTES,
+            encodeVarint(this.#type),
+            this.#dataBytes
+        ]);
+    }
+    toString() {
+        if (this.#string == null) {
+            this.#string = base36.encode(this.bytes);
+        }
+        return this.#string;
+    }
+    [Symbol.for('nodejs.util.inspect.custom')]() {
+        return `KubunID(${this.toString()})`;
+    }
+}

package/lib/common.d.ts

@@ -0,0 +1,10 @@
+export { encode as encodeCBOR } from '@ipld/dag-cbor';
+export { type ByteView, varint } from 'multiformats';
+export { base36 } from 'multiformats/bases/base36';
+export { CID } from 'multiformats/cid';
+export { encode as encodeRaw } from 'multiformats/codecs/raw';
+export { type Digest, decode as decodeDigest } from 'multiformats/hashes/digest';
+export { identity } from 'multiformats/hashes/identity';
+export { sha256 } from 'multiformats/hashes/sha2';
+export { concat, equals } from 'uint8arrays';
+//# sourceMappingURL=common.d.ts.map

package/lib/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA"}

package/lib/common.js

@@ -0,0 +1,9 @@
+export { encode as encodeCBOR } from '@ipld/dag-cbor';
+export { varint } from 'multiformats';
+export { base36 } from 'multiformats/bases/base36';
+export { CID } from 'multiformats/cid';
+export { encode as encodeRaw } from 'multiformats/codecs/raw';
+export { decode as decodeDigest } from 'multiformats/hashes/digest';
+export { identity } from 'multiformats/hashes/identity';
+export { sha256 } from 'multiformats/hashes/sha2';
+export { concat, equals } from 'uint8arrays';

package/lib/decode.d.ts

@@ -0,0 +1,3 @@
+import { type KubunID } from './base.js';
+export declare function decodeID(input: string | Uint8Array): KubunID;
+//# sourceMappingURL=decode.d.ts.map

package/lib/decode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.d.ts","sourceRoot":"","sources":["../src/decode.ts"],"names":[],"mappings":"AACA,OAAO,EAAgC,KAAK,OAAO,EAA6B,MAAM,WAAW,CAAA;AAKjG,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAuB5D"}

package/lib/decode.js

@@ -0,0 +1,27 @@
+import { AttachmentID } from './attachment.js';
+import { AttachmentType, DocumentType, ModelType, NAMESPACE_CODE } from './base.js';
+import { base36, varint } from './common.js';
+import { DocumentID } from './document.js';
+import { GraphModelID, ScalarModelID, ShapeModelID } from './model.js';
+export function decodeID(input) {
+    const bytes = typeof input === 'string' ? base36.decode(input) : input;
+    const [namespace, namespaceLength] = varint.decode(bytes);
+    if (namespace !== NAMESPACE_CODE) {
+        throw new Error('Invalid KubunID: namespace mismatch');
+    }
+    const [type] = varint.decode(bytes, namespaceLength);
+    switch(type){
+        case AttachmentType.BINARY:
+            return AttachmentID.fromBytes(bytes);
+        case ModelType.SCALAR:
+            return ScalarModelID.fromBytes(bytes);
+        case ModelType.SHAPE:
+            return ShapeModelID.fromBytes(bytes);
+        case ModelType.GRAPH:
+            return GraphModelID.fromBytes(bytes);
+        case DocumentType.MERGE_DOCUMENT:
+            return DocumentID.fromBytes(bytes);
+        default:
+            throw new Error(`Invalid KubunID: unknown type ${type}`);
+    }
+}

package/lib/document.d.ts

@@ -0,0 +1,13 @@
+import { DocumentType, KubunID } from './base.js';
+import { GraphModelID } from './model.js';
+export declare class DocumentID extends KubunID<DocumentType.MERGE_DOCUMENT> {
+    #private;
+    static create(model: GraphModelID | Uint8Array | string, owner: string | Uint8Array, unique: Uint8Array): DocumentID;
+    static fromBytes(input: Uint8Array): DocumentID;
+    static fromString(input: string): DocumentID;
+    static from(input: DocumentID | Uint8Array | string): DocumentID;
+    constructor(model: GraphModelID, contentDigestBytes: Uint8Array);
+    get model(): GraphModelID;
+    get content(): Uint8Array;
+}
+//# sourceMappingURL=document.d.ts.map

package/lib/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAA;AAEjE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAGzC,qBAAa,UAAW,SAAQ,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC;;IAClE,MAAM,CAAC,MAAM,CACX,KAAK,EAAE,YAAY,GAAG,UAAU,GAAG,MAAM,EACzC,KAAK,EAAE,MAAM,GAAG,UAAU,EAC1B,MAAM,EAAE,UAAU,GACjB,UAAU;IAQb,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAkC/C,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;IAI5C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU;gBAgBpD,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,UAAU;IAkB/D,IAAI,KAAK,IAAI,YAAY,CAExB;IAED,IAAI,OAAO,IAAI,UAAU,CAExB;CACF"}

package/lib/document.js

@@ -0,0 +1,79 @@
+import { DocumentType, KubunID, NAMESPACE_CODE } from './base.js';
+import { base36, concat, varint } from './common.js';
+import { GraphModelID } from './model.js';
+import { encodeVarint, toSHA256Digest } from './utils.js';
+export class DocumentID extends KubunID {
+    static create(model, owner, unique) {
+        const contentBytes = concat([
+            typeof owner === 'string' ? new TextEncoder().encode(owner) : owner,
+            unique
+        ]);
+        return new DocumentID(GraphModelID.from(model), toSHA256Digest(contentBytes).bytes);
+    }
+    static fromBytes(input) {
+        let offset = 0;
+        // Check namespace = is it a KubunID?
+        const [namespace, namespaceLength] = varint.decode(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        offset += namespaceLength;
+        // Check type matches
+        const [type, typeLength] = varint.decode(input, offset);
+        if (type !== DocumentType.MERGE_DOCUMENT) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        offset += typeLength;
+        // Decode model ID: digest bytes followed by index
+        const [modelDataByteLength, modelDataVarintLength] = varint.decode(input, offset);
+        offset += modelDataVarintLength;
+        const modelDigest = input.slice(offset, offset + modelDataByteLength);
+        offset += modelDataByteLength;
+        const [modelIndex, modelIndexVarintLength] = varint.decode(input, offset);
+        offset += modelIndexVarintLength;
+        const modelID = new GraphModelID(modelDigest, modelIndex);
+        // Extract content digest bytes
+        const [contentByteLength, contentVarintLength] = varint.decode(input, offset);
+        offset += contentVarintLength;
+        const contentBytes = input.slice(offset, offset + contentByteLength);
+        return new DocumentID(modelID, contentBytes);
+    }
+    static fromString(input) {
+        return DocumentID.fromBytes(base36.decode(input));
+    }
+    static from(input) {
+        if (input instanceof DocumentID) {
+            return input;
+        }
+        if (input instanceof Uint8Array) {
+            return DocumentID.fromBytes(input);
+        }
+        if (typeof input === 'string') {
+            return DocumentID.fromString(input);
+        }
+        throw new Error('Unsupported input type');
+    }
+    #model;
+    #content;
+    constructor(model, contentDigestBytes){
+        if (model.isLocal) {
+            throw new Error('Invalid DocumentID: model cannot be local');
+        }
+        const data = concat([
+            encodeVarint(model.data.byteLength),
+            model.data,
+            encodeVarint(model.index),
+            encodeVarint(contentDigestBytes.byteLength),
+            contentDigestBytes
+        ]);
+        super(DocumentType.MERGE_DOCUMENT, data);
+        this.#model = model;
+        this.#content = contentDigestBytes;
+    }
+    get model() {
+        return this.#model;
+    }
+    get content() {
+        return this.#content;
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+export { type AttachmentCID, AttachmentID, createAttachmentCID, digestAttachment, } from './attachment.js';
+export { KubunID } from './base.js';
+export { decodeID } from './decode.js';
+export { DocumentID } from './document.js';
+export { GraphModelID, ScalarModelID, ShapeModelID } from './model.js';
+export type { SHA256Digest } from './types.js';
+export { toDigestBytes, toSHA256Digest } from './utils.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAClB,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACtE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA"}

package/lib/index.js

@@ -0,0 +1,6 @@
+export { AttachmentID, createAttachmentCID, digestAttachment } from './attachment.js';
+export { KubunID } from './base.js';
+export { decodeID } from './decode.js';
+export { DocumentID } from './document.js';
+export { GraphModelID, ScalarModelID, ShapeModelID } from './model.js';
+export { toDigestBytes, toSHA256Digest } from './utils.js';

package/lib/model.d.ts

@@ -0,0 +1,26 @@
+import { KubunID, ModelType } from './base.js';
+export declare class ScalarModelID extends KubunID<ModelType.SCALAR> {
+    static create(value: unknown): ScalarModelID;
+    static fromBytes(input: Uint8Array): ScalarModelID;
+    static fromString(input: string): ScalarModelID;
+    constructor(digestBytes: Uint8Array);
+}
+export declare class ShapeModelID extends KubunID<ModelType.SHAPE> {
+    static create(value: unknown): ShapeModelID;
+    static fromBytes(input: Uint8Array): ShapeModelID;
+    static fromString(input: string): ShapeModelID;
+    constructor(digestBytes: Uint8Array);
+}
+export declare class GraphModelID extends KubunID<ModelType.GRAPH> {
+    #private;
+    static fromBytes(input: Uint8Array): GraphModelID;
+    static fromString(input: string): GraphModelID;
+    static from(input: GraphModelID | Uint8Array | string): GraphModelID;
+    static local(index: number): GraphModelID;
+    constructor(digestBytes: Uint8Array, index: number);
+    get index(): number;
+    get isLocal(): boolean;
+    toBytes(): Uint8Array;
+    toGlobal(digestBytesOrModelID: Uint8Array | GraphModelID): GraphModelID;
+}
+//# sourceMappingURL=model.d.ts.map

package/lib/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAkB,MAAM,WAAW,CAAA;AAI9D,qBAAa,aAAc,SAAQ,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC;IAC1D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa;IAI5C,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,aAAa;IAclD,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa;gBAInC,WAAW,EAAE,UAAU;CAGpC;AAED,qBAAa,YAAa,SAAQ,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;IACxD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY;IAI3C,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY;IAcjD,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;gBAIlC,WAAW,EAAE,UAAU;CAGpC;AAKD,qBAAa,YAAa,SAAQ,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;;IACxD,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY;IAejD,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAI9C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,YAAY;IAapE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;gBAO7B,WAAW,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM;IAWlD,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,IAAI,UAAU;IAIrB,QAAQ,CAAC,oBAAoB,EAAE,UAAU,GAAG,YAAY,GAAG,YAAY;CAOxE"}

package/lib/model.js

@@ -0,0 +1,111 @@
+import { KubunID, ModelType, NAMESPACE_CODE } from './base.js';
+import { base36, concat, encodeCBOR, equals, identity, varint } from './common.js';
+import { encodeVarint, toDigestBytes } from './utils.js';
+export class ScalarModelID extends KubunID {
+    static create(value) {
+        return new ScalarModelID(toDigestBytes(value));
+    }
+    static fromBytes(input) {
+        const [namespace, namespaceLength] = varint.decode(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        const [type, typeLength] = varint.decode(input, namespaceLength);
+        if (type !== ModelType.SCALAR) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        const digestBytes = input.slice(namespaceLength + typeLength);
+        return new ScalarModelID(digestBytes);
+    }
+    static fromString(input) {
+        return ScalarModelID.fromBytes(base36.decode(input));
+    }
+    constructor(digestBytes){
+        super(ModelType.SCALAR, digestBytes);
+    }
+}
+export class ShapeModelID extends KubunID {
+    static create(value) {
+        return new ShapeModelID(toDigestBytes(value));
+    }
+    static fromBytes(input) {
+        const [namespace, namespaceLength] = varint.decode(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        const [type, typeLength] = varint.decode(input, namespaceLength);
+        if (type !== ModelType.SHAPE) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        const digestBytes = input.slice(namespaceLength + typeLength);
+        return new ShapeModelID(digestBytes);
+    }
+    static fromString(input) {
+        return ShapeModelID.fromBytes(base36.decode(input));
+    }
+    constructor(digestBytes){
+        super(ModelType.SHAPE, digestBytes);
+    }
+}
+const LOCAL_DIGEST_BYTES = identity.digest(encodeCBOR('local')).bytes;
+const MAX_INDEX = 127;
+export class GraphModelID extends KubunID {
+    static fromBytes(input) {
+        const [namespace, namespaceLength] = varint.decode(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        const [type, typeLength] = varint.decode(input, namespaceLength);
+        if (type !== ModelType.GRAPH) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        const digestBytes = input.slice(namespaceLength + typeLength, input.byteLength - 1);
+        const [index] = varint.decode(input, input.byteLength - 1);
+        return new GraphModelID(digestBytes, index);
+    }
+    static fromString(input) {
+        return GraphModelID.fromBytes(base36.decode(input));
+    }
+    static from(input) {
+        if (input instanceof GraphModelID) {
+            return input;
+        }
+        if (input instanceof Uint8Array) {
+            return GraphModelID.fromBytes(input);
+        }
+        if (typeof input === 'string') {
+            return GraphModelID.fromString(input);
+        }
+        throw new Error('Unsupported input type');
+    }
+    static local(index) {
+        return new GraphModelID(LOCAL_DIGEST_BYTES, index);
+    }
+    #index;
+    #isLocal;
+    constructor(digestBytes, index){
+        if (index > MAX_INDEX) {
+            // index should be encoded in a single byte
+            throw new RangeError(`Index ${index} exceeds maximum of ${MAX_INDEX}`);
+        }
+        super(ModelType.GRAPH, digestBytes);
+        this.#index = index;
+        this.#isLocal = equals(digestBytes, LOCAL_DIGEST_BYTES);
+    }
+    get index() {
+        return this.#index;
+    }
+    get isLocal() {
+        return this.#isLocal;
+    }
+    toBytes() {
+        return concat([
+            super.toBytes(),
+            encodeVarint(this.#index)
+        ]);
+    }
+    toGlobal(digestBytesOrModelID) {
+        const digestBytes = digestBytesOrModelID instanceof GraphModelID ? digestBytesOrModelID.data : digestBytesOrModelID;
+        return new GraphModelID(digestBytes, this.#index);
+    }
+}

package/lib/types.d.ts

@@ -0,0 +1,3 @@
+import type { Digest } from './common.js';
+export type SHA256Digest = Digest<18, number>;
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA"}

package/lib/types.js

@@ -0,0 +1 @@
+export { };

package/lib/utils.d.ts

@@ -0,0 +1,8 @@
+import { type ByteView } from './common.js';
+import type { SHA256Digest } from './types.js';
+export declare function encodeVarint(value: number): Uint8Array;
+export declare function toSHA256Digest(bytes: ByteView<unknown>): SHA256Digest;
+export declare function toDigestBytes<T = unknown>(value: T): Uint8Array;
+export declare function decodeUTF8(bytes: Uint8Array): string;
+export declare function encodeUTF8(value: string): Uint8Array;
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAA8B,MAAM,aAAa,CAAA;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE9C,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEtD;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,YAAY,CAErE;AAED,wBAAgB,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAG/D;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEpD"}

package/lib/utils.js

@@ -0,0 +1,17 @@
+import { encodeCBOR, sha256, varint } from './common.js';
+export function encodeVarint(value) {
+    return varint.encodeTo(value, new Uint8Array(varint.encodingLength(value)));
+}
+export function toSHA256Digest(bytes) {
+    return sha256.digest(bytes);
+}
+export function toDigestBytes(value) {
+    const bytes = encodeCBOR(value);
+    return toSHA256Digest(bytes).bytes;
+}
+export function decodeUTF8(bytes) {
+    return new TextDecoder().decode(bytes);
+}
+export function encodeUTF8(value) {
+    return new TextEncoder().encode(value);
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@kubun/id",
+  "version": "0.1.0",
+  "license": "see LICENSE.md",
+  "keywords": [],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@ipld/dag-cbor": "^9.2.1",
+    "multiformats": "^13.3.0",
+    "uint8arrays": "^5.1.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test:types": "tsc --noEmit",
+    "test:unit": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}