feat(core/schemas): set public release level for schema API (#1766)

kuhe · web-flow · commit 3926fd725e85 · 2025-11-07T14:32:03.000-05:00
diff --git a/.changeset/modern-paws-hear.md b/.changeset/modern-paws-hear.md
@@ -0,0 +1,6 @@
+---
+"@smithy/types": minor
+"@smithy/core": minor
+---
+
+set release level for schemas
diff --git a/packages/core/src/submodules/cbor/CborCodec.ts b/packages/core/src/submodules/cbor/CborCodec.ts
@@ -8,7 +8,7 @@ import { cbor } from "./cbor";
 import { dateToTag } from "./parseCborBody";
 
 /**
- * @alpha
+ * @public
  */
 export class CborCodec extends SerdeContext implements Codec<Uint8Array, Uint8Array> {
   public createSerializer(): CborShapeSerializer {
@@ -25,7 +25,7 @@ export class CborCodec extends SerdeContext implements Codec<Uint8Array, Uint8Ar
 }
 
 /**
- * @alpha
+ * @public
  */
 export class CborShapeSerializer extends SerdeContext implements ShapeSerializer {
   private value: unknown;
@@ -115,7 +115,7 @@ export class CborShapeSerializer extends SerdeContext implements ShapeSerializer
 }
 
 /**
- * @alpha
+ * @public
  */
 export class CborShapeDeserializer extends SerdeContext implements ShapeDeserializer {
   public read(schema: Schema, bytes: Uint8Array): any {
diff --git a/packages/core/src/submodules/cbor/SmithyRpcV2CborProtocol.ts b/packages/core/src/submodules/cbor/SmithyRpcV2CborProtocol.ts
@@ -20,7 +20,7 @@ import { loadSmithyRpcV2CborErrorCode } from "./parseCborBody";
 /**
  * Client protocol for Smithy RPCv2 CBOR.
  *
- * @alpha
+ * @public
  */
 export class SmithyRpcV2CborProtocol extends RpcProtocol {
   private codec = new CborCodec();
diff --git a/packages/core/src/submodules/event-streams/EventStreamSerde.ts b/packages/core/src/submodules/event-streams/EventStreamSerde.ts
@@ -18,7 +18,7 @@ import { fromUtf8 } from "@smithy/util-utf8";
  * Separated module for async mixin of EventStream serde capability.
  * This is used by the HttpProtocol base class from \@smithy/core/protocols.
  *
- * @alpha
+ * @public
  */
 export class EventStreamSerde {
   private readonly marshaller: EventStreamMarshaller;
diff --git a/packages/core/src/submodules/protocols/HttpBindingProtocol.ts b/packages/core/src/submodules/protocols/HttpBindingProtocol.ts
@@ -24,7 +24,7 @@ import { HttpProtocol } from "./HttpProtocol";
  * Base for HTTP-binding protocols. Downstream examples
  * include AWS REST JSON and AWS REST XML.
  *
- * @alpha
+ * @public
  */
 export abstract class HttpBindingProtocol extends HttpProtocol {
   public async serializeRequest<Input extends object>(
diff --git a/packages/core/src/submodules/protocols/HttpProtocol.ts b/packages/core/src/submodules/protocols/HttpProtocol.ts
@@ -26,7 +26,7 @@ import { SerdeContext } from "./SerdeContext";
 /**
  * Abstract base for HTTP-based client protocols.
  *
- * @alpha
+ * @public
  */
 export abstract class HttpProtocol extends SerdeContext implements ClientProtocol<IHttpRequest, IHttpResponse> {
   protected abstract serializer: ShapeSerializer<string | Uint8Array>;
diff --git a/packages/core/src/submodules/protocols/RpcProtocol.ts b/packages/core/src/submodules/protocols/RpcProtocol.ts
@@ -18,7 +18,7 @@ import { HttpProtocol } from "./HttpProtocol";
 /**
  * Abstract base for RPC-over-HTTP protocols.
  *
- * @alpha
+ * @public
  */
 export abstract class RpcProtocol extends HttpProtocol {
   public async serializeRequest<Input extends object>(
diff --git a/packages/core/src/submodules/protocols/serde/FromStringShapeDeserializer.ts b/packages/core/src/submodules/protocols/serde/FromStringShapeDeserializer.ts
@@ -24,7 +24,7 @@ import { determineTimestampFormat } from "./determineTimestampFormat";
 /**
  * This deserializer reads strings.
  *
- * @alpha
+ * @public
  */
 export class FromStringShapeDeserializer extends SerdeContext implements ShapeDeserializer<string> {
   public constructor(private settings: CodecSettings) {
diff --git a/packages/core/src/submodules/protocols/serde/HttpInterceptingShapeDeserializer.ts b/packages/core/src/submodules/protocols/serde/HttpInterceptingShapeDeserializer.ts
@@ -12,7 +12,7 @@ import { FromStringShapeDeserializer } from "./FromStringShapeDeserializer";
  * For example, in a JSON HTTP message, the deserialization of a field will differ depending on whether
  * it is bound to the HTTP header (string) or body (JSON).
  *
- * @alpha
+ * @public
  */
 export class HttpInterceptingShapeDeserializer<CodecShapeDeserializer extends ShapeDeserializer<any>>
   extends SerdeContext
diff --git a/packages/core/src/submodules/protocols/serde/HttpInterceptingShapeSerializer.ts b/packages/core/src/submodules/protocols/serde/HttpInterceptingShapeSerializer.ts
@@ -16,7 +16,7 @@ import { ToStringShapeSerializer } from "./ToStringShapeSerializer";
  * For example, a JavaScript array is serialized differently when being written
  * to a REST JSON HTTP header (comma-delimited string) and a REST JSON HTTP body (JSON array).
  *
- * @alpha
+ * @public
  */
 export class HttpInterceptingShapeSerializer<CodecShapeSerializer extends ShapeSerializer<string | Uint8Array>>
   implements ShapeSerializer<string | Uint8Array>, ConfigurableSerdeContext
diff --git a/packages/core/src/submodules/protocols/serde/ToStringShapeSerializer.ts b/packages/core/src/submodules/protocols/serde/ToStringShapeSerializer.ts
@@ -16,7 +16,7 @@ import { determineTimestampFormat } from "./determineTimestampFormat";
 /**
  * Serializes a shape to string.
  *
- * @alpha
+ * @public
  */
 export class ToStringShapeSerializer extends SerdeContext implements ShapeSerializer<string> {
   private stringBuffer = "";
diff --git a/packages/core/src/submodules/schema/TypeRegistry.ts b/packages/core/src/submodules/schema/TypeRegistry.ts
@@ -5,7 +5,7 @@ import type { ErrorSchema } from "./schemas/ErrorSchema";
 /**
  * A way to look up schema by their ShapeId values.
  *
- * @alpha
+ * @public
  */
 export class TypeRegistry {
   public static readonly registries = new Map<string, TypeRegistry>();
diff --git a/packages/core/src/submodules/schema/schemas/ErrorSchema.ts b/packages/core/src/submodules/schema/schemas/ErrorSchema.ts
@@ -9,7 +9,7 @@ import { StructureSchema } from "./StructureSchema";
  * and have an existing notion of a XYZServiceBaseException, the ErrorSchema differs from a StructureSchema
  * by additionally holding the class reference for the corresponding ServiceException class.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class ErrorSchema extends StructureSchema {
diff --git a/packages/core/src/submodules/schema/schemas/ListSchema.ts b/packages/core/src/submodules/schema/schemas/ListSchema.ts
@@ -6,7 +6,7 @@ import { Schema } from "./Schema";
  * A schema with a single member schema.
  * The deprecated Set type may be represented as a list.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class ListSchema extends Schema implements IListSchema {
diff --git a/packages/core/src/submodules/schema/schemas/MapSchema.ts b/packages/core/src/submodules/schema/schemas/MapSchema.ts
@@ -4,7 +4,7 @@ import { Schema } from "./Schema";
 
 /**
  * A schema with a key schema and value schema.
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class MapSchema extends Schema implements IMapSchema {
diff --git a/packages/core/src/submodules/schema/schemas/NormalizedSchema.ts b/packages/core/src/submodules/schema/schemas/NormalizedSchema.ts
@@ -39,7 +39,7 @@ import { translateTraits } from "./translateTraits";
  * Wraps both class instances, numeric sentinel values, and member schema pairs.
  * Presents a consistent interface for interacting with polymorphic schema representations.
  *
- * @alpha
+ * @public
  */
 export class NormalizedSchema implements INormalizedSchema {
   // ========================
diff --git a/packages/core/src/submodules/schema/schemas/OperationSchema.ts b/packages/core/src/submodules/schema/schemas/OperationSchema.ts
@@ -6,7 +6,7 @@ import { Schema } from "./Schema";
  * This is used as a reference container for the input/output pair of schema, and for trait
  * detection on the operation that may affect client protocol logic.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class OperationSchema extends Schema implements IOperationSchema {
diff --git a/packages/core/src/submodules/schema/schemas/Schema.ts b/packages/core/src/submodules/schema/schemas/Schema.ts
@@ -5,7 +5,7 @@ import { TypeRegistry } from "../TypeRegistry";
 /**
  * Abstract base for class-based Schema except NormalizedSchema.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export abstract class Schema implements TraitsSchema {
diff --git a/packages/core/src/submodules/schema/schemas/SimpleSchema.ts b/packages/core/src/submodules/schema/schemas/SimpleSchema.ts
@@ -7,7 +7,7 @@ import { Schema } from "./Schema";
  * Although numeric values exist for most simple schema, this class is used for cases where traits are
  * attached to those schema, since a single number cannot easily represent both a schema and its traits.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class SimpleSchema extends Schema implements TraitsSchema {
diff --git a/packages/core/src/submodules/schema/schemas/StructureSchema.ts b/packages/core/src/submodules/schema/schemas/StructureSchema.ts
@@ -6,7 +6,7 @@ import { Schema } from "./Schema";
 /**
  * A structure schema has a known list of members. This is also used for unions.
  *
- * @alpha
+ * @internal
  * @deprecated use StaticSchema
  */
 export class StructureSchema extends Schema implements IStructureSchema {
diff --git a/packages/core/src/submodules/schema/schemas/sentinels.ts b/packages/core/src/submodules/schema/schemas/sentinels.ts
@@ -17,7 +17,7 @@ import type {
 
 /**
  * Schema sentinel runtime values.
- * @alpha
+ * @internal
  *
  * @deprecated use inline numbers with type annotation to save space.
  */
diff --git a/packages/types/src/schema/schema-deprecated.ts b/packages/types/src/schema/schema-deprecated.ts
@@ -7,7 +7,7 @@ import type { StaticSchema } from "./static-schemas";
 
 /**
  * A schema is an object or value that describes how to serialize/deserialize data.
- * @public
+ * @internal
  * @deprecated use $Schema
  */
 export type Schema =
@@ -26,15 +26,15 @@ export type Schema =
  * A schema "reference" is either a schema or a function that
  * provides a schema. This is useful for lazy loading, and to allow
  * code generation to define schema out of dependency order.
- * @public
+ * @internal
  * @deprecated use $SchemaRef
  */
 export type SchemaRef = Schema | (() => Schema);
 
 /**
  * A schema that has traits.
  *
- * @public
+ * @internal
  * @deprecated use static schema.
  */
 export interface TraitsSchema {
@@ -46,14 +46,14 @@ export interface TraitsSchema {
 /**
  * Indicates the schema is a member of a parent Structure schema.
  * It may also have a set of member traits distinct from its target shape's traits.
- * @public
+ * @internal
  * @deprecated use $MemberSchema
  */
 export type MemberSchema = [SchemaRef, SchemaTraits];
 
 /**
  * Schema for the structure aggregate type.
- * @public
+ * @internal
  * @deprecated use static schema.
  */
 export interface StructureSchema extends TraitsSchema {
@@ -69,7 +69,7 @@ export interface StructureSchema extends TraitsSchema {
 
 /**
  * Schema for the list aggregate type.
- * @public
+ * @internal
  * @deprecated use static schema.
  */
 export interface ListSchema extends TraitsSchema {
@@ -78,7 +78,7 @@ export interface ListSchema extends TraitsSchema {
 
 /**
  * Schema for the map aggregate type.
- * @public
+ * @internal
  * @deprecated use static schema.
  */
 export interface MapSchema extends TraitsSchema {
@@ -88,7 +88,7 @@ export interface MapSchema extends TraitsSchema {
 
 /**
  * Schema for an operation.
- * @public
+ * @internal
  * @deprecated use StaticOperationSchema or $OperationSchema
  */
 export interface OperationSchema {
@@ -101,7 +101,7 @@ export interface OperationSchema {
 
 /**
  * Turns a serialization into a data object.
- * @public
+ * @internal
  * @deprecated use $ShapeDeserializer
  */
 export interface ShapeDeserializer<SerializationType = Uint8Array> extends ConfigurableSerdeContext {
@@ -113,7 +113,7 @@ export interface ShapeDeserializer<SerializationType = Uint8Array> extends Confi
 
 /**
  * Turns a data object into a serialization.
- * @public
+ * @internal
  * @deprecated use $ShapeSerializer
  */
 export interface ShapeSerializer<SerializationType = Uint8Array> extends ConfigurableSerdeContext {
@@ -125,7 +125,7 @@ export interface ShapeSerializer<SerializationType = Uint8Array> extends Configu
 /**
  * A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.
  *
- * @public
+ * @internal
  * @deprecated use $Codec
  */
 export interface Codec<S, D> extends ConfigurableSerdeContext {
@@ -135,7 +135,7 @@ export interface Codec<S, D> extends ConfigurableSerdeContext {
 
 /**
  * A client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.
- * @public
+ * @internal
  * @deprecated use $ClientProtocol
  */
 export interface ClientProtocol<Request, Response> extends ConfigurableSerdeContext {
diff --git a/packages/types/src/schema/schema.ts b/packages/types/src/schema/schema.ts
@@ -21,7 +21,7 @@ import type { TraitBitVector } from "./traits";
 
 /**
  * A schema is an object or value that describes how to serialize/deserialize data.
- * @alpha
+ * @public
  */
 export type $Schema = UnitSchema | SimpleSchema | $MemberSchema | StaticSchema | NormalizedSchema;
 
@@ -74,7 +74,7 @@ export type BlobSchemas = BlobSchema | StreamingBlobSchema;
  * Signal value for the Smithy void value. Typically used for
  * operation input and outputs.
  *
- * @alpha
+ * @public
  */
 export type UnitSchema = "unit";
 
@@ -133,13 +133,13 @@ export type SchemaTraitsObject = {
 /**
  * Indicates the schema is a member of a parent Structure schema.
  * It may also have a set of member traits distinct from its target shape's traits.
- * @alpha
+ * @public
  */
 export type $MemberSchema = [$SchemaRef, SchemaTraits];
 
 /**
  * Schema for an operation.
- * @alpha
+ * @public
  */
 export interface $OperationSchema {
   namespace: string;
@@ -186,7 +186,7 @@ export interface NormalizedSchema {
  * A schema "reference" is either a schema or a function that
  * provides a schema. This is useful for lazy loading, and to allow
  * code generation to define schema out of dependency order.
- * @alpha
+ * @public
  */
 export type $SchemaRef = $Schema | (() => $Schema);
 
diff --git a/packages/types/src/schema/static-schemas.ts b/packages/types/src/schema/static-schemas.ts

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import { loadSmithyRpcV2CborErrorCode } from "./parseCborBody";`
`20`	`20`	`/**`
`21`	`21`	`* Client protocol for Smithy RPCv2 CBOR.`
`22`	`22`	`*`
`23`		`- * @alpha`
	`23`	`+ * @public`
`24`	`24`	`*/`
`25`	`25`	`export class SmithyRpcV2CborProtocol extends RpcProtocol {`
`26`	`26`	`private codec = new CborCodec();`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ import { fromUtf8 } from "@smithy/util-utf8";`
`18`	`18`	`* Separated module for async mixin of EventStream serde capability.`
`19`	`19`	`* This is used by the HttpProtocol base class from \@smithy/core/protocols.`
`20`	`20`	`*`
`21`		`- * @alpha`
	`21`	`+ * @public`
`22`	`22`	`*/`
`23`	`23`	`export class EventStreamSerde {`
`24`	`24`	`private readonly marshaller: EventStreamMarshaller;`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ import { HttpProtocol } from "./HttpProtocol";`
`24`	`24`	`* Base for HTTP-binding protocols. Downstream examples`
`25`	`25`	`* include AWS REST JSON and AWS REST XML.`
`26`	`26`	`*`
`27`		`- * @alpha`
	`27`	`+ * @public`
`28`	`28`	`*/`
`29`	`29`	`export abstract class HttpBindingProtocol extends HttpProtocol {`
`30`	`30`	`public async serializeRequest<Input extends object>(`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import { SerdeContext } from "./SerdeContext";`
`26`	`26`	`/**`
`27`	`27`	`* Abstract base for HTTP-based client protocols.`
`28`	`28`	`*`
`29`		`- * @alpha`
	`29`	`+ * @public`
`30`	`30`	`*/`
`31`	`31`	`export abstract class HttpProtocol extends SerdeContext implements ClientProtocol<IHttpRequest, IHttpResponse> {`
`32`	`32`	`protected abstract serializer: ShapeSerializer<string \| Uint8Array>;`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ import { HttpProtocol } from "./HttpProtocol";`
`18`	`18`	`/**`
`19`	`19`	`* Abstract base for RPC-over-HTTP protocols.`
`20`	`20`	`*`
`21`		`- * @alpha`
	`21`	`+ * @public`
`22`	`22`	`*/`
`23`	`23`	`export abstract class RpcProtocol extends HttpProtocol {`
`24`	`24`	`public async serializeRequest<Input extends object>(`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ import { determineTimestampFormat } from "./determineTimestampFormat";`
`24`	`24`	`/**`
`25`	`25`	`* This deserializer reads strings.`
`26`	`26`	`*`
`27`		`- * @alpha`
	`27`	`+ * @public`
`28`	`28`	`*/`
`29`	`29`	`export class FromStringShapeDeserializer extends SerdeContext implements ShapeDeserializer<string> {`
`30`	`30`	`public constructor(private settings: CodecSettings) {`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import { FromStringShapeDeserializer } from "./FromStringShapeDeserializer";`
`12`	`12`	`* For example, in a JSON HTTP message, the deserialization of a field will differ depending on whether`
`13`	`13`	`* it is bound to the HTTP header (string) or body (JSON).`
`14`	`14`	`*`
`15`		`- * @alpha`
	`15`	`+ * @public`
`16`	`16`	`*/`
`17`	`17`	`export class HttpInterceptingShapeDeserializer<CodecShapeDeserializer extends ShapeDeserializer<any>>`
`18`	`18`	`extends SerdeContext`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import { ToStringShapeSerializer } from "./ToStringShapeSerializer";`
`16`	`16`	`* For example, a JavaScript array is serialized differently when being written`
`17`	`17`	`* to a REST JSON HTTP header (comma-delimited string) and a REST JSON HTTP body (JSON array).`
`18`	`18`	`*`
`19`		`- * @alpha`
	`19`	`+ * @public`
`20`	`20`	`*/`
`21`	`21`	`export class HttpInterceptingShapeSerializer<CodecShapeSerializer extends ShapeSerializer<string \| Uint8Array>>`
`22`	`22`	`implements ShapeSerializer<string \| Uint8Array>, ConfigurableSerdeContext`