@metad/contracts 3.6.0 → 3.6.1

package/src/organization-contact.model.ts

@@ -0,0 +1,84 @@
+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[];
+	contact: IContact;
+	budget?: number;
+	budgetType?: OrganizationContactBudgetTypeEnum;
+}
+
+export enum OrganizationContactBudgetTypeEnum {
+	HOURS = 'hours',
+	COST = 'cost'
+}
+
+export interface IOrganizationContactFindInput
+	extends IBasePerTenantAndOrganizationEntityModel {
+	name?: string;
+	primaryEmail?: string;
+	primaryPhone?: string;
+	notes?: string;
+	imageUrl?: string;
+	contactType?: string;
+	// createdBy?: 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;
+	// createdBy?: 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 enum ContactOrganizationInviteStatus {
+	NOT_INVITED = 'NOT_INVITED',
+	INVITED = 'INVITED',
+	ACCEPTED = 'ACCEPTED'
+}
+
+export enum ContactType {
+	CLIENT = 'CLIENT',
+	CUSTOMER = 'CUSTOMER',
+	LEAD = 'LEAD'
+}

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

@@ -2,19 +2,25 @@ 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.ts

@@ -0,0 +1,24 @@
+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.ts

@@ -0,0 +1,99 @@
+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;
+	// prefix to project tasks / issues, e.g. GA-XXXX (GA is prefix)
+	code?: string;
+	description?: string;
+	// the color of project which is used in UI
+	color?: string;
+	// is project billable?
+	billable?: boolean;
+	// true if the project is flat rate, false if the project is time / materials billable
+	billingFlat?: boolean;
+	openSource?: boolean;
+	projectUrl?: string;
+	openSourceProjectUrl?: string;
+	budget?: number;
+	budgetType?: OrganizationProjectBudgetTypeEnum;
+	membersCount?: number;
+	imageUrl?: string;
+}
+
+export enum TaskListTypeEnum {
+	GRID = 'GRID',
+	SPRINT = 'SPRINT'
+}
+
+export 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.ts

@@ -0,0 +1,14 @@
+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.ts

@@ -0,0 +1,25 @@
+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.ts

@@ -0,0 +1,266 @@
+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 enum OrganizationPermissionsEnum {
+	ALLOW_MANUAL_TIME = 'allowManualTime',
+	ALLOW_MODIFY_TIME = 'allowModifyTime',
+	ALLOW_DELETE_TIME = 'allowDeleteTime',
+	ALLOW_FUTURE_DATE = 'futureDateAllowed'
+}
+
+export 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;
+	// Organization logo Url
+	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;
+	contact: IContact;
+	separateInvoiceItemTaxAndDiscount?: boolean;
+	minimumProjectSize?: string;
+	show_clients?: boolean;
+	// "left" and "right" values, used to know where to put currency symbol relative to amount
+	currencyPosition?: string;
+	website?: string;
+	// used in invoice headers to display organization details
+	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 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 enum RegionsEnum {
+	'EN' = 'English (United States)',
+	'BG' = 'Bulgarian (Bulgaria)',
+	'HE' = 'Hebrew (Israel)',
+	'RU' = 'Rusian (Russia)'
+}
+
+export enum DefaultValueDateTypeEnum {
+	TODAY = 'TODAY',
+	END_OF_MONTH = 'END_OF_MONTH',
+	START_OF_MONTH = 'START_OF_MONTH'
+}
+
+export enum ProjectBillingEnum {
+	RATE = 'RATE',
+	FLAT_FEE = 'FLAT_FEE',
+	MILESTONES = 'MILESTONES'
+}
+
+export enum AlignmentOptions {
+	LEFT = 'LEFT',
+	RIGHT = 'RIGHT',
+	CENTER = 'CENTER'
+}
+
+export enum CurrencyPosition {
+	LEFT = 'LEFT',
+	RIGHT = 'RIGHT'
+}
+
+export enum WeekDaysEnum {
+	MONDAY = 'MONDAY',
+	TUESDAY = 'TUESDAY',
+	WEDNESDAY = 'WEDNESDAY',
+	THURSDAY = 'THURSDAY',
+	FRIDAY = 'FRIDAY',
+	SATURDAY = 'SATURDAY',
+	SUNDAY = 'SUNDAY'
+}
+
+export enum BonusTypeEnum {
+	PROFIT_BASED_BONUS = 'PROFIT_BASED_BONUS',
+	REVENUE_BASED_BONUS = 'REVENUE_BASED_BONUS'
+}
+
+export enum ClientFocusEnum {
+	VERY_SMALL_BUSINESSES = 'Very Small Businesses',
+	SMALL_BUSINESSES = 'Small Businesses',
+	MEDIUM_BUSINESSES = 'Medium Businesses',
+	LARGE_BUSINESSES = 'Large Businesses'
+}
+
+export enum ProjectOwnerEnum {
+	CLIENT = 'CLIENT',
+	INTERNAL = 'INTERNAL'
+}
+
+export enum MinimumProjectSizeEnum {
+	ONE_THOUSAND = '1000+',
+	FIVE_THOUSAND = '5000+',
+	TEN_THOUSAND = '10000+',
+	TWENTY_FIVE_THOUSAND = '25000+',
+	FIFTY_THOUSAND = '50000+',
+	ONE_HUNDRED_THOUSAND = '100000+'
+}
+
+export const DEFAULT_PROFIT_BASED_BONUS = 75;
+export const DEFAULT_REVENUE_BASED_BONUS = 10;
+export const DEFAULT_INVITE_EXPIRY_PERIOD = 7;
+
+export interface IOrganizationStoreState {
+	organization: IOrganization;
+	action: CrudActionEnum;
+}
+
+export enum CrudActionEnum {
+	CREATED = 'CREATED',
+	UPDATED = 'UPDATED',
+	DELETED = 'DELETED'
+}
+
+export const DEFAULT_DATE_FORMATS: string[] = ['L', 'LL', 'dddd, LL'];
+export const DEFAULT_TIME_FORMATS: number[] = [12, 24];
+export interface IKeyValuePair {
+    key: string;
+    value: boolean | string;
+}
+
+export enum OrganizationDemoNetworkEnum {
+	github = 'github',
+	aliyun = 'aliyun'
+}
+
+export type OrgGenerateDemoOptions = {
+	source: OrganizationDemoNetworkEnum | string;
+	importData: boolean
+}

package/src/password-reset.model.ts

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

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

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

package/src/plugin.ts

@@ -0,0 +1,15 @@
+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'
+  displayName: string
+  description: string
+  keywords?: string[]
+  author: string
+  homepage?: string
+}