@metad/contracts 3.6.7 → 3.8.0

package/src/invite.model.d.ts

@@ -0,0 +1,123 @@
+import { IRole } from './role.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IUser, IUserRegistrationInput, LanguagesEnum } from './user.model';
+import { IOrganization } from './organization.model';
+import { IOrganizationContact } from './organization-contact.model';
+import { IOrganizationDepartment } from './organization-department.model';
+import { IEmployee } from './employee.model';
+export interface IInvite extends IBasePerTenantAndOrganizationEntityModel {
+    token: string;
+    email: string;
+    roleId: string;
+    invitedById: string;
+    status: string;
+    expireDate: Date;
+    actionDate?: Date;
+    role?: IRole;
+    invitedBy?: IUser;
+    organizationContacts?: IOrganizationContact[];
+    departments?: IOrganizationDepartment[];
+}
+export interface IInviteAcceptInput extends IUserRegistrationInput {
+    inviteId: string;
+    organization: IOrganization;
+    originalUrl?: string;
+}
+export interface IInviteResendInput {
+    id: string;
+    invitedById: string;
+    email: string;
+    roleName: string;
+    organization: IOrganization;
+    departmentNames?: string[];
+    clientNames?: string[];
+    inviteType: any;
+}
+export interface ICreateEmailInvitesInput extends IBasePerTenantAndOrganizationEntityModel {
+    emailIds: string[];
+    projectIds?: string[];
+    organizationContactIds?: string[];
+    departmentIds?: string[];
+    roleId: string;
+    invitedById: string;
+    inviteType: any;
+    startedWorkOn: Date;
+    appliedDate?: Date;
+    invitationExpirationPeriod?: number | string;
+}
+export interface ICreateOrganizationContactInviteInput extends IBasePerTenantAndOrganizationEntityModel {
+    emailId: string;
+    organizationContactId: string;
+    roleId: string;
+    invitedById: string;
+    originalUrl: string;
+    languageCode: LanguagesEnum;
+}
+export interface ICreateEmailInvitesOutput {
+    items: IInvite[];
+    total: number;
+    ignored: number;
+}
+export interface IInviteFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    invitationType?: InvitationTypeEnum;
+}
+export interface IPublicInviteFindInput {
+    email: string;
+    token: string;
+}
+export interface IInviteUpdateInput {
+    status: InviteStatusEnum;
+}
+export declare enum InviteStatusEnum {
+    INVITED = "INVITED",
+    ACCEPTED = "ACCEPTED"
+}
+export declare enum InvitationTypeEnum {
+    USER = "USER",
+    EMPLOYEE = "EMPLOYEE",
+    CANDIDATE = "CANDIDATE"
+}
+export declare enum InvitationExpirationEnum {
+    DAY = 1,
+    WEEK = 7,
+    TWO_WEEK = 14,
+    MONTH = 30,
+    NEVER = "Never"
+}
+export interface IInviteViewModel {
+    email: string;
+    expireDate: string;
+    createdDate: string;
+    imageUrl: string;
+    fullName: string;
+    roleName?: string;
+    status: string;
+    projectNames: string[];
+    clientNames: string[];
+    departmentNames: string[];
+    id: string;
+    inviteUrl: string;
+}
+export interface IInviteUserModel extends IBasePerTenantAndOrganizationEntityModel {
+    email: string;
+    role: string;
+    registerUrl: string;
+    languageCode: LanguagesEnum;
+    invitedBy: IUser;
+    originUrl?: string;
+}
+export interface IInviteEmployeeModel extends IBasePerTenantAndOrganizationEntityModel {
+    email: string;
+    registerUrl: string;
+    languageCode: LanguagesEnum;
+    invitedBy: IUser;
+    organizationContacts?: IOrganizationContact[];
+    departments?: IOrganizationDepartment[];
+    originUrl?: string;
+}
+export interface IJoinEmployeeModel extends IBasePerTenantAndOrganizationEntityModel {
+    email: string;
+    employee: IEmployee;
+    organization: IOrganization;
+    languageCode: LanguagesEnum;
+}

package/src/language.model.d.ts

@@ -0,0 +1,19 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export interface ILanguage extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    code?: string;
+    is_system?: boolean;
+    description?: string;
+    color?: string;
+    isSelected?: boolean;
+}
+export interface ILanguageName {
+    name?: string;
+}
+export interface ILanguageFindInput {
+    name?: string;
+    code?: string;
+    is_system?: boolean;
+    description?: string;
+    color?: string;
+}

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

