mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-16 19:00:38 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies through company-scoped control-plane workflows. > - Agents need reusable, inspectable skills that can be installed, reset, audited, exported, and assigned without bespoke local setup. > - The existing skill truth model needed cleanup so bundled skills, optional catalog skills, runtime skills, and adapter-provided skills have clear provenance. > - Operators also need a practical CLI and board UI for discovering and managing company skills. > - This pull request adds the skills CLI, packaged skills catalog, company skills APIs, and catalog-aware board UI. > - The benefit is a more reusable Paperclip company setup where skills are portable, auditable, and easier for operators and agents to manage. ## What Changed - Added `paperclipai skills` CLI commands and coverage for catalog listing, installing, resetting, and inspecting company skills. - Added a packaged `@paperclipai/skills-catalog` workspace with bundled and optional skill content plus validation/build tests. - Added shared company-skill types and validators used across CLI, server, and UI contracts. - Added server catalog APIs/services for company skill catalog operations, reset semantics, audit behavior, and portability provenance. - Updated adapter skill handling so runtime/catalog provenance remains explicit across local adapters. - Added board UI support for browsing and managing catalog-backed company skills. - Updated docs for the skills CLI/catalog flow and the company skills Paperclip skill reference. - Rebased the branch onto current `paperclipai/paperclip:master`; no `pnpm-lock.yaml`, `.github/workflows`, or migration files are included in the final PR diff. ## Verification - Passed: `pnpm run preflight:workspace-links && pnpm exec vitest run cli/src/__tests__/skills.test.ts packages/skills-catalog/src/catalog-builder.test.ts packages/skills-catalog/src/shipped-catalog.test.ts packages/shared/src/validators/company-skill.test.ts packages/adapter-utils/src/server-utils.test.ts packages/plugins/create-paperclip-plugin/src/entrypoints.test.ts server/src/__tests__/company-skills-catalog-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-portability.test.ts`. - Passed: `pnpm exec vitest run server/src/__tests__/workspace-runtime.test.ts -t "default branch|origin/master|symbolic-ref"`. - Attempted: full `server/src/__tests__/workspace-runtime.test.ts`. Four provisioning tests failed while seeding an isolated worktree database from the local Paperclip instance because the local plugin schema dump contains a duplicate-column foreign key (`plugin_content_machine_18a7bc327b.content_case_signals`). The default-branch tests touched by the rebase conflict passed in the focused run above. - Checked final diff: no `pnpm-lock.yaml`, no `.github/workflows`, and no migration-file changes relative to `master`. ## Risks - Medium: this is a broad skills/catalog change touching CLI, server APIs, shared contracts, adapter skill sync, and UI. - Catalog validation and reset semantics need careful reviewer attention because they affect reusable company setup and portability. - No database migrations are included in this PR, so there is no migration ordering/idempotency risk in the final diff. - No lockfile is included by design; dependency resolution will be handled by the repository lockfile workflow. ## Model Used - OpenAI Codex coding agent based on GPT-5, running in Paperclip via the `codex_local` adapter with shell, git, GitHub CLI, and code-editing tool access. Exact hosted model build/context-window metadata is not exposed in this 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 targeted tests locally and documented the local workspace-runtime seed failure above - [x] I have added or updated tests where applicable - [x] If this change affects the UI, screenshots were intentionally omitted per PAP-10124 instructions; UI behavior is covered by tests and reviewer inspection - [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>
65 lines
2.1 KiB
TypeScript
65 lines
2.1 KiB
TypeScript
export const PORTABLE_CATALOG_PROVENANCE_STRING_KEYS = [
|
|
"sourceRef",
|
|
"originHash",
|
|
"catalogId",
|
|
"catalogKey",
|
|
"catalogKind",
|
|
"catalogCategory",
|
|
"catalogPath",
|
|
"packageName",
|
|
"packageVersion",
|
|
"originVersion",
|
|
"installedHash",
|
|
"userModifiedAt",
|
|
"updateHoldReason",
|
|
"auditVerdict",
|
|
"auditScannedAt",
|
|
"auditScanVersion",
|
|
] as const;
|
|
|
|
function asCatalogString(value: unknown) {
|
|
if (typeof value !== "string") return null;
|
|
const trimmed = value.trim();
|
|
return trimmed.length > 0 ? trimmed : null;
|
|
}
|
|
|
|
export function readCatalogStringList(value: unknown) {
|
|
if (!Array.isArray(value)) return null;
|
|
const entries = value.map((entry) => asCatalogString(entry)).filter((entry): entry is string => Boolean(entry));
|
|
return entries.length === value.length ? entries : null;
|
|
}
|
|
|
|
function isCatalogRecord(value: unknown): value is Record<string, unknown> {
|
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
}
|
|
|
|
export function readPortableCatalogProvenance(
|
|
metadata: Record<string, unknown> | null,
|
|
canonicalKey: string | null = null,
|
|
) {
|
|
const paperclip = isCatalogRecord(metadata?.paperclip) ? metadata.paperclip : null;
|
|
const catalog = isCatalogRecord(paperclip?.catalog) ? paperclip.catalog : null;
|
|
if (!catalog) return null;
|
|
|
|
const sourceRef = asCatalogString(catalog.sourceRef) ?? asCatalogString(catalog.originHash);
|
|
const normalized: Record<string, unknown> = {
|
|
...(canonicalKey ? { skillKey: canonicalKey } : {}),
|
|
sourceKind: "catalog",
|
|
};
|
|
const catalogSkillKey = asCatalogString(catalog.skillKey);
|
|
if (!canonicalKey && catalogSkillKey) normalized.skillKey = catalogSkillKey;
|
|
|
|
for (const key of PORTABLE_CATALOG_PROVENANCE_STRING_KEYS) {
|
|
if (key === "sourceRef") continue;
|
|
const value = asCatalogString(catalog[key]);
|
|
if (value) normalized[key] = value;
|
|
}
|
|
if (sourceRef && !normalized.originHash) normalized.originHash = sourceRef;
|
|
const auditCodes = readCatalogStringList(catalog.auditCodes);
|
|
if (auditCodes) normalized.auditCodes = auditCodes;
|
|
|
|
return {
|
|
sourceRef,
|
|
metadata: normalized,
|
|
};
|
|
}
|