@metad/contracts 3.6.7 → 3.7.0

package/src/employee.model.d.ts

@@ -0,0 +1,128 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IContact } from './contact.model';
+import { CrudActionEnum, IOrganizationFindInput } from './organization.model';
+import { IOrganizationTeam } from './organization-team-model';
+import { ITag } from './tag-entity.model';
+import { IUser, IUserFindInput } from './user.model';
+export interface IEmployee extends IBasePerTenantAndOrganizationEntityModel {
+    [x: string]: any;
+    endWork?: any;
+    startedWorkOn?: any;
+    user: IUser;
+    userId: string;
+    valueDate?: Date;
+    isActive: boolean;
+    short_description?: string;
+    description?: string;
+    teams?: IOrganizationTeam[];
+    payPeriod?: string;
+    billRateValue?: number;
+    billRateCurrency?: string;
+    reWeeklyLimit?: number;
+    tags: ITag[];
+    offerDate?: Date;
+    acceptDate?: Date;
+    rejectDate?: Date;
+    employeeLevel?: string;
+    anonymousBonus?: boolean;
+}
+export interface UpdateEmployeeJobsStatistics {
+    isJobSearchActive?: boolean;
+}
+export interface IEmployeeFindInput {
+    id?: string;
+    organization?: IOrganizationFindInput;
+    user?: IUserFindInput;
+    valueDate?: Date;
+    organizationId?: string;
+    tenantId?: string;
+    tags?: ITag[];
+}
+export interface IEmployeeUpdateInput extends IBasePerTenantAndOrganizationEntityModel {
+    payPeriod?: string;
+    billRateValue?: number;
+    billRateCurrency?: string;
+    reWeeklyLimit?: number;
+    offerDate?: Date;
+    acceptDate?: Date;
+    rejectDate?: Date;
+    short_description?: string;
+    description?: string;
+    averageIncome?: number;
+    averageExpenses?: number;
+    averageBonus?: number;
+    isJobSearchActive?: boolean;
+    contact?: IContact;
+    linkedInUrl?: string;
+    facebookUrl?: string;
+    instagramUrl?: string;
+    twitterUrl?: string;
+    githubUrl?: string;
+    gitlabUrl?: string;
+    upworkUrl?: string;
+}
+export interface IEmployeeCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    user: IUser;
+    password?: string;
+    offerDate?: Date;
+    acceptDate?: Date;
+    rejectDate?: Date;
+    members?: IEmployee[];
+    tags?: ITag[];
+    startedWorkOn?: any;
+    short_description?: string;
+    description?: string;
+    originalUrl?: string;
+    isActive?: boolean;
+}
+export interface ISelectedEmployee {
+    id: string;
+    firstName: string;
+    lastName: string;
+    fullName?: string;
+    imageUrl: string;
+    defaultType?: DEFAULT_TYPE;
+    tags?: ITag[];
+}
+export declare enum DEFAULT_TYPE {
+    ALL_EMPLOYEE = "ALL_EMPLOYEE",
+    NO_EMPLOYEE = "NO_EMPLOYEE"
+}
+export declare enum PayPeriodEnum {
+    NONE = "NONE",
+    BI_WEEKLY = "BI_WEEKLY",
+    WEEKLY = "WEEKLY",
+    TWICE_PER_MONTH = "TWICE_PER_MONTH",
+    MONTHLY = "MONTHLY"
+}
+export interface IEmployeeLevel extends IBasePerTenantAndOrganizationEntityModel {
+    level: string;
+    tag?: ITag[];
+}
+export interface IEmployeeLevelInput extends IBasePerTenantAndOrganizationEntityModel {
+    level: string;
+    tags?: ITag[];
+}
+export interface IEmployeeLevelFindInput {
+    organizationId?: string;
+    tenantId: string;
+}
+export interface EmployeeViewModel {
+    fullName: string;
+    email: string;
+    bonus?: number;
+    endWork?: any;
+    id: string;
+    imageUrl?: string;
+    averageIncome?: number;
+    averageExpenses?: number;
+    averageBonus?: number;
+    workStatus?: string;
+    startedWorkOn?: string;
+    isActive?: boolean;
+    tags?: ITag[];
+}
+export interface IEmployeeStoreState {
+    employee: IEmployee | IEmployee[];
+    action: CrudActionEnum;
+}

package/src/entity-with-members.model.d.ts

@@ -0,0 +1,13 @@
+import { IEmployee } from './employee.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { ITag } from './tag-entity.model';
+export interface IBaseEntityWithMembers extends IBasePerTenantAndOrganizationEntityModel {
+    members?: IEmployee[];
+    name?: string;
+    tags?: ITag[];
+}
+export interface IEditEntityByMemberInput {
+    addedEntityIds?: string[];
+    removedEntityIds?: string[];
+    member: IEmployee;
+}

