From c862acdb7db271f1d5be17b5628f4e15dad54dca Mon Sep 17 00:00:00 2001
From: Matthew Miller <matthew@millerti.me>
Date: Sun, 8 Dec 2024 11:55:35 -0800
Subject: [PATCH] Add module definitions for ISO helpers

---
 packages/server/src/helpers/cose.ts                | 1 +
 packages/server/src/helpers/iso/isoBase64URL.ts    | 4 ++++
 packages/server/src/helpers/iso/isoCBOR.ts         | 4 ++++
 packages/server/src/helpers/iso/isoCrypto/index.ts | 4 ++++
 packages/server/src/helpers/iso/isoUint8Array.ts   | 5 +++++
 5 files changed, 18 insertions(+)

diff --git a/packages/server/src/helpers/cose.ts b/packages/server/src/helpers/cose.ts
index 4e0224059..ad062cab8 100644
--- a/packages/server/src/helpers/cose.ts
+++ b/packages/server/src/helpers/cose.ts
@@ -7,6 +7,7 @@
  *
  * These types are an unorthodox way of saying "these Maps should involve these discrete lists of
  * keys", but it works.
+ * @module
  */
 export type COSEPublicKey = {
   // Getters
diff --git a/packages/server/src/helpers/iso/isoBase64URL.ts b/packages/server/src/helpers/iso/isoBase64URL.ts
index 52c4bd838..6ad536c6e 100644
--- a/packages/server/src/helpers/iso/isoBase64URL.ts
+++ b/packages/server/src/helpers/iso/isoBase64URL.ts
@@ -1,3 +1,7 @@
+/**
+ * A runtime-agnostic collection of methods for working with Base64URL encoding
+ * @module
+ */
 import base64 from '@hexagon/base64';
 
 import type { Base64URLString } from '../../types/index.ts';
diff --git a/packages/server/src/helpers/iso/isoCBOR.ts b/packages/server/src/helpers/iso/isoCBOR.ts
index d48ca49c4..70f0e7ea4 100644
--- a/packages/server/src/helpers/iso/isoCBOR.ts
+++ b/packages/server/src/helpers/iso/isoCBOR.ts
@@ -1,3 +1,7 @@
+/**
+ * A runtime-agnostic collection of methods for working with CBOR encoding
+ * @module
+ */
 import * as tinyCbor from 'tiny-cbor';
 
 /**
diff --git a/packages/server/src/helpers/iso/isoCrypto/index.ts b/packages/server/src/helpers/iso/isoCrypto/index.ts
index 6d10ad1a6..ea9050950 100644
--- a/packages/server/src/helpers/iso/isoCrypto/index.ts
+++ b/packages/server/src/helpers/iso/isoCrypto/index.ts
@@ -1,3 +1,7 @@
+/**
+ * A runtime-agnostic collection of methods for working with the WebCrypto API
+ * @module
+ */
 export { digest } from './digest.ts';
 export { getRandomValues } from './getRandomValues.ts';
 export { verify } from './verify.ts';
diff --git a/packages/server/src/helpers/iso/isoUint8Array.ts b/packages/server/src/helpers/iso/isoUint8Array.ts
index 0df676379..f681c0d78 100644
--- a/packages/server/src/helpers/iso/isoUint8Array.ts
+++ b/packages/server/src/helpers/iso/isoUint8Array.ts
@@ -1,3 +1,8 @@
+/**
+ * A runtime-agnostic collection of methods for working with Uint8Arrays
+ * @module
+ */
+
 /**
  * Make sure two Uint8Arrays are deeply equivalent
  */