Add tsdoc (#107)

* Add tsdocs

* More tsdoc fixes

Author: rayokota

schemaregistry/rest-error.ts

@@ -1,10 +1,19 @@
+/**
+ * Represents a REST error.
+ */
 export class RestError extends Error {
   status: number;
   errorCode: number;
 
+  /**
+   * Creates a new REST error.
+   * @param message - The error message.
+   * @param status - The HTTP status code.
+   * @param errorCode - The error code.
+   */
   constructor(message: string, status: number, errorCode: number) {
     super(message + "; Error code: " + errorCode);
     this.status = status;
     this.errorCode = errorCode;
   }
-}
+}

schemaregistry/rules/encryption/awskms/aws-driver.ts

@@ -8,6 +8,9 @@ export class AwsKmsDriver implements KmsDriver {
   static ACCESS_KEY_ID = 'access.key.id'
   static SECRET_ACCESS_KEY = 'secret.access.key'
 
+  /**
+   * Register the AWS KMS driver with the KMS registry.
+   */
   static register(): void {
     registerKmsDriver(new AwsKmsDriver())
   }

schemaregistry/rules/encryption/azurekms/azure-driver.ts

@@ -9,6 +9,9 @@ export class AzureKmsDriver implements KmsDriver {
   static CLIENT_ID = 'client.id'
   static CLIENT_SECRET = 'client.secret'
 
+  /**
+   * Register the Azure KMS driver with the KMS registry.
+   */
   static register(): void {
     registerKmsDriver(new AzureKmsDriver())
   }

schemaregistry/rules/encryption/encrypt-executor.ts

@@ -64,6 +64,9 @@ export class FieldEncryptionExecutor extends FieldRuleExecutor {
   client: Client | null = null
   clock: Clock
 
+  /**
+   * Register the field encryption executor with the rule registry.
+   */
   static register(): FieldEncryptionExecutor {
     return this.registerWithClock(new Clock())
   }

schemaregistry/rules/encryption/gcpkms/gcp-driver.ts

@@ -10,6 +10,9 @@ export class GcpKmsDriver implements KmsDriver {
   static PRIVATE_KEY_ID = "private.key.id";
   static PRIVATE_KEY= "private.key";
 
+  /**
+   * Register the GCP KMS driver with the KMS registry.
+   */
   static register(): void {
     registerKmsDriver(new GcpKmsDriver())
   }

schemaregistry/rules/encryption/hcvault/hcvault-driver.ts

@@ -7,6 +7,9 @@ export class HcVaultDriver implements KmsDriver {
   static TOKEN_ID = 'token.id'
   static NAMESPACE = 'namespace'
 
+  /**
+   * Register the HashiCorp Vault driver with the KMS registry.
+   */
   static register(): void {
     registerKmsDriver(new HcVaultDriver())
   }

schemaregistry/rules/encryption/kms-registry.ts

@@ -1,10 +1,16 @@
 import {SecurityException} from "./tink/exception/security_exception";
 
+/**
+ * Key management service (KMS) driver.
+ */
 export interface KmsDriver {
   getKeyUrlPrefix(): string
   newKmsClient(config: Map<string, string>, keyUrl: string): KmsClient
 }
 
+/**
+ * Key management service (KMS) client.
+ */
 export interface KmsClient {
   supported(keyUri: string): boolean
   encrypt(plaintext: Buffer): Promise<Buffer>
@@ -16,10 +22,18 @@ const kmsDrivers: KmsDriver[] = []
 const kmsClients: KmsClient[] = []
 
 
+/**
+ * Register a KMS driver.
+ * @param kmsDriver - the KMS driver to register
+ */
 export function registerKmsDriver(kmsDriver: KmsDriver): void {
   kmsDrivers.push(kmsDriver)
 }
 
+/**
+ * Get the KMS driver for the given key URL.
+ * @param keyUrl - the key URL
+ */
 export function getKmsDriver(keyUrl: string): KmsDriver {
   for (let driver of kmsDrivers) {
     if (keyUrl.startsWith(driver.getKeyUrlPrefix())) {
@@ -29,10 +43,18 @@ export function getKmsDriver(keyUrl: string): KmsDriver {
   throw new SecurityException('no KMS driver found for key URL: ' + keyUrl)
 }
 
+/**
+ * Register a KMS client.
+ * @param kmsClient - the KMS client to register
+ */
 export function registerKmsClient(kmsClient: KmsClient): void {
   kmsClients.push(kmsClient)
 }
 
+/**
+ * Get the KMS client for the given key URL.
+ * @param keyUrl - the key URL
+ */
 export function getKmsClient(keyUrl: string): KmsClient | null {
   for (let client of kmsClients) {
     if (client.supported(keyUrl)) {
@@ -42,6 +64,9 @@ export function getKmsClient(keyUrl: string): KmsClient | null {
   return null
 }
 
+/**
+ * Clear the KMS clients.
+ */
 export function clearKmsClients(): void {
   kmsClients.length = 0
 }

schemaregistry/rules/encryption/localkms/local-driver.ts

@@ -6,6 +6,9 @@ export class LocalKmsDriver implements KmsDriver {
   static PREFIX: string = 'local-kms://'
   static SECRET: string = 'secret'
 
+  /**
+   * Register the local KMS driver with the KMS registry.
+   */
   static register(): void {
     registerKmsDriver(new LocalKmsDriver())
   }

schemaregistry/rules/encryption/tink/aead.ts

@@ -1,5 +1,4 @@
 /**
- * @license
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -21,13 +20,13 @@ export abstract class Aead {
    * data. The resulting ciphertext allows for checking authenticity and
    * integrity of associated data, but does not guarantee its secrecy.
    *
-   * @param plaintext the plaintext to be encrypted. It must be
+   * @param plaintext - the plaintext to be encrypted. It must be
    *     non-null, but can also be an empty (zero-length) byte array.
-   * @param opt_associatedData  optional associated data to be
+   * @param opt_associatedData - optional associated data to be
    *     authenticated, but not encrypted. A null value is equivalent to an
    *     empty (zero-length) byte array. For successful decryption the same
    *     associated data must be provided along with the ciphertext.
-   * @return resulting ciphertext
+   * @returns resulting ciphertext
    *
    */
   abstract encrypt(plaintext: Uint8Array, opt_associatedData?: Uint8Array|null):
@@ -38,13 +37,13 @@ export abstract class Aead {
    * The decryption verifies the authenticity and integrity of the associated
    * data, but there are no guarantees wrt. secrecy of that data.
    *
-   * @param ciphertext the ciphertext to be decrypted, must be
+   * @param ciphertext - the ciphertext to be decrypted, must be
    *     non-null.
-   * @param opt_associatedData  optional associated data to be
+   * @param opt_associatedData - optional associated data to be
    *     authenticated. A null value is equivalent to an empty (zero-length)
    *     byte array. For successful decryption the same associated data must be
    *     provided along with the ciphertext.
-   * @return resulting plaintext
+   * @returns resulting plaintext
    */
   abstract decrypt(
       ciphertext: Uint8Array,

schemaregistry/rules/encryption/tink/aes_gcm.ts

@@ -1,5 +1,4 @@
 /**
- * @license
  * Copyright 2020 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -27,7 +26,6 @@ const TAG_SIZE_IN_BITS: number = 128;
 /**
  * Implementation of AES-GCM.
  *
- * @final
  */
 export class AesGcm extends Aead {
   constructor(private readonly key: CryptoKey) {