@n8n/stores 2.32.2 → 2.34.0

package/dist/users.store.d.cts

@@ -0,0 +1,552 @@
+import { t as IInviteResponse } from "./invitation2.api.cjs";
+import { t as ModalOpeners } from "./modalOpeners2.cjs";
+import * as vue323 from "vue";
+import * as pinia5 from "pinia";
+import { LoginRequestDto, PasswordUpdateRequestDto, SettingsUpdateRequestDto, User, UserSelfSettingsUpdateRequestDto, UserUpdateRequestDto, UsersListFilterDto } from "@n8n/api-types";
+import { AssignableGlobalRole } from "@n8n/permissions";
+import { CurrentUserResponse, IPersonalizationLatestVersion, IUser, IUserResponse, UpdateGlobalRolePayload } from "@n8n/rest-api-client/api/users";
+import * as _vueuse_core2 from "@vueuse/core";
+import * as zod0 from "zod";
+import * as mfaApi from "@n8n/rest-api-client/api/mfa";
+
+//#region src/users.store.d.ts
+type LoginHook = (user: CurrentUserResponse) => void | Promise<void>;
+type LogoutHook = () => void | Promise<void>;
+declare const useUsersStore: pinia5.StoreDefinition<"users", Pick<{
+  initialized: vue323.Ref<boolean, boolean>;
+  currentUserId: vue323.Ref<string | null, string | null>;
+  usersById: vue323.Ref<Record<string, IUser>, Record<string, IUser>>;
+  allUsers: vue323.ComputedRef<IUser[]>;
+  currentUser: vue323.ComputedRef<IUser | null>;
+  userActivated: vue323.ComputedRef<boolean>;
+  isDefaultUser: vue323.ComputedRef<boolean>;
+  isInstanceOwner: vue323.ComputedRef<boolean>;
+  isAdmin: vue323.ComputedRef<boolean>;
+  isAdminOrOwner: vue323.ComputedRef<boolean>;
+  mfaEnabled: vue323.ComputedRef<boolean>;
+  globalRoleName: vue323.ComputedRef<string>;
+  userClaimedAiCredits: vue323.ComputedRef<boolean | undefined>;
+  isEasyAIWorkflowOnboardingDone: vue323.ComputedRef<boolean>;
+  canUserUpdateVersion: vue323.ComputedRef<boolean>;
+  usersLimitNotReached: vue323.ComputedRef<boolean>;
+  addUsers: (newUsers: User[]) => void;
+  loginWithCookie: () => Promise<void>;
+  initialize: () => Promise<void>;
+  setPersonalizationAnswers: (answers: IPersonalizationLatestVersion) => void;
+  loginWithCreds: (params: LoginRequestDto) => Promise<void>;
+  logout: (options?: {
+    viaOidc?: boolean;
+  }) => Promise<{
+    redirectUrl: string | null;
+  }>;
+  registerLoginHook: (hook: LoginHook) => void;
+  registerLogoutHook: (hook: LogoutHook) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  setPermissionsResolvers: (resolvers: {
+    listUsers: () => boolean;
+  }) => void;
+  createOwner: (params: {
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+  }) => Promise<void>;
+  validateSignupToken: (params: {
+    token: string;
+  }) => Promise<{
+    inviter: {
+      firstName: string;
+      lastName: string;
+    };
+  }>;
+  acceptInvitation: (params: {
+    token: string;
+    firstName: string;
+    lastName: string;
+    password: string;
+  }) => Promise<void>;
+  sendForgotPasswordEmail: (params: {
+    email: string;
+  }) => Promise<void>;
+  validatePasswordToken: (params: {
+    token: string;
+  }) => Promise<void>;
+  changePassword: (params: {
+    token: string;
+    password: string;
+    mfaCode?: string;
+  }) => Promise<void>;
+  updateUser: (params: UserUpdateRequestDto) => Promise<IUserResponse>;
+  updateUserName: (params: {
+    firstName: string;
+    lastName: string;
+  }) => Promise<IUserResponse | undefined>;
+  updateUserSettings: (settings: UserSelfSettingsUpdateRequestDto) => Promise<void>;
+  updateOtherUserSettings: (userId: string, settings: SettingsUpdateRequestDto) => Promise<void>;
+  updateCurrentUserPassword: (params: PasswordUpdateRequestDto) => Promise<void>;
+  deleteUser: (params: {
+    id: string;
+    transferId?: string;
+  }) => Promise<void>;
+  fetchUsers: ({
+    take,
+    skip,
+    filter
+  }?: {
+    take?: number;
+    skip?: number;
+    filter?: UsersListFilterDto["filter"];
+  }) => Promise<void>;
+  inviteUsers: (params: Array<{
+    email: string;
+    role: AssignableGlobalRole;
+  }>) => Promise<IInviteResponse[]>;
+  reinviteUser: ({
+    email,
+    role
+  }: {
+    email: string;
+    role: AssignableGlobalRole;
+  }) => Promise<void>;
+  getUserPasswordResetLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  generateInviteLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  submitPersonalizationSurvey: (results: IPersonalizationLatestVersion) => Promise<void>;
+  showPersonalizationSurvey: () => void;
+  fetchMfaQR: () => Promise<{
+    qrCode: string;
+    secret: string;
+    recoveryCodes: string[];
+  }>;
+  verifyMfaCode: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  enableMfa: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  disableMfa: (data: mfaApi.DisableMfaParams) => Promise<void>;
+  updateEnforceMfa: (enforce: boolean) => Promise<void>;
+  canEnableMFA: () => Promise<unknown>;
+  sendConfirmationEmail: () => Promise<void>;
+  updateGlobalRole: ({
+    id,
+    newRoleName
+  }: UpdateGlobalRolePayload) => Promise<void>;
+  setEasyAIWorkflowOnboardingDone: () => void;
+  isCalloutDismissed: (callout: string) => boolean;
+  setCalloutDismissed: (callout: string) => void;
+  submitContactEmail: (email: string, agree: boolean) => Promise<string | null>;
+  setUserQuota: (quota?: number) => void;
+  usersList: _vueuse_core2.UseAsyncStateReturn<{
+    count: number;
+    items: {
+      id: string;
+      firstName?: string | null | undefined;
+      lastName?: string | null | undefined;
+      email?: string | null | undefined;
+      role?: string | undefined;
+      isPending?: boolean | undefined;
+      isOwner?: boolean | undefined;
+      signInType?: string | undefined;
+      settings?: {
+        isOnboarded?: boolean | undefined;
+        firstSuccessfulWorkflowId?: string | undefined;
+        userActivated?: boolean | undefined;
+        userActivatedAt?: number | undefined;
+        allowSSOManualLogin?: boolean | undefined;
+        npsSurvey?: {
+          lastShownAt: number;
+          responded: true;
+        } | {
+          lastShownAt: number;
+          waitingForResponse: true;
+          ignoredCount: number;
+        } | undefined;
+        easyAIWorkflowOnboarded?: boolean | undefined;
+        userClaimedAiCredits?: boolean | undefined;
+        dismissedCallouts?: Record<string, boolean> | undefined;
+      } | null | undefined;
+      personalizationAnswers?: zod0.objectOutputType<{}, zod0.ZodTypeAny, "passthrough"> | null | undefined;
+      projectRelations?: {
+        id: string;
+        role: string;
+        name: string;
+        icon?: {
+          type: "emoji" | "icon";
+          value: string;
+          color?: string | undefined;
+        } | null | undefined;
+      }[] | null | undefined;
+      mfaEnabled?: boolean | undefined;
+      lastActiveAt?: string | null | undefined;
+      inviteAcceptUrl?: string | undefined;
+      isManagedByEnv?: boolean | undefined;
+    }[];
+  }, [filter?: UsersListFilterDto | undefined], true>;
+}, "initialized" | "currentUserId" | "usersById" | "usersList">, Pick<{
+  initialized: vue323.Ref<boolean, boolean>;
+  currentUserId: vue323.Ref<string | null, string | null>;
+  usersById: vue323.Ref<Record<string, IUser>, Record<string, IUser>>;
+  allUsers: vue323.ComputedRef<IUser[]>;
+  currentUser: vue323.ComputedRef<IUser | null>;
+  userActivated: vue323.ComputedRef<boolean>;
+  isDefaultUser: vue323.ComputedRef<boolean>;
+  isInstanceOwner: vue323.ComputedRef<boolean>;
+  isAdmin: vue323.ComputedRef<boolean>;
+  isAdminOrOwner: vue323.ComputedRef<boolean>;
+  mfaEnabled: vue323.ComputedRef<boolean>;
+  globalRoleName: vue323.ComputedRef<string>;
+  userClaimedAiCredits: vue323.ComputedRef<boolean | undefined>;
+  isEasyAIWorkflowOnboardingDone: vue323.ComputedRef<boolean>;
+  canUserUpdateVersion: vue323.ComputedRef<boolean>;
+  usersLimitNotReached: vue323.ComputedRef<boolean>;
+  addUsers: (newUsers: User[]) => void;
+  loginWithCookie: () => Promise<void>;
+  initialize: () => Promise<void>;
+  setPersonalizationAnswers: (answers: IPersonalizationLatestVersion) => void;
+  loginWithCreds: (params: LoginRequestDto) => Promise<void>;
+  logout: (options?: {
+    viaOidc?: boolean;
+  }) => Promise<{
+    redirectUrl: string | null;
+  }>;
+  registerLoginHook: (hook: LoginHook) => void;
+  registerLogoutHook: (hook: LogoutHook) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  setPermissionsResolvers: (resolvers: {
+    listUsers: () => boolean;
+  }) => void;
+  createOwner: (params: {
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+  }) => Promise<void>;
+  validateSignupToken: (params: {
+    token: string;
+  }) => Promise<{
+    inviter: {
+      firstName: string;
+      lastName: string;
+    };
+  }>;
+  acceptInvitation: (params: {
+    token: string;
+    firstName: string;
+    lastName: string;
+    password: string;
+  }) => Promise<void>;
+  sendForgotPasswordEmail: (params: {
+    email: string;
+  }) => Promise<void>;
+  validatePasswordToken: (params: {
+    token: string;
+  }) => Promise<void>;
+  changePassword: (params: {
+    token: string;
+    password: string;
+    mfaCode?: string;
+  }) => Promise<void>;
+  updateUser: (params: UserUpdateRequestDto) => Promise<IUserResponse>;
+  updateUserName: (params: {
+    firstName: string;
+    lastName: string;
+  }) => Promise<IUserResponse | undefined>;
+  updateUserSettings: (settings: UserSelfSettingsUpdateRequestDto) => Promise<void>;
+  updateOtherUserSettings: (userId: string, settings: SettingsUpdateRequestDto) => Promise<void>;
+  updateCurrentUserPassword: (params: PasswordUpdateRequestDto) => Promise<void>;
+  deleteUser: (params: {
+    id: string;
+    transferId?: string;
+  }) => Promise<void>;
+  fetchUsers: ({
+    take,
+    skip,
+    filter
+  }?: {
+    take?: number;
+    skip?: number;
+    filter?: UsersListFilterDto["filter"];
+  }) => Promise<void>;
+  inviteUsers: (params: Array<{
+    email: string;
+    role: AssignableGlobalRole;
+  }>) => Promise<IInviteResponse[]>;
+  reinviteUser: ({
+    email,
+    role
+  }: {
+    email: string;
+    role: AssignableGlobalRole;
+  }) => Promise<void>;
+  getUserPasswordResetLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  generateInviteLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  submitPersonalizationSurvey: (results: IPersonalizationLatestVersion) => Promise<void>;
+  showPersonalizationSurvey: () => void;
+  fetchMfaQR: () => Promise<{
+    qrCode: string;
+    secret: string;
+    recoveryCodes: string[];
+  }>;
+  verifyMfaCode: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  enableMfa: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  disableMfa: (data: mfaApi.DisableMfaParams) => Promise<void>;
+  updateEnforceMfa: (enforce: boolean) => Promise<void>;
+  canEnableMFA: () => Promise<unknown>;
+  sendConfirmationEmail: () => Promise<void>;
+  updateGlobalRole: ({
+    id,
+    newRoleName
+  }: UpdateGlobalRolePayload) => Promise<void>;
+  setEasyAIWorkflowOnboardingDone: () => void;
+  isCalloutDismissed: (callout: string) => boolean;
+  setCalloutDismissed: (callout: string) => void;
+  submitContactEmail: (email: string, agree: boolean) => Promise<string | null>;
+  setUserQuota: (quota?: number) => void;
+  usersList: _vueuse_core2.UseAsyncStateReturn<{
+    count: number;
+    items: {
+      id: string;
+      firstName?: string | null | undefined;
+      lastName?: string | null | undefined;
+      email?: string | null | undefined;
+      role?: string | undefined;
+      isPending?: boolean | undefined;
+      isOwner?: boolean | undefined;
+      signInType?: string | undefined;
+      settings?: {
+        isOnboarded?: boolean | undefined;
+        firstSuccessfulWorkflowId?: string | undefined;
+        userActivated?: boolean | undefined;
+        userActivatedAt?: number | undefined;
+        allowSSOManualLogin?: boolean | undefined;
+        npsSurvey?: {
+          lastShownAt: number;
+          responded: true;
+        } | {
+          lastShownAt: number;
+          waitingForResponse: true;
+          ignoredCount: number;
+        } | undefined;
+        easyAIWorkflowOnboarded?: boolean | undefined;
+        userClaimedAiCredits?: boolean | undefined;
+        dismissedCallouts?: Record<string, boolean> | undefined;
+      } | null | undefined;
+      personalizationAnswers?: zod0.objectOutputType<{}, zod0.ZodTypeAny, "passthrough"> | null | undefined;
+      projectRelations?: {
+        id: string;
+        role: string;
+        name: string;
+        icon?: {
+          type: "emoji" | "icon";
+          value: string;
+          color?: string | undefined;
+        } | null | undefined;
+      }[] | null | undefined;
+      mfaEnabled?: boolean | undefined;
+      lastActiveAt?: string | null | undefined;
+      inviteAcceptUrl?: string | undefined;
+      isManagedByEnv?: boolean | undefined;
+    }[];
+  }, [filter?: UsersListFilterDto | undefined], true>;
+}, "allUsers" | "currentUser" | "userActivated" | "isDefaultUser" | "isInstanceOwner" | "isAdmin" | "isAdminOrOwner" | "mfaEnabled" | "globalRoleName" | "userClaimedAiCredits" | "isEasyAIWorkflowOnboardingDone" | "canUserUpdateVersion" | "usersLimitNotReached">, Pick<{
+  initialized: vue323.Ref<boolean, boolean>;
+  currentUserId: vue323.Ref<string | null, string | null>;
+  usersById: vue323.Ref<Record<string, IUser>, Record<string, IUser>>;
+  allUsers: vue323.ComputedRef<IUser[]>;
+  currentUser: vue323.ComputedRef<IUser | null>;
+  userActivated: vue323.ComputedRef<boolean>;
+  isDefaultUser: vue323.ComputedRef<boolean>;
+  isInstanceOwner: vue323.ComputedRef<boolean>;
+  isAdmin: vue323.ComputedRef<boolean>;
+  isAdminOrOwner: vue323.ComputedRef<boolean>;
+  mfaEnabled: vue323.ComputedRef<boolean>;
+  globalRoleName: vue323.ComputedRef<string>;
+  userClaimedAiCredits: vue323.ComputedRef<boolean | undefined>;
+  isEasyAIWorkflowOnboardingDone: vue323.ComputedRef<boolean>;
+  canUserUpdateVersion: vue323.ComputedRef<boolean>;
+  usersLimitNotReached: vue323.ComputedRef<boolean>;
+  addUsers: (newUsers: User[]) => void;
+  loginWithCookie: () => Promise<void>;
+  initialize: () => Promise<void>;
+  setPersonalizationAnswers: (answers: IPersonalizationLatestVersion) => void;
+  loginWithCreds: (params: LoginRequestDto) => Promise<void>;
+  logout: (options?: {
+    viaOidc?: boolean;
+  }) => Promise<{
+    redirectUrl: string | null;
+  }>;
+  registerLoginHook: (hook: LoginHook) => void;
+  registerLogoutHook: (hook: LogoutHook) => void;
+  registerModalOpeners: (openers: ModalOpeners) => void;
+  setPermissionsResolvers: (resolvers: {
+    listUsers: () => boolean;
+  }) => void;
+  createOwner: (params: {
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+  }) => Promise<void>;
+  validateSignupToken: (params: {
+    token: string;
+  }) => Promise<{
+    inviter: {
+      firstName: string;
+      lastName: string;
+    };
+  }>;
+  acceptInvitation: (params: {
+    token: string;
+    firstName: string;
+    lastName: string;
+    password: string;
+  }) => Promise<void>;
+  sendForgotPasswordEmail: (params: {
+    email: string;
+  }) => Promise<void>;
+  validatePasswordToken: (params: {
+    token: string;
+  }) => Promise<void>;
+  changePassword: (params: {
+    token: string;
+    password: string;
+    mfaCode?: string;
+  }) => Promise<void>;
+  updateUser: (params: UserUpdateRequestDto) => Promise<IUserResponse>;
+  updateUserName: (params: {
+    firstName: string;
+    lastName: string;
+  }) => Promise<IUserResponse | undefined>;
+  updateUserSettings: (settings: UserSelfSettingsUpdateRequestDto) => Promise<void>;
+  updateOtherUserSettings: (userId: string, settings: SettingsUpdateRequestDto) => Promise<void>;
+  updateCurrentUserPassword: (params: PasswordUpdateRequestDto) => Promise<void>;
+  deleteUser: (params: {
+    id: string;
+    transferId?: string;
+  }) => Promise<void>;
+  fetchUsers: ({
+    take,
+    skip,
+    filter
+  }?: {
+    take?: number;
+    skip?: number;
+    filter?: UsersListFilterDto["filter"];
+  }) => Promise<void>;
+  inviteUsers: (params: Array<{
+    email: string;
+    role: AssignableGlobalRole;
+  }>) => Promise<IInviteResponse[]>;
+  reinviteUser: ({
+    email,
+    role
+  }: {
+    email: string;
+    role: AssignableGlobalRole;
+  }) => Promise<void>;
+  getUserPasswordResetLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  generateInviteLink: (params: {
+    id: string;
+  }) => Promise<{
+    link: string;
+  }>;
+  submitPersonalizationSurvey: (results: IPersonalizationLatestVersion) => Promise<void>;
+  showPersonalizationSurvey: () => void;
+  fetchMfaQR: () => Promise<{
+    qrCode: string;
+    secret: string;
+    recoveryCodes: string[];
+  }>;
+  verifyMfaCode: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  enableMfa: (data: {
+    mfaCode: string;
+  }) => Promise<void>;
+  disableMfa: (data: mfaApi.DisableMfaParams) => Promise<void>;
+  updateEnforceMfa: (enforce: boolean) => Promise<void>;
+  canEnableMFA: () => Promise<unknown>;
+  sendConfirmationEmail: () => Promise<void>;
+  updateGlobalRole: ({
+    id,
+    newRoleName
+  }: UpdateGlobalRolePayload) => Promise<void>;
+  setEasyAIWorkflowOnboardingDone: () => void;
+  isCalloutDismissed: (callout: string) => boolean;
+  setCalloutDismissed: (callout: string) => void;
+  submitContactEmail: (email: string, agree: boolean) => Promise<string | null>;
+  setUserQuota: (quota?: number) => void;
+  usersList: _vueuse_core2.UseAsyncStateReturn<{
+    count: number;
+    items: {
+      id: string;
+      firstName?: string | null | undefined;
+      lastName?: string | null | undefined;
+      email?: string | null | undefined;
+      role?: string | undefined;
+      isPending?: boolean | undefined;
+      isOwner?: boolean | undefined;
+      signInType?: string | undefined;
+      settings?: {
+        isOnboarded?: boolean | undefined;
+        firstSuccessfulWorkflowId?: string | undefined;
+        userActivated?: boolean | undefined;
+        userActivatedAt?: number | undefined;
+        allowSSOManualLogin?: boolean | undefined;
+        npsSurvey?: {
+          lastShownAt: number;
+          responded: true;
+        } | {
+          lastShownAt: number;
+          waitingForResponse: true;
+          ignoredCount: number;
+        } | undefined;
+        easyAIWorkflowOnboarded?: boolean | undefined;
+        userClaimedAiCredits?: boolean | undefined;
+        dismissedCallouts?: Record<string, boolean> | undefined;
+      } | null | undefined;
+      personalizationAnswers?: zod0.objectOutputType<{}, zod0.ZodTypeAny, "passthrough"> | null | undefined;
+      projectRelations?: {
+        id: string;
+        role: string;
+        name: string;
+        icon?: {
+          type: "emoji" | "icon";
+          value: string;
+          color?: string | undefined;
+        } | null | undefined;
+      }[] | null | undefined;
+      mfaEnabled?: boolean | undefined;
+      lastActiveAt?: string | null | undefined;
+      inviteAcceptUrl?: string | undefined;
+      isManagedByEnv?: boolean | undefined;
+    }[];
+  }, [filter?: UsersListFilterDto | undefined], true>;
+}, "initialize" | "generateInviteLink" | "addUsers" | "loginWithCookie" | "setPersonalizationAnswers" | "loginWithCreds" | "logout" | "registerLoginHook" | "registerLogoutHook" | "registerModalOpeners" | "setPermissionsResolvers" | "createOwner" | "validateSignupToken" | "acceptInvitation" | "sendForgotPasswordEmail" | "validatePasswordToken" | "changePassword" | "updateUser" | "updateUserName" | "updateUserSettings" | "updateOtherUserSettings" | "updateCurrentUserPassword" | "deleteUser" | "fetchUsers" | "inviteUsers" | "reinviteUser" | "getUserPasswordResetLink" | "submitPersonalizationSurvey" | "showPersonalizationSurvey" | "fetchMfaQR" | "verifyMfaCode" | "enableMfa" | "disableMfa" | "updateEnforceMfa" | "canEnableMFA" | "sendConfirmationEmail" | "updateGlobalRole" | "setEasyAIWorkflowOnboardingDone" | "isCalloutDismissed" | "setCalloutDismissed" | "submitContactEmail" | "setUserQuota">>;
+//#endregion
+export { LoginHook, useUsersStore };
+//# sourceMappingURL=users.store.d.cts.map