@@ -0,0 +1,72 @@
+import { IEmployee } from './employee.model';
+import { IOrganizationCreateInput } from './organization.model';
+import { IBaseEntityWithMembers } from './entity-with-members.model';
+import { IUser, LanguagesEnum } from './user.model';
+import { ITag } from './tag-entity.model';
+import { IContact } from './contact.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export interface IOrganizationContact extends IBaseEntityWithMembers {
+    name: string;
+    contactType: string;
+    primaryEmail: string;
+    emailAddresses?: string[];
+    primaryPhone: string;
+    phones?: string[];
+    notes?: string;
+    members?: IEmployee[];
+    imageUrl?: string;
+    inviteStatus?: string;
+    tags: ITag[];
+    budget?: number;
+    budgetType?: OrganizationContactBudgetTypeEnum;
+}
+export declare enum OrganizationContactBudgetTypeEnum {
+    HOURS = "hours",
+    COST = "cost"
+}
+export interface IOrganizationContactFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    primaryEmail?: string;
+    primaryPhone?: string;
+    notes?: string;
+    imageUrl?: string;
+    contactType?: string;
+}
+export interface IOrganizationContactCreateInput extends IContact {
+    name: string;
+    organizationId: string;
+    contactId?: string;
+    primaryEmail?: string;
+    emailAddresses?: string[];
+    primaryPhone?: string;
+    phones?: string[];
+    members?: IEmployee[];
+    notes?: string;
+    imageUrl?: string;
+    contactType?: string;
+}
+export interface IOrganizationContactInviteInput {
+    id: string;
+    languageCode: LanguagesEnum;
+    originalUrl?: string;
+    inviterUser?: IUser;
+}
+export interface IOrganizationContactRegistrationInput {
+    user: IUser;
+    password: string;
+    contactOrganization: IOrganizationCreateInput;
+}
+export interface IOrganizationContactAcceptInviteInput extends IOrganizationContactRegistrationInput {
+    inviteId: string;
+    originalUrl?: string;
+}
+export declare enum ContactOrganizationInviteStatus {
+    NOT_INVITED = "NOT_INVITED",
+    INVITED = "INVITED",
+    ACCEPTED = "ACCEPTED"
+}
+export declare enum ContactType {
+    CLIENT = "CLIENT",
+    CUSTOMER = "CUSTOMER",
+    LEAD = "LEAD"
+}

package/src/{organization-department.model.ts → organization-department.model.d.ts}

@@ -2,25 +2,19 @@ import { IBaseEntityWithMembers } from './entity-with-members.model';
 import { IEmployee } from './employee.model';
 import { ITag } from './tag-entity.model';
 import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
-
 export interface IOrganizationDepartment extends IBaseEntityWithMembers {
-	name: string;
-	tags: ITag[];
+    name: string;
+    tags: ITag[];
 }
-
-export interface IOrganizationDepartmentFindInput
-	extends IBasePerTenantAndOrganizationEntityModel {
-	name?: string;
+export interface IOrganizationDepartmentFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
 }
-
 export interface IOrganizationDepartmentFindByMemberInput {
-	memberId: string;
-	tags: ITag[];
+    memberId: string;
+    tags: ITag[];
 }
-
-export interface IOrganizationDepartmentCreateInput
-	extends IBasePerTenantAndOrganizationEntityModel {
-	name: string;
-	members?: IEmployee[];
-	tags: ITag[];
+export interface IOrganizationDepartmentCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    members?: IEmployee[];
+    tags: ITag[];
 }

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

@@ -0,0 +1,18 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { ILanguage, ILanguageFindInput } from './language.model';
+export interface IOrganizationLanguage extends IBasePerTenantAndOrganizationEntityModel {
+    language: ILanguage;
+    languageCode: string;
+    level: string;
+    name: string;
+}
+export interface IOrganizationLanguageFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    language?: ILanguageFindInput;
+    level?: string;
+    name?: string;
+}
+export interface IOrganizationLanguageCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    language: ILanguage;
+    level: string;
+    name: string;
+}

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

