Class BundleDatabase

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

Index

Constructors

Methods

getBundleFromVersions getLatestBundleByEnv getLatestVersions saveBundle

Constructors

constructor

new BundleDatabase(pool: Pool): 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.
Parameters
- pool: Pool
Returns BundleDatabase
Throws
ConnectionNotInitializedError If the dataSource is not initialized.
- Defined in packages/auth-bundler/src/db.ts:62

Methods

getBundleFromVersions

getBundleFromVersions(versions: BundleContentVersions): 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:116

getLatestBundleByEnv

getLatestBundleByEnv(
    env: "np" | "stage" | "prod",
): Promise<
    | {
        assets: { name: string; version: number }[]
        | null;
        connections: { name: string; version: number }[] | null;
        createdAt: Date;
        environment: "np" | "stage" | "prod";
        hash: string | null;
        id: number;
        keyVersion: number | null;
        metadata: Record<string, unknown> | null;
        opaVersion: string;
        revision: string;
    }
    | null,
>
Parameters
- env: "np" | "stage" | "prod"
Returns Promise<
    | {
        assets: { name: string; version: number }[]
        | null;
        connections: { name: string; version: number }[] | null;
        createdAt: Date;
        environment: "np" | "stage" | "prod";
        hash: string | null;
        id: number;
        keyVersion: number | null;
        metadata: Record<string, unknown> | null;
        opaVersion: string;
        revision: string;
    }
    | null,
>
- Defined in packages/auth-bundler/src/db.ts:81

getLatestVersions

getLatestVersions(env: "np" | "stage" | "prod"): Promise<BundleContentVersions>
Retrieves all the latest assets, connections and key versions based on requested environment
Parameters
- env: "np" | "stage" | "prod"
  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:71

saveBundle

saveBundle(
    versions: BundleContentVersions,
    hash: string,
    revision: string,
): 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
- revision: string
Returns Promise<number>
The ID of the created bundle
- Defined in packages/auth-bundler/src/db.ts:95