Webiny Docs home page

Changes

This document highlights the most important fixes, improvements, and features, that were introduced in Webiny 5.13.0.

How To Upgrade?
Please check the Webiny 5.13.0 migration guide for the upgrade steps.

Development
anchor

Three New Scaffolds (#1839 external link)
anchor

The highlight of this release - we bring you three brand new scaffolds that are focused on aiding developers in custom application development. The three scaffolds are:

To get started, simply run the existing webiny scaffold command and pick the scaffold you need. On the other hand, if you’d like to learn more, you can check out the linked how-to guides.

Finally, we’re also working on a brand new Create Custom Application tutorial, which will show you step-by-step how to utilize these scaffolds, and also how to build on top of them. Stay tuned!

New types.ts Declaration File in GraphQL API Application Code (#1839 external link)
anchor

By default, every Webiny project starts with two GraphQL APIs. The default one, which is being utilized by all of the Webiny applications like Page Builder, Form Builder, and others. And, the Headless CMS GraphQL API, which is a standalone GraphQL API, used only for content management, preview, and reading purposes.

When it comes to custom development or extending these, one of the frictions we’ve seen developers were experiencing was figuring out what is the context object and what are the properties it consists of. This is especially important while creating custom GraphQL field resolver functions.

The context object is extended via ContextPlugin external link plugins, which is what all of the default Webiny applications are using as well. But, most likely, you will be interacting with it in your GraphQL resolver functions.

So, to improve the developer experience, in the application code of both GraphQL APIs, we’ve added the new types.ts file, which export the Context interface that completely describes the context object. To use it in your custom application code, for example in a custom GraphQL resolver function, simply import the interface and pass it to the GraphQLSchemaPlugin plugin, for example:

Using the New Context Interface and Passing It to the ContextPlugin Plugin.
import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/plugins";

// The `Context` interface can be easily imported via the `~/types` path.
import { Context } from "~/types";

// Pass the Context interface to the `GraphQLSchemaPlugin` plugin.
export default new GraphQLSchemaPlugin<Context>({
  typeDefs: (...),
  resolvers: {
    Query: {
      listBooks: async (_, args, context) => {
        (...)
      }
    }
  }
});

Except for the ability to interact with the context object in a type-safe manner, another benefit of this approach is easier usage. All of the properties of the context object will now be shown by your IDE, in an autocomplete dropdown menu.

The existing guides that cover extending GraphQL APIs were also updated, so make sure to check them out to learn more:

Yarn 3 Support (#1862 external link)
anchor

You can now use Yarn 3 external link with your existing projects, and all new Webiny projects will be created with Yarn 3. Yarn project is using the codename berry for all their releases. To prevent unexpected problems as major version releases occur, our CLI and create-webiny-project utility will have the supported versions of Yarn whitelisted. Currently, we allow versions 2 and 3, and we’ll keep adding new versions when they arrive, only after thorough testing.

Non-Default AWS Profiles Now Work as Expected (#1839 external link)
anchor

When specifying a non-default AWS profile via an environment variable, for example via the root .env file, users would experience an issue at the end of the project deployment. More specifically, after all of the cloud infrastructure resources of the Website project application were deployed, several AWS Lambda function invocations would fail, because the AWS profile wasn’t properly assumed.

This has now been taken care of and you should be able to successfully deploy your Webiny project with a non-default AWS profile.

Check out the Use AWS Profiles how-to guide to learn how to use different AWS profiles upon deploying your Webiny project.

Fix watch on Windows (#1848 external link)
anchor

There’s currently a bug in the Pulumi path detection for file watching, so on Windows, where paths start with C:, etc., Pulumi thinks it’s a relative path, and constructs a wrong file path to watch. To bypass this issue, and get the watch command to work on Windows, we’ve temporarily disabled path filtering on Windows.

Watch works just a good, but you might experience a case of double update on Lambda functions. Not a major problem, just a little detail you’ll most likely not even notice, if you don’t pay attention to deploy logs.

Allow Links to Be Rendered in the Menu Group (#1857 external link)
anchor

With the introduction of Webiny UI Composer, in Admin Area, navigation menu items are now rendered using the new concept of renderers. Unfortunately, it did not include a renderer for links as a direct child of a menu group. With this release, we’ve improved one of the renderers to handle both 2-level and 3-level menu hierarchy.

Users who used the Extend Admin Area scaffold were the first to experience this issue, as the main-menu items that were created during the scaffolding process simply weren’t clickable.

Add .mjs Webpack Rule (#1852 external link)
anchor

When including a third-party dependency into your GraphQL Lambda functions, if that dependency uses JS modules (.mjs extension), webpack bundling would fail. We’ve now added a rule to properly bundle .mjs files.

Shout out to @econtentmaps external link for testing the fix! 🙌 🧡