immunum 1.0.0 → 1.1.1

package/README.md

@@ -1,6 +1,8 @@
-# immunum
+![Immunum Logo](https://raw.githubusercontent.com/ENPICOM/immunum/master/docs/assets/immunum_logotype.svg)
 
-High-performance antibody and TCR sequence numbering in Rust, Python, and WebAssembly.
+Immunum is a high-performance antibody and TCR sequence numbering tool for Rust, Python, Polars and JS/TS.
+
+Try it in your browser: [interactive demo](https://immunum.enpicom.com/demo/).
 
 [![Crates.io](https://img.shields.io/crates/v/immunum)](https://crates.io/crates/immunum)
 [![PyPI](https://img.shields.io/pypi/v/immunum)](https://pypi.org/project/immunum/)

package/immunum.d.ts

@@ -1,34 +1,45 @@
 /* tslint:disable */
 /* eslint-disable */
 
-/** Numbered residues keyed by IMGT/Kabat position string (e.g. `"112A"`). */
-export type Numbering = Record<string, string>;
+/**
+ * Ordered position → residue map, iterated in IMGT-correct order.
+ * Keys are position strings (e.g. `"112A"`) and values are single-character residues.
+ */
+export type Numbering = Map<string, string>;
 
-/** Result returned by {@link Annotator.number}. */
+/** Result returned by {@link Annotator.number}. On failure, chain/scheme/confidence/numbering/query_start/query_end are null and error contains the reason. */
 export interface NumberingResult {
-    /** Detected chain type: `"H"`, `"K"`, `"L"`, `"A"`, `"B"`, `"G"`, or `"D"`. */
-    chain: string;
-    /** Numbering scheme used: `"imgt"` or `"kabat"`. */
-    scheme: string;
-    /** Alignment confidence score between 0 and 1. */
-    confidence: number;
-    /** Position-to-residue mapping for the aligned region. */
-    numbering: Numbering;
+    /** Detected chain type: `"H"`, `"K"`, `"L"`, `"A"`, `"B"`, `"G"`, or `"D"`. Null on failure. */
+    chain: string | null;
+    /** Numbering scheme used: `"imgt"` or `"kabat"`. Null on failure. */
+    scheme: string | null;
+    /** Alignment confidence score between 0 and 1. Null on failure. */
+    confidence: number | null;
+    /** Position-to-residue mapping for the aligned region. Null on failure. */
+    numbering: Numbering | null;
+    /** 0-indexed start of the aligned region in the input sequence (inclusive). Null on failure. */
+    query_start: number | null;
+    /** 0-indexed end of the aligned region in the input sequence (inclusive). Null on failure. */
+    query_end: number | null;
+    /** Error message if numbering failed, null on success. */
+    error: string | null;
 }
 
-/** FR/CDR segments returned by {@link Annotator.segment}. */
+/** FR/CDR segments returned by {@link Annotator.segment}. On failure, all region fields are absent and error contains the reason. */
 export interface SegmentationResult {
-    fr1: string;
-    cdr1: string;
-    fr2: string;
-    cdr2: string;
-    fr3: string;
-    cdr3: string;
-    fr4: string;
+    fr1?: string;
+    cdr1?: string;
+    fr2?: string;
+    cdr2?: string;
+    fr3?: string;
+    cdr3?: string;
+    fr4?: string;
     /** Residues before FR1 (non-canonical N-terminal extension). */
-    prefix: string;
+    prefix?: string;
     /** Residues after FR4 (non-canonical C-terminal extension). */
-    postfix: string;
+    postfix?: string;
+    /** Error message if segmentation failed, null on success. */
+    error: string | null;
 }
 
 /**
@@ -62,4 +73,5 @@ export class Annotator {
     constructor(chains: string[], scheme: string, min_confidence?: number | null);
     number(sequence: string): NumberingResult;
     segment(sequence: string): SegmentationResult;
+
 }

package/immunum.js

@@ -40,10 +40,7 @@ class Annotator {
         const ptr0 = passStringToWasm0(sequence, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.annotator_number(this.__wbg_ptr, ptr0, len0);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
-        }
-        return takeFromExternrefTable0(ret[0]);
+        return ret;
     }
     /**
      * @param {string} sequence
@@ -53,10 +50,7 @@ class Annotator {
         const ptr0 = passStringToWasm0(sequence, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.annotator_segment(this.__wbg_ptr, ptr0, len0);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
-        }
-        return takeFromExternrefTable0(ret[0]);
+        return ret;
     }
 }
 if (Symbol.dispose) Annotator.prototype[Symbol.dispose] = Annotator.prototype.free;
@@ -83,6 +77,10 @@ function __wbg_get_imports() {
         __wbg___wbindgen_throw_6ddd609b62940d55: function(arg0, arg1) {
             throw new Error(getStringFromWasm0(arg0, arg1));
         },
+        __wbg_new_49d5571bd3f0c4d4: function() {
+            const ret = new Map();
+            return ret;
+        },
         __wbg_new_ab79df5bd7c26067: function() {
             const ret = new Object();
             return ret;
@@ -91,6 +89,10 @@ function __wbg_get_imports() {
             const ret = Reflect.set(arg0, arg1, arg2);
             return ret;
         }, arguments); },
+        __wbg_set_bf7251625df30a02: function(arg0, arg1, arg2) {
+            const ret = arg0.set(arg1, arg2);
+            return ret;
+        },
         __wbindgen_cast_0000000000000001: function(arg0) {
             // Cast intrinsic for `F64 -> Externref`.
             const ret = arg0;

package/package.json

@@ -4,7 +4,7 @@
     "ENPICOM <dev@enpicom.com>"
   ],
   "description": "Fast antibody and T-cell receptor numbering in Rust and Python",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "license": "MIT",
   "repository": {
     "type": "git",