Skip to content
Netlify SDK Docs Netlify SDK Docs 1.38.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.

@netlify/create-sdk@1.7.1 (2024-04-10)

Bug Fixes

  • change prefix for sf injection template

@netlify/sdk@1.38.2 (2024-04-10)

v1.38.0 and v1.38.1 were not published due to a mistake in the release process.

Features

  • add support for onCancel button functionality
  • improve types for connector authors

Bug Fixes

  • change prefix for sf injection template

@netlify/sdk@1.37.0 (2024-04-03)

Features

  • connectors: cross reference fields

@netlify/sdk@1.36.1 (2024-04-03)

Bug Fixes

  • revert support cross reference field type

@netlify/sdk@1.36.0 (2024-04-03)

Features

  • copy serverless functions to the user’s site

@netlify/sdk@1.35.0 (2024-04-02)

Features

  • connectors: support cross reference field type

@netlify/sdk@1.34.0 (2024-03-28)

Features

  • connectors: getRemoteGraphQLSchema util for proxySchema

Bug Fixes

  • connectors: check correct asset field model name
  • remove unnecessary node-fetch dependency

@netlify/sdk@1.33.1 (2024-03-27)

Bug Fixes

  • connectors: dont mutate connector input definitions

@netlify/sdk@1.33.0 (2024-03-22)

Features

  • connectors: file field type

Bug Fixes

  • connectors: don’t coerce fields if there aren’t any
  • connectors: remove open all key

@netlify/sdk@1.32.1 (2024-03-22)

Bug Fixes

  • connectors: error for incorrect list type
  • connectors: required list validation

@netlify/sdk@1.32.0 (2024-03-21)

Features

  • connectors: add missing Netlify Create properties

@netlify/sdk@1.31.0 (2024-03-20)

Features

  • connectors: document page types

@netlify/sdk@1.30.0 (2024-03-19)

Features

  • connectors: add support for editor control types
  • connectors: inline model definitions

Bug Fixes

  • connectors: update failing snapshot

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @netlify/content-engine bumped to 0.0.33

@netlify/sdk@1.29.2 (2024-03-15)

Bug Fixes

  • bundle the build event handler

@netlify/create-sdk@1.7.0 (2024-04-03)

Features

  • copy serverless functions to the user’s site

@netlify/create-sdk@1.6.0 (2024-04-02)

Features

  • ensure CLI is installed before user follows create prompts
  • show directory after integration has been created

@netlify/sdk@1.29.1 (2024-03-15)

Bug Fixes

  • await injectededgefunction

@netlify/sdk@1.29.0 (2024-03-14)

Features

  • connectors: expose getDocument in create/update/delete mutations

@netlify/sdk@1.28.3 (2024-03-14)

Bug Fixes

  • update SDK with content-engine changes

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @netlify/content-engine bumped to 0.0.31

@netlify/sdk@1.28.2 (2024-03-13)

Bug Fixes

  • remove cjs-shim as it seems to break enablement of integrations.

@netlify/sdk@1.28.1(2024-03-13)

Bug Fixes

  • use import.meta.url again

@netlify/sdk@1.27.1 (2024-03-12)

Bug Fixes

  • remove publish dir from internal edge functions directory path and use cp promise

@netlify/sdk@1.27.0 (2024-03-11)

Features

  • connectors: lock bundled connectors SDK version

@netlify/sdk@1.26.1 (2024-03-11)

Bug Fixes

  • use __dirname instead of import.meta.url for ef injection

@netlify/sdk@1.26.0 (2024-03-08)

Features

  • add edge function injection functionality
  • add support for color and html simple types in Netlify Create

Bug Fixes

  • connectors: use modelDataAPIs[modelName] instead of models.get(modelName) to lookup models

@netlify/create-sdk@1.5.0 (2024-03-08)

Features

  • add edge function injection functionality

Bug Fixes

  • deps: update dependency @netlify/edge-bundler to ^11.3.0

@netlify/sdk@1.25.0 (2024-03-07)

Features

  • connectors: support multiple simultaneous connector instances of the same integration instance

@netlify/sdk@1.24.0 (2024-03-06)

Features

  • automatically enable connectors or build event handlers in the default onEnable method if they are available.

@netlify/sdk@1.23.2 (2024-03-05)

Bug Fixes

  • connectors: Netlify Create model conversion tests.

@netlify/sdk@1.23.1 (2024-03-04)

Bug Fixes

  • connectors: create model test ts errors.

@netlify/sdk@1.23.0 (2024-03-01)

Features

  • use _updatedAt field as default cacheField if one is not provided.

Bug Fixes

  • local run of SDK init using local bin.

@netlify/create-sdk@1.4.4 (2024-03-01)

Bug Fixes

  • add a none option to boilerplate selection for create-sdk and prefill integrationLevel and permissions when having chosen build event handler or connector boilerplate.
  • integration level selection with and without boilerplate.
  • local run of SDK init using local bin.

1.22.0

connectors:

  • Added the ability to upload assets (pre-alpha feature)
  • Fixed a devdep vs dependency issue

1.20.3

connectors:

  • added a new action DELETE_MISSING_NODE that’s emitted when model.name.delete() is called for a node that’s already been deleted

1.20.2

connectors:

  • fixed a bug where number ids in reference fields were causing errors

1.19.1

  • exported additional connector TS types DefineDocumentArgs, DefineEnumArgs, ModelField, ModelFields, ModelFieldsObject, and ModelFieldsArray

1.19.0

connectors:

  • fix a “framework hooks” content-engine bug when supports.create === true but no local frontend exists in integration.yml
  • add suport for a type “kind” field to handle conflicting field types between internal and connector-defined types

1.18.1

connectors:

  • Export PlatformType TS type

1.18.0

create-sdk:

  • skip “git init” if the current dir is already part of a repo
  • pipe dependency install subprocess stdout/err to the main process
  • merge duplicate install steps

connectors:

  • Add enum support

1.17.4

  • removed connector GraphQL types for internal fields that start with _ (for ex _status, _createdAt, _updatedAt)

1.17.3

  • fixed a connector regression where builtin types would conflict with developer defined types
  • fixed a CLI output issue where a lot of whitespace was printed while running netlify-integration build

1.17.1

connectors: removed global ID transformation in connector.documents.create API

1.17.0

  • Internal changes related to upcoming connector features

1.16.1

  • Fixed a Connect bug when resolving object union values

1.15.0

Connectors:

  • Made __typename and _versionId reserved internal fields
  • internal changes related to upcoming connector APIs

1.14.2

  • Internal changes related to upcoming connector APIs: Use original model names for new connector APIs without auto-renaming to pascalcase.

1.14.1

  • Internal changes related to upcoming connector APIs

1.14.0

  • Internal changes related to upcoming connector APIs

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

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.

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