@metad/contracts 3.6.1 → 3.6.2

package/src/role-permission.model.d.ts

@@ -0,0 +1,61 @@
+import { AnalyticsPermissionsEnum } from './analytics/index';
+import { AIPermissionsEnum } from './ai/index';
+import { IBasePerTenantEntityModel } from './base-entity.model';
+import { IRole } from './role.model';
+export interface IRolePermission extends IBasePerTenantEntityModel {
+    roleId: string;
+    permission: string;
+    role: IRole;
+    enabled: boolean;
+}
+export interface IRolePermissionMigrateInput extends IBasePerTenantEntityModel {
+    permission: string;
+    role: string;
+    isImporting: boolean;
+    sourceId: string;
+}
+export interface IRolePermissionCreateInput extends IBasePerTenantEntityModel {
+    roleId: string;
+    permission: string;
+    enabled: boolean;
+}
+export interface IRolePermissionUpdateInput {
+    enabled: boolean;
+}
+export declare enum PermissionsEnum {
+    PROFILE_EDIT = "PROFILE_EDIT",
+    ADMIN_DASHBOARD_VIEW = "ADMIN_DASHBOARD_VIEW",
+    ORG_EMPLOYEES_VIEW = "ORG_EMPLOYEES_VIEW",
+    ORG_EMPLOYEES_EDIT = "ORG_EMPLOYEES_EDIT",
+    ORG_TAGS_EDIT = "ORG_TAGS_EDIT",
+    ORG_USERS_VIEW = "ORG_USERS_VIEW",
+    ORG_USERS_EDIT = "ORG_USERS_EDIT",
+    ORG_INVITE_VIEW = "ORG_INVITE_VIEW",
+    ORG_INVITE_EDIT = "ORG_INVITE_EDIT",
+    ALL_ORG_VIEW = "ALL_ORG_VIEW",
+    ALL_ORG_EDIT = "ALL_ORG_EDIT",
+    APPROVAL_POLICY_VIEW = "APPROVALS_POLICY_VIEW",
+    APPROVAL_POLICY_EDIT = "APPROVALS_POLICY_EDIT",
+    CHANGE_SELECTED_ORGANIZATION = "CHANGE_SELECTED_ORGANIZATION",
+    CHANGE_ROLES_PERMISSIONS = "CHANGE_ROLES_PERMISSIONS",
+    SUPER_ADMIN_EDIT = "SUPER_ADMIN_EDIT",
+    PUBLIC_PAGE_EDIT = "PUBLIC_PAGE_EDIT",
+    VIEW_ALL_EMAILS = "VIEW_ALL_EMAILS",
+    VIEW_ALL_EMAIL_TEMPLATES = "VIEW_ALL_EMAIL_TEMPLATES",
+    ORG_HELP_CENTER_EDIT = "ORG_HELP_CENTER_EDIT",
+    ORG_CONTACT_EDIT = "ORG_CONTACT_EDIT",
+    ORG_CONTACT_VIEW = "ORG_CONTACT_VIEW",
+    ORG_DEMO_EDIT = "ORG_DEMO_EDIT",// Orgnization demo edit permission
+    INTEGRATION_EDIT = "INTEGRATION_EDIT",
+    INTEGRATION_VIEW = "INTEGRATION_VIEW",
+    FILE_STORAGE_VIEW = "FILE_STORAGE_VIEW",
+    SMS_GATEWAY_VIEW = "SMS_GATEWAY_VIEW",
+    CUSTOM_SMTP_VIEW = "CUSTOM_SMTP_VIEW",
+    VIEW_ALL_ACCOUNTING_TEMPLATES = "VIEW_ALL_ACCOUNTING_TEMPLATES",
+    ACCESS_DELETE_ACCOUNT = "ACCESS_DELETE_ACCOUNT",
+    ACCESS_DELETE_ALL_DATA = "ACCESS_DELETE_ALL_DATA"
+}
+export declare const PermissionGroups: {
+    GENERAL: (PermissionsEnum | AIPermissionsEnum | AnalyticsPermissionsEnum)[];
+    ADMINISTRATION: PermissionsEnum[];
+};

