@iscc/lib

High-performance Node.js bindings for ISO 24138:2024 -- International Standard Content Code (ISCC). Native addon built with Rust and napi-rs for near-native speed.

What is ISCC

The ISCC is a similarity-preserving fingerprint and identifier for digital media assets. ISCCs are generated algorithmically from digital content, just like cryptographic hashes. However, instead of using a single cryptographic hash function to identify data only, the ISCC uses various algorithms to create a composite identifier that exhibits similarity-preserving properties (soft hash).

Installation

npm install @iscc/lib

Quick Start

const {
    gen_meta_code_v0
} = require("@iscc/lib");

const iscc = gen_meta_code_v0("ISCC Test Document!");
console.log(`Meta-Code: ${iscc}`);

API Overview

Code Generators

| Function | Description | | ---------------------- | -------------------------------------------- | | gen_meta_code_v0 | Generate a Meta-Code from metadata fields | | gen_text_code_v0 | Generate a Text-Code from plain text | | gen_image_code_v0 | Generate an Image-Code from pixel data | | gen_audio_code_v0 | Generate an Audio-Code from Chromaprint data | | gen_video_code_v0 | Generate a Video-Code from frame signatures | | gen_mixed_code_v0 | Generate a Mixed-Code from Content-Codes | | gen_data_code_v0 | Generate a Data-Code from a Buffer | | gen_instance_code_v0 | Generate an Instance-Code from a Buffer | | gen_iscc_code_v0 | Generate a composite ISCC-CODE | | gen_sum_code_v0 | Generate an ISCC-SUM from a file path |

All code generators return ISCC strings directly.

Utilities

• Text processing: text_clean, text_remove_newlines, text_trim, text_collapse
• Algorithm primitives: alg_simhash, alg_minhash_256, alg_cdc_chunks, sliding_window
• Soft hashing: soft_hash_video_v0
• Encoding: encode_base64
• Codec: iscc_decompose
• Streaming: DataHasher, InstanceHasher classes for incremental processing
• Diagnostics: conformance_selftest

Links

• Documentation
• Repository
• ISCC Specification (ISO 24138)
• ISCC Foundation

License

Apache-2.0