Add typescript definitions

[rricard]

For now, in some use cases, TS (in atom) warns: Argument of type 'TemplateStringsArray' is not assignable to parameter of type 'string'. for using gql like this:

gql` ... `

[rricard]

Found a fix to that: your typescript is too old. if you are using atom, please change the path to the typescriptServices in your config

[philcockfield]

@rricard - is this working for you? I updated the typescriptServices.js file as you showed, to the version of TypeScript I'm using, but I'm still getting the build error:

.../graphql.spec.tsx(26,22): error TS2345: Argument of 
type 'TemplateStringsArray' is not assignable to parameter of 
type 'string'.

Where are you getting your typescriptServices.js file from?

[rricard]

I installed the latest tsc from npm using npm i -g typescript.

[philcockfield]

@stubailo FYI here's the wrapper hack I wrote to get this working in TS:

import gql from 'graphql-tag';
import { Document } from 'graphql';



/**
 * Processes the given template string parts.
 */
function formatTemplate(literals: Array<string>, ...placeholders: Array<any>): any {
  const parts = [];
  literals.forEach((item, i) => {
    parts.push(item);
    if (placeholders[i]) {
      parts.push(placeholders[i]);
    }
  });
  return [parts.join('')];
}



/**
 * Process the given template-string into a GraphQL query.
 *  NOTE:
 *    This is a layer of indirection to `graphql-tag` because
 *    TypeScript does not play nicely with the module at the moment.
 */
export default (literals: Array<string>, ...placeholders: Array<string>): Document => {
  const query = formatTemplate(literals, ...placeholders);
  return (<any> gql)(query);
};

[philcockfield]

The type definition file that produces is:

import { Document } from 'graphql';
declare var _default: (literals: string[], ...placeholders: string[]) => Document;
export default _default;

[stubailo]

Hmm, how do dependencies in TypeScript definition files work? Since this package doesn't actually have a dependency on GraphQL, is it going to be weird?

[philcockfield]

I don't thinks so. This is what you already have in your index.d.ts
https://github.com./apollostack/graphql-tag/blob/master/index.d.ts

import { Document } from 'graphql';
export default function gql(str: string): Document;

Where/how did you generate that file?

My understanding (as it stands) is that you don't need this package to reference graphql, however when someone installs this package within a TS project, they will need to add typings for graphql:

typings install graphql --save

---

@stubailo, why not write this module in TS directly, like Apollo-Client

[stubailo]

Where/how did you generate that file?

I wrote it by hand!

why not write this module in TS directly

Honestly it's too much work to set up the build process for a module this simple - it's like 10 lines of code.

[philcockfield]

Fair enough.

[stubailo]

Anyone have the time to write a better definition?

[philcockfield]

@stubailo - I suspect this would do the trick:

index.d.ts

import { Document } from 'graphql';
export default function gql(literals: Array<string>, ...placeholders: Array<string>): Document;

[stubailo]

OK I'll try this one and republish soon!

[mquandalle]

@stubailo I pushed the fix proposed by @philcockfield, which works as expected and fixes the OP bug. Please publish on NPM if that’s good for you.

[stubailo]

Publishing now!

[stubailo]

Done - published as 0.1.10!