@apia/uploader-controller 4.0.44 → 5.0.0

package/dist/index.d.ts

@@ -2,44 +2,27 @@ import * as _apia_util from '@apia/util';
 import { EventEmitter, NotificationDefinition, T__LEGACY_SERVER__ApiaLoad, T__LEGACY_SERVER__ApiaFunction } from '@apia/util';
 import * as _apia_api2 from '@apia/api2';
 import { ApiContext } from '@apia/api2';
+import { MobXTreeNodeState, MobXTreeNode, MobXTree } from '@apia/tree2-controller';
 
-interface UploadContext extends ApiContext {
-    currentUserLogin: string;
-    docLangs: string;
-    everyoneCanUpdate: boolean;
-    ownerCanUpdate: boolean;
-    readonly: boolean;
-    IN_MONITOR: boolean;
-    WEBDAV_SERVER: string;
-    ITHit: any;
-}
-/**
- * El comportamiento de esta función se explica por su
- * nombre.
- */
-declare function returnExactlyTheSame(defaultParameters: Record<string, unknown>): Record<string, unknown>;
-declare const parseFileDefinition: (context: UploadContext, fileDefinition: TFileUploaded | TUploaderFileInfo, isSignRequired: boolean) => TUploaderFileInfo;
-type TOnUploadProgress = (progress: number) => void;
 declare class UploaderApi extends EventEmitter<{
     fileUploaded: null;
 }> {
     props: {
         context: UploadContext;
         id: string;
-        type: 'E' | 'P';
         modalConfig: TModalConfig;
     };
     maxFiles: number;
     modalController: UploaderModalController | null;
-    allowTranslations: boolean;
     langs: Record<number, string> | undefined;
     currentConfiguration: TUploaderLoadCurrentFunctionMessages | undefined;
     state: UploaderState;
     get filesArray(): TUploaderFileInfo[];
+    get id(): string;
+    get modalConfig(): TModalConfig;
     constructor(props: {
         context: UploadContext;
         id: string;
-        type: 'E' | 'P';
         modalConfig: TModalConfig;
     });
     get context(): UploadContext;
@@ -147,17 +130,18 @@ declare class UploaderApi extends EventEmitter<{
         langId?: number;
         translatingFile?: TUploaderFileInfo;
     }): Promise<boolean>;
+    protected getLoadCurrentDocumentsParameters(params: Record<string, unknown>): Record<string, unknown>;
     loadCurrentDocuments(): Promise<void>;
     lockDocument(id: string): Promise<void>;
     protected evaluateDeleteDocumentResult(result: unknown): boolean;
     setTranslationFile(file: TUploaderFileInfo, docId: string, langId: number): void;
-    protected getCheckSignatureParameters: typeof returnExactlyTheSame;
-    protected getAjaxUploadFileStatusParameters: typeof returnExactlyTheSame;
-    protected getAjaxUploadStartParameters: typeof returnExactlyTheSame;
-    protected getConfirmDropModalParameters: typeof returnExactlyTheSame;
-    protected getCheckLockDocumentParameters: typeof returnExactlyTheSame;
-    protected getCheckWebDavLockParameters: typeof returnExactlyTheSame;
-    protected getConfirmDropModalPostdata: typeof returnExactlyTheSame;
+    protected getCheckSignatureParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getAjaxUploadFileStatusParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getAjaxUploadStartParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getConfirmDropModalParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getCheckLockDocumentParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getCheckWebDavLockParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getConfirmDropModalPostdata(props: Record<string, unknown>): Record<string, unknown>;
     protected getConfirmDropModalMetadataString: ({ metadata, }: {
         metadata: TDocumentMetadata[];
     }) => string;
@@ -166,17 +150,17 @@ declare class UploaderApi extends EventEmitter<{
         usersPermissions: IUsersPermissions[];
     }) => string;
     protected getConfirmDropModalAdditionalMetadataString: (additionalMetadata: TDocumentMetadata[] | []) => string;
-    protected getDeleteDocumentParameters: typeof returnExactlyTheSame;
-    protected getClearTempFilesParameters: typeof returnExactlyTheSame;
-    protected getDocumentInfoParameters: typeof returnExactlyTheSame;
-    protected getDownloadMultipleDocumentsParameters: typeof returnExactlyTheSame;
-    protected getEditDocumentParameters: typeof returnExactlyTheSame;
-    protected getLockDocumentParameters: typeof returnExactlyTheSame;
-    protected getMarkFileToSignParameters: typeof returnExactlyTheSame;
-    protected getProcessDroppedFilesParameters: typeof returnExactlyTheSame;
-    protected getProcessDroppedFilesPostdata: typeof returnExactlyTheSame;
-    protected getReloadMetadataParameters: typeof returnExactlyTheSame;
-    protected getSaveDroppedFilesParameters: typeof returnExactlyTheSame;
+    protected getDeleteDocumentParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getClearTempFilesParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getDocumentInfoParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getDownloadMultipleDocumentsParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getEditDocumentParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getLockDocumentParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getMarkFileToSignParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getProcessDroppedFilesParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getProcessDroppedFilesPostdata(props: Record<string, unknown>): Record<string, unknown>;
+    protected getReloadMetadataParameters(props: Record<string, unknown>): Record<string, unknown>;
+    protected getSaveDroppedFilesParameters(props: Record<string, unknown>): Record<string, unknown>;
     protected filterAlreadyUploadedFiles(files: File[], conf?: TSaveDroppedFilesConf): File[];
     protected filterByFilesAmountLimit(files: File[]): File[];
     protected filterAcceptedFiles(files: File[], shouldNotify?: boolean, docTypeId?: string | TDocType): File[];