@@ -0,0 +1,80 @@
+import { IEmployee } from './employee.model';
+import { IOrganizationContact } from './organization-contact.model';
+import { CrudActionEnum, ProjectBillingEnum, ProjectOwnerEnum } from './organization.model';
+import { IBaseEntityWithMembers } from './entity-with-members.model';
+import { ITag } from './tag-entity.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { CurrenciesEnum } from './currency.model';
+export interface IOrganizationProject extends IBaseEntityWithMembers {
+    name: string;
+    organizationContact?: IOrganizationContact;
+    organizationContactId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    billing: string;
+    currency: string;
+    members?: IEmployee[];
+    public: boolean;
+    tags: ITag[];
+    owner: string;
+    taskListType: string;
+    code?: string;
+    description?: string;
+    color?: string;
+    billable?: boolean;
+    billingFlat?: boolean;
+    openSource?: boolean;
+    projectUrl?: string;
+    openSourceProjectUrl?: string;
+    budget?: number;
+    budgetType?: OrganizationProjectBudgetTypeEnum;
+    membersCount?: number;
+    imageUrl?: string;
+}
+export declare enum TaskListTypeEnum {
+    GRID = "GRID",
+    SPRINT = "SPRINT"
+}
+export declare enum OrganizationProjectBudgetTypeEnum {
+    HOURS = "hours",
+    COST = "cost"
+}
+export interface IOrganizationProjectsFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    organizationContactId?: string;
+    organizationContact?: IOrganizationContact;
+    members?: IEmployee[];
+    public?: boolean;
+    tags?: ITag[];
+    billable?: boolean;
+    billingFlat?: boolean;
+}
+export interface IOrganizationProjectsCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    organizationContact?: IOrganizationContact;
+    organizationContactId?: string;
+    startDate?: Date;
+    endDate?: Date;
+    billing?: ProjectBillingEnum;
+    currency?: CurrenciesEnum;
+    members?: IEmployee[];
+    public?: boolean;
+    tags?: ITag[];
+    owner?: ProjectOwnerEnum;
+    code?: string;
+    description?: string;
+    color?: string;
+    billable?: boolean;
+    billingFlat?: boolean;
+    status?: string;
+    openSource?: boolean;
+    projectUrl?: string;
+    openSourceProjectUrl?: string;
+}
+export interface IOrganizationProjectsUpdateInput extends IOrganizationProjectsCreateInput {
+    id?: string;
+}
+export interface IOrganizationProjectStoreState {
+    project: IOrganizationProject;
+    action: CrudActionEnum;
+}

package/src/organization-team-employee-model.d.ts

@@ -0,0 +1,12 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IOrganizationTeam } from './organization-team-model';
+import { IEmployee } from './employee.model';
+import { IRole } from './role.model';
+export interface IOrganizationTeamEmployee extends IBasePerTenantAndOrganizationEntityModel {
+    organizationTeamId: string;
+    employeeId: string;
+    roleId?: string;
+    organizationTeam: IOrganizationTeam;
+    employee: IEmployee;
+    role?: IRole;
+}

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

@@ -0,0 +1,19 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IOrganizationTeamEmployee } from './organization-team-employee-model';
+import { ITag } from './tag-entity.model';
+export interface IOrganizationTeam extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    members?: IOrganizationTeamEmployee[];
+    managers?: IOrganizationTeamEmployee[];
+    tags?: ITag[];
+}
+export interface IOrganizationTeamFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    tags?: ITag[];
+}
+export interface IOrganizationTeamCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    members?: string[];
+    managers?: string[];
+    tags?: ITag[];
+}

package/src/organization.model.d.ts

