mirror of
https://github.com/paperclipai/paperclip
synced 2026-04-25 17:25:15 +02:00
## Thinking Path > - Paperclip is the control plane for autonomous AI companies. > - V1 needs to stay local-first while also supporting shared, authenticated deployments. > - Human operators need real identities, company membership, invite flows, profile surfaces, and company-scoped access controls. > - Agents and operators also need the existing issue, inbox, workspace, approval, and plugin flows to keep working under those authenticated boundaries. > - This branch accumulated the multi-user implementation, follow-up QA fixes, workspace/runtime refinements, invite UX improvements, release-branch conflict resolution, and review hardening. > - This pull request consolidates that branch onto the current `master` branch as a single reviewable PR. > - The benefit is a complete multi-user implementation path with tests and docs carried forward without dropping existing branch work. ## What Changed - Added authenticated human-user access surfaces: auth/session routes, company user directory, profile settings, company access/member management, join requests, and invite management. - Added invite creation, invite landing, onboarding, logo/branding, invite grants, deduped join requests, and authenticated multi-user E2E coverage. - Tightened company-scoped and instance-admin authorization across board, plugin, adapter, access, issue, and workspace routes. - Added profile-image URL validation hardening, avatar preservation on name-only profile updates, and join-request uniqueness migration cleanup for pending human requests. - Added an atomic member role/status/grants update path so Company Access saves no longer leave partially updated permissions. - Improved issue chat, inbox, assignee identity rendering, sidebar/account/company navigation, workspace routing, and execution workspace reuse behavior for multi-user operation. - Added and updated server/UI tests covering auth, invites, membership, issue workspace inheritance, plugin authz, inbox/chat behavior, and multi-user flows. - Merged current `public-gh/master` into this branch, resolved all conflicts, and verified no `pnpm-lock.yaml` change is included in this PR diff. ## Verification - `pnpm exec vitest run server/src/__tests__/issues-service.test.ts ui/src/components/IssueChatThread.test.tsx ui/src/pages/Inbox.test.tsx` - `pnpm run preflight:workspace-links && pnpm exec vitest run server/src/__tests__/plugin-routes-authz.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/workspace-runtime-service-authz.test.ts server/src/__tests__/access-validators.test.ts` - `pnpm exec vitest run server/src/__tests__/authz-company-access.test.ts server/src/__tests__/routines-routes.test.ts server/src/__tests__/sidebar-preferences-routes.test.ts server/src/__tests__/approval-routes-idempotency.test.ts server/src/__tests__/openclaw-invite-prompt-route.test.ts server/src/__tests__/agent-cross-tenant-authz-routes.test.ts server/src/__tests__/routines-e2e.test.ts` - `pnpm exec vitest run server/src/__tests__/auth-routes.test.ts ui/src/pages/CompanyAccess.test.tsx` - `pnpm --filter @paperclipai/shared typecheck && pnpm --filter @paperclipai/db typecheck && pnpm --filter @paperclipai/server typecheck` - `pnpm --filter @paperclipai/shared typecheck && pnpm --filter @paperclipai/server typecheck` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm db:generate` - `npx playwright test --config tests/e2e/playwright.config.ts --list` - Confirmed branch has no uncommitted changes and is `0` commits behind `public-gh/master` before PR creation. - Confirmed no `pnpm-lock.yaml` change is staged or present in the PR diff. ## Risks - High review surface area: this PR contains the accumulated multi-user branch plus follow-up fixes, so reviewers should focus especially on company-boundary enforcement and authenticated-vs-local deployment behavior. - UI behavior changed across invites, inbox, issue chat, access settings, and sidebar navigation; no browser screenshots are included in this branch-consolidation PR. - Plugin install, upgrade, and lifecycle/config mutations now require instance-admin access, which is intentional but may change expectations for non-admin board users. - A join-request dedupe migration rejects duplicate pending human requests before creating unique indexes; deployments with unusual historical duplicates should review the migration behavior. - Company member role/status/grant saves now use a new combined endpoint; older separate endpoints remain for compatibility. - Full production build was not run locally in this heartbeat; CI should cover the full matrix. ## Model Used - OpenAI Codex coding agent, GPT-5-based model, CLI/tool-use environment. Exact deployed model identifier and context window were not exposed by the runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge Note on screenshots: this is a branch-consolidation PR for an already-developed multi-user branch, and no browser screenshots were captured during this heartbeat. --------- Co-authored-by: dotta <dotta@example.com> Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
392 lines
12 KiB
TypeScript
392 lines
12 KiB
TypeScript
import type { AgentAdapterType, JoinRequest, PermissionKey } from "@paperclipai/shared";
|
|
import { api } from "./client";
|
|
|
|
export type HumanCompanyRole = "owner" | "admin" | "operator" | "viewer";
|
|
|
|
type InviteSummary = {
|
|
id: string;
|
|
companyId: string | null;
|
|
companyName?: string | null;
|
|
companyLogoUrl?: string | null;
|
|
companyBrandColor?: string | null;
|
|
inviteType: "company_join" | "bootstrap_ceo";
|
|
allowedJoinTypes: "human" | "agent" | "both";
|
|
humanRole?: HumanCompanyRole | null;
|
|
expiresAt: string;
|
|
onboardingPath?: string;
|
|
onboardingUrl?: string;
|
|
onboardingTextPath?: string;
|
|
onboardingTextUrl?: string;
|
|
skillIndexPath?: string;
|
|
skillIndexUrl?: string;
|
|
inviteMessage?: string | null;
|
|
invitedByUserName?: string | null;
|
|
joinRequestStatus?: JoinRequest["status"] | null;
|
|
joinRequestType?: JoinRequest["requestType"] | null;
|
|
};
|
|
|
|
type AcceptInviteInput =
|
|
| { requestType: "human" }
|
|
| {
|
|
requestType: "agent";
|
|
agentName: string;
|
|
adapterType?: AgentAdapterType;
|
|
capabilities?: string | null;
|
|
agentDefaultsPayload?: Record<string, unknown> | null;
|
|
};
|
|
|
|
type AgentJoinRequestAccepted = JoinRequest & {
|
|
claimSecret: string;
|
|
claimApiKeyPath: string;
|
|
onboarding?: Record<string, unknown>;
|
|
diagnostics?: Array<{
|
|
code: string;
|
|
level: "info" | "warn";
|
|
message: string;
|
|
hint?: string;
|
|
}>;
|
|
};
|
|
|
|
type InviteOnboardingManifest = {
|
|
invite: InviteSummary;
|
|
onboarding: {
|
|
inviteMessage?: string | null;
|
|
connectivity?: {
|
|
guidance?: string;
|
|
connectionCandidates?: string[];
|
|
testResolutionEndpoint?: {
|
|
method?: string;
|
|
path?: string;
|
|
url?: string;
|
|
};
|
|
};
|
|
textInstructions?: {
|
|
url?: string;
|
|
};
|
|
};
|
|
};
|
|
|
|
type BoardClaimStatus = {
|
|
status: "available" | "claimed" | "expired";
|
|
requiresSignIn: boolean;
|
|
expiresAt: string | null;
|
|
claimedByUserId: string | null;
|
|
};
|
|
|
|
type CliAuthChallengeStatus = {
|
|
id: string;
|
|
status: "pending" | "approved" | "cancelled" | "expired";
|
|
command: string;
|
|
clientName: string | null;
|
|
requestedAccess: "board" | "instance_admin_required";
|
|
requestedCompanyId: string | null;
|
|
requestedCompanyName: string | null;
|
|
approvedAt: string | null;
|
|
cancelledAt: string | null;
|
|
expiresAt: string;
|
|
approvedByUser: { id: string; name: string; email: string } | null;
|
|
requiresSignIn: boolean;
|
|
canApprove: boolean;
|
|
currentUserId: string | null;
|
|
};
|
|
|
|
type CompanyInviteCreated = {
|
|
id: string;
|
|
token: string;
|
|
inviteUrl: string;
|
|
expiresAt: string;
|
|
allowedJoinTypes: "human" | "agent" | "both";
|
|
humanRole?: HumanCompanyRole | null;
|
|
companyName?: string | null;
|
|
onboardingTextPath?: string;
|
|
onboardingTextUrl?: string;
|
|
inviteMessage?: string | null;
|
|
};
|
|
|
|
export type CompanyMemberGrant = {
|
|
id: string;
|
|
companyId: string;
|
|
principalType: "user";
|
|
principalId: string;
|
|
permissionKey: PermissionKey;
|
|
scope: Record<string, unknown> | null;
|
|
grantedByUserId: string | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
};
|
|
|
|
export type CompanyMember = {
|
|
id: string;
|
|
companyId: string;
|
|
principalType: "user";
|
|
principalId: string;
|
|
status: "pending" | "active" | "suspended";
|
|
membershipRole: HumanCompanyRole | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
user: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
grants: CompanyMemberGrant[];
|
|
};
|
|
|
|
export type CompanyMembersResponse = {
|
|
members: CompanyMember[];
|
|
access: {
|
|
currentUserRole: HumanCompanyRole | null;
|
|
canManageMembers: boolean;
|
|
canInviteUsers: boolean;
|
|
canApproveJoinRequests: boolean;
|
|
};
|
|
};
|
|
|
|
export type CompanyUserDirectoryEntry = {
|
|
principalId: string;
|
|
status: "active";
|
|
user: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
};
|
|
|
|
export type CompanyUserDirectoryResponse = {
|
|
users: CompanyUserDirectoryEntry[];
|
|
};
|
|
|
|
export type CompanyInviteRecord = {
|
|
id: string;
|
|
companyId: string | null;
|
|
companyName: string | null;
|
|
inviteType: "company_join" | "bootstrap_ceo";
|
|
allowedJoinTypes: "human" | "agent" | "both";
|
|
humanRole: HumanCompanyRole | null;
|
|
defaultsPayload: Record<string, unknown> | null;
|
|
expiresAt: string;
|
|
invitedByUserId: string | null;
|
|
revokedAt: string | null;
|
|
acceptedAt: string | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
inviteMessage: string | null;
|
|
state: "active" | "revoked" | "accepted" | "expired";
|
|
invitedByUser: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
relatedJoinRequestId: string | null;
|
|
};
|
|
|
|
export type CompanyInviteListResponse = {
|
|
invites: CompanyInviteRecord[];
|
|
nextOffset: number | null;
|
|
};
|
|
|
|
export type CompanyJoinRequest = JoinRequest & {
|
|
requesterUser: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
approvedByUser: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
rejectedByUser: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
invite: {
|
|
id: string;
|
|
inviteType: "company_join" | "bootstrap_ceo";
|
|
allowedJoinTypes: "human" | "agent" | "both";
|
|
humanRole: HumanCompanyRole | null;
|
|
inviteMessage: string | null;
|
|
createdAt: string;
|
|
expiresAt: string;
|
|
revokedAt: string | null;
|
|
acceptedAt: string | null;
|
|
invitedByUser: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
} | null;
|
|
};
|
|
|
|
export type AdminUserDirectoryEntry = {
|
|
id: string;
|
|
email: string | null;
|
|
name: string | null;
|
|
image: string | null;
|
|
isInstanceAdmin: boolean;
|
|
activeCompanyMembershipCount: number;
|
|
};
|
|
|
|
export type UserCompanyAccessEntry = {
|
|
id: string;
|
|
companyId: string;
|
|
principalType: "user";
|
|
principalId: string;
|
|
status: "pending" | "active" | "suspended";
|
|
membershipRole: HumanCompanyRole | "member" | null;
|
|
createdAt: string;
|
|
updatedAt: string;
|
|
companyName: string | null;
|
|
companyStatus: "active" | "paused" | "archived" | null;
|
|
};
|
|
|
|
export type UserCompanyAccessResponse = {
|
|
user: {
|
|
id: string;
|
|
email: string | null;
|
|
name: string | null;
|
|
image: string | null;
|
|
isInstanceAdmin: boolean;
|
|
} | null;
|
|
companyAccess: UserCompanyAccessEntry[];
|
|
};
|
|
|
|
export type CurrentBoardAccess = {
|
|
user: { id: string; email: string | null; name: string | null; image: string | null } | null;
|
|
userId: string;
|
|
isInstanceAdmin: boolean;
|
|
companyIds: string[];
|
|
source: string;
|
|
keyId: string | null;
|
|
};
|
|
|
|
function buildInviteListQuery(options: {
|
|
state?: "active" | "revoked" | "accepted" | "expired";
|
|
limit?: number;
|
|
offset?: number;
|
|
}) {
|
|
const params = new URLSearchParams();
|
|
if (options.state) params.set("state", options.state);
|
|
if (options.limit) params.set("limit", String(options.limit));
|
|
if (options.offset) params.set("offset", String(options.offset));
|
|
const query = params.toString();
|
|
return query ? `?${query}` : "";
|
|
}
|
|
|
|
export const accessApi = {
|
|
createCompanyInvite: (
|
|
companyId: string,
|
|
input: {
|
|
allowedJoinTypes?: "human" | "agent" | "both";
|
|
humanRole?: HumanCompanyRole | null;
|
|
defaultsPayload?: Record<string, unknown> | null;
|
|
agentMessage?: string | null;
|
|
} = {},
|
|
) =>
|
|
api.post<CompanyInviteCreated>(`/companies/${companyId}/invites`, input),
|
|
|
|
createOpenClawInvitePrompt: (
|
|
companyId: string,
|
|
input: {
|
|
agentMessage?: string | null;
|
|
} = {},
|
|
) =>
|
|
api.post<CompanyInviteCreated>(
|
|
`/companies/${companyId}/openclaw/invite-prompt`,
|
|
input,
|
|
),
|
|
|
|
getInvite: (token: string) => api.get<InviteSummary>(`/invites/${token}`),
|
|
getInviteOnboarding: (token: string) =>
|
|
api.get<InviteOnboardingManifest>(`/invites/${token}/onboarding`),
|
|
|
|
acceptInvite: (token: string, input: AcceptInviteInput) =>
|
|
api.post<AgentJoinRequestAccepted | JoinRequest | { bootstrapAccepted: true; userId: string }>(
|
|
`/invites/${token}/accept`,
|
|
input,
|
|
),
|
|
|
|
listInvites: (
|
|
companyId: string,
|
|
options: {
|
|
state?: "active" | "revoked" | "accepted" | "expired";
|
|
limit?: number;
|
|
offset?: number;
|
|
} = {},
|
|
) =>
|
|
api.get<CompanyInviteListResponse>(
|
|
`/companies/${companyId}/invites${buildInviteListQuery(options)}`,
|
|
),
|
|
|
|
revokeInvite: (inviteId: string) => api.post(`/invites/${inviteId}/revoke`, {}),
|
|
|
|
listJoinRequests: (
|
|
companyId: string,
|
|
status: "pending_approval" | "approved" | "rejected" = "pending_approval",
|
|
requestType?: "human" | "agent",
|
|
) =>
|
|
api.get<CompanyJoinRequest[]>(
|
|
`/companies/${companyId}/join-requests?status=${status}${requestType ? `&requestType=${requestType}` : ""}`,
|
|
),
|
|
|
|
listMembers: (companyId: string) =>
|
|
api.get<CompanyMembersResponse>(`/companies/${companyId}/members`),
|
|
|
|
listUserDirectory: (companyId: string) =>
|
|
api.get<CompanyUserDirectoryResponse>(`/companies/${companyId}/user-directory`),
|
|
|
|
updateMember: (
|
|
companyId: string,
|
|
memberId: string,
|
|
input: {
|
|
membershipRole?: HumanCompanyRole | null;
|
|
status?: "pending" | "active" | "suspended";
|
|
},
|
|
) => api.patch<CompanyMember>(`/companies/${companyId}/members/${memberId}`, input),
|
|
|
|
updateMemberPermissions: (
|
|
companyId: string,
|
|
memberId: string,
|
|
input: {
|
|
grants: Array<{
|
|
permissionKey: PermissionKey;
|
|
scope?: Record<string, unknown> | null;
|
|
}>;
|
|
},
|
|
) => api.patch<CompanyMember>(`/companies/${companyId}/members/${memberId}/permissions`, input),
|
|
|
|
updateMemberAccess: (
|
|
companyId: string,
|
|
memberId: string,
|
|
input: {
|
|
membershipRole?: HumanCompanyRole | null;
|
|
status?: "pending" | "active" | "suspended";
|
|
grants: Array<{
|
|
permissionKey: PermissionKey;
|
|
scope?: Record<string, unknown> | null;
|
|
}>;
|
|
},
|
|
) => api.patch<CompanyMember>(`/companies/${companyId}/members/${memberId}/role-and-grants`, input),
|
|
|
|
approveJoinRequest: (companyId: string, requestId: string) =>
|
|
api.post<JoinRequest>(`/companies/${companyId}/join-requests/${requestId}/approve`, {}),
|
|
|
|
rejectJoinRequest: (companyId: string, requestId: string) =>
|
|
api.post<JoinRequest>(`/companies/${companyId}/join-requests/${requestId}/reject`, {}),
|
|
|
|
claimJoinRequestApiKey: (requestId: string, claimSecret: string) =>
|
|
api.post<{ keyId: string; token: string; agentId: string; createdAt: string }>(
|
|
`/join-requests/${requestId}/claim-api-key`,
|
|
{ claimSecret },
|
|
),
|
|
|
|
getBoardClaimStatus: (token: string, code: string) =>
|
|
api.get<BoardClaimStatus>(`/board-claim/${token}?code=${encodeURIComponent(code)}`),
|
|
|
|
claimBoard: (token: string, code: string) =>
|
|
api.post<{ claimed: true; userId: string }>(`/board-claim/${token}/claim`, { code }),
|
|
|
|
getCliAuthChallenge: (id: string, token: string) =>
|
|
api.get<CliAuthChallengeStatus>(`/cli-auth/challenges/${id}?token=${encodeURIComponent(token)}`),
|
|
|
|
approveCliAuthChallenge: (id: string, token: string) =>
|
|
api.post<{ approved: boolean; status: string; userId: string; keyId: string | null; expiresAt: string }>(
|
|
`/cli-auth/challenges/${id}/approve`,
|
|
{ token },
|
|
),
|
|
|
|
cancelCliAuthChallenge: (id: string, token: string) =>
|
|
api.post<{ cancelled: boolean; status: string }>(`/cli-auth/challenges/${id}/cancel`, { token }),
|
|
|
|
searchAdminUsers: (query: string) =>
|
|
api.get<AdminUserDirectoryEntry[]>(`/admin/users?query=${encodeURIComponent(query)}`),
|
|
|
|
promoteInstanceAdmin: (userId: string) =>
|
|
api.post(`/admin/users/${userId}/promote-instance-admin`, {}),
|
|
|
|
demoteInstanceAdmin: (userId: string) =>
|
|
api.post(`/admin/users/${userId}/demote-instance-admin`, {}),
|
|
|
|
getUserCompanyAccess: (userId: string) =>
|
|
api.get<UserCompanyAccessResponse>(`/admin/users/${userId}/company-access`),
|
|
|
|
setUserCompanyAccess: (userId: string, companyIds: string[]) =>
|
|
api.put<UserCompanyAccessResponse>(`/admin/users/${userId}/company-access`, { companyIds }),
|
|
|
|
getCurrentBoardAccess: () =>
|
|
api.get<CurrentBoardAccess>("/cli-auth/me"),
|
|
};
|