cat-documents-ng 0.1.30 → 0.1.32

package/lib/document/document.module.d.ts

@@ -0,0 +1,40 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./components/document-container/document-container.component";
+import * as i2 from "./components/folder-container/folder-container.component";
+import * as i3 from "./components/folder-block/folder-block.component";
+import * as i4 from "./components/document-list/document-list.component";
+import * as i5 from "./components/document-list-item/document-list-item.component";
+import * as i6 from "./components/document-upload/document-upload.component";
+import * as i7 from "./components/document-viewer/document-viewer.component";
+import * as i8 from "./directives/document.directive";
+import * as i9 from "./directives/permission.directive";
+import * as i10 from "./components/linked-document/linked-document.component";
+import * as i11 from "@angular/common";
+import * as i12 from "primeng/accordion";
+import * as i13 from "@angular/common/http";
+import * as i14 from "primeng/button";
+import * as i15 from "primeng/sidebar";
+import * as i16 from "primeng/fileupload";
+import * as i17 from "primeng/progressbar";
+import * as i18 from "primeng/badge";
+import * as i19 from "primeng/listbox";
+import * as i20 from "primeng/checkbox";
+import * as i21 from "primeng/timeline";
+import * as i22 from "primeng/inputtextarea";
+import * as i23 from "@angular/forms";
+import * as i24 from "ng2-pdf-viewer";
+import * as i25 from "primeng/dialog";
+import * as i26 from "primeng/dropdown";
+import * as i27 from "primeng/inputtext";
+/**
+ * @module DocumentModule
+ *
+ * The `DocumentModule` handles the organization and display of document and folder components
+ * in the application. This module is designed to support features like folder containers,
+ * document lists, and individual document items.
+ */
+export declare class DocumentModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DocumentModule, [typeof i1.DocumentContainerComponent, typeof i2.FolderContainerComponent, typeof i3.FolderBlockComponent, typeof i4.DocumentListComponent, typeof i5.DocumentListItemComponent, typeof i6.DocumentUploadComponent, typeof i7.DocumentViewerComponent, typeof i8.DocumentDirective, typeof i9.HasPermissionDirective, typeof i10.LinkedDocumentComponent], [typeof i11.CommonModule, typeof i12.AccordionModule, typeof i13.HttpClientModule, typeof i14.ButtonModule, typeof i15.SidebarModule, typeof i16.FileUploadModule, typeof i17.ProgressBarModule, typeof i18.BadgeModule, typeof i19.ListboxModule, typeof i20.CheckboxModule, typeof i21.TimelineModule, typeof i22.InputTextareaModule, typeof i23.FormsModule, typeof i24.PdfViewerModule, typeof i25.DialogModule, typeof i26.DropdownModule, typeof i27.InputTextModule], [typeof i9.HasPermissionDirective, typeof i1.DocumentContainerComponent, typeof i7.DocumentViewerComponent, typeof i4.DocumentListComponent, typeof i8.DocumentDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DocumentModule>;
+}

package/{src/lib/document/models/document-alert.model.ts → lib/document/models/document-alert.model.d.ts}

@@ -1,45 +1,38 @@
-import { SHARED } from "../../../Shared/constant/SHARED";
-
-/**
- * The `DocumentAlertModel` is responsible for managing and displaying alert messages for documents.
- * @export
- * @class DocumentAlertModel
- * @typedef {DocumentAlertModel} - Represents the document alert model.
- */
-export class DocumentAlertModel {
-    /**
-     * The unique identifier for the document alert.
-     * @type {string}
-     */
-    _id : string = SHARED.EMPTY
-    
-    /**
-     * The alert status for the document.
-     * @type {string}
-     */
-    alertStatus?: string;
-    
-    /**
-     * The context ID for the document.
-     * @type {?string}
-     */
-    contextId?: string;
-
-    /**
-     * The document ID for the document.
-     * @type {?string}
-     */
-    documentId?: string;
-
-    /**
-     * The alert message for the document.
-     * @type {?string}
-     */
-    alertMessage?:string;
-
-    /**
-     * The alert type for the document.
-     * @type {?string}
-     */
-    status?: string;
-}
+/**
+ * The `DocumentAlertModel` is responsible for managing and displaying alert messages for documents.
+ * @export
+ * @class DocumentAlertModel
+ * @typedef {DocumentAlertModel} - Represents the document alert model.
+ */
+export declare class DocumentAlertModel {
+    /**
+     * The unique identifier for the document alert.
+     * @type {string}
+     */
+    _id: string;
+    /**
+     * The alert status for the document.
+     * @type {string}
+     */
+    alertStatus?: string;
+    /**
+     * The context ID for the document.
+     * @type {?string}
+     */
+    contextId?: string;
+    /**
+     * The document ID for the document.
+     * @type {?string}
+     */
+    documentId?: string;
+    /**
+     * The alert message for the document.
+     * @type {?string}
+     */
+    alertMessage?: string;
+    /**
+     * The alert type for the document.
+     * @type {?string}
+     */
+    status?: string;
+}

