@feedmepos/mf-hrm-portal 2.3.1 → 2.3.3-dev

package/dist/src/types/staff-invite.d.ts

@@ -0,0 +1,100 @@
+import type { FdoPermissionRule } from '@feedmepos/core/entity';
+import type { IFdtoPermissionPosUser } from '@/types/team';
+/** Wire contract: account-service-zus-lark-sso/part-b-contract.md §2.2. */
+export type StaffInviteMatch = 'mobile' | 'email';
+export type StaffInviteWarning = 'not_in_org' | 'dm_unavailable' | 'dm_failed';
+export declare const STAFF_INVITE_ERROR_CODES: readonly ["provider_unavailable", "key_mismatch", "key_required", "invalid_key", "invalid_contact", "already_member", "ambiguous_account", "invite_exists", "not_pending"];
+export type StaffInviteErrorCode = (typeof STAFF_INVITE_ERROR_CODES)[number];
+export type StaffInvitePosUser = IFdtoPermissionPosUser | null;
+export type StaffInviteDmStatus = 'sent' | 'not_in_org' | 'unsupported' | 'failed';
+export interface IFdtoStaffInviteProvider {
+    slug: string;
+    label: string;
+    type: string;
+    inviteMatch: StaffInviteMatch;
+}
+export interface IFdtoStaffInviteGrant {
+    permissions: FdoPermissionRule[];
+    customPermissions: FdoPermissionRule[];
+    permissionSetIds: string[];
+    posUser: StaffInvitePosUser;
+}
+export interface IFdtoStaffInvite {
+    _id: string;
+    businessId: string;
+    provider: string;
+    match: StaffInviteMatch;
+    mobile?: string;
+    email?: string;
+    /** The other way to reach them; never matched on. */
+    contact?: {
+        mobile?: string;
+        email?: string;
+    };
+    displayName?: string;
+    employeeId?: string | null;
+    grant: IFdtoStaffInviteGrant;
+    status: 'pending' | 'claiming' | 'claimed' | 'revoked';
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+    claimedBy?: string;
+    claimedAt?: string;
+    claimOutcome?: 'granted' | 'already_member' | 'granted_without_pos';
+    posConflict?: {
+        restaurantId: string;
+        reason: 'passcode_taken';
+    }[];
+    dm?: {
+        status: StaffInviteDmStatus;
+        at: string;
+    };
+    revokedBy?: string;
+    revokedAt?: string;
+}
+export interface IFdtoCreateStaffInviteReq {
+    provider: string;
+    /** The sign-in key; the other of mobile/email is contact only. */
+    match: StaffInviteMatch;
+    mobile?: string;
+    email?: string;
+    displayName: string;
+    employeeId?: string;
+    permissions: FdoPermissionRule[];
+    customPermissions: FdoPermissionRule[];
+    permissionSetIds?: string[];
+    posUser?: StaffInvitePosUser;
+}
+/** The key is fixed: only the mobile/email that isn't the key applies ('' clears it). */
+export type IFdtoUpdateStaffInviteReq = Omit<IFdtoCreateStaffInviteReq, 'provider' | 'match'>;
+/** Who already answers to a sign-in key: a member, or an open invite. */
+export type IFdtoStaffInviteLookup = {
+    kind: 'member';
+    id: string;
+    name: string;
+    restaurantCount: number;
+    isOwner: boolean;
+} | {
+    kind: 'invite';
+    id: string;
+    name: string;
+    restaurantCount: number;
+    invite: IFdtoStaffInvite;
+};
+export type IFdtoCreateStaffInviteRes = {
+    result: 'added';
+    uid: string;
+    portalUserId: string;
+    warnings: StaffInviteWarning[];
+} | {
+    result: 'invited';
+    invite: IFdtoStaffInvite;
+    warnings: StaffInviteWarning[];
+};
+export interface IFdtoResendStaffInviteRes {
+    dm: {
+        status: StaffInviteDmStatus;
+        at: string;
+    };
+    warnings: StaffInviteWarning[];
+}

package/dist/src/types/team.d.ts