package/src/feature.model.d.ts

@@ -0,0 +1,93 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export interface IFeature extends IBasePerTenantAndOrganizationEntityModel {
+    code: string;
+    description: string;
+    featureOrganizations?: IFeatureOrganization[];
+    image?: string;
+    readonly imageUrl?: string;
+    link: string;
+    name: string;
+    status: string;
+    icon: string;
+    isEnabled?: boolean;
+    isPaid?: boolean;
+    readonly parentId?: string;
+    parent?: IFeature;
+    children?: IFeature[];
+}
+export interface IFeatureCreateInput extends IFeature {
+    isEnabled: boolean;
+}
+export interface IFeatureOrganization extends IBasePerTenantAndOrganizationEntityModel {
+    feature: IFeature;
+    featureId?: string;
+    isEnabled: boolean;
+}
+export interface IFeatureOrganizationUpdateInput extends IBasePerTenantAndOrganizationEntityModel {
+    featureId: string;
+    isEnabled: boolean;
+}
+export interface IFeatureOrganizationFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    featureId?: string;
+}
+export declare enum FeatureStatusEnum {
+    INFO = "info",
+    PRIMARY = "primary",
+    SUCCESS = "success",
+    WARNING = "warning"
+}
+export declare enum IFeatureToggleTypeEnum {
+    RELEASE = "release",
+    KILL_SWITCH = "kill-switch",
+    EXPERIMENT = "experiment",
+    OPERATIONAL = "operational",
+    PERMISSION = "permission"
+}
+export interface IFeatureToggleVariant {
+    name?: string;
+    weight?: number;
+    weightType?: string;
+    payload?: IFeatureTogglePayload;
+    overrides?: IFeatureToggleOverride[];
+}
+export interface IFeatureToggleOverride {
+    contextName?: string;
+    values?: string[];
+}
+export interface IFeatureTogglePayload {
+    type?: string;
+    value?: string;
+}
+export interface IFeatureToggle {
+    name: string;
+    description?: string;
+    type: IFeatureToggleTypeEnum;
+    project?: string;
+    enabled: boolean;
+    stale?: boolean;
+    strategies?: any;
+    variants?: IFeatureToggleVariant[];
+    createdAt?: string;
+    lastSeenAt?: string | null;
+}
+export declare enum FeatureEnum {
+    FEATURE_HOME = "FEATURE_HOME",
+    FEATURE_DASHBOARD = "FEATURE_DASHBOARD",
+    FEATURE_JOB = "FEATURE_JOB",
+    FEATURE_EMPLOYEES = "FEATURE_EMPLOYEES",
+    FEATURE_MANAGE_INVITE = "FEATURE_MANAGE_INVITE",
+    FEATURE_ORGANIZATION = "FEATURE_ORGANIZATION",
+    FEATURE_ORGANIZATION_TAG = "FEATURE_ORGANIZATION_TAG",
+    FEATURE_ORGANIZATION_PROJECT = "FEATURE_ORGANIZATION_PROJECT",
+    FEATURE_CONTACT = "FEATURE_CONTACT",
+    FEATURE_USER = "FEATURE_USER",
+    FEATURE_ORGANIZATIONS = "FEATURE_ORGANIZATIONS",
+    FEATURE_SETTING = "FEATURE_SETTING",
+    FEATURE_EMAIL_HISTORY = "FEATURE_EMAIL_HISTORY",
+    FEATURE_EMAIL_TEMPLATE = "FEATURE_EMAIL_TEMPLATE",
+    FEATURE_FILE_STORAGE = "FEATURE_FILE_STORAGE",
+    FEATURE_SMS_GATEWAY = "FEATURE_SMS_GATEWAY",
+    FEATURE_SMTP = "FEATURE_SMTP",
+    FEATURE_ROLES_PERMISSION = "FEATURE_ROLES_PERMISSION",
+    FEATURE_INTEGRATION = "FEATURE_INTEGRATION"
+}

package/src/file-provider.d.ts

@@ -0,0 +1,33 @@
+export interface FileStorageOption {
+    dest: string | CallableFunction;
+    provider?: FileStorageProviderEnum;
+    prefix?: string;
+    filename?: string | CallableFunction;
+}
+export interface FileSystem {
+    rootPath: string;
+    baseUrl?: string;
+}
+export declare enum FileStorageProviderEnum {
+    LOCAL = "LOCAL",
+    S3 = "S3",
+    WASABI = "WASABI",
+    OSS = "OSS"
+}
+export interface UploadedFile {
+    fieldname: string;
+    key: string;
+    originalname: string;
+    size: number;
+    encoding?: string;
+    mimetype?: string;
+    filename: string;
+    url: string;
+    path: string;
+}
+export interface S3FileStorageProviderConfig {
+    aws_access_key_id?: string;
+    aws_secret_access_key?: string;
+    aws_default_region?: string;
+    aws_bucket?: string;
+}

