Migrate server service docstrings so they render

packages/server/src/services/metadataService.ts

@@ -42,11 +42,30 @@ type VerificationMode = 'permissive' | 'strict';
 const log = getLogger('MetadataService');
 
 interface MetadataService {
+  /**
+   * Prepare the service to handle remote MDS servers and/or cache local metadata statements.
+   *
+   * **Options:**
+   *
+   * @param opts.mdsServers An array of URLs to FIDO Alliance Metadata Service
+   * (version 3.0)-compatible servers. Defaults to the official FIDO MDS server
+   * @param opts.statements An array of local metadata statements
+   * @param opts.verificationMode How MetadataService will handle unregistered AAGUIDs. Defaults to
+   * `"strict"` which throws errors during registration response verification when an
+   * unregistered AAGUID is encountered. Set to `"permissive"` to allow registration by
+   * authenticators with unregistered AAGUIDs
+   */
   initialize(opts?: {
     mdsServers?: string[];
     statements?: MetadataStatement[];
     verificationMode?: VerificationMode;
   }): Promise<void>;
+  /**
+   * Get a metadata statement for a given AAGUID.
+   *
+   * This method will coordinate updating the cache as per the `nextUpdate` property in the initial
+   * BLOB download.
+   */
   getStatement(aaguid: string | Uint8Array): Promise<MetadataStatement | undefined>;
 }
 
@@ -62,19 +81,6 @@ export class BaseMetadataService implements MetadataService {
   private state: SERVICE_STATE = SERVICE_STATE.DISABLED;
   private verificationMode: VerificationMode = 'strict';
 
-  /**
-   * Prepare the service to handle remote MDS servers and/or cache local metadata statements.
-   *
-   * **Options:**
-   *
-   * @param opts.mdsServers An array of URLs to FIDO Alliance Metadata Service
-   * (version 3.0)-compatible servers. Defaults to the official FIDO MDS server
-   * @param opts.statements An array of local metadata statements
-   * @param opts.verificationMode How MetadataService will handle unregistered AAGUIDs. Defaults to
-   * `"strict"` which throws errors during registration response verification when an
-   * unregistered AAGUID is encountered. Set to `"permissive"` to allow registration by
-   * authenticators with unregistered AAGUIDs
-   */
   async initialize(
     opts: {
       mdsServers?: string[];
@@ -144,12 +150,6 @@ export class BaseMetadataService implements MetadataService {
     this.setState(SERVICE_STATE.READY);
   }
 
-  /**
-   * Get a metadata statement for a given AAGUID.
-   *
-   * This method will coordinate updating the cache as per the `nextUpdate` property in the initial
-   * BLOB download.
-   */
   async getStatement(
     aaguid: string | Uint8Array,
   ): Promise<MetadataStatement | undefined> {

packages/server/src/services/settingsService.ts

@@ -12,10 +12,21 @@ import { GlobalSign_Root_CA_R3 } from './defaultRootCerts/mds.ts';
 type RootCertIdentifier = AttestationFormat | 'mds';
 
 interface SettingsService {
+  /**
+   * Set potential root certificates for attestation formats that use them. Root certs will be tried
+   * one-by-one when validating a certificate path.
+   *
+   * Certificates can be specified as a raw `Buffer`, or as a PEM-formatted string. If a
+   * `Buffer` is passed in it will be converted to PEM format.
+   */
   setRootCertificates(opts: {
     identifier: RootCertIdentifier;
     certificates: (Uint8Array | string)[];
   }): void;
+
+  /**
+   * Get any registered root certificates for the specified attestation format
+   */
   getRootCertificates(opts: { identifier: RootCertIdentifier }): string[];
 }
 
@@ -27,13 +38,6 @@ class BaseSettingsService implements SettingsService {
     this.pemCertificates = new Map();
   }
 
-  /**
-   * Set potential root certificates for attestation formats that use them. Root certs will be tried
-   * one-by-one when validating a certificate path.
-   *
-   * Certificates can be specified as a raw `Buffer`, or as a PEM-formatted string. If a
-   * `Buffer` is passed in it will be converted to PEM format.
-   */
   setRootCertificates(opts: {
     identifier: RootCertIdentifier;
     certificates: (Uint8Array | string)[];
@@ -52,9 +56,6 @@ class BaseSettingsService implements SettingsService {
     this.pemCertificates.set(identifier, newCertificates);
   }
 
-  /**
-   * Get any registered root certificates for the specified attestation format
-   */
   getRootCertificates(opts: { identifier: RootCertIdentifier }): string[] {
     const { identifier } = opts;
     return this.pemCertificates.get(identifier) ?? [];