Skip to content
Netlify SDK DocsNetlify SDK Docs1.13.2

Release notes

The Netlify SDK uses semantic versioning after v1.

  • Patch version updates include only backward-compatible bug fixes.
  • Minor version updates introduce only backward-compatible new features.
  • Major version updates can introduce breaking changes.

While the Netlify SDK was < v1, all breaking changes were released as a minor version and backward-compatible changes were released as a patch version.

1.13.2

  • Improved the NetlifyIntegrationClient to create environment variables for the build token in a way that it is always the correct format.

1.13.1

  • integration.yaml validation schema has changed location. Updated the init command to use the new location.

1.13.0

  • Connectors: added the ability to set/get visitor context for passing relevant data to child visitor functions.

1.12.0

  • Cleaned up terminal output logs for connectors.

1.11.1

  • Fixed an issue with npm create @netlify/sdk where the initialization step would throw an error about a missing -d flag.

1.11.0

  • Connectors: use randomly generated suffix package version in output connector to properly support package cache busting

1.10.0

  • Connectors: bumped content-engine and added the ability to mix node and object types in a single union. Previously this was disallowed because Connect & content-engine didn’t support it.

1.9.5

  • Fixed a connector issue during node insertion where union values that had an auto-renamed __typename field weren’t being properly renamed.

1.9.4

  • Fixed the field.originalName value passed to visitor info object in connectors. In some cases the normalized name was returned instead of the original.

1.9.3

  • Fixed auto-renaming union type references in connectors

1.9.2

  • Fixed more cases of truncated error messages in connectors

1.9.1

  • Bumped content-engine dependency for general connector bug fixes and improvements

1.9.0

Connectors:

  • add rebundle-only mode #824
  • open graphiql when pressing “o” #825
  • expose connector types from main export #823
  • fix large error messages #827
  • support webhooks #826

1.8.0

  • Added an info object to field/node/object/union visitor functions to assist with dynamically generated schemas in connectors
  • Fixed a bug with node visitors where it wasn’t possible to set the node id with a visitor function

1.7.0

  • Added field visitors for connectors to help with normalizing data
  • Added models.ModelName.originalName to allow access to model names before they’re normalized to pascal case. This can help when you need to fetch CMS data using the original name.

1.6.0

  • New connector features for model definitions: iterators/concurrency for looping over defined models while fetching data, and the visitor pattern for normalizing data before inserting it into the Connect DB

1.5.0

  • Update dependencies
  • Fix issues with lockfiles

1.4.0

  • Automatically populate the integration slug from the API if a linked site is detected and a matching integration is found

1.3.1

  • Bugfix: integrationConfig returned an integration.yaml file with a double scopes key.

1.2.1

  • Init automatically adds more metadata to the integration.yaml file.
  • Configuration files can now have different file types, like integration.yaml, integration.yml, integration.netlify.yaml, integration.netlify.yml

1.1.5

  • Use fs.rmSync to remove folders - fixes usage on Windows

1.1.4

  • Bump content-engine dependency

1.1.3

  • Host the configuration schema on the site.
  • Include link to schema in the generated config file.
  • Fix checking the integrationLevel inside getConfiguration().

1.1.2

  • Allow lowercased builtin field types.

1.1.1

  • For Dynamic Build Event Handlers, pass an empty object as buildConfig if there is no buildConfig available.
  • Add integrationLevel to netlifyIntegrationConfiguration.json and fix the formatting of the file.

1.1.0

1.0.9

  • Adds integrationLevel to IntegrationConfigurationSchema

1.0.8

  • Adds onDisconnect handler
  • Adds optional confirmation messages for buttons

1.0.7

  • Handles conflicts in on-enable requests in the default handlers

1.0.6

  • Adds the Alert element to the available elements in Integration UI

1.0.4

  • Adds the ability to validate input-text and input-password elements in Integration UI

1.0.3

  • If a site has been linked to an integration, when the netlify-integration preview command is run, a live URL is passed to the browser
  • Fix previewing integration UI in Safari

1.0.1

Fixes an issue with the dev -a command when no connector is specified. Now the command will silently skip trying to start a connector when running dev -a, but will throw an error when running dev -c with no connector.

1.0.0

This first major release of the Netlify SDK contains all the tools necessary to start creating integrations for the Netlify platform.

0.8.5

Breaking

The following methods should be passed an object instead of the separate arguments:

  • createEnvironmentVariable(accountId, siteId, key, values) to createEnvironmentVariable({ accountId, siteId, key, values })
  • createOrUpdateVariable(accountId, siteId, key, value) to createOrUpdateVariable({ accountId, siteId, key, value })
  • createOrUpdateVariables(accountId, siteId, variables) to createOrUpdateVariables({ accountId, siteId, variables })
  • deleteEnvironmentVariable(accountId, siteId, key) to deleteEnvironmentVariable({ accountId, siteId, key })
  • deleteEnvironmentVariables(accountId, siteId, variables) to deleteEnvironmentVariables({ accountId, siteId, variables })
  • getEnvironmentVariables(accountId, siteId) to getEnvironmentVariables({ accountId, siteId })
  • patchEnvironmentVariable(accountId, siteId, key, context, value, contextParameter) to patchEnvironmentVariable({ accountId, siteId, key, context, value, contextParameter })
  • updateEnvironmentVariable(accountId, siteId, key, values) to updateEnvironmentVariable({ accountId, siteId, key, values })

0.8.4

Breaking

  • addHandler has been renamed to addApiHandler.

0.8.1

  • z from zod is now exported, import { z } from '@netlify/sdk'

Breaking

  • addBuildContext has been renamed to addBuildEventContext
  • addBuildHook has been renamed to addBuildEventHandler
  • disableBuildhook has been renamed to disableBuildEventHandlers
  • enableBuildhook has been renamed to enableBuildEventHandlers

0.7.9

  • Added input element getters and setters to surfaceState

0.7.3

  • Fetch function now provided in SurfaceState
  • Use of generics when picking elements

0.4.14

  • ConnectionCard renamed to OAuthCard

0.4.6

  • You can now add codesnippets to the Integration UI