Update model to use REST bindings and add more settings

Author: mtdowling

smithy-typescript-codegen-test/model/main.smithy

@@ -1,9 +1,8 @@
 $version: "0.4.0"
-namespace example.weather.foo
+namespace example.weather
 
 /// Provides weather forecasts.
-@paginated(inputToken: "nextToken", outputToken: "nextToken",
-           pageSize: "pageSize")
+@paginated(inputToken: "nextToken", outputToken: "nextToken", pageSize: "pageSize")
 service Weather {
     version: "2006-03-01",
     resources: [City],
@@ -14,25 +13,32 @@ resource City {
     identifiers: { cityId: CityId },
     read: GetCity,
     list: ListCities,
-    resources: [Forecast],
+    resources: [Forecast, CityImage],
 }
 
 resource Forecast {
     identifiers: { cityId: CityId },
     read: GetForecast,
 }
 
+resource CityImage {
+    identifiers: { cityId: CityId },
+    read: GetCityImage,
+}
+
 // "pattern" is a trait.
 @pattern("^[A-Za-z0-9 ]+$")
 string CityId
 
 @readonly
+@http(method: "GET", uri: "/cities/{cityId}")
 operation GetCity(GetCityInput) -> GetCityOutput errors [NoSuchResource]
 
 structure GetCityInput {
     // "cityId" provides the identifier for the resource and
     // has to be marked as required.
     @required
+    @httpLabel
     cityId: CityId
 }
 
@@ -59,6 +65,7 @@ structure CityCoordinates {
 
 /// Error encountered when no resource could be found.
 @error("client")
+@httpError(404)
 structure NoSuchResource {
     /// The type of resource that was not found.
     @required
@@ -69,10 +76,14 @@ structure NoSuchResource {
 // return truncated results.
 @readonly
 @paginated(items: "items")
+@http(method: "GET", uri: "/cities")
 operation ListCities(ListCitiesInput) -> ListCitiesOutput
 
 structure ListCitiesInput {
+    @httpQuery("nextToken")
     nextToken: String,
+
+    @httpQuery("pageSize")
     pageSize: Integer
 }
 
@@ -102,6 +113,7 @@ structure CitySummary {
 }
 
 @readonly
+@http(method: "GET", uri: "/current-time")
 operation GetCurrentTime() -> GetCurrentTimeOutput
 
 structure GetCurrentTimeOutput {
@@ -110,12 +122,14 @@ structure GetCurrentTimeOutput {
 }
 
 @readonly
+@http(method: "GET", uri: "/cities/{cityId}/forecast")
 operation GetForecast(GetForecastInput) -> GetForecastOutput
 
 // "cityId" provides the only identifier for the resource since
 // a Forecast doesn't have its own.
 structure GetForecastInput {
     @required
+    @httpLabel
     cityId: CityId,
 }
 
@@ -145,3 +159,20 @@ map StringMap {
     key: String,
     value: String,
 }
+
+@readonly
+@http(method: "GET", uri: "/cities/{cityId}/image")
+operation GetCityImage(GetCityImageInput) -> GetCityImageOutput errors [NoSuchResource]
+
+structure GetCityImageInput {
+    @required @httpLabel
+    cityId: CityId
+}
+
+structure GetCityImageOutput {
+    @httpPayload
+    image: CityImageData,
+}
+
+@streaming
+blob CityImageData

smithy-typescript-codegen-test/smithy-build.json

@@ -2,9 +2,12 @@
     "version": "1.0",
     "plugins": {
         "typescript-codegen": {
-            "service": "example.weather.foo#Weather",
+            "service": "example.weather#Weather",
             "package": "weather",
-            "target": "node"
+            "packageVersion": "0.0.1",
+            "packageJson": {
+                "license": "Apache-2.0"
+            }
         }
     }
- }
+}

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java

@@ -30,9 +30,15 @@
 public final class TypeScriptSettings {
 
     private static final String PACKAGE = "package";
+    private static final String PACKAGE_DESCRIPTION = "packageDescription";
+    private static final String PACKAGE_VERSION = "packageVersion";
+    private static final String PACKAGE_JSON = "packageJson";
     private static final String SERVICE = "service";
 
     private String packageName;
+    private String packageDescription;
+    private String packageVersion;
+    private ObjectNode packageJson;
     private ShapeId service;
     private ObjectNode pluginSettings = Node.objectNode();
 
@@ -44,9 +50,14 @@ public final class TypeScriptSettings {
      */
     public static TypeScriptSettings from(ObjectNode config) {
         TypeScriptSettings settings = new TypeScriptSettings();
-        config.warnIfAdditionalProperties(Arrays.asList(PACKAGE, SERVICE));
-        settings.setPackageName(config.expectStringMember(PACKAGE).getValue());
+        config.warnIfAdditionalProperties(Arrays.asList(
+                PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION, SERVICE));
         settings.setService(config.expectStringMember(SERVICE).expectShapeId());
+        settings.setPackageName(config.expectStringMember(PACKAGE).getValue());
+        settings.setPackageVersion(config.expectStringMember(PACKAGE_VERSION).getValue());
+        settings.setPackageDescription(config.getStringMemberOrDefault(
+                PACKAGE_DESCRIPTION, settings.getPackageName() + " client"));
+        settings.packageJson = config.getObjectMember(PACKAGE_JSON).orElse(Node.objectNode());
         settings.setPluginSettings(config);
         return settings;
     }
@@ -104,4 +115,49 @@ public ServiceShape getService(Model model) {
                 .asServiceShape()
                 .orElseThrow(() -> new CodegenException("Shape is not a Service: " + getService()));
     }
+
+    /**
+     * Gets the description of the package that will be placed in the
+     * "description" field of the generated package.json.
+     *
+     * @return Returns the description.
+     */
+    public String getPackageDescription() {
+        return packageDescription;
+    }
+
+    public void setPackageDescription(String packageDescription) {
+        this.packageDescription = packageDescription;
+    }
+
+    /**
+     * Gets the version of the generated package that will be used with the
+     * generated package.json file.
+     *
+     * @return Returns the package version.
+     */
+    public String getPackageVersion() {
+        return packageVersion;
+    }
+
+    public void setPackageVersion(String packageVersion) {
+        this.packageVersion = packageVersion;
+    }
+
+    /**
+     * Gets a chunk of custom properties to merge into the generated
+     * package.json file.
+     *
+     * <p>This JSON is used to provide any property present in the
+     * package.json file that isn't captured by any other settings.
+     *
+     * @return Returns the custom package JSON.
+     */
+    public ObjectNode getPackageJson() {
+        return packageJson;
+    }
+
+    public void setPackageJson(ObjectNode packageJson) {
+        this.packageJson = packageJson;
+    }
 }