@resistdesign/voltra 3.0.0-alpha.2 → 3.0.0-alpha.21

package/src/api/ORM/drivers/DynamoDBDataItemDBDriver.js

@@ -1,282 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DynamoDBSupportedDataItemDBDriverEntry = exports.DynamoDBDataItemDBDriver = void 0;
-const common_1 = require("./common");
-const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
-const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
-const uuid_1 = require("uuid");
-const SearchTypes_1 = require("../../../common/SearchTypes");
-const SearchUtils_1 = require("../../../common/SearchUtils");
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const TypeParsing_1 = require("../../../common/TypeParsing");
-const DynamoDBOperatorMappings = {
-    [SearchTypes_1.ComparisonOperators.EQUALS]: (fieldName) => `#${fieldName} = :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.NOT_EQUALS]: (fieldName) => `#${fieldName} <> :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.GREATER_THAN]: (fieldName) => `#${fieldName} > :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.GREATER_THAN_OR_EQUAL]: (fieldName) => `#${fieldName} >= :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.LESS_THAN]: (fieldName) => `#${fieldName} < :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.LESS_THAN_OR_EQUAL]: (fieldName) => `#${fieldName} <= :${fieldName}`,
-    [SearchTypes_1.ComparisonOperators.IN]: (fieldName) => `#${fieldName} IN (:${fieldName})`,
-    [SearchTypes_1.ComparisonOperators.LIKE]: (fieldName) => `contains(#${fieldName}, :${fieldName})`,
-    [SearchTypes_1.ComparisonOperators.EXISTS]: (fieldName) => `attribute_exists(#${fieldName})`,
-    [SearchTypes_1.ComparisonOperators.NOT_EXISTS]: (fieldName) => `attribute_not_exists(#${fieldName})`,
-    [SearchTypes_1.ComparisonOperators.IS_EMPTY]: (fieldName) => `size(#${fieldName}) = 0`,
-    [SearchTypes_1.ComparisonOperators.IS_NOT_EMPTY]: (fieldName) => `size(#${fieldName}) > 0`,
-    [SearchTypes_1.ComparisonOperators.BETWEEN]: (fieldName) => `#${fieldName} BETWEEN :${fieldName}_start AND :${fieldName}_end`,
-    [SearchTypes_1.ComparisonOperators.CONTAINS]: (fieldName) => `contains(#${fieldName}, :${fieldName})`,
-    [SearchTypes_1.ComparisonOperators.STARTS_WITH]: (fieldName) => `begins_with(#${fieldName}, :${fieldName})`,
-};
-const DynamoDBLogicalOperatorMappings = {
-    [SearchTypes_1.LogicalOperators.AND]: "AND",
-    [SearchTypes_1.LogicalOperators.OR]: "OR",
-};
-const createFilterExpression = (fieldCriteria, logicalOperator) => {
-    let output = {};
-    if (fieldCriteria && fieldCriteria.length > 0) {
-        const expressions = [];
-        const attributeNames = {};
-        const attributeValues = {};
-        for (const criterion of fieldCriteria) {
-            const { fieldName, operator, value } = criterion;
-            const createExpression = DynamoDBOperatorMappings[operator];
-            if (!createExpression) {
-                throw {
-                    message: common_1.DATA_ITEM_DB_DRIVER_ERRORS.SEARCH_COMPARISON_OPERATOR_NOT_SUPPORTED,
-                    operator,
-                    fieldName,
-                };
-            }
-            expressions.push(createExpression(fieldName));
-            attributeNames[`#${fieldName}`] = fieldName;
-            attributeValues[`:${fieldName}`] = value;
-        }
-        output = {
-            FilterExpression: expressions.join(` ${DynamoDBLogicalOperatorMappings[logicalOperator]} `),
-            ExpressionAttributeNames: attributeNames,
-            ExpressionAttributeValues: (0, util_dynamodb_1.marshall)(attributeValues),
-        };
-    }
-    return output;
-};
-const buildUpdateExpression = (updatedItem, uniquelyIdentifyingFieldName) => {
-    const updateExpressionParts = [];
-    const attributeNames = {};
-    const attributeValues = {};
-    for (const f in updatedItem) {
-        const value = updatedItem[f];
-        // IMPORTANT: DO NOT use the `uniquelyIdentifyingFieldName`.
-        if (f !== uniquelyIdentifyingFieldName && typeof value !== "undefined") {
-            const placeholderName = `#${f}`;
-            const placeholderValue = `:${f}`;
-            updateExpressionParts.push(`${placeholderName} = ${placeholderValue}`);
-            attributeNames[placeholderName] = f;
-            attributeValues[placeholderValue] = (0, util_dynamodb_1.marshall)(value);
-        }
-    }
-    return {
-        UpdateExpression: `SET ${updateExpressionParts.join(", ")}`,
-        ExpressionAttributeNames: attributeNames,
-        ExpressionAttributeValues: attributeValues,
-    };
-};
-const buildSelectedFieldParams = (selectedFields) => {
-    const selectedFieldParams = typeof (selectedFields ?? false) && Array.isArray(selectedFields)
-        ? {
-            ExpressionAttributeNames: selectedFields.reduce((acc, field) => {
-                const fieldAsString = String(field);
-                acc[`#${fieldAsString}`] = fieldAsString;
-                return acc;
-            }, {}),
-            ProjectionExpression: selectedFields
-                .map((field) => `#${String(field)}`)
-                .join(", "),
-        }
-        : {};
-    return selectedFieldParams;
-};
-/**
- * A {@link DataItemDBDriver} that uses DynamoDB as its database.
- * */
-class DynamoDBDataItemDBDriver {
-    config;
-    dynamoDBClient;
-    constructor(config) {
-        this.config = config;
-        const { dbSpecificConfig } = config;
-        this.dynamoDBClient = new client_dynamodb_1.DynamoDBClient(dbSpecificConfig);
-    }
-    /**
-     * Create an item in the database.
-     */
-    createItem = async (newItem) => {
-        const { tableName, uniquelyIdentifyingFieldName, generateUniqueIdentifier = () => (0, uuid_1.v4)(), } = this.config;
-        const newItemId = generateUniqueIdentifier(newItem);
-        const cleanNewItemWithId = {
-            ...newItem,
-            [uniquelyIdentifyingFieldName]: newItemId,
-        };
-        const command = new client_dynamodb_1.PutItemCommand({
-            TableName: tableName,
-            Item: (0, util_dynamodb_1.marshall)(cleanNewItemWithId),
-        });
-        await this.dynamoDBClient.send(command);
-        return newItemId;
-    };
-    /**
-     * Read an item from the database.
-     */
-    readItem = async (uniqueIdentifier, selectedFields) => {
-        const { tableName, uniquelyIdentifyingFieldName } = this.config;
-        const selectedFieldParams = buildSelectedFieldParams(selectedFields);
-        const command = new client_dynamodb_1.GetItemCommand({
-            TableName: tableName,
-            Key: (0, util_dynamodb_1.marshall)({
-                [uniquelyIdentifyingFieldName]: uniqueIdentifier,
-            }),
-            ...selectedFieldParams,
-        });
-        const { Item } = await this.dynamoDBClient.send(command);
-        if (typeof Item === "undefined") {
-            throw new Error(common_1.DATA_ITEM_DB_DRIVER_ERRORS.ITEM_NOT_FOUND);
-        }
-        else {
-            const cleanItem = (0, util_dynamodb_1.unmarshall)(Item);
-            return cleanItem;
-        }
-    };
-    /**
-     * Update an item in the database.
-     */
-    updateItem = async (uniqueIdentifier, updatedItem) => {
-        const { tableName, uniquelyIdentifyingFieldName } = this.config;
-        const { [uniquelyIdentifyingFieldName]: _unusedUniqueIdentifier, ...cleanUpdatedItem } = updatedItem;
-        if (typeof uniqueIdentifier !== "undefined") {
-            const command = new client_dynamodb_1.UpdateItemCommand({
-                TableName: tableName,
-                Key: (0, util_dynamodb_1.marshall)({
-                    [uniquelyIdentifyingFieldName]: uniqueIdentifier,
-                }),
-                ReturnValues: "ALL_NEW",
-                ...buildUpdateExpression(cleanUpdatedItem, uniquelyIdentifyingFieldName),
-            });
-            const { Attributes } = await this.dynamoDBClient.send(command);
-            return !!Attributes;
-        }
-        else {
-            throw {
-                message: common_1.DATA_ITEM_DB_DRIVER_ERRORS.MISSING_UNIQUE_IDENTIFIER,
-                uniquelyIdentifyingFieldName,
-            };
-        }
-    };
-    /**
-     * Delete an item from the database.
-     */
-    deleteItem = async (uniqueIdentifier) => {
-        const { tableName, uniquelyIdentifyingFieldName } = this.config;
-        const command = new client_dynamodb_1.DeleteItemCommand({
-            TableName: tableName,
-            Key: (0, util_dynamodb_1.marshall)({
-                [uniquelyIdentifyingFieldName]: uniqueIdentifier,
-            }),
-            ReturnValues: "ALL_OLD",
-        });
-        const { Attributes } = await this.dynamoDBClient.send(command);
-        return !!Attributes;
-    };
-    /**
-     * List items from the database.
-     */
-    listItems = async (config, selectedFields) => {
-        const { tableName } = this.config;
-        const { itemsPerPage = 10, cursor, sortFields, criteria: { logicalOperator = SearchTypes_1.LogicalOperators.AND, fieldCriteria = [], } = {}, } = config;
-        const { ProjectionExpression, ExpressionAttributeNames: selectFieldParamsAttributeNames, } = buildSelectedFieldParams(selectedFields);
-        const { FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues, } = createFilterExpression(fieldCriteria, logicalOperator);
-        // IMPORTANT: DynamoDB is VERY particular about whether to include
-        // properties, AT ALL, based on expressions being used.
-        const params = {
-            TableName: tableName,
-            Select: selectedFields && selectedFields.length > 0
-                ? "SPECIFIC_ATTRIBUTES"
-                : "ALL_ATTRIBUTES",
-            ...(ProjectionExpression
-                ? {
-                    ProjectionExpression: ProjectionExpression,
-                }
-                : {}),
-            ...(FilterExpression
-                ? {
-                    FilterExpression,
-                }
-                : {}),
-            ...(FilterExpression
-                ? {
-                    ExpressionAttributeNames: {
-                        ...selectFieldParamsAttributeNames,
-                        ...ExpressionAttributeNames,
-                    },
-                }
-                : ProjectionExpression
-                    ? {
-                        ExpressionAttributeNames: {
-                            ...selectFieldParamsAttributeNames,
-                        },
-                    }
-                    : {}),
-            ...(FilterExpression
-                ? {
-                    ExpressionAttributeValues,
-                }
-                : {}),
-        };
-        let structuredCursor = undefined;
-        if (typeof cursor === "string") {
-            try {
-                structuredCursor = (0, util_dynamodb_1.marshall)(JSON.parse(cursor));
-            }
-            catch (error) {
-                throw {
-                    message: common_1.DATA_ITEM_DB_DRIVER_ERRORS.INVALID_CURSOR,
-                    cursor,
-                };
-            }
-        }
-        const command = new client_dynamodb_1.ScanCommand({
-            ...params,
-            ExclusiveStartKey: structuredCursor,
-            Limit: itemsPerPage,
-        });
-        const { Items = [], LastEvaluatedKey } = await this.dynamoDBClient.send(command);
-        const unmarshalledItems = Items.map((item) => (0, util_dynamodb_1.unmarshall)(item));
-        // Sort the items.
-        const sortedItems = (0, SearchUtils_1.getSortedItems)(sortFields, unmarshalledItems);
-        return {
-            items: sortedItems,
-            cursor: LastEvaluatedKey
-                ? JSON.stringify((0, util_dynamodb_1.unmarshall)(LastEvaluatedKey))
-                : undefined,
-        };
-    };
-}
-exports.DynamoDBDataItemDBDriver = DynamoDBDataItemDBDriver;
-/**
- * The supported DB driver entry for the DynamoDB {@link DataItemDBDriver}.
- * */
-exports.DynamoDBSupportedDataItemDBDriverEntry = {
-    factory: (config) => {
-        return new DynamoDBDataItemDBDriver(config);
-    },
-    getDBSpecificConfigTypeInfo: () => {
-        const configTypesPath = path_1.default.join(__dirname, "DynamoDBDataItemDBDriver", "ConfigTypes.ts");
-        const configTypesTS = fs_1.default.readFileSync(configTypesPath, "utf8");
-        const typeInfoMap = (0, TypeParsing_1.getTypeInfoMapFromTypeScript)(configTypesTS);
-        return {
-            entryTypeName: "DynamoDBSpecificConfig",
-            typeInfoMap,
-        };
-    },
-};

