docs(contracts): mark compatibility aliases and V1 readers deprecated with removal conditions (07-07)
The aliases and V1 config/manifest readers had no @deprecated tag, replacement or removal condition in code, so they could only become permanent. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
0bcee348c5
commit
9e616d3a06
@@ -14,7 +14,13 @@ export type BoundaryMappingResult<Value> =
|
||||
| Readonly<{ ok: true; value: Value }>
|
||||
| Readonly<{ ok: false; code: MappingFailureCode }>;
|
||||
|
||||
/** Compatible alias kept for existing importers; see `BoundaryMappingResult`. */
|
||||
/**
|
||||
* Compatible alias kept for existing importers.
|
||||
*
|
||||
* @deprecated Use `BoundaryMappingResult`. Remove in the next minor release
|
||||
* once no module imports `MappingResult` from this file (owner:
|
||||
* frontend-platform).
|
||||
*/
|
||||
export type MappingResult<Value> = BoundaryMappingResult<Value>;
|
||||
|
||||
/** Adapts a boundary mapper result to the canonical contract mapping result. */
|
||||
|
||||
@@ -135,9 +135,10 @@ export type AppFailure = Readonly<{
|
||||
}>;
|
||||
|
||||
/**
|
||||
* Backward-compatible transport-facing name. New application and presentation
|
||||
* code should prefer AppFailure.
|
||||
* Backward-compatible transport-facing name.
|
||||
*
|
||||
* @deprecated Use `AppFailure`. Remove in the next minor release once
|
||||
* `grep -rw ApiFailure src` finds only this line (owner: frontend-platform).
|
||||
*/
|
||||
export type ApiFailure = AppFailure;
|
||||
|
||||
|
||||
@@ -61,5 +61,9 @@ export function createReadOnlyMap<Key, Value>(
|
||||
return readOnlyFacade(entries);
|
||||
}
|
||||
|
||||
/** Kept here for existing importers; the implementation lives in `exact-snapshot.ts`. */
|
||||
/**
|
||||
* @deprecated Import `exactOwnDataSnapshot` from `./exact-snapshot.ts`. Kept for
|
||||
* downstream importers; remove in the next minor release (owner:
|
||||
* frontend-platform).
|
||||
*/
|
||||
export { exactOwnDataSnapshot } from "./exact-snapshot.ts";
|
||||
|
||||
@@ -151,6 +151,13 @@ const runtimeConfigArtifactFields = {
|
||||
BUILD_ID: z.string().min(1).optional(),
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* @deprecated V1 reader kept for one release after the V2-only writer
|
||||
* (change evidence `FE-REG-ENV:API_CONTRACT_VERSION:*:removed`, 2026-09-24).
|
||||
* Remove it and its re-export in `src/bootstrap/runtime-config-schema.ts`
|
||||
* once no deployed `/config.json` still carries `CONFIG_SCHEMA_VERSION: "1"`
|
||||
* (owner: frontend-platform).
|
||||
*/
|
||||
export const runtimeConfigV1ArtifactSchema = z
|
||||
.object({
|
||||
...runtimeConfigArtifactFields,
|
||||
@@ -188,6 +195,13 @@ const releaseManifestArtifactFields = {
|
||||
routeChunks: z.record(z.string().min(1), z.string().min(1)),
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* @deprecated V1 reader kept for one release after the V2-only writer
|
||||
* (change evidence `FE-REG-ENV:API_CONTRACT_VERSION:*:removed`, 2026-09-24).
|
||||
* Remove it and its re-export in `src/bootstrap/load-release-manifest.ts`
|
||||
* once no deployed `/release-manifest.json` still carries `schemaVersion: 1`
|
||||
* (owner: frontend-platform).
|
||||
*/
|
||||
export const releaseManifestV1ArtifactSchema = z
|
||||
.object({
|
||||
schemaVersion: z.literal(1),
|
||||
|
||||
Reference in New Issue
Block a user