@resistdesign/voltra 3.0.0-alpha.3 → 3.0.0-alpha.4

package/src/api/ORM/ORMRouteMap.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypeInfoORMRouteMap = exports.TYPE_INFO_ORM_API_PATH_METHOD_NAME_MAP = exports.TYPE_INFO_ORM_ROUTE_MAP_ERRORS = void 0;
-const TypeInfoORMService_1 = require("./TypeInfoORMService");
-const Router_1 = require("../Router");
-/**
- * A collection of errors that can occur when creating or using a Type Info ORM Route Map.
- * */
-var TYPE_INFO_ORM_ROUTE_MAP_ERRORS;
-(function (TYPE_INFO_ORM_ROUTE_MAP_ERRORS) {
-    TYPE_INFO_ORM_ROUTE_MAP_ERRORS["MISSING_ACCESSING_ROLE"] = "MISSING_ACCESSING_ROLE";
-    TYPE_INFO_ORM_ROUTE_MAP_ERRORS["MISSING_ACCESSING_ROLE_GETTER"] = "MISSING_ACCESSING_ROLE_GETTER";
-})(TYPE_INFO_ORM_ROUTE_MAP_ERRORS || (exports.TYPE_INFO_ORM_ROUTE_MAP_ERRORS = TYPE_INFO_ORM_ROUTE_MAP_ERRORS = {}));
-/**
- * A map of Type Info ORM API paths to method names.
- * */
-exports.TYPE_INFO_ORM_API_PATH_METHOD_NAME_MAP = {
-    "create-relationship": "createRelationship",
-    "delete-relationship": "deleteRelationship",
-    "list-relationships": "listRelationships",
-    create: "create",
-    read: "read",
-    update: "update",
-    delete: "delete",
-    list: "list",
-};
-/**
- * Get a route map for a Type Info ORM service.
- * */
-const getTypeInfoORMRouteMap = (config, dacConfig, getAccessingRole, authConfig) => {
-    if (dacConfig && !getAccessingRole) {
-        throw {
-            message: TYPE_INFO_ORM_ROUTE_MAP_ERRORS.MISSING_ACCESSING_ROLE_GETTER,
-        };
-    }
-    else {
-        const ormMethodFactory = (methodName, eventData) => {
-            const { authInfo } = eventData;
-            const accessingRole = getAccessingRole
-                ? getAccessingRole(authInfo)
-                : undefined;
-            if (dacConfig && !accessingRole) {
-                throw {
-                    message: TYPE_INFO_ORM_ROUTE_MAP_ERRORS.MISSING_ACCESSING_ROLE,
-                };
-            }
-            else {
-                const dacOptions = dacConfig
-                    ? {
-                        useDAC: true,
-                        dacConfig: {
-                            ...dacConfig,
-                            accessingRole: accessingRole,
-                        },
-                    }
-                    : {
-                        useDAC: false,
-                    };
-                // TODO: Maybe don't instantiate a new ORM service for each method.
-                const orm = new TypeInfoORMService_1.TypeInfoORMService({
-                    ...config,
-                    ...dacOptions,
-                });
-                return orm[methodName];
-            }
-        };
-        const getRoute = (path, methodName) => ({
-            path,
-            authConfig: authConfig ?? {
-                anyAuthorized: true,
-            },
-            handlerFactory: (eventData) => ormMethodFactory(methodName, eventData),
-        });
-        let routeMap = {};
-        for (const p in exports.TYPE_INFO_ORM_API_PATH_METHOD_NAME_MAP) {
-            const m = exports.TYPE_INFO_ORM_API_PATH_METHOD_NAME_MAP[p];
-            routeMap = (0, Router_1.addRouteToRouteMap)(routeMap, getRoute(p, m));
-        }
-        return routeMap;
-    }
-};
-exports.getTypeInfoORMRouteMap = getTypeInfoORMRouteMap;

package/src/api/ORM/TypeInfoORMService.d.ts

