@lib-q/types 0.0.2

package/README.md

@@ -0,0 +1,9 @@
+# @lib-q/types
+
+TypeScript typings for @lib-q WASM packages
+
+## Install
+
+```bash
+npm install @lib-q/types@0.0.2
+```

package/index.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Structured error object (`lib_q_core::wasm_common::wasm_js_error`).
+ */
+export interface LibQWasmError {
+  /** Stable string category, e.g. `LIB_Q_HPKE`. */
+  code: string;
+  /** FNV-1a 32-bit id of `code` for numeric switching. */
+  codeNumeric: number;
+  message: string;
+}
+
+/** `@lib-q/hpke` — single-shot seal */
+export interface HpkeSealResult {
+  encapsulatedKeyHex: string;
+  ciphertextHex: string;
+}
+
+/** Serialized sender context (snake_case keys as emitted by `serde` on the Rust structs). */
+export interface HpkeSenderWire {
+  encapsulated_key_hex: string;
+  shared_secret_hex: string;
+  exporter_secret_hex: string;
+  key_hex: string;
+  nonce_hex: string;
+  aead: string;
+  sequence_number: number;
+  max_sequence_number: number;
+  state: string;
+}
+
+/** `@lib-q/hpke` — `hpkeSetupSender` */
+export interface HpkeSetupSenderResult {
+  encapsulated_key_hex: string;
+  sender: HpkeSenderWire;
+}
+
+/** `@lib-q/hpke` — `hpkeSenderSeal` */
+export interface HpkeSenderSealResult {
+  ciphertext_hex: string;
+  sender: HpkeSenderWire;
+}
+
+/** Receiver context wire (snake_case). */
+export interface HpkeReceiverWire {
+  shared_secret_hex: string;
+  key_hex: string;
+  nonce_hex: string;
+  aead: string;
+  sequence_number: number;
+  max_sequence_number: number;
+  state: string;
+}
+
+/** `@lib-q/hpke` — `hpkeSetupReceiver` */
+export interface HpkeSetupReceiverResult {
+  receiver: HpkeReceiverWire;
+}
+
+/** `@lib-q/hpke` — `hpkeReceiverOpen` */
+export interface HpkeReceiverOpenResult {
+  plaintext: Uint8Array;
+  receiver: HpkeReceiverWire;
+}
+
+/** `@lib-q/cb-kem` */
+export interface CbKemKeypair {
+  public_key_hex: string;
+  secret_key_hex: string;
+}
+
+export interface CbKemEncapsulateResult {
+  ciphertext_hex: string;
+  shared_secret_hex: string;
+}
+
+export interface CbKemDecapsulateResult {
+  sharedSecretHex: string;
+}
+
+/** `@lib-q/hqc` */
+export interface HqcKeygenResult {
+  publicKey: string;
+  secretKey: string;
+}
+
+export interface HqcEncapsulateResult {
+  ciphertext: string;
+  sharedSecret: string;
+}
+
+export interface HqcDecapsulateResult {
+  sharedSecretHex: string;
+}
+
+/** `@lib-q/slh-dsa` — shapes depend on parameter set; keys and signatures are hex strings in JS. */
+export interface SlhDsaKeypair {
+  verifying_key_hex: string;
+  signing_key_hex: string;
+}
+
+export interface SlhDsaSignResult {
+  signature_hex: string;
+}
+
+/** `@lib-q/zkp` — preimage API (object return from prove path) */
+export interface ZkpPreimageProof {
+  /** Proof payload; exact fields depend on build configuration. */
+  [key: string]: unknown;
+}
+
+/** `@lib-q/prf` — Gold PRF return shape (`goldPrfU256BeHex`). */
+export interface GoldPrfU256HexOut {
+  output_hex: string;
+}
+
+/** `@lib-q/prf` — hex string outputs */
+export type PrfHexString = string;
+
+/** `@lib-q/random` */
+export type SecureRandomBytes = Uint8Array;

package/index.js

@@ -0,0 +1,5 @@
+/**
+ * @lib-q/types — Type-only package. Runtime exports are intentionally empty.
+ * Import generated bindings from each @lib-q/* package; use these types for shapes.
+ */
+export {};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@lib-q/types",
+  "version": "0.0.2",
+  "description": "TypeScript typings for @lib-q WASM packages",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Enkom-Tech/libQ.git"
+  },
+  "homepage": "https://github.com/Enkom-Tech/libQ#readme",
+  "bugs": {
+    "url": "https://github.com/Enkom-Tech/libQ/issues"
+  },
+  "keywords": "[\"typescript\",\"lib-q\",\"wasm\",\"types\"]",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "author": "lib-Q Contributors"
+}