Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@aws-amplify/graphql-directives

aws-amplify588.7kApache-2.02.7.1TypeScript support: included

Directive definitions for Amplify GraphQL transformers.

graphql, aws, amplify, directives

readme

Amplify GraphQL Directives

Source of truth for the GraphQL directive definition used by the Amplify GraphQL API.

:warning: Intended for internal Amplify use only.

Description

This package defines the GraphQL directives in GraphQL syntax. Each directive is imported into the corresponding GraphQL transformer. This package is responsible for the name, definition, and argument defaults for a directive. The GraphQL transformers utilize the GraphQL directives to define the behavior of the transform.

This package also contains the AppSync GraphQL directives. These directives are defined internally by AppSync. The definitions here are copied from the internal definition.

This package is intended to be the only source of truth for the GraphQL directive definitions used by the Amplify GraphQL API. This package should be imported in place of reproducing the definitions in other packages.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.7.1 (2025-04-17)

Note: Version bump only for package @aws-amplify/graphql-directives

2.7.0 (2025-02-26)

Features

2.6.1 (2024-12-17)

Note: Version bump only for package @aws-amplify/graphql-directives

2.6.0 (2024-11-14)

Features

  • conversation: require auth input for conversation directive (#3007) (39cca3f)
  • conversation: update directive input for tool definition for model list queries (#3013) (ee976cc)

2.5.0 (2024-11-08)

Features

  • add imported DDB tables for gen 2 migration in experimental state (#2992) (0c415b3)

2.4.0 (2024-10-17)

Features

  • constrain custom conversation handler event version (#2958) (083fe17)

2.3.0 (2024-10-10)

Features

2.2.0 (2024-09-16)

Features

  • function-transformer: add support for event invocation types (async lambda) (#2864) (6a54bad)

2.1.0 (2024-09-06)

Features

  • graphql-directives: add conversation and generation directive definitions (#2810) (fbb9d38)

2.0.0 (2024-08-20)

  • feat!: bump version for v2 transformer packages (7dac35c)

BREAKING CHANGES

  • distinguish from LTS version

1.1.0 (2024-04-26)

Features

  • add identityPool auth provider (8d1d24f)

1.0.1 (2024-03-28)

Note: Version bump only for package @aws-amplify/graphql-directives