package/src/role.model.d.ts

@@ -0,0 +1,26 @@
+import { IUser } from './user.model';
+import { IBasePerTenantEntityModel } from './base-entity.model';
+import { IRolePermission } from './role-permission.model';
+export interface IRole extends IRoleCreateInput {
+    isSystem?: boolean;
+    rolePermissions?: IRolePermission[];
+    users?: IUser[];
+}
+export interface IRoleCreateInput extends IBasePerTenantEntityModel {
+    name: string;
+}
+export declare enum RolesEnum {
+    SUPER_ADMIN = "SUPER_ADMIN",
+    ADMIN = "ADMIN",
+    DATA_ENTRY = "DATA_ENTRY",
+    EMPLOYEE = "EMPLOYEE",
+    CANDIDATE = "CANDIDATE",
+    MANAGER = "MANAGER",
+    VIEWER = "VIEWER",
+    TRIAL = "TRIAL"
+}
+export interface IRoleMigrateInput extends IBasePerTenantEntityModel {
+    name: string;
+    isImporting: boolean;
+    sourceId: string;
+}

package/src/schedule.d.ts

@@ -0,0 +1,27 @@
+export declare enum ScheduleTaskStatus {
+    PAUSED = "paused",
+    ARCHIVED = "archived",
+    SCHEDULED = "scheduled"
+}
+export declare enum TaskFrequency {
+    Once = "Once",
+    Daily = "Daily",
+    Weekly = "Weekly",
+    Monthly = "Monthly",
+    Yearly = "Yearly"
+}
+export type TScheduleOptions = {
+    frequency: TaskFrequency;
+    time: string;
+    dayOfWeek?: number;
+    dayOfMonth?: number;
+    month?: number;
+    date?: string;
+};
+/**
+ * Generate cron expression: Minutes Hour Day Month Week
+ *
+ * @param schedule
+ * @returns
+ */
+export declare function generateCronExpression(schedule: TScheduleOptions): string;

package/src/secret-token.model.d.ts

@@ -0,0 +1,11 @@
+import { IBaseEntityModel } from './base-entity.model';
+export interface ISecretToken extends IBaseEntityModel {
+    entityId?: string;
+    token: string;
+    validUntil?: Date;
+    expired?: boolean;
+}
+export interface ISecretTokenFindInput extends IBaseEntityModel {
+    entityId?: string;
+    token?: string;
+}

package/src/seed.model.d.ts

@@ -0,0 +1,37 @@
+import { CurrenciesEnum } from './currency.model';
+import { DefaultValueDateTypeEnum } from './organization.model';
+import { IUser, LanguagesEnum } from './user.model';
+export interface IDefaultUser {
+    email: string;
+    password: string;
+    imageUrl: string;
+    firstName?: string;
+    lastName?: string;
+    preferredLanguage: LanguagesEnum;
+}
+export interface IDefaultEmployee extends IDefaultUser {
+    startedWorkOn?: string;
+    endWork?: string;
+    employeeLevel?: string;
+}
+export interface IDefaultOrganization {
+    name: string;
+    currency: CurrenciesEnum;
+    defaultValueDateType: DefaultValueDateTypeEnum;
+    imageUrl: string;
+}
+export interface ISeedUsers {
+    adminUsers: IUser[];
+    employeeUsers: IUser[];
+    candidateUsers: IUser[];
+}
+export interface IDefaultProductCategory {
+    name: string;
+    description: string;
+    imageUrl: string;
+}
+export interface IDefaultProductType {
+    name: string;
+    description: string;
+    icon: string;
+}

package/src/storage-file.model.d.ts

