fix: Export error code type union to get typesense for error handling.

Author: jortsupetterson

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,14 +4,14 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

jsr.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@sovereignbase/bytecodec",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "exports": "./src/index.ts",
   "publish": {
     "include": [

src/.errors/class.ts

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/**
+ * All structured error codes thrown by the bytecodec.
+ */
 export type BytecodecErrorCode =
   | 'BASE64_DECODER_UNAVAILABLE'
   | 'BASE64_ENCODER_UNAVAILABLE'
@@ -38,9 +41,21 @@ export type BytecodecErrorCode =
   | 'Z85_INVALID_CHARACTER'
   | 'Z85_INVALID_LENGTH'
 
+/**
+ * Error type used by the bytecodec helpers to expose a stable error code.
+ */
 export class BytecodecError extends Error {
+  /**
+   * Machine-readable error code for programmatic handling.
+   */
   readonly code: BytecodecErrorCode
 
+  /**
+   * Creates a new bytecodec error with a package-prefixed message.
+   *
+   * @param code Stable error code describing the failure category.
+   * @param message Optional human-readable detail appended to the package prefix.
+   */
   constructor(code: BytecodecErrorCode, message?: string) {
     const detail = message ?? code
     super(`{@sovereignbase/bytecodec} ${detail}`)

src/index.ts

@@ -56,6 +56,8 @@ export type ByteSource =
   | ArrayBufferView
   | number[]
 
+export type { BytecodecErrorCode } from './.errors/class.js'
+
 export {
   /***/
   fromBase64String,

test/e2e/runsInBrowsers/run.mjs

@@ -42,7 +42,9 @@ async function waitForServer(baseURL, child) {
 
   while (Date.now() - startedAt < 10_000) {
     if (child.exitCode !== null)
-      throw new Error(`browser test server exited early with code ${child.exitCode}`)
+      throw new Error(
+        `browser test server exited early with code ${child.exitCode}`
+      )
 
     try {
       const response = await fetch(baseURL)
@@ -83,10 +85,8 @@ async function main() {
       })
     })
 
-    if (result.signal)
-      process.exitCode = 1
-    else if (result.code !== 0)
-      process.exitCode = result.code ?? 1
+    if (result.signal) process.exitCode = 1
+    else if (result.code !== 0) process.exitCode = result.code ?? 1
   } finally {
     if (server.exitCode === null) {
       server.kill('SIGTERM')

test/e2e/runsInBrowsers/runner.js

@@ -1,8 +1,5 @@
 import * as api from '/dist/index.js'
-import {
-  printResults,
-  runBytecodecSuite,
-} from '../shared/suite.mjs'
+import { printResults, runBytecodecSuite } from '../shared/suite.mjs'
 
 const results = await runBytecodecSuite(api, { label: 'browser esm' })
 printResults(results)

test/e2e/runsInCloudflareWorkers/run.mjs

@@ -24,7 +24,13 @@ const workerEntry = resolve(
   'runsInCloudflareWorkers',
   'worker.mjs'
 )
-const wranglerBin = resolve(root, 'node_modules', 'wrangler', 'bin', 'wrangler.js')
+const wranglerBin = resolve(
+  root,
+  'node_modules',
+  'wrangler',
+  'bin',
+  'wrangler.js'
+)
 
 function withTimeout(promise, timeoutMs, name) {
   let timer
@@ -111,7 +117,9 @@ async function fetchWorkerResults(url, child, logLines) {
       if (
         error instanceof TypeError ||
         (error instanceof Error &&
-          /fetch failed|ECONNREFUSED|ENOTFOUND|socket hang up/i.test(error.message))
+          /fetch failed|ECONNREFUSED|ENOTFOUND|socket hang up/i.test(
+            error.message
+          ))
       ) {
         await delay(POLL_INTERVAL_MS)
         continue

test/e2e/runsInDeno/run.mjs

@@ -4,13 +4,9 @@ import { spawnSync } from 'node:child_process'
 const script = resolve(process.cwd(), 'test', 'e2e', 'runsInDeno', 'runner.mjs')
 const result =
   process.platform === 'win32'
-    ? spawnSync(
-        'pwsh',
-        ['-NoProfile', '-Command', `deno run "${script}"`],
-        {
-          stdio: 'inherit',
-        }
-      )
+    ? spawnSync('pwsh', ['-NoProfile', '-Command', `deno run "${script}"`], {
+        stdio: 'inherit',
+      })
     : spawnSync('deno', ['run', script], {
         stdio: 'inherit',
       })