Package detail

@pothos/plugin-directives

hayes31.8kISC4.2.0

Directive plugin for Pothos, enables using graphql-tools based directives with Pothos

pothos, graphql, schema, directives, tools, visitor, transforms, plugin

readme

Directives Plugin

A plugin for using schema directives with schemas generated by Pothos.

Schema Directives are not intended to be used with code first schemas, but there is a large existing community with several very useful directives based

Usage

Install

yarn add @pothos/plugin-directives

Setup

import DirectivePlugin from '@pothos/plugin-directives';
import { rateLimitDirective } from 'graphql-rate-limit-directive';

const builder = new SchemaBuilder<{
  Directives: {
    rateLimit: {
      locations: 'OBJECT' | 'FIELD_DEFINITION';
      args: { limit: number, duration: number };
    };
  };
}>({
  plugins: [DirectivePlugin],
  directives: {
    useGraphQLToolsUnorderedDirectives: true,
  }
});

builder.queryType({
  directives: {
    rateLimit: { limit: 5, duration: 60 },
  },
  fields: (t) => ({
    hello: t.string({ resolve: () => 'world' });
  });
});

const { rateLimitDirectiveTransformer } = rateLimitDirective();
const schema = rateLimitDirectiveTransformer(builder.toSchema());

The directives plugin allows you to define types for the directives your schema will use the SchemaTypes parameter. Each directive can define a set of locations the directive can appear, and an object type representing the arguments the directive accepts.

The valid locations for directives are:

ARGUMENT_DEFINITION
ENUM_VALUE
ENUM
FIELD_DEFINITION
INPUT_FIELD_DEFINITION
INPUT_OBJECT
INTERFACE
OBJECT
SCALAR
SCHEMA
UNION

Pothos does not apply the directives itself, this plugin simply adds directive information to the extensions property of the underlying GraphQL type so that it can be consumed by other tools like graphql-tools.

By default this plugin uses the format that Gatsby uses (described here). This format was not supported by older versions of graphql-tools. To support older versions of graphql-tools or directives that provide a schema visitor based on an older graphql-tools version like the rate-limit directive from the example above you can set the useGraphQLToolsUnorderedDirectives option. This option does not preserve the order that directives are defined in. This will be okay for most cases, but may cause issues if your directives need to be applied in a specific order.

To define directives on your fields or types, you can add a directives property in any of the supported locations using one of the following 2 formats:

{
  directives: [
    {
      name: "validation",
      args: {
        regex: "/abc+/"
      }
    },
    {
      name: "required",
      args: {},
    }
  ],
  // or
  directives: {
    validation: {
      regex: "/abc+/"
    },
    required: {}
  }
}

Each of these applies the same 2 directives. The first format is preferred, especially when using directives that are sensitive to ordering, or can be repeated multiple times for the same location.

Applying directives

For most locations (On fields and types) the options object for the field or type will have a directives option which can be used to define directives.

To apply SCHEMA directives, you can use the schemaDirectives option on the toSchema method. directives on toSchema is reserved for the Directive implementations.

changelog

Change Log

4.2.0

Minor Changes

ea9981f: Improve ast representation of direvtive arguments

4.1.0

Minor Changes

27af377: replace eslint and prettier with biome

4.0.1

Patch Changes

9bd203e: Fix graphql peer dependency version to match documented minumum version

4.0.0

Major Changes

29841a8: Release Pothos v4 🎉 see https://pothos-graphql.dev/docs/migrations/v4 for more details

Patch Changes

c1e6dcb: update readmes

4.0.0-next.1

Patch Changes

update readmes

4.0.0-next.0

Major Changes

29841a8: Release Pothos v4 🎉 see https://pothos-graphql.dev/docs/migrations/v4 for more details

3.10.3

Patch Changes

1ecea46: revert accidental pinning of graphql peer dependency

3.10.2

Patch Changes

4c6bc638: Add provinance to npm releases

3.10.1

Patch Changes

671a9935: Add ast nodes for defaultalues for args and input fields

3.10.0

Minor Changes

487b810a: Add support for @interfaceObject and @composeDirective
487b810a: Add schemaDirectives option to toSchema for defining SCHEMA directives

3.9.2

Patch Changes

0eb6cb94: Fix bug that ignored directives added directly via extensions in some locations

3.9.1

Patch Changes

bf6a6d2b: make directives plugin more compatible with older versions of graphql.js

3.9.0

Minor Changes

cd1c0502: Add support for nested lists

3.8.4

Patch Changes

d4d41796: Update dev dependencies

3.8.3

Patch Changes

6f00194c: Fix an issue with esm import transform

