mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 19:00:38 +09: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>
178 lines
6.1 KiB
TypeScript
178 lines
6.1 KiB
TypeScript
import { z } from "zod";
|
|
import {
|
|
AGENT_ADAPTER_TYPES,
|
|
HUMAN_COMPANY_MEMBERSHIP_ROLES,
|
|
INVITE_JOIN_TYPES,
|
|
JOIN_REQUEST_STATUSES,
|
|
JOIN_REQUEST_TYPES,
|
|
MEMBERSHIP_STATUSES,
|
|
PERMISSION_KEYS,
|
|
} from "../constants.js";
|
|
import { optionalAgentAdapterTypeSchema } from "../adapter-type.js";
|
|
|
|
export const createCompanyInviteSchema = z.object({
|
|
allowedJoinTypes: z.enum(INVITE_JOIN_TYPES).default("both"),
|
|
humanRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
defaultsPayload: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
agentMessage: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type CreateCompanyInvite = z.infer<typeof createCompanyInviteSchema>;
|
|
|
|
export const createOpenClawInvitePromptSchema = z.object({
|
|
agentMessage: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type CreateOpenClawInvitePrompt = z.infer<
|
|
typeof createOpenClawInvitePromptSchema
|
|
>;
|
|
|
|
export const acceptInviteSchema = z.object({
|
|
requestType: z.enum(JOIN_REQUEST_TYPES),
|
|
agentName: z.string().min(1).max(120).optional(),
|
|
adapterType: optionalAgentAdapterTypeSchema,
|
|
capabilities: z.string().max(4000).optional().nullable(),
|
|
agentDefaultsPayload: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
// OpenClaw join compatibility fields accepted at top level.
|
|
responsesWebhookUrl: z.string().max(4000).optional().nullable(),
|
|
responsesWebhookMethod: z.string().max(32).optional().nullable(),
|
|
responsesWebhookHeaders: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
paperclipApiUrl: z.string().max(4000).optional().nullable(),
|
|
webhookAuthHeader: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type AcceptInvite = z.infer<typeof acceptInviteSchema>;
|
|
|
|
export const listJoinRequestsQuerySchema = z.object({
|
|
status: z.enum(JOIN_REQUEST_STATUSES).optional(),
|
|
requestType: z.enum(JOIN_REQUEST_TYPES).optional(),
|
|
});
|
|
|
|
export type ListJoinRequestsQuery = z.infer<typeof listJoinRequestsQuerySchema>;
|
|
|
|
export const listCompanyInvitesQuerySchema = z.object({
|
|
state: z.enum(["active", "revoked", "accepted", "expired"]).optional(),
|
|
limit: z.coerce.number().int().min(1).max(100).optional().default(20),
|
|
offset: z.coerce.number().int().min(0).optional().default(0),
|
|
});
|
|
|
|
export type ListCompanyInvitesQuery = z.infer<typeof listCompanyInvitesQuerySchema>;
|
|
|
|
export const claimJoinRequestApiKeySchema = z.object({
|
|
claimSecret: z.string().min(16).max(256),
|
|
});
|
|
|
|
export type ClaimJoinRequestApiKey = z.infer<typeof claimJoinRequestApiKeySchema>;
|
|
|
|
export const boardCliAuthAccessLevelSchema = z.enum([
|
|
"board",
|
|
"instance_admin_required",
|
|
]);
|
|
|
|
export type BoardCliAuthAccessLevel = z.infer<typeof boardCliAuthAccessLevelSchema>;
|
|
|
|
export const createCliAuthChallengeSchema = z.object({
|
|
command: z.string().min(1).max(240),
|
|
clientName: z.string().max(120).optional().nullable(),
|
|
requestedAccess: boardCliAuthAccessLevelSchema.default("board"),
|
|
requestedCompanyId: z.string().uuid().optional().nullable(),
|
|
});
|
|
|
|
export type CreateCliAuthChallenge = z.infer<typeof createCliAuthChallengeSchema>;
|
|
|
|
export const resolveCliAuthChallengeSchema = z.object({
|
|
token: z.string().min(16).max(256),
|
|
});
|
|
|
|
export type ResolveCliAuthChallenge = z.infer<typeof resolveCliAuthChallengeSchema>;
|
|
|
|
export const updateMemberPermissionsSchema = z.object({
|
|
grants: z.array(
|
|
z.object({
|
|
permissionKey: z.enum(PERMISSION_KEYS),
|
|
scope: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
}),
|
|
),
|
|
});
|
|
|
|
export type UpdateMemberPermissions = z.infer<typeof updateMemberPermissionsSchema>;
|
|
|
|
export const updateCompanyMemberSchema = z.object({
|
|
membershipRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
status: z.enum(MEMBERSHIP_STATUSES).optional(),
|
|
}).refine((value) => value.membershipRole !== undefined || value.status !== undefined, {
|
|
message: "membershipRole or status is required",
|
|
});
|
|
|
|
export type UpdateCompanyMember = z.infer<typeof updateCompanyMemberSchema>;
|
|
|
|
export const updateCompanyMemberWithPermissionsSchema = z.object({
|
|
membershipRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
status: z.enum(MEMBERSHIP_STATUSES).optional(),
|
|
grants: updateMemberPermissionsSchema.shape.grants.default([]),
|
|
}).refine((value) => value.membershipRole !== undefined || value.status !== undefined, {
|
|
message: "membershipRole or status is required",
|
|
});
|
|
|
|
export type UpdateCompanyMemberWithPermissions = z.infer<typeof updateCompanyMemberWithPermissionsSchema>;
|
|
|
|
export const updateUserCompanyAccessSchema = z.object({
|
|
companyIds: z.array(z.string().uuid()).default([]),
|
|
});
|
|
|
|
export type UpdateUserCompanyAccess = z.infer<typeof updateUserCompanyAccessSchema>;
|
|
|
|
export const searchAdminUsersQuerySchema = z.object({
|
|
query: z.string().trim().max(120).optional().default(""),
|
|
});
|
|
|
|
export type SearchAdminUsersQuery = z.infer<typeof searchAdminUsersQuerySchema>;
|
|
|
|
const profileImageAssetPathPattern = /^\/api\/assets\/[^/?#]+\/content(?:\?[^#]*)?(?:#.*)?$/;
|
|
|
|
function isValidProfileImage(value: string): boolean {
|
|
if (profileImageAssetPathPattern.test(value)) return true;
|
|
|
|
try {
|
|
const url = new URL(value);
|
|
return url.protocol === "https:" || url.protocol === "http:";
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
const profileImageSchema = z
|
|
.string()
|
|
.trim()
|
|
.min(1)
|
|
.max(4000)
|
|
.refine(isValidProfileImage, { message: "Invalid profile image URL" });
|
|
|
|
export const currentUserProfileSchema = z.object({
|
|
id: z.string().min(1),
|
|
email: z.string().email().nullable(),
|
|
name: z.string().min(1).max(120).nullable(),
|
|
image: profileImageSchema.nullable(),
|
|
});
|
|
|
|
export type CurrentUserProfile = z.infer<typeof currentUserProfileSchema>;
|
|
|
|
export const authSessionSchema = z.object({
|
|
session: z.object({
|
|
id: z.string().min(1),
|
|
userId: z.string().min(1),
|
|
}),
|
|
user: currentUserProfileSchema,
|
|
});
|
|
|
|
export type AuthSession = z.infer<typeof authSessionSchema>;
|
|
|
|
export const updateCurrentUserProfileSchema = z.object({
|
|
name: z.string().trim().min(1).max(120),
|
|
image: z
|
|
.union([profileImageSchema, z.literal(""), z.null()])
|
|
.optional()
|
|
.transform((value) => value === "" ? null : value),
|
|
});
|
|
|
|
export type UpdateCurrentUserProfile = z.infer<typeof updateCurrentUserProfileSchema>;
|