@tstdl/base 0.93.97 → 0.93.99

package/document-management/service-models/document-statistics.view-model.js

@@ -0,0 +1,160 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var _a, _b, _c;
+import { BooleanProperty, Integer, Property, StringProperty } from '../../schema/index.js';
+import { DocumentApproval } from '../models/document.model.js';
+export class DocumentApprovalBreakdown {
+    [_a = DocumentApproval.Pending];
+    [_b = DocumentApproval.Approved];
+    [_c = DocumentApproval.Rejected];
+}
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentApprovalBreakdown.prototype, _a, void 0);
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentApprovalBreakdown.prototype, _b, void 0);
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentApprovalBreakdown.prototype, _c, void 0);
+export class DocumentDataQualityMetrics {
+    missingType;
+    missingDate;
+    missingTitle;
+}
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentDataQualityMetrics.prototype, "missingType", void 0);
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentDataQualityMetrics.prototype, "missingDate", void 0);
+__decorate([
+    Integer(),
+    __metadata("design:type", Number)
+], DocumentDataQualityMetrics.prototype, "missingTitle", void 0);
+export class DocumentStatistics {
+    totalCount;
+    approvalBreakdown;
+    typeBreakdown;
+    storageUsage;
+    mimeTypeDistribution;
+    dataQuality;
+    createdLast30Days;
+    tagUsage;
+    totalPages;
+    validationFailures;
+}
+__decorate([
+    Integer({ optional: true }),
+    __metadata("design:type", Number)
+], DocumentStatistics.prototype, "totalCount", void 0);
+__decorate([
+    Property(DocumentApprovalBreakdown, { optional: true }),
+    __metadata("design:type", DocumentApprovalBreakdown)
+], DocumentStatistics.prototype, "approvalBreakdown", void 0);
+__decorate([
+    Property(Object, { optional: true }),
+    __metadata("design:type", Object)
+], DocumentStatistics.prototype, "typeBreakdown", void 0);
+__decorate([
+    Integer({ optional: true }),
+    __metadata("design:type", Number)
+], DocumentStatistics.prototype, "storageUsage", void 0);
+__decorate([
+    Property(Object, { optional: true }),
+    __metadata("design:type", Object)
+], DocumentStatistics.prototype, "mimeTypeDistribution", void 0);
+__decorate([
+    Property(DocumentDataQualityMetrics, { optional: true }),
+    __metadata("design:type", DocumentDataQualityMetrics)
+], DocumentStatistics.prototype, "dataQuality", void 0);
+__decorate([
+    Integer({ optional: true }),
+    __metadata("design:type", Number)
+], DocumentStatistics.prototype, "createdLast30Days", void 0);
+__decorate([
+    Property(Object, { optional: true }),
+    __metadata("design:type", Object)
+], DocumentStatistics.prototype, "tagUsage", void 0);
+__decorate([
+    Integer({ optional: true }),
+    __metadata("design:type", Number)
+], DocumentStatistics.prototype, "totalPages", void 0);
+__decorate([
+    Integer({ optional: true }),
+    __metadata("design:type", Number)
+], DocumentStatistics.prototype, "validationFailures", void 0);
+export class GetDocumentStatisticsOptions {
+    includeTotalCount;
+    includeApprovalBreakdown;
+    includeTypeBreakdown;
+    includeStorageUsage;
+    includeMimeTypeDistribution;
+    includeDataQuality;
+    includeCreatedLast30Days;
+    includeTagUsage;
+    includeTotalPages;
+    includeValidationFailures;
+    collectionIds;
+    categoryIds;
+}
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeTotalCount", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeApprovalBreakdown", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeTypeBreakdown", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeStorageUsage", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeMimeTypeDistribution", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeDataQuality", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeCreatedLast30Days", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeTagUsage", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeTotalPages", void 0);
+__decorate([
+    BooleanProperty({ optional: true }),
+    __metadata("design:type", Boolean)
+], GetDocumentStatisticsOptions.prototype, "includeValidationFailures", void 0);
+__decorate([
+    StringProperty({ array: true }),
+    __metadata("design:type", Array)
+], GetDocumentStatisticsOptions.prototype, "collectionIds", void 0);
+__decorate([
+    StringProperty({ array: true, optional: true }),
+    __metadata("design:type", Array)
+], GetDocumentStatisticsOptions.prototype, "categoryIds", void 0);

package/document-management/service-models/document.service-model.d.ts

@@ -236,7 +236,7 @@ export declare const addOrArchiveDocumentToOrFromCollectionParametersSchema: imp
 }>;
 export declare const proceedDocumentWorkflowParametersSchema: import("../../schema/index.js").ObjectSchema<{
     id: string;
-    state: "error" | "pending" | "running" | "completed" | "review" | "failed";
+    state: "error" | "pending" | "running" | "completed" | "failed" | "review";
 }>;
 export type MetadataParameter = SchemaOutput<typeof metadataParameterObjectSchema>;
 export type LoadDataParameters = SchemaOutput<typeof loadDataParametersSchema>;

package/document-management/service-models/index.d.ts

@@ -3,6 +3,7 @@ export * from './document-collection-metadata.service-model.js';
 export * from './document-folders.view-model.js';
 export * from './document-management.view-model.js';
 export * from './document-requests-template.view-model.js';
+export * from './document-statistics.view-model.js';
 export * from './document.service-model.js';
 export * from './enriched/index.js';
 export * from './stats.view-model.js';

package/document-management/service-models/index.js

@@ -3,6 +3,7 @@ export * from './document-collection-metadata.service-model.js';
 export * from './document-folders.view-model.js';
 export * from './document-management.view-model.js';
 export * from './document-requests-template.view-model.js';
+export * from './document-statistics.view-model.js';
 export * from './document.service-model.js';
 export * from './enriched/index.js';
 export * from './stats.view-model.js';

package/document-management/tests/document-management-core.test.js

@@ -4,7 +4,7 @@ import { AiModuleOptions } from '../../ai/module.js';
 import { runInInjectionContext } from '../../injector/index.js';
 import { ObjectStorage } from '../../object-storage/index.js';
 import { TaskQueue } from '../../task-queue/index.js';
-import { setupIntegrationTest, truncateTables } from '../../unit-test/index.js';
+import { setupIntegrationTest, clearTenantData } from '../../unit-test/index.js';
 import { configureDocumentManagement } from '../server/configure.js';
 import { migrateDocumentManagementSchema } from '../server/module.js';
 import { DocumentCategoryTypeService } from '../server/services/document-category-type.service.js';
