@metad/contracts 0.0.1

package/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/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/feature.model.d.ts

@@ -0,0 +1,134 @@
+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_DASHBOARD = "FEATURE_DASHBOARD",
+    FEATURE_TIME_TRACKING = "FEATURE_TIME_TRACKING",
+    FEATURE_ESTIMATE = "FEATURE_ESTIMATE",
+    FEATURE_ESTIMATE_RECEIVED = "FEATURE_ESTIMATE_RECEIVED",
+    FEATURE_INVOICE = "FEATURE_INVOICE",
+    FEATURE_INVOICE_RECURRING = "FEATURE_INVOICE_RECURRING",
+    FEATURE_INVOICE_RECEIVED = "FEATURE_INVOICE_RECEIVED",
+    FEATURE_INCOME = "FEATURE_INCOME",
+    FEATURE_EXPENSE = "FEATURE_EXPENSE",
+    FEATURE_PAYMENT = "FEATURE_PAYMENT",
+    FEATURE_PROPOSAL = "FEATURE_PROPOSAL",
+    FEATURE_PROPOSAL_TEMPLATE = "FEATURE_PROPOSAL_TEMPLATE",
+    FEATURE_PIPELINE = "FEATURE_PIPELINE",
+    FEATURE_PIPELINE_DEAL = "FEATURE_PIPELINE_DEAL",
+    FEATURE_DASHBOARD_TASK = "FEATURE_DASHBOARD_TASK",
+    FEATURE_TEAM_TASK = "FEATURE_TEAM_TASK",
+    FEATURE_MY_TASK = "FEATURE_MY_TASK",
+    FEATURE_JOB = "FEATURE_JOB",
+    FEATURE_EMPLOYEES = "FEATURE_EMPLOYEES",
+    FEATURE_EMPLOYEE_TIME_ACTIVITY = "FEATURE_EMPLOYEE_TIME_ACTIVITY",
+    FEATURE_EMPLOYEE_TIMESHEETS = "FEATURE_EMPLOYEE_TIMESHEETS",
+    FEATURE_EMPLOYEE_APPOINTMENT = "FEATURE_EMPLOYEE_APPOINTMENT",
+    FEATURE_EMPLOYEE_APPROVAL = "FEATURE_EMPLOYEE_APPROVAL",
+    FEATURE_EMPLOYEE_APPROVAL_POLICY = "FEATURE_EMPLOYEE_APPROVAL_POLICY",
+    FEATURE_EMPLOYEE_LEVEL = "FEATURE_EMPLOYEE_LEVEL",
+    FEATURE_EMPLOYEE_POSITION = "FEATURE_EMPLOYEE_POSITION",
+    FEATURE_EMPLOYEE_TIMEOFF = "FEATURE_EMPLOYEE_TIMEOFF",
+    FEATURE_EMPLOYEE_RECURRING_EXPENSE = "FEATURE_EMPLOYEE_RECURRING_EXPENSE",
+    FEATURE_EMPLOYEE_CANDIDATE = "FEATURE_EMPLOYEE_CANDIDATE",
+    FEATURE_MANAGE_INTERVIEW = "FEATURE_MANAGE_INTERVIEW",
+    FEATURE_MANAGE_INVITE = "FEATURE_MANAGE_INVITE",
+    FEATURE_ORGANIZATION = "FEATURE_ORGANIZATION",
+    FEATURE_ORGANIZATION_EQUIPMENT = "FEATURE_ORGANIZATION_EQUIPMENT",
+    FEATURE_ORGANIZATION_INVENTORY = "FEATURE_ORGANIZATION_INVENTORY",
+    FEATURE_ORGANIZATION_TAG = "FEATURE_ORGANIZATION_TAG",
+    FEATURE_ORGANIZATION_VENDOR = "FEATURE_ORGANIZATION_VENDOR",
+    FEATURE_ORGANIZATION_PROJECT = "FEATURE_ORGANIZATION_PROJECT",
+    FEATURE_ORGANIZATION_DEPARTMENT = "FEATURE_ORGANIZATION_DEPARTMENT",
+    FEATURE_ORGANIZATION_TEAM = "FEATURE_ORGANIZATION_TEAM",
+    FEATURE_ORGANIZATION_DOCUMENT = "FEATURE_ORGANIZATION_DOCUMENT",
+    FEATURE_ORGANIZATION_EMPLOYMENT_TYPE = "FEATURE_ORGANIZATION_EMPLOYMENT_TYPE",
+    FEATURE_ORGANIZATION_RECURRING_EXPENSE = "FEATURE_ORGANIZATION_RECURRING_EXPENSE",
+    FEATURE_ORGANIZATION_HELP_CENTER = "FEATURE_ORGANIZATION_HELP_CENTER",
+    FEATURE_CONTACT = "FEATURE_CONTACT",
+    FEATURE_GOAL = "FEATURE_GOAL",
+    FEATURE_GOAL_REPORT = "FEATURE_GOAL_REPORT",
+    FEATURE_GOAL_SETTING = "FEATURE_GOAL_SETTING",
+    FEATURE_REPORT = "FEATURE_REPORT",
+    FEATURE_USER = "FEATURE_USER",
+    FEATURE_ORGANIZATIONS = "FEATURE_ORGANIZATIONS",
+    FEATURE_APP_INTEGRATION = "FEATURE_APP_INTEGRATION",
+    FEATURE_SETTING = "FEATURE_SETTING",
+    FEATURE_EMAIL_HISTORY = "FEATURE_EMAIL_HISTORY",
+    FEATURE_EMAIL_TEMPLATE = "FEATURE_EMAIL_TEMPLATE",
+    FEATURE_IMPORT_EXPORT = "FEATURE_IMPORT_EXPORT",
+    FEATURE_FILE_STORAGE = "FEATURE_FILE_STORAGE",
+    FEATURE_PAYMENT_GATEWAY = "FEATURE_PAYMENT_GATEWAY",
+    FEATURE_SMS_GATEWAY = "FEATURE_SMS_GATEWAY",
+    FEATURE_SMTP = "FEATURE_SMTP",
+    FEATURE_ROLES_PERMISSION = "FEATURE_ROLES_PERMISSION"
+}

