Class BundleDatabase

This class handles all the database interactions required to creating a bundle.

Hierarchy

BundleDatabase

Index

Constructors

Properties

assetRepository bundleRepository connectionRepository dataSource keyRepository

Methods

getAssetsVersions getBundleFromVersions getConnectionsVersions getLatestKeyVersion getLatestVersions saveBundle

Constructors

constructor

new BundleDatabase(dataSource): BundleDatabase
Initializes the class for communication with the database. The dataSource should point to a database initialized with the model defined in the auth-core package.

See
https://typeorm.io/data-source

Throws
ConnectionNotInitializedError If the dataSource is not initialized.
Parameters
- dataSource: DataSource
  
  The typeorm dataSource to use in the class
Returns BundleDatabase
- Defined in packages/auth-bundler/src/db.ts:24

Properties

`Private` `Readonly` assetRepository

assetRepository: Repository<Asset>

`Private` `Readonly` bundleRepository

bundleRepository: Repository<Bundle>

`Private` `Readonly` connectionRepository

connectionRepository: Repository<Connection>

`Private` `Readonly` dataSource

dataSource: DataSource

The typeorm dataSource to use in the class

`Private` `Readonly` keyRepository

keyRepository: Repository<Key>

Methods

`Private` getAssetsVersions

getAssetsVersions(environment): Promise<{
name: string;
version: number;
}[]>
Parameters
- environment: string
Returns Promise<{
name: string;
version: number;
}[]>
- Defined in packages/auth-bundler/src/db.ts:101

getBundleFromVersions

getBundleFromVersions(versions): Promise<BundleContent>
Retrieves the values of the assets, connections and key based on the supplied versions
Parameters
- versions: BundleContentVersions
  
  The requested versions to be retrieved
Returns Promise<BundleContent>
All the values based on the supplied versions
- Defined in packages/auth-bundler/src/db.ts:74

`Private` getConnectionsVersions

getConnectionsVersions(environment): Promise<{
name: string;
version: number;
}[]>
Parameters
- environment: string
Returns Promise<{
name: string;
version: number;
}[]>
- Defined in packages/auth-bundler/src/db.ts:127

`Private` getLatestKeyVersion

getLatestKeyVersion(environment): Promise<null | number>
Parameters
- environment: string
Returns Promise<null | number>
- Defined in packages/auth-bundler/src/db.ts:113

getLatestVersions

getLatestVersions(env): Promise<BundleContentVersions>
Retrieves all the latest assets, connections and key versions based on requested environment
Parameters
- env: Environment
  
  The environment for which to retrieve the versions
Returns Promise<BundleContentVersions>
An object describing all the latest versions
- Defined in packages/auth-bundler/src/db.ts:39

saveBundle

saveBundle(versions, hash): Promise<number>
Saved the metadata of the bundle into the database
Parameters
- versions: BundleContentVersions
  
  The versions of the bundle content
- hash: string
  
  The md5 hash of the created bundle tarball
Returns Promise<number>
The ID of the created bundle
- Defined in packages/auth-bundler/src/db.ts:55

Generated using TypeDoc