@edifice.io/client/dist/share/interface.d.ts

Edifice TypeScript Client

import { Group, Bookmark, User } from '../directory/interface';
export interface ShareRight {
    id: string;
    type: ShareRightType;
    displayName: string;
    profile?: string;
    avatarUrl: string;
    directoryUrl: string;
    actions: ShareRightAction[];
    isBookmarkMember?: boolean;
    users?: User[];
    groups?: Group[];
}
export interface ShareParameters {
    id: string;
    rights: ShareRight[];
}
/**
 * Type of share right
 * */
export type ShareRightType = 'user' | 'group' | 'sharebookmark';
/**
 * Type of action when sharing
 * */
export interface ShareRightAction {
    id: ShareRightActionDisplayName;
    displayName: ShareRightActionDisplayName;
    priority?: number;
    requires?: ShareRightActionDisplayName[];
}
/**
 * Name of current action when sharing
 * */
export type ShareRightActionDisplayName = 'read' | 'contrib' | 'manage' | 'publish' | 'manager' | 'comment';
export type ShareRightActionDisplayNameExt = ShareRightActionDisplayName | 'creator';
export type SharingRight = Record<ShareRightActionDisplayName, {
    priority: number;
    default: boolean;
    requires: ShareRightActionDisplayName[];
}>;
export type ShareMapping = Record<ShareRightActionDisplayName, string[]>;
/**
 * Payload of shared resource
 * */
export interface GetResourceRightPayload {
    actions: Array<{
        name: string[];
        displayName: string;
        type: 'RESOURCE';
    }>;
    groups: {
        visibles: Array<{
            id: string;
            name: string;
            groupDisplayName: string;
            structureName: string;
            labels?: string[];
        }>;
        checked: Record<string, string[]>;
    };
    users: {
        visibles: Array<{
            id: string;
            login: string;
            username: string;
            lastName: string;
            firstName: string;
            profile: string;
        }>;
        checked: Record<string, string[]>;
    };
}
/**
 * Update payload of shared resource
 * */
export interface PutSharePayload {
    users: Record<string, string[]>;
    groups: Record<string, string[]>;
    bookmarks: Record<string, string[]>;
}
/**
 * Response of shared resource
 * */
export interface PutShareResponse {
    'notify-timeline-array': Array<{
        groupId: string;
    } | {
        userId: string;
    }>;
}
export interface ShareSubject {
    id: string;
    displayName: string;
    profile?: string;
    avatarUrl: string;
    directoryUrl: string;
    type: 'user' | 'group' | 'sharebookmark';
    structureName?: string;
}
export interface ShareRightWithVisibles {
    rights: ShareRight[];
    visibleUsers: User[];
    visibleGroups: Group[];
    visibleBookmarks: Bookmark[];
}