@kubun/id 0.17.0 → 0.18.0

package/lib/base.d.ts

@@ -17,12 +17,14 @@ export type DocumentType = typeof DOCUMENT_MERGE;
 export declare const CREDENTIAL_KEY = 31;
 export declare const CREDENTIAL_ENTRY = 32;
 export type CredentialType = typeof CREDENTIAL_KEY | typeof CREDENTIAL_ENTRY;
+export declare const CATALOG = 33;
+export type CatalogType = typeof CATALOG;
 /**
  * External references
  */
 export declare const EXTERNAL_PLUGIN_NODE = 40;
 export type ExternalType = typeof EXTERNAL_PLUGIN_NODE;
-export type KubunType = AttachmentType | ModelType | DocumentType | CredentialType | ExternalType;
+export type KubunType = AttachmentType | ModelType | DocumentType | CredentialType | CatalogType | ExternalType;
 export declare class KubunID<T extends KubunType = KubunType> {
     #private;
     constructor(type: T, dataBytes: Uint8Array);

package/lib/base.js

@@ -17,6 +17,7 @@ export const MODEL_CLUSTER = 21;
  */ export const DOCUMENT_MERGE = 30;
 export const CREDENTIAL_KEY = 31;
 export const CREDENTIAL_ENTRY = 32;
+export const CATALOG = 33;
 /**
  * External references
  */ export const EXTERNAL_PLUGIN_NODE = 40;

package/lib/catalog.d.ts

@@ -0,0 +1,15 @@
+import { CATALOG, KubunID } from './base.js';
+export declare class CatalogID extends KubunID<typeof CATALOG> {
+    #private;
+    static create(owner: string, localID: string): CatalogID;
+    static fromBytes(input: Uint8Array): CatalogID;
+    static fromString(input: string): CatalogID;
+    static from(input: CatalogID | Uint8Array | string): CatalogID;
+    constructor(owner: string, localID: string);
+    get owner(): string;
+    get localID(): string;
+    toRecordKey(): {
+        owner: string;
+        id: string;
+    };
+}

package/lib/catalog.js

@@ -0,0 +1,91 @@
+import { fromUTF, toUTF } from '@sozai/codec';
+import { base36 } from 'multiformats/bases/base36';
+import { CATALOG, KubunID, NAMESPACE_CODE } from './base.js';
+import { concat } from './bytes.js';
+import { decodeVarint, encodeVarint } from './utils.js';
+const EMPTY_PARTS_MESSAGE = 'Invalid CatalogID: owner and local ID must be non-empty';
+export class CatalogID extends KubunID {
+    static create(owner, localID) {
+        return new CatalogID(owner, localID);
+    }
+    static fromBytes(input) {
+        let offset = 0;
+        // Check namespace
+        const [namespace, namespaceLength] = decodeVarint(input);
+        if (namespace !== NAMESPACE_CODE) {
+            throw new Error('Invalid KubunID: namespace mismatch');
+        }
+        offset += namespaceLength;
+        // Check type matches
+        const [type, typeLength] = decodeVarint(input, offset);
+        if (type !== CATALOG) {
+            throw new Error('Invalid KubunID: type mismatch');
+        }
+        offset += typeLength;
+        // Decode owner
+        const [ownerLength, ownerVarintLength] = decodeVarint(input, offset);
+        offset += ownerVarintLength;
+        if (offset + ownerLength > input.byteLength) {
+            throw new Error('Invalid CatalogID: truncated owner');
+        }
+        const owner = toUTF(input.slice(offset, offset + ownerLength));
+        offset += ownerLength;
+        // Decode localID
+        const [localIDLength, localIDVarintLength] = decodeVarint(input, offset);
+        offset += localIDVarintLength;
+        if (offset + localIDLength > input.byteLength) {
+            throw new Error('Invalid CatalogID: truncated local ID');
+        }
+        const localID = toUTF(input.slice(offset, offset + localIDLength));
+        offset += localIDLength;
+        if (offset !== input.byteLength) {
+            throw new Error('Invalid CatalogID: unexpected trailing bytes');
+        }
+        return new CatalogID(owner, localID);
+    }
+    static fromString(input) {
+        return CatalogID.fromBytes(base36.decode(input));
+    }
+    static from(input) {
+        if (input instanceof CatalogID) {
+            return input;
+        }
+        if (input instanceof Uint8Array) {
+            return CatalogID.fromBytes(input);
+        }
+        if (typeof input === 'string') {
+            return CatalogID.fromString(input);
+        }
+        throw new Error('Unsupported input type');
+    }
+    #owner;
+    #localID;
+    constructor(owner, localID){
+        if (owner.length === 0 || localID.length === 0) {
+            throw new Error(EMPTY_PARTS_MESSAGE);
+        }
+        const ownerBytes = fromUTF(owner);
+        const localIDBytes = fromUTF(localID);
+        const data = concat([
+            encodeVarint(ownerBytes.byteLength),
+            ownerBytes,
+            encodeVarint(localIDBytes.byteLength),
+            localIDBytes
+        ]);
+        super(CATALOG, data);
+        this.#owner = owner;
+        this.#localID = localID;
+    }
+    get owner() {
+        return this.#owner;
+    }
+    get localID() {
+        return this.#localID;
+    }
+    toRecordKey() {
+        return {
+            owner: this.#owner,
+            id: this.#localID
+        };
+    }
+}

package/lib/decode.js

@@ -1,6 +1,7 @@
 import { base36 } from 'multiformats/bases/base36';
 import { AttachmentID } from './attachment.js';
-import { ATTACHMENT_BINARY, CREDENTIAL_ENTRY, CREDENTIAL_KEY, DOCUMENT_MERGE, EXTERNAL_PLUGIN_NODE, MODEL_CLUSTER, MODEL_DOCUMENT, MODEL_SCALAR, MODEL_SHAPE, NAMESPACE_CODE } from './base.js';
+import { ATTACHMENT_BINARY, CATALOG, CREDENTIAL_ENTRY, CREDENTIAL_KEY, DOCUMENT_MERGE, EXTERNAL_PLUGIN_NODE, MODEL_CLUSTER, MODEL_DOCUMENT, MODEL_SCALAR, MODEL_SHAPE, NAMESPACE_CODE } from './base.js';
+import { CatalogID } from './catalog.js';
 import { ClusterModelID } from './cluster-model.js';
 import { CredentialEntryID, CredentialKeyID } from './credential.js';
 import { DocumentID } from './document.js';
@@ -31,6 +32,8 @@ export function decodeID(input) {
             return CredentialKeyID.fromBytes(bytes);
         case CREDENTIAL_ENTRY:
             return CredentialEntryID.fromBytes(bytes);
+        case CATALOG:
+            return CatalogID.fromBytes(bytes);
         case EXTERNAL_PLUGIN_NODE:
             return PluginNodeID.fromBytes(bytes);
         default:

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export { AttachmentID } from './attachment.js';
 export { KubunID } from './base.js';
+export { CatalogID } from './catalog.js';
 export { ClusterModelID } from './cluster-model.js';
 export { CredentialEntryID, CredentialKeyID } from './credential.js';
 export { decodeID } from './decode.js';

package/lib/index.js

@@ -1,5 +1,6 @@
 export { AttachmentID } from './attachment.js';
 export { KubunID } from './base.js';
+export { CatalogID } from './catalog.js';
 export { ClusterModelID } from './cluster-model.js';
 export { CredentialEntryID, CredentialKeyID } from './credential.js';
 export { decodeID } from './decode.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/id",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -16,7 +16,7 @@
   ],
   "dependencies": {
     "@noble/hashes": "^2.4.0",
-    "@sozai/codec": "^0.4.0",
+    "@sozai/codec": "^0.4.3",
     "multiformats": "^14.0.5",
     "varint": "^6.0.0"
   },