houdini 1.0.0-next.4 → 1.0.0-next.5

package/build/lib/config.d.ts

@@ -1,16 +1,14 @@
 import * as graphql from 'graphql';
-import type { CustomPluginOptions, LoadResult, ObjectHook, PluginContext, ResolveIdResult } from 'rollup';
 import type { ConfigFile } from '../runtime/lib';
 import { CachePolicy } from '../runtime/lib';
-import type { TransformPage } from '../vite/houdini';
-import type { CollectedGraphQLDocument } from './types';
-export type PluginMeta = Plugin & {
+import type { PluginConfig, PluginHooks } from './types';
+import { LogLevel } from './types';
+export type PluginMeta = PluginHooks & {
     name: string;
-    include_runtime: boolean;
-    version: string;
-    directory: string;
+    filepath: string;
 };
 export declare class Config {
+    #private;
     filepath: string;
     rootDir: string;
     projectRoot: string;
@@ -26,7 +24,6 @@ export declare class Config {
     internalListPosition: 'first' | 'last';
     defaultListTarget: 'all' | null;
     definitionsFolder?: string;
-    newSchema: string;
     newDocuments: string;
     defaultKeys: string[];
     typeConfig: ConfigFile['types'];
@@ -50,6 +47,8 @@ export declare class Config {
     processEnvValues(env: Record<string, string | undefined>, value: string | ((env: any) => string)): string | undefined;
     pullHeaders(): Promise<any>;
     sourceFiles(): Promise<string[]>;
+    set newSchema(value: string);
+    get newSchema(): string;
     get artifactDirectory(): string;
     get artifactDirectoryName(): string;
     get artifactTypeDirectory(): string;
@@ -62,7 +61,6 @@ export declare class Config {
     get typeIndexPath(): string;
     get typeRootDir(): string;
     get typeRootFile(): string;
-    findModule(pkg?: string, currentLocation?: string): string;
     get runtimeSource(): string;
     artifactTypePath(document: graphql.DocumentNode): string;
     artifactPath(document: graphql.DocumentNode): string;
@@ -74,6 +72,7 @@ export declare class Config {
     createDirectories(): void;
     get compiledAssetsDir(): string;
     compiledAssetPath(filepath: string): string;
+    excludeFile(filepath: string): boolean;
     includeFile(filepath: string, { root, ignore_plugins, }?: {
         root?: string;
         ignore_plugins?: boolean;
@@ -119,7 +118,7 @@ export declare class Config {
     isToggleFragment(name: string): boolean;
     listRemoveFragment(name: string): string;
     isInternalEnum(node: graphql.EnumTypeDefinitionNode): boolean;
-    isInternalDirective({ name }: graphql.DirectiveNode): boolean;
+    isInternalDirective(name: string): boolean;
     isListFragment(name: string): boolean;
     isListOperationDirective(name: string): boolean;
     isFragmentForList(listName: string, fragmentName: string): boolean;
@@ -130,87 +129,8 @@ export declare class Config {
     extractQueryDefinition(document: graphql.DocumentNode): graphql.OperationDefinitionNode;
     variableFunctionName(name: string): string;
 }
-export declare function readConfigFile(configPath?: string): Promise<ConfigFile>;
 export declare function getConfig({ configPath, noSchema, ...extraConfig }?: PluginConfig & {
     noSchema?: boolean;
 }): Promise<Config>;
-export declare enum LogLevel {
-    Full = "full",
-    Summary = "summary",
-    ShortSummary = "short-summary",
-    Quiet = "quiet"
-}
-export type PluginFactory = (args?: PluginConfig) => Promise<Plugin>;
+export declare function readConfigFile(configPath?: string): Promise<ConfigFile>;
 export declare const orderedPlugins: (plugins: PluginMeta[]) => PluginMeta[];
-export type Plugin = {
-    order?: 'before' | 'after' | 'core';
-    extensions?: string[];
-    transform_runtime?: Record<string, (args: {
-        config: Config;
-        content: string;
-    }) => string>;
-    after_load?: (config: Config) => Promise<void> | void;
-    artifact_data?: (config: Config, doc: CollectedGraphQLDocument) => Record<string, any>;
-    extract_documents?: (config: Config, filepath: string, content: string) => Promise<string[]> | string[];
-    generate?: GenerateHook;
-    client_plugins?: Record<string, null | Record<string, any>> | ((config: ConfigFile, pluginConfig: any) => Record<string, null | Record<string, any>>);
-    transform_file?: (page: TransformPage) => Promise<{
-        code: string;
-    }> | {
-        code: string;
-    };
-    index_file?: ModuleIndexTransform;
-    graphql_tag_return?: (args: {
-        config: Config;
-        doc: CollectedGraphQLDocument;
-        ensure_import: (import_args: {
-            identifier: string;
-            module: string;
-        }) => void;
-    }) => string | undefined;
-    env?: (args: {
-        env: any;
-        config: Config;
-    }) => Promise<Record<string, string>>;
-    validate?: (args: {
-        config: Config;
-        documents: CollectedGraphQLDocument[];
-    }) => Promise<void> | void;
-    vite?: {
-        resolveId?: ObjectHook<(this: PluginContext, source: string, importer: string | undefined, options: {
-            config: Config;
-            custom?: CustomPluginOptions;
-            ssr?: boolean;
-            isEntry: boolean;
-        }) => Promise<ResolveIdResult> | ResolveIdResult>;
-        load?: ObjectHook<(this: PluginContext, id: string, options: {
-            config: Config;
-            ssr?: boolean;
-        }) => Promise<LoadResult> | LoadResult>;
-    };
-    include?: (config: Config, filepath: string) => boolean | null | undefined;
-};
-type ModuleIndexTransform = (arg: {
-    config: Config;
-    content: string;
-    export_default_as(args: {
-        module: string;
-        as: string;
-    }): string;
-    export_star_from(args: {
-        module: string;
-    }): string;
-    plugin_root: string;
-    typedef: boolean;
-    documents: CollectedGraphQLDocument[];
-}) => string;
-export type GenerateHook = (args: GenerateHookInput) => Promise<void> | void;
-export type GenerateHookInput = {
-    config: Config;
-    documents: CollectedGraphQLDocument[];
-    plugin_root: string;
-};
-export type PluginConfig = {
-    configPath?: string;
-} & Partial<ConfigFile>;
-export {};

package/build/lib/deepMerge.d.ts

@@ -0,0 +1 @@
+export declare function deepMerge(filepath: string, ...targets: {}[]): {};

package/build/lib/graphql.d.ts

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

package/build/lib/index.d.ts

@@ -9,6 +9,8 @@ export * from './types';
 export * from './constants';
 export * from './introspection';
 export * from './cleanupFiles';
+export * from './deepMerge';
+export * from './plugin';
 export * from './walk';
 export type { EmbeddedGraphqlDocument } from './walk';
 export * as fs from './fs';

package/build/lib/pipeline.d.ts

@@ -1,3 +1,3 @@
 import type { Config } from './config';
-export type Transform<_TransformType> = null | ((config: Config, documents: _TransformType) => Promise<void>);
+export type Transform<_TransformType> = null | ((config: Config, documents: _TransformType) => Promise<void> | void);
 export declare function runPipeline<_TransformType>(config: Config, pipeline: Transform<_TransformType>[], target: _TransformType): Promise<void>;

package/build/lib/plugin.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin, PluginInit } from './types';
+export declare function plugin(name: string, hooks: Plugin): PluginInit;

package/build/lib/types.d.ts

@@ -1,6 +1,9 @@
 import type graphql from 'graphql';
 import type * as recast from 'recast';
-import type { ArtifactKind, BaseCompiledDocument } from '../runtime/lib/types';
+import type { CustomPluginOptions, LoadResult, ObjectHook, PluginContext, ResolveIdResult } from 'rollup';
+import type { ConfigFile } from '../runtime/lib/config';
+import type { ArtifactKind, BaseCompiledDocument, DocumentArtifact } from '../runtime/lib/types';
+import type { TransformPage } from '../vite/houdini';
 import type { Config } from './config';
 type Program = recast.types.namedTypes.Program;
 export type Maybe<T> = T | null | undefined;
@@ -11,16 +14,261 @@ export type TransformDocument = {
     dependencies: string[];
     filename: string;
 };
+/**
+ * The result of collecting documents from source code
+ */
 export type CollectedGraphQLDocument = {
+    /**
+     * The name of the document.
+     */
+    name: string;
+    /**
+     * A field you can use to distinguish documents by type (query, mutation, subscription, fragment)
+     */
     kind: ArtifactKind;
+    /**
+     * The artifact generated for the document. This will only have a value in the last phase
+     * of the Generation Pipeline.
+     */
+    artifact: DocumentArtifact | null;
+    /**
+     * The path of the file containing this document
+     */
     filename: string;
-    name: string;
+    /**
+     * 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 .
+     */
     generateArtifact: boolean;
+    /**
+     * Whether a runtime equivalent should be generated for the document. This should be set to false for internal
+     * or virtual documents .
+     */
     generateStore: boolean;
+    /**
+     * The original document string that the user passed
+     */
     originalString: string;
+    /**
+     * Refetch logic that has been built up throughout the pipeline
+     */
     refetch?: BaseCompiledDocument['refetch'];
 };
+export declare enum LogLevel {
+    Full = "full",
+    Summary = "summary",
+    ShortSummary = "short-summary",
+    Quiet = "quiet"
+}
+export type Plugin = (args?: PluginConfig) => Promise<(PluginHooks | PluginInit) | (PluginHooks | PluginInit)[] | null | false>;
+export type PluginInit = {
+    __plugin_init__: boolean;
+    plugin: Plugin;
+    name: string;
+    config?: {};
+    local?: string;
+    with(config: {}): PluginInit;
+};
+export type PluginHooks = {
+    /**
+     * Specify the priority for the hook. The order is before -> core -> after.
+     * @default 'before'
+     */
+    order?: 'before' | 'after' | 'core';
+    /**
+     * Add extensions to the list that houdini uses to find valid source files
+     */
+    extensions?: string[];
+    /**
+     * A relative path from the file exporting your plugin to a runtime that will be
+     * automatically included with your
+     */
+    include_runtime?: 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.
+     */
+    transform_runtime?: Record<string, (args: {
+        config: Config;
+        content: string;
+    }) => string>;
+    /**
+     * Used to modify any values that the user passed to their config files. Configuration values
+     * that you return will be deeply merged with the previous value.
+     */
+    config?: (old: ConfigFile) => ConfigFile | Promise<ConfigFile>;
+    /**
+     *
+     * Add environment variables to houdini's pipeline (ie, for schema polling headers, url, etc.)
+     */
+    env?: (args: {
+        env: any;
+        config: Config;
+    }) => Promise<Record<string, string>>;
+    /**
+     * Invoked after all plugins have loaded and modified config values.
+     */
+    after_load?: (args: {
+        config: Config;
+    }) => Promise<void> | void;
+    /**
+     * A filter for whether a file should be included in the the processing. Return true to include.
+     */
+    include?: (args: {
+        config: Config;
+        filepath: string;
+    }) => boolean | null | undefined;
+    /**
+     * A filter for whether a file should be included in the the processing. Return false to include.
+     */
+    exclude?: (args: {
+        config: Config;
+        filepath: string;
+    }) => boolean | null | undefined;
+    /**
+     * Configure the codegen pipeline to extract graphql documents out of a file.
+     */
+    extract_documents?: (args: {
+        config: Config;
+        filepath: string;
+        content: string;
+    }) => Promise<string[] | null> | string[] | null;
+    /**
+     * 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.
+     */
+    schema?: (args: {
+        config: Config;
+    }) => string;
+    /**
+     * A hook to transform the documents before they are validated.
+     */
+    before_validate?: (args: {
+        config: Config;
+        documents: CollectedGraphQLDocument[];
+    }) => Promise<void> | void;
+    /**
+     * A hook to validate all of the documents in a project.
+     */
+    validate?: (args: {
+        config: Config;
+        documents: CollectedGraphQLDocument[];
+    }) => Promise<void> | void;
+    /**
+     * A hook to transform the documents after they are validated.
+     */
+    after_validate?: (args: {
+        config: Config;
+        documents: CollectedGraphQLDocument[];
+    }) => Promise<void> | void;
+    /**
+     * A hook to transform the documents before documents are generated.
+     */
+    transform_before_generate?: (args: {
+        config: Config;
+        documents: CollectedGraphQLDocument[];
+    }) => Promise<void> | void;
+    /**
+     * A hook to embed metadata at the root of the artifact.
+     */
+    artifact_data?: (args: {
+        config: Config;
+        document: CollectedGraphQLDocument;
+    }) => Record<string, any>;
+    /**
+     * A hook to customize the hash generated for your document.
+     */
+    hash?: (args: {
+        config: Config;
+        document: CollectedGraphQLDocument;
+    }) => 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: {
+        config: Config;
+        document: CollectedGraphQLDocument;
+        ensure_import: (import_args: {
+            identifier: string;
+            module: string;
+        }) => void;
+    }) => string | undefined;
+    /**
+     * A hook to modify the root `index.js` of the generated runtime.
+     */
+    index_file?: ModuleIndexTransform;
+    /**
+     * A hook to generate custom files for every document in a project.
+     */
+    generate?: GenerateHook;
+    /**
+     * A hook to modify the generated artifact before it is persisted
+     */
+    artifact_end?: (args: {
+        config: Config;
+        document: CollectedGraphQLDocument;
+    }) => 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>>);
+    /**
+     * A hook to transform the source file to support desired APIs.
+     */
+    transform_file?: (page: TransformPage) => Promise<{
+        code: string;
+    }> | {
+        code: string;
+    };
+    vite?: {
+        resolveId?: ObjectHook<(this: PluginContext, source: string, importer: string | undefined, options: {
+            config: Config;
+            custom?: CustomPluginOptions;
+            ssr?: boolean;
+            isEntry: boolean;
+        }) => Promise<ResolveIdResult> | ResolveIdResult>;
+        load?: ObjectHook<(this: PluginContext, id: string, options: {
+            config: Config;
+            ssr?: boolean;
+        }) => Promise<LoadResult> | LoadResult>;
+    };
+};
+type ModuleIndexTransform = (arg: {
+    config: Config;
+    content: string;
+    export_default_as(args: {
+        module: string;
+        as: string;
+    }): string;
+    export_star_from(args: {
+        module: string;
+    }): string;
+    plugin_root: string;
+    typedef: boolean;
+    documents: CollectedGraphQLDocument[];
+}) => string;
+export type GenerateHook = (args: GenerateHookInput) => Promise<void> | void;
+export type GenerateHookInput = {
+    config: Config;
+    documents: CollectedGraphQLDocument[];
+    plugin_root: string;
+};
+export type PluginConfig = {
+    configPath?: string;
+} & Partial<ConfigFile>;
 export * from '../runtime/lib/types';
 export * from '../runtime/lib/config';