@xpert-ai/contracts 3.9.0-beta.1

package/src/user-me-context.model.d.ts

@@ -0,0 +1,9 @@
+import { IFeatureOrganization } from './feature.model';
+export interface IUserMeOrganizationFeatures {
+    organizationId: string;
+    featureOrganizations: IFeatureOrganization[];
+}
+export interface IUserMeFeatures {
+    tenantFeatureOrganizations: IFeatureOrganization[];
+    organizationFeatures: IUserMeOrganizationFeatures[];
+}

package/src/user-organization.model.d.ts

@@ -0,0 +1,28 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { LanguagesEnum, IUser } from './user.model';
+export interface IUserOrganizationPreferences {
+    defaultWorkspaceId?: string | null;
+}
+export interface IUserOrganization extends IBasePerTenantAndOrganizationEntityModel {
+    userId: string;
+    isDefault: boolean;
+    isActive: boolean;
+    preferences?: IUserOrganizationPreferences | null;
+    user?: IUser;
+}
+export interface IUserOrganizationFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+    userId?: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IUserOrganizationCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    userId: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IUserOrganizationDeleteInput {
+    userOrganizationId: string;
+    requestingUser: IUser;
+    language?: LanguagesEnum;
+}

package/src/user.model.d.ts

@@ -0,0 +1,131 @@
+import { IRole } from './role.model';
+import { IBasePerTenantEntityModel } from './base-entity.model';
+import { ITag } from './tag-entity.model';
+import { IEmployee } from './employee.model';
+import { IUserOrganization } from './user-organization.model';
+export declare enum UserType {
+    USER = "user",// Regular user
+    COMMUNICATION = "communication"
+}
+export interface IUser extends IBasePerTenantEntityModel {
+    thirdPartyId?: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    mobile?: string;
+    username?: string;
+    timeZone?: string;
+    type?: UserType;
+    role?: IRole;
+    roleId?: string;
+    hash?: string;
+    imageUrl?: string;
+    employee?: IEmployee;
+    employeeId?: string;
+    tags?: ITag[];
+    preferredLanguage?: string;
+    paymentsId?: string;
+    fullName?: string;
+    organizations?: IUserOrganization[];
+    isImporting?: boolean;
+    sourceId?: string;
+    emailVerified?: boolean;
+    emailVerification?: IEmailVerification;
+    deletedAt?: Date;
+}
+export interface IEmailVerification extends IBasePerTenantEntityModel {
+    token: string;
+    userId: string;
+    user?: IUser;
+    validUntil: Date;
+}
+export interface IUserEmailInput {
+    email: string;
+}
+export interface IUserFindInput {
+    thirdPartyId?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    username?: string;
+    role?: IRole;
+    roleId?: string;
+    hash?: string;
+    imageUrl?: string;
+    tags?: ITag[];
+    preferredLanguage?: LanguagesEnum;
+}
+export interface IUserRegistrationInput {
+    user: IUser;
+    password?: string;
+    confirmPassword?: string;
+    originalUrl?: string;
+    organizationId?: string;
+    createdById?: string;
+    isImporting?: boolean;
+    sourceId?: string;
+    timeZone?: string;
+}
+export interface IUserLoginInput {
+    email: string;
+    password: string;
+}
+export interface IAuthResponse {
+    user: IUser;
+    token: string;
+    refreshToken: string;
+}
+export interface IUserCreateInput {
+    type?: UserType;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    username?: string;
+    role?: IRole;
+    roleId?: string;
+    hash?: string;
+    imageUrl?: string;
+    tags?: ITag[];
+    preferredLanguage?: LanguagesEnum;
+    timeZone?: string;
+    thirdPartyId?: string;
+    roleName?: string;
+}
+export interface IUserUpdateInput extends Omit<IUserCreateInput, 'type'> {
+    password?: string;
+    confirmPassword?: string;
+}
+export interface IUserPasswordInput {
+    hash?: string;
+    password?: string;
+    confirmPassword?: string;
+}
+/**
+ * Browser http header `Language`
+ */
+export declare enum LanguagesEnum {
+    Chinese = "zh-CN",
+    SimplifiedChinese = "zh-Hans",
+    TraditionalChinese = "zh-Hant",
+    English = "en"
+}
+export declare const LanguagesMap: {
+    'zh-CN': LanguagesEnum;
+    'zh-Hans': LanguagesEnum;
+    zh: LanguagesEnum;
+};
+export declare enum ProviderEnum {
+    GOOGLE = "google",
+    FACEBOOK = "facebook"
+}
+export interface IUserViewModel extends IBasePerTenantEntityModel {
+    fullName: string;
+    email: string;
+    bonus?: number;
+    endWork?: any;
+    id: string;
+    roleName?: string;
+    role?: string;
+    tags?: ITag[];
+}

package/src/view-extension/index.d.ts

@@ -0,0 +1 @@
+export * from './model';

package/src/view-extension/model.d.ts

