@powerportalspro/core 6.1.0 → 7.0.0

package/dist/index.js

@@ -104,6 +104,12 @@ var auth = {
   externalLoginRememberChoice: `${authRoot}/external-login/remember-choice`,
   /** POST — swap the current cookie for the user's alt identity (the contact↔systemuser sibling). */
   switchIdentity: `${authRoot}/switch-identity`,
+  /** POST — start impersonating a portal contact. Internal users holding the SystemAdmin role only. */
+  impersonate: `${authRoot}/impersonate`,
+  /** POST — end an impersonation session. Takes no body; the user to return to comes from the session's claims. */
+  stopImpersonation: `${authRoot}/stop-impersonation`,
+  /** POST — search portal contacts for the impersonation picker. */
+  impersonateSearch: `${authRoot}/impersonate/search`,
   /** GET — snapshot of the current user (or anonymous shape). */
   me: `${authRoot}/me`,
   /** Account-management endpoints under `/api/auth/manage/*`. */
@@ -551,6 +557,51 @@ var AuthClient = class {
       bodyAndSignal(void 0, signal)
     );
   }
+  // --- Impersonation ---------------------------------------------------------------
+  /**
+   * Starts impersonating a portal contact, swapping the auth cookie for theirs. Restricted
+   * server-side to internal users holding the `SystemAdmin` role; the target is resolved through
+   * the contact store alone, so a systemuser id can't be supplied to assume a staff identity.
+   *
+   * On `ImpersonateResult.Started` the session IS that contact — `/api/auth/me` reports the
+   * contact's id, roles and user type, with only `isImpersonating` / `impersonator*` betraying
+   * who is behind it. Reload or re-fetch the user after this resolves; anything already rendered
+   * was rendered for the previous identity.
+   */
+  impersonateAsync(targetUserId, signal) {
+    return this.transport.sendJson(
+      "POST",
+      Routes.api.auth.impersonate,
+      bodyAndSignal({ targetUserId }, signal)
+    );
+  }
+  /**
+   * Ends an impersonation session and signs the internal user back in. Takes no parameters — the
+   * identity to return to is read from the session's own claims server-side, so a caller can't
+   * choose who it becomes on the way back.
+   */
+  stopImpersonationAsync(signal) {
+    return this.transport.sendJson(
+      "POST",
+      Routes.api.auth.stopImpersonation,
+      bodyAndSignal(void 0, signal)
+    );
+  }
+  /**
+   * Searches portal contacts that may be impersonated. A query that parses as a GUID is an exact
+   * user-id lookup; otherwise it matches full name and email columns, and queries shorter than
+   * three characters return nothing.
+   *
+   * Returns an empty result rather than failing when the caller isn't permitted to impersonate,
+   * so a picker renders "no matches" without learning which condition applied.
+   */
+  searchImpersonationTargetsAsync(query, signal) {
+    return this.transport.sendJson(
+      "POST",
+      Routes.api.auth.impersonateSearch,
+      bodyAndSignal({ query }, signal)
+    );
+  }
   // --- Profile ---------------------------------------------------------------------
   /** Reads the signed-in user's manage-profile snapshot (Identity status + linked contact fields). */
   getProfileAsync(signal) {
@@ -1329,6 +1380,16 @@ var ChartDateGrouping = {
   /** Group by quarter + year. Label: "Q1 2024". */
   QuarterAndYear: 10
 };
+var ColumnSecurityPermission = {
+  /** The column can be neither read nor written. */
+  None: 0,
+  /** The column's real value is returned. */
+  Read: 1,
+  /** The column can be included in a create or update. */
+  Write: 2,
+  /** Full access — the default for every column not listed in ColumnPermissions. */
+  All: 3
+};
 var ColumnType = {
   /** A Boolean attribute. Value = 0. */
   Boolean: 0,
@@ -1423,6 +1484,20 @@ var FileArchiveResponseFormat = {
   /** Returns a JSON envelope (FileArchiveJsonResponse) that wraps the archive's bytes as base64. Useful when the consumer wants to inspect headers / filename / size programmatically before triggering a download, or when the host environment can't stream binary responses (some test harnesses, some service workers). Trades ~33% wire-size overhead for the JSON wrapper. */
   Json: 1
 };
+var ImpersonateResult = {
+  /** The target contact was signed in and the auth cookie has been swapped. */
+  Started: 0,
+  /** The current request is unauthenticated. */
+  NotAuthenticated: 1,
+  /** The caller may not impersonate — either they don't hold the SystemAdmin role, or they aren't a real internal systemuser (a contact backed by a stub systemuser is still a portal contact and can never impersonate). */
+  NotAuthorized: 2,
+  /** No active contact exists with the requested id. Also returned when the id belongs to a systemuser — the lookup only ever consults the contact store, so an internal user's id simply doesn't resolve. */
+  TargetNotFound: 3,
+  /** The contact exists but the host's impersonation target filter rejected it. */
+  TargetNotImpersonatable: 4,
+  /** The session is already impersonating. Nesting isn't supported — it would make the return path order-dependent — so stop the current impersonation first. */
+  AlreadyImpersonating: 5
+};
 var JoinOperator = {
   /** Inner join — only matching rows are returned. */
   Inner: 0,
@@ -1513,6 +1588,16 @@ var ResetPasswordResult = {
   /** The new password did not satisfy the host's password rules. The accompanying ProblemDetails (in the failed-validation HTTP 400) carries the per-rule error messages from IdentityResult.Errors. */
   InvalidPassword: 2
 };
+var StopImpersonationResult = {
+  /** Impersonation ended and the auth cookie is back to the internal user. */
+  Stopped: 0,
+  /** The session wasn't impersonating — there was nothing to stop. */
+  NotImpersonating: 1,
+  /** The internal user recorded on the session no longer resolves (disabled or removed in Dataverse mid-session). The impersonated session is signed out rather than left running, so the caller ends up anonymous and must sign in again. */
+  ImpersonatorNotFound: 2,
+  /** The current request is unauthenticated. */
+  NotAuthenticated: 3
+};
 var SwitchIdentityResult = {
   /** The alt identity was signed in and the auth cookie has been swapped. */
   Switched: 0,
@@ -1558,6 +1643,18 @@ var ViewType = {
   LookupDisplay: 2048
 };
 
+// src/column-permissions.ts
+function getColumnPermissions(record, columnName) {
+  const columnPermissions = record?.columnPermissions?.[columnName];
+  return columnPermissions ?? ColumnSecurityPermission.All;
+}
+function canReadColumn(record, columnName) {
+  return (getColumnPermissions(record, columnName) & ColumnSecurityPermission.Read) === ColumnSecurityPermission.Read;
+}
+function canWriteColumn(record, columnName) {
+  return (getColumnPermissions(record, columnName) & ColumnSecurityPermission.Write) === ColumnSecurityPermission.Write;
+}
+
 // src/record-id.ts
 var EMPTY_GUID = "00000000-0000-0000-0000-000000000000";
 function getRecordReferenceId(record) {
@@ -1569,6 +1666,6 @@ function getRecordReferenceId(record) {
 // src/index.ts
 var VERSION = "0.1.0";
 
-export { AggregateType, ArchiveFormat, ArgumentError, ArgumentNullError, AuthClient, ChangeEmailResult, ChangePasswordResult, ChartDateGrouping, ColumnType, ConfirmExternalLoginResult, DateTimeBehavior, DeletePersonalDataResult, EntityRole, ExternalLoginCandidateKind, FileArchiveResponseFormat, InvalidOperationError, JoinOperator, LocalizationSourceKind, LocalizationSourceStatus, LoginResult, PortalUserType, PowerPortalsProClient, PowerPortalsProError, RegisterResult, RelationshipFilterMode, RequiredLevel, ResetPasswordResult, Routes, SwitchIdentityResult, TableSecurityPermission, Transport, UnauthorizedAccessError, VERSION, ViewType, getRecordReferenceId, mapProblemDetails };
+export { AggregateType, ArchiveFormat, ArgumentError, ArgumentNullError, AuthClient, ChangeEmailResult, ChangePasswordResult, ChartDateGrouping, ColumnSecurityPermission, ColumnType, ConfirmExternalLoginResult, DateTimeBehavior, DeletePersonalDataResult, EntityRole, ExternalLoginCandidateKind, FileArchiveResponseFormat, ImpersonateResult, InvalidOperationError, JoinOperator, LocalizationSourceKind, LocalizationSourceStatus, LoginResult, PortalUserType, PowerPortalsProClient, PowerPortalsProError, RegisterResult, RelationshipFilterMode, RequiredLevel, ResetPasswordResult, Routes, StopImpersonationResult, SwitchIdentityResult, TableSecurityPermission, Transport, UnauthorizedAccessError, VERSION, ViewType, canReadColumn, canWriteColumn, getColumnPermissions, getRecordReferenceId, mapProblemDetails };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map