package/src/api/ORM/drivers/S3FileItemDBDriver/ConfigTypes.d.ts

@@ -1,90 +0,0 @@
-export type Trace = (...content: any[]) => void;
-export type Logger = {
-    trace?: string | Trace;
-    debug: Trace;
-    info: Trace;
-    warn: Trace;
-    error: Trace;
-};
-export type Endpoint = {
-    protocol: string;
-    hostname: string;
-    port?: string;
-    path: string;
-    query?: string;
-};
-export type Properties = {
-    authSchemes?: string;
-};
-export type RetryStrategy = {
-    mode?: string;
-    retry: any;
-};
-export type Credentials = {
-    accessKeyId: string;
-    secretAccessKey: string;
-    sessionToken?: string;
-    credentialScope?: string;
-    expiration?: string;
-};
-export type Signer = {
-    sign: any;
-};
-export type AbridgedS3ClientConfig = {
-    requestHandler?: string;
-    apiVersion?: string;
-    sha256?: string;
-    urlParser?: string;
-    bodyLengthChecker?: string;
-    streamCollector?: string;
-    base64Decoder?: string;
-    base64Encoder?: string;
-    utf8Decoder?: string;
-    utf8Encoder?: string;
-    runtime?: string;
-    disableHostPrefix?: string | false | true;
-    serviceId?: string;
-    useDualstackEndpoint?: string | false | true;
-    useFipsEndpoint?: string | false | true;
-    region?: string;
-    credentialDefaultProvider?: string;
-    signingEscapePath?: string | false | true;
-    useArnRegion?: string | false | true;
-    defaultUserAgentProvider?: string;
-    streamHasher?: string;
-    md5?: string;
-    sha1?: string;
-    getAwsChunkedEncodingStream?: string;
-    maxAttempts?: string;
-    retryMode?: string;
-    logger?: string | Logger;
-    extensions?: string;
-    eventStreamSerdeProvider?: string;
-    /**
-     * @allowCustomSelection
-     * */
-    defaultsMode?: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy";
-    sdkStreamMixin?: string;
-    endpoint?: string | Endpoint;
-    endpointProvider?: string;
-    tls?: string | false | true;
-    retryStrategy?: string | RetryStrategy;
-    credentials?: string | Credentials;
-    signer?: string | Signer;
-    systemClockOffset?: string;
-    signingRegion?: string;
-    signerConstructor?: string;
-    forcePathStyle?: string | false | true;
-    useAccelerateEndpoint?: string | false | true;
-    disableMultiregionAccessPoints?: string | false | true;
-    followRegionRedirects?: string | false | true;
-    s3ExpressIdentityProvider?: string;
-    customUserAgent?: string;
-    useGlobalEndpoint?: string | false | true;
-    disableS3ExpressSessionAuth?: string | false | true;
-};
-export type S3SpecificConfig = {
-    s3Config?: AbridgedS3ClientConfig;
-    bucketName: string;
-    urlExpirationInSeconds?: number;
-};

