@qrvey/assets-sharing 0.3.4-dev.2221 → 0.3.5-1236-beta.1

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 declare const ORGANIZATION_QRVEY = "org:0";
-declare const ORGANIZATION_ANONYMOUS = "anonymous";
+declare const USER_ANONYMOUS = "anonymous";
 declare enum ASSET_TYPE {
     DX = "DX",// DASHBOARD X (Next Gen)
     DM = "DM"
@@ -12,7 +12,8 @@ declare enum SHARED_ORIGIN {
 declare enum SHARE_TYPE {
     USER = "USER",
     ROLE = "ROLE",
-    ORGANIZATION = "ORGANIZATION"
+    ORGANIZATION = "ORGANIZATION",
+    TENANT = "TENANT"
 }
 /**
  * Access levels for assets.
@@ -29,17 +30,6 @@ declare enum ACCESS_LEVEL {
     CAN_EDIT = 2,
     ADMIN = 4
 }
-/**
- * Sharing Mode for assets.
- * Those are calculated with Base 2, so:
- * - PRIVATE = 0 (undefined)
- * - SAME_AS_APP = 1 (2^0)
- */
-declare enum SHARING_MODE {
-    PRIVATE = 0,
-    SAME_AS_APP = 1,
-    SHARED = 2
-}
 declare enum APP_SHARING_STATUS {
     PUBLIC = "public",
     PRIVATE = "private",
@@ -48,6 +38,11 @@ declare enum APP_SHARING_STATUS {
 interface AppAccessResponse {
     hasAccess: boolean;
 }
+interface AppOwner {
+    userId: string;
+    appId: string;
+    userEmail?: string;
+}
 
 interface BaseSharing {
     assetId: string;
@@ -55,16 +50,12 @@ interface BaseSharing {
     createdAt: string;
     updatedAt: string;
     deletedAt?: string;
-    sharingMode?: SHARING_MODE | null;
-    sharingModeStatus?: boolean;
 }
 type CreateSharing = Omit<BaseSharing, 'createdAt' | 'updatedAt' | 'deletedAt'>;
 type ResponseSharing = Omit<BaseSharing, 'deletedAt'>;
 interface SharingTable {
     asset_id: string;
     asset_type: ASSET_TYPE | string;
-    sharing_mode: SHARING_MODE | null;
-    sharing_mode_status: boolean;
     created_at: string;
     updated_at: string;
     deleted_at?: string;
@@ -76,8 +67,6 @@ declare class Sharing {
     private createdAt;
     private updatedAt;
     private deletedAt?;
-    private sharingModeStatus;
-    private sharingMode;
     constructor(params: BaseSharing);
     static create(params: CreateSharing): Sharing;
     static parse(params: SharingTable): Sharing;
@@ -85,8 +74,6 @@ declare class Sharing {
     toTable(): SharingTable;
     toPlain(): BaseSharing;
     toJSON(): ResponseSharing;
-    set setSharingModeStatus(sharingModeStatus: boolean);
-    set setSharingMode(sharingMode: SHARING_MODE | null);
     get getAssetId(): string;
     get getAssetType(): string;
 }
@@ -120,14 +107,6 @@ interface ListOutput<T> {
     pagination: Pagination;
 }
 
-interface UserToken {
-    userId: string;
-    clientId?: string;
-    roles?: string[];
-    orgId?: string;
-    loginType?: string;
-}
-
 declare enum HIERARCHY_SCOPE {
     CHILDREN = "children",
     PARENTS = "parents",
@@ -138,6 +117,34 @@ interface OrgHierarchyResult {
     parentIds: string[];
 }
 
+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>;
+}
+
 interface Delete {
     assetId: string;
 }
@@ -159,11 +166,104 @@ type ResponseSharingDetails = Omit<BaseSharingDetails, 'sharingDetailsId' | 'del
     sharedId: string;
     accessLevelAsText: string;
 };
+interface SharingDetailsTable {
+    sharing_details_id: string;
+    asset_id: string;
+    access_level: number;
+    org_id: string;
+    shared_with: string;
+    shared_type: string;
+    shared_email?: string;
+    share_origin: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string;
+}
 type GetSharingList = ListInput<{
     assetId: string;
 }>;
 type ListSharingDetails = ListOutput<ResponseSharingDetails>;
 
+interface RoleRepositoryInterface {
+    getOne(identifier: string): Promise<{
+        groupid: string;
+    } | null>;
+    getByName(name: string): Promise<{
+        groupid: string;
+        permissions: {
+            contentAdministration: boolean;
+            assetSharing: boolean;
+        };
+    } | null>;
+}
+
+interface BaseUser {
+    userid: string;
+    email: string;
+    groups: string[];
+    organization: string;
+}
+interface UserToken {
+    userId: string;
+    clientId?: string;
+    roles?: string[];
+    orgId?: string;
+    loginType?: string;
+}
+
+interface UserRepositoryInterface {
+    getOne(identifier: string): Promise<BaseUser | null>;
+    getList(options: ListInput<{
+        identifier: string;
+        role?: string;
+    }>): Promise<ListOutput<BaseUser>>;
+}
+
+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;
+        parentOrgIds?: string[];
+    }>): 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>;
+}
+
 interface SharingWith {
     sharedId?: string;
     sharedWith: string;
@@ -182,6 +282,136 @@ interface UpsertInterface {
     }>;
 }
 
+declare class FromTokenToUser {
+    private readonly userRepository;
+    constructor(userRepository: UserRepositoryInterface);
+    execute({ body, }: {
+        body: UserToken;
+    }): Promise<ParamsFromTokenToUser>;
+}
+
+interface PermissionRepositoryInterface {
+    getPermission(userIdentifier: string): Promise<{
+        contentAdministration: boolean;
+        assetSharing: boolean;
+    } | null>;
+}
+
+/**
+ * This methods must be called HasContentAdministrationPermission,
+ * but for backward compatibility, we keep the name HasAdminRole
+ */
+declare class HasAdminRole {
+    private readonly userRepository;
+    private readonly permissionRepository;
+    private readonly roleRepository;
+    constructor(userRepository: UserRepositoryInterface, permissionRepository: PermissionRepositoryInterface, roleRepository: RoleRepositoryInterface);
+    execute({ apiKey, clientId, orgId, userId, loginType, roles, }?: {
+        apiKey?: string;
+        clientId?: string;
+        orgId?: string;
+        userId?: string;
+        loginType?: string;
+        roles?: string[];
+    }): Promise<boolean>;
+}
+
+declare class HasSharingPermission {
+    private readonly permissionRepository;
+    private readonly roleRepository;
+    constructor(permissionRepository: PermissionRepositoryInterface, roleRepository: RoleRepositoryInterface);
+    execute({ clientId, userId, roles, }?: {
+        apiKey?: string;
+        clientId?: string;
+        orgId?: string;
+        userId?: string;
+        loginType?: string;
+        roles?: string[];
+    }): Promise<boolean>;
+}
+
+interface AdminRepositoryInterface {
+    getApplicationInfo(params: {
+        appId: string;
+        userId: string;
+    }): Promise<{
+        status: number;
+        data: AppOwner;
+    }>;
+}
+
+declare class CheckAppAccess {
+    private readonly adminRepository;
+    constructor(adminRepository: AdminRepositoryInterface);
+    execute({ appId, userId, }: {
+        appId: string;
+        userId: string;
+    }): Promise<AppAccessResponse>;
+}
+
+interface OrganizationType {
+    orgId: string;
+    name: string;
+    parent_org_id: string | null;
+    org_path: string;
+    asset_sharing: boolean;
+    effective_asset_sharing: boolean;
+    created_at: string;
+    updated_at: string;
+}
+
+interface OrganizationRepositoryInterface {
+    getOne(orgId: string): Promise<OrganizationType | null>;
+    getOrgTree(orgId: string, scope: HIERARCHY_SCOPE): Promise<OrgHierarchyResult>;
+}
+
+declare class CheckOrgPermissions {
+    private readonly organizationRepository;
+    constructor(organizationRepository: OrganizationRepositoryInterface);
+    execute({ orgId, }: {
+        orgId: string;
+    }): Promise<{
+        privacy: APP_SHARING_STATUS;
+    }>;
+}
+
+declare class CheckUserAccessLevel {
+    private readonly detailsRepository;
+    private readonly organizationRepository;
+    constructor(detailsRepository: SharingDetailsRepositoryInterface, organizationRepository: OrganizationRepositoryInterface);
+    execute({ userId, assetId, assetOrgId, clientId, loginType, roles, orgId, }: {
+        assetId: string;
+        assetOrgId: string;
+        userId: string;
+        clientId?: string;
+        loginType?: string;
+        roles?: string[];
+        orgId?: string;
+    }): Promise<{
+        level: ACCESS_LEVEL;
+        levelAsText: string;
+    }>;
+}
+
+declare class GetOrgTree {
+    private readonly organizationRepository;
+    constructor(organizationRepository: OrganizationRepositoryInterface);
+    execute(orgId: string, scope?: HIERARCHY_SCOPE): Promise<OrgHierarchyResult>;
+}
+
+declare class SetDefaultSharing {
+    private readonly sharingRepository;
+    private readonly detailsRepository;
+    private readonly adminRepository;
+    constructor(sharingRepository: SharingRepositoryInterface, detailsRepository: SharingDetailsRepositoryInterface, adminRepository: AdminRepositoryInterface);
+    execute({ assetId, assetType, orgId, sharedOrigin, }: {
+        assetId: string;
+        assetType: ASSET_TYPE;
+        orgId: string;
+        sharedOrigin: SHARED_ORIGIN;
+    }): Promise<Sharing>;
+}
+
 declare const api: {
     upsert: (args_0: {
         body: UpsertInterface;
@@ -193,42 +423,18 @@ declare const api: {
         body: Delete;
     }) => Promise<boolean | null>;
 };
-declare const checkUserAccessLevel: (args_0: {
-    assetId: string;
-    userId: string;
-    clientId?: string;
-    loginType?: string;
-    roles?: string[];
-    orgId?: string;
-}) => Promise<{
+declare const checkUserAccessLevel: (...args: Parameters<CheckUserAccessLevel["execute"]>) => Promise<{
     level: ACCESS_LEVEL;
     levelAsText: string;
 }>;
-declare const checkAppAccess: (args_0: {
-    appId: string;
-    userId: string;
-}) => Promise<AppAccessResponse>;
-declare const getOrgTree: (orgId: string, scope?: HIERARCHY_SCOPE | undefined) => Promise<OrgHierarchyResult>;
-declare const fromTokenToUser: (args_0: {
-    body: UserToken;
-}) => Promise<ParamsFromTokenToUser>;
-declare const hasAdminRole: (args_0?: {
-    apiKey?: string;
-    clientId?: string;
-    orgId?: string;
-    userId?: string;
-    loginType?: string;
-} | undefined) => Promise<boolean>;
-declare const upsertDefaultSharing: (args_0: {
-    assetId: string;
-    assetType: ASSET_TYPE;
-    sharingMode?: SHARING_MODE;
-    sharingModeStatus?: boolean;
-}) => Promise<Sharing>;
-declare const checkOrgPermissions: (args_0: {
-    orgId: string;
-}) => Promise<{
+declare const checkAppAccess: (...args: Parameters<CheckAppAccess["execute"]>) => Promise<AppAccessResponse>;
+declare const getOrgTree: (...args: Parameters<GetOrgTree["execute"]>) => Promise<OrgHierarchyResult>;
+declare const fromTokenToUser: (...args: Parameters<FromTokenToUser["execute"]>) => Promise<ParamsFromTokenToUser>;
+declare const hasAdminRole: (...args: Parameters<HasAdminRole["execute"]>) => Promise<boolean>;
+declare const hasSharingPermission: (...args: Parameters<HasSharingPermission["execute"]>) => Promise<boolean>;
+declare const setDefaultSharing: (...args: Parameters<SetDefaultSharing["execute"]>) => Promise<Sharing>;
+declare const checkOrgPermissions: (...args: Parameters<CheckOrgPermissions["execute"]>) => Promise<{
     privacy: APP_SHARING_STATUS;
 }>;
 
-export { ACCESS_LEVEL, APP_SHARING_STATUS, ASSET_TYPE, type GetSharingList, HIERARCHY_SCOPE, ORGANIZATION_ANONYMOUS, ORGANIZATION_QRVEY, SHARED_ORIGIN, SHARE_TYPE, SHARING_MODE, api, checkAppAccess, checkOrgPermissions, checkUserAccessLevel, fromTokenToUser, getOrgTree, hasAdminRole, upsertDefaultSharing };
+export { ACCESS_LEVEL, APP_SHARING_STATUS, ASSET_TYPE, type GetSharingList, HIERARCHY_SCOPE, ORGANIZATION_QRVEY, SHARED_ORIGIN, SHARE_TYPE, USER_ANONYMOUS, api, checkAppAccess, checkOrgPermissions, checkUserAccessLevel, fromTokenToUser, getOrgTree, hasAdminRole, hasSharingPermission, setDefaultSharing };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/assets-sharing",
-  "version": "0.3.4-dev.2221",
+  "version": "0.3.5-1236-beta.1",
   "types": "dist/types/index.d.ts",
   "main": "dist/cjs/index.js",
   "exports": {
@@ -31,21 +31,24 @@
     "publish-package": "yarn prepare-publish && npm publish"
   },
   "dependencies": {
-    "@qrvey/data-persistence": "0.5.13-552",
-    "@qrvey/id-generator": "^1.0.1",
+    "@qrvey/data-persistence": "0.5.21-1012",
+    "@qrvey/id-generator": "1.0.1",
     "@qrvey/utils": "1.15.0-30",
     "reflect-metadata": "0.2.2",
     "tsyringe": "4.8.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.14",
-    "eslint": "8.48.0",
-    "eslint-import-resolver-typescript": "3.8.0",
+    "eslint": "8.57.1",
+    "eslint-import-resolver-typescript": "3.8.7",
     "eslint-plugin-import": "2.31.0",
     "jest": "29.7.0",
     "ts-jest": "29.3.4",
-    "tsup": "8.3.5",
-    "typescript": "5.7.3"
+    "tsup": "8.5.1",
+    "typescript": "5.9.3"
+  },
+  "overrides": {
+    "esbuild": "0.28.1"
   },
   "keywords": [
     "sharing",
@@ -57,4 +60,4 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   }
-}
+}