SOFA

Patch Changes

• #1413 ef9ffb6 Thanks @mhayes! - Fix release

• #1410 4999686 Thanks @renovate! - dependencies updates:

  • Updated dependency fets@^0.7.0 ↗︎ (from ^0.6.4, in dependencies)

Patch Changes

• #1372 dac1f7e Thanks @gilgardosh! - Bug fix: Generate spec for Union types

• #1388 ffe6e67 Thanks @robertherber! - fix: add types to exports in package.json

• #1390 03b0ccf Thanks @ardatan! - dependencies updates:

  • Updated dependency @whatwg-node/fetch@^0.9.14 ↗︎ (from ^0.9.0, in dependencies)
  • Updated dependency fets@^0.6.4 ↗︎ (from ^0.2.0, in dependencies)

• #1370 028af74 Thanks @nathanchapman! - Handle nested query parameters

Minor Changes

• f6afa0e Thanks @ardatan! - Breaking changes:

  • Drop Node 14 support and require Node >16

  • OpenAPI options are now under openAPI

  • SwaggerUI options are now under swaggerUI

Patch Changes

• 61e0494 Thanks @ardatan! - Add missing options for OAS

Minor Changes

• a32e2d6 Thanks @ardatan! - BREAKING: Now OpenAPI module has been deprecated, SOFA now automatically generates `openapi.json` and Swagger UI on `/docs` on the fly

vNEXT

v0.12.0

• Allow to override mapping of custom scalar to OpenAPI (#1159) - Thanks @izumin5210
• Stop using AST Node to retrieve Enum values in OpenAPI (#1158) - Thanks @izumin5210
• Feature/openapi tags description (#1114) - Thanks @NorbertRuff
• Fix payload parsing for subscriptions (#1148) - Thanks @csuriano23

• Allow to override mapping of custom scalar to OpenAPI (#1159) - Thanks @izumin5210
• Stop using AST Node to retrieve Enum values in OpenAPI (#1158) - Thanks @izumin5210
• Feature/openapi tags description (#1114) - Thanks @NorbertRuff
• Fix payload parsing for subscriptions (#1148) - Thanks @csuriano23

BREAKING CHANGES

• createSofaRouter is no longer exported, use useSofa directly
• useSofa now supports more server frameworks. It uses itty-router and @whatwg-node/server so it supports almost all JS environments;
  See more
  Documentation on SOFA's docs will be updated soon.
• OpenAPI no longer has .save method. Use .get to get the schema;

const openApi = OpenAPI({
  schema,
  servers: [
    {
      url: '/', // Specify Server's URL.
      description: 'Development server',
    },
  ],
  info: {
    title: 'Example API',
    version: '3.0.0',
  },
});

- openApi.save('swagger.json');
+ fs.writeFileSync('swagger.json', JSON.stringify(openApi.get(), null, 2));

In this release express is removed as dependency. New basePath option is required to resolve sofa routes properly

app.use(
  '/api',
  useSofa({
    basePath: '/api',
    schema,
  })
);

Added new server framework agnostic api

const invokeSofa = createSofaRouter({
  basePath: '/api',
  schema,
});
...
const response = await invokeSofa({
  method: req.method,
  url: req.url,
  body: JSON.parse(await getStream(req)),
  contextValue: {
    req
  },
});

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

• Replace winston with custom logger (#534) - Thanks @TrySound !

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

• Bump @graphql-tools/utils to fix https://github.com/ardatan/graphql-tools/pull/1928

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

• Update dependencies

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

List of changes:

• feat(swagger): custom components and security for OpenAPI PR #296

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

List of changes:

• fix(swagger): broken type of ID scalar in generated swagger document PR #280
• fix: do not resolve nil variables PR #193
• fix: use Kind from graphql instead of strings PR #192
• fix: replace request package with Axios PR #194

Do you want The Guild to keep your codebase up to date and run your build on each GraphQL Inspector commit so we will make sure not to break your app?
Contact us here: the-guild.dev/connected-build
Chat with us on discord

List of changes:

• fix(swagger): fix descriptions PR #178
• feat: support GraphQL Interfaces PR #167

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we'll make sure not to break your app?
Contact us here: the-guild.dev/connected-build

• fix: do not skip falsy values (only null and undefined) PR #134

Do you want The Guild to keep your codebase up to date and run your build on each Sofa commit so we'll make sure not to break your app?
Contact us here: the-guild.dev/connected-build

• feat(swagger): add description PR #107
• feat(swagger): add ID scalar definition PR #107
• fix(swagger): use requestBody or parameters not both PR #107
• fix(swagger): generate valid YAML structure for nested objects PR #107
• fix(swagger): avoid empty required array PR #107

• feat: add error handler PR #44 PR #45
• feat: allow to customize endpoint's HTTP Method PR #46
• feat: add InputTypeObjects to OpenAPI generation PR #34 - @hajnalben

• fix: parse InputTypeObject with JSON.parse PR #30
• feat: custom depthLimit (circular references) PR #29

• fix: prevent circular references PR #23