package/src/api/ORM/drivers/S3FileItemDBDriver/ConfigTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/ORM/drivers/S3FileItemDBDriver/S3FileDriver.d.ts

@@ -1,45 +0,0 @@
-import { S3, S3ClientConfig } from "@aws-sdk/client-s3";
-import { BaseFile, BaseFileLocationInfo, CloudFileServiceDriver } from "../common/Types";
-export declare const S3_FILE_DRIVER_ERRORS: {
-    INVALID_PATH: string;
-};
-export declare const getFullFileKey: ({ file, baseDirectory, }: {
-    file: BaseFileLocationInfo;
-    baseDirectory?: string;
-}) => string;
-export declare const getBaseFileLocationInfo: (path: string) => BaseFileLocationInfo;
-/**
- * The configuration for an {@link S3FileDriver}.
- * */
-export type S3FileDriverConfig = {
-    s3Config?: S3ClientConfig;
-    bucketName: string;
-    urlExpirationInSeconds?: number;
-};
-/**
- * Use S3 as a {@link CloudFileServiceDriver} for {@link BaseFile}s.
- */
-export declare class S3FileDriver implements CloudFileServiceDriver {
-    protected config: S3FileDriverConfig;
-    protected s3: S3;
-    constructor(config: S3FileDriverConfig);
-    /**
-     * Get a signed URL for uploading a file.
-     */
-    getFileUploadUrl: (file: BaseFileLocationInfo, baseDirectory?: string) => Promise<string>;
-    /**
-     * Get a signed URL for downloading a file.
-     */
-    getFileDownloadUrl: (file: BaseFileLocationInfo, baseDirectory?: string) => Promise<string>;
-    /**
-     * Delete a file.
-     */
-    deleteFile: (file: BaseFileLocationInfo, baseDirectory?: string) => Promise<void>;
-    /**
-     * List the files and directories in a directory.
-     */
-    listFiles: (path?: string, baseDirectory?: string, maxNumberOfFiles?: number, cursor?: string) => Promise<{
-        files: BaseFile[];
-        cursor: string | undefined;
-    }>;
-}