3.8.2

Patch Changes

b12f9122: Fix issue with esm build script

3.8.1

Patch Changes

d350f842: update dev deps

3.8.0

Minor Changes

4c086637: Add deprecated directive to mock ast nodes

3.7.4

Patch Changes

9fa27cf7: Transform dynamic type imports in d.ts files

3.7.3

Patch Changes

3a82d645: Apply esm transform to esm d.ts definitions

3.7.2

Patch Changes

218fc68b: Fix script for copying ems d.ts definitions

3.7.1

Patch Changes

67531f1e: Create separate typescript definitions for esm files

3.7.0

Minor Changes

11929311: Update type definitions to work with module: "nodeNext"

3.6.1

Patch Changes

aa18acb7: update dev dependencies

3.6.0

Minor Changes

d67764b5: Make options objecst on toSchema, queryType, and mutationType optional

3.5.2

Patch Changes

e297e78a: Support typescript@4.8

3.5.1

Patch Changes

3ead60ae: update dev deps

3.5.0

Minor Changes

3a7ff291: Refactor internal imports to remove import cycles

Patch Changes

3a7ff291: Update dev dependencies

3.4.3

Patch Changes

7311904e: Update dev deps

3.4.2

Patch Changes

c8f75aa1: Update dev dependencies

3.4.1

Patch Changes

4e5756ca: Update dev dependencies

3.4.0

Minor Changes

ecb2714c: Add types entry to export map in package.json and update dev dependencies

This should fix compatibility with typescripts new "moduleResolution": "node12"

3.3.1

Patch Changes

971f1aad: Update dev dependencies

3.3.0

Minor Changes

a8e31a70: Improve user experience when srtict mode is disabled

3.2.0

Minor Changes

6279235f: Update build process to use swc and move type definitions to dts directory

Patch Changes

21a2454e: update dev dependencies

3.1.3

Patch Changes

ad8d119b: update dev dependencies

3.1.2

Patch Changes

03aecf76: update .npmignore

3.1.1

Patch Changes

2d9b21cd: Use workspace:* for dev dependencies on pothos packages

3.1.0

Minor Changes

4094e70a: Add initial support for new federation plugin

3.0.0

Major Changes

4caad5e4: Rename GiraphQL to Pothos

2.11.0

Minor Changes

9307635a: Migrate build process to use turborepo

2.10.2

Patch Changes

c6aa732: graphql@15 type compatibility fix

2.10.1

Patch Changes

c85dc33: Add types entry in package.json

2.10.0

Minor Changes

aeef5e5: Update dependencies

2.9.0

Minor Changes

9107f29: Update dependencies (includes graphql 16)

2.8.0

Minor Changes

17db3bd: Make type refs extendable by plugins

2.7.2

Patch Changes

c976bfe: Update dependencies

2.7.1

Patch Changes

4150f92: Fixed esm transformer for path-imports from dependencies

2.7.0

Minor Changes

dc87e68: update esm build process so extensions are added during build rather than in source

2.6.2

Patch Changes

b4b8381: Updrade deps (typescript 4.4)

2.6.1

Patch Changes

f04be64: Update dependencies

2.6.0

Minor Changes

a4c87cf: Use ".js" extensions everywhere and add module and exports to package.json to better support ems in node

2.5.2

Patch Changes

f13208c: bump to fix latest tag

2.5.1

Patch Changes

9ab8fbc: re-release previous version due to build-process issue

2.5.0

Minor Changes

3dd3ff14: Updated dev dependencies, switched to pnpm, and added changesets for releases

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

2.4.1 - 2021-08-03

Note: Version bump only for package @giraphql/plugin-directives

2.4.1-alpha.0 - 2021-08-02

Note: Version bump only for package @giraphql/plugin-directives

2.4.0 - 2021-07-30

🚀 Updates

add prisma plugin (d427c82)

Note: Version bump only for package @giraphql/plugin-directives

2.3.4 - 2021-07-23

Note: Version bump only for package @giraphql/plugin-directives

2.3.4-alpha.0 - 2021-07-17

Note: Version bump only for package @giraphql/plugin-directives

2.3.3 - 2021-07-10

Note: Version bump only for package @giraphql/plugin-directives

2.3.2 - 2021-07-04

Note: Version bump only for package @giraphql/plugin-directives

2.3.2-alpha.0 - 2021-07-04

📦 Dependencies

upgrade typescript (675f6a2)

Note: Version bump only for package @giraphql/plugin-directives

2.3.1 - 2021-07-02

Note: Version bump only for package @giraphql/plugin-directives

2.3.0 - 2021-06-28

