Import plugin interface

package.json

@@ -15,8 +15,7 @@
 		"@types/relay-runtime": "^1.3.1",
 		"immutable": "~3.7.6",
 		"invariant": "2.2.2",
-		"relay-compiler": "file:../relay/dist/relay-compiler-1.4.1.tgz",
-		"relay-runtime": "file:../relay/dist/relay-runtime-1.4.1.tgz",
+		"relay-compiler": "file:../relay/dist/relay-compiler/relay-compiler-1.4.1-plugin.2.tgz",
 		"yargs": "^9.0.0"
 	},
 	"peerDependencies": {
@@ -29,5 +28,7 @@
 		"@types/yargs": "10.0.1",
 		"typescript": "2.6.2"
 	},
-	"resolutions": {}
+	"resolutions": {
+    "relay-runtime": "file:../relay/dist/relay-runtime/relay-runtime-1.4.1-plugin.2.tgz"
+  }
 }

types/relay-compiler/language/RelayLanguagePluginInterface.d.ts

@@ -0,0 +1,50 @@
+import { RelayConcreteNode } from 'relay-runtime';
+import { Root, Fragment, IRTransform } from '../../graphql-compiler';
+
+export type GraphQLTag = {
+  keyName: string | null,
+  template: string,
+  sourceLocationOffset: {
+    /* TODO: Is this also expected to use 1-based index? */
+    line: number,
+    /* Should use 1-based index */
+    column: number,
+  }
+};
+
+/**
+ * Generate a module for the given document name/text.
+ */
+export type FormatModule = (args: {
+  moduleName: string,
+  documentType:
+    | typeof RelayConcreteNode.FRAGMENT
+    | typeof RelayConcreteNode.REQUEST
+    | typeof RelayConcreteNode.BATCH_REQUEST
+    | null,
+  docText: string | null,
+  concreteText: string,
+  typeText: string,
+  hash: string | null,
+  devOnlyAssignments: string | null,
+  relayRuntimeModule: string,
+  sourceHash: string,
+}) => string;
+
+export type GraphQLTagFinder = (
+  text: string,
+) => Array<GraphQLTag>;
+
+export interface TypeGenerator {
+  transforms: Array<IRTransform>,
+  // For now this is an opaque set of options communicated from the bin to the plugin.
+  generate: (node: Root | Fragment, options: any) => string,
+}
+
+export interface PluginInterface {
+  inputExtensions: string[],
+  outputExtension: string,
+  findGraphQLTags: GraphQLTagFinder,
+  formatModule: FormatModule,
+  typeGenerator: TypeGenerator,
+}