package/src/api/ORM/drivers/S3FileItemDBDriver/S3FileDriver.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.S3FileDriver = exports.getBaseFileLocationInfo = exports.getFullFileKey = exports.S3_FILE_DRIVER_ERRORS = void 0;
-const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
-const client_s3_1 = require("@aws-sdk/client-s3");
-const Routing_1 = require("../../../../common/Routing");
-exports.S3_FILE_DRIVER_ERRORS = {
-    INVALID_PATH: "INVALID_PATH",
-};
-const getFullFileKey = ({ file, baseDirectory, }) => {
-    const { directory, name } = file;
-    const fullFileKey = `${baseDirectory ? `${baseDirectory}/` : ""}${directory ? `${directory}/` : ""}${name}`;
-    const pathArray = (0, Routing_1.getPathArray)(fullFileKey, "/", false);
-    if (pathArray.includes("..") ||
-        pathArray.includes(".") ||
-        pathArray.includes("")) {
-        throw {
-            message: exports.S3_FILE_DRIVER_ERRORS.INVALID_PATH,
-            file,
-            baseDirectory,
-        };
-    }
-    else {
-        return fullFileKey;
-    }
-};
-exports.getFullFileKey = getFullFileKey;
-const getBaseFileLocationInfo = (path) => {
-    const [name, ...directoryParts] = path.split("/").reverse();
-    return {
-        directory: directoryParts.reverse().join("/"),
-        name,
-    };
-};
-exports.getBaseFileLocationInfo = getBaseFileLocationInfo;
-/**
- * Use S3 as a {@link CloudFileServiceDriver} for {@link BaseFile}s.
- */
-class S3FileDriver {
-    config;
-    s3;
-    constructor(config) {
-        this.config = config;
-        const { s3Config = {} } = config;
-        this.s3 = new client_s3_1.S3(s3Config);
-    }
-    /**
-     * Get a signed URL for uploading a file.
-     */
-    getFileUploadUrl = async (file, baseDirectory) => {
-        const { bucketName, urlExpirationInSeconds } = this.config;
-        const params = {
-            Bucket: bucketName,
-            Key: (0, exports.getFullFileKey)({ file, baseDirectory }),
-        };
-        return await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new client_s3_1.PutObjectCommand(params), {
-            expiresIn: urlExpirationInSeconds,
-        });
-    };
-    /**
-     * Get a signed URL for downloading a file.
-     */
-    getFileDownloadUrl = async (file, baseDirectory) => {
-        const { bucketName, urlExpirationInSeconds } = this.config;
-        const params = {
-            Bucket: bucketName,
-            Key: (0, exports.getFullFileKey)({ file, baseDirectory }),
-        };
-        return await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new client_s3_1.GetObjectCommand(params), {
-            expiresIn: urlExpirationInSeconds,
-        });
-    };
-    /**
-     * Delete a file.
-     */
-    deleteFile = async (file, baseDirectory) => {
-        const { bucketName } = this.config;
-        await this.s3.send(new client_s3_1.DeleteObjectCommand({
-            Bucket: bucketName,
-            Key: (0, exports.getFullFileKey)({ file, baseDirectory }),
-        }));
-    };
-    /**
-     * List the files and directories in a directory.
-     */
-    listFiles = async (path, baseDirectory, maxNumberOfFiles = 1, cursor) => {
-        const { bucketName } = this.config;
-        const files = [];
-        let allContents = [], continuationToken = cursor, listAttempted = false;
-        while ((!listAttempted || continuationToken) &&
-            files.length < maxNumberOfFiles) {
-            listAttempted = true;
-            const listObjectsV2CommandOutput = await this.s3.send(new client_s3_1.ListObjectsV2Command({
-                Bucket: bucketName,
-                Prefix: `${baseDirectory || ""}${path || ""}`,
-                ContinuationToken: continuationToken,
-                MaxKeys: maxNumberOfFiles === Infinity
-                    ? undefined
-                    : maxNumberOfFiles - allContents.length,
-            }));
-            const { Contents = [], NextContinuationToken, } = listObjectsV2CommandOutput;
-            allContents = [...allContents, ...Contents];
-            continuationToken = NextContinuationToken;
-        }
-        for (const file of allContents) {
-            if (file.Key) {
-                const { ContentType = "", ContentLength = 0, LastModified, Metadata: {} = {}, } = await this.s3.send(new client_s3_1.HeadObjectCommand({
-                    Bucket: bucketName,
-                    Key: file.Key,
-                }));
-                files.push({
-                    updatedOn: LastModified?.getTime() || 0,
-                    mimeType: ContentType,
-                    sizeInBytes: ContentLength,
-                    directory: path,
-                    name: file.Key.split("/").pop() || "",
-                    isDirectory: ContentType === "application/x-directory",
-                });
-            }
-        }
-        return {
-            files,
-            cursor: continuationToken,
-        };
-    };
-}
-exports.S3FileDriver = S3FileDriver;