@10x-media/impersonation 0.1.0-beta.0

package/dist/ui/useImpersonation.d.ts

@@ -0,0 +1,43 @@
+import { FailureCode } from "../endpoints/codes.js";
+import { ImpersonationStatus } from "../getImpersonation.js";
+import { Where } from "payload";
+
+//#region src/ui/useImpersonation.d.ts
+type UseImpersonation = {
+  apiPath: string;
+  cardEmail: boolean;
+  end: (id: number | string) => Promise<{
+    error?: FailureCode;
+    ok: boolean;
+    status: number;
+  }>;
+  exit: () => Promise<{
+    error?: FailureCode;
+    ok: boolean;
+    status: number;
+  }>;
+  reasonMode: 'off' | 'optional' | 'required';
+  sessionCollection: string;
+  setStatus: (status: ImpersonationStatus) => void;
+  start: (args: {
+    collection: string;
+    id: number | string;
+    reason?: string;
+    redirect?: string;
+  }) => Promise<{
+    error?: FailureCode;
+    ok: boolean;
+    redirect?: string;
+    status: number;
+  }>;
+  status: ImpersonationStatus;
+  targetFilters: Record<string, true | Where>;
+};
+/**
+ * Headless client API. The provider is always registered, so this works from
+ * any admin component. Built-in switcher, bar, and document button use it.
+ */
+declare const useImpersonation: () => UseImpersonation;
+//#endregion
+export { useImpersonation };
+//# sourceMappingURL=useImpersonation.d.ts.map

package/dist/ui/useImpersonation.js

@@ -0,0 +1,36 @@
+"use client";
+import { postImpersonation } from "./api.js";
+import { useImpersonationClient } from "./ImpersonationConfig.js";
+import { useConfig } from "@payloadcms/ui";
+//#region src/ui/useImpersonation.ts
+const noopSetStatus = (_status) => {};
+/**
+* Headless client API. The provider is always registered, so this works from
+* any admin component. Built-in switcher, bar, and document button use it.
+*/
+const useImpersonation = () => {
+	const plugin = useImpersonationClient();
+	const { config } = useConfig();
+	const apiPath = plugin?.apiPath ?? `${config.routes.api}/impersonation`;
+	const reasonMode = plugin?.reasonMode ?? "off";
+	const sessionCollection = plugin?.sessionCollection ?? "impersonation-sessions";
+	const targetFilters = plugin?.targetFilters ?? {};
+	const cardEmail = plugin?.cardEmail ?? true;
+	const status = plugin?.status ?? { active: false };
+	return {
+		apiPath,
+		cardEmail,
+		end: (id) => postImpersonation(`${apiPath}/${encodeURIComponent(String(id))}/end`, {}),
+		exit: () => postImpersonation(`${apiPath}/exit`, {}),
+		reasonMode,
+		sessionCollection,
+		setStatus: plugin?.setStatus ?? noopSetStatus,
+		start: (args) => postImpersonation(`${apiPath}/start`, args),
+		status,
+		targetFilters
+	};
+};
+//#endregion
+export { useImpersonation };
+
+//# sourceMappingURL=useImpersonation.js.map

package/dist/ui/useImpersonation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useImpersonation.js","names":[],"sources":["../../src/ui/useImpersonation.ts"],"sourcesContent":["'use client'\n\nimport { useConfig } from '@payloadcms/ui'\nimport type { Where } from 'payload'\n\nimport type { FailureCode } from '../endpoints/codes'\nimport type { ImpersonationStatus } from '../getImpersonation'\nimport { errorKey, goAfterSwitch, postImpersonation } from './api'\nimport { useImpersonationClient } from './ImpersonationConfig'\n\nexport type UseImpersonation = {\n\tapiPath: string\n\tcardEmail: boolean\n\tend: (id: number | string) => Promise<{ error?: FailureCode; ok: boolean; status: number }>\n\texit: () => Promise<{ error?: FailureCode; ok: boolean; status: number }>\n\treasonMode: 'off' | 'optional' | 'required'\n\tsessionCollection: string\n\tsetStatus: (status: ImpersonationStatus) => void\n\tstart: (args: {\n\t\tcollection: string\n\t\tid: number | string\n\t\treason?: string\n\t\tredirect?: string\n\t}) => Promise<{ error?: FailureCode; ok: boolean; redirect?: string; status: number }>\n\tstatus: ImpersonationStatus\n\ttargetFilters: Record<string, true | Where>\n}\n\nconst noopSetStatus = (_status: ImpersonationStatus): void => {}\n\n/**\n * Headless client API. The provider is always registered, so this works from\n * any admin component. Built-in switcher, bar, and document button use it.\n */\nexport const useImpersonation = (): UseImpersonation => {\n\tconst plugin = useImpersonationClient()\n\tconst { config } = useConfig()\n\tconst apiPath = plugin?.apiPath ?? `${config.routes.api}/impersonation`\n\tconst reasonMode = plugin?.reasonMode ?? 'off'\n\tconst sessionCollection = plugin?.sessionCollection ?? 'impersonation-sessions'\n\tconst targetFilters = plugin?.targetFilters ?? {}\n\tconst cardEmail = plugin?.cardEmail ?? true\n\tconst status = plugin?.status ?? { active: false }\n\tconst setStatus = plugin?.setStatus ?? noopSetStatus\n\n\treturn {\n\t\tapiPath,\n\t\tcardEmail,\n\t\tend: (id) => postImpersonation(`${apiPath}/${encodeURIComponent(String(id))}/end`, {}),\n\t\texit: () => postImpersonation(`${apiPath}/exit`, {}),\n\t\treasonMode,\n\t\tsessionCollection,\n\t\tsetStatus,\n\t\tstart: (args) => postImpersonation(`${apiPath}/start`, args),\n\t\tstatus,\n\t\ttargetFilters,\n\t}\n}\n\nexport { errorKey, goAfterSwitch, postImpersonation }\n"],"mappings":";;;;;AA4BA,MAAM,iBAAiB,YAAuC,CAAC;;;;;AAM/D,MAAa,yBAA2C;CACvD,MAAM,SAAS,uBAAuB;CACtC,MAAM,EAAE,WAAW,UAAU;CAC7B,MAAM,UAAU,QAAQ,WAAW,GAAG,OAAO,OAAO,IAAI;CACxD,MAAM,aAAa,QAAQ,cAAc;CACzC,MAAM,oBAAoB,QAAQ,qBAAqB;CACvD,MAAM,gBAAgB,QAAQ,iBAAiB,CAAC;CAChD,MAAM,YAAY,QAAQ,aAAa;CACvC,MAAM,SAAS,QAAQ,UAAU,EAAE,QAAQ,MAAM;CAGjD,OAAO;EACN;EACA;EACA,MAAM,OAAO,kBAAkB,GAAG,QAAQ,GAAG,mBAAmB,OAAO,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;EACrF,YAAY,kBAAkB,GAAG,QAAQ,QAAQ,CAAC,CAAC;EACnD;EACA;EACA,WATiB,QAAQ,aAAa;EAUtC,QAAQ,SAAS,kBAAkB,GAAG,QAAQ,SAAS,IAAI;EAC3D;EACA;CACD;AACD"}

