Skip to content

Commit 6b2129f

Browse files
docs(skills): name the objectui upload packages after the providers fold (#30683)
<!-- claude-projects-attribution: {"github_login":"os-elon-musk"} --> _Requested by **Elon** · [project thread](https://claude.ai/code/project/chan_01WedDzV26nniwxv7jC88B9D?thread=cmsg_01WedDzV26nniwxv7jC88B9DRcxA4Y78HaWBtydhVvejsk)_ Fixes #30559 Clause-②: no Metadata-protocol: none ## 维护者速读 - 改了什么:objectui 技能的 project-setup 指南里两处上传说明(provider 列表与决策矩阵)不再指向已退役的 `@object-ui/providers`,改为点名 `@object-ui/fields`、`@object-ui/data-objectstack` 与 `@object-ui/types`。 - 为什么改:PR #30550 把上传能力并入 fields 并退役 providers 包;客户 agent 按旧指南会装一个不再发版、也没有上传上下文的依赖。 - 风险与回滚:纯文档,不动代码与契约;回滚即 revert 本 PR。为付令牌棘轮,删了故障排查里两条只适用于 monorepo 的提示(Turbo 缓存一节与「下游包要先 build dist」一行)。 - 先看:`skills/objectui/guides/project-setup.md` 的 L249 段与决策矩阵上传行;其次故障排查节的两处删除。 - 两分钟验证:`git grep -n "@object-ui/providers" -- skills/` 预期零命中;`node scripts/check-skills-token-ratchet.mjs` 预期该文件 2726/2727 绿。 - 需要你做的:批准并合并(`skills/**` 为 Tier H,人合)。 ## What changes - `skills/objectui/guides/project-setup.md`, provider-stack list: `UploadProvider` / `useUpload` now come from `@object-ui/fields`; the ObjectStack storage adapter `createObjectStackUploadAdapter` from `@object-ui/data-objectstack`; the `UploadAdapter` / `UploadOptions` / `UploadResult` contract from `@object-ui/types`, re-exported by `@object-ui/fields`. - Decision matrix, uploads row: `+ @object-ui/fields (UploadProvider), @object-ui/data-objectstack (adapter)`. - Token payment (same-file deletion, no ceiling move): the troubleshooting section drops the `### Turbo cache issues` block and the `Run pnpm build — downstream packages need built dist/ directories` line. Both are advice for working inside the ObjectUI monorepo, not for a third-party app that consumes published packages; nothing else in the guide or the objectui skill points to them (`grep -i turbo` over the guide, `SKILL.md` and `README.md`: 0 hits after the edit). - One root changeset, `'@objectstack/skills': patch`. Every name was read off `origin/main` b77c160, not off the card: `ui/packages/fields/src/index.tsx` L5485 (`UploadProvider`, `useUpload`) and L5486 (re-export of `UploadAdapter`, `UploadOptions`, `UploadResult` from `@object-ui/types`); `ui/packages/data-objectstack/src/index.ts` L8024 (`createObjectStackUploadAdapter`); `ui/packages/types/src/index.ts` L498 (the contract). `ui/packages/providers` no longer exists on `main`. All three packages are published (no `private` flag). No other `skills/**` line names `@object-ui/providers`. ## Tests Docs-only diff; no test pins changed behaviour, so no ablation. <details><summary>Skills size readings (head 67b7dec)</summary> - Edited file: `skills/objectui/guides/project-setup.md` 349 → 346 lines, 2718 → 2726 tokens (ceiling 2727, headroom 1). - Whole package, sum of every `SKILL.md`: 4534 → 4534 lines (no `SKILL.md` touched). - Bundle total (whole shipped tree, `check-skills-token-ratchet`): 226234 → 226242 tokens. </details> ## Acceptance notes - The dispatch asked that nothing else in the guide change; the two troubleshooting deletions are the token-ratchet payment. The seat accepted the Turbo block; the `dist/` line was needed for the last 3 tokens and is the same monorepo-only class. ## Verification Local subset at head 67b7dec: `node scripts/pm/dispatch-gates.mjs --ran` reconciles 44 derived families: 43 run with exit 0, 1 NOT MEASURED. `pnpm lint` exit 0 (outside the derivation). <details><summary>Gate readings</summary> - `node scripts/check-skills-token-ratchet.mjs`: exit 0, "57 authored bundle file(s) within their ceilings". - `pnpm --dir ui exec vitest run scripts/`: exit 0, Test Files 170 passed / 2 skipped, Tests 4970 passed / 2 skipped. - `pnpm check:dual-build-cjs-loads`: NOT MEASURED, reason: PREREQUISITE NOT MET (exit 3), the gate reads every package's built `dist/` and this worktree built only the closures the derived gates need; CI builds first. - Every other derived family: exit 0. </details> --- _Generated by [Claude Code](https://claude.ai/code/session_016WV4d1CgLtPgbu4RrVtPDQ)_ Co-authored-by: Claude <noreply@anthropic.com>
1 parent 83fc231 commit 6b2129f

2 files changed

Lines changed: 18 additions & 8 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
'@objectstack/skills': patch
3+
---
4+
5+
docs(skills): the objectui project-setup guide names where uploads live now that `@object-ui/providers` is gone
6+
7+
Clause-②: no
8+
Metadata-protocol: none
9+
10+
- **Before.** `objectui/guides/project-setup.md` sent a third-party app to `@object-ui/providers` for `UploadProvider` / `useUpload`, in the provider-stack list and in the decision matrix. That package is retired and gets no further release.
11+
- **Now.** `UploadProvider` / `useUpload` come from `@object-ui/fields`; the ObjectStack storage adapter `createObjectStackUploadAdapter` comes from `@object-ui/data-objectstack`; the `UploadAdapter` / `UploadOptions` / `UploadResult` contract is `@object-ui/types`'s, re-exported by `@object-ui/fields`.
12+
- The troubleshooting section drops two monorepo-only tips (the Turbo cache block and the "downstream packages need built `dist/`" line), which a third-party app consuming published packages never needs.
13+
- No schema, key or behaviour changes.

‎skills/objectui/guides/project-setup.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,10 @@ The provider stack for a third-party app comes from the packages that read it:
246246
`auto` / `light` / `dark` mode.
247247
- `MetadataProvider` / `useMetadata` (`@object-ui/app-shell`) — apps / objects /
248248
dashboards / pages metadata from the API.
249-
- `UploadProvider` / `useUpload` (`@object-ui/providers`) — the upload adapter the
250-
file and image fields upload through.
249+
- `UploadProvider` / `useUpload` (`@object-ui/fields`) — the adapter file and image
250+
fields upload through; `createObjectStackUploadAdapter`
251+
(`@object-ui/data-objectstack`) is ObjectStack's. Its contract `UploadAdapter` /
252+
`UploadOptions` / `UploadResult` is `@object-ui/types`'s; `fields` re-exports it.
251253

252254
```tsx
253255
import { SchemaRendererProvider, ThemeProvider } from '@object-ui/react';
@@ -304,7 +306,7 @@ a private workspace demo app, not a published package.
304306
|------|-----|
305307
| Bare renderer in existing app | `@object-ui/react` |
306308
| Need the data-source / theme providers | `SchemaRendererProvider`, `ThemeProvider` from `@object-ui/react` |
307-
| Need file / image uploads | + `@object-ui/providers` (`UploadProvider`) |
309+
| Need file / image uploads | + `@object-ui/fields` (`UploadProvider`), `@object-ui/data-objectstack` (adapter) |
308310
| Need shell + object/dashboard/page/record views | + `@object-ui/app-shell` |
309311
| Need full admin console (sidebar, system hub, navigation) | study `apps/console` patterns |
310312
| Need a CLI-driven dev server | `@object-ui/cli` (`objectui dev`) |
@@ -337,13 +339,8 @@ Access in code: `import.meta.env.VITE_API_BASE_URL`
337339

338340
### Module not found errors
339341
- Run `pnpm install` to ensure workspace links are resolved
340-
- Run `pnpm build` — downstream packages need built `dist/` directories
341342
- Check `tsconfig.json` path aliases match project structure
342343

343-
### Turbo cache issues
344-
- `pnpm turbo run build --force` to bypass cache
345-
- Delete `.turbo/` directory for clean state
346-
347344
### Vite HMR not working
348345
- Check `vite.config.ts` has `react()` plugin
349346
- Ensure file extensions are `.tsx` not `.jsx` when using TypeScript

0 commit comments

Comments
 (0)