@tstdl/base 0.91.50 → 0.91.52

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

@@ -0,0 +1,262 @@
+import { type SchemaOutput } from '../../../schema/index.js';
+export declare const metadataParameterSchema: import("../../../schema/index.js").OptionalSchema<Partial<{
+    attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+}>>;
+export declare const metadataParameterObjectSchema: import("../../../schema/index.js").ObjectSchema<{
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const setDocumentPropertyParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    documentId: import("../../../orm/schemas/uuid.js").Uuid;
+    propertyId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly value: unknown;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    date: import("../../../orm/schemas/numeric-date.js").NumericDate | null;
+    expiration: import("../../../orm/schemas/numeric-date.js").NumericDate | null;
+    typeId: import("../../../orm/schemas/uuid.js").Uuid | null;
+    addition: string | null;
+    originalFileName: string | null;
+    readonly collectionIds: string | string[];
+    readonly properties?: {
+        readonly value: unknown;
+        readonly metadata?: Partial<{
+            attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+        }> | undefined;
+        propertyId: import("../../../orm/schemas/uuid.js").Uuid;
+    }[] | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const updateDocumentParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    date?: import("../../../orm/types.js").NumericDate | null | undefined;
+    expiration?: import("../../../orm/types.js").NumericDate | null | undefined;
+    fileId?: import("../../../orm/types.js").Uuid | undefined;
+    typeId?: import("../../../orm/types.js").Uuid | null | undefined;
+    addition?: string | null | undefined;
+    readonly properties?: {
+        readonly value: unknown;
+        readonly metadata?: Partial<{
+            attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+        }> | undefined;
+        propertyId: import("../../../orm/schemas/uuid.js").Uuid;
+    }[] | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentRequestsTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    description: string | null;
+    label: string;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const updateDocumentRequestsTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    description?: string | null | undefined;
+    label?: string | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const applyDocumentRequestsTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    readonly collectionIds: string[];
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const deleteDocumentRequestsTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentRequestTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    comment: string | null;
+    typeId: import("../../../orm/schemas/uuid.js").Uuid | null;
+    requiredFilesCount: number;
+    requestsTemplateId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const updateDocumentRequestTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    comment?: string | null | undefined;
+    typeId?: import("../../../orm/types.js").Uuid | null | undefined;
+    requiredFilesCount?: number | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const deleteDocumentRequestTemplateParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentRequestParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    comment: string | null;
+    typeId: import("../../../orm/schemas/uuid.js").Uuid | null;
+    requiredFilesCount: number;
+    readonly collectionIds: string[];
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const updateDocumentRequestParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    comment?: string | null | undefined;
+    typeId?: import("../../../orm/types.js").Uuid | null | undefined;
+    requiredFilesCount?: number | undefined;
+    completed?: boolean | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const deleteDocumentRequestParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const updateDocumentRequestFileParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    addition?: string | null | undefined;
+    approvalComment?: string | null | undefined;
+    approvalTimestamp?: import("../../../orm/types.js").Timestamp | null | undefined;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const deleteDocumentRequestFileParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const loadDataCollectionMetadataParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    readonly name?: string | null | undefined;
+    readonly group?: string | null | undefined;
+}>;
+export declare const loadDataCollectionsMetadataParametersSchema: import("../../../schema/index.js").ObjectSchema<Partial<import("../../../schema/index.js").Record<string, {
+    readonly name?: string | null | undefined;
+    readonly group?: string | null | undefined;
+}>>>;
+export declare const loadDataParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    readonly collectionIds: string | string[];
+    readonly collectionsMetadata: Partial<import("../../../schema/index.js").Record<string, {
+        readonly name?: string | null | undefined;
+        readonly group?: string | null | undefined;
+    }>>;
+}>;
+export declare const createCollectionParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const setDocumentPropertiesParametersSchema: import("../../../schema/index.js").ArraySchema<{
+    documentId: import("../../../orm/schemas/uuid.js").Uuid;
+    propertyId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly value: unknown;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentCategoryParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    label: string;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentTypeParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    group: string | null;
+    label: string;
+    categoryId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentRequestFileParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    readonly requestId: string;
+    addition: string | null;
+    originalFileName: string | null;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const approveDocumentRequestFileParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    approvalComment: string | null;
+    readonly documentMetadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+    readonly requestFileMetadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const rejectDocumentRequestFileParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    id: import("../../../orm/types.js").IsPrimaryKey<import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/uuid.js").Uuid>>;
+    approvalComment: string | null;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const createDocumentPropertyParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    label: string;
+    dataType: import("../document-property.model.js").DocumentPropertyDataType;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const assignPropertyToTypeParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    typeId: import("../../../orm/schemas/uuid.js").Uuid;
+    propertyId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export declare const addOrArchiveDocumentToOrFromCollectionParametersSchema: import("../../../schema/index.js").ObjectSchema<{
+    collectionId: import("../../../orm/schemas/uuid.js").Uuid;
+    documentId: import("../../../orm/schemas/uuid.js").Uuid;
+    readonly metadata?: Partial<{
+        attributes: import("../../../orm/types.js").HasDefault<import("../../../orm/schemas/json.js").Json<import("../../../orm/entity.js").EntityMetadataAttributes>>;
+    }> | undefined;
+}>;
+export type MetadataParameter = SchemaOutput<typeof metadataParameterObjectSchema>;
+export type LoadDataCollectionMetadataParameters = SchemaOutput<typeof loadDataCollectionMetadataParametersSchema>;
+export type LoadDataCollectionsMetadataParameters = SchemaOutput<typeof loadDataCollectionsMetadataParametersSchema>;
+export type LoadDataParameters = SchemaOutput<typeof loadDataParametersSchema>;
+export type CreateCollectionParameters = SchemaOutput<typeof createCollectionParametersSchema>;
+export type CreateDocumentParameters = SchemaOutput<typeof createDocumentParametersSchema>;
+export type ApproveDocumentRequestFileParameters = SchemaOutput<typeof approveDocumentRequestFileParametersSchema>;
+export type RejectDocumentRequestFileParameters = SchemaOutput<typeof rejectDocumentRequestFileParametersSchema>;
+export type CreateDocumentCategoryParameters = SchemaOutput<typeof createDocumentCategoryParametersSchema>;
+export type CreateDocumentTypeParameters = SchemaOutput<typeof createDocumentTypeParametersSchema>;
+export type CreateDocumentRequestFileParameters = SchemaOutput<typeof createDocumentRequestFileParametersSchema>;
+export type CreateDocumentRequestParameters = SchemaOutput<typeof createDocumentRequestParametersSchema>;
+export type CreateDocumentRequestsTemplateParameters = SchemaOutput<typeof createDocumentRequestsTemplateParametersSchema>;
+export type UpdateDocumentRequestsTemplateParameters = SchemaOutput<typeof updateDocumentRequestsTemplateParametersSchema>;
+export type ApplyDocumentRequestsTemplateParameters = SchemaOutput<typeof applyDocumentRequestsTemplateParametersSchema>;
+export type DeleteDocumentRequestsTemplateParameters = SchemaOutput<typeof deleteDocumentRequestsTemplateParametersSchema>;
+export type CreateDocumentRequestTemplateParameters = SchemaOutput<typeof createDocumentRequestTemplateParametersSchema>;
+export type UpdateDocumentRequestTemplateParameters = SchemaOutput<typeof updateDocumentRequestTemplateParametersSchema>;
+export type DeleteDocumentRequestTemplateParameters = SchemaOutput<typeof deleteDocumentRequestTemplateParametersSchema>;
+export type CreateDocumentPropertyParameters = SchemaOutput<typeof createDocumentPropertyParametersSchema>;
+export type AssignPropertyToTypeParameters = SchemaOutput<typeof assignPropertyToTypeParametersSchema>;
+export type SetDocumentPropertyParameters = SchemaOutput<typeof setDocumentPropertyParametersSchema>;
+export type SetDocumentPropertiesParameters = SchemaOutput<typeof setDocumentPropertiesParametersSchema>;
+export type AddOrArchiveDocumentToOrFromCollectionParameters = SchemaOutput<typeof addOrArchiveDocumentToOrFromCollectionParametersSchema>;
+export type UpdateDocumentParameters = SchemaOutput<typeof updateDocumentParametersSchema>;
+export type UpdateDocumentRequestParameters = SchemaOutput<typeof updateDocumentRequestParametersSchema>;
+export type DeleteDocumentRequestParameters = SchemaOutput<typeof deleteDocumentRequestParametersSchema>;
+export type UpdateDocumentRequestFileParameters = SchemaOutput<typeof updateDocumentRequestFileParametersSchema>;
+export type DeleteDocumentRequestFileParameters = SchemaOutput<typeof deleteDocumentRequestFileParametersSchema>;

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

@@ -0,0 +1,50 @@
+import { EntityMetadata } from '../../../orm/entity.js';
+import { array, assign, nullable, object, omit, oneOrMany, optional, partial, pick, record, string, unknown } from '../../../schema/index.js';
+import { DocumentCategory } from '../document-category.model.js';
+import { DocumentCollectionDocument } from '../document-collection-document.model.js';
+import { DocumentFile } from '../document-file.model.js';
+import { DocumentPropertyValueBase } from '../document-property-value.model.js';
+import { DocumentProperty } from '../document-property.model.js';
+import { DocumentRequestFile } from '../document-request-file.model.js';
+import { DocumentRequestTemplate } from '../document-request-template.js';
+import { DocumentRequest } from '../document-request.model.js';
+import { DocumentRequestsTemplate } from '../document-requests-template.js';
+import { DocumentTypeProperty } from '../document-type-property.model.js';
+import { DocumentType } from '../document-type.model.js';
+import { Document } from '../document.model.js';
+export const metadataParameterSchema = optional(partial(pick(EntityMetadata, 'attributes')));
+export const metadataParameterObjectSchema = object({ metadata: metadataParameterSchema });
+export const setDocumentPropertyParametersSchema = assign(pick(DocumentPropertyValueBase, ['documentId', 'propertyId']), object({ value: unknown() }), metadataParameterObjectSchema);
+export const createDocumentParametersSchema = assign(pick(Document, ['typeId', 'addition', 'date', 'expiration']), pick(DocumentFile, ['originalFileName']), object({
+    collectionIds: oneOrMany(string()),
+    properties: optional(array(omit(setDocumentPropertyParametersSchema, ['documentId'])))
+}), metadataParameterObjectSchema);
+export const updateDocumentParametersSchema = assign(pick(Document, ['id']), partial(omit(Document, ['id', 'metadata'])), object({ properties: optional(array(omit(setDocumentPropertyParametersSchema, ['documentId']))) }), metadataParameterObjectSchema);
+export const createDocumentRequestsTemplateParametersSchema = assign(pick(DocumentRequestsTemplate, ['label', 'description']), metadataParameterObjectSchema);
+export const updateDocumentRequestsTemplateParametersSchema = assign(pick(DocumentRequestsTemplate, ['id']), partial(omit(DocumentRequestsTemplate, ['id', 'metadata'])), metadataParameterObjectSchema);
+export const applyDocumentRequestsTemplateParametersSchema = assign(pick(DocumentRequestsTemplate, ['id']), object({ collectionIds: array(string()) }), metadataParameterObjectSchema);
+export const deleteDocumentRequestsTemplateParametersSchema = assign(pick(DocumentRequestsTemplate, ['id']), metadataParameterObjectSchema);
+export const createDocumentRequestTemplateParametersSchema = assign(pick(DocumentRequestTemplate, ['requestsTemplateId', 'typeId', 'requiredFilesCount', 'comment']), metadataParameterObjectSchema);
+export const updateDocumentRequestTemplateParametersSchema = assign(pick(DocumentRequestTemplate, ['id']), partial(omit(DocumentRequestTemplate, ['id', 'requestsTemplateId', 'metadata'])), metadataParameterObjectSchema);
+export const deleteDocumentRequestTemplateParametersSchema = assign(pick(DocumentRequestTemplate, ['id']), metadataParameterObjectSchema);
+export const createDocumentRequestParametersSchema = assign(pick(DocumentRequest, ['typeId', 'requiredFilesCount', 'comment']), object({ collectionIds: array(string()) }), metadataParameterObjectSchema);
+export const updateDocumentRequestParametersSchema = assign(pick(DocumentRequest, ['id']), partial(omit(DocumentRequest, ['id', 'metadata'])), metadataParameterObjectSchema);
+export const deleteDocumentRequestParametersSchema = assign(pick(DocumentRequest, ['id']), metadataParameterObjectSchema);
+export const updateDocumentRequestFileParametersSchema = assign(pick(DocumentRequestFile, ['id']), partial(omit(DocumentRequestFile, ['id', 'requestId', 'fileId', 'createdDocumentId', 'approval', 'metadata'])), metadataParameterObjectSchema);
+export const deleteDocumentRequestFileParametersSchema = assign(pick(DocumentRequestFile, ['id']), metadataParameterObjectSchema);
+export const loadDataCollectionMetadataParametersSchema = object({ name: optional(nullable(string())), group: optional(nullable(string())) });
+export const loadDataCollectionsMetadataParametersSchema = record(string(), loadDataCollectionMetadataParametersSchema);
+export const loadDataParametersSchema = object({ collectionIds: oneOrMany(string()), collectionsMetadata: loadDataCollectionsMetadataParametersSchema });
+export const createCollectionParametersSchema = metadataParameterObjectSchema;
+export const setDocumentPropertiesParametersSchema = array(setDocumentPropertyParametersSchema);
+export const createDocumentCategoryParametersSchema = assign(pick(DocumentCategory, ['label']), metadataParameterObjectSchema);
+export const createDocumentTypeParametersSchema = assign(pick(DocumentType, ['categoryId', 'group', 'label']), metadataParameterObjectSchema);
+export const createDocumentRequestFileParametersSchema = assign(object({ requestId: string() }), pick(DocumentRequestFile, ['addition']), pick(DocumentFile, ['originalFileName']), metadataParameterObjectSchema);
+export const approveDocumentRequestFileParametersSchema = assign(pick(DocumentRequestFile, ['id', 'approvalComment']), object({
+    documentMetadata: metadataParameterSchema,
+    requestFileMetadata: metadataParameterSchema
+}));
+export const rejectDocumentRequestFileParametersSchema = assign(pick(DocumentRequestFile, ['id', 'approvalComment']), metadataParameterObjectSchema);
+export const createDocumentPropertyParametersSchema = assign(pick(DocumentProperty, ['label', 'dataType']), metadataParameterObjectSchema);
+export const assignPropertyToTypeParametersSchema = assign(pick(DocumentTypeProperty, ['typeId', 'propertyId']), metadataParameterObjectSchema);
+export const addOrArchiveDocumentToOrFromCollectionParametersSchema = assign(pick(DocumentCollectionDocument, ['collectionId', 'documentId']), metadataParameterObjectSchema);

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

@@ -0,0 +1,33 @@
+import { Timestamp } from '../../../orm/types.js';
+import { DocumentCategory } from '../document-category.model.js';
+import { DocumentCollection } from '../document-collection.model.js';
+import { DocumentFile } from '../document-file.model.js';
+import { DocumentPropertyValue } from '../document-property-value.model.js';
+import { DocumentRequestFile } from '../document-request-file.model.js';
+import { DocumentRequest } from '../document-request.model.js';
+import { DocumentType } from '../document-type.model.js';
+import { Document } from '../document.model.js';
+export declare class DocumentCollectionView extends DocumentCollection {
+    name: string | null;
+    group: string | null;
+}
+export declare class DocumentViewCollectionAssignment {
+    collectionId: string;
+    archiveTimestamp: Timestamp | null;
+}
+export declare class DocumentView extends Document {
+    collectionAssignments: DocumentViewCollectionAssignment[];
+    properties: DocumentPropertyValue[];
+}
+export declare class DocumentRequestView extends DocumentRequest {
+    collectionIds: string[];
+    requestFiles: DocumentRequestFile[];
+}
+export declare class DocumentManagementData {
+    collections: DocumentCollectionView[];
+    documents: DocumentView[];
+    requests: DocumentRequestView[];
+    files: DocumentFile[];
+    categories: DocumentCategory[];
+    types: DocumentType[];
+}

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

@@ -0,0 +1,99 @@
+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);
+};
+import { Timestamp } from '../../../orm/types.js';
+import { Array, StringProperty } from '../../../schema/index.js';
+import { DocumentCategory } from '../document-category.model.js';
+import { DocumentCollection } from '../document-collection.model.js';
+import { DocumentFile } from '../document-file.model.js';
+import { documentPropertyValueSchema } from '../document-property-value.model.js';
+import { DocumentRequestFile } from '../document-request-file.model.js';
+import { DocumentRequest } from '../document-request.model.js';
+import { DocumentType } from '../document-type.model.js';
+import { Document } from '../document.model.js';
+export class DocumentCollectionView extends DocumentCollection {
+    name;
+    group;
+}
+__decorate([
+    StringProperty({ nullable: true }),
+    __metadata("design:type", Object)
+], DocumentCollectionView.prototype, "name", void 0);
+__decorate([
+    StringProperty({ nullable: true }),
+    __metadata("design:type", Object)
+], DocumentCollectionView.prototype, "group", void 0);
+export class DocumentViewCollectionAssignment {
+    collectionId;
+    archiveTimestamp;
+}
+__decorate([
+    StringProperty(),
+    __metadata("design:type", String)
+], DocumentViewCollectionAssignment.prototype, "collectionId", void 0);
+__decorate([
+    Timestamp({ nullable: true }),
+    __metadata("design:type", Object)
+], DocumentViewCollectionAssignment.prototype, "archiveTimestamp", void 0);
+export class DocumentView extends Document {
+    collectionAssignments;
+    properties;
+}
+__decorate([
+    Array(DocumentViewCollectionAssignment),
+    __metadata("design:type", Array)
+], DocumentView.prototype, "collectionAssignments", void 0);
+__decorate([
+    Array(documentPropertyValueSchema),
+    __metadata("design:type", Array)
+], DocumentView.prototype, "properties", void 0);
+export class DocumentRequestView extends DocumentRequest {
+    collectionIds;
+    requestFiles;
+}
+__decorate([
+    Array(String),
+    __metadata("design:type", Array)
+], DocumentRequestView.prototype, "collectionIds", void 0);
+__decorate([
+    Array(DocumentRequestFile),
+    __metadata("design:type", Array)
+], DocumentRequestView.prototype, "requestFiles", void 0);
+export class DocumentManagementData {
+    collections;
+    documents;
+    requests;
+    files;
+    categories;
+    types;
+}
+__decorate([
+    Array(DocumentCollectionView),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "collections", void 0);
+__decorate([
+    Array(DocumentView),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "documents", void 0);
+__decorate([
+    Array(DocumentRequestView),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "requests", void 0);
+__decorate([
+    Array(DocumentFile),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "files", void 0);
+__decorate([
+    Array(DocumentCategory),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "categories", void 0);
+__decorate([
+    Array(DocumentType),
+    __metadata("design:type", Array)
+], DocumentManagementData.prototype, "types", void 0);

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

@@ -0,0 +1,8 @@
+export * from './categories-and-types.view-model.js';
+export * from './document-folders.view-model.js';
+export * from './document-requests-template.view-model.js';
+export * from './document.service-model.js';
+export * from './document.view-model.js';
+export * from './normalized-document-collection-view.model.js';
+export * from './normalized-requests-template-data.model.js';
+export * from './stats.view-model.js';

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

@@ -0,0 +1,8 @@
+export * from './categories-and-types.view-model.js';
+export * from './document-folders.view-model.js';
+export * from './document-requests-template.view-model.js';
+export * from './document.service-model.js';
+export * from './document.view-model.js';
+export * from './normalized-document-collection-view.model.js';
+export * from './normalized-requests-template-data.model.js';
+export * from './stats.view-model.js';

package/document-management/models/service-models/normalized-document-collection-view.model.d.ts

@@ -0,0 +1,73 @@
+import type { TypedOmit } from '../../../types.js';
+import type { DocumentCategory } from '../document-category.model.js';
+import type { DocumentCollection } from '../document-collection.model.js';
+import type { DocumentFile } from '../document-file.model.js';
+import type { DocumentRequestFile } from '../document-request-file.model.js';
+import type { DocumentType } from '../document-type.model.js';
+import type { DocumentManagementData, DocumentRequestView, DocumentView } from './document.view-model.js';
+export type RequestMetadata = {
+    pendingRequestFilesCount: number;
+    approvedRequestFilesCount: number;
+    rejectedRequestFilesCount: number;
+    requiredFilesLeft: number;
+};
+export type RequestsMetadata = RequestMetadata & {
+    requiredFilesCount: number;
+};
+export type GroupedCollectionsItem = RequestsMetadata & {
+    group: string | null;
+    collections: NormalizedDocumentCollectionView[];
+};
+export type NormalizedDocumentManagementData = TypedOmit<DocumentManagementData, 'collections' | 'documents' | 'requests' | 'categories' | 'types'> & RequestsMetadata & {
+    collections: NormalizedDocumentCollectionView[];
+    groupedCollections: GroupedCollectionsItem[];
+    documents: NormalizedDocumentView[];
+    requests: NormalizedDocumentRequestView[];
+    categories: NormalizedDocumentCategory[];
+    types: NormalizedDocumentType[];
+};
+export type GroupedRequestsItem = {
+    category: NormalizedDocumentCategory | null;
+    groups: ({
+        label: string | null;
+        requests: NormalizedDocumentRequestView[];
+    } & RequestsMetadata)[];
+};
+export type NormalizedDocumentCollectionView = DocumentCollection & RequestsMetadata & {
+    name: string | null;
+    group: string | null;
+    documents: NormalizedDocumentView[];
+    requests: NormalizedDocumentRequestView[];
+    groupedRequests: GroupedRequestsItem[];
+};
+export type NormalizedDocumentView = TypedOmit<DocumentView, 'typeId'> & {
+    type: NormalizedDocumentType | null;
+    file: DocumentFile;
+};
+export type NormalizedDocumentRequestView = TypedOmit<DocumentRequestView, 'typeId' | 'requestFiles'> & RequestMetadata & {
+    collections: NormalizedDocumentCollectionView[];
+    type: NormalizedDocumentType | null;
+    files: DocumentFile[];
+    requestFiles: NormalizedDocumentRequestFileView[];
+};
+export type NormalizedDocumentRequestFileView = TypedOmit<DocumentRequestFile, 'fileId'> & {
+    file: DocumentFile;
+};
+export type NormalizedDocumentTypeGroup = {
+    label: string | null;
+    types: NormalizedDocumentType[];
+};
+export type NormalizedDocumentCategory = DocumentCategory & {
+    groups: NormalizedDocumentTypeGroup[];
+    types: NormalizedDocumentType[];
+};
+export type NormalizedDocumentType = TypedOmit<DocumentType, 'categoryId'> & {
+    category: DocumentCategory;
+};
+/**
+ * @param primaryCollectionId - if a document request is for multiple collections, remove the primary collection from the request to avoid duplication
+ * @returns
+ */
+export declare function toNormalizedDocumentManagementData(data: DocumentManagementData, options?: {
+    primaryCollectionId?: string | null;
+}): NormalizedDocumentManagementData;