@numericoach/gskills-admin-cli 0.1.32 → 0.1.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated from `src/cli/content-platform-resource-guides.ts`. Edit that source and run `bun run --cwd packages/gskills-admin-cli docs:content-platform` to refresh both copies. Each entry is also available through `<resource> help` and `content-platform explain <resource>`.
|
|
4
4
|
|
|
5
|
-
This reference covers all
|
|
5
|
+
This reference covers all 78 models in the page platform, translation batch, content inheritance, migration control, workflow platform, quiz revision and stable child identity schemas.
|
|
6
6
|
|
|
7
7
|
All resources below are read-only in the CLI. Named writers are internal product operations or system workers, not CLI commands you can invoke by typing their names. Author pages with the guarded `page-authoring` family (editor, create, draft, readiness, publish, upload-image) and run every other admin write by name with `admin ops` / `admin run` (pages.restore-revision, pages.archive, pages.unpublish, quizzes.*, learning-paths.*, catalogue.* ...). See [the operating guide](content-platform.md) for the authority checks and supported workflows.
|
|
8
8
|
|
|
@@ -12,7 +12,14 @@ Examples are read-only queries. Replace angle-bracket placeholders with verified
|
|
|
12
12
|
|
|
13
13
|
| CLI resource | Prisma model |
|
|
14
14
|
| --- | --- |
|
|
15
|
+
| [content-catalogue-generations](#content-catalogue-generations) | `ContentCatalogueGeneration` |
|
|
16
|
+
| [content-governance-checklist-items](#content-governance-checklist-items) | `ContentGovernanceChecklistItem` |
|
|
17
|
+
| [learning-path-publications](#learning-path-publications) | `LearningPathPublication` |
|
|
18
|
+
| [learning-path-revisions](#learning-path-revisions) | `LearningPathRevision` |
|
|
19
|
+
| [learning-path-obligation-baselines](#learning-path-obligation-baselines) | `LearningPathObligationBaseline` |
|
|
15
20
|
| [canonical-pages](#canonical-pages) | `Page` |
|
|
21
|
+
| [page-personal-drafts](#page-personal-drafts) | `PagePersonalDraft` |
|
|
22
|
+
| [pending-changes](#pending-changes) | `PendingChange` |
|
|
16
23
|
| [page-locales](#page-locales) | `PageLocale` |
|
|
17
24
|
| [page-revisions](#page-revisions) | `PageRevision` |
|
|
18
25
|
| [page-revision-categories](#page-revision-categories) | `PageRevisionCategory` |
|
|
@@ -84,6 +91,116 @@ Examples are read-only queries. Replace angle-bracket placeholders with verified
|
|
|
84
91
|
| [learning-path-item-identities](#learning-path-item-identities) | `LearningPathItemIdentity` |
|
|
85
92
|
| [chromebook-exercise-step-identities](#chromebook-exercise-step-identities) | `ChromebookExerciseStepIdentity` |
|
|
86
93
|
|
|
94
|
+
## content-catalogue-generations
|
|
95
|
+
|
|
96
|
+
Prisma model `ContentCatalogueGeneration` in `prisma/schema/Content/ContentInheritance.prisma`.
|
|
97
|
+
|
|
98
|
+
**Purpose.** Generation of the shared catalogue snapshot for one content type.
|
|
99
|
+
|
|
100
|
+
**Key.** `contentType`. Use list --where with contentType. There is no scalar id for get <id>.
|
|
101
|
+
|
|
102
|
+
**Relationships.** The generation keys the cache of ownerless families, locales and shared aliases of that content type.
|
|
103
|
+
|
|
104
|
+
**Inspect it when.** Investigate whether a shared catalogue change advanced its cache generation.
|
|
105
|
+
|
|
106
|
+
**Who writes it.** Deferred database triggers; the guarded generation-advance maintenance script after a restore that bypassed triggers.
|
|
107
|
+
|
|
108
|
+
**Avoid this mistake.** Never change this counter through generic CRUD. It has no scalar id: use list --where with contentType.
|
|
109
|
+
|
|
110
|
+
**Scope.** This resource has no --instance filter. Use the documented key/relationship fields in --where to locate the intended scope.
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
gskills-admin content-catalogue-generations list --where '{"contentType":"PAGE"}' --output json
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## content-governance-checklist-items
|
|
117
|
+
|
|
118
|
+
Prisma model `ContentGovernanceChecklistItem` in `prisma/schema/Operations/ContentGovernance.prisma`.
|
|
119
|
+
|
|
120
|
+
**Purpose.** Ordered checklist steps and completion state of an Editor Space content task.
|
|
121
|
+
|
|
122
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
123
|
+
|
|
124
|
+
**Relationships.** entryId references ContentGovernanceEntry; its instance owns the task.
|
|
125
|
+
|
|
126
|
+
**Inspect it when.** Inspect task checklist order or completion alongside the governance entry.
|
|
127
|
+
|
|
128
|
+
**Who writes it.** Editor Space content-task checklist operations, also exposed through the product MCP.
|
|
129
|
+
|
|
130
|
+
**Avoid this mistake.** Use the authorized content-task operations to change a checklist, not generic CRUD.
|
|
131
|
+
|
|
132
|
+
**Scope.** --instance filters entry.instanceId. This raw filter does not compute inherited availability or effective access.
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
gskills-admin content-governance-checklist-items list --where '{"entryId":"<entryId>"}' --output json
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## learning-path-publications
|
|
139
|
+
|
|
140
|
+
Prisma model `LearningPathPublication` in `prisma/schema/Learning/LearningPathPublication.prisma`.
|
|
141
|
+
|
|
142
|
+
**Purpose.** One draft and one global publication pointer for a canonical learning-path family.
|
|
143
|
+
|
|
144
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
145
|
+
|
|
146
|
+
**Relationships.** id refers to ContentFamilyIdentity; revision pointers refer to LearningPathRevision in the same family.
|
|
147
|
+
|
|
148
|
+
**Inspect it when.** Audit publication pointers, owner scope and whether the revision authority has been activated.
|
|
149
|
+
|
|
150
|
+
**Who writes it.** Learning-path revision repository and the audited migration preparation. Runtime integration is not activated yet.
|
|
151
|
+
|
|
152
|
+
**Avoid this mistake.** A null activatedAt means prepared storage only. Never activate it or move pointers through generic CRUD.
|
|
153
|
+
|
|
154
|
+
**Scope.** --instance filters instanceId. This raw filter does not compute inherited availability or effective access.
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
gskills-admin learning-path-publications list --where '{"instanceId":"<instanceId>"}' --output json
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## learning-path-revisions
|
|
161
|
+
|
|
162
|
+
Prisma model `LearningPathRevision` in `prisma/schema/Learning/LearningPathPublication.prisma`.
|
|
163
|
+
|
|
164
|
+
**Purpose.** Path-owned wording, structure and content references; published revisions are immutable.
|
|
165
|
+
|
|
166
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
167
|
+
|
|
168
|
+
**Relationships.** publicationId scopes the revision. basedOnRevisionId and restoredFromRevisionId reference published revisions of this family.
|
|
169
|
+
|
|
170
|
+
**Inspect it when.** Inspect draft concurrency or compare path publication history.
|
|
171
|
+
|
|
172
|
+
**Who writes it.** LearningPathRevisionRepository; guarded runtime transports are still pending integration.
|
|
173
|
+
|
|
174
|
+
**Avoid this mistake.** The snapshot contains no linked content versions. A restored path must not restore its courses or quizzes.
|
|
175
|
+
|
|
176
|
+
**Scope.** --instance filters publication.instanceId. This raw filter does not compute inherited availability or effective access.
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
gskills-admin learning-path-revisions list --where '{"publicationId":"<familyId>"}' --output json
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## learning-path-obligation-baselines
|
|
183
|
+
|
|
184
|
+
Prisma model `LearningPathObligationBaseline` in `prisma/schema/Learning/LearningPathPublication.prisma`.
|
|
185
|
+
|
|
186
|
+
**Purpose.** Immutable set of required step identities captured for one learner at their first start.
|
|
187
|
+
|
|
188
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
189
|
+
|
|
190
|
+
**Relationships.** publicationId identifies the path family; startedRevisionId identifies its initial published version; consumerInstanceId is the learner scope.
|
|
191
|
+
|
|
192
|
+
**Inspect it when.** Explain why a newly added step is optional for an existing learner.
|
|
193
|
+
|
|
194
|
+
**Who writes it.** LearningPathObligationsRepository within a start or migration transaction; runtime integration is pending.
|
|
195
|
+
|
|
196
|
+
**Avoid this mistake.** Do not rewrite obligations when a new version is published or erase historical completions when steps disappear.
|
|
197
|
+
|
|
198
|
+
**Scope.** --instance filters consumerInstanceId. This raw filter does not compute inherited availability or effective access.
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
gskills-admin learning-path-obligation-baselines list --where '{"consumerInstanceId":"<instanceId>","publicationId":"<familyId>"}' --output json
|
|
202
|
+
```
|
|
203
|
+
|
|
87
204
|
## canonical-pages
|
|
88
205
|
|
|
89
206
|
Prisma model `Page` in `prisma/schema/Content/PagePlatform.prisma`.
|
|
@@ -106,6 +223,50 @@ Prisma model `Page` in `prisma/schema/Content/PagePlatform.prisma`.
|
|
|
106
223
|
gskills-admin canonical-pages list --where '{"id":"<pageId>"}' --output json
|
|
107
224
|
```
|
|
108
225
|
|
|
226
|
+
## page-personal-drafts
|
|
227
|
+
|
|
228
|
+
Prisma model `PagePersonalDraft` in `prisma/schema/Content/PagePlatform.prisma`.
|
|
229
|
+
|
|
230
|
+
**Purpose.** One author-owned working snapshot for an existing canonical page, separate from the shared draft and submitted proposals.
|
|
231
|
+
|
|
232
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
233
|
+
|
|
234
|
+
**Relationships.** pageId refers to Page; authorId refers to User. Base revision identity and version fence the complete snapshot.
|
|
235
|
+
|
|
236
|
+
**Inspect it when.** Diagnose a private autosave conflict using its author, base revision and authority epoch.
|
|
237
|
+
|
|
238
|
+
**Who writes it.** Native Editor Space personal-draft save; submission atomically freezes a PendingChange and consumes the personal draft.
|
|
239
|
+
|
|
240
|
+
**Avoid this mistake.** Never write this table through generic CRUD or treat its unsent snapshot as a shared course revision.
|
|
241
|
+
|
|
242
|
+
**Scope.** --instance filters page.ownerInstanceId. This raw filter does not compute inherited availability or effective access.
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
gskills-admin page-personal-drafts list --where '{"pageId":"<pageId>","authorId":"<authorId>"}' --output json
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
## pending-changes
|
|
249
|
+
|
|
250
|
+
Prisma model `PendingChange` in `prisma/schema/Operations/ContentUpdate.prisma`.
|
|
251
|
+
|
|
252
|
+
**Purpose.** Immutable submitted content proposals awaiting a scoped review decision.
|
|
253
|
+
|
|
254
|
+
**Key.** `id`. Use get <id> for the primary key or list --where to find related rows.
|
|
255
|
+
|
|
256
|
+
**Relationships.** authorId and reviewerId refer to User; instanceId scopes management. EDITOR_COURSE payloads carry a complete frozen snapshot.
|
|
257
|
+
|
|
258
|
+
**Inspect it when.** Inspect submission status, its stable receipt and the recorded review decision.
|
|
259
|
+
|
|
260
|
+
**Who writes it.** Guarded content submission and reviewer operations; native course submission uses a unique submissionKey.
|
|
261
|
+
|
|
262
|
+
**Avoid this mistake.** A pending proposal is not a shared draft, and its payload must never be edited or applied through generic CRUD.
|
|
263
|
+
|
|
264
|
+
**Scope.** --instance filters instanceId. This raw filter does not compute inherited availability or effective access.
|
|
265
|
+
|
|
266
|
+
```bash
|
|
267
|
+
gskills-admin pending-changes list --where '{"instanceId":"global","entityType":"EDITOR_COURSE","authorId":"<authorId>"}' --output json
|
|
268
|
+
```
|
|
269
|
+
|
|
109
270
|
## page-locales
|
|
110
271
|
|
|
111
272
|
Prisma model `PageLocale` in `prisma/schema/Content/PagePlatform.prisma`.
|