huly-platform/models/core/src/security.ts

//
// Copyright © 2020, 2021 Anticrm Platform Contributors.
//
// 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 {
  DOMAIN_MODEL,
  DOMAIN_SPACE,
  IndexKind,
  type ModulePermissionGroup,
  type AccountRole,
  type AccountUuid,
  type AnyAttribute,
  type AttributePermission,
  type Class,
  type ClassPermission,
  type CollectionSize,
  type Doc,
  type Permission,
  type Ref,
  type Role,
  type RolesAssignment,
  type Space,
  type SpaceType,
  type SpaceTypeDescriptor,
  type Tx,
  type TxAccessLevel,
  type TypedSpace
} from '@hcengineering/core'
import {
  ArrOf,
  Collection,
  Hidden,
  Index,
  Mixin,
  Model,
  Prop,
  TypeAccountUuid,
  TypeBoolean,
  TypeNumber,
  TypeRef,
  TypeString,
  UX
} from '@hcengineering/model'
import { getEmbeddedLabel, type Asset, type IntlString } from '@hcengineering/platform'
import core from './component'
import { TAttachedDoc, TClass, TDoc } from './core'
// S P A C E

@Model(core.class.Space, core.class.Doc, DOMAIN_SPACE)
@UX(core.string.Space, undefined, undefined, 'name')
export class TSpace extends TDoc implements Space {
  @Prop(TypeString(), core.string.Name)
  @Index(IndexKind.FullText)
    name!: string

  @Prop(TypeString(), core.string.Description)
  @Index(IndexKind.FullText)
    description!: string

  @Prop(TypeBoolean(), core.string.Private)
    private!: boolean

  @Prop(TypeBoolean(), core.string.Archived)
  @Index(IndexKind.Indexed)
    archived!: boolean

  @Prop(ArrOf(TypeAccountUuid()), core.string.Members)
  @Index(IndexKind.Indexed)
    members!: AccountUuid[]

  @Prop(ArrOf(TypeAccountUuid()), core.string.Owners)
    owners?: AccountUuid[]

  @Prop(TypeBoolean(), core.string.AutoJoin)
    autoJoin?: boolean
}

@Model(core.class.SystemSpace, core.class.Space)
@UX(core.string.Space, undefined, undefined, 'name')
export class TSystemSpace extends TSpace implements Space {}

@Model(core.class.TypedSpace, core.class.Space)
@UX(core.string.TypedSpace, undefined, undefined, 'name')
export class TTypedSpace extends TSpace implements TypedSpace {
  @Prop(TypeRef(core.class.SpaceType), core.string.SpaceType)
    type!: Ref<SpaceType>
}

@Model(core.class.SpaceTypeDescriptor, core.class.Doc, DOMAIN_MODEL)
export class TSpaceTypeDescriptor extends TDoc implements SpaceTypeDescriptor {
  name!: IntlString
  description!: IntlString
  icon!: Asset
  baseClass!: Ref<Class<Space>>
  availablePermissions!: Ref<Permission>[]
  system?: boolean
}

@Model(core.class.SpaceType, core.class.Doc, DOMAIN_MODEL)
@UX(core.string.SpaceType, undefined, undefined, 'name')
export class TSpaceType extends TDoc implements SpaceType {
  @Prop(TypeString(), core.string.Name)
  @Index(IndexKind.FullText)
    name!: string

  @Prop(TypeString(), core.string.ShortDescription)
    shortDescription?: string

  @Prop(TypeRef(core.class.SpaceTypeDescriptor), core.string.Descriptor)
    descriptor!: Ref<SpaceTypeDescriptor>

  @Prop(TypeRef(core.class.Class), core.string.TargetClass)
    targetClass!: Ref<Class<Space>>

  @Prop(Collection(core.class.Role), core.string.Roles)
    roles!: CollectionSize<Role>

  @Prop(ArrOf(TypeAccountUuid()), core.string.Members)
    members!: AccountUuid[]

  @Prop(TypeBoolean(), core.string.AutoJoin)
    autoJoin?: boolean
}

@Model(core.class.Role, core.class.AttachedDoc, DOMAIN_MODEL)
@UX(core.string.Role, undefined, undefined, 'name')
export class TRole extends TAttachedDoc implements Role {
  @Prop(TypeRef(core.class.SpaceType), core.string.AttachedTo)
  @Index(IndexKind.Indexed)
  @Hidden()
  declare attachedTo: Ref<SpaceType>

  @Prop(TypeRef(core.class.SpaceType), core.string.AttachedToClass)
  @Index(IndexKind.Indexed)
  @Hidden()
  declare attachedToClass: Ref<Class<SpaceType>>

  @Prop(TypeString(), core.string.Collection)
  @Hidden()
  override collection: 'roles' = 'roles'

  @Prop(TypeString(), core.string.Name)
  @Index(IndexKind.FullText)
    name!: string

  @Prop(ArrOf(TypeRef(core.class.Permission)), core.string.Permission)
    permissions!: Ref<Permission>[]
}

@Model(core.class.Permission, core.class.Doc, DOMAIN_MODEL)
@UX(core.string.Permission)
export class TPermission extends TDoc implements Permission {
  label!: IntlString
  txClass?: Ref<Class<Tx>>
  forbid?: boolean
  objectClass?: Ref<Class<Doc<Space>>>
  scope?: 'space' | 'workspace'
  description?: IntlString
  icon?: Asset
}

@Model(core.class.AttributePermission, core.class.Permission)
@UX(core.string.Permission)
export class TAttributePermission extends TPermission implements AttributePermission {
  attribute!: Ref<AnyAttribute>
}

@Model(core.class.ClassPermission, core.class.Permission)
@UX(core.string.Permission)
export class TClassPermission extends TPermission implements ClassPermission {
  targetClass!: Ref<Class<Doc>>
}

@Mixin(core.mixin.SpacesTypeData, core.class.Space)
@UX(getEmbeddedLabel("All spaces' type")) // TODO: add icon?
export class TSpacesTypeData extends TSpace implements RolesAssignment {
  [key: Ref<Role>]: AccountUuid[]
}

@Mixin(core.mixin.TxAccessLevel, core.class.Class)
export class TTxAccessLevel extends TClass implements TxAccessLevel {
  createAccessLevel?: AccountRole
  removeAccessLevel?: AccountRole
  updateAccessLevel?: AccountRole
  isIdentity?: boolean
}

@Model(core.class.ModulePermissionGroup, core.class.Doc, DOMAIN_MODEL)
export class TModulePermissionGroup extends TDoc implements ModulePermissionGroup {
  @Prop(TypeRef(core.class.Doc), core.string.AttachedTo)
    application!: Ref<Doc>

  @Prop(TypeString(), core.string.Roles)
    role!: AccountRole

  @Prop(ArrOf(TypeRef(core.class.Permission)), core.string.Permission)
    permissions!: Ref<Permission>[]

  @Prop(ArrOf(TypeRef(core.class.Permission)), core.string.Permission)
    disabledPermissions?: Ref<Permission>[]

  @Prop(TypeRef(core.class.Class), core.string.Class)
    spaceClass!: Ref<Class<Space>>

  @Prop(TypeBoolean(), core.string.Name)
    enabled!: boolean

  @Prop(TypeNumber(), core.string.Order)
    order?: number
}