feat: wip

Author: kuhe

.changeset/strong-baboons-sort.md

@@ -0,0 +1,5 @@
+---
+"@smithy/core": minor
+---
+
+add type interfaces for runtime model interpreters

packages/core/src/index.ts

@@ -5,3 +5,5 @@ export * from "./getSmithyContext";
 export * from "./normalizeProvider";
 export * from "./protocols/requestBuilder";
 export { createPaginator } from "./pagination/createPaginator";
+export * from "./protocols/serde/SmithyModel";
+export * from "./protocols/serde/RuntimeModelInterpreter";

packages/core/src/protocols/serde/RuntimeModelInterpreter.ts

@@ -0,0 +1,33 @@
+import { HttpRequest as IHttpRequest, HttpResponse as IHttpResponse, SerdeContext } from "@smithy/types";
+
+import { ISmithyModel, ISmithyModelShape, ISmithyModelShapeId, SmithyModel } from "./SmithyModel";
+
+export interface IRuntimeModelInterpreter {}
+
+export abstract class RuntimeModelInterpreter implements IRuntimeModelInterpreter {
+  public model: SmithyModel;
+
+  protected constructor(model: ISmithyModel) {
+    this.model = SmithyModel.from(model);
+  }
+
+  public abstract serialize<I>(
+    input: I,
+    requestShapeId: ISmithyModelShapeId,
+    context: SerdeContext
+  ): Promise<IHttpRequest>;
+
+  public abstract deserialize<O>(
+    httpResponse: IHttpResponse,
+    responseShapeId: ISmithyModelShapeId,
+    context: SerdeContext
+  ): Promise<O>;
+
+  public getShape<T extends ISmithyModelShape>(id: ISmithyModelShapeId): T {
+    const shape = this.model.shapes[id];
+    if (!shape) {
+      throw new Error("shape not found: " + id);
+    }
+    return shape as T;
+  }
+}

packages/core/src/protocols/serde/SmithyModel.ts

@@ -0,0 +1,77 @@
+export interface ISmithyModel {
+  smithy: "2.0";
+  metadata: {
+    suppressions: { id: string; namespace: string }[];
+  };
+  shapes: Record<ISmithyModelShapeId, ISmithyModelShape>;
+}
+
+export interface ISmithyModelShape {
+  type: string;
+}
+
+export interface ISmithyModelServiceShape extends ISmithyModelShape {
+  type: "service";
+  version: string;
+  operations: { target: ISmithyModelShapeId }[];
+  traits: ISmithyModelTraits;
+}
+
+export interface ISmithyModelStructureShape extends ISmithyModelShape {
+  type: "structure";
+  members: {
+    [memberName: string]: {
+      target: ISmithyModelShapeId;
+      traits: ISmithyModelTraits;
+    };
+  };
+  traits: ISmithyModelTraits;
+}
+
+export interface ISmithyModelOperationShape extends ISmithyModelShape {
+  type: "operation";
+  input: {
+    target: ISmithyModelShapeId;
+  };
+  output: {
+    target: ISmithyModelShapeId;
+  };
+  errors: { target: ISmithyModelShapeId }[];
+  traits: ISmithyModelTraits;
+}
+
+export type ISmithyModelTraits = {
+  "smithy.api#http"?: {
+    method: string;
+    uri: string;
+    code: number;
+  };
+  "smithy.api#httpLabel"?: {} | undefined;
+  "smithy.api#httpHeader"?: string;
+  "smithy.api#httpQuery"?: string;
+  "smithy.api#httpPayload"?: {} | undefined;
+  "smithy.api#jsonName"?: string;
+  "smithy.api#httpResponseCode"?: {} | undefined;
+  [traitName: string]: unknown;
+};
+
+export type ISmithyModelShapeId = `${string}#${string}`;
+
+export class SmithyModel implements ISmithyModel {
+  public smithy: ISmithyModel["smithy"];
+  public metadata: ISmithyModel["metadata"];
+  public shapes: ISmithyModel["shapes"];
+
+  public static from(model: ISmithyModel) {
+    if (model instanceof SmithyModel) {
+      return model;
+    }
+    return new SmithyModel(model);
+  }
+
+  public constructor(public readonly _jsonObject: ISmithyModel) {
+    this.smithy = _jsonObject.smithy;
+    this.metadata = _jsonObject.metadata;
+    this.shapes = _jsonObject.shapes;
+  }
+}