houdini 0.15.9 → 0.16.0-next.2

package/.eslintrc.cjs

@@ -0,0 +1,36 @@
+module.exports = {
+	root: true,
+	extends: '@theguild',
+	rules: {
+		'@typescript-eslint/no-unused-vars': 'off',
+		'@typescript-eslint/ban-ts-comment': 'off',
+		'@typescript-eslint/no-non-null-assertion': 'off',
+		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/no-empty-function': 'off',
+		'@typescript-eslint/ban-types': 'off',
+		'@typescript-eslint/no-inferrable-types': 'off',
+		'@typescript-eslint/prefer-as-const': 'off',
+		'@typescript-eslint/no-var-requires': 'off',
+		'unicorn/no-lonely-if': 'off',
+		'unicorn/filename-case': 'off',
+		'unicorn/no-instanceof-array': 'off',
+		'unicorn/prefer-includes': 'off',
+		'import/no-default-export': 'off',
+		'sonarjs/no-gratuitous-expressions': 'off',
+		'no-lonely-if': 'off',
+		'no-console': 'off',
+		'prefer-arrow-callback': 'off',
+		'prefer-const': 'off',
+		'no-else-return': 'off',
+		'no-empty': 'off',
+		'no-var': 'off',
+		'no-undef': 'off',
+		'object-shorthand': 'off',
+		// 'no-console': ['error', { allow: ['info', 'warn', 'error', 'time', 'timeEnd'] }],
+	},
+	ignorePatterns: ['integration', 'example', 'site'],
+	parserOptions: {
+		sourceType: 'module',
+		ecmaVersion: 2020,
+	},
+}

package/.prettierignore

