@managemint-solutions/entities 1.0.4 → 1.0.6

package/dist/auth/index.d.ts

@@ -1,4 +1,8 @@
-export type GetTokensResponse = {
+export type LoginResponse = {
+    access_token: string;
+    refresh_token: string;
+};
+export type ExchangeTokenResponse = {
     access_token: string;
     refresh_token: string;
 };

package/dist/clients/index.d.ts

@@ -1,19 +1,19 @@
 import { UUID } from 'crypto';
-import { ShorthandUser } from '../users';
+import { UserIdentity } from '../users';
 import { Status } from '../status';
-export type ClientShorthand = {
+export type ClientIdentity = {
     mms_id: UUID;
     name: string;
 };
-export type ClientList = {
+export type ClientSummary = {
     mms_id: UUID;
     created_at: Date;
     name: string;
     email: string;
     status: Status | null;
-    created_by: ShorthandUser | null;
-}[];
-export type Client = {
+    created_by: UserIdentity;
+};
+export type ClientEntity = {
     mms_id: UUID;
     created_at: Date;
     name: string;
@@ -23,16 +23,16 @@ export type Client = {
     contract_client: boolean;
     contracted_hours: number | null;
     updated_at: Date | null;
-    last_updated_by: ShorthandUser | null;
-    created_by: ShorthandUser | null;
+    last_updated_by: UserIdentity | null;
+    created_by: UserIdentity;
     archived: boolean;
     archived_at: Date | null;
-    archived_by: ShorthandUser | null;
+    archived_by: UserIdentity | null;
     unarchived_at: Date | null;
-    unarchived_by: ShorthandUser | null;
+    unarchived_by: UserIdentity | null;
     deleted: boolean;
     deleted_at: Date | null;
-    deleted_by: ShorthandUser | null;
+    deleted_by: UserIdentity | null;
     restored_at: Date | null;
-    restored_by: ShorthandUser | null;
+    restored_by: UserIdentity | null;
 };

package/dist/users/enum/index.d.ts

@@ -0,0 +1,15 @@
+export declare enum EmploymentType {
+    FULL_TIME = "full_time",
+    PART_TIME = "part_time",
+    CONTRACTOR = "contractor",
+    INTERN = "intern",
+    TEMPORARY = "temporary"
+}
+export declare enum EmergencyContactRelationship {
+    SPOUSE = "spouse",
+    PARENT = "parent",
+    SIBLING = "sibling",
+    FRIEND = "friend",
+    PARTNER = "partner",
+    OTHER = "other"
+}

package/dist/users/index.d.ts

@@ -1,45 +1,12 @@
 import type { UUID } from 'crypto';
-export interface ShorthandUser {
+import { EmergencyContactRelationship, EmploymentType } from './enum';
+export interface UserIdentity {
     mms_id: UUID;
     name: string;
     surname: string;
     email: string;
     profile_image: string | null;
 }
-export interface UserEntity {
-    id: number;
-    mms_id: string;
-    created_at: Date;
-    created_by: string | null;
-    profile_image: string | null;
-    name: string;
-    surname: string;
-    email: string;
-    phone: string;
-    last_logged_in: Date | null;
-    organization_id: UUID;
-    updated_at: Date | null;
-    last_updated_by: string | null;
-    country_code: string | null;
-    manager_id: string | null;
-    active: boolean;
-    start_date: Date;
-    end_date: Date | null;
-    job_title: string | null;
-    employment_type: string;
-    birthday: Date | null;
-    social_facebook: string | null;
-    social_linkedin: string | null;
-    social_twitter: string | null;
-    social_instagram: string | null;
-    social_github: string | null;
-    social_website: string | null;
-    emergency_contact_name: string | null;
-    emergency_contact_relationship: string | null;
-    emergency_contact_phone: string | null;
-    emergency_contact_email: string | null;
-    supporting_files: string[];
-}
 export interface User {
     mms_id: string;
     name: string;
@@ -49,25 +16,25 @@ export interface User {
     profile_image: string | null;
     active: boolean;
     created_at: Date;
-    created_by: ShorthandUser | null;
+    created_by: UserIdentity | null;
     last_logged_in: Date | null;
     country_code: string | null;
     updated_at: Date | null;
-    last_updated_by: ShorthandUser | null;
-    manager: ShorthandUser | null;
+    last_updated_by: UserIdentity | null;
+    manager: UserIdentity | null;
     birthday: Date | null;
-    employment_type: string;
+    employment_type: EmploymentType;
     job_title: string | null;
     start_date: Date;
     end_date: Date | null;
-    social_facebook: string | null;
-    social_linkedin: string | null;
-    social_twitter: string | null;
-    social_instagram: string | null;
-    social_github: string | null;
-    social_website: string | null;
+    social_facebook: URL | null;
+    social_linkedin: URL | null;
+    social_twitter: URL | null;
+    social_instagram: URL | null;
+    social_github: URL | null;
+    social_website: URL | null;
     emergency_contact_name: string | null;
-    emergency_contact_relationship: string | null;
+    emergency_contact_relationship: EmergencyContactRelationship | null;
     emergency_contact_phone: string | null;
     emergency_contact_email: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {
@@ -22,6 +22,7 @@
       "types": "./dist/auth/dto/index.d.ts",
       "default": "./dist/auth/dto/index.js"
     },
+
     "./clients": {
       "types": "./dist/clients/index.d.ts",
       "default": "./dist/clients/index.js"
@@ -30,6 +31,7 @@
       "types": "./dist/clients/dto/index.d.ts",
       "default": "./dist/clients/dto/index.js"
     },
+
     "./status": {
       "types": "./dist/status/index.d.ts",
       "default": "./dist/status/index.js"
@@ -38,6 +40,7 @@
       "types": "./dist/status/dto/index.d.ts",
       "default": "./dist/status/dto/index.js"
     },
+
     "./users": {
       "types": "./dist/users/index.d.ts",
       "default": "./dist/users/index.js"
@@ -45,6 +48,10 @@
     "./users/dto": {
       "types": "./dist/users/dto/index.d.ts",
       "default": "./dist/users/dto/index.js"
+    },
+    "./users/enum": {
+      "types": "./dist/users/enum/index.d.ts",
+      "default": "./dist/users/enum/index.js"
     }
   },
   "scripts": {

package/dist/auth.types.d.ts

@@ -1,4 +0,0 @@
-export type GetTokensResponse = {
-    access_token: string;
-    refresh_token: string;
-};

package/dist/clients.types.d.ts

@@ -1,38 +0,0 @@
-import { UUID } from 'crypto';
-import { ShorthandUser } from './user.types';
-import { Status } from './status.types';
-export type ClientShorthand = {
-    mms_id: UUID;
-    name: string;
-};
-export type ClientList = {
-    mms_id: UUID;
-    created_at: Date;
-    name: string;
-    email: string;
-    status: Status | null;
-    created_by: ShorthandUser | null;
-}[];
-export type Client = {
-    mms_id: UUID;
-    created_at: Date;
-    name: string;
-    email: string;
-    phone: string;
-    status: Status | null;
-    contract_client: boolean;
-    contracted_hours: number | null;
-    updated_at: Date | null;
-    last_updated_by: ShorthandUser | null;
-    created_by: ShorthandUser | null;
-    archived: boolean;
-    archived_at: Date | null;
-    archived_by: ShorthandUser | null;
-    unarchived_at: Date | null;
-    unarchived_by: ShorthandUser | null;
-    deleted: boolean;
-    deleted_at: Date | null;
-    deleted_by: ShorthandUser | null;
-    restored_at: Date | null;
-    restored_by: ShorthandUser | null;
-};

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './user.types';
-export * from './auth.types';
-export * from './clients.types';
-export * from './/status.types';

package/dist/status.types.d.ts

@@ -1,6 +0,0 @@
-import { UUID } from 'crypto';
-export type Status = {
-    mms_id: UUID;
-    label: string;
-    colour: string;
-};

package/dist/user.types.d.ts

@@ -1,174 +0,0 @@
-import type { UUID } from 'crypto';
-export interface ShorthandUser {
-    mms_id: UUID;
-    name: string;
-    surname: string;
-    email: string;
-    profile_image: string | null;
-}
-export interface UserEntity {
-    id: number;
-    mms_id: string;
-    created_at: Date;
-    created_by: string | null;
-    profile_image: string | null;
-    name: string;
-    surname: string;
-    email: string;
-    phone: string;
-    last_logged_in: Date | null;
-    organization_id: UUID;
-    updated_at: Date | null;
-    last_updated_by: string | null;
-    country_code: string | null;
-    manager_id: string | null;
-    active: boolean;
-    start_date: Date;
-    end_date: Date | null;
-    job_title: string | null;
-    employment_type: string;
-    birthday: Date | null;
-    social_facebook: string | null;
-    social_linkedin: string | null;
-    social_twitter: string | null;
-    social_instagram: string | null;
-    social_github: string | null;
-    social_website: string | null;
-    emergency_contact_name: string | null;
-    emergency_contact_relationship: string | null;
-    emergency_contact_phone: string | null;
-    emergency_contact_email: string | null;
-    supporting_files: string[];
-}
-export interface User {
-    mms_id: string;
-    name: string;
-    surname: string;
-    email: string;
-    phone: string;
-    profile_image: string | null;
-    active: boolean;
-    created_at: Date;
-    created_by: ShorthandUser | null;
-    last_logged_in: Date | null;
-    country_code: string | null;
-    updated_at: Date | null;
-    last_updated_by: ShorthandUser | null;
-    manager: ShorthandUser | null;
-    birthday: Date | null;
-    employment_type: string;
-    job_title: string | null;
-    start_date: Date;
-    end_date: Date | null;
-    social_facebook: string | null;
-    social_linkedin: string | null;
-    social_twitter: string | null;
-    social_instagram: string | null;
-    social_github: string | null;
-    social_website: string | null;
-    emergency_contact_name: string | null;
-    emergency_contact_relationship: string | null;
-    emergency_contact_phone: string | null;
-    emergency_contact_email: string | null;
-}
-export interface CrudPermission {
-    read: boolean;
-    create: boolean;
-    update: boolean;
-    delete: boolean;
-}
-export interface PermissionsEntity {
-    id: number;
-    mms_id: string;
-    user_id: string;
-    organization_id: string;
-    is_admin: boolean;
-    is_owner: boolean;
-    view_dashboard: boolean;
-    create_clients: boolean;
-    read_clients: boolean;
-    update_clients: boolean;
-    delete_clients: boolean;
-    create_projects: boolean;
-    read_projects: boolean;
-    update_projects: boolean;
-    delete_projects: boolean;
-    create_budgets: boolean;
-    read_budgets: boolean;
-    update_budgets: boolean;
-    delete_budgets: boolean;
-    create_tasks: boolean;
-    read_tasks: boolean;
-    update_tasks: boolean;
-    delete_tasks: boolean;
-    create_timesheets: boolean;
-    read_timesheets: boolean;
-    update_timesheets: boolean;
-    delete_timesheets: boolean;
-    create_documents: boolean;
-    read_docuemnts: boolean;
-    update_documents: boolean;
-    delete_documents: boolean;
-    create_leave: boolean;
-    read_leave: boolean;
-    update_leave: boolean;
-    delete_leave: boolean;
-    create_leave_types: boolean;
-    read_leave_types: boolean;
-    update_leave_types: boolean;
-    delete_leave_types: boolean;
-    create_leave_requests: boolean;
-    read_leave_requests: boolean;
-    update_leave_requests: boolean;
-    delete_leave_requests: boolean;
-    create_invoices: boolean;
-    read_invoices: boolean;
-    update_invoices: boolean;
-    delete_invoices: boolean;
-    create_users: boolean;
-    read_users: boolean;
-    update_users: boolean;
-    delete_users: boolean;
-    create_user_permissions: boolean;
-    read_user_permissions: boolean;
-    update_user_permissions: boolean;
-    delete_user_permissions: boolean;
-    create_organizations: boolean;
-    read_organizations: boolean;
-    update_organizations: boolean;
-    delete_organizations: boolean;
-    create_payments: boolean;
-    read_payments: boolean;
-    update_payments: boolean;
-    delete_payments: boolean;
-    create_notifications: boolean;
-    read_notifications: boolean;
-    update_notifications: boolean;
-    delete_notifications: boolean;
-    create_subscriptions: boolean;
-    read_subscriptions: boolean;
-    update_subscriptions: boolean;
-    delete_subscriptions: boolean;
-}
-export interface Permissions {
-    permissions: {
-        dashboard: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
-        clients: CrudPermission;
-        projects: CrudPermission;
-        project_budgets: CrudPermission;
-        tasks: CrudPermission;
-        invoices: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
-        users: CrudPermission;
-        user_permissions: Omit<CrudPermission, 'create' | 'delete'>;
-        organization: Omit<CrudPermission, 'create' | 'delete'>;
-        subscription: Omit<CrudPermission, 'read' | 'create' | 'delete'>;
-        payments: Omit<CrudPermission, 'read' | 'update' | 'delete'>;
-    };
-    roles: {
-        admin: boolean;
-        owner: boolean;
-    };
-}
-export interface LoggedInUser extends User, Permissions {
-    alerts: Record<string, boolean>;
-}