@l-v-yonsama/multi-platform-database-drivers 1.3.0 → 2.0.0

package/built/src/resource/DbResource.d.ts

@@ -1,373 +0,0 @@
-import { CompareKey, GeneralColumnType } from '@l-v-yonsama/rdh';
-import { AwsServiceType, AwsSetting, AwsSQSAttributes, AwsDynamoTableAttributes, AwsSESIdentityAttributes, AwsSsmParameterAttributes, AwsSecretAttributes, AwsCfnStackAttributes, ConnectionEnvironment, ConnectionSetting, DBType, FirebaseSetting, ForeignKeyConstraint, IamSolutionSetting, RedisKeyType, ResourceType, SQLServerSetting, SshSetting, SslSetting, TransactionIsolationLevel, UniqueKeyConstraint, ResourceFilter, MqttSetting, MqttQoS } from '../types';
-export interface SchemaAndTableName {
-    schema?: string;
-    table: string;
-}
-export interface SchemaAndTableHints {
-    list: SchemaAndTableName[];
-}
-export declare function fromJson<T extends DbResource = DbResource>(json: T): T;
-export type DbDatabase = RdsDatabase | AwsDatabase | RedisDatabase | MemcacheDatabase | Auth0Database | KeycloakDatabase | MqttDatabase;
-export type AllSubDbResource = DbDatabase | DbSchema | DbTable | DbKey | DbColumn | DbS3Bucket | DbSQSQueue | DbLogGroup | DbLogStream | DbS3Owner | DbDynamoTable | DbDynamoTableColumn | DbSESIdentity | DbSsmParameter | DbSecretsManagerSecret | DbCfnStack | DbResourceGroup | DbSubscription | IamRealm | IamClient | IamOrganization | IamUser | IamGroup | IamRole;
-export type IamResourceType = 'users' | 'groups' | 'roles';
-export declare abstract class DbResource<T extends DbResource = AllSubDbResource> {
-    readonly id: string;
-    readonly resourceType: ResourceType;
-    readonly name: string;
-    comment?: string;
-    readonly children: Array<T>;
-    meta: {
-        [key: string]: any;
-    };
-    isInProgress?: boolean;
-    constructor(resourceType: ResourceType, name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-    addChild(res: T): T;
-    hasChildren(): boolean;
-    clearChildren(): void;
-    getChildByName(name: string, insensitive?: boolean): T | undefined;
-    findChildren<U extends DbResource = AllSubDbResource>({ keyword, resourceType, recursively, }: {
-        resourceType: ResourceType;
-        keyword?: string | RegExp;
-        recursively?: boolean;
-    }): U[];
-    toString(): string;
-    toJsonStringify(space?: number): string;
-}
-export declare class DbConnection extends DbResource<DbDatabase> implements ConnectionSetting {
-    dbType: DBType;
-    name: string;
-    environment?: ConnectionEnvironment;
-    url?: string;
-    host?: string;
-    port?: number;
-    user?: string;
-    password?: string;
-    database?: string;
-    databaseVersion?: number;
-    ds?: string;
-    isConnected: boolean;
-    apiVersion?: string;
-    ssh?: SshSetting;
-    ssl?: SslSetting;
-    awsSetting?: AwsSetting;
-    iamSolution?: IamSolutionSetting;
-    mqttSetting?: MqttSetting;
-    firebase?: FirebaseSetting;
-    sqlServer?: SQLServerSetting;
-    timezone?: string;
-    readOnly?: boolean;
-    transactionIsolationLevel?: TransactionIsolationLevel;
-    connectTimeoutMs?: number;
-    queryTimeoutMs?: number;
-    lockWaitTimeoutMs?: number;
-    resourceFilter?: ResourceFilter;
-    constructor(prop: any);
-    hasUrl(): boolean;
-    hasSshSetting(): boolean;
-}
-export declare class RdsDatabase extends DbResource<DbSchema> {
-    version?: number;
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-    getSchema(option: {
-        name?: string;
-        isDefault?: boolean;
-    }): DbSchema;
-}
-export declare class AwsDatabase extends DbResource<DbS3Bucket | DbSQSQueue | DbLogGroup | DbS3Owner | DbDynamoTable | DbSESIdentity | DbSsmParameter | DbSecretsManagerSecret | DbCfnStack | DbResourceGroup> {
-    readonly serviceType: AwsServiceType;
-    constructor(name: string, serviceType: AwsServiceType);
-}
-export declare class RedisDatabase extends DbResource<DbKey> {
-    numOfKeys: number;
-    constructor(name: string, numOfKeys: number);
-    getDBIndex(): number;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class MemcacheDatabase extends DbResource<DbKey> {
-    servers: string;
-    hot: number;
-    warm: number;
-    cold: number;
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class MqttDatabase extends DbResource<DbSubscription> {
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class KeycloakDatabase extends DbResource<IamRealm> {
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-    getRealm(option: {
-        name?: string;
-        isDefault?: boolean;
-    }): IamRealm;
-}
-export declare class Auth0Database extends DbResource<IamClient | IamUser | IamGroup | IamRole> {
-    isDefault: boolean;
-    numOfUsers: number;
-    numOfOrganizations: number;
-    constructor(name: string);
-    getClientByName(name: string): IamClient | undefined;
-    getUserByName(name: string): IamUser | undefined;
-    getGroupByName(name: string): IamGroup | undefined;
-    getRoleByName(name: string): IamRole | undefined;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class IamRealm extends DbResource<IamClient | IamUser | IamGroup | IamRole> {
-    isDefault: boolean;
-    numOfUsers: number;
-    numOfGroups: number;
-    constructor(name: string);
-    getClientByName(name: string): IamClient | undefined;
-    getUserByName(name: string): IamUser | undefined;
-    getGroupByName(name: string): IamGroup | undefined;
-    getRoleByName(name: string): IamRole | undefined;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class IamClient extends DbResource {
-    baseUrl: string;
-    protocol: string;
-    clientId: string;
-    standardFlowEnabled?: boolean;
-    implicitFlowEnabled?: boolean;
-    directAccessGrantsEnabled?: boolean;
-    numOfUserSessions?: number;
-    numOfOfflineSessions?: number;
-    appType: string;
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class IamUser extends DbResource {
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class IamGroup extends DbResource {
-    constructor(name: string);
-}
-export declare class IamOrganization extends DbResource {
-    constructor(name: string);
-}
-export declare class IamRole extends DbResource {
-    constructor(name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbSchema extends DbResource<DbTable> {
-    isDefault: boolean;
-    constructor(name: string);
-    getUniqColumnNameWithComments(): {
-        name: string;
-        comment?: string;
-    }[];
-}
-export interface ITableComparable {
-    getCompareKeys(availableColumnNames?: string[]): CompareKey[];
-}
-export declare class DbTable extends DbResource<DbColumn> implements ITableComparable {
-    tableType: any;
-    foreignKeys?: ForeignKeyConstraint;
-    uniqueKeys?: UniqueKeyConstraint[];
-    constructor(name: string, tableType: any, comment?: string);
-    getCompareKeys(availableColumnNames?: string[]): CompareKey[];
-    getPrimaryColumnNames(): string[];
-    getUniqColumnNames(): string[];
-    toString(): string;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbKey<T extends RedisKeyParams | MemcacheKeyParams | S3KeyParams | SQSMessageParams | LogMessageParams = any> extends DbResource {
-    readonly params: T;
-    constructor(name: string, params: T);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export type RedisKeyParams = {
-    type: RedisKeyType;
-    ttl: number;
-    val?: any;
-    base64?: string;
-};
-export type MemcacheKeyParams = {
-    slabId: number;
-    val?: any;
-    base64?: string;
-};
-export type S3KeyParams = {
-    downloadUrl?: string;
-    outputFilePath?: string;
-    lastModified: Date;
-    etag: string;
-    size: number;
-    storageClass: string;
-    stringValue?: string;
-    encodedBase64?: boolean;
-    deleteMarker?: boolean;
-    versionId?: string;
-    cacheControl?: string;
-    contentDisposition?: string;
-    contentEncoding?: string;
-    contentType?: string;
-};
-export type SQSMessageParams = {
-    body: string;
-    receiptHandle: string;
-    md5OfBody: string;
-    sentTimestamp: Date;
-    approximateFirstReceiveTimestamp: Date;
-};
-export type LogMessageParams = {
-    message: string;
-};
-export declare class DbColumn extends DbResource {
-    readonly colType: GeneralColumnType;
-    readonly nullable: boolean;
-    readonly primaryKey: boolean;
-    readonly uniqKey: boolean;
-    readonly default: any;
-    readonly extra: any;
-    constructor(name: string, colType: GeneralColumnType, params: any, comment?: string);
-    toString(): string;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class AwsDbResource<T = any, U extends AllSubDbResource = any> extends DbResource<U> {
-    readonly attr: T;
-    private dateProperties?;
-    private byteProperties?;
-    constructor(resourceType: ResourceType, name: string, attr: T);
-    protected setPropertyFormat({ dates, bytes, }: {
-        dates?: string[];
-        bytes?: string[];
-    }): void;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbDynamoTable extends AwsDbResource<AwsDynamoTableAttributes, DbDynamoTableColumn> implements ITableComparable {
-    constructor(name: string, attr: AwsDynamoTableAttributes);
-    getProperties(): {
-        [key: string]: any;
-    };
-    getPrimaryColumnNames(): string[];
-    getPkAndSkByIndex(indexName?: string): {
-        pk?: string;
-        sk?: string;
-    };
-    getCompareKeys(availableColumnNames?: string[]): CompareKey[];
-}
-export declare class DbDynamoTableColumn extends DbResource {
-    readonly attrType: string;
-    readonly pk: boolean;
-    readonly sk: boolean;
-    constructor(name: string, attrType: string, pk: boolean, sk: boolean);
-    toString(): string;
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbS3Bucket extends AwsDbResource<{
-    CreationDate?: Date;
-}> {
-    constructor(name?: string, CreationDate?: Date);
-}
-export declare class DbSubscription extends DbResource {
-    readonly qos: MqttQoS;
-    isSubscribed: boolean;
-    readonly nl?: boolean;
-    readonly rap?: boolean;
-    readonly rh?: number;
-    constructor(name: string, qos: MqttQoS, options?: {
-        nl?: boolean;
-        rap?: boolean;
-        rh?: number;
-    });
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbSQSQueue extends AwsDbResource<AwsSQSAttributes> {
-    readonly url: string;
-    constructor(name: string, url: string, attr: AwsSQSAttributes);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbLogGroup extends AwsDbResource<{
-    creationTime?: number;
-    storedBytes?: number;
-    retentionInDays?: number;
-    kmsKeyId?: string;
-}> {
-    constructor(name: string, attr: {
-        creationTime?: number;
-        storedBytes?: number;
-        retentionInDays?: number;
-        kmsKeyId?: string;
-    });
-}
-export declare class DbLogStream extends AwsDbResource<{
-    creationTime: Date;
-    firstEventTimestamp: Date;
-    lastEventTimestamp: Date;
-    lastIngestionTime: Date;
-}> {
-    constructor(name: string, attr: {
-        creationTime: Date;
-        firstEventTimestamp: Date;
-        lastEventTimestamp: Date;
-        lastIngestionTime: Date;
-    });
-}
-export declare class DbS3Owner extends AwsDbResource<{}> {
-    readonly ownerId: string;
-    constructor(ownerId: string, name: string);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbSESIdentity extends AwsDbResource<AwsSESIdentityAttributes> {
-    constructor(name: string, attr: AwsSESIdentityAttributes);
-    getProperties(): {
-        [key: string]: any;
-    };
-}
-export declare class DbSsmParameter extends AwsDbResource<AwsSsmParameterAttributes> {
-    constructor(name: string, attr: AwsSsmParameterAttributes);
-}
-export declare class DbSecretsManagerSecret extends AwsDbResource<AwsSecretAttributes> {
-    constructor(name: string, attr: AwsSecretAttributes);
-}
-export declare class DbCfnStack extends AwsDbResource<AwsCfnStackAttributes> {
-    constructor(name: string, attr: AwsCfnStackAttributes);
-}
-export declare class DbResourceGroup extends DbResource {
-    constructor(name: string);
-}