platform/plugins/controlled-documents/src/docutils.ts
Anna Khismatullina e61eea7076
Port import changes to develop (#8685)
Signed-off-by: Anna Khismatullina <anna.khismatullina@gmail.com>
2025-04-25 17:53:40 +04:00

412 lines
11 KiB
TypeScript

//
// Copyright © 2023 Hardcore Engineering Inc.
//
// Licensed under the Eclipse Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may
// obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
import { type Employee } from '@hcengineering/contact'
import core, { type AttachedData, type Class, type Ref, type TxOperations, Blob, Mixin } from '@hcengineering/core'
import {
type ControlledDocument,
type Document,
type DocumentCategory,
type DocumentMeta,
type DocumentSpace,
type DocumentTemplate,
type HierarchyDocument,
type Project,
type ProjectDocument,
DocumentState
} from './types'
import { makeRank } from '@hcengineering/rank'
import documents from './plugin'
import { getFirstRank, TEMPLATE_PREFIX } from './utils'
async function getParentPath (client: TxOperations, parent: Ref<ProjectDocument>): Promise<Array<Ref<DocumentMeta>>> {
const parentDocObj = await client.findOne(documents.class.ProjectDocument, {
_id: parent
})
if (parentDocObj === undefined) {
console.warn(`Couldn't find the parent project document object with id: ${parent}`)
return []
}
const parentMeta = await client.findOne(documents.class.ProjectMeta, {
_id: parentDocObj.attachedTo
})
if (parentMeta === undefined) {
console.warn(`Couldn't find the parent document meta with id: ${parentDocObj.attachedTo}`)
return []
}
return [parentMeta.meta, ...parentMeta.path]
}
export async function createControlledDocFromTemplate (
client: TxOperations,
templateId: Ref<DocumentTemplate> | undefined,
documentId: Ref<ControlledDocument>,
spec: AttachedData<ControlledDocument>,
space: Ref<DocumentSpace>,
project: Ref<Project> | undefined,
parent: Ref<ProjectDocument> | undefined,
docClass: Ref<Class<ControlledDocument>> = documents.class.ControlledDocument
): Promise<{ seqNumber: number, success: boolean }> {
if (templateId == null) {
return { seqNumber: -1, success: false }
}
const { seqNumber, prefix, content, category } = await useDocumentTemplate(client, templateId)
const { success, documentMetaId } = await createControlledDocMetadata(
client,
templateId,
documentId,
space,
project,
parent,
prefix,
seqNumber,
spec.code,
spec.title
)
if (!success) {
return { seqNumber: -1, success: false }
}
await client.addCollection(
docClass,
space,
documentMetaId,
documents.class.DocumentMeta,
'documents',
{
...spec,
category,
template: templateId,
seqNumber,
prefix,
state: DocumentState.Draft,
content
},
documentId
)
return { seqNumber, success: true }
}
export async function useDocumentTemplate (
client: TxOperations,
templateId: Ref<DocumentTemplate>
): Promise<{ seqNumber: number, prefix: string, content: Ref<Blob> | null, category: Ref<DocumentCategory> }> {
const template = await client.findOne(documents.mixin.DocumentTemplate, {
_id: templateId
})
if (template === undefined) {
return { seqNumber: -1, prefix: '', content: null, category: '' as Ref<DocumentCategory> }
}
await client.updateMixin(templateId, documents.class.Document, template.space, documents.mixin.DocumentTemplate, {
$inc: { sequence: 1 }
})
// FIXME: not concurrency safe
const seqNumber = template.sequence + 1
const prefix = template.docPrefix
return { seqNumber, prefix, content: template.content, category: template.category as Ref<DocumentCategory> }
}
export async function createControlledDocMetadata (
client: TxOperations,
templateId: Ref<DocumentTemplate>,
documentId: Ref<ControlledDocument>,
space: Ref<DocumentSpace>,
project: Ref<Project> | undefined,
parent: Ref<ProjectDocument> | undefined,
prefix: string,
seqNumber: number,
specCode: string,
specTitle: string,
metaId?: Ref<DocumentMeta>
): Promise<{
success: boolean
seqNumber: number
documentMetaId: Ref<DocumentMeta>
projectDocumentId: Ref<ProjectDocument>
}> {
const projectId = project ?? documents.ids.NoProject
const ops = client.apply('create-qms-document')
ops.notMatch(documents.class.Document, {
template: templateId,
seqNumber
})
ops.notMatch(documents.class.Document, {
code: specCode
})
const documentMetaId = await ops.createDoc(
documents.class.DocumentMeta,
space,
{
documents: 0,
title: `${specCode} ${specTitle}`
},
metaId
)
let path: Array<Ref<DocumentMeta>> = []
if (parent !== undefined) {
path = await getParentPath(client, parent)
}
const parentMeta = path[0] ?? documents.ids.NoParent
const lastRank = await getFirstRank(client, space, projectId, parentMeta)
const projectMetaId = await ops.createDoc(documents.class.ProjectMeta, space, {
project: projectId,
meta: documentMetaId,
path,
parent: parentMeta,
documents: 0,
rank: makeRank(lastRank, undefined)
})
const projectDocumentId = await client.addCollection(
documents.class.ProjectDocument,
space,
projectMetaId,
documents.class.ProjectMeta,
'documents',
{
project: projectId,
initial: projectId,
document: documentId
}
)
const success = await ops.commit()
return { success: success.result, seqNumber, documentMetaId, projectDocumentId }
}
export async function createDocumentTemplate (
client: TxOperations,
_class: Ref<Class<Document>>,
space: Ref<DocumentSpace>,
_mixin: Ref<Mixin<DocumentTemplate>>,
project: Ref<Project> | undefined,
parent: Ref<ProjectDocument> | undefined,
templateId: Ref<ControlledDocument>,
prefix: string,
spec: Omit<AttachedData<ControlledDocument>, 'prefix'>,
category: Ref<DocumentCategory>,
author?: Ref<Employee>
): Promise<{ seqNumber: number, success: boolean }> {
const { success, seqNumber, code, documentMetaId } = await createDocumentTemplateMetadata(
client,
_class,
space,
_mixin,
project,
parent,
templateId,
prefix,
spec.code ?? '',
spec.title
)
if (!success) {
return { seqNumber: -1, success: false }
}
const ops = client.apply()
await ops.addCollection<DocumentMeta, HierarchyDocument>(
_class,
space,
documentMetaId,
documents.class.DocumentMeta,
'documents',
{
...spec,
code,
seqNumber,
category,
prefix: TEMPLATE_PREFIX,
author,
owner: author,
content: spec.content ?? null
},
templateId
)
await ops.createMixin(templateId, documents.class.Document, space, _mixin, {
sequence: 0,
docPrefix: prefix
})
const commit = await ops.commit()
return { seqNumber, success: commit.result }
}
export async function createDocumentTemplateMetadata (
client: TxOperations,
_class: Ref<Class<Document>>,
space: Ref<DocumentSpace>,
_mixin: Ref<Mixin<DocumentTemplate>>,
project: Ref<Project> | undefined,
parent: Ref<ProjectDocument> | undefined,
templateId: Ref<ControlledDocument>,
prefix: string,
specCode: string,
specTitle: string,
metaId?: Ref<DocumentMeta>
): Promise<{
success: boolean
seqNumber: number
code: string
documentMetaId: Ref<DocumentMeta>
projectDocumentId: Ref<ProjectDocument>
}> {
const projectId = project ?? documents.ids.NoProject
const incResult = await client.updateDoc(
core.class.Sequence,
documents.space.Documents,
documents.sequence.Templates,
{
$inc: { sequence: 1 }
},
true
)
const seqNumber = (incResult as any).object.sequence as number
const code = specCode === '' ? `${TEMPLATE_PREFIX}-${seqNumber}` : specCode
let path: Array<Ref<DocumentMeta>> = []
if (parent !== undefined) {
path = await getParentPath(client, parent)
}
const ops = client.apply('create-qms-document')
ops.notMatch(documents.class.Document, {
template: { $exists: false },
seqNumber
})
ops.notMatch(documents.class.Document, {
code
})
ops.notMatch(documents.mixin.DocumentTemplate, {
docPrefix: prefix
})
const documentMetaId = await ops.createDoc(
documents.class.DocumentMeta,
space,
{
documents: 0,
title: `${code} ${specTitle}`
},
metaId
)
const parentMeta = path[0] ?? documents.ids.NoParent
const lastRank = await getFirstRank(client, space, projectId, parentMeta)
const projectMetaId = await ops.createDoc(documents.class.ProjectMeta, space, {
project: projectId,
meta: documentMetaId,
path,
parent: path[0] ?? documents.ids.NoParent,
documents: 0,
rank: makeRank(lastRank, undefined)
})
const projectDocumentId = await client.addCollection(
documents.class.ProjectDocument,
space,
projectMetaId,
documents.class.ProjectMeta,
'documents',
{
project: projectId,
initial: projectId,
document: templateId
}
)
const success = await ops.commit()
return { success: success.result, seqNumber, code, documentMetaId, projectDocumentId }
}
export async function createNewFolder (
client: TxOperations,
space: Ref<DocumentSpace>,
project: Ref<Project> | undefined,
parent: Ref<ProjectDocument> | undefined,
title: string
): Promise<{
success: boolean
documentMetaId: Ref<DocumentMeta>
projectDocumentId: Ref<ProjectDocument>
}> {
const projectId = project ?? documents.ids.NoProject
const ops = client.apply()
const documentMetaId = await ops.createDoc(documents.class.DocumentMeta, space, { documents: 0, title })
let path: Array<Ref<DocumentMeta>> = []
if (parent !== undefined) {
path = await getParentPath(client, parent)
}
const parentMeta = path[0] ?? documents.ids.NoParent
const lastRank = await getFirstRank(client, space, projectId, parentMeta)
const projectMetaId = await ops.createDoc(documents.class.ProjectMeta, space, {
project: projectId,
meta: documentMetaId,
path,
parent: parentMeta,
documents: 0,
rank: makeRank(lastRank, undefined)
})
const projectDocumentId = await client.addCollection(
documents.class.ProjectDocument,
space,
projectMetaId,
documents.class.ProjectMeta,
'documents',
{
project: projectId,
initial: projectId,
document: documents.ids.Folder
}
)
const success = await ops.commit()
return { success: success.result, documentMetaId, projectDocumentId }
}