@@ -1,103 +0,0 @@
-import { LiteralValue, TypeInfo, TypeInfoDataItem, TypeInfoMap, TypeOperation } from "../../common/TypeParsing/TypeInfo";
-import { CustomTypeInfoFieldValidatorMap } from "../../common/TypeParsing/Validation";
-import { ListItemsConfig, ListItemsResults, ListRelationshipsConfig } from "../../common/SearchTypes";
-import { DeleteRelationshipResults, RelationshipOperation, TypeInfoORMAPI } from "../../common/TypeInfoORM";
-import { DataItemDBDriver, ItemRelationshipDBDriver } from "./drivers";
-import { BaseItemRelationshipInfo, ItemRelationshipInfo, ItemRelationshipInfoKeys, ItemRelationshipInfoType, ItemRelationshipOriginatingItemInfo } from "../../common/ItemRelationshipInfoTypes";
-import { DACAccessResult, DACDataItemResourceAccessResultMap, DACRole } from "../DataAccessControl";
-export declare const cleanRelationshipItem: (relationshipItem: BaseItemRelationshipInfo) => BaseItemRelationshipInfo;
-export declare const getDriverMethodWithModifiedError: <ItemType extends TypeInfoDataItem, UniquelyIdentifyingFieldName extends keyof ItemType, DriverMethodNameType extends keyof DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>, MethodType extends DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>[DriverMethodNameType]>(extendedData: Record<any, any>, driver: DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>, driverMethodName: DriverMethodNameType) => MethodType;
-/**
- * The configuration for the TypeInfoORMService DAC features.
- * */
-export type TypeInfoORMDACConfig = {
-    itemResourcePathPrefix: LiteralValue[];
-    relationshipResourcePathPrefix: LiteralValue[];
-    accessingRole: DACRole;
-    getDACRoleById: (id: string) => DACRole;
-};
-/**
- * The basis for the configuration for the TypeInfoORMService.
- * */
-export type BaseTypeInfoORMServiceConfig = {
-    typeInfoMap: TypeInfoMap;
-    getDriver: (typeName: string) => DataItemDBDriver<any, any>;
-    getRelationshipDriver: (typeName: string, fieldName: string) => ItemRelationshipDBDriver;
-    createRelationshipCleanupItem?: (relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo) => Promise<void>;
-    customValidators?: CustomTypeInfoFieldValidatorMap;
-};
-/**
- * The options determining the usage of DAC features in a {@link TypeInfoORMServiceConfig}.
- * */
-export type TypeInfoORMServiceDACOptions = {
-    useDAC: true;
-    dacConfig: TypeInfoORMDACConfig;
-} | {
-    useDAC: false;
-};
-/**
- * The configuration for the TypeInfoORMService, including DAC features.
- * */
-export type TypeInfoORMServiceConfig = BaseTypeInfoORMServiceConfig & TypeInfoORMServiceDACOptions;
-/**
- * A service using TypeInfo to perform ORM operations with one or many `DBServiceItemDriver` instances.
- * */
-export declare class TypeInfoORMService implements TypeInfoORMAPI {
-    protected config: TypeInfoORMServiceConfig;
-    protected dacRoleCache: Record<string, DACRole>;
-    constructor(config: TypeInfoORMServiceConfig);
-    protected getItemDACValidation: (item: Partial<TypeInfoDataItem>, typeName: string, typeOperation: TypeOperation) => DACDataItemResourceAccessResultMap;
-    protected getRelationshipDACValidation: (itemRelationship: BaseItemRelationshipInfo, relationshipOperation: RelationshipOperation) => DACAccessResult;
-    protected getWrappedDriverWithExtendedErrorData: <ItemType extends TypeInfoDataItem, UniquelyIdentifyingFieldName extends keyof ItemType>(driver: DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>, extendedData: Record<any, any>) => DataItemDBDriver<ItemType, UniquelyIdentifyingFieldName>;
-    protected getDriverInternal: (typeName: string) => DataItemDBDriver<any, any>;
-    protected getRelationshipDriverInternal: (typeName: string, fieldName: string) => ItemRelationshipDBDriver;
-    protected getTypeInfo: (typeName: string) => TypeInfo;
-    protected validateReadOperation: (typeName: string, selectedFields?: (keyof TypeInfoDataItem)[]) => void;
-    protected validate: (typeName: string, item: TypeInfoDataItem, typeOperation: TypeOperation, itemIsPartial?: boolean) => void;
-    protected getCleanItem: (typeName: string, item: Partial<TypeInfoDataItem>, dacFieldResources?: Partial<Record<keyof TypeInfoDataItem, DACAccessResult>>, selectedFields?: (keyof TypeInfoDataItem)[]) => Partial<TypeInfoDataItem>;
-    protected getCleanSelectedFields: (typeName: string, selectedFields?: (keyof TypeInfoDataItem)[]) => (keyof TypeInfoDataItem)[] | undefined;
-    protected validateRelationshipItem: (relationshipItem: ItemRelationshipInfoType, omitFields?: ItemRelationshipInfoKeys[]) => void;
-    protected cleanupRelationships: (relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo) => Promise<void>;
-    /**
-     * Create a new relationship between two items.
-     * */
-    createRelationship: (relationshipItem: BaseItemRelationshipInfo) => Promise<boolean>;
-    /**
-     * Delete a relationship between two items.
-     * */
-    deleteRelationship: (relationshipItem: BaseItemRelationshipInfo) => Promise<DeleteRelationshipResults>;
-    /**
-     * List the relationships for a given item.
-     * */
-    listRelationships: (config: ListRelationshipsConfig) => Promise<ListItemsResults<ItemRelationshipInfo>>;
-    listRelatedItems: (config: ListRelationshipsConfig, selectedFields?: (keyof TypeInfoDataItem)[]) => Promise<{
-        items: Partial<TypeInfoDataItem>[];
-        cursor: string | undefined;
-    }>;
-    /**
-     * Create a new item of the given type.
-     * */
-    create: (typeName: string, item: TypeInfoDataItem) => Promise<any>;
-    /**
-     * Read an existing item of the given type.
-     * */
-    read: (typeName: string, primaryFieldValue: any, selectedFields?: string[]) => Promise<Partial<TypeInfoDataItem>>;
-    /**
-     * Update an existing item of the given type.
-     *
-     * This update will always act as a **patch**.
-     * Use `null` to signify the deletion of a field.
-     * Assign values to **all** fields to perform a **replacement**.
-     *
-     * The `item` **must always** contain its **primary field value**.
-     * */
-    update: (typeName: string, item: TypeInfoDataItem) => Promise<boolean>;
-    /**
-     * Delete an existing item of the given type.
-     * */
-    delete: (typeName: string, primaryFieldValue: any) => Promise<boolean>;
-    /**
-     * List items of the given type, with the given criteria.
-     * */
-    list: (typeName: string, config: ListItemsConfig, selectedFields?: (keyof TypeInfoDataItem)[]) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
-}