Skip to content

Commit 2f2c6fe

Browse files
committed
chore(spec): regenerate the API reference on the merged tree (#23073)
Step 4 of os-regen-merge: the two os-regen mdx files regenerated from the merge of origin/main 55828c5, carrying #23098's and #23075's rows and this card's member rows. Claude-Session: https://claude.ai/code/session_01GZSPSQ5ArPjSJdxxuqwGoZ Co-authored-by: Claude <noreply@anthropic.com>
1 parent 15b37f9 commit 2f2c6fe

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

‎content/docs/references/api/package-lifecycle.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ const result = DiscardPackageDraftsResponseSchema.parse(data);
144144
| **namespace** | `string` | ✅ | The base's namespace — the SOURCE package's, kept so every copied object name stays valid. |
145145
| **copiedCount** | `number` | ✅ | How many items were copied. |
146146
| **copied** | `{ type: string; name: string }[]` | ✅ | Every item that was copied, in the order it was written. |
147+
| **strippedLocks** | `{ type: string; name: string; lock: Enum<'no-overlay' \| 'no-delete' \| 'full'>; reason?: string }[]` | ✅ | Every protection lock the package shipped on a copied item and the copy does not keep, in the order the items were written. Empty when the package locked nothing. |
147148

148149
### Nested Shape: `ImportUnmanagedPackageResponse.copied[number]`
149150

@@ -152,6 +153,15 @@ const result = DiscardPackageDraftsResponseSchema.parse(data);
152153
| **type** | `string` | ✅ | Metadata type of the copied item. |
153154
| **name** | `string` | ✅ | Name of the copied item. |
154155

156+
### Nested Shape: `ImportUnmanagedPackageResponse.strippedLocks[number]`
157+
158+
| Property | Type | Required | Description |
159+
| :--- | :--- | :--- | :--- |
160+
| **type** | `string` | ✅ | Metadata type of the copied item. |
161+
| **name** | `string` | ✅ | Name of the copied item. |
162+
| **lock** | `Enum<'no-overlay' \| 'no-delete' \| 'full'>` | ✅ | The lock the package shipped on the item — its `protection` block's `lock`, else its `_lock`. The copy carries no lock. |
163+
| **reason** | `string` | optional | The reason the package gave for that lock, verbatim. Absent when it gave none. |
164+
155165

156166
---
157167

‎content/docs/references/api/protocol.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1731,7 +1731,7 @@ The published metadata item body, opaque by ruling (1C). Shape is the item's own
17311731
| **addRecord** | `{ enabled?: boolean; position?: Enum<'top' \| 'bottom' \| 'both'>; mode?: Enum<'inline' \| 'form' \| 'modal'>; formView?: string }` | optional | Add record entry point configuration |
17321732
| **showRecordCount** | `boolean` | optional | Show record count at the bottom of the list |
17331733
| **allowPrinting** | `boolean` | optional | Allow users to print the view |
1734-
| **emptyState** | `{ title?: string \| Record<string, string>; message?: string \| Record<string, string>; icon?: string }` | optional | Empty state configuration when no records found |
1734+
| **emptyState** | `{ title?: string \| Record<string, string>; message?: string \| Record<string, string>; icon?: string; link?: object }` | optional | Empty state configuration when no records found |
17351735
| **aria** | `{ ariaLabel?: string \| Record<string, string>; ariaDescribedBy?: string; role?: string }` | optional | ARIA accessibility attributes for the list view |
17361736
| **responsive** | `never` | optional | [REMOVED] `view.responsive` was removed in @objectstack/spec 17.0.0 (audit close-out) — no renderer ever read it; the grid is responsive by its own layout rules. Delete the key. Run `os migrate meta --from 16` to list the mechanical edits for existing sources; `--write` applies the ones it can prove, and you apply the rest by hand. |
17371737
| **performance** | `never` | optional | [REMOVED] `view.performance` was removed in @objectstack/spec 17.0.0 (audit close-out) — no renderer or runtime read it; list-view performance tuning was never implemented. Delete the key. Run `os migrate meta --from 16` to list the mechanical edits for existing sources; `--write` applies the ones it can prove, and you apply the rest by hand. |
@@ -1817,7 +1817,7 @@ The published metadata item body, opaque by ruling (1C). Shape is the item's own
18171817
| **addRecord** | `{ enabled?: boolean; position?: Enum<'top' \| 'bottom' \| 'both'>; mode?: Enum<'inline' \| 'form' \| 'modal'>; formView?: string }` | optional | Add record entry point configuration |
18181818
| **showRecordCount** | `boolean` | optional | Show record count at the bottom of the list |
18191819
| **allowPrinting** | `boolean` | optional | Allow users to print the view |
1820-
| **emptyState** | `{ title?: string \| Record<string, string>; message?: string \| Record<string, string>; icon?: string }` | optional | Empty state configuration when no records found |
1820+
| **emptyState** | `{ title?: string \| Record<string, string>; message?: string \| Record<string, string>; icon?: string; link?: object }` | optional | Empty state configuration when no records found |
18211821
| **aria** | `{ ariaLabel?: string \| Record<string, string>; ariaDescribedBy?: string; role?: string }` | optional | ARIA accessibility attributes for the list view |
18221822
| **responsive** | `never` | optional | [REMOVED] `view.responsive` was removed in @objectstack/spec 17.0.0 (audit close-out) — no renderer ever read it; the grid is responsive by its own layout rules. Delete the key. Run `os migrate meta --from 16` to list the mechanical edits for existing sources; `--write` applies the ones it can prove, and you apply the rest by hand. |
18231823
| **performance** | `never` | optional | [REMOVED] `view.performance` was removed in @objectstack/spec 17.0.0 (audit close-out) — no renderer or runtime read it; list-view performance tuning was never implemented. Delete the key. Run `os migrate meta --from 16` to list the mechanical edits for existing sources; `--write` applies the ones it can prove, and you apply the rest by hand. |

0 commit comments

Comments
 (0)