@@ -0,0 +1,183 @@
+import type { I18nObject } from '../types';
+export type XpertViewHostType = 'integration' | 'knowledgebase' | 'agent' | 'project' | 'sandbox' | string;
+export type XpertViewSlotMode = 'tabs' | 'sections' | 'widgets' | 'sidebar';
+export type XpertViewSchemaType = 'stats' | 'table' | 'list' | 'detail' | 'raw_json';
+export type XpertViewValueType = 'text' | 'number' | 'status' | 'datetime' | 'json';
+export type XpertViewColumnDataType = 'text' | 'number' | 'date' | 'datetime' | 'status' | 'tag' | 'avatar' | 'link';
+export type XpertViewActionPlacement = 'toolbar' | 'row';
+export type XpertViewActionType = 'invoke' | 'navigate' | 'open_detail' | 'refresh';
+export type XpertViewSortDirection = 'asc' | 'desc';
+export type XpertViewFilterOperator = 'eq' | 'neq' | 'contains' | 'starts_with' | 'ends_with' | 'in' | 'gt' | 'gte' | 'lt' | 'lte';
+export type XpertViewScalar = string | number | boolean | null;
+export interface XpertViewHostContext {
+    tenantId: string;
+    organizationId?: string | null;
+    workspaceId?: string | null;
+    userId: string;
+    hostType: XpertViewHostType;
+    hostId: string;
+    module?: string;
+    route?: string;
+    permissions?: string[];
+    locale?: string;
+}
+export interface XpertResolvedViewHostContext extends XpertViewHostContext {
+    slots: XpertViewSlot[];
+    hostSnapshot?: unknown;
+}
+export interface XpertViewSlot {
+    key: string;
+    title?: I18nObject;
+    mode: XpertViewSlotMode;
+    order?: number;
+}
+export interface XpertViewSource {
+    provider: string;
+    plugin?: string;
+    version?: string;
+}
+export interface XpertViewBadge {
+    type: 'count' | 'status' | 'text';
+    value?: string | number;
+}
+export interface XpertViewPolling {
+    enabled: boolean;
+    intervalMs?: number;
+}
+export interface XpertViewCachePolicy {
+    enabled?: boolean;
+    ttlMs?: number;
+}
+export interface XpertViewQuerySchema {
+    supportsPagination?: boolean;
+    supportsSearch?: boolean;
+    supportsSort?: boolean;
+    supportsFilter?: boolean;
+    supportsCursor?: boolean;
+    supportsSelection?: boolean;
+    defaultPageSize?: number;
+}
+export interface XpertViewDataSource {
+    mode: 'platform';
+    querySchema?: XpertViewQuerySchema;
+    cache?: XpertViewCachePolicy;
+    polling?: XpertViewPolling;
+}
+export interface XpertViewFilter {
+    key: string;
+    operator?: XpertViewFilterOperator;
+    value: XpertViewScalar | XpertViewScalar[];
+}
+export interface XpertViewQuery {
+    page?: number;
+    pageSize?: number;
+    cursor?: string;
+    search?: string;
+    sortBy?: string;
+    sortDirection?: XpertViewSortDirection;
+    filters?: XpertViewFilter[];
+    selectionId?: string;
+}
+export interface XpertStatsViewSchema {
+    type: 'stats';
+    items: Array<{
+        key: string;
+        label: I18nObject;
+        valueType?: XpertViewValueType;
+    }>;
+}
+export interface XpertTableViewSchema {
+    type: 'table';
+    columns: Array<{
+        key: string;
+        label: I18nObject;
+        dataType?: XpertViewColumnDataType;
+        width?: string;
+        sortable?: boolean;
+        searchable?: boolean;
+    }>;
+    pagination?: {
+        enabled: boolean;
+        pageSize?: number;
+    };
+    search?: {
+        enabled: boolean;
+        placeholder?: I18nObject;
+    };
+}
+export interface XpertListViewSchema {
+    type: 'list';
+    item: {
+        titleKey: string;
+        subtitleKey?: string;
+        descriptionKey?: string;
+        metaKeys?: string[];
+    };
+    pagination?: {
+        enabled: boolean;
+        pageSize?: number;
+    };
+    search?: {
+        enabled: boolean;
+        placeholder?: I18nObject;
+    };
+}
+export interface XpertDetailViewSchema {
+    type: 'detail';
+    fields: Array<{
+        key: string;
+        label: I18nObject;
+        dataType?: XpertViewValueType;
+    }>;
+}
+export interface XpertRawJsonViewSchema {
+    type: 'raw_json';
+}
+export type XpertViewSchema = XpertStatsViewSchema | XpertTableViewSchema | XpertListViewSchema | XpertDetailViewSchema | XpertRawJsonViewSchema;
+export interface XpertViewActionDefinition {
+    key: string;
+    label: I18nObject;
+    icon?: string;
+    placement?: XpertViewActionPlacement;
+    actionType: XpertViewActionType;
+    confirm?: {
+        title?: I18nObject;
+        message?: I18nObject;
+    };
+    permissions?: string[];
+}
+export interface XpertExtensionViewManifest {
+    key: string;
+    title: I18nObject;
+    description?: I18nObject;
+    icon?: string;
+    hostType: XpertViewHostType;
+    slot: string;
+    order?: number;
+    visible?: boolean;
+    source: XpertViewSource;
+    permissions?: string[];
+    badge?: XpertViewBadge;
+    refreshable?: boolean;
+    polling?: XpertViewPolling;
+    view: XpertViewSchema;
+    dataSource: XpertViewDataSource;
+    actions?: XpertViewActionDefinition[];
+}
+export interface XpertViewActionRequest {
+    targetId?: string;
+}
+export interface XpertViewDataResult<TItem = unknown, TSummary = unknown> {
+    items?: TItem[];
+    item?: TItem;
+    total?: number;
+    nextCursor?: string;
+    summary?: TSummary;
+    meta?: unknown;
+}
+export interface XpertViewActionResult<TData = unknown> {
+    success: boolean;
+    message?: I18nObject;
+    data?: TData;
+    refresh?: boolean;
+}

package/src/visibility.model.d.ts

@@ -0,0 +1,6 @@
+export declare enum Visibility {
+    Public = "public",
+    Internal = "internal",
+    Secret = "secret",
+    Private = "private"
+}