package/lib/document/models/document-type.model.d.ts

@@ -0,0 +1,37 @@
+/**
+ * DocumentTypeModel
+ * @interface DocumentTypeModel  Model for document types.
+ * @typedef {DocumentTypeModel}  Model for document types.
+ */
+export interface DocumentTypeModel {
+    /**
+     * The label for the document type.
+     * @type {string}
+     * @memberof DocumentTypeModel
+     */
+    label?: string;
+    /**
+     * The match rules for the document type.
+     * @type {string}
+     * @memberof DocumentTypeModel
+     */
+    matchRules?: string;
+    /**
+     * The name of the document type.
+     * @type {string}
+     * @memberof DocumentTypeModel
+     */
+    name?: string;
+    /**
+     * The parent document type ID.
+     * @type {string}
+     * @memberof DocumentTypeModel
+     */
+    parentDocumentTypeId?: string;
+    /**
+     * The document type ID.
+     * @type {string}
+     * @memberof DocumentTypeModel
+     */
+    _id: string;
+}

package/lib/document/models/document.model.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Represents a document model.
+ *
+ * This class contains the structure for document-related data, including file name,
+ * status, and document URL.
+ */
+export declare class DocumentModel {
+    /**
+     * The unique identifier for the document.
+     * @type {string}
+     */
+    _id: string;
+    /**
+     * The name of the document file.
+     * @type {?string}
+     */
+    fileName?: string;
+    /**
+     * The current status of the document.
+     * @type {?string}
+     */
+    status?: string;
+    /**
+     * The URL where the document is hosted or stored.
+     * @type {?string}
+     */
+    documentUrl?: string;
+    /**
+     * Date of document get uploaded
+     * @type {?Date}
+     */
+    createdAt?: Date;
+    /**
+     * Shows the type of document
+     * @type {?string}
+     */
+    documentTypeName?: string;
+    /**
+     * Shows the type of content
+     * @type {?string}
+     */
+    contentType?: string;
+    documentName?: string;
+}

package/{src/lib/document/models/folder.model.ts → lib/document/models/folder.model.d.ts}

@@ -1,35 +1,29 @@
-import { SHARED } from "../../../Shared/constant/SHARED";
-
-/**
- * Represents the model for a folder block.
- * 
- * This class provides the structure for folder block data, including properties 
- * for ID, file counts, descriptive text, and counts for missing and pending files.
- */
-export class FolderBlockModel {
-    /**
-     * Unique identifier for the folder block.
-     * Defaults to an empty string sourced from `SHARED.EMPTY`.
-     */
-    _id: string = SHARED.EMPTY;
-
-    /**
-     * Total number of document within the folder block.
-     */
-    documentCount?: number;
-
-    /**
-     * Descriptive text associated with the folder block.
-     */
-    folderName?: string;
-
-    /**
-     * Number of files marked as missing in the folder block.
-     */
-    missingFiles?: number;
-
-    /**
-     * Number of files marked as pending in the folder block.
-     */
-    pendingFiles?: number;
-}
+/**
+ * Represents the model for a folder block.
+ *
+ * This class provides the structure for folder block data, including properties
+ * for ID, file counts, descriptive text, and counts for missing and pending files.
+ */
+export declare class FolderBlockModel {
+    /**
+     * Unique identifier for the folder block.
+     * Defaults to an empty string sourced from `SHARED.EMPTY`.
+     */
+    _id: string;
+    /**
+     * Total number of document within the folder block.
+     */
+    documentCount?: number;
+    /**
+     * Descriptive text associated with the folder block.
+     */
+    folderName?: string;
+    /**
+     * Number of files marked as missing in the folder block.
+     */
+    missingFiles?: number;
+    /**
+     * Number of files marked as pending in the folder block.
+     */
+    pendingFiles?: number;
+}

