@@ -28,8 +28,8 @@ DELETE /api/v1/packages/:packageId — Uninstall a package
2828## TypeScript Usage
2929
3030``` typescript
31- import { GetInstalledPackageRequestSchema , GetInstalledPackageResponseSchema , ListInstalledPackagesRequestSchema , ListInstalledPackagesResponseSchema , PackageApiErrorCode , PackageInstallRequestSchema , PackageInstallResponseSchema , PackagePathParamsSchema , PackageRollbackRequestSchema , PackageUpgradeRequestSchema , PackageUpgradeResponseSchema , ResolveDependenciesRequestSchema , ResolveDependenciesResponseSchema , UninstallPackageApiRequestSchema , UninstallPackageApiResponseSchema , UploadArtifactRequestSchema , UploadArtifactResponseSchema } from ' @objectstack/spec/api' ;
32- import type { GetInstalledPackageRequest , GetInstalledPackageResponse , ListInstalledPackagesRequest , ListInstalledPackagesResponse , PackageApiErrorCode , PackageInstallRequest , PackageInstallResponse , PackagePathParams , PackageRollbackRequest , PackageUpgradeRequest , PackageUpgradeResponse , ResolveDependenciesRequest , ResolveDependenciesResponse , UninstallPackageApiRequest , UninstallPackageApiResponse , UploadArtifactRequest , UploadArtifactResponse } from ' @objectstack/spec/api' ;
31+ import { GetInstalledPackageRequestSchema , GetInstalledPackageResponseSchema , ListInstalledPackagesRequestSchema , ListInstalledPackagesResponseSchema , PackageApiErrorCode , PackageInstallRequestSchema , PackageInstallResponseSchema , PackagePathParamsSchema , PackageRollbackRequestSchema , PackageRollbackResponseSchema , PackageUpgradeRequestSchema , PackageUpgradeResponseSchema , ResolveDependenciesRequestSchema , ResolveDependenciesResponseSchema , UninstallPackageApiRequestSchema , UninstallPackageApiResponseSchema , UploadArtifactRequestSchema , UploadArtifactResponseSchema } from ' @objectstack/spec/api' ;
32+ import type { GetInstalledPackageRequest , GetInstalledPackageResponse , ListInstalledPackagesRequest , ListInstalledPackagesResponse , PackageApiErrorCode , PackageInstallRequest , PackageInstallResponse , PackagePathParams , PackageRollbackRequest , PackageRollbackResponse , PackageUpgradeRequest , PackageUpgradeResponse , ResolveDependenciesRequest , ResolveDependenciesResponse , UninstallPackageApiRequest , UninstallPackageApiResponse , UploadArtifactRequest , UploadArtifactResponse } from ' @objectstack/spec/api' ;
3333
3434// Validate data
3535const result = GetInstalledPackageRequestSchema .parse (data );
@@ -287,6 +287,43 @@ Rollback package request
287287| ** rollbackCustomizations** | ` boolean ` | optional (default: ` true ` ) | Whether to restore pre-upgrade customizations |
288288
289289
290+ ---
291+
292+ ## PackageRollbackResponse
293+
294+ Rollback package response
295+
296+ ### Properties
297+
298+ | Property | Type | Required | Description |
299+ | :--- | :--- | :--- | :--- |
300+ | ** success** | ` boolean ` | ✅ | Operation success status |
301+ | ** error** | ` { code: Enum<'VALIDATION_ERROR' \| 'INVALID_FIELD' \| 'MISSING_REQUIRED_FIELD' \| …>; declaredCode?: string; message: string; userMessage?: string; … } ` | optional | Error details if success is false |
302+ | ** meta** | ` { timestamp: string; duration?: number; requestId?: string; traceId?: string } ` | optional | Response metadata |
303+ | ** data** | ` { success: boolean; restoredVersion?: string; message?: string } ` | ✅ | |
304+
305+ ### Nested Shape: ` PackageRollbackResponse.error `
306+
307+ | Property | Type | Required | Description |
308+ | :--- | :--- | :--- | :--- |
309+ | ** code** | ` Enum<'VALIDATION_ERROR' \| 'INVALID_FIELD' \| 'MISSING_REQUIRED_FIELD' \| …> ` | ✅ | Error code (e.g. VALIDATION_ERROR; StandardErrorCode ∪ the ledger the serving side registers — ERROR_CODE_LEDGER for framework packages) |
310+ | ** declaredCode** | ` string ` | optional | The producer-declared code, verbatim, when it is not a member of the closed ` code ` vocabulary — the open, author-authored channel (app-specific spellings; ADR-0112, #9106 ) |
311+ | ** message** | ` string ` | ✅ | Readable error message |
312+ | ** userMessage** | ` string ` | optional | Producer-marked user-facing refusal text, verbatim (#9934 ). Present exactly when the producer opted in at throw time; consumers render it to end users and keep their generic substitution (#3821 ) for anything unmarked. Status-agnostic; never replaces ` message ` . |
313+ | ** category** | ` string ` | optional | Error category (e.g. validation, authorization) |
314+ | ** httpStatus** | ` integer ` | optional | HTTP status of the response carrying this error |
315+ | ** details** | ` any ` | optional | Additional error context (e.g. field validation errors) |
316+ | ** requestId** | ` string ` | optional | Request ID for tracking |
317+
318+ ### Nested Shape: ` PackageRollbackResponse.data `
319+
320+ | Property | Type | Required | Description |
321+ | :--- | :--- | :--- | :--- |
322+ | ** success** | ` boolean ` | ✅ | Whether the rollback succeeded |
323+ | ** restoredVersion** | ` string ` | optional | Restored version |
324+ | ** message** | ` string ` | optional | Rollback status message |
325+
326+
290327---
291328
292329## PackageUpgradeRequest
0 commit comments