@aws/nx-plugin-mcp 1.0.0-rc.53 → 1.0.0-rc.54

package/docs/snippets/pdk-migration/faq/type-safe-api.mdx

@@ -77,117 +77,11 @@ For TypeScript, check out [Smithy TypeScript](https://github.com/smithy-lang/smi
 
 Type Safe API provided a Projen project type named `SmithyShapeLibraryProject` which configured a project which contained Smithy models which could be reused by multiple Smithy-based APIs.
 
-The most straightforward way to achieve this is to do the following:
+The equivalent is the <Link path="/guides/smithy-project">`smithy#project` generator</Link> with `type` set to `shapes`:
 
-###### Create a Shape Library
+<RunGenerator generator="smithy#project" requiredParameters={{ name: 'my-shapes', type: 'shapes' }} />
 
-<Steps>
-
-1. Create your shape library using the `smithy#project` generator:
-
-    <RunGenerator generator="smithy#project" />
-
-    Specify any name for the `serviceName` option, as we will remove the `service` shape.
-
-    :::note
-    This generator is hidden at the time of writing and so you will need to execute it via the CLI.
-    :::
-
-1. Replace the default model in `src` with the shapes you wish to define
-
-1. Update `smithy-build.json` to remove the `plugins` and any unused maven dependencies
-
-1. Replace `build.Dockerfile` with minimal build steps:
-
-    ```docker
-    // build.Dockerfile
-    FROM public.ecr.aws/docker/library/node:24 AS builder
-
-    # Output directory
-    RUN mkdir /out
-
-    # Install Smithy CLI
-    # https://smithy.io/2.0/guides/smithy-cli/cli_installation.html
-    WORKDIR /smithy
-    ARG TARGETPLATFORM
-    RUN if [ "$TARGETPLATFORM" = "linux/arm64" ]; then ARCH="aarch64"; else ARCH="x86_64"; fi && \
-        mkdir -p smithy-install/smithy && \
-        curl -L https://github.com/smithy-lang/smithy/releases/download/1.61.0/smithy-cli-linux-$ARCH.zip -o smithy-install/smithy-cli-linux-$ARCH.zip && \
-        unzip -qo smithy-install/smithy-cli-linux-$ARCH.zip -d smithy-install && \
-        mv smithy-install/smithy-cli-linux-$ARCH/* smithy-install/smithy
-    RUN smithy-install/smithy/install
-
-    # Copy project files
-    COPY smithy-build.json .
-    COPY src src
-
-    # Smithy build with Maven cache mount
-    RUN --mount=type=cache,target=/root/.m2/repository,id=maven-cache \
-        smithy build
-
-    RUN cp -r build/* /out/
-
-    # Export the /out directory
-    FROM scratch AS export
-    COPY --from=builder /out /
-    ```
-
-</Steps>
-
-###### Consume the Shape Library
-
-In your service model project(s), make the following changes to consume the shape library:
-
-<Steps>
-
-1. Update the `compile` target in `project.json` to add the workspace as build context, and a dependency on the shape library's `build` target
-
-    ```json {10,15} "--build-context workspace=." "@my-project/shapes:build"
-    // project.json
-    {
-      "cache": true,
-      "outputs": ["{workspaceRoot}/dist/{projectRoot}/build"],
-      "executor": "nx:run-commands",
-      "options": {
-        "commands": [
-          "rimraf dist/packages/api/model/build",
-          "make-dir dist/packages/api/model/build",
-          "docker build --build-context workspace=. -f packages/api/model/build.Dockerfile --target export --output type=local,dest=dist/packages/api/model/build packages/api/model"
-        ],
-        "parallel": false,
-        "cwd": "{workspaceRoot}"
-      },
-      "dependsOn": ["@my-project/shapes:build"]
-    }
-    ```
-
-1. Update the `build.Dockerfile` to copy the `src` directory from your shape library. For example, assuming the shape library is located in `packages/shapes`:
-
-    ```docker {5}
-    // build.Dockerfile
-    # Copy project files
-    COPY smithy-build.json .
-    COPY src src
-    COPY --from=workspace packages/shapes/src shapes
-    ```
-
-1. Update `smithy-build.json` to add the shapes directory to its `sources`:
-
-    ```json {4} "shapes/"
-    // smithy-build.json
-    {
-      "version": "1.0",
-      "sources": ["src/", "shapes/"],
-      "plugins": {
-      ...
-    }
-    ```
-
-</Steps>
-
-:::note
-Please express your interest on the [GitHub issue here](https://github.com/awslabs/nx-plugin-for-aws/issues/304) if you have a use case for a dedicated Smithy shape library generator.
-:::
+Move the shapes from your `SmithyShapeLibraryProject` into the generated project's `src` folder, then refer to the <Link path="/guides/smithy-project#depending-on-a-shape-library">Smithy project guide</Link> for how to wire the library up as a dependency of your API's model.
 
 #### Interceptors
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws/nx-plugin-mcp",
-  "version": "1.0.0-rc.53",
+  "version": "1.0.0-rc.54",
   "repository": {
     "type": "git",
     "url": "https://github.com/awslabs/nx-plugin-for-aws.git",