Gadget Framework 

What is the Gadget framework? 

The Gadget framework is a powerful backend framework that utilizes Fastify to power all Gadget applications. It offers a serverless Node.js environment for running your JavaScript code, accompanied by Actions and HTTP routes that are used to execute and organize your backend code.

How to use the Gadget framework 

How to change your application's framework version 

Existing applications can upgrade or downgrade their framework version in one click. New apps use the latest framework version by default but can be downgraded.

Follow the steps below to change your Gadget framework version:

1. Head over to the Settings page within your application.

2. Click the Upgrade button in the framework version section.

3. You can now drop down the menu and select the framework version you prefer to change your application to use.

4. Now hit the Upgrade and run yarn button in the bottom right-hand corner (will be Downgrade and run yarn if you are downgrading your framework version).

Framework version changelog 

v1.4.0 

• Computed Views now available
• Vite upgraded to Vite 6 by default

v1.3.0 

• Related model filtering now available

v1.2.0 

• Vite upgraded to Vite 5
• Apps use a new, customizable build script in package.json for building frontend assets
  • The old vite:build script has been deprecated
  • Using the gadget Vite plugin is now required

v1.1.0 

• Node.js upgraded from v20.9 to v20.12
• Realtime query support in imperative API clients. Read more
• Add models, fields, actions, and routes to your app from the command line using ggt add. Read more
• Namespace and nested folder support for models and actions. Read more: models, actions
• Default value for connections.shopify.maxRetries changed from 6 to 2
• API client bundle size reduced

v1.0.0 

• Added support for unlimited development environments
• Git-based source control across your entire Gadget application's code and configurations
• App file structure updated:
  • The backend now uses an api folder for models, actions, and routes
  • Model-related files are reorganized under api/models
  • Global actions are reorganized under api/actions
  • The frontend folder is renamed to web
  • Access control is now represented as its own folder (accessControl) containing permissions (accessControl/permissions)
• App settings, permissions, and model schemas are now represented in metadata files that can be added to source control when using ggt
• Added support for invoking actions in background queues
• Queues dashboard page for viewing the status and progress of background actions and Shopify webhooks

v0.3.1 

Shopify connections

• The shopifyShop model now has a field disabledWebhooks to allow shop-level control over webhook registration
• The scheduledShopifySync global action is added to give explicit control over when the Shopify daily sync is run

v0.3 

• Node.js upgraded from v18.15 to v20.9

  • New WebCrypto APIs added for cryptography matching the browser APIs
  • V8 engine upgraded to version 11.3 for improved performance. Read more

• fastify upgraded from v3 to v4

  • Plugins have all been renamed from fastify-something to @fastify/something and versions have changed. Please verify any Fastify plugins are compatible with Fastify 4.
  • HTTP Route error handlers are now encapsulated. If any of your route plugins set error handlers, they will only apply to errors thrown by routes in that folder or a subfolder. Read more.
  • HTTP Route handlers now need to return the reply object if they will send a response later. Read more.
  • HTTP Route handlers for GET routes now expose a HEAD route automatically. Read more.
  • reply.res has been moved to reply.raw. Read more.

v0.2 

• Node.js upgraded from v16.20 to v18.15
  • fetch global function is now available
  • V8 engine upgraded to version 10.1 for improved performance. Read more.
• Support added for response streaming from Gadget routes. Read more.