package/lib/document/services/document-http.service.d.ts

@@ -0,0 +1,69 @@
+import { Observable } from 'rxjs';
+import { AppConfigService } from '../../../Shared/services/app-config.service';
+import { DocumentStore } from '../state/document.store';
+import { HttpClient } from '@angular/common/http';
+import { DocumentTypeModel } from '../models/document-type.model';
+import { DocumentAlertModel } from '../models/document-alert.model';
+import { DocumentModel } from '../models/document.model';
+import { FolderBlockModel } from '../models/folder.model';
+import * as i0 from "@angular/core";
+/**
+ * Service for making HTTP requests related to documents.
+ * @class DocumentHttpService
+ * @typedef {DocumentHttpService}
+ */
+export declare class DocumentHttpService {
+    documentStore: DocumentStore;
+    private http;
+    appConfigService: AppConfigService;
+    /**
+     * Creates an instance of DocumentService.
+     * @param {DocumentStore} documentStore - Store managing the state of documents.
+     * @param {HttpClient} http - Angular HTTP client for making API requests.
+     * @param {AppConfigService} appConfigService - Service for retrieving application configuration, such as API base URL.
+     */
+    constructor(documentStore: DocumentStore, http: HttpClient, appConfigService: AppConfigService);
+    /**
+     * Get api url from appConfigService.
+     * @readonly
+     * @type {string}
+     */
+    get apiUrl(): string;
+    /**
+     * Fetches a document by its path name and transforms the response for dropdown options.
+     * Includes error handling for failed API requests.
+     * @param {string} contextId - The context ID to fetch the document.
+     * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
+     */
+    getFoldersData(contextId: string | undefined): Observable<FolderBlockModel[]>;
+    /**
+     * Fetches a document by its path name and transforms the response for dropdown options.
+     * Includes error handling for failed API requests.
+     * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
+     */
+    getDocumentTypes(): Observable<DocumentTypeModel[]>;
+    /**
+     * Fetches a document by its path name and transforms the response for dropdown options.
+     * @param {string} documentId - The document ID to fetch the document.
+     * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
+     */
+    getAlertsByDocumentID(documentId: string): Observable<DocumentAlertModel>;
+    /**
+     * Fetches a document by its folder ID and transforms the response for dropdown options.
+     * @param {string} folderId - The folder ID to fetch the document.
+     * @param {string} contextId - The context ID to fetch the document.
+     * @returns {Observable<any>} Observable that emits the transformed data for dropdown options.
+     */
+    getDocumentByFolderID(folderId: string, contextId: string): Observable<DocumentModel[]>;
+    /**
+     * Updates the name of a document.
+     * This method sends an HTTP PUT request to update the document's file name using the provided document ID and payload.
+     * In case of an error, it will return an observable that throws an Error.
+     * @param {string} documentId - The unique identifier of the document to update.
+     * @param {any} payload - The payload containing the updated document data (e.g., fileName).
+     * @returns {Observable<DocumentModel>} An observable that emits the updated DocumentModel.
+     */
+    updateDocumentName(documentId: string, payload: any): Observable<DocumentModel>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentHttpService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentHttpService>;
+}

package/lib/document/services/document-upload.service.d.ts