@@ -0,0 +1,40 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { FileStorageProviderEnum } from './file-provider';
+import { _TFile } from './types';
+export type TFile = _TFile & {
+    fileType?: string;
+    contents?: string;
+    description?: string;
+    size?: number;
+    createdAt?: Date;
+    storageFileId?: string;
+};
+export interface IStorageFile extends IBasePerTenantAndOrganizationEntityModel {
+    file: string;
+    url?: string;
+    thumb?: string;
+    fileUrl?: string;
+    thumbUrl?: string;
+    originalName?: string;
+    encoding?: string;
+    size?: number;
+    mimetype?: string;
+    recordedAt?: Date;
+    storageProvider?: FileStorageProviderEnum;
+}
+export interface ICreateStorageFileInput extends IBasePerTenantAndOrganizationEntityModel {
+    activityTimestamp: string;
+    employeeId?: string;
+    file: string;
+    thumb?: string;
+    recordedAt: Date | string;
+}
+export interface IUpdateStorageFileInput extends ICreateStorageFileInput {
+    id: string;
+}
+export type TFileDirectory = TFile & {
+    fullPath?: string;
+    directory?: string;
+    hasChildren?: boolean;
+    children?: TFileDirectory[];
+};

package/src/tag-entity.model.d.ts

@@ -0,0 +1,20 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { I18nObject } from './types';
+export interface ITag extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    label?: I18nObject;
+    description?: string;
+    category?: TagCategoryEnum;
+    color?: string;
+    isSelected?: boolean;
+    icon?: string;
+}
+export interface ITagName {
+    name?: string;
+}
+export declare enum TagCategoryEnum {
+    INDICATOR = "indicator",
+    STORY = "story",
+    TOOLSET = "toolset",
+    XPERT = "xpert"
+}

package/src/tenant.model.d.ts

@@ -0,0 +1,40 @@
+import { IImportRecord } from './import-export.model';
+import { IFeatureOrganization } from './feature.model';
+import { FileStorageProviderEnum, S3FileStorageProviderConfig } from './file-provider';
+import { IOrganization, IOrganizationCreateInput } from './organization.model';
+import { IRolePermission } from './role-permission.model';
+import { IUserCreateInput } from './user.model';
+export interface ITenant {
+    id?: string;
+    name?: string;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    organizations?: IOrganization[];
+    rolePermissions?: IRolePermission[];
+    featureOrganizations?: IFeatureOrganization[];
+    importRecords?: IImportRecord[];
+    settings?: ISetting[];
+}
+export interface ITenantCreateInput {
+    name: string;
+    isImporting?: boolean;
+    sourceId?: string;
+    userSourceId?: string;
+    superAdmin?: IUserCreateInput;
+    defaultOrganization?: IOrganizationCreateInput;
+}
+export interface ISetting {
+    name: string;
+    value: string;
+}
+export interface ITenantSetting extends S3FileStorageProviderConfig {
+    fileStorageProvider?: FileStorageProviderEnum;
+    tenant_title?: string;
+    tenant_title_en?: string;
+    tenant_enable_feishu?: boolean;
+    tenant_enable_dingtalk?: boolean;
+    tenant_enable_wechat?: boolean;
+    tenant_enable_github?: boolean;
+    tenant_enable_google?: boolean;
+}
+export declare const DEFAULT_TENANT = "Default Tenant";

package/src/tools/index.d.ts

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

package/src/tools/sandbox.d.ts

@@ -0,0 +1,5 @@
+export declare enum InterruptMessageType {
+    SlidesTemplate = "slides_template",
+    SwitchGitHubRepository = "switch_github_repository",
+    Select = "select"
+}

package/src/translation.model.d.ts

