appsync-schema-converter

Release 2.1.4

Converts GraphQL schemas into AppSync compatible version.

Homepage Repository npm Download

Keywords
aws, appsync, directives, graphql, schema, utilities
License
BSD-2-Clause
Install
npm install appsync-schema-converter@2.1.4

Documentation

AppSync Schema Converter

The sole purpose of this package is to convert modern GraphQL schemas into AppSync compatible version.

  1. printSchema() is a copy of graphql@^14.4.2/utilities/schemaPrinter.js@printSchema with includesDirectives: Boolean option added.
  2. convertSchemas(schemas: [string]) takes an array of GraphQL SDL string and converts them into one single AppSync comptaible schema.

My team only works with Apollo, so expects more care on that front.

If AppSync updates their ancient GraphQL engine, I am more than happy to ditch this package.

Serverless Framework

This package also made with serverless-appsync-plugin in mind, especially useful when merge-graphql-schemas was in your stack.

You make use of variables in JavaScript and write a little script to merge schemas into AppSync compatible one.

Based on your serverless-appsync-plugin settings, change this line in your serverless.yml.

custom:
  appSync:
    schema: ${file(schema.js):compile}

Then read and convert your schemas in schema.js@compile.

const { promisify } = require('util');
const glob = require('glob');
const { readFile, writeFile } = require('fs').promises;
const { convertSchemas } = require("appsync-schema-converter");

const SCHEMA_PATH = './schema.graphql';

module.exports.compile = async _ => {
  let schemas;

  schemas = await promisify(glob)(`${__dirname}/schemas/**/*.graphql`);
  schemas = await Promise.all(schemas.map(async schema => (await readFile(schema)).toString('utf8')));

  schemas = convertSchemas(schemas, {
    commentDescriptions: true,
    includeDirectives: true,
  });

  await writeFile(SCHEMA_PATH, schemas);

  return SCHEMA_PATH;
};

Contributors

Stats

Dependencies
1
Dependent packages
6
Dependent repositories
0
Total releases
23
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
9

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

2.1.4
2.1.3
2.1.2
2.1.1
2.0.0
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
See all 23 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-11-30 05:44:29 UTC

Login to resync this project