Skip to content

fix(ssr): remove mentioning of internal packages #8282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Conversation

AllanZhengYP
Copy link
Member

@AllanZhengYP AllanZhengYP commented Mar 11, 2025

Description of changes:

The Nuxt SSR example refers to the internal-only package @aws-amplify/core, which should not be used directly in customer apps. Updating the example to fix this issue.

This change also fixed the incorrect import of amplify_outputs.json.

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@@ -273,7 +270,7 @@ export default defineNuxtPlugin({
);

// Create the libraryOptions object
const libraryOptions: LibraryOptions = {
const libraryOptions = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this type available from the main package?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josefaidt This type is not available in the main package. In this example it's not necessary, since tokenProvider and credentialsProvider are typed individually

import {
createKeyValueStorageFromCookieStorageAdapter,
createUserPoolsTokenProvider,
createAWSCredentialsAndIdentityIdProvider,
runWithAmplifyServerContext
} from 'aws-amplify/adapter-core';
import { parseAmplifyConfig } from 'aws-amplify/utils';
import type { FetchAuthSessionOptions } from 'aws-amplify/auth';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, can we move this type import above the value imports?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josefaidt sorted & grouped all the imports.

@AllanZhengYP AllanZhengYP requested a review from josefaidt March 11, 2025 19:03
@HuiSF
Copy link
Member

HuiSF commented Mar 11, 2025

Is this PR for updating the content of https://docs.amplify.aws/gen1/react/build-a-backend/server-side-rendering/nuxt/?

The changed file in this PR is not the page under gen1, it's for gen2, but currently unlinked (inaccessible on the doc site) should we also update the page for gen1?

@AllanZhengYP AllanZhengYP merged commit 51b5a27 into main Mar 12, 2025
12 checks passed
@AllanZhengYP AllanZhengYP deleted the fix-nuxt-import branch March 12, 2025 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants