@qrvey/assets-sharing 0.3.4-dev.2092 → 0.3.4-dev.2153

package/src/sharing/implementations/sharing.model.ts

@@ -1,33 +0,0 @@
-import { CrudSchema } from '@qrvey/data-persistence';
-
-import { DATABASE_INFO } from '../../common/constants';
-
-export class SharingModel extends CrudSchema {
-    static table = {
-        name: `${DATABASE_INFO.SERVER_PREFIX}_sharing`,
-        alias: `${DATABASE_INFO.TABLE_PREFIX}_sharing`,
-    };
-
-    static columns = {
-        asset_id: { type: 'string', primary: true },
-        asset_type: { type: 'string' },
-        created_at: { type: 'date' },
-        updated_at: { type: 'date' },
-        deleted_at: { type: 'date' },
-        qvAttributes: { type: 'object' },
-    };
-
-    static indexes = {
-        sharingAssetIdAssetType: {
-            name: 'sharing_asset_id_asset_type_index',
-            columns: ['asset_id', 'asset_type'],
-        },
-        sharingAssetType: {
-            name: 'sharing_asset_type_index',
-            columns: ['asset_type'],
-        },
-    };
-
-    static schema = DATABASE_INFO.DATA_PERSISTENCE_SCHEMA;
-    static usePool = true;
-}

package/src/sharing/implementations/sharing.repository.ts

@@ -1,36 +0,0 @@
-import { SharingModel } from './sharing.model';
-import { BaseRepository } from '../../common/persistence/base';
-import { SharingTable } from '../entities/types/sharing.type';
-import { SharingRepositoryInterface } from '../interfaces/sharingRepository.interface';
-
-export class SharingRepository
-    extends BaseRepository
-    implements SharingRepositoryInterface
-{
-    constructor() {
-        super(SharingModel);
-    }
-
-    async getOne(assetId: string): Promise<SharingTable | null> {
-        const params = {
-            filters: [this.filter('asset_id', assetId)],
-        };
-        const response = await super.findItem(params);
-        return response as SharingTable;
-    }
-
-    async create(sharing: SharingTable): Promise<SharingTable> {
-        const response = (await super.create(sharing)) as SharingTable;
-        return response;
-    }
-
-    async patch(assetId: string, sharing: SharingTable): Promise<boolean> {
-        await super.update([this.filter('asset_id', assetId)], sharing);
-        return true;
-    }
-
-    async delete(assetId: string): Promise<boolean> {
-        await super.remove([this.filter('asset_id', assetId)]);
-        return true;
-    }
-}

package/src/sharing/interfaces/adminRepository.interface.ts

@@ -1,13 +0,0 @@
-import { AppOwner } from '../../common/constants';
-
-export interface AdminRepositoryInterface {
-    getApplicationInfo(params: { appId: string; userId: string }): Promise<{
-        status: number;
-        data: AppOwner;
-    }>;
-
-    getPlatformConfiguration(): Promise<{
-        status: number;
-        legacyMode: boolean;
-    }>;
-}

package/src/sharing/interfaces/dashboardRepository.interface.ts

@@ -1,3 +0,0 @@
-export interface DashboardRepositoryInterface {
-    get(identifier: string): Promise<{ dashboardId: string } | null>;
-}

package/src/sharing/interfaces/detailsRepository.interface.ts

@@ -1,60 +0,0 @@
-import {
-    ListInput,
-    ListOutput,
-    ParamsFromTokenToUser,
-} from '../../common/common.type';
-import { SharingDetailsTable } from '../entities/types/details.type';
-
-export interface SharingDetailsRepositoryInterface {
-    /**
-     * Retrieves a single sharing detail by its ID.
-     * @param sharingDetailId - The ID of the sharing detail to retrieve.
-     * @returns A promise that resolves to the sharing detail or null if not found.
-     */
-    getOne(sharingDetailId: string): Promise<SharingDetailsTable | null>;
-
-    /**
-     * Retrieves a single sharing detail by its asset ID and the user it is shared with.
-     * @param assetId - The ID of the asset.
-     * @param sharedWith - The user with whom the asset is shared.
-     * @returns A promise that resolves to the sharing detail or null if not found.
-     */
-    getBySharedWith(
-        assetId: string,
-        sharedWith: string,
-    ): Promise<SharingDetailsTable | null>;
-
-    /**
-     * Retrieves a list of sharing details based on the provided options.
-     * @param options - An object containing the asset ID to filter the sharing details.
-     * @returns A promise that resolves to an array of sharing details.
-     */
-    getList(
-        options: ListInput<{ assetId: string; user?: ParamsFromTokenToUser }>,
-    ): Promise<ListOutput<SharingDetailsTable>>;
-
-    /**
-     * Creates a new sharing detail in the repository.
-     * @param details - The sharing detail to create.
-     * @returns A promise that resolves to the created sharing detail.
-     */
-    create(details: SharingDetailsTable): Promise<SharingDetailsTable>;
-
-    /**
-     * Updates an existing sharing detail in the repository.
-     * @param sharingDetailId - The ID of the sharing detail to update.
-     * @param details - The updated sharing detail.
-     * @returns A promise that resolves to a boolean indicating success or failure.
-     */
-    patch(
-        sharingDetailId: string,
-        details: SharingDetailsTable,
-    ): Promise<boolean>;
-
-    /**
-     * Deletes a sharing detail from the repository.
-     * @param sharingDetailId - The ID of the sharing detail to delete.
-     * @returns A promise that resolves to a boolean indicating success or failure.
-     */
-    delete(sharingDetailId: string): Promise<boolean>;
-}

package/src/sharing/interfaces/downloadManagerRepository.interface.ts

@@ -1,3 +0,0 @@
-export interface DownloadManagerRepositoryInterface {
-    get(identifier: string): Promise<{ downloadManagerId: string } | null>;
-}

package/src/sharing/interfaces/organizationRepository.interface.ts

@@ -1,5 +0,0 @@
-import { OrganizationType } from '../entities/types/organization.type';
-
-export interface OrganizationRepositoryInterface {
-    getOne(orgId: string): Promise<OrganizationType | null>;
-}

package/src/sharing/interfaces/sharingRepository.interface.ts

@@ -1,32 +0,0 @@
-import { SharingTable } from '../entities/types/sharing.type';
-
-export interface SharingRepositoryInterface {
-    /**
-     * Retrieves a sharing record by its asset ID.
-     * @param assetId - The ID of the asset to retrieve.
-     * @returns A promise that resolves to the sharing record or null if not found.
-     */
-    getOne(assetId: string): Promise<SharingTable | null>;
-
-    /**
-     * Creates a new sharing record.
-     * @param sharing - The sharing record to create.
-     * @returns A promise that resolves to the created sharing record.
-     */
-    create(sharing: SharingTable): Promise<SharingTable>;
-
-    /**
-     * Updates a sharing record by its ID.
-     * @param assetId - The ID of the sharing record to update.
-     * @param sharing - The updated sharing record.
-     * @returns A promise that resolves to a boolean indicating whether the update was successful.
-     */
-    patch(assetId: string, sharing: SharingTable): Promise<boolean>;
-
-    /**
-     * Deletes a sharing record by its ID.
-     * @param assetId - The ID of the sharing record to delete.
-     * @returns A promise that resolves to a boolean indicating whether the deletion was successful.
-     */
-    delete(assetId: string): Promise<boolean>;
-}

package/src/sharing/services/checkAppPermissions.ts

@@ -1,47 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import {
-    AppPermissionResponse,
-    AppSharingStatus,
-} from '../../common/constants';
-import { AdminRepositoryInterface } from '../interfaces/adminRepository.interface';
-
-@injectable()
-export default class CheckAppPermissions {
-    constructor(
-        @inject('AdminRepository')
-        private readonly adminRepository: AdminRepositoryInterface,
-    ) {}
-
-    //TODO Need Test
-    async execute({
-        appId,
-        userId,
-    }: {
-        appId: string;
-        userId: string;
-    }): Promise<AppPermissionResponse> {
-        // If no user is available, block access by default
-        if (!userId) return { privacy: AppSharingStatus.PRIVATE };
-
-        // Fetch application status and global platform configuration in parallel
-        const appInfo = await this.adminRepository.getApplicationInfo({
-            appId,
-            userId,
-        });
-        const platform = await this.adminRepository.getPlatformConfiguration();
-
-        // Check if the application is shared with the current user
-        if (appInfo.status !== 200)
-            return { privacy: AppSharingStatus.PRIVATE };
-
-        // According to QRV-297, the LegacyMode ON will have public access, in future implementation, other options will be added.
-        const hasPublicAccess = platform?.legacyMode;
-
-        const privacy = hasPublicAccess
-            ? AppSharingStatus.PUBLIC
-            : AppSharingStatus.PRIVATE;
-
-        return { privacy };
-    }
-}

package/src/sharing/services/checkOrgPermissions.ts

@@ -1,29 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import {
-    AppPermissionResponse,
-    AppSharingStatus,
-} from '../../common/constants';
-import { OrganizationRepositoryInterface } from '../interfaces/organizationRepository.interface';
-
-@injectable()
-export default class CheckOrgPermissions {
-    constructor(
-        @inject('OrganizationRepository')
-        private readonly organizationRepository: OrganizationRepositoryInterface,
-    ) {}
-
-    //TODO Need Tes
-    async execute({
-        orgId,
-    }: {
-        orgId: string;
-    }): Promise<AppPermissionResponse> {
-        const hasPublicAccess = await this.organizationRepository.getOne(orgId);
-        const privacy = hasPublicAccess?.effective_content_privacy
-            ? AppSharingStatus.PRIVATE
-            : AppSharingStatus.PUBLIC;
-
-        return { privacy };
-    }
-}

package/src/sharing/services/checkUserAccessLevel.ts

@@ -1,63 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import { ACCESS_LEVEL, SHARE_TYPE } from '../../common/constants';
-import { fromTokenToUser } from '../../index';
-import { SharingDetail } from '../entities/details';
-import { SharingDetailsRepositoryInterface } from '../interfaces/detailsRepository.interface';
-
-@injectable()
-export class CheckUserAccessLevel {
-    constructor(
-        @inject('SharingDetailsRepository')
-        private readonly detailsRepository: SharingDetailsRepositoryInterface,
-    ) {}
-
-    public async execute({
-        userId,
-        assetId,
-        clientId,
-        loginType,
-        roles,
-        orgId,
-    }: {
-        assetId: string;
-        userId: string;
-        clientId?: string;
-        loginType?: string;
-        roles?: string[];
-        orgId?: string;
-    }): Promise<{ level: ACCESS_LEVEL; levelAsText: string }> {
-        const user = await fromTokenToUser({
-            body: { userId, clientId, roles, orgId, loginType },
-        });
-        const details = await this.detailsRepository.getList({
-            data: { assetId, user },
-            sorting: [{ column: 'access_level', direction: 'DESC' }],
-        });
-        if (details.items.length === 0)
-            return { level: ACCESS_LEVEL.NONE, levelAsText: 'NONE' };
-
-        const priority = {
-            [SHARE_TYPE.USER]: 3,
-            [SHARE_TYPE.ROLE]: 2,
-            [SHARE_TYPE.ORGANIZATION]: 1,
-        };
-        const priorityDetail = details.items.reduce((best, current) => {
-            const bestPriority = priority[best.shared_type as SHARE_TYPE];
-            const currentPriority = priority[current.shared_type as SHARE_TYPE];
-            const isBetter =
-                currentPriority > bestPriority ||
-                (currentPriority === bestPriority &&
-                    current.access_level > best.access_level);
-
-            if (isBetter) return current;
-            return best;
-        });
-
-        const currentDetail = SharingDetail.parse(priorityDetail);
-        return {
-            level: currentDetail.getAccessLevel,
-            levelAsText: currentDetail.getAccessLevelAsText,
-        };
-    }
-}

package/src/sharing/services/delete.ts

@@ -1,24 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import { SharingRepositoryInterface } from '../interfaces/sharingRepository.interface';
-
-export interface Delete {
-    assetId: string;
-}
-
-@injectable()
-export class DeleteSharing {
-    constructor(
-        @inject('SharingRepository')
-        private readonly sharingRepository: SharingRepositoryInterface,
-    ) {}
-
-    public async execute({ body }: { body: Delete }): Promise<boolean | null> {
-        const { assetId } = body;
-        const sharing = await this.sharingRepository.getOne(assetId);
-
-        if (!sharing) return null;
-        const detailSharing = await this.sharingRepository.delete(assetId);
-        return detailSharing;
-    }
-}

package/src/sharing/services/list.ts

@@ -1,53 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import { Sorting } from '../../common/common.type';
-import { SharingDetail } from '../entities/details';
-import {
-    GetSharingList,
-    ListSharingDetails,
-    SharingDetailsTable,
-} from '../entities/types/details.type';
-import { SharingDetailsRepositoryInterface } from '../interfaces/detailsRepository.interface';
-import { SharingRepositoryInterface } from '../interfaces/sharingRepository.interface';
-
-@injectable()
-export class ListSharing {
-    constructor(
-        @inject('SharingRepository')
-        private readonly sharingRepository: SharingRepositoryInterface,
-        @inject('SharingDetailsRepository')
-        private readonly detailsRepository: SharingDetailsRepositoryInterface,
-    ) {}
-
-    public async execute({
-        body,
-    }: {
-        body: GetSharingList;
-    }): Promise<ListSharingDetails | null> {
-        const {
-            data: { assetId },
-            pagination,
-        } = body;
-        const sharing = await this.sharingRepository.getOne(assetId);
-
-        if (!sharing) return null;
-
-        const sorting: Array<Sorting> =
-            body.sorting && body.sorting?.length > 0
-                ? body.sorting
-                : [{ column: 'created_at', direction: 'ASC' }];
-
-        const detailSharing = await this.detailsRepository.getList({
-            data: { assetId },
-            pagination,
-            sorting,
-        });
-        const items = detailSharing.items.map((item) =>
-            SharingDetail.parse(item as SharingDetailsTable).toJSON(),
-        );
-        return {
-            ...detailSharing,
-            items,
-        };
-    }
-}

package/src/sharing/services/upsert.ts

@@ -1,197 +0,0 @@
-import { inject, injectable } from 'tsyringe';
-
-import {
-    ACCESS_LEVEL,
-    ASSET_TYPE,
-    ORGANIZATION_QRVEY,
-    SHARED_ORIGIN,
-    SHARE_TYPE,
-} from '../../common/constants';
-import { RoleRepositoryInterface } from '../../quser/interfaces/rolesRepository.interface';
-import { UserRepositoryInterface } from '../../quser/interfaces/userRepository.interface';
-import { SharingDetail } from '../entities/details';
-import { Sharing } from '../entities/sharing';
-import { ResponseSharingDetails } from '../entities/types/details.type';
-import { DashboardRepositoryInterface } from '../interfaces/dashboardRepository.interface';
-import { SharingDetailsRepositoryInterface } from '../interfaces/detailsRepository.interface';
-import { DownloadManagerRepositoryInterface } from '../interfaces/downloadManagerRepository.interface';
-import { SharingRepositoryInterface } from '../interfaces/sharingRepository.interface';
-
-interface SharingWith {
-    sharedId?: string;
-    sharedWith: string;
-    sharedOrigin: SHARED_ORIGIN;
-    accessLevel: ACCESS_LEVEL;
-    orgId?: string;
-    sharedEmail?: string;
-    sharedType: SHARE_TYPE;
-}
-
-export interface UpsertInterface {
-    assetId: string;
-    assetType: ASSET_TYPE;
-    add?: Array<SharingWith>;
-    remove?: Array<{
-        sharedId: string;
-    }>;
-}
-
-@injectable()
-export class UpsertSharing {
-    constructor(
-        @inject('SharingRepository')
-        private readonly sharingRepository: SharingRepositoryInterface,
-        @inject('SharingDetailsRepository')
-        private readonly detailsRepository: SharingDetailsRepositoryInterface,
-        @inject('dxRepository')
-        private readonly dxRepository: DashboardRepositoryInterface,
-        @inject('dmRepository')
-        private readonly dmRepository: DownloadManagerRepositoryInterface,
-        @inject('UserRepository')
-        private readonly userRepository: UserRepositoryInterface,
-        @inject('RoleRepository')
-        private readonly roleRepository: RoleRepositoryInterface,
-    ) {}
-
-    public async execute({
-        body,
-    }: {
-        body: UpsertInterface;
-    }): Promise<ResponseSharingDetails[]> {
-        const assetId = body.assetId;
-
-        const isValidAsset = await this.validateIfAssetExists(
-            assetId,
-            body.assetType,
-        );
-        if (!isValidAsset)
-            throw new Error(`Asset with ID ${assetId} not found`);
-
-        const sharing = await this.sharingRepository.getOne(assetId);
-        let currentSharing: Sharing;
-        if (sharing) {
-            currentSharing = Sharing.parse(sharing);
-        } else {
-            const createSharing = {
-                assetId,
-                assetType: body.assetType,
-            };
-            currentSharing = Sharing.create(createSharing);
-            await this.sharingRepository.create(currentSharing.toTable());
-        }
-
-        let updatedList: SharingDetail[] = [];
-        if (body.add) updatedList = await this.addDetails(assetId, body.add);
-        if (body.remove) await this.removeDetails(body.remove);
-
-        currentSharing.update();
-        await this.sharingRepository.patch(
-            currentSharing.getAssetId,
-            currentSharing.toTable(),
-        );
-        return updatedList.map((detail) => detail.toJSON());
-    }
-
-    private async validateIfAssetExists(
-        assetId: string,
-        assetType: ASSET_TYPE,
-    ): Promise<boolean> {
-        switch (assetType) {
-            case ASSET_TYPE.DX: {
-                const result = await this.dxRepository.get(assetId);
-                if (result) return true;
-                return false;
-            }
-            case ASSET_TYPE.DM: {
-                return true;
-            }
-
-            default:
-                return false;
-        }
-    }
-
-    private async addDetails(
-        assetId: string,
-        list: Required<UpsertInterface>['add'],
-    ): Promise<SharingDetail[]> {
-        const sharingList: SharingDetail[] = [];
-        for (const detail of list) {
-            const currentDetail = await this.addSpecificDetail(assetId, detail);
-            if (currentDetail) sharingList.push(currentDetail);
-        }
-        return sharingList;
-    }
-
-    private async addSpecificDetail(
-        assetId: string,
-        detail: SharingWith,
-    ): Promise<SharingDetail | null> {
-        let currentDetail: SharingDetail;
-        const isValid = await this.validateIfSharedWithExist(detail);
-        if (!isValid) return null;
-
-        let sharingDetail = await this.detailsRepository.getBySharedWith(
-            assetId,
-            detail.sharedWith,
-        );
-        if (!sharingDetail && detail.sharedId) {
-            sharingDetail = await this.detailsRepository.getOne(
-                detail.sharedId,
-            );
-        }
-
-        if (sharingDetail) {
-            currentDetail = SharingDetail.parse(sharingDetail);
-            currentDetail.update(detail);
-            await this.detailsRepository.patch(
-                currentDetail.getSharingDetailsId,
-                currentDetail.toTable(),
-            );
-        } else {
-            const createDetails = {
-                assetId: assetId,
-                orgId: detail.orgId ?? ORGANIZATION_QRVEY, //TODO If shareOrigin is INTERNAL then `ORGANIZATION_QRVEY` else fail
-                ...detail,
-            };
-            currentDetail = SharingDetail.create(createDetails);
-            await this.detailsRepository.create(currentDetail.toTable());
-        }
-        return currentDetail;
-    }
-
-    private async validateIfSharedWithExist(
-        detail: SharingWith,
-    ): Promise<boolean> {
-        if (
-            detail.sharedOrigin === SHARED_ORIGIN.EXTERNAL ||
-            detail.sharedOrigin === SHARED_ORIGIN.UNKNOWN
-        )
-            return true;
-
-        const isQrveyOrg =
-            detail.sharedType === SHARE_TYPE.ORGANIZATION &&
-            detail.sharedWith === ORGANIZATION_QRVEY;
-        if (isQrveyOrg) return true; // NOTE: If more Internal Organization arrive, need to change this validation
-
-        if (detail.sharedType === SHARE_TYPE.USER) {
-            const user = await this.userRepository.getOne(detail.sharedWith);
-            if (user) return true;
-        }
-
-        if (detail.sharedType === SHARE_TYPE.ROLE) {
-            const role = await this.roleRepository.getOne(detail.sharedWith);
-            if (role) return true;
-        }
-
-        return false;
-    }
-
-    private async removeDetails(
-        list: Required<UpsertInterface>['remove'],
-    ): Promise<void> {
-        for (const detail of list) {
-            await this.detailsRepository.delete(detail.sharedId);
-        }
-    }
-}

package/tsconfig.cjs.json

@@ -1,7 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./dist/cjs",
-        "module": "commonjs"
-    }
-}

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-    "extends": "tsconfig/tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./dist",
-        "experimentalDecorators": true
-    },
-    "references": [
-        {
-            "path": "../id-generator"
-        },
-        {
-            "path": "../data-persistence"
-        }
-    ],
-    "include": [
-        "src/index.ts"
-    ],
-    "exclude": [
-        "dist",
-        "build",
-        "node_modules",
-        "coverage",
-        "**/*.test.ts",
-        "**/*.test.d.ts",
-        "**/*.spec.ts"
-    ]
-}

package/tsup.config.cjs.ts

@@ -1,19 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-    entryPoints: ['./src/index.ts'],
-    bundle: true,
-    minify: false,
-    format: ['cjs'],
-    treeshake: true,
-    sourcemap: true,
-    outDir: 'dist/cjs',
-    references: [
-        {
-            path: "../id-generator"
-        },
-        {
-            path: "../data-persistence"
-        }
-    ],
-});

package/tsup.config.esm.ts

@@ -1,12 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-    entryPoints: ['./src/index.ts'],
-    bundle: true,
-    minify: false,
-    format: ['esm'],
-    treeshake: true,
-    sourcemap: true,
-    dts: false,
-    outDir: 'dist/esm',
-});