ula-vc-data-management/src/interface/data-storage.ts

A ULA data management plugin for W3C Verifiable Credentials

/*
 * Copyright 2020 Coöperatieve Rabobank U.A.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Interface for a generic key-value data storage
 * implementation. The implementation should
 * be able to get, set and remove data.
 *
 * The Verifiable Credential repository will be
 * using unique keys (nonces) and an index to
 * keep track of all the stored data.
 * @see VerifiableCredentialRepository
 */
export interface DataStorage {
  /**
   * Get data that corresponds to
   * the given key.
   *
   * @param {string} key
   * @return {Promise<any>}
   */
  get (key: string): Promise<any>

  /**
   * Set data for the given key,
   * so it can be retrieved
   * by using the same key.
   *
   * @param {string} key
   * @param value
   * @return {Promise<void>}
   */
  set (key: string, value: any): Promise<void>

  /**
   * Remove a single piece of data,
   * identified by the given key.
   *
   * @param {string} key
   * @return {Promise<void>}
   */
  remove (key: string): Promise<void>
}