Missing typings for optional configuration

[a88zach]

Missing typings for optional configuration

[bizob2828]

@a88zach nice catch. We need to do a better job of keeping these up to date/checking.

[bizob2828]

@a88zach PRs are always welcome. As you can see we aren't writing native typescript so this is always overlooked, I apologize. This is going out shortly has 3.1.1 btw

[workato-integration]

https://issues.newrelic.com/browse/NR-145326

[a88zach]

@bizob2828 thanks for the fix! For a future version, I'd like to suggest a slight enhancement to the typings so that we can correctly type the resolver arguments and request context

export type NRPluginConfig<U = any, V = any> = {
  captureScalars?: boolean;
  captureIntrospectionQueries?: boolean;
  captureServiceDefinitionQueries?: boolean;
  captureHealthCheckQueries?: boolean;
  customResolverAttributes?: (
    resolverArguments: U
  ) => Record<string, string | number | boolean> | null;
  customOperationAttributes?: (
    requestContext: V
  ) => Record<string, string | number | boolean> | null;
  captureFieldMetrics?: boolean;
};

export default function createPlugin<T, U = any, V = any>(
  config?: NRPluginConfig<U, V>
): T;

This would give us strongly typed arguments for the 2 functions

expectType<V3Plugin>(createPlugin<V3Plugin>({}));
expectType<V3Plugin>(
  createPlugin<
    V3Plugin,
    { source: any; args: any; contextValue: { bar: string }; info: any },
    { bar: string }
  >({
    captureHealthCheckQueries: true,
    captureScalars: false,
    captureServiceDefinitionQueries: true,
    captureFieldMetrics: true,
    customOperationAttributes: (ctx) => ({
      attr: ctx.bar,
    }),
    customResolverAttributes: (ctx) => ({ attr: ctx.contextValue.bar }),
  })
);