@bgx4k3p/huly-mcp-server 2.2.4 → 2.2.5

package/node_modules/@hcengineering/core/types/classes.d.ts

@@ -1,716 +0,0 @@
-import type { Asset, IntlString, Plugin } from '@hcengineering/platform';
-import type { DocumentQuery } from './storage';
-import { type WorkspaceDataId, type WorkspaceUuid } from './utils';
-import { Tx } from '.';
-/**
- * @public
- */
-export type Ref<T extends Doc> = string & {
-    __ref: T;
-};
-/**
- * @public
- */
-export type PrimitiveType = number | string | boolean | undefined | Ref<Doc>;
-/**
- * @public
- */
-export type Timestamp = number;
-/**
- * @public
- */
-export type Markup = string;
-/**
- * @public
- */
-export type Hyperlink = string;
-/**
- * @public
- */
-export type CollectionSize<T> = T[]['length'];
-/**
- * @public
- *
- * String representation of {@link https://www.npmjs.com/package/lexorank LexoRank} type
- */
-export type Rank = string;
-/**
- * @public
- *
- * Reference to blob containing snapshot of collaborative doc.
- */
-export type MarkupBlobRef = Ref<Blob>;
-/**
- * @public
- */
-export interface Obj {
-    _class: Ref<Class<this>>;
-}
-export interface Account {
-    uuid: AccountUuid;
-    role: AccountRole;
-    primarySocialId: PersonId;
-    socialIds: PersonId[];
-    fullSocialIds: SocialId[];
-}
-/**
- * @public
- * Global person UUID.
- */
-export type PersonUuid = string & {
-    __personUuid: true;
-};
-/**
- * @public
- * Global person account UUID.
- * The same UUID as PersonUuid but for when account exists.
- */
-export type AccountUuid = PersonUuid & {
-    __accountUuid: true;
-};
-/**
- * @public
- * Generated identifier of a social id linked to a global person.
- */
-export type PersonId = string & {
-    __personId: true;
-};
-export interface BasePerson {
-    name: string;
-    personUuid?: PersonUuid;
-}
-/**
- * @public
- */
-export interface Doc<S extends Space = Space> extends Obj {
-    _id: Ref<this>;
-    space: Ref<S>;
-    modifiedOn: Timestamp;
-    modifiedBy: PersonId;
-    createdBy?: PersonId;
-    createdOn?: Timestamp;
-}
-/**
- * @public
- */
-export type PropertyType = any;
-/**
- * @public
- */
-export interface UXObject extends Obj {
-    label: IntlString;
-    icon?: Asset;
-    color?: number;
-    hidden?: boolean;
-    readonly?: boolean;
-}
-/**
- * @public
- */
-export interface Association extends Doc {
-    classA: Ref<Class<Doc>>;
-    classB: Ref<Class<Doc>>;
-    nameA: string;
-    nameB: string;
-    type: '1:1' | '1:N' | 'N:N';
-}
-/**
- * @public
- */
-export interface Relation extends Doc {
-    docA: Ref<Doc>;
-    docB: Ref<Doc>;
-    association: Ref<Association>;
-}
-/**
- * @public
- */
-export interface AttachedDoc<Parent extends Doc = Doc, Collection extends Extract<keyof Parent, string> | string = Extract<keyof Parent, string> | string, S extends Space = Space> extends Doc<S> {
-    attachedTo: Ref<Parent>;
-    attachedToClass: Ref<Class<Parent>>;
-    collection: Collection;
-}
-/**
- * @public
- */
-export interface Type<T extends PropertyType> extends UXObject {
-}
-/**
- * @public
- */
-export declare enum IndexKind {
-    /**
-     * Attribute with this index annotation should be added to elastic for search
-     * Could be added to string or Ref attribute
-     * TODO: rename properly for better code readability
-     */
-    FullText = 0,
-    /**
-     * For attribute with this annotation should be created an index in mongo database
-     *
-     * Also mean to include into Elastic search.
-     */
-    Indexed = 1,
-    IndexedDsc = 2
-}
-/**
- * @public
- */
-export interface Enum extends Doc {
-    name: string;
-    enumValues: string[];
-}
-/**
- * @public
- */
-export interface Attribute<T extends PropertyType> extends Doc, UXObject {
-    attributeOf: Ref<Class<Obj>>;
-    name: string;
-    type: Type<T>;
-    index?: IndexKind;
-    shortLabel?: IntlString;
-    isCustom?: boolean;
-    defaultValue?: any;
-    automationOnly?: boolean;
-    rank?: Rank;
-    [key: string]: any;
-}
-/**
- * @public
- */
-export type AnyAttribute = Attribute<Type<any>>;
-/**
- * @public
- */
-export declare enum ClassifierKind {
-    CLASS = 0,
-    INTERFACE = 1,
-    MIXIN = 2
-}
-/**
- * @public
- */
-export interface Classifier extends Doc, UXObject {
-    kind: ClassifierKind;
-}
-/**
- * @public
- */
-export type Domain = string & {
-    __domain: true;
-};
-/**
- * @public
- */
-export type OperationDomain = string & {
-    __domain: true;
-};
-/**
- * @public
- */
-export interface Interface<T extends Doc> extends Classifier {
-    extends?: Ref<Interface<Doc>>[];
-}
-/**
- * @public
- */
-export interface Class<T extends Obj> extends Classifier {
-    extends?: Ref<Class<Obj>>;
-    implements?: Ref<Interface<Doc>>[];
-    domain?: Domain;
-    shortLabel?: string;
-    sortingKey?: string;
-    filteringKey?: string;
-    pluralLabel?: IntlString;
-}
-/**
- * @public
- * Define a set of plugin to model document bindings.
- */
-export interface PluginConfiguration extends Doc {
-    pluginId: Plugin;
-    transactions: Ref<Doc>[];
-    label: IntlString;
-    icon?: Asset;
-    description?: IntlString;
-    enabled: boolean;
-    system?: true;
-    hidden?: boolean;
-    beta: boolean;
-    classFilter?: Ref<Class<Obj>>[];
-}
-/**
- * @public
- */
-export type Mixin<T extends Doc> = Class<T>;
-/**
- * @public
- */
-export type Data<T extends Doc> = Omit<T, keyof Doc>;
-/**
- * @public
- */
-export type AttachedData<T extends AttachedDoc> = Omit<T, keyof AttachedDoc>;
-/**
- * @public
- */
-export type DocData<T extends Doc> = T extends AttachedDoc ? AttachedData<T> : Data<T>;
-/**
- * @public
- */
-export declare enum DateRangeMode {
-    DATE = "date",
-    TIME = "time",
-    DATETIME = "datetime",
-    TIMEONLY = "timeonly"
-}
-/**
- * @public
- */
-export interface TypeDate extends Type<Date> {
-    mode: DateRangeMode;
-    withShift: boolean;
-}
-/**
- * @public
- */
-export interface TypeIdentifier extends Type<string> {
-    of: Ref<CustomSequence>;
-}
-/**
- * @public
- */
-export interface TypeNumber extends Type<number> {
-    min?: number;
-    max?: number;
-    digits?: number;
-}
-/**
- * @public
- */
-export interface RefTo<T extends Doc> extends Type<Ref<Class<T>>> {
-    to: Ref<Class<T>>;
-}
-/**
- * @public
- */
-export interface Collection<T extends AttachedDoc> extends Type<CollectionSize<T>> {
-    of: Ref<Class<T>>;
-    itemLabel?: IntlString;
-}
-/**
- * @public
- */
-export type Arr<T extends PropertyType> = T[];
-/**
- * @public
- */
-export interface ArrOf<T extends PropertyType> extends Type<T[]> {
-    of: Type<T>;
-}
-/**
- * @public
- */
-export interface EnumOf extends Type<string> {
-    of: Ref<Enum>;
-}
-/**
- * @public
- */
-export interface TypeHyperlink extends Type<Hyperlink> {
-}
-/**
- * @public
- *
- * A type for some custom serialized field with a set of editors
- */
-export interface TypeAny<AnyComponent = any> extends Type<any> {
-    presenter: AnyComponent;
-    editor?: AnyComponent;
-}
-/**
- * @public
- */
-export declare const DOMAIN_MODEL: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_MODEL_TX: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_SPACE: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_CONFIGURATION: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_MIGRATION: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_TRANSIENT: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_RELATION: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_COLLABORATOR: Domain;
-/**
- * @public
- */
-export interface TransientConfiguration extends Class<Doc> {
-    broadcastOnly: boolean;
-}
-/**
- * Special domain to access s3 blob data.
- * @public
- */
-export declare const DOMAIN_BLOB: Domain;
-/**
- * @public
- */
-export declare const DOMAIN_SEQUENCE: Domain;
-/**
- * @public
- */
-export interface Space extends Doc {
-    name: string;
-    description: string;
-    private: boolean;
-    members: AccountUuid[];
-    archived: boolean;
-    owners?: AccountUuid[];
-    autoJoin?: boolean;
-}
-/**
- * @public
- */
-export interface SystemSpace extends Space {
-}
-/**
- * @public
- *
- * Space with custom configured type
- */
-export interface TypedSpace extends Space {
-    type: Ref<SpaceType>;
-}
-/**
- * @public
- *
- * Is used to describe "types" for space type
- */
-export interface SpaceTypeDescriptor extends Doc {
-    name: IntlString;
-    description: IntlString;
-    icon: Asset;
-    baseClass: Ref<Class<Space>>;
-    availablePermissions: Ref<Permission>[];
-    system?: boolean;
-}
-/**
- * @public
- *
- * Customisable space type allowing to configure space roles and permissions within them
- */
-export interface SpaceType extends Doc {
-    name: string;
-    shortDescription?: string;
-    descriptor: Ref<SpaceTypeDescriptor>;
-    members?: AccountUuid[];
-    autoJoin?: boolean;
-    targetClass: Ref<Class<Space>>;
-    roles: CollectionSize<Role>;
-}
-/**
- * @public
- * Role defines permissions for employees assigned to this role within the space
- */
-export interface Role extends AttachedDoc<SpaceType, 'roles'> {
-    name: string;
-    permissions: Ref<Permission>[];
-}
-/**
- * @public
- * Defines assignment of employees to a role within a space
- */
-export type RolesAssignment = Record<Ref<Role>, AccountUuid[] | undefined>;
-/**
- * @public
- * Permission is a basic access control item in the system
- */
-export interface Permission extends Doc {
-    label: IntlString;
-    txClass?: Ref<Class<Tx>>;
-    forbid?: boolean;
-    objectClass?: Ref<Class<Doc>>;
-    scope?: 'space' | 'workspace';
-    txMatch?: DocumentQuery<Tx>;
-    description?: IntlString;
-    icon?: Asset;
-}
-/**
- * @public
- */
-export declare enum AccountRole {
-    ReadOnlyGuest = "READONLYGUEST",
-    DocGuest = "DocGuest",
-    Guest = "GUEST",
-    User = "USER",
-    Maintainer = "MAINTAINER",
-    Owner = "OWNER",
-    Admin = "ADMIN"
-}
-/**
- * @public
- */
-export declare const roleOrder: Record<AccountRole, number>;
-export interface TxAccessLevel extends Class<Doc> {
-    createAccessLevel?: AccountRole;
-    removeAccessLevel?: AccountRole;
-    updateAccessLevel?: AccountRole;
-    isIdentity?: boolean;
-}
-/**
- * @public
- */
-export interface Person {
-    uuid: PersonUuid;
-    firstName: string;
-    lastName: string;
-}
-export interface PersonInfo extends BasePerson {
-    socialIds: SocialId[];
-}
-/**
- * @public
- */
-export interface UserStatus extends Doc {
-    online: boolean;
-    user: AccountUuid;
-}
-/**
- * @public
- */
-export interface Version extends Doc {
-    major: number;
-    minor: number;
-    patch: number;
-}
-/**
- * @public
- */
-export interface MigrationState extends Doc {
-    plugin: string;
-    state: string;
-}
-/**
- * @public
- */
-export declare function versionToString(version: Version | Data<Version>): string;
-/**
- * @public
- */
-export interface Sequence extends Doc {
-    attachedTo: Ref<Class<Doc>>;
-    sequence: number;
-}
-export interface CustomSequence extends Sequence {
-    prefix: string;
-}
-/**
- * @public
- */
-export type BlobMetadata = Record<string, any>;
-/**
- * @public
- *
- * A blob document to manage blob attached documents.
- *
- * _id: is a platform ID and it created using our regular generateId(),
- * and storageId is a provider specified storage id.
- */
-export interface Blob extends Doc {
-    provider: string;
-    contentType: string;
-    etag: string;
-    version: string | null;
-    size: number;
-}
-export interface BlobType {
-    file: Ref<Blob>;
-    type: string;
-    name: string;
-    size: number;
-    metadata?: BlobMetadata;
-}
-export type Blobs = Record<string, BlobType>;
-/**
- * For every blob will automatically add a lookup.
- *
- * It extends Blob to allow for $lookup operations work as expected.
- */
-export interface BlobLookup extends Blob {
-    downloadUrl: string;
-    downloadUrlExpire?: number;
-}
-/**
- * @public
- *
- * If defined for class, this class will be enabled for embedding search like openai.
- */
-export interface FullTextSearchContext extends Doc {
-    toClass: Ref<Class<Doc>>;
-    fullTextSummary?: boolean;
-    forceIndex?: boolean;
-}
-/**
- * @public
- */
-export interface ConfigurationElement extends Class<Doc> {
-    title: IntlString;
-    group: IntlString;
-}
-/**
- * @public
- *
- * Define configuration value configuration for workspace.
- *
- * Configuration is accessible only for owners of workspace and under hood services.
- */
-export interface Configuration extends Doc {
-    enabled: boolean;
-}
-/**
- * @public
- */
-export type RelatedDocument = Pick<Doc, '_id' | '_class'>;
-/**
- * @public
- */
-export declare enum IndexOrder {
-    Ascending = 1,
-    Descending = -1
-}
-/**
- * @public
- */
-export type FieldIndex<T extends Doc> = {
-    [P in keyof T]?: IndexOrder;
-} & Record<string, IndexOrder>;
-export interface FieldIndexConfig<T extends Doc> {
-    sparse?: boolean;
-    filter?: Omit<DocumentQuery<T>, '$search'>;
-    keys: FieldIndex<T> | string;
-}
-/**
- * @public
- *
- * Mixin for extra indexing fields.
- */
-export interface IndexingConfiguration<T extends Doc> extends Class<Doc> {
-    indexes: (string | FieldIndexConfig<T>)[];
-    searchDisabled?: boolean;
-}
-export interface DomainIndexConfiguration extends Doc {
-    domain: Domain;
-    disableCollection?: boolean;
-    disabled?: (FieldIndex<Doc> | string)[];
-    indexes?: (FieldIndexConfig<Doc> | string)[];
-    skip?: string[];
-}
-export type WorkspaceMode = 'manual-creation' | 'pending-creation' | 'creating' | 'upgrading' | 'pending-deletion' | 'deleting' | 'active' | 'deleted' | 'archiving-pending-backup' | 'archiving-backup' | 'archiving-pending-clean' | 'archiving-clean' | 'archived' | 'migration-pending-backup' | 'migration-backup' | 'migration-pending-clean' | 'migration-clean' | 'pending-restore' | 'restoring';
-export type WorkspaceUserOperation = 'archive' | 'migrate-to' | 'unarchive' | 'delete' | 'reset-attempts';
-export declare function isActiveMode(mode?: WorkspaceMode): boolean;
-export declare function isDeletingMode(mode: WorkspaceMode): boolean;
-export declare function isArchivingMode(mode?: WorkspaceMode): boolean;
-export declare function isMigrationMode(mode?: WorkspaceMode): boolean;
-export declare function isRestoringMode(mode?: WorkspaceMode): boolean;
-export declare function isUpgradingMode(mode?: WorkspaceMode): boolean;
-export type WorkspaceUpdateEvent = 'ping' | 'create-started' | 'create-done' | 'upgrade-started' | 'upgrade-done' | 'restore-started' | 'restore-done' | 'progress' | 'migrate-backup-started' | 'migrate-backup-done' | 'migrate-clean-started' | 'migrate-clean-done' | 'archiving-backup-started' | 'archiving-backup-done' | 'archiving-clean-started' | 'archiving-clean-done' | 'archiving-done' | 'delete-started' | 'delete-done';
-export interface WorkspaceInfo {
-    uuid: WorkspaceUuid;
-    dataId?: WorkspaceDataId;
-    name: string;
-    url: string;
-    region?: string;
-    branding?: string;
-    createdOn: number;
-    createdBy?: PersonUuid;
-    billingAccount?: PersonUuid;
-    allowReadOnlyGuest?: boolean;
-    allowGuestSignUp?: boolean;
-    passwordAgingRule?: number;
-}
-export interface BackupStatus {
-    dataSize: number;
-    blobsSize: number;
-    backupSize: number;
-    lastBackup: Timestamp;
-    backups: number;
-}
-export interface UsageStatus {
-    usage: Record<string, number>;
-    startTime: Timestamp;
-    updateTime: Timestamp;
-}
-export interface WorkspaceInfoWithStatus extends WorkspaceInfo {
-    isDisabled?: boolean;
-    versionMajor: number;
-    versionMinor: number;
-    versionPatch: number;
-    lastVisit?: number;
-    mode: WorkspaceMode;
-    processingProgress?: number;
-    backupInfo?: BackupStatus;
-    usageInfo?: UsageStatus;
-    processingAttemps: number;
-}
-export interface WorkspaceMemberInfo {
-    person: AccountUuid;
-    role: AccountRole;
-}
-export declare enum SocialIdType {
-    EMAIL = "email",
-    GITHUB = "github",
-    GOOGLE = "google",
-    PHONE = "phone",
-    OIDC = "oidc",
-    HULY = "huly",
-    TELEGRAM = "telegram",
-    HULY_ASSISTANT = "huly-assistant"
-}
-export interface SocialId {
-    _id: PersonId;
-    type: SocialIdType;
-    value: string;
-    key: string;
-    displayValue?: string;
-    verifiedOn?: number;
-    isDeleted?: boolean;
-}
-export interface AccountInfo {
-    timezone?: string;
-    locale?: string;
-}
-export type SocialKey = Pick<SocialId, 'type' | 'value'>;
-export interface ClassCollaborators<T extends Doc> extends Doc {
-    attachedTo: Ref<Class<T>>;
-    fields: (keyof T)[];
-    provideSecurity?: boolean;
-}
-export interface Collaborator extends AttachedDoc {
-    collaborator: AccountUuid;
-}
-/**
- * @public
- */
-export type IntegrationKind = string & {
-    __IntegrationKind: true;
-};
-//# sourceMappingURL=classes.d.ts.map