@@ -19,7 +19,12 @@ export interface IFdtoPortalUser extends IPermissionUser {
     phoneNumber: string;
     email: string;
     posUser?: IFdtoPermissionPosUser;
+    employeeId?: string | null;
+    loginMethod: TeamMemberLoginMethod;
+    status: TeamMemberStatus;
 }
+export type TeamMemberStatus = 'active' | 'invited';
+export type TeamMemberLoginMethod = 'sso' | 'feedme';
 export interface IFdtoPortalUserPage {
     items: IFdtoPortalUser[];
     total: number;
@@ -34,10 +39,16 @@ export interface IFdtoPermissionPosUserRole {
     restaurantId: string;
     roleId: string;
 }
+/** On a member edit `passcode` is sent only when the admin changed it; absent keeps the stored one. */
+export type IFdtoUpdatePermissionPosUser = Omit<IFdtoPermissionPosUser, 'passcode'> & {
+    passcode?: string;
+};
 export interface IFdtoUpdatePortalUserReq {
+    /** Absent keeps the stored one; '' clears it. */
+    employeeId?: string;
     /** @deprecated use customPermissions instead */
     permissions?: FdoPermissionRule[];
-    posUser?: IFdtoPermissionPosUser | null;
+    posUser?: IFdtoUpdatePermissionPosUser | null;
     permissionSetIds?: string[];
     customPermissions?: FdoPermissionRule[];
 }
@@ -49,6 +60,7 @@ export interface IFdtoCreatePortalUserReq {
     permissionSetIds?: string[];
     customPermissions: FdoPermissionRule[];
     name?: string;
+    employeeId?: string;
     posUser?: IFdtoPermissionPosUser | null;
 }
 export interface FTeamMember {
@@ -60,6 +72,8 @@ export interface FTeamMember {
     managableRestaurantIds: string[] | null;
     permissions: FdoPermissionRule[];
     permissionLabels: string[];
+    status: TeamMemberStatus;
+    loginMethod: TeamMemberLoginMethod;
     doc: IFdtoPortalUser;
 }
 export interface IReadTeamMembersPageReq {
@@ -69,6 +83,8 @@ export interface IReadTeamMembersPageReq {
     restaurantIds?: string[];
     permissionSubjects?: string[];
     permissionSetIds?: string[];
+    statuses?: TeamMemberStatus[];
+    loginMethods?: TeamMemberLoginMethod[];
 }
 export interface IFdtoTeamMemberPage {
     items: FTeamMember[];

package/dist/src/views/audit-log/constants.d.ts

@@ -1,9 +1,30 @@
-export interface AuditLogModuleTab {
-    key: 'all' | 'inventory' | 'report' | 'hrm' | 'payment' | 'menu' | 'crm' | 'pos';
-    label: string;
-    /** Portal modules filter by subject namespace. */
-    subjectPrefixes: string[];
-    /** Row origins the tab selects; the POS tab filters by origin instead of subject. */
-    sources?: string[];
-}
-export declare const AUDIT_LOG_MODULE_TABS: readonly AuditLogModuleTab[];
+export declare const AUDIT_LOG_MODULE_TABS: readonly [{
+    readonly key: "all";
+    readonly label: "All";
+    readonly subjectPrefixes: string[];
+}, {
+    readonly key: "inventory";
+    readonly label: "Inventory";
+    readonly subjectPrefixes: readonly ["business::inventory", "inventory"];
+}, {
+    readonly key: "report";
+    readonly label: "Report";
+    readonly subjectPrefixes: readonly ["business::report", "report"];
+}, {
+    readonly key: "hrm";
+    readonly label: "HRM";
+    readonly subjectPrefixes: readonly ["business::hrm", "hrm"];
+}, {
+    readonly key: "payment";
+    readonly label: "Payment";
+    readonly subjectPrefixes: readonly ["business::payment", "payment"];
+}, {
+    readonly key: "menu";
+    readonly label: "Menu";
+    readonly subjectPrefixes: readonly ["business::menu", "menu"];
+}, {
+    readonly key: "crm";
+    readonly label: "CRM";
+    readonly subjectPrefixes: readonly ["business::crm", "crm"];
+}];
+export type AuditLogModuleTab = (typeof AUDIT_LOG_MODULE_TABS)[number];