ox 0.9.13 → 0.9.15

package/core/Errors.ts

@@ -18,13 +18,31 @@ export class BaseError<
 > extends Error {
   details: string
   docs?: string | undefined
+  docsOrigin?: string | undefined
   docsPath?: string | undefined
   shortMessage: string
+  showVersion?: boolean | undefined
   version?: string | undefined
 
   override cause: cause
   override name = 'BaseError'
 
+  static defaultStaticOptions = {
+    docsOrigin: 'https://oxlib.sh',
+    showVersion: false,
+    version: `ox@${getVersion()}`,
+  } satisfies BaseError.GlobalOptions
+
+  static setStaticOptions(options: BaseError.GlobalOptions) {
+    BaseError.prototype.docsOrigin = options.docsOrigin
+    BaseError.prototype.showVersion = options.showVersion
+    BaseError.prototype.version = options.version
+  }
+
+  static {
+    BaseError.setStaticOptions(BaseError.defaultStaticOptions)
+  }
+
   constructor(shortMessage: string, options: BaseError.Options<cause> = {}) {
     const details = (() => {
       if (options.cause instanceof BaseError) {
@@ -46,18 +64,22 @@ export class BaseError<
       return options.docsPath
     })()
 
-    const docsBaseUrl = options.docsOrigin ?? 'https://oxlib.sh'
+    const docsBaseUrl = options.docsOrigin ?? BaseError.prototype.docsOrigin
     const docs = `${docsBaseUrl}${docsPath ?? ''}`
+    const showVersion = Boolean(
+      options.version ?? BaseError.prototype.showVersion,
+    )
+    const version = options.version ?? BaseError.prototype.version
 
     const message = [
       shortMessage || 'An error occurred.',
       ...(options.metaMessages ? ['', ...options.metaMessages] : []),
-      ...(details || docsPath || options.version
+      ...(details || docsPath || showVersion
         ? [
             '',
             details ? `Details: ${details}` : undefined,
             docsPath ? `See: ${docs}` : undefined,
-            options.version ? `Version: ${options.version}` : undefined,
+            showVersion ? `Version: ${version}` : undefined,
           ]
         : []),
     ]
@@ -69,9 +91,11 @@ export class BaseError<
     this.cause = options.cause as any
     this.details = details
     this.docs = docs
+    this.docsOrigin = docsBaseUrl
     this.docsPath = docsPath
     this.shortMessage = shortMessage
-    this.version = options.version ?? `ox@${getVersion()}`
+    this.showVersion = showVersion
+    this.version = version
   }
 
   walk(): Error
@@ -83,11 +107,26 @@ export class BaseError<
 
 export declare namespace BaseError {
   type Options<cause extends Error | undefined = Error | undefined> = {
+    /** Cause of the error. */
     cause?: cause | undefined
+    /** Details of the error. */
     details?: string | undefined
+    /** Origin of the docs. */
     docsOrigin?: string | undefined
+    /** Path of the docs. */
     docsPath?: string | undefined
+    /** Meta messages to add to the error. */
     metaMessages?: (string | undefined)[] | undefined
+    /** Version of the library to attribute the error to. */
+    version?: string | undefined
+  }
+
+  type GlobalOptions = {
+    /** Origin of the docs. */
+    docsOrigin?: string | undefined
+    /** Whether to show the version of the library in the error message. */
+    showVersion?: boolean | undefined
+    /** Version of the library to attribute the error to. */
     version?: string | undefined
   }
 }

package/core/WebAuthnP256.ts

@@ -783,3 +783,31 @@ export class CredentialRequestFailedError extends Errors.BaseError<Error> {
     })
   }
 }
+
+// Export types required for inference.
+export type {
+  AttestationConveyancePreference,
+  AuthenticationExtensionsClientInputs,
+  AuthenticatorAttachment,
+  AuthenticatorSelectionCriteria,
+  AuthenticatorTransport,
+  BufferSource,
+  COSEAlgorithmIdentifier,
+  Credential,
+  CredentialCreationOptions,
+  CredentialMediationRequirement,
+  CredentialRequestOptions,
+  LargeBlobSupport,
+  PrfExtension,
+  PublicKeyCredential,
+  PublicKeyCredentialCreationOptions,
+  PublicKeyCredentialDescriptor,
+  PublicKeyCredentialEntity,
+  PublicKeyCredentialParameters,
+  PublicKeyCredentialRequestOptions,
+  PublicKeyCredentialRpEntity,
+  PublicKeyCredentialType,
+  PublicKeyCredentialUserEntity,
+  ResidentKeyRequirement,
+  UserVerificationRequirement,
+} from './internal/webauthn.js'

package/index.ts

@@ -1298,6 +1298,39 @@ export * as Bytes from './core/Bytes.js'
 
 export * as Caches from './core/Caches.js'
 
+/**
+ * Functions for encoding and decoding CBOR (Concise Binary Object Representation) data.
+ *
+ * CBOR is a binary data format designed for compact data representation and efficient parsing.
+ * It supports all JSON data types plus additional types like byte strings, tags, and simple values.
+ *
+ * @example
+ * ### Encoding Values to CBOR
+ *
+ * Values can be encoded to CBOR using {@link ox#Cbor.(encode:function)}:
+ *
+ * ```ts twoslash
+ * import { Cbor } from 'ox'
+ *
+ * Cbor.encode({ foo: 'bar', baz: [1, 2, 3] })
+ * // @log: '0xa263666f6f636261726362617a83010203'
+ * ```
+ *
+ * ### Decoding CBOR to Values
+ *
+ * Values can be decoded from CBOR using {@link ox#Cbor.(decode:function)}:
+ *
+ * ```ts twoslash
+ * import { Cbor } from 'ox'
+ *
+ * Cbor.decode('0xa263666f6f636261726362617a83010203')
+ * // @log: { foo: 'bar', baz: [1, 2, 3] }
+ * ```
+ *
+ * @category Data
+ */
+export * as Cbor from './core/Cbor.js'
+
 /**
  * Utility functions for computing Contract Addresses.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.9.13",
+  "version": "0.9.15",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -168,6 +168,11 @@
       "import": "./_esm/core/Caches.js",
       "default": "./_cjs/core/Caches.js"
     },
+    "./Cbor": {
+      "types": "./_types/core/Cbor.d.ts",
+      "import": "./_esm/core/Cbor.js",
+      "default": "./_cjs/core/Cbor.js"
+    },
     "./ContractAddress": {
       "types": "./_types/core/ContractAddress.d.ts",
       "import": "./_esm/core/ContractAddress.js",

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.9.13'
+export const version = '0.9.15'