Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Expose generic type system for plugins

See original GitHub issue

Is your feature request related to a problem? Please describe.

Currently, when creating the envelop with typescript there are some plugins that have no type information other than unknown, but they do return a Plugin<DefaultContext> meaning they do have some extensibility potential.

By pain point is using useExtendedSchema which has a function signature of (unknown) => unknown so when I pass my typed function, it says it’s not compatible.

Describe the solution you’d like Expose type generics to extend the plugin and that they match the context type coming from envelop.

envelop<Context extends DefaultContext = DefaultContext>(options: {
  plugins: Plugin<Context>[];
}) => Envelop<Context>;

useSchema<Context extends DefaultContext = DefaultContext>(schema: GraphQLSchema) => Plugin<Context>;

useExtendSchema<Context extends DefaultContext = DefaultContext, PrevContext  extends DefaultContext = DefaultContext>(createContext: (PrevContext) => Context) => Plugin<Context>;

// It could even go like this, since the previous context is something the entire envelop will receive at some point

envelop<
  Context extends DefaultContext = DefaultContext,
  PrevContext  extends DefaultContext = DefaultContext
>(options: {
  plugins: Plugin<Context, PrevContext>[];
}) => Envelop<Context, PrevContext>;

useSchema<Context extends DefaultContext = DefaultContext, PrevContext  extends DefaultContext = DefaultContext>(schema: GraphQLSchema) => Plugin<Context, PrevContext>;

useExtendSchema<Context extends DefaultContext = DefaultContext, PrevContext  extends DefaultContext = DefaultContext>(createContext: (PrevContext) => PromiseLike<Context>) => Plugin<Context, PrevContext>;

// This could even help type 

const {
        parse,
        validate,
        contextFactory,
        execute,
        schema
      } = getEnveloped();

contextFactory // (PrevContext) => PromiseLike<Context>

Describe alternatives you’ve considered Using as to cast the types but it’s not a very nice solution.