@@ -0,0 +1,67 @@
+import { DocumentService } from '../state/document.service';
+import { DocumentStore } from '../state/document.store';
+import { MessageService } from 'primeng/api';
+import * as i0 from "@angular/core";
+/**
+ * Service for handling document uploads.
+ * @class DocumentUploadService
+ * @typedef {DocumentUploadService}
+ */
+export declare class DocumentUploadService {
+    documentService: DocumentService;
+    documentUploadStore: DocumentStore;
+    messageService: MessageService;
+    /**
+     * The file to upload.
+     * @type {*}
+     */
+    uploadedFile: any;
+    /**
+     * Represent contextId
+     * @type {string}
+     */
+    contextId: string;
+    /**
+     * Represent document name
+     * @type {string}
+     */
+    docName: string;
+    /**
+     * Represent document id
+     * @type {string}
+     */
+    docTypeId: string;
+    /**
+     * Creates an instance of DocumentUploadService.
+     * @param {DocumentService} documentService - Service for handling document uploads.
+     * @param {DocumentStore} documentUploadStore - Store for managing uploaded documents.
+     * @param {MessageService} messageService - Service for displaying messages.
+     * @returns {void}
+     */
+    constructor(documentService: DocumentService, documentUploadStore: DocumentStore, messageService: MessageService);
+    /**
+     * Prepares the files for upload by creating a FormData object.
+     * This method appends each file to the FormData for submission.
+     * @returns {void}
+     */
+    handleTemplatedUpload(): void;
+    /**
+     * Get the file and contextId
+     * @param file - The file to upload.
+     * @param contextId - The contextId to upload.
+     */
+    getUploadFileData(file: File, contextId: string): void;
+    /**
+     * Get the document name and document type id
+     * @param documentName - The document name to upload.
+     * @param documentTypeId - The document type id to upload.
+     */
+    getDocumentNameAndType(documentTypeId: string): void;
+    /**
+     * Handle the creation of formdata.
+     * @returns {*} - The formdata object.
+     */
+    handleCreateFormData(): FormData | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentUploadService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentUploadService>;
+}

package/lib/document/services/document.service.d.ts

@@ -0,0 +1,20 @@
+import { DocumentModel } from "../models/document.model";
+import * as i0 from "@angular/core";
+/**
+ * Service to manage the document data
+ */
+export declare class DocumentService {
+    private documentSubject$;
+    /**
+     * Set the document data
+     * @param document the document data
+     */
+    set(document: DocumentModel | null): void;
+    /**
+     * Get the document data
+     * @returns the document data
+     */
+    get(): import("rxjs").Observable<DocumentModel | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentService>;
+}

package/lib/document/services/file-format.service.d.ts

@@ -0,0 +1,23 @@
+import { PrimeNGConfig } from 'primeng/api';
+import * as i0 from "@angular/core";
+/**
+ * Description placeholder
+ * @class FileFormatService
+ * @typedef {FileFormatService}
+ */
+export declare class FileFormatService {
+    /**
+     * Creates an instance of FileFormatService.
+     * @constructor
+     */
+    constructor();
+    /**
+     * Description placeholder
+     * @param {number} bytes
+     * @param {PrimeNGConfig} config
+     * @returns {string}
+     */
+    formatFileSize(bytes: number, config: PrimeNGConfig): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileFormatService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FileFormatService>;
+}

package/lib/document/state/document.query.d.ts

@@ -0,0 +1,50 @@
+import { QueryEntity } from '@datorama/akita';
+import { DocumentStore } from './document.store';
+import { DocumentState } from './document.state';
+import { Observable } from 'rxjs';
+import { Message } from 'primeng/api';
+import { DocumentModel } from '../models/document.model';
+import * as i0 from "@angular/core";
+/**
+ * Query service for managing document state.
+ * This class extends Akita's `QueryEntity` to provide additional functionality for querying document data.
+ * @class DocumentQuery
+ * @typedef {DocumentQuery}
+ * @augments {QueryEntity<DocumentState>}
+ */
+export declare class DocumentQuery extends QueryEntity<DocumentState> {
+    protected store: DocumentStore;
+    constructor(store: DocumentStore);
+    /**
+     * Selects the currently selected folder ID from the document state.
+     * @returns {Observable<string | null>} Observable that emits the currently selected folder ID.
+     */
+    getParentDocumentTypeId(): string | null;
+    /**
+     * Selects the currently selected folder ID from the document state.
+     * @returns {Observable<string | null>} Observable that emits the currently selected folder ID.
+     */
+    selectParentDocumentTypeId(): Observable<string | null>;
+    /**
+     * Selects the set messages.
+     * @returns {Observable<Message>} Observable that emits the current Message.
+     */
+    selectMessages(): Observable<Message[]>;
+    /**
+     * Selects the set documents.
+     * @returns {Observable<DocumentModel[]>} Observable that emits the documets.
+     */
+    selectDocumets(): Observable<DocumentModel[]>;
+    /**
+     * Retrieves the currently selected document from the store state.
+     * @returns {Observable<any>} Observable that emits the selected document.
+     */
+    getSelectedDocument(): Observable<any>;
+    /**
+     * Retrieves the flag indicating whether a document has been updated.
+     * @returns {Observable<any>} Observable that emits a boolean or status flag.
+     */
+    getIsDocumentUpdated(): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DocumentQuery, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DocumentQuery>;
+}