Upcoming Release Changes

[github-actions[bot]]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

Releases

@eddeee888/gcg-server-config@0.2.0

Minor Changes

• de5599b: Move union and interface config from server config to server preset

  This config is fairly opinionated and may not make sense being on server config. However, it is definitely the default mode of operation we want to use for server preset to avoid having extra files, simplifying the setup.

@eddeee888/gcg-typescript-resolver-files@0.8.0

Minor Changes

• 6bf957d: Extend resolverGeneration functionality

  Allow passing in an object that to control which files to be generated. By default (i.e. resolverGeneration: 'recommended'), it's equivalent to the following settings:

  defineConfig({
    resolverGeneration: {
      query: '*',
      mutation: '*',
      subscription: '*',
      scalar: '*',
      object: '*',
      union: '',
      interface: '',
    },
  });

  Each option can take a glob pattern to tell the preset which files of a given type to be generated based on its normalized file name.

  ---

  A normalized file name has this pattern:

  <Module name>.<Top-level type name>.<Field resolver>?

  Consider this schema:

  # src/schema/pet/schema.graphql
  extend type Query {
    pets: [Pet!]!
  }
  
  type Cat {
    id: ID!
  }
  type Dog {
    id: ID!
  }
  union Pet = Cat | Dog
  
  # src/schema/user/schema.graphql
  extend type Mutation {
    createUser(id: ID!): CreateUserResult!
  }
  
  type User {
    id: ID!
  }
  
  type CreateUserOk {
    result: User!
  }
  type CreateUserError {
    error: String!
  }
  union CreateUserResult = CreateUserOk | CreateUserError

  Then, the generated files and normalised names are:

  • src/schema/pet/resolvers/Query/pets.ts, affected by query option, normalized name: pet.Query.pets
  • src/schema/pet/resolvers/Cat.ts, affected by object option, normalized name: pet.Cat
  • src/schema/pet/resolvers/Dog.ts, affected by object option, normalized name: pet.Dog
  • src/schema/pet/resolvers/Pet.ts, affected by union option, normalized name: pet.Pet
  • src/schema/user/resolvers/Mutation/createUser.ts, affected by mutation option, normalized name: user.Mutation.createUser
  • src/schema/user/resolvers/User.ts, affected by object option, normalized name: user.User
  • src/schema/user/resolvers/CreateUserOk.ts, affected by object option, normalized name: user.CreateUserOk
  • src/schema/user/resolvers/CreateUserError.ts, affected by object option, normalized name: user.CreateUserError
  • src/schema/user/resolvers/CreateUserResult.ts, affected by union option, normalized name: user.CreateUserResult

  Now, let's say we want to disable all union files, types ending with Ok or Error, the config would look like this:

  defineConfig({
    resolverGeneration: {
      query: '*',
      mutation: '*',
      subscription: '*',
      scalar: '*',
      object: ['!*.*Ok', '!*.*Error'], // Disables objects ending with `Ok` or `Error` in every module
      union: '', // Empty string disables all file generation of relevant type in every module
      interface: '*',
    },
  });

• 00a80bc: Bump ts-morph to v22 which requires TypeScript 5.4

Patch Changes

• 6bf957d: Add colours to logs

• de5599b: Move union and interface config from server config to server preset

  This config is fairly opinionated and may not make sense being on server config. However, it is definitely the default mode of operation we want to use for server preset to avoid having extra files, simplifying the setup.

• Updated dependencies [de5599b]

  • @eddeee888/gcg-server-config@0.2.0