houdini 1.0.0-next.5 → 1.0.0-next.7

package/build/lib/graphql.d.ts

@@ -1,9 +1,9 @@
 import * as graphql from 'graphql';
-import type { CollectedGraphQLDocument, Config } from '.';
+import type { Document, Config } from '.';
 export declare function getRootType(type: graphql.GraphQLType): graphql.GraphQLType;
 export declare function hashDocument({ document, }: {
     config: Config;
-    document: string | CollectedGraphQLDocument;
+    document: string | Document;
 }): string;
 type GraphQLParentType = graphql.GraphQLObjectType | graphql.GraphQLInputObjectType | graphql.GraphQLInterfaceType;
 export declare function parentTypeFromAncestors(schema: graphql.GraphQLSchema, filepath: string, ancestors: readonly any[]): GraphQLParentType;

package/build/lib/types.d.ts

@@ -17,7 +17,7 @@ export type TransformDocument = {
 /**
  * The result of collecting documents from source code
  */
-export type CollectedGraphQLDocument = {
+export type Document = {
     /**
      * The name of the document.
      */
@@ -39,10 +39,6 @@ export type CollectedGraphQLDocument = {
      * The parsed document. This value should be modified throughout the pipeline.
      * */
     document: graphql.DocumentNode;
-    /**
-     * The document that the user provided
-     * */
-    originalDocument: graphql.DocumentNode;
     /**
      * Whether an artifact should be generated for the document. This should be set to false for internal
      * or virtual documents .
@@ -57,6 +53,10 @@ export type CollectedGraphQLDocument = {
      * The original document string that the user passed
      */
     originalString: string;
+    /**
+     * The parsed document that the user provided
+     * */
+    originalParsed: graphql.DocumentNode;
     /**
      * Refetch logic that has been built up throughout the pipeline
      */
@@ -91,15 +91,15 @@ export type PluginHooks = {
      * A relative path from the file exporting your plugin to a runtime that will be
      * automatically included with your
      */
-    include_runtime?: string | {
+    includeRuntime?: string | {
         esm: string;
         commonjs: string;
     };
     /**
      * Transform the plugin's runtime while houdini is copying it .
-     * You must have passed a value to include_runtime for this hook to matter.
+     * You must have passed a value to includeRuntime for this hook to matter.
      */
-    transform_runtime?: Record<string, (args: {
+    transformRuntime?: Record<string, (args: {
         config: Config;
         content: string;
     }) => string>;
@@ -119,7 +119,7 @@ export type PluginHooks = {
     /**
      * Invoked after all plugins have loaded and modified config values.
      */
-    after_load?: (args: {
+    afterLoad?: (args: {
         config: Config;
     }) => Promise<void> | void;
     /**
@@ -139,7 +139,7 @@ export type PluginHooks = {
     /**
      * Configure the codegen pipeline to extract graphql documents out of a file.
      */
-    extract_documents?: (args: {
+    extractDocuments?: (args: {
         config: Config;
         filepath: string;
         content: string;
@@ -147,7 +147,7 @@ export type PluginHooks = {
     /**
      * Can be used to add custom definitions to your project's schema. Definitions (like directives) added
      * here are automatically removed from the document before they are sent to the server. Useful
-     * in connection with artifact_data or artifact_selection to embed data in the artifact.
+     * in connection with artifactData or artifact_selection to embed data in the artifact.
      */
     schema?: (args: {
         config: Config;
@@ -155,53 +155,53 @@ export type PluginHooks = {
     /**
      * A hook to transform the documents before they are validated.
      */
-    before_validate?: (args: {
+    beforeValidate?: (args: {
         config: Config;
-        documents: CollectedGraphQLDocument[];
+        documents: Document[];
     }) => Promise<void> | void;
     /**
      * A hook to validate all of the documents in a project.
      */
     validate?: (args: {
         config: Config;
-        documents: CollectedGraphQLDocument[];
+        documents: Document[];
     }) => Promise<void> | void;
     /**
      * A hook to transform the documents after they are validated.
      */
-    after_validate?: (args: {
+    afterValidate?: (args: {
         config: Config;
-        documents: CollectedGraphQLDocument[];
+        documents: Document[];
     }) => Promise<void> | void;
     /**
      * A hook to transform the documents before documents are generated.
      */
-    transform_before_generate?: (args: {
+    beforeGenerate?: (args: {
         config: Config;
-        documents: CollectedGraphQLDocument[];
+        documents: Document[];
     }) => Promise<void> | void;
     /**
      * A hook to embed metadata at the root of the artifact.
      */
-    artifact_data?: (args: {
+    artifactData?: (args: {
         config: Config;
-        document: CollectedGraphQLDocument;
+        document: Document;
     }) => Record<string, any>;
     /**
      * A hook to customize the hash generated for your document.
      */
     hash?: (args: {
         config: Config;
-        document: CollectedGraphQLDocument;
+        document: Document;
     }) => string;
     /**
      * A hook to customize the return type of the graphql function. If you need to add an import to the file
      * in order to resolve the import, you can use the `ensure_import` utility.
      */
-    graphql_tag_return?: (args: {
+    graphqlTagReturn?: (args: {
         config: Config;
-        document: CollectedGraphQLDocument;
-        ensure_import: (import_args: {
+        document: Document;
+        ensureImport: (import_args: {
             identifier: string;
             module: string;
         }) => void;
@@ -209,7 +209,7 @@ export type PluginHooks = {
     /**
      * A hook to modify the root `index.js` of the generated runtime.
      */
-    index_file?: ModuleIndexTransform;
+    indexFile?: ModuleIndexTransform;
     /**
      * A hook to generate custom files for every document in a project.
      */
@@ -217,19 +217,19 @@ export type PluginHooks = {
     /**
      * A hook to modify the generated artifact before it is persisted
      */
-    artifact_end?: (args: {
+    artifactEnd?: (args: {
         config: Config;
-        document: CollectedGraphQLDocument;
+        document: Document;
     }) => void;
     /**
      * Specify the plugins that should be added to the user's client because
      * of this plugin.
      */
-    client_plugins?: Record<string, null | Record<string, any>> | ((config: ConfigFile, pluginConfig: any) => Record<string, null | Record<string, any>>);
+    clientPlugins?: Record<string, null | Record<string, any>> | ((config: ConfigFile, pluginConfig: any) => Record<string, null | Record<string, any>>);
     /**
      * A hook to transform the source file to support desired APIs.
      */
-    transform_file?: (page: TransformPage) => Promise<{
+    transformFile?: (page: TransformPage) => Promise<{
         code: string;
     }> | {
         code: string;
@@ -250,22 +250,22 @@ export type PluginHooks = {
 type ModuleIndexTransform = (arg: {
     config: Config;
     content: string;
-    export_default_as(args: {
+    exportDefaultAs(args: {
         module: string;
         as: string;
     }): string;
-    export_star_from(args: {
+    exportStarFrom(args: {
         module: string;
     }): string;
-    plugin_root: string;
+    pluginRoot: string;
     typedef: boolean;
-    documents: CollectedGraphQLDocument[];
+    documents: Document[];
 }) => string;
 export type GenerateHook = (args: GenerateHookInput) => Promise<void> | void;
 export type GenerateHookInput = {
     config: Config;
-    documents: CollectedGraphQLDocument[];
-    plugin_root: string;
+    documents: Document[];
+    pluginRoot: string;
 };
 export type PluginConfig = {
     configPath?: string;