feat(pq-key-fingerprint/ts): phase 1 - rebuild source API surface (ENG-1760)

packages/pq-key-encoder/ts/tsconfig.json

@@ -4,6 +4,7 @@
     "module": "ESNext",
     "moduleResolution": "bundler",
     "declaration": true,
+    "composite": true,
     "outDir": "./dist",
     "rootDir": "./src",
     "strict": true,

packages/pq-key-fingerprint/ts/package.json

@@ -9,7 +9,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -b",
+    "test": "bun test",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -19,6 +20,9 @@
   ],
   "author": "",
   "license": "MIT",
+  "dependencies": {
+    "pq-key-encoder": "^1.0.3"
+  },
   "devDependencies": {
     "typescript": "^5.0.0"
   }

packages/pq-key-fingerprint/ts/src/errors.ts

@@ -0,0 +1,40 @@
+/** Base error for pq-key-fingerprint failures. */
+export class FingerprintError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'FingerprintError';
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+/** Error for invalid or missing fingerprint input values. */
+export class InvalidFingerprintInputError extends FingerprintError {
+  constructor(message: string) {
+    super(message);
+    this.name = 'InvalidFingerprintInputError';
+  }
+}
+
+/** Error for key-type mismatches, such as passing private keys. */
+export class InvalidKeyTypeError extends FingerprintError {
+  constructor(message: string) {
+    super(message);
+    this.name = 'InvalidKeyTypeError';
+  }
+}
+
+/** Error for unsupported digest algorithm selections. */
+export class UnsupportedDigestError extends FingerprintError {
+  constructor(message: string) {
+    super(message);
+    this.name = 'UnsupportedDigestError';
+  }
+}
+
+/** Error for missing runtime cryptographic capabilities. */
+export class RuntimeCapabilityError extends FingerprintError {
+  constructor(message: string) {
+    super(message);
+    this.name = 'RuntimeCapabilityError';
+  }
+}

packages/pq-key-fingerprint/ts/src/index.ts

@@ -1,4 +1,2 @@
-// pq-key-fingerprint - Generate fingerprints/hashes of PQ public keys
-// Implementation coming soon
-
-export {};
+export * from './errors';
+export * from './types';

packages/pq-key-fingerprint/ts/src/types.ts

@@ -0,0 +1,23 @@
+import type { AlgorithmName as EncoderAlgorithmName, KeyData, PQJwk } from 'pq-key-encoder';
+
+export type { AlgorithmName } from 'pq-key-encoder';
+
+export type FingerprintDigest = 'SHA-256' | 'SHA-384' | 'SHA-512';
+
+export type FingerprintEncoding = 'hex' | 'base64' | 'base64url' | 'bytes';
+
+export interface FingerprintOptions {
+  digest?: FingerprintDigest;
+  encoding?: FingerprintEncoding;
+}
+
+export type PublicKeyData = Omit<KeyData, 'type' | 'alg'> & {
+  alg: EncoderAlgorithmName;
+  type: 'public';
+};
+
+export type PublicKeyInput = PublicKeyData | { alg: EncoderAlgorithmName; bytes: Uint8Array };
+
+export type FingerprintInput = PublicKeyInput | Uint8Array | string | PQJwk;
+
+export type FingerprintResult = string | Uint8Array;

packages/pq-key-fingerprint/ts/tsconfig.json

@@ -10,5 +10,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true
   },
+  "references": [{ "path": "../../pq-key-encoder/ts" }],
   "include": ["src"]
 }