Note: Version bump only for package @giraphql/plugin-directives

2.3.0-alpha.1 - 2021-06-28

Note: Version bump only for package @giraphql/plugin-directives

2.3.0-alpha.0 - 2021-06-28

🚀 Updates

add errors plugin (88509b4)

Note: Version bump only for package @giraphql/plugin-directives

2.2.0 - 2021-06-11

🚀 Updates

make field options args optional when empty (ae71648)

📦 Dependencies

update dev deps (813d9d0)

Note: Version bump only for package @giraphql/plugin-directives

2.1.6 - 2021-06-10

Note: Version bump only for package @giraphql/plugin-directives

2.1.6-alpha.0 - 2021-06-09

Note: Version bump only for package @giraphql/plugin-directives

2.1.5 - 2021-05-18

Note: Version bump only for package @giraphql/plugin-directives

2.1.4 - 2021-05-13

📘 Docs

add docs for loadableNode (1ae01e8)

🛠 Internals

add tests for loadableNode (c1b49a0)

Note: Version bump only for package @giraphql/plugin-directives

2.1.3 - 2021-05-12

🛠 Internals

udate dev deps (3251227)

Note: Version bump only for package @giraphql/plugin-directives

2.1.2 - 2021-05-10

🐞 Fixes

update ci build command (7e1d1d2)

Note: Version bump only for package @giraphql/plugin-directives

2.1.1 - 2021-05-10

🐞 Fixes

force new version to fix esm build issue (25f1fd2)

Note: Version bump only for package @giraphql/plugin-directives

2.1.0 - 2021-05-10

🚀 Updates

add esm build for all packages (d8bbdc9)

Note: Version bump only for package @giraphql/plugin-directives

2.0.8 - 2021-05-09

📘 Docs

update readmes (07c727b)

Note: Version bump only for package @giraphql/plugin-directives

2.0.8-alpha.0 - 2021-05-08

Note: Version bump only for package @giraphql/plugin-directives

2.0.7 - 2021-05-05

Note: Version bump only for package @giraphql/plugin-directives

2.0.6 - 2021-05-05

Note: Version bump only for package @giraphql/plugin-directives

2.0.6-alpha.0 - 2021-05-05

Note: Version bump only for package @giraphql/plugin-directives

2.0.5 - 2021-05-02

🛠 Internals

force version bumps and update validation to 2.0 range (07730b3)

Note: Version bump only for package @giraphql/plugin-directives

2.0.4 - 2021-05-02

🛠 Internals

migrate to @beemo/dev for dev tool configs (1da1283)

Note: Version bump only for package @giraphql/plugin-directives

2.0.3 - 2021-04-16

Note: Version bump only for package @giraphql/plugin-directives

2.0.3-alpha.0 - 2021-04-12

📦 Dependencies

update dev dependencies (25a15d4)
update dev deps (cbfa0a4)

Note: Version bump only for package @giraphql/plugin-directives

2.0.2 - 2021-03-16

Note: Version bump only for package @giraphql/plugin-directives

2.0.1 - 2021-02-19

Note: Version bump only for package @giraphql/plugin-directives

2.0.0 - 2021-02-16

💥 Breaking

update plugin API to avoid modifying args. subGraphs are now build by passing subGraph to toSchema (66d456e)
update plugin exports and names to be more consistent (ee07b35)

📦 Dependencies

update dependencies and add license files (cb0d102)

📘 Docs

add more docs o writing plugins (b996fc6)

Note: Version bump only for package @giraphql/plugin-directives

2.0.0-alpha.1 - 2021-02-10

🛠 Internals

fix broken dev deps (7af8a0a)

Note: Version bump only for package @giraphql/plugin-directives

2.0.0-alpha.0 - 2021-02-10

💥 Breaking

bump peer deps to 2.0 range (2a0fae8)

🚀 Updates

add directives plugin (b44ccde)

🐞 Fixes

add useGraphQLToolsUnorderedDirectives option to directive plugin (a9e1ca6)
move rate limit directive to devDependencies (1415572)
update peer deps for directives plugin (bf28486)

🛠 Internals

add some basic scope-auth tests (7ceb24a)

Note: Version bump only for package @giraphql/plugin-directives

1.1.0-alpha.1 - 2021-02-01

🐞 Fixes

add useGraphQLToolsUnorderedDirectives option to directive plugin (6517dd4)

Note: Version bump only for package @giraphql/plugin-directives

1.1.0-alpha.0 - 2021-02-01

🚀 Updates

add directives plugin (ff76fe7)

Note: Version bump only for package @giraphql/plugin-directives