@@ -192,6 +176,92 @@ declare class UploaderApi extends EventEmitter<{
     getLoadFilesForFolderParameters(): Record<string, unknown>;
 }
 
+type TFilePickerProps = {
+    controller?: DirectoriesPicker;
+    onFilePick: (file: string) => unknown;
+};
+type TDocumentStructure = {
+    dLckByCurrUsr: string;
+    docLock: string;
+    folder: string;
+    id: string;
+    moreDocs: number;
+    name: string;
+};
+type TFolderStructure = {
+    addToggler: boolean;
+    allEdit: 'M' | 'R';
+    canWrite: boolean;
+    date: string;
+    desc: string;
+    edit: boolean;
+    id: string;
+    level: string;
+    name: string;
+    parent: string;
+    selectedFolder: boolean;
+};
+type TDirectoriesPickerResponse = {
+    documents: {
+        document: TDocumentStructure | TDocumentStructure[];
+        documentInfo: {
+            folder: string;
+            moreDocs: number;
+        };
+    };
+    folder: TFolderStructure[];
+};
+type TFilesPickerResponse = {
+    folders: {
+        folder: TFolderStructure | TFolderStructure[];
+    };
+    documents: {
+        document: TDocumentStructure | TDocumentStructure[];
+        documentInfo: {
+            folder: string;
+            moreDocs: number;
+        };
+    };
+};
+type TCreateTreeNode = {
+    id?: string;
+    parentId: string;
+} & Omit<Partial<MobXTreeNodeState>, 'children'>;
+
+declare class DirectoryPickerFolderNode extends MobXTreeNode {
+    protected loadMoreDocsNode: MobXTreeNode | null;
+    protected removeLoadMoreDocsNode(): void;
+    isLoadingMore: boolean;
+    constructor(parent: DirectoryPickerFolderNode | DirectoriesPicker, { parentId, id, ...props }: TCreateTreeNode);
+    getTree(): DirectoriesPicker;
+    loadMore(focus?: boolean): Promise<void>;
+    refresh(): Promise<void>;
+}
+
+declare class DocumentNode extends MobXTreeNode {
+    constructor(parent: DirectoryPickerFolderNode | DirectoriesPicker, { parentId, id, ...props }: TCreateTreeNode);
+}
+
+declare class DirectoriesPicker extends MobXTree {
+    api: UploaderApi;
+    isLoading: boolean;
+    renderers: TModalConfig['renderers'];
+    constructor(api: UploaderApi);
+    createDocument(nodeProps: TCreateTreeNode): DocumentNode;
+    createFolder(nodeProps: TCreateTreeNode): DirectoryPickerFolderNode;
+    initialLoad(): Promise<void>;
+    getFolderStructureParams(): {
+        ajaxUrl: string;
+        action: string;
+        preventAsXmlParameter: boolean;
+        isAjax: boolean;
+        isXml: boolean;
+        docId: string | undefined;
+    };
+    getNodeHandler(nodeProps: TCreateTreeNode): DirectoryPickerFolderNode;
+    parseStructureResponse(res: any): TFolderStructure[] | null;
+}
+
 declare class UploaderModalController {
     api: UploaderApi;
     modalConfig: TModalConfig;
@@ -200,6 +270,7 @@ declare class UploaderModalController {
         translatingFile?: TUploaderFileInfo;
         versionFile?: TUploaderFileInfo;
     } | undefined;
+    directories: DirectoriesPicker | null;
     state: UploaderModalState;
     constructor(api: UploaderApi, modalConfig: TModalConfig, conf?: {
         langId?: number;
@@ -234,7 +305,6 @@ declare class UploaderModalController {
     deleteMetadata(indices: number[]): void;
     deletePermission(item: IPoolsPermissions | IUsersPermissions): void;
     protected onChangeExtension(): void;
-    openModal(): Promise<void>;
     setDescription(desc: string): void;
     protected resetMetadata(): Promise<void>;
     validate(): boolean;
@@ -358,19 +428,30 @@ type TDocumentMetadata = {
 };
 type TModalConfig = {
     allowDocumentsMonitor: boolean;
-    allowPickFromDirectories: boolean;
     collapsePermissions: boolean;
     collapseDirectories: boolean;
     collapseMetadata: boolean;
-    defaultDirectory?: number;
     monitorId?: number;
     oneClickUpload: boolean;
     rootFolder?: string;
-    showDirectoriesStructure: boolean;
     showExpDate: boolean;
     showPermissions: boolean;
     showMetadata: boolean;
     translationId?: string;
+    allowPickFromDirectories: boolean;
+    showDirectoriesStructure: boolean;
+    defaultDirectory?: number;
+    /**
+     * Renderers
+     *
+     * Due to avoid react policy on controllers we cannot declare ReactComponent here.
+     */
+    renderers?: {
+        FolderIconRenderer?: any;
+        FileIconRenderer: any;
+        LoadMoreRenderer?: any;
+        LockedFolderIconRenderer?: any;
+    };
 };
 type TUploaderLoadCurrentFunctionMessages = {
     allowSign: boolean;
@@ -490,6 +571,47 @@ type TDocumentVersion = {
 type TRequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
 }[Keys];
+interface UploadContext extends ApiContext {
+    currentUserLogin: string;
+    docLangs: string;
+    everyoneCanUpdate: boolean;
+    openModal: () => unknown;
+    ownerCanUpdate: boolean;
+    readonly: boolean;
+    allowTranslation: boolean;
+    IN_MONITOR: boolean;
+    WEBDAV_SERVER: string;
+    ITHit: any;
+}
+type TOnUploadProgress = (progress: number) => void;
+
+declare const parseFileDefinition: (context: UploadContext, fileDefinition: TFileUploaded | TUploaderFileInfo, isSignRequired: boolean) => TUploaderFileInfo;
+
+declare class FilePicker extends DirectoriesPicker {
+    constructor(api: UploaderApi);
+    getNodeHandler(nodeProps: TCreateTreeNode): DirectoryPickerFolderNode;
+    getFolderStructureParams(): any;
+    parseStructureResponse(res: any): TFolderStructure[] | null;
+}
+
+declare class FilePickerFolderNode extends DirectoryPickerFolderNode {
+    private params;
+    constructor(parent: DirectoryPickerFolderNode | DirectoriesPicker, props: TCreateTreeNode, params?: Record<string, unknown>);
+    loadMore(focus?: boolean): Promise<void>;
+}
+
+declare const DirectoryPickerActions: {
+    ajaxUrl: (api: UploaderApi) => string;
+    loadFolderStructure: string;
+    loadFilesForFolder: string;
+};
+declare const FilePickerActions: {
+    ajaxUrl: string;
+    loadFileSystemStructureTree: string;
+    loadFilesForFolder: string;
+    loadFolderStructure: string;
+};
+declare function makeId(str: string): string;
 
-export { type IPoolsPermissions, type IUsersPermissions, type TAjaxUploadFileStatus, type TAjaxUploadStart, type TApiaDocumentDefinition, type TConfirmDropModal, type TDocInfo, type TDocType, type TDocumentDownloadHistory, type TDocumentInformation, type TDocumentMetadata, type TDocumentPermission, type TDocumentVersion, type TFileUploaded, type TModalConfig, type TOnUploadProgress, type TProcessDroppedFiles, type TRequireOnlyOne, type TSaveDroppedFilesConf, type TUploadModalOpener, type TUploaderFileInfo, type TUploaderLoadCurrentFunction, type TUploaderLoadCurrentFunctionMessages, type UploadContext, UploaderApi, UploaderModalController, type UploaderModalState, type UploaderState, parseFileDefinition, returnExactlyTheSame };
+export { DirectoriesPicker, DirectoryPickerActions, DirectoryPickerFolderNode, DocumentNode, FilePicker, FilePickerActions, FilePickerFolderNode, type IPoolsPermissions, type IUsersPermissions, type TAjaxUploadFileStatus, type TAjaxUploadStart, type TApiaDocumentDefinition, type TConfirmDropModal, type TCreateTreeNode, type TDirectoriesPickerResponse, type TDocInfo, type TDocType, type TDocumentDownloadHistory, type TDocumentInformation, type TDocumentMetadata, type TDocumentPermission, type TDocumentStructure, type TDocumentVersion, type TFilePickerProps, type TFileUploaded, type TFilesPickerResponse, type TFolderStructure, type TModalConfig, type TOnUploadProgress, type TProcessDroppedFiles, type TRequireOnlyOne, type TSaveDroppedFilesConf, type TUploadModalOpener, type TUploaderFileInfo, type TUploaderLoadCurrentFunction, type TUploaderLoadCurrentFunctionMessages, type UploadContext, UploaderApi, UploaderModalController, type UploaderModalState, type UploaderState, makeId, parseFileDefinition };
 //# sourceMappingURL=index.d.ts.map