@@ -72,7 +72,7 @@ describe('Document Management Core', () => {
         await injector?.dispose();
     });
     beforeEach(async () => {
-        await truncateTables(database, schema, ['request_collection_assignment', 'collection_assignment', 'workflow', 'request', 'document', 'collection', 'type', 'category']);
+        await clearTenantData(database, schema, ['request_collection_assignment', 'collection_assignment', 'workflow', 'request', 'document', 'collection', 'type', 'category'], tenantId);
     });
     // --- Collection Management ---
     test('Create and load collection', async () => {

package/document-management/tests/document-management.api.test.d.ts

@@ -0,0 +1 @@
+export {};

package/document-management/tests/document-management.api.test.js

@@ -0,0 +1,102 @@
+import { afterAll, beforeAll, beforeEach, describe, expect, test, vi } from 'vitest';
+import { AiService } from '../../ai/ai.service.js';
+import { AiModuleOptions } from '../../ai/module.js';
+import { runInInjectionContext } from '../../injector/index.js';
+import { ObjectStorage } from '../../object-storage/index.js';
+import { TaskQueue } from '../../task-queue/index.js';
+import { clearTenantData, setupIntegrationTest } from '../../unit-test/index.js';
+import { DocumentManagementAuthorizationService } from '../authorization/document-management-authorization.service.js';
+import { DocumentManagementApiController } from '../server/api/document-management.api.js';
+import { configureDocumentManagement } from '../server/configure.js';
+import { migrateDocumentManagementSchema } from '../server/module.js';
+import { DocumentCollectionService } from '../server/services/document-collection.service.js';
+import { DocumentService } from '../server/services/document.service.js';
+import { TestDocumentManagementAncillaryService, TestDocumentManagementAuthorizationService } from './helper.js';
+describe('DocumentManagementApi Stats', () => {
+    let injector;
+    let database;
+    let controller;
+    let documentService;
+    let collectionService;
+    const schema = 'document_management';
+    const tenantId = crypto.randomUUID();
+    beforeAll(async () => {
+        ({ injector, database } = await setupIntegrationTest({
+            modules: { taskQueue: false, messageBus: true },
+            orm: { schema },
+        }));
+        injector.register(AiModuleOptions, { useValue: {} });
+        injector.register(AiService, { useValue: { processFile: vi.fn() } });
+        injector.register(ObjectStorage, {
+            useValue: {
+                uploadObject: vi.fn(),
+                getDownloadUrl: vi.fn(),
+                getContent: vi.fn(),
+                getContentStream: vi.fn(),
+                getObject: vi.fn(),
+                exists: vi.fn(),
+            },
+        });
+        injector.register(TaskQueue, {
+            useValue: {
+                enqueue: vi.fn(),
+                enqueueMany: vi.fn(),
+                process: vi.fn(),
+            },
+        });
+        configureDocumentManagement({
+            ancillaryService: TestDocumentManagementAncillaryService,
+            authorizationService: TestDocumentManagementAuthorizationService,
+            fileObjectStorageModule: 'documents',
+            fileUploadObjectStorageModule: 'document-uploads',
+            filePreviewObjectStorageModule: 'document-previews',
+        });
+        await runInInjectionContext(injector, migrateDocumentManagementSchema);
+        controller = await injector.resolveAsync(DocumentManagementApiController);
+        documentService = await injector.resolveAsync(DocumentService);
+        collectionService = await injector.resolveAsync(DocumentCollectionService);
+    });
+    afterAll(async () => {
+        await injector?.dispose();
+    });
+    beforeEach(async () => {
+        await clearTenantData(database, schema, ['collection_assignment', 'workflow', 'document', 'collection', 'tag', 'type', 'category'], tenantId);
+    });
+    test('getStatistics API endpoint', async () => {
+        await runInInjectionContext(injector, async () => {
+            const collection = await collectionService.createCollection(tenantId, null);
+            const authService = injector.resolve(DocumentManagementAuthorizationService);
+            vi.spyOn(authService, 'getTenantId').mockResolvedValue(tenantId);
+            await documentService.create(tenantId, {
+                assignment: { collections: [collection.id] },
+                skipWorkflow: true,
+            }, new Uint8Array([1, 2, 3]));
+            const mockContext = {
+                getToken: async () => ({ payload: { tenantId } }),
+                parameters: {
+                    includeTotalCount: true,
+                    includeStorageUsage: true,
+                    collectionIds: [collection.id]
+                }
+            };
+            const stats = await controller.getStatistics(mockContext);
+            expect(stats.totalCount).toBe(1);
+            expect(stats.storageUsage).toBe(3);
+        });
+    });
+    test('getStatistics API endpoint should deny access if collection is restricted', async () => {
+        await runInInjectionContext(injector, async () => {
+            const authService = injector.resolve(DocumentManagementAuthorizationService);
+            vi.spyOn(authService, 'getTenantId').mockResolvedValue(tenantId);
+            vi.spyOn(authService, 'canReadCollection').mockResolvedValue(false);
+            const mockContext = {
+                getToken: async () => ({ payload: { tenantId } }),
+                parameters: {
+                    includeTotalCount: true,
+                    collectionIds: ['some-collection-id']
+                }
+            };
+            await expect(controller.getStatistics(mockContext)).rejects.toThrow('You are not allowed to read collection some-collection-id');
+        });
+    });
+});

package/document-management/tests/document-statistics.service.test.d.ts

@@ -0,0 +1 @@
+export {};