package/package.json

@@ -0,0 +1,126 @@
+{
+  "name": "@10x-media/impersonation",
+  "version": "0.1.0-beta.0",
+  "description": "Let an authorised account sign in as another user without their password, then return. Every session is recorded.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/10x-media/payload-plugins.git",
+    "directory": "packages/impersonation"
+  },
+  "homepage": "https://github.com/10x-media/payload-plugins/tree/main/packages/impersonation",
+  "bugs": "https://github.com/10x-media/payload-plugins/issues",
+  "keywords": [
+    "payload",
+    "payloadcms",
+    "plugin",
+    "impersonation",
+    "auth",
+    "session"
+  ],
+  "author": "10x-media",
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/exports/types.d.ts",
+      "import": "./dist/exports/types.js",
+      "default": "./dist/exports/types.js"
+    },
+    "./client": {
+      "types": "./dist/exports/client.d.ts",
+      "import": "./dist/exports/client.js",
+      "default": "./dist/exports/client.js"
+    },
+    "./rsc": {
+      "types": "./dist/exports/rsc.d.ts",
+      "import": "./dist/exports/rsc.js",
+      "default": "./dist/exports/rsc.js"
+    },
+    "./i18n": {
+      "types": "./dist/exports/i18n.d.ts",
+      "import": "./dist/exports/i18n.js",
+      "default": "./dist/exports/i18n.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "@10x-media/dual-session": ">=0.1.0-beta.0",
+    "@payloadcms/ui": "^3.83.0",
+    "next": "^15.0.0 || ^16.0.0",
+    "payload": "^3.83.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@10x-media/dual-session": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@payloadcms/db-mongodb": "3.85.0",
+    "@payloadcms/db-postgres": "3.85.0",
+    "@payloadcms/ui": "3.85.0",
+    "@playwright/test": "1.60.0",
+    "@types/node": "22.19.19",
+    "@types/react": "19.2.15",
+    "@types/react-dom": "19.2.3",
+    "next": "16.2.6",
+    "payload": "3.85.0",
+    "playwright": "1.60.0",
+    "react": "19.2.6",
+    "react-dom": "19.2.6",
+    "tsdown": "0.22.1",
+    "typescript": "5.9.3",
+    "vitest": "4.1.7",
+    "@10x-media/payload-test-harness": "0.0.0",
+    "@10x-media/tsconfig": "0.0.0",
+    "@10x-media/tsdown-config": "0.0.0",
+    "@10x-media/vitest-config": "0.0.0",
+    "@10x-media/dual-session": "0.1.0-beta.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "biome check src tests dev",
+    "lint:fix": "biome check --write src tests dev",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:unit": "vitest run src",
+    "test:int": "vitest run tests/int",
+    "test:matrix": "DB_MATRIX=mongo vitest run tests/int && DB_MATRIX=postgres vitest run tests/int",
+    "test:container": "TEST_DB=container DB_MATRIX=mongo vitest run tests/int/matrix.int.spec.ts && TEST_DB=container DB_MATRIX=postgres vitest run tests/int/matrix.int.spec.ts",
+    "test:e2e": "bash scripts/e2e.sh",
+    "dev": "pnpm --filter @10x-media/impersonation-dev dev",
+    "start": "pnpm --filter @10x-media/impersonation-dev start",
+    "generate": "pnpm --filter @10x-media/impersonation-dev generate",
+    "generate:types": "pnpm --filter @10x-media/impersonation-dev generate:types",
+    "generate:importmap": "pnpm --filter @10x-media/impersonation-dev generate:importmap",
+    "migrate": "pnpm --filter @10x-media/impersonation-dev migrate",
+    "migrate:create": "pnpm --filter @10x-media/impersonation-dev migrate:create",
+    "migrate:down": "pnpm --filter @10x-media/impersonation-dev migrate:down",
+    "migrate:refresh": "pnpm --filter @10x-media/impersonation-dev migrate:refresh",
+    "migrate:reset": "pnpm --filter @10x-media/impersonation-dev migrate:reset",
+    "migrate:status": "pnpm --filter @10x-media/impersonation-dev migrate:status",
+    "migrate:fresh": "pnpm --filter @10x-media/impersonation-dev migrate:fresh",
+    "clean": "rm -rf dist *.tsbuildinfo dev/.next"
+  }
+}