@@ -0,0 +1,238 @@
+import { IBasePerTenantEntityModel } from './base-entity.model';
+import { IContact } from './contact.model';
+import { CurrenciesEnum } from './currency.model';
+import { IEmployee } from './employee.model';
+import { IFeatureOrganization } from './feature.model';
+import { IOrganizationLanguage } from './organization-language.model';
+import { ITag } from './tag-entity.model';
+import { ITenant } from './tenant.model';
+import { LanguagesEnum } from './user.model';
+export declare enum OrganizationPermissionsEnum {
+    ALLOW_MANUAL_TIME = "allowManualTime",
+    ALLOW_MODIFY_TIME = "allowModifyTime",
+    ALLOW_DELETE_TIME = "allowDeleteTime",
+    ALLOW_FUTURE_DATE = "futureDateAllowed"
+}
+export declare enum ListsInputTypeEnum {
+    DEPARTMENTS = "DEPARTMENTS",
+    POSITIONS = "POSITIONS",
+    VENDORS = "VENDORS"
+}
+export interface IOrganization extends IBasePerTenantEntityModel {
+    name: string;
+    isDefault: boolean;
+    profile_link: string;
+    valueDate?: Date;
+    totalEmployees: number;
+    status?: string;
+    imageUrl?: string;
+    banner: string;
+    short_description: string;
+    client_focus: string;
+    createdDemo?: boolean;
+    show_income?: boolean;
+    show_profits?: boolean;
+    show_bonuses_paid?: boolean;
+    show_total_hours?: boolean;
+    show_minimum_project_size?: boolean;
+    show_projects_count?: boolean;
+    show_clients_count?: boolean;
+    show_employees_count?: boolean;
+    overview: string;
+    currency: string;
+    isActive: boolean;
+    defaultValueDateType: string;
+    defaultAlignmentType?: string;
+    dateFormat?: string;
+    brandColor?: string;
+    timeZone?: string;
+    officialName?: string;
+    startWeekOn?: string;
+    taxId?: string;
+    numberFormat?: string;
+    bonusType?: string;
+    bonusPercentage?: number;
+    employees?: IEmployee[];
+    invitesAllowed?: boolean;
+    inviteExpiryPeriod?: number;
+    tags: ITag[];
+    futureDateAllowed?: boolean;
+    allowManualTime?: boolean;
+    allowModifyTime?: boolean;
+    allowDeleteTime?: boolean;
+    regionCode?: string;
+    requireReason?: boolean;
+    requireDescription?: boolean;
+    requireProject?: boolean;
+    requireTask?: boolean;
+    requireClient?: boolean;
+    timeFormat?: 12 | 24;
+    defaultStartTime?: string;
+    defaultEndTime?: string;
+    registrationDate?: Date;
+    separateInvoiceItemTaxAndDiscount?: boolean;
+    minimumProjectSize?: string;
+    show_clients?: boolean;
+    currencyPosition?: string;
+    website?: string;
+    fiscalInformation?: string;
+    fiscalStartDate?: Date;
+    fiscalEndDate?: Date;
+    discountAfterTax?: boolean;
+    languages?: IOrganizationLanguage[];
+    featureOrganizations?: IFeatureOrganization[];
+    defaultInvoiceEstimateTerms?: string;
+    convertAcceptedEstimates?: boolean;
+    daysUntilDue?: number;
+    preferredLanguage?: LanguagesEnum;
+}
+export interface IOrganizationFindInput extends IBasePerTenantEntityModel {
+    id?: string;
+    name?: string;
+    isDefault?: boolean;
+    profile_link?: string;
+    valueDate?: Date;
+    imageUrl?: string;
+    currency?: CurrenciesEnum;
+    isActive?: boolean;
+    tags?: ITag[];
+}
+export interface IOrganizationCreateInput extends IContact {
+    name: string;
+    isDefault: boolean;
+    profile_link: string;
+    valueDate?: Date;
+    imageUrl: string;
+    currency: CurrenciesEnum;
+    client_focus: string;
+    show_income?: boolean;
+    show_profits?: boolean;
+    show_bonuses_paid?: boolean;
+    show_total_hours?: boolean;
+    show_minimum_project_size?: boolean;
+    show_projects_count?: boolean;
+    show_clients_count?: boolean;
+    show_employees_count?: boolean;
+    defaultValueDateType: DefaultValueDateTypeEnum;
+    dateFormat?: string;
+    timeZone?: string;
+    officialName?: string;
+    startWeekOn?: string;
+    taxId?: string;
+    numberFormat?: string;
+    bonusType: BonusTypeEnum;
+    bonusPercentage?: number;
+    invitesAllowed?: boolean;
+    inviteExpiryPeriod?: number;
+    tags?: ITag[];
+    tenant: ITenant;
+    contact?: IContact;
+    minimumProjectSize?: string;
+    show_clients?: boolean;
+    website?: string;
+    fiscalInformation?: string;
+    defaultInvoiceEstimateTerms?: string;
+    convertAcceptedEstimates?: boolean;
+    daysUntilDue?: number;
+    preferredLanguage?: LanguagesEnum;
+    isImporting?: boolean;
+    sourceId?: string;
+    userOrganizationSourceId?: string;
+}
+export interface IOrganizationUpdateInput extends IOrganizationCreateInput {
+    id?: string;
+}
+export declare enum OrganizationSelectInput {
+    id = "id",
+    name = "name",
+    profile_link = "profile_link",
+    valueDate = "valueDate",
+    imageUrl = "imageUrl",
+    currency = "currency",
+    createdAt = "createdAt",
+    updatedAt = "updatedAt",
+    isActive = "isActive",
+    tags = "tags"
+}
+export declare enum RegionsEnum {
+    'EN' = "English (United States)",
+    'BG' = "Bulgarian (Bulgaria)",
+    'HE' = "Hebrew (Israel)",
+    'RU' = "Rusian (Russia)"
+}
+export declare enum DefaultValueDateTypeEnum {
+    TODAY = "TODAY",
+    END_OF_MONTH = "END_OF_MONTH",
+    START_OF_MONTH = "START_OF_MONTH"
+}
+export declare enum ProjectBillingEnum {
+    RATE = "RATE",
+    FLAT_FEE = "FLAT_FEE",
+    MILESTONES = "MILESTONES"
+}
+export declare enum AlignmentOptions {
+    LEFT = "LEFT",
+    RIGHT = "RIGHT",
+    CENTER = "CENTER"
+}
+export declare enum CurrencyPosition {
+    LEFT = "LEFT",
+    RIGHT = "RIGHT"
+}
+export declare enum WeekDaysEnum {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
+export declare enum BonusTypeEnum {
+    PROFIT_BASED_BONUS = "PROFIT_BASED_BONUS",
+    REVENUE_BASED_BONUS = "REVENUE_BASED_BONUS"
+}
+export declare enum ClientFocusEnum {
+    VERY_SMALL_BUSINESSES = "Very Small Businesses",
+    SMALL_BUSINESSES = "Small Businesses",
+    MEDIUM_BUSINESSES = "Medium Businesses",
+    LARGE_BUSINESSES = "Large Businesses"
+}
+export declare enum ProjectOwnerEnum {
+    CLIENT = "CLIENT",
+    INTERNAL = "INTERNAL"
+}
+export declare enum MinimumProjectSizeEnum {
+    ONE_THOUSAND = "1000+",
+    FIVE_THOUSAND = "5000+",
+    TEN_THOUSAND = "10000+",
+    TWENTY_FIVE_THOUSAND = "25000+",
+    FIFTY_THOUSAND = "50000+",
+    ONE_HUNDRED_THOUSAND = "100000+"
+}
+export declare const DEFAULT_PROFIT_BASED_BONUS = 75;
+export declare const DEFAULT_REVENUE_BASED_BONUS = 10;
+export declare const DEFAULT_INVITE_EXPIRY_PERIOD = 7;
+export interface IOrganizationStoreState {
+    organization: IOrganization;
+    action: CrudActionEnum;
+}
+export declare enum CrudActionEnum {
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    DELETED = "DELETED"
+}
+export declare const DEFAULT_DATE_FORMATS: string[];
+export declare const DEFAULT_TIME_FORMATS: number[];
+export interface IKeyValuePair {
+    key: string;
+    value: boolean | string;
+}
+export declare enum OrganizationDemoNetworkEnum {
+    github = "github",
+    aliyun = "aliyun"
+}
+export type OrgGenerateDemoOptions = {
+    source: OrganizationDemoNetworkEnum | string;
+    importData: boolean;
+};

package/src/{password-reset.model.ts → password-reset.model.d.ts}

@@ -1,22 +1,18 @@
 import { IBasePerTenantEntityModel } from './base-entity.model';
-
 export interface IPasswordReset extends IBasePerTenantEntityModel {
-	email: string;
-	token: string;
-	expired?: boolean;
+    email: string;
+    token: string;
+    expired?: boolean;
 }
-
 export interface IPasswordResetFindInput extends IBasePerTenantEntityModel {
-	email?: string;
-	token?: string;
+    email?: string;
+    token?: string;
 }
-
 export interface IChangePasswordRequest {
-	token: string;
-	password: string;
-	confirmPassword: string;
+    token: string;
+    password: string;
+    confirmPassword: string;
 }
-
 export interface IResetPasswordRequest {
-	email: string;
-}
+    email: string;
+}

package/src/{plain-object.model.ts → plain-object.model.d.ts}

@@ -9,5 +9,5 @@
  * }
  */
 export interface PlainObject {
-	[key: string]: any;
+    [key: string]: any;
 }

package/src/plugin.d.ts

@@ -0,0 +1,21 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IconDefinition } from './types';
+export type PluginName = string;
+export interface PluginMeta {
+    name: PluginName;
+    version: string;
+    icon?: IconDefinition;
+    category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration' | 'datasource' | 'database' | 'middleware';
+    displayName: string;
+    description: string;
+    keywords?: string[];
+    author: string;
+    homepage?: string;
+}
+export interface IPlugin extends IBasePerTenantAndOrganizationEntityModel {
+    pluginName: string;
+    packageName: string;
+    version?: string;
+    source?: "marketplace" | "local" | "git" | "url" | "npm" | "code";
+    config: Record<string, any>;
+}