@@ -1,4 +1,3 @@
-.yarn/
 **/build/**
 README.md
 .github/**

package/.prettierrc

@@ -4,5 +4,8 @@
 	"useTabs": true,
 	"singleQuote": true,
 	"printWidth": 100,
-	"trailingComma": "es5"
+	"trailingComma": "es5",
+	"plugins": ["@trivago/prettier-plugin-sort-imports"],
+	"importOrder": ["<THIRD_PARTY_MODULES>", "^[./]"],
+	"importOrderSeparation": true
 }

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # houdini
 
+## 0.16.0-next.2
+
+### Patch Changes
+
+-   [#483](https://github.com/HoudiniGraphql/houdini/pull/483) [`a69138a`](https://github.com/HoudiniGraphql/houdini/commit/a69138ae2908b0517cdbfe8b544b634e6f96df53) Thanks [@jycouet](https://github.com/jycouet)! - fix: check field existence before @list directive to have better error msg
+
+## 0.16.0-next.1
+
+### Patch Changes
+
+-   [#479](https://github.com/HoudiniGraphql/houdini/pull/479) [`9a9d376`](https://github.com/HoudiniGraphql/houdini/commit/9a9d376d7d707889a5ca77a5b98ebddcef7d6272) Thanks [@janvotava](https://github.com/janvotava)! - fix readDirSync patch (fixing file.isDirectory is not a function)
+
+## 0.16.0-next.0
+
+### ⚠️ Breaking Changes
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - remove inline document functions query, paginatedQuery, subscription, and mutation
+
+*   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - renamed `generate --pull-header` to `generate --header` and `generate --persist-output` to `generate --output`
+
+*   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - inverted argument order for inline fragments
+
+*   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - Stores are now classes and need to be instantiated with `new MyQueryStore()`
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - query stores must now be passed to routes as props instead of globally imported
+
+*   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - SvelteKit projects must now use `houdini/kit` as a vite plugin
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - `config.sourceGlob` has been renamed to `config.include` and is now optional. Also added `config.exclude` to filter out files matched by `config.include`
+
+### ✨ Features
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - added support for page queries
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@jycouet](https://github.com/jycouet)! - You can now define the prefix of your global stores with globalStorePrefix param in the config.
+
+*   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - graphql tags return store references
+
+-   [#449](https://github.com/HoudiniGraphql/houdini/pull/449) [`59257d1`](https://github.com/HoudiniGraphql/houdini/commit/59257d1dffa6c1d9d250ba0964c6f1f0c35da048) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - add generated typedefs for route functions
+
 ## 0.15.9
 
 ### Patch Changes

package/README.md

@@ -5,7 +5,7 @@
   <br />
 
   <strong>
-    The disappearing GraphQL client for Sapper and SvelteKit.
+    The disappearing GraphQL client for SvelteKit.
   </strong>
   <br />
   <br />
@@ -14,18 +14,19 @@
 
 ```svelte
 <script>
-    import { query, graphql } from '$houdini'
+    // src/routes/items/+page.svelte
+    import { graphql } from '$houdini'
 
-    const { data } = query(graphql`
-        query AllTodoItems {
+    const AllItems = graphql`
+        query AllItems {
             items {
                 text
             }
         }
-    `)
+    `
 </script>
 
-{#each $data.items as item}
+{#each $AllItems.data.items as item}
     <div>{item.text}</div>
 {/each}
 ```
@@ -36,7 +37,7 @@
 -   Normalized cache with declarative updates
 -   Generated types
 -   Subscriptions
--   Support for SvelteKit and Sapper
+-   Support for SvelteKit
 -   Pagination (cursors **and** offsets)
 
 At its core, houdini seeks to enable a high quality developer experience

package/build/cmd/generate.js

@@ -27,17 +27,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runPipeline = void 0;
-// externals
 const glob_1 = __importDefault(require("glob"));
-const svelte = __importStar(require("svelte/compiler"));
-const promises_1 = __importDefault(require("fs/promises"));
 const graphql = __importStar(require("graphql"));
+const minimatch_1 = __importDefault(require("minimatch"));
+const path_1 = __importDefault(require("path"));
+const svelte = __importStar(require("svelte/compiler"));
 const util_1 = require("util");
-// locals
 const common_1 = require("../common");
-const types_1 = require("./types");
-const transforms = __importStar(require("./transforms"));
 const generators = __importStar(require("./generators"));
+const transforms = __importStar(require("./transforms"));
+const types_1 = require("./types");
 const validators = __importStar(require("./validators"));
 // the main entry point of the compile script
 async function compile(config) {
@@ -65,92 +64,116 @@ async function runPipeline(config, docs) {
         new: [],
         deleted: [],
     };
-    // notify the user we are starting the generation process
-    if (config.logLevel !== common_1.LogLevel.Quiet) {
-        console.log('🎩 Generating runtime...');
-    }
     // the last version the runtime was generated with
     let previousVersion = '';
+    let newClientPath = false;
+    let newTimestamp = false;
+    const content = await (0, common_1.readFile)(config.metaFilePath);
+    if (content) {
+        try {
+            const parsed = JSON.parse(content);
+            previousVersion = parsed.version + parsed.createdOn;
+            newClientPath = parsed.client !== config.client;
+            // look up the source metadata (so we can figure out if the version actually changed)
+            const sourceMeta = await (0, common_1.readFile)(path_1.default.join(config.runtimeSource, 'meta.json'));
+            if (!sourceMeta) {
+                throw new Error('skip');
+            }
+            // if the two timestamps are not the same, we have a new version
+            newTimestamp = JSON.parse(sourceMeta).timestamp !== parsed.timestamp;
+        }
+        catch { }
+    }
+    // generate the runtime if the version changed, if its a new project, or they changed their client path
+    const generateRuntime = newTimestamp || newClientPath || !previousVersion;
+    // run the generate command before we print "🎩 Generating runtime..." because we don't know upfront artifactStats.
+    let error = null;
     try {
-        const content = JSON.parse(await promises_1.default.readFile(config.metaFilePath, 'utf-8'));
-        previousVersion = content.version;
+        await (0, common_1.runPipeline)(config, [
+            // validators
+            validators.typeCheck,
+            validators.uniqueNames,
+            validators.noIDAlias,
+            validators.forbiddenNames,
+            // transforms
+            transforms.internalSchema,
+            transforms.addID,
+            transforms.typename,
+            // list transform must go before fragment variables
+            // so that the mutation fragments are defined before they get mixed in
+            transforms.list,
+            // paginate transform needs to go before fragmentVariables
+            // so that the variable definitions get hashed
+            transforms.paginate,
+            transforms.fragmentVariables,
+            transforms.composeQueries,
+            // generators
+            // the runtime is a static thing most of the time. It only needs to be regenerated if
+            // the user is upgrading versions or the client path changed
+            generateRuntime ? generators.runtime : null,
+            generators.artifacts(artifactStats),
+            generators.typescript,
+            generators.persistOutput,
+            generators.definitions,
+            generators.stores,
+            // this has to go after runtime and artifacts
+            generators.kit,
+        ], docs);
     }
-    catch { }
-    // if the previous version is different from the current version
-    const versionChanged = previousVersion && previousVersion !== 'HOUDINI_VERSION';
-    await (0, common_1.runPipeline)(config, [
-        // validators
-        validators.typeCheck,
-        validators.uniqueNames,
-        validators.noIDAlias,
-        // transforms
-        transforms.internalSchema,
-        transforms.addID,
-        transforms.typename,
-        // list transform must go before fragment variables
-        // so that the mutation fragments are defined before they get mixed in
-        transforms.list,
-        // paginate transform needs to go before fragmentVariables
-        // so that the variable definitions get hashed
-        transforms.paginate,
-        transforms.fragmentVariables,
-        transforms.composeQueries,
-        // generators
-        generators.runtime,
-        generators.artifacts(artifactStats),
-        generators.typescript,
-        generators.persistOutput,
-        generators.definitions,
-        generators.stores,
-    ], docs);
-    // don't log anything if its quiet
-    if (config.logLevel === common_1.LogLevel.Quiet) {
+    catch (e) {
+        error = e;
+    }
+    /// Summary
+    // count the number of unchanged
+    const unchanged = artifactStats.total.length -
+        artifactStats.changed.length -
+        artifactStats.new.length -
+        artifactStats.deleted.length;
+    // If triggered from the plugin, we show logs ONLY if there are changes.
+    const printMessage = !config.plugin || unchanged !== artifactStats.total.length;
+    if (!printMessage || config.logLevel === common_1.LogLevel.Quiet) {
+        if (error) {
+            throw error;
+        }
+        return;
     }
-    else if (versionChanged) {
+    if (!config.plugin) {
+        console.log('🎩 Generating runtime...');
+    }
+    if (error) {
+        throw error;
+    }
+    // if we detected a version change, we're nuking everything so don't bother with a summary
+    if (newTimestamp) {
         console.log('💣 Detected new version of Houdini. Regenerating all documents...');
         console.log('🎉 Welcome to HOUDINI_VERSION!');
         // if the user is coming from a version pre-15, point them to the migration guide
         const major = parseInt(previousVersion.split('.')[1]);
-        if (major < 15) {
-            console.log(`❓ For a description of what's changed, visit this guide: https://www.houdinigraphql.com/guides/migrating-to-0.15.0
-❓ Don't forget to update your sourceGlob config value if you want to define documents in external files.`);
+        if (major < 16) {
+            console.log(`❓ For a description of what's changed, visit this guide: http://docs-next-kohl.vercel.app/guides/release-notes`);
         }
     }
+    // print a line showing that the process is finished (wo document)
+    else if (artifactStats.total.length === 0) {
+        console.log(`💡 No operation found. If that's unexpected, please check your config.`);
+    }
+    // print summaries of the changes
     else if ([common_1.LogLevel.Summary, common_1.LogLevel.ShortSummary].includes(config.logLevel)) {
-        // count the number of unchanged
-        const unchanged = artifactStats.total.length -
-            artifactStats.changed.length -
-            artifactStats.new.length -
-            artifactStats.deleted.length;
         // if we have any unchanged artifacts
-        if (unchanged > 0) {
+        if (unchanged > 0 && printMessage && !config.plugin) {
             console.log(`📃 Unchanged: ${unchanged}`);
         }
-        if (artifactStats.changed.length > 0) {
-            console.log(`✏️  Changed: ${artifactStats.changed.length}`);
-            if (config.logLevel === common_1.LogLevel.Summary) {
-                logFirst5(artifactStats.changed);
-            }
-        }
-        if (artifactStats.new.length > 0) {
-            console.log(`✨ New: ${artifactStats.new.length}`);
-            if (config.logLevel === common_1.LogLevel.Summary) {
-                logFirst5(artifactStats.new);
-            }
-        }
-        if (artifactStats.deleted.length > 0) {
-            console.log(`🧹 Deleted: ${artifactStats.deleted.length}`);
-            if (config.logLevel === common_1.LogLevel.Summary) {
-                logFirst5(artifactStats.deleted);
-            }
-        }
+        logStyled('CREATED', artifactStats.new, config.logLevel, config.plugin);
+        logStyled('UPDATED', artifactStats.changed, config.logLevel, config.plugin);
+        logStyled('DELETED', artifactStats.deleted, config.logLevel, config.plugin);
     }
+    // print the status of every file
     else if (config.logLevel === common_1.LogLevel.Full) {
         for (const artifact of artifactStats.total) {
             // figure out the emoji to use
             let emoji = '📃';
             if (artifactStats.changed.includes(artifact)) {
-                emoji = '✏️ ';
+                emoji = '✏️';
             }
             else if (artifactStats.new.includes(artifact)) {
                 emoji = '✨';
@@ -166,52 +189,79 @@ async function runPipeline(config, docs) {
 exports.runPipeline = runPipeline;
 async function collectDocuments(config) {
     // the first step we have to do is grab a list of every file in the source tree
-    const sourceFiles = await (0, util_1.promisify)(glob_1.default)(config.sourceGlob);
+    let sourceFiles = await (0, util_1.promisify)(glob_1.default)(config.include);
+    if (config.exclude) {
+        sourceFiles = sourceFiles.filter((filepath) => !(0, minimatch_1.default)(filepath, config.exclude));
+    }
     // the list of documents we found
     const documents = [];
     // wait for every file to be processed
     await Promise.all(sourceFiles.map(async (filepath) => {
         // read the file
-        const contents = await promises_1.default.readFile(filepath, 'utf-8');
+        const contents = await (0, common_1.readFile)(filepath);
+        if (!contents) {
+            return;
+        }
         // if the file ends with .svelte, we need to look for graphql template tags
         if (filepath.endsWith('.svelte')) {
-            documents.push(...(await findGraphQLTemplates(filepath, contents)));
+            documents.push(...(await processSvelteFile(filepath, contents)));
         }
-        // otherwise just treat the file as a graphql file (the whole file contents constitute a graphql file)
-        else {
+        else if (filepath.endsWith('.graphql') || filepath.endsWith('.gql')) {
             documents.push({
                 filepath,
                 document: contents,
             });
         }
+        // otherwise just treat the file as a javascript file
+        else {
+            documents.push(...(await processJSFile(config, filepath, contents)));
+        }
     }));
     return await Promise.all(documents.map(async ({ document, filepath }) => {
         try {
             return await processGraphQLDocument(config, filepath, document);
         }
         catch (e) {
-            throw {
-                ...e,
-                filepath,
-            };
+            throw new common_1.HoudiniError({ filepath, message: e.message });
         }
     }));
 }
-async function findGraphQLTemplates(filepath, contents) {
+async function processJSFile(config, filepath, contents) {
+    const documents = [];
+    // parse the contents as js
+    let program;
+    try {
+        program = (await (0, common_1.parseJS)(contents)).script;
+    }
+    catch (e) {
+        // add the filepath to the error message
+        throw new common_1.HoudiniError({ filepath, message: e.message });
+    }
+    // look for a graphql template tag
+    await (0, common_1.walkGraphQLTags)(config, program, {
+        tag(tag) {
+            documents.push({ document: tag.tagContent, filepath });
+        },
+    });
+    // we found every document in the file
+    return documents;
+}
+async function processSvelteFile(filepath, contents) {
     const documents = [];
     let parsedFile;
     try {
-        parsedFile = await (0, common_1.parseFile)(contents);
+        parsedFile = await (0, common_1.parseSvelte)(contents);
     }
     catch (e) {
         const err = e;
         // add the filepath to the error message
-        throw { message: `Encountered error parsing ${filepath}`, description: err.message };
+        throw new common_1.HoudiniError({
+            message: `Encountered error parsing ${filepath}`,
+            description: err.message,
+        });
     }
     // we need to look for multiple script tags to support sveltekit
-    const scripts = [parsedFile.instance, parsedFile.module]
-        .map((script) => (script ? script.content : null))
-        .filter(Boolean);
+    const scripts = [parsedFile];
     await Promise.all(scripts.map(async (jsContent) => {
         // @ts-ignore
         // look for any template tag literals in the script body
@@ -240,13 +290,19 @@ async function processGraphQLDocument(config, filepath, document) {
     const fragments = parsedDoc.definitions.filter(({ kind }) => kind === graphql.Kind.FRAGMENT_DEFINITION);
     // if there is more than one operation, throw an error
     if (operations.length > 1) {
-        throw { filepath, message: 'Operation documents can only have one operation' };
+        throw new common_1.HoudiniError({
+            filepath,
+            message: 'Operation documents can only have one operation',
+        });
     }
     // we are looking at a fragment document
     else {
         // if there is more than one fragment, throw an error
         if (fragments.length > 1) {
-            throw { filepath, message: 'Fragment documents can only have one fragment' };
+            throw new common_1.HoudiniError({
+                filepath,
+                message: 'Fragment documents can only have one fragment',
+            });
         }
     }
     // figure out the document kind
@@ -280,13 +336,51 @@ async function processGraphQLDocument(config, filepath, document) {
         originalString: document,
     };
 }
-function logFirst5(values) {
-    // grab the first 5 changed documents
-    for (const artifact of values.slice(0, 5)) {
-        console.log(`    ${artifact}`);
-    }
-    // if there are more than 5 just tell them how many
-    if (values.length > 5) {
-        console.log(`    ... ${values.length - 5} more`);
+function logStyled(kind, stat, logLevel, plugin) {
+    if (stat.length > 0) {
+        // Let's prepare the one liner in the plugin mode, of a bit more in other lol level.
+        const msg = [];
+        // in plugin mode, it will be very short, let's put a hat first.
+        if (plugin) {
+            msg.push(`🎩 `);
+        }
+        if (kind === 'CREATED') {
+            msg.push(`✨ `);
+            if (!plugin) {
+                msg.push(`New: ${stat.length}`);
+            }
+        }
+        else if (kind === 'UPDATED') {
+            msg.push(`✏️  `);
+            if (!plugin) {
+                msg.push(`Changed: ${stat.length}`);
+            }
+        }
+        else if (kind === 'DELETED') {
+            msg.push(`🧹 `);
+            if (!plugin) {
+                msg.push(`Deleted: ${stat.length}`);
+            }
+        }
+        // let's do a summary for x elements
+        const nbToDisplay = 5;
+        // format for plugin
+        if (plugin) {
+            msg.push(`${stat.slice(0, nbToDisplay).join(', ')}`);
+            if (stat.length > 5) {
+                msg.push(`, ... ${stat.length - nbToDisplay} more`);
+            }
+        }
+        console.log(msg.join(''));
+        // Format for not plugin & Summary mode
+        if (!plugin && logLevel === common_1.LogLevel.Summary) {
+            for (const artifact of stat.slice(0, nbToDisplay)) {
+                console.log(`    ${artifact}`);
+            }
+            // if there are more than 5 just tell them how many
+            if (stat.length > nbToDisplay) {
+                console.log(`    ... ${stat.length - nbToDisplay} more`);
+            }
+        }
     }
 }

package/build/cmd/generators/artifacts/fieldKey.js

@@ -23,7 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// external imports
 const graphql = __importStar(require("graphql"));
 // we need to generate a static key that we can use to index this field in the cache.
 // this needs to be a unique hash driven by the field's attribute and arguments
@@ -34,9 +33,7 @@ function fieldKey(config, field) {
     const attributeName = field.alias?.value || field.name.value;
     // field might not have a location so print and re-parse before we look at serialized values
     const printed = graphql.print(field);
-    const secondParse = graphql.parse(`{${printed}}`)
-        .definitions[0].selectionSet
-        .selections[0];
+    const secondParse = graphql.parse(`{${printed}}`).definitions[0].selectionSet.selections[0];
     // if the field is paginated, we need to strip away any args
     const paginated = !!field.directives?.find((directive) => directive.name.value === config.paginateDirective);
     const paginationArgs = ['first', 'after', 'last', 'before', 'limit', 'offset'];

package/build/cmd/generators/artifacts/index.d.ts

@@ -1,5 +1,5 @@
-import { CollectedGraphQLDocument } from '../../types';
 import { Config } from '../../../common';
+import { CollectedGraphQLDocument } from '../../types';
 export default function artifactGenerator(stats: {
     total: string[];
     new: string[];