package/file-provider.d.ts

@@ -0,0 +1,31 @@
+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"
+}
+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/help-center-article.model.d.ts

@@ -0,0 +1,27 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IEmployee } from './employee.model';
+export interface IHelpCenterArticle extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    description: string;
+    data: string;
+    index: number;
+    draft: boolean;
+    privacy: boolean;
+    categoryId: string;
+    employees?: IEmployee[];
+    authors?: IHelpCenterAuthor[];
+}
+export interface IHelpCenterAuthor extends IBasePerTenantAndOrganizationEntityModel {
+    articleId: string;
+    article?: IHelpCenterArticle;
+    employeeId: string;
+    employee?: IEmployee;
+    articles?: IHelpCenterArticle[];
+}
+export interface IHelpCenterAuthorCreate extends IBasePerTenantAndOrganizationEntityModel {
+    articleId: string;
+    employeeIds: string[];
+}
+export interface IHelpCenterAuthorFind extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+}

package/help-center.model.d.ts

@@ -0,0 +1,28 @@
+import { IHelpCenterArticle } from './help-center-article.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export interface IHelpCenter extends IBasePerTenantAndOrganizationEntityModel {
+    name: string;
+    icon: string;
+    flag: string;
+    privacy: string;
+    language: string;
+    color: string;
+    description?: string;
+    data?: string;
+    index: number;
+    children?: IHelpCenter[];
+    parent?: IHelpCenter;
+    article?: IHelpCenterArticle[];
+    parentId?: string;
+}
+export interface IHelpCenterFind extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+}
+export declare enum HelpCenterActionEnum {
+    ADD = "add",
+    EDIT = "edit"
+}
+export declare enum HelpCenterFlagEnum {
+    BASE = "base",
+    CATEGORY = "category"
+}

package/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/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"
+}