@@ -0,0 +1,26 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { LanguagesEnum } from './user.model';
+export interface ITranslation<T> extends IBasePerTenantAndOrganizationEntityModel {
+    reference?: ITranslatable<T>;
+    referenceId?: string;
+    languageCode: string;
+}
+export interface ITranslatable<T> extends IBasePerTenantAndOrganizationEntityModel {
+    translations?: ITranslation<T>[];
+    translate?(languageCode: string): any;
+    translateNested?(languageCode: string, translatePropsInput: Array<any>): any;
+}
+export interface TranslateInput {
+    key: string;
+    alias: string;
+}
+export interface TranslatePropertyInput {
+    prop: string;
+    propsTranslate: Array<TranslateInput>;
+    propAsArr?: Array<string>;
+}
+export declare const TranslationLanguageMap: {
+    'zh-CN': string;
+    'zh-Hans': string;
+};
+export declare function mapTranslationLanguage(languageCode: LanguagesEnum): any;

package/src/types.d.ts

@@ -0,0 +1,241 @@
+import ShortUniqueId from 'short-unique-id';
+export declare const uuid: ShortUniqueId;
+/**
+ * @description
+ * An entity ID. Represents a unique identifier as a string.
+ *
+ * @docsCategory Type Definitions
+ * @docsSubcategory Identifiers
+ */
+export type ID = string;
+export interface I18nObject {
+    en_US: string;
+    zh_Hans?: string;
+}
+export type TAvatar = {
+    emoji?: {
+        id: string;
+        set?: '' | 'apple' | 'google' | 'twitter' | 'facebook';
+        colons?: string;
+        unified?: string;
+    };
+    /**
+     * Use Noto Color Emoji:
+     * https://fonts.google.com/noto/specimen/Noto+Color+Emoji/
+     */
+    useNotoColor?: boolean;
+    background?: string;
+    url?: string;
+};
+export type TDeleteResult = {
+    /**
+     * Raw SQL result returned by executed query.
+     */
+    raw: any;
+    /**
+     * Number of affected rows/documents
+     * Not all drivers support this
+     */
+    affected?: number | null;
+};
+export type TranslateOptions = {
+    lang?: string;
+    args?: ({
+        [k: string]: any;
+    } | string)[] | {
+        [k: string]: any;
+    };
+    debug?: boolean;
+};
+/**
+ * Select option type
+ */
+export type TSelectOption<T = string | number | boolean, K = string> = {
+    key?: K;
+    value: T;
+    label?: I18nObject | string;
+    description?: I18nObject | string;
+    icon?: string;
+};
+export declare enum ParameterTypeEnum {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    ARRAY = "array",
+    SELECT = "select",
+    SECRET_INPUT = "secret-input",
+    FILE = "file"
+}
+export type TParameterOption = {
+    value: string;
+    label: I18nObject;
+};
+export type TParameterHelpInfo = {
+    title: I18nObject;
+    url: I18nObject;
+};
+export type TParameter = {
+    name: string;
+    label: I18nObject;
+    placeholder?: I18nObject;
+    description?: I18nObject;
+    type: ParameterTypeEnum;
+    required?: boolean;
+    default?: number | string;
+    min?: number;
+    max?: number;
+    options?: TParameterOption[];
+    items?: {
+        type: ParameterTypeEnum;
+    };
+    when?: Record<string, unknown[]>;
+    /**
+     * Is visible for parameters
+     */
+    visible?: boolean;
+    help?: TParameterHelpInfo;
+};
+export type TParameterSchema = {
+    type: 'object' | 'array';
+    required?: string[];
+    secret?: string[];
+    /**
+     * @deprecated use parameters
+     */
+    properties?: any;
+    parameters?: TParameter[];
+};
+export interface IPoint {
+    x: number;
+    y: number;
+}
+export interface ISize {
+    width: number;
+    height: number;
+}
+export type _TFile = {
+    filePath: string;
+    fileUrl?: string;
+    mimeType?: string;
+    /**
+     * @deprecated use fileUrl instead
+     */
+    url?: string;
+};
+/**
+ * A recursive implementation of the Partial<T> type.
+ * Source: https://stackoverflow.com/a/49936686/772859
+ */
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends Readonly<infer U>[] ? Readonly<DeepPartial<U>>[] : DeepPartial<T[P]>;
+};
+export interface ChecklistItem {
+    node?: string;
+    field?: string;
+    value?: string;
+    message: I18nObject;
+    level: 'error' | 'warning';
+    ruleCode?: string;
+}
+export interface RuleValidator {
+    validate(input: any, params?: any): Promise<ChecklistItem[]>;
+}
+export declare function letterStartSUID(start: string): string;
+/**
+ * The type of icon to render.
+ * Determines how the `value` field should be interpreted.
+ */
+export type IconType = 'image' | 'svg' | 'font' | 'emoji' | 'lottie';
+/**
+ * Defines a unified structure for representing different kinds of icons
+ * in the frontend (image, SVG, font icon, emoji, Lottie animation, etc.).
+ *
+ * ---
+ * 🧩 Supported icon types:
+ *
+ * | Type     | Description                      | Example `value` |
+ * |-----------|----------------------------------|-----------------|
+ * | `image`  | Raster or Base64-encoded image    | `"https://cdn.example.com/logo.png"` or `"data:image/png;base64,..."` |
+ * | `svg`    | Inline SVG markup                 | `"<svg xmlns='http://www.w3.org/2000/svg'><path d='M12 2l4 20H8z'/></svg>"` |
+ * | `font`   | Font icon class name              | `"fa-solid fa-user"` or `"material-icons:home"` |
+ * | `emoji`  | Unicode emoji character           | `"🚀"` |
+ * | `lottie` | Lottie animation JSON URL         | `"https://assets.lottiefiles.com/packages/lf20_abc123.json"` |
+ *
+ * ---
+ * 🧠 Example usages:
+ *
+ * ```json
+ * {
+ *   "icon": {
+ *     "type": "image",
+ *     "value": "https://cdn.example.com/logo.png",
+ *     "alt": "Company logo"
+ *   }
+ * }
+ *
+ * {
+ *   "icon": {
+ *     "type": "svg",
+ *     "value": "<svg xmlns='http://www.w3.org/2000/svg'><path d='M12 2l4 20H8z'/></svg>"
+ *   }
+ * }
+ *
+ * {
+ *   "icon": {
+ *     "type": "font",
+ *     "value": "fa-solid fa-user",
+ *     "color": "#666",
+ *     "size": 20
+ *   }
+ * }
+ *
+ * {
+ *   "icon": {
+ *     "type": "emoji",
+ *     "value": "🚀",
+ *     "size": 32
+ *   }
+ * }
+ *
+ * {
+ *   "icon": {
+ *     "type": "lottie",
+ *     "value": "https://assets.lottiefiles.com/packages/lf20_abc123.json"
+ *   }
+ * }
+ * ```
+ * ---
+ */
+export interface IconDefinition {
+    /**
+     * The type of icon to render.
+     * Determines how the `value` field should be interpreted.
+     */
+    type: IconType;
+    /**
+     * The icon content or resource reference.
+     * Can be a URL, Base64 data, SVG markup, emoji, or animation file.
+     */
+    value: string;
+    /**
+     * Optional color for the icon.
+     * Typically used for font, SVG, or emoji icons.
+     */
+    color?: string;
+    /**
+     * Optional size of the icon, in pixels.
+     * Defines the intended rendered size (e.g. 24 → 24px).
+     */
+    size?: number;
+    /**
+     * Alternative text for accessibility.
+     * Useful for image or SVG icons.
+     */
+    alt?: string;
+    /**
+     * Optional inline style definitions.
+     * Can include any CSS-compatible properties
+     * (e.g. `{ "borderRadius": "50%", "backgroundColor": "#f0f0f0" }`).
+     */
+    style?: Record<string, string>;
+}

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

@@ -0,0 +1,24 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { LanguagesEnum, IUser } from './user.model';
+export interface IUserOrganization extends IBasePerTenantAndOrganizationEntityModel {
+    userId: string;
+    isDefault: boolean;
+    isActive: boolean;
+    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;
+}