platform/plugins/workbench/src/index.ts
Andrey Sobolev 51b0cdb5f4
Fix version to be proper value (#891)
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
2022-01-31 10:08:51 +01:00

98 lines
2.2 KiB
TypeScript

//
// 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 type { Class, Doc, Mixin, Obj, Ref, Space } from '@anticrm/core'
import type { Asset, IntlString, Metadata, Plugin } from '@anticrm/platform'
import { plugin } from '@anticrm/platform'
import type { AnyComponent } from '@anticrm/ui'
/**
* @public
*/
export interface Application extends Doc {
label: IntlString
icon: Asset
hidden: boolean
navigatorModel?: NavigatorModel
// Component will be displayed in case navigator model is not defined, or nothing is selected in navigator model
component?: AnyComponent
}
/**
* @public
*/
export interface SpacesNavModel {
label: IntlString
spaceClass: Ref<Class<Space>>
addSpaceLabel: IntlString
createComponent: AnyComponent
component?: AnyComponent
}
/**
* @public
*/
export interface NavigatorModel {
spaces: SpacesNavModel[]
specials?: SpecialNavModel[]
}
/**
* @public
*/
export interface SpecialNavModel {
id: string // Uniq id
label: IntlString
icon: Asset
component: AnyComponent
position?: 'top'|'bottom' // undefined == 'top
}
/**
* @public
*/
export interface ViewConfiguration {
class: Ref<Class<Doc>> // show object of this class
createItemDialog?: AnyComponent
}
/**
* @public
*/
export interface SpaceView extends Class<Obj> {
view: ViewConfiguration
}
/**
* @public
*/
export const workbenchId = 'workbench' as Plugin
export default plugin(workbenchId, {
class: {
Application: '' as Ref<Class<Application>>
},
mixin: {
SpaceView: '' as Ref<Mixin<SpaceView>>
},
component: {
WorkbenchApp: '' as AnyComponent
},
metadata: {
RequiredVersion: '' as Metadata<string>
}
})