package/src/http-status.enum.d.ts

@@ -0,0 +1,57 @@
+export declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}
+export declare enum RequestMethodEnum {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    ALL = "ALL",
+    OPTIONS = "OPTIONS",
+    HEAD = "HEAD"
+}

package/src/import-export.model.d.ts

@@ -0,0 +1,36 @@
+import { IBasePerTenantEntityModel } from "./base-entity.model";
+export interface IImportRecord extends IBasePerTenantEntityModel {
+    entityType?: string;
+    sourceId?: string;
+    destinationId?: string;
+    importDate?: Date;
+    wasCreated?: boolean;
+}
+export interface IImportRecordFind extends IBasePerTenantEntityModel {
+    entityType?: string;
+    sourceId?: string;
+    destinationId?: string;
+}
+export interface IImportHistory extends IBasePerTenantEntityModel {
+    file: string;
+    path: string;
+    size: number;
+    status: string;
+    importDate?: Date;
+}
+export interface IEntityModel {
+    name: string;
+    value: string;
+    checked: boolean;
+    isGroup: boolean;
+    entities: IEntityModel[];
+}
+export declare enum ImportTypeEnum {
+    MERGE = "merge",
+    CLEAN = "clean"
+}
+export declare enum ImportHistoryStatusEnum {
+    SUCCESS = "Success",
+    FAILED = "Failed",
+    CANCELLED = "Cancelled"
+}

package/src/index.d.ts

@@ -0,0 +1,48 @@
+export * from './types';
+export * from './contact.model';
+export * from './core.model';
+export * from './country.model';
+export * from './currency.model';
+export * from './email-template.model';
+export * from './email.model';
+export * from './employee.model';
+export * from './entity-with-members.model';
+export * from './feature.model';
+export * from './file-provider';
+export * from './http-status.enum';
+export * from './import-export.model';
+export * from './language.model';
+export * from './organization-contact.model';
+export * from './organization-department.model';
+export * from './organization-language.model';
+export * from './organization-team-employee-model';
+export * from './organization-team-model';
+export * from './organization.model';
+export * from './role-permission.model';
+export * from './seed.model';
+export * from './tag-entity.model';
+export * from './tenant.model';
+export * from './translation.model';
+export type { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel, IBaseRelationsEntityModel } from './base-entity.model';
+export type { IBaseEntityModel as BaseEntityModel } from './base-entity.model';
+export * from './role.model';
+export * from './user-organization.model';
+export * from './user.model';
+export * from './analytics/index';
+export * from './custom-smtp.model';
+export * from './date-picker.model';
+export * from './integration.model';
+export * from './invite.model';
+export * from './organization-projects.model';
+export * from './password-reset.model';
+export * from './secret-token.model';
+export * from './storage-file.model';
+export * from './visibility.model';
+export * from './integration/index';
+export * from './ai/index';
+export * from './agent/index';
+export * from './api-key.model';
+export * from './schedule';
+export * from './tools/index';
+export * from './plain-object.model';
+export * from './plugin';

package/src/integration/dingtalk.d.ts

@@ -0,0 +1,2 @@
+import { TIntegrationProvider } from '../integration.model';
+export declare const IntegrationDingTalkProvider: TIntegrationProvider;

package/src/integration/firecrawl.d.ts

@@ -0,0 +1,2 @@
+import { TIntegrationProvider } from '../integration.model';
+export declare const IntegrationFirecrawlProvider: TIntegrationProvider;

package/src/integration/github.d.ts

@@ -0,0 +1,69 @@
+import { Endpoints } from "@octokit/types";
+import { TIntegrationProvider } from '../integration.model';
+export declare const IntegrationGitHubProvider: TIntegrationProvider;
+export type TGithubAuth = {
+    redirectUri: string;
+    integrationId: string;
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+    refresh_token_expires_in: number;
+    token_type: string;
+    scope: string;
+    installation_token: string;
+    repository: string;
+};
+type GitHubInstallationsResponse = Endpoints["GET /user/installations"]["response"]["data"];
+type GitHubInstallation = GitHubInstallationsResponse["installations"][0];
+export interface Installation {
+    id: number;
+    accountName: string;
+    accountType: "User" | "Organization";
+    avatarUrl: string;
+}
+/**
+ * Transform GitHub API installation data to our simplified format
+ */
+export declare const transformInstallation: (installation: GitHubInstallation) => Installation;
+export type TRepositoryReturn = {
+    repositories: Repository[];
+    pagination: {
+        page: number;
+        perPage: number;
+        hasMore: boolean;
+        totalCount: number;
+    };
+};
+/**
+ * Repository interface representing GitHub repository data
+ */
+export interface Repository {
+    id: number;
+    name: string;
+    full_name: string;
+    description: string | null;
+    private: boolean;
+    fork: boolean;
+    html_url: string;
+    default_branch: string;
+    permissions: {
+        admin: boolean;
+        maintain: boolean;
+        push: boolean;
+        triage: boolean;
+        pull: boolean;
+    };
+    has_issues: boolean;
+}
+/**
+ * Branch interface representing GitHub branch data
+ */
+export interface Branch {
+    name: string;
+    commit: {
+        sha: string;
+        url: string;
+    };
+    protected: boolean;
+}
+export {};

package/src/integration/index.d.ts

@@ -0,0 +1,4 @@
+import { IntegrationEnum, TIntegrationProvider } from '../integration.model';
+export * from './github';
+export * from './lark';
+export declare const INTEGRATION_PROVIDERS: Partial<Record<IntegrationEnum, TIntegrationProvider>>;

package/src/integration/lark.d.ts

@@ -0,0 +1,11 @@
+import { TIntegrationProvider } from '../integration.model';
+export type TIntegrationLarkOptions = {
+    isLark?: boolean;
+    appId: string;
+    appSecret: string;
+    verificationToken: string;
+    encryptKey: string;
+    xpertId: string;
+    preferLanguage: string;
+};
+export declare const IntegrationLarkProvider: TIntegrationProvider;

package/src/integration/wecom.d.ts

@@ -0,0 +1,2 @@
+import { TIntegrationProvider } from '../integration.model';
+export declare const IntegrationWeComProvider: TIntegrationProvider;

package/src/integration.model.d.ts

@@ -0,0 +1,90 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IOrganizationProjectsUpdateInput } from './organization-projects.model';
+import { IOrganizationUpdateInput } from './organization.model';
+import { ITag } from './tag-entity.model';
+import { I18nObject, IconDefinition, TAvatar, TParameterSchema } from './types';
+export interface IIntegration<T = any> extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    description?: string;
+    /**
+     * avatar object
+     */
+    avatar?: TAvatar;
+    slug: string;
+    provider: string | IntegrationEnum;
+    /**
+     * Integration features: ['knowledge', 'agent', ...]
+     */
+    features?: IntegrationFeatureEnum[];
+    /**
+     * Custom options for different providers
+     */
+    options?: T;
+    tags?: ITag[];
+}
+export interface IIntegrationFilter {
+    integrationTypeId: string;
+    searchQuery: string;
+    filter: string;
+}
+export interface IIntegrationMapSyncProject extends IBasePerTenantAndOrganizationEntityModel {
+    organizationProjectInput: IOrganizationProjectsUpdateInput;
+    integrationId: string;
+    sourceId: number;
+}
+export interface IIntegrationMapSyncOrganization extends IBasePerTenantAndOrganizationEntityModel {
+    organizationInput: IOrganizationUpdateInput;
+    integrationId: string;
+    sourceId: number;
+}
+/**
+ * @deprecated use Plugins instead
+ */
+export declare enum IntegrationEnum {
+    UPWORK = "Upwork",
+    HUBSTAFF = "Hubstaff",
+    LARK = "Lark",
+    DINGTALK = "DingTalk",
+    WECOM = "WeCom",
+    FIRECRAWL = "firecrawl",
+    KNOWLEDGEBASE = "knowledgebase",
+    GITHUB = "github",
+    RAGFlow = "ragflow",
+    Dify = "dify",
+    FastGPT = "fastgpt"
+}
+export declare enum IntegrationFeatureEnum {
+    KNOWLEDGE = "knowledge",
+    AGENT = "agent",
+    SSO = "sso"
+}
+export declare enum IntegrationFilterEnum {
+    ALL = "All",
+    FREE = "Free",
+    PAID = "Paid"
+}
+export declare const DEFAULT_INTEGRATION_PAID_FILTERS: {
+    label: IntegrationFilterEnum;
+    value: string;
+}[];
+export interface IDateRangeActivityFilter {
+    start: Date;
+    end: Date;
+}
+export type TIntegrationProvider = {
+    name: string;
+    label: I18nObject;
+    description?: I18nObject;
+    avatar?: string;
+    icon?: IconDefinition;
+    webhook?: boolean;
+    schema?: TParameterSchema;
+    features?: IntegrationFeatureEnum[];
+    helpUrl?: string;
+    /**
+     * Webhook URL generator, for example:
+     * `{{apiBaseUrl}}/api/integration/webhook/{{integrationId}}`
+     */
+    webhookUrl?: string;
+    pro?: boolean;
+};