forked from farhoodlabs/paperclip
d67347be77
## Thinking Path > - Paperclip orchestrates AI agents that need scoped, auditable access to secrets > - Hosted and external deployments need provider vault configuration without exposing secret values in Paperclip metadata > - AWS Secrets Manager vault setup previously required too much manual operator knowledge > - Provider vault discovery and removal belong together as an independent secrets-management improvement > - This pull request adds AWS provider vault discovery/prefill plus vault removal flows > - The benefit is a safer operator path for configuring external secret storage before higher-level cloud workflows depend on it ## What Changed - Added shared validators/types for AWS provider vault discovery payloads and safe provider metadata. - Implemented AWS provider vault discovery preview on the server. - Added provider vault removal service/route behavior. - Added Secrets page UI for discovery prefill, removal messaging, and related rendering coverage. - Added Storybook provider-vault fixtures and captured screenshots for the new UX states. ## Verification - `pnpm install --frozen-lockfile --ignore-scripts` - `pnpm exec vitest run packages/shared/src/validators/secret.test.ts server/src/__tests__/aws-secrets-manager-provider.test.ts server/src/__tests__/secrets-routes.test.ts server/src/__tests__/secrets-service.test.ts ui/src/pages/Secrets.render.test.tsx` - Result: 4 files passed, 1 embedded Postgres-backed file skipped on this host because local Postgres init was unavailable. - `pnpm --filter @paperclipai/ui exec vitest run src/pages/Secrets.render.test.tsx` - `pnpm --filter @paperclipai/ui typecheck` - Storybook screenshot capture against `Product/Secrets` on `http://127.0.0.1:60381/iframe.html?id=product-secrets--secrets-inventory&viewMode=story&globals=theme:dark` ## Screenshots Provider vaults tab after this change:  AWS discovery candidate flow:  Provider vault removal confirmation:  ## Risks - Secret provider metadata handling must remain non-sensitive; validators reject credential-bearing Vault URLs and sensitive AWS discovery keys. - AWS discovery depends on deployment credentials being configured correctly outside Paperclip-managed company secrets. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5-based coding agent with local shell/git/tool use. Exact hosted model ID and context-window size are not exposed by the local Paperclip adapter 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 checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
158 lines
5.5 KiB
TypeScript
158 lines
5.5 KiB
TypeScript
import type {
|
|
CompanySecret,
|
|
CompanySecretUsageBinding,
|
|
CompanySecretProviderConfig,
|
|
SecretProviderConfigDiscoveryPreviewResult,
|
|
RemoteSecretImportPreviewResult,
|
|
RemoteSecretImportResult,
|
|
SecretAccessEvent,
|
|
SecretManagedMode,
|
|
SecretProvider,
|
|
SecretProviderConfigStatus,
|
|
SecretProviderConfigHealthResponse,
|
|
SecretProviderDescriptor,
|
|
SecretStatus,
|
|
} from "@paperclipai/shared";
|
|
import { api } from "./client";
|
|
|
|
export interface SecretUsageResponse {
|
|
secretId: string;
|
|
bindings: CompanySecretUsageBinding[];
|
|
}
|
|
|
|
export interface CreateSecretInput {
|
|
name: string;
|
|
key?: string;
|
|
provider?: SecretProvider;
|
|
managedMode?: SecretManagedMode;
|
|
value?: string | null;
|
|
description?: string | null;
|
|
externalRef?: string | null;
|
|
providerVersionRef?: string | null;
|
|
providerConfigId?: string | null;
|
|
providerMetadata?: Record<string, unknown> | null;
|
|
}
|
|
|
|
export interface SecretProviderHealthResponse {
|
|
providers: Array<{
|
|
provider: SecretProvider;
|
|
status: "ok" | "warn" | "error";
|
|
message: string;
|
|
warnings?: string[];
|
|
backupGuidance?: string[];
|
|
details?: Record<string, unknown>;
|
|
}>;
|
|
}
|
|
|
|
export interface UpdateSecretInput {
|
|
name?: string;
|
|
key?: string;
|
|
status?: SecretStatus;
|
|
description?: string | null;
|
|
externalRef?: string | null;
|
|
providerMetadata?: Record<string, unknown> | null;
|
|
}
|
|
|
|
export interface RotateSecretInput {
|
|
value?: string | null;
|
|
externalRef?: string | null;
|
|
providerVersionRef?: string | null;
|
|
providerConfigId?: string | null;
|
|
}
|
|
|
|
export interface CreateSecretProviderConfigInput {
|
|
provider: SecretProvider;
|
|
displayName: string;
|
|
status?: SecretProviderConfigStatus;
|
|
isDefault?: boolean;
|
|
config?: Record<string, unknown>;
|
|
}
|
|
|
|
export interface UpdateSecretProviderConfigInput {
|
|
displayName?: string;
|
|
status?: SecretProviderConfigStatus;
|
|
isDefault?: boolean;
|
|
config?: Record<string, unknown>;
|
|
}
|
|
|
|
export interface RemoteImportPreviewInput {
|
|
providerConfigId: string;
|
|
query?: string | null;
|
|
nextToken?: string | null;
|
|
pageSize?: number;
|
|
}
|
|
|
|
export interface RemoteImportSelectionInput {
|
|
externalRef: string;
|
|
name?: string | null;
|
|
key?: string | null;
|
|
description?: string | null;
|
|
providerVersionRef?: string | null;
|
|
providerMetadata?: Record<string, unknown> | null;
|
|
}
|
|
|
|
export interface RemoteImportInput {
|
|
providerConfigId: string;
|
|
secrets: RemoteImportSelectionInput[];
|
|
}
|
|
|
|
export interface SecretProviderConfigDiscoveryPreviewInput {
|
|
provider: SecretProvider;
|
|
config?: Record<string, unknown>;
|
|
query?: string | null;
|
|
nextToken?: string | null;
|
|
pageSize?: number;
|
|
}
|
|
|
|
export const secretsApi = {
|
|
list: (companyId: string) => api.get<CompanySecret[]>(`/companies/${companyId}/secrets`),
|
|
providers: (companyId: string) =>
|
|
api.get<SecretProviderDescriptor[]>(`/companies/${companyId}/secret-providers`),
|
|
providerHealth: (companyId: string) =>
|
|
api.get<SecretProviderHealthResponse>(`/companies/${companyId}/secret-providers/health`),
|
|
providerConfigs: (companyId: string) =>
|
|
api.get<CompanySecretProviderConfig[]>(`/companies/${companyId}/secret-provider-configs`),
|
|
providerConfigDiscoveryPreview: (
|
|
companyId: string,
|
|
data: SecretProviderConfigDiscoveryPreviewInput,
|
|
) =>
|
|
api.post<SecretProviderConfigDiscoveryPreviewResult>(
|
|
`/companies/${companyId}/secret-provider-configs/discovery/preview`,
|
|
data,
|
|
),
|
|
createProviderConfig: (companyId: string, data: CreateSecretProviderConfigInput) =>
|
|
api.post<CompanySecretProviderConfig>(`/companies/${companyId}/secret-provider-configs`, data),
|
|
updateProviderConfig: (id: string, data: UpdateSecretProviderConfigInput) =>
|
|
api.patch<CompanySecretProviderConfig>(`/secret-provider-configs/${id}`, data),
|
|
disableProviderConfig: (id: string) =>
|
|
api.patch<CompanySecretProviderConfig>(`/secret-provider-configs/${id}`, { status: "disabled" }),
|
|
removeProviderConfig: (id: string) =>
|
|
api.delete<CompanySecretProviderConfig>(`/secret-provider-configs/${id}`),
|
|
setDefaultProviderConfig: (id: string) =>
|
|
api.post<CompanySecretProviderConfig>(`/secret-provider-configs/${id}/default`, {}),
|
|
checkProviderConfigHealth: (id: string) =>
|
|
api.post<SecretProviderConfigHealthResponse>(`/secret-provider-configs/${id}/health`, {}),
|
|
create: (companyId: string, data: CreateSecretInput) =>
|
|
api.post<CompanySecret>(`/companies/${companyId}/secrets`, data),
|
|
update: (id: string, data: UpdateSecretInput) =>
|
|
api.patch<CompanySecret>(`/secrets/${id}`, data),
|
|
rotate: (id: string, data: RotateSecretInput) =>
|
|
api.post<CompanySecret>(`/secrets/${id}/rotate`, data),
|
|
disable: (id: string) =>
|
|
api.patch<CompanySecret>(`/secrets/${id}`, { status: "disabled" satisfies SecretStatus }),
|
|
enable: (id: string) =>
|
|
api.patch<CompanySecret>(`/secrets/${id}`, { status: "active" satisfies SecretStatus }),
|
|
archive: (id: string) =>
|
|
api.patch<CompanySecret>(`/secrets/${id}`, { status: "archived" satisfies SecretStatus }),
|
|
remove: (id: string) => api.delete<{ ok: true }>(`/secrets/${id}`),
|
|
usage: (id: string) => api.get<SecretUsageResponse>(`/secrets/${id}/usage`),
|
|
accessEvents: (id: string) => api.get<SecretAccessEvent[]>(`/secrets/${id}/access-events`),
|
|
remoteImportPreview: (companyId: string, data: RemoteImportPreviewInput) =>
|
|
api.post<RemoteSecretImportPreviewResult>(
|
|
`/companies/${companyId}/secrets/remote-import/preview`,
|
|
data,
|
|
),
|
|
remoteImport: (companyId: string, data: RemoteImportInput) =>
|
|
api.post<RemoteSecretImportResult>(`/companies/${companyId}/secrets/remote-import`, data),
|
|
};
|