@managemint-solutions/entities 1.35.0 → 1.36.0

package/dist/audit-trail/enum/index.d.ts

@@ -27,7 +27,8 @@ export declare enum AuditTrailEntityType {
     LEAVE_ADJUSTMENTS = "leave_adjustments",
     BILLING_TRANSACTIONS = "billing_transactions",
     INVOICE = "invoices",
-    NOTIFICATION = "notifications"
+    NOTIFICATION = "notifications",
+    USER_API_CREDENTIAL = "user_api_credentials"
 }
 export declare enum AuditTrailChangeType {
     TEXT = "text",

package/dist/audit-trail/enum/index.js

@@ -33,6 +33,7 @@ var AuditTrailEntityType;
     AuditTrailEntityType["BILLING_TRANSACTIONS"] = "billing_transactions";
     AuditTrailEntityType["INVOICE"] = "invoices";
     AuditTrailEntityType["NOTIFICATION"] = "notifications";
+    AuditTrailEntityType["USER_API_CREDENTIAL"] = "user_api_credentials";
 })(AuditTrailEntityType || (exports.AuditTrailEntityType = AuditTrailEntityType = {}));
 var AuditTrailChangeType;
 (function (AuditTrailChangeType) {

package/dist/clients/dto/index.d.ts

@@ -8,6 +8,10 @@ export type GetClientsDto = {
     status_id_in?: string | null;
     archive: boolean;
 };
+/** A staff read across organizations, optionally narrowed to one of them. */
+export type StaffGetClientsDto = GetClientsDto & {
+    organization_id?: string | null;
+};
 export type ClientIdDto = {
     clientId: string;
 };

package/dist/clients/index.d.ts

@@ -1,6 +1,7 @@
 import type { UUID } from 'crypto';
 import { UserIdentity } from '../users';
 import { StatusEntity } from '../status';
+import type { OrganizationIdentity } from '../organization';
 export type ClientIdentity = {
     mms_id: UUID;
     name: string;
@@ -12,6 +13,8 @@ export type ClientSummary = {
     email: string;
     status: StatusEntity | null;
     created_by: UserIdentity;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };
 export type ClientEntity = {
     mms_id: UUID;

package/dist/leads/dto/index.d.ts

@@ -11,6 +11,10 @@ export type GetLeadsDto = {
     completed?: boolean | null;
     archive: boolean;
 };
+/** A staff read across organizations, optionally narrowed to one of them. */
+export type StaffGetLeadsDto = GetLeadsDto & {
+    organization_id?: string | null;
+};
 export type LeadIdDto = {
     leadId: string;
 };

package/dist/leads/index.d.ts

@@ -3,6 +3,7 @@ import { ClientIdentity } from '../clients';
 import { StatusEntity } from '../status';
 import { UserIdentity } from '../users';
 import { LeadSource } from './enum';
+import type { OrganizationIdentity } from '../organization';
 export type LeadIdentity = {
     mms_id: UUID;
     name: string;
@@ -21,6 +22,8 @@ export type LeadSummary = {
     /** A date (YYYY-MM-DD) to follow the lead up; null when none is set. */
     follow_up_date: string | null;
     created_by: UserIdentity;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };
 /**
  * A prospective client. Converting it creates a client from its data, moves its notes,

package/dist/organization/dto/index.d.ts

@@ -63,3 +63,12 @@ export type UpdateOrganizationDto = {
     /** The month (1-12) the leave year starts on; shapes entitlements created after the change. */
     leave_calendar_start_month?: number;
 };
+export type OrganizationIdDto = {
+    organizationId: string;
+};
+/** The staff list of every organization. `search` matches name, trading name and email. */
+export type GetOrganizationsDto = {
+    search?: string | null;
+    page: number;
+    page_size: number;
+};

package/dist/organization/index.d.ts

@@ -3,6 +3,23 @@ import { PricebookWithModules, PricedModule } from '../modules/index';
 import { UserIdentity } from '../users';
 import { BillingStatus } from '../billing/enum';
 import { PaymentFrequency } from './enum';
+/** Which organization a row belongs to, as a staff read across organizations shows it. */
+export type OrganizationIdentity = {
+    mms_id: UUID;
+    name: string;
+};
+/** An organization as the staff list shows it. `modules` holds the module keys it owns. */
+export type OrganizationSummary = {
+    mms_id: UUID;
+    created_at: Date;
+    name: string;
+    trading_name: string;
+    email: string;
+    billing_status: BillingStatus;
+    active_seat_count: number;
+    paid_seat_count: number;
+    modules: string[];
+};
 export type OrganizationEntity = {
     mms_id: UUID;
     created_at: Date;

package/dist/projects/dto/index.d.ts

@@ -17,6 +17,10 @@ export type GetProjectsDto = {
     client_id?: string | null;
     archive: boolean;
 };
+/** A staff read across organizations, optionally narrowed to one of them. */
+export type StaffGetProjectsDto = GetProjectsDto & {
+    organization_id?: string | null;
+};
 export type CreateProjectDto = {
     name: string;
     specification?: string | null;

package/dist/projects/index.d.ts

@@ -2,6 +2,7 @@ import { UUID } from "crypto";
 import { UserIdentity } from "../users";
 import { ClientIdentity } from "../clients";
 import { StatusEntity } from "../status";
+import type { OrganizationIdentity } from "../organization";
 export type ProjectIdentity = {
     mms_id: UUID;
     name: string;
@@ -16,6 +17,8 @@ export type ProjectSummary = {
     status: StatusEntity | null;
     manager: UserIdentity | null;
     client: ClientIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };
 export type ProjectEntity = {
     mms_id: UUID;

package/dist/staff/dto/index.d.ts

@@ -0,0 +1,13 @@
+import type { UpdatePermissionsDto } from '../../users/permissions/dto';
+export type CreateStaffDto = {
+    email: string;
+    name: string;
+    password: string;
+};
+export type UpdateStaffPermissionsDto = UpdatePermissionsDto & {
+    is_admin: boolean;
+    view_dashboard: boolean;
+};
+export type StaffIdDto = {
+    staffId: string;
+};

package/dist/staff/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/staff/index.d.ts

@@ -0,0 +1,22 @@
+import type { UUID } from 'crypto';
+import type { PermissionsEntity } from '../users';
+/** A ManageMint Solutions employee. `mms_id` is their auth user id. */
+export type StaffEntity = {
+    mms_id: UUID;
+    email: string;
+    name: string;
+    active: boolean;
+    created_at: Date;
+    created_by: UUID | null;
+    deactivated_at: Date | null;
+    deactivated_by: UUID | null;
+};
+/** A staff member's flags: a tenant permissions row with no organization and no owner. */
+export type StaffPermissionsEntity = Omit<PermissionsEntity, 'user_id' | 'organization_id' | 'is_owner'> & {
+    staff_id: UUID;
+};
+/** A staff member with their flags: the signed-in one (`/staff/me`) or any other (`/staff/:staffId`). */
+export type StaffDetail = {
+    staff: StaffEntity;
+    permissions: StaffPermissionsEntity;
+};

package/dist/staff/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tasks/dto/index.d.ts

@@ -30,6 +30,10 @@ export type GetTasksDto = {
     label_id_in?: string | null;
     archive: boolean;
 };
+/** A staff read across organizations, optionally narrowed to one of them. */
+export type StaffGetTasksDto = GetTasksDto & {
+    organization_id?: string | null;
+};
 export type CreateTaskDto = {
     name: string;
     description?: string | null;

package/dist/tasks/index.d.ts

@@ -3,6 +3,7 @@ import { LabelEntity } from "../labels";
 import { ProjectIdentity } from "../projects";
 import { StatusEntity } from "../status";
 import { UserIdentity } from "../users";
+import type { OrganizationIdentity } from "../organization";
 export type TaskIdentity = {
     mms_id: string;
     name: string;
@@ -32,6 +33,8 @@ export type TaskSummary = {
     assigned_to: UserIdentity | null;
     project: ProjectIdentity | null;
     client: ClientIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };
 export type TaskEntity = {
     mms_id: string;

package/dist/user-api-credentials/dto/index.d.ts

@@ -0,0 +1,12 @@
+export type CreateUserApiCredentialDto = {
+    label: string;
+    /** ISO 8601; null or omitted never expires. */
+    expires_at?: string | null;
+};
+export type MintEmulationTokenDto = {
+    client_id: string;
+    client_secret: string;
+};
+export type UserApiCredentialIdDto = {
+    credentialId: string;
+};

package/dist/user-api-credentials/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/user-api-credentials/index.d.ts

@@ -0,0 +1,33 @@
+import type { UUID } from 'crypto';
+/**
+ * A client id and secret staff issue for one user: exchanging them mints an access token that
+ * acts as that user. The secret is stored as a hash and never read back.
+ */
+export type UserApiCredentialEntity = {
+    mms_id: UUID;
+    user_id: UUID;
+    organization_id: UUID;
+    client_id: string;
+    label: string;
+    created_at: Date;
+    /** The staff member who issued it. */
+    created_by: UUID;
+    expires_at: Date | null;
+    revoked_at: Date | null;
+    revoked_by: UUID | null;
+    last_used_at: Date | null;
+};
+/** The credential as it is issued: the only time the secret is ever shown. */
+export type CreatedUserApiCredential = UserApiCredentialEntity & {
+    client_secret: string;
+};
+/** A short-lived access token for the credential's user, marked as emulated. */
+export type MintEmulationTokenResponse = {
+    access_token: string;
+    token_type: 'Bearer';
+    expires_at: string;
+    user: {
+        mms_id: UUID;
+        organization_id: UUID;
+    };
+};

package/dist/user-api-credentials/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -11,6 +11,10 @@ export type GetUsersDto = {
     /** A manager's team: everyone naming this user as their manager or second manager. */
     manager_id?: string | null;
 };
+/** A staff read across organizations, optionally narrowed to one of them. */
+export type StaffGetUsersDto = GetUsersDto & {
+    organization_id?: string | null;
+};
 export type CreateUserDto = {
     email: string;
     password: string;

package/dist/users/index.d.ts

@@ -1,5 +1,6 @@
 import type { UUID } from 'crypto';
 import { EmergencyContactRelationship, EmploymentType } from './enum';
+import type { OrganizationIdentity } from '../organization';
 export interface UserIdentity {
     mms_id: UUID;
     name: string;
@@ -16,6 +17,8 @@ export interface UserSummary {
     active: boolean;
     created_at: Date;
     last_logged_in: Date | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 }
 export interface UserEntity {
     mms_id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.35.0",
+  "version": "1.36.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {