Add toggle to docs between typescript and jsdocs (#791)

* Tweak docs for endpoints (#785) * ✏️ DOC: tweaks * ✏️ FIX: \t to ' ' * Fix error when prerendering application (#786) * don't add session infrastructure when static is set to true * use existing static config value * changeset * unused import * 📦 v0.19.2 (#788) * 📦 v{VERSION} * update changelogs * oops Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Alec Aivazis <[email protected]> * add js/ts toggle * fix search input sizing * duplicate code examples and implement toggle * convert all blocks to typescript * transform handles variable declaration type signatures * transform function parameters * transform svelte documents * add type definitions to rest of getting started guide * update guides * add types to authentication docs * remove semicolon * update snapshots * move typescript test to js Co-authored-by: JYC <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
HoudiniGraphql · Dec 26, 2022 · bf3e525 · bf3e525
1 parent 14ceac0
commit bf3e525
Show file tree

Hide file tree

Showing 57 changed files with 1,540 additions and 1,135 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,3 +19,5 @@ $houdini
 build/**
 dist/**
 .next/**
+
+vite.config.js.timestamp-*
diff --git a/e2e/sveltekit/package.json b/e2e/sveltekit/package.json
@@ -37,7 +37,7 @@
     "prettier": "^2.5.1",
     "prettier-plugin-svelte": "^2.5.0",
     "svelte": "3.55.0",
-    "svelte-check": "^2.2.6",
+    "svelte-check": "^3.0.1",
     "svelte-preprocess": "^5.0.0",
     "tslib": "^2.3.1",
     "typescript": "^4.9",

diff --git a/e2e/sveltekit/src/lib/utils/routes.ts b/e2e/sveltekit/src/lib/utils/routes.ts
@@ -24,6 +24,7 @@ export const routes = {
   Stores_SSR_One_Store_Multivariables: '/stores/ssr-one-store-multivariables',
   Stores_Fragment_Null: '/stores/fragment-null',
   Stores_Metadata: '/stores/metadata',
+  Stores_action_mutation: '/stores/action-mutation',
   Stores_Endpoint_Query: '/stores/endpoint-query',
   Stores_Endpoint_Mutation: '/stores/endpoint-mutation',
   Stores_Session: '/stores/session',

diff --git a/e2e/sveltekit/src/routes/stores/action-mutation/+page.server.js b/e2e/sveltekit/src/routes/stores/action-mutation/+page.server.js
@@ -0,0 +1,26 @@
+import { graphql } from '$houdini';
+import { fail } from '@sveltejs/kit';
+
+/** @type {import('./$types').Actions} */
+export const actions = {
+  add: async (event) => {
+    const data = await event.request.formData();
+
+    const name = data.get('name')?.toString();
+
+    if (!name) {
+      return fail(403, { name: '*' });
+    }
+
+    const actionMutation = graphql(`
+      mutation ActionMutation($name: String!) {
+        addUser(name: $name, birthDate: 254143016000, snapshot: "ActionMutation") {
+          id
+          name
+        }
+      }
+    `);
+
+    return await actionMutation.mutate({ name });
+  }
+};
diff --git a/e2e/sveltekit/src/routes/stores/action-mutation/+page.svelte b/e2e/sveltekit/src/routes/stores/action-mutation/+page.svelte
@@ -0,0 +1,21 @@
+<script>
+  import { enhance } from '$app/forms';
+
+  /** @type {import('./$types').ActionData} */
+  export let form;
+</script>
+
+<form method="POST" action="?/add" use:enhance>
+  <label>
+    Name
+    <input name="name" type="name" />
+  </label>
+  <span id="name-error"
+    >{#if form?.name}{form?.name}{/if}</span
+  >
+  <button type="submit">Add</button>
+</form>
+
+<div id="result">
+  {form?.addUser?.name || 'No user added'}
+</div>
diff --git a/e2e/sveltekit/src/routes/stores/action-mutation/spec.ts b/e2e/sveltekit/src/routes/stores/action-mutation/spec.ts
@@ -0,0 +1,36 @@
+import { sleep } from '@kitql/helper';
+import { test } from '@playwright/test';
+import { routes } from '../../../lib/utils/routes.js';
+import { expectToBe, goto } from '../../../lib/utils/testsHelper.js';
+
+test.describe('action-mutation', () => {
+  test('happy path action-mutation ', async ({ page }) => {
+    await goto(page, routes.Stores_action_mutation);
+
+    await expectToBe(page, 'No user added');
+
+    // click the button
+    await Promise.all([
+      page.waitForResponse((res) => res.url().endsWith('action-mutation?/add'), { timeout: 1000 }),
+      page.getByRole('button', { name: 'Add' }).click()
+    ]);
+
+    // a start should be displayed
+    await expectToBe(page, '*', 'span[id=name-error]');
+
+    // fill the input
+    await page.getByLabel('Name').fill('My New Name');
+
+    // add
+    await Promise.all([
+      page.waitForResponse((res) => res.url().endsWith('action-mutation?/add'), { timeout: 1000 }),
+      page.getByRole('button', { name: 'Add' }).click()
+    ]);
+
+    // wait for the message to appear
+    await sleep(500);
+
+    // check that we have the right data
+    await expectToBe(page, 'My New Name');
+  });
+});
diff --git a/...tes/stores/endpoint-query/+page.server.ts → ...tes/stores/endpoint-query/+page.server.js b/...tes/stores/endpoint-query/+page.server.ts → ...tes/stores/endpoint-query/+page.server.js
@@ -1,8 +1,8 @@
 import { GQL_Hello } from '$houdini';
-import type { RequestEvent } from '@sveltejs/kit';
 
-export async function load(event: RequestEvent) {
+/** @type {import('./$types').PageServerLoad} */
+export const load = async (event) => {
   const { data } = await GQL_Hello.fetch({ event });
 
   return { hello: data?.hello };
-}
+};
diff --git a/packages/houdini-plugin-svelte-global-stores/CHANGELOG.md b/packages/houdini-plugin-svelte-global-stores/CHANGELOG.md
@@ -1,5 +1,7 @@
 # houdini-plugin-svelte-global-stores
 
+## 0.19.2
+
 ## 0.19.1
 
 ## 0.19.0
diff --git a/packages/houdini-plugin-svelte-global-stores/README.md b/packages/houdini-plugin-svelte-global-stores/README.md
@@ -73,7 +73,7 @@ query MyAwesomeQuery {
 }
 ```
 
-```javascript
+```typescript
 // src/routes/myRoute/+page.js
 import { GQL_MyAwesomeQuery } from '$houdini'
 ```
@@ -117,7 +117,7 @@ Fragments stores can be created from your external documents by using the `.get`
 Using a query store inside of an endpoint looks very similar to the `load` function: just pass the event you
 are handed in your route function:
 
-```javascript
+```typescript
 import { GQL_MyQuery } from '$houdini'
 
 export async function get(event) {

diff --git a/packages/houdini-plugin-svelte-global-stores/package.json b/packages/houdini-plugin-svelte-global-stores/package.json
@@ -1,6 +1,6 @@
 {
     "name": "houdini-plugin-svelte-global-stores",
-    "version": "0.19.1",
+    "version": "0.19.2",
     "description": "The svelte global store plugin for houdini",
     "keywords": [
         "typescript",

diff --git a/packages/houdini-plugin-svelte-global-stores/src/plugin/codegen/stores/fragment.test.ts b/packages/houdini-plugin-svelte-global-stores/src/plugin/codegen/stores/fragment.test.ts
@@ -49,6 +49,10 @@ test('global fragment type', async function () {
 	)
 
 	expect(contents).toMatchInlineSnapshot(
-		'"import { TestFragment1Store } from \'../../houdini-svelte/stores\'\\n\\nexport const GQL_TestFragment1: TestFragment1Store"'
+		`
+		"import { TestFragment1Store } from '../../houdini-svelte/stores'
+
+		export const GQL_TestFragment1: TestFragment1Store"
+	`
 	)
 })
diff --git a/packages/houdini-react/CHANGELOG.md b/packages/houdini-react/CHANGELOG.md
@@ -1,5 +1,7 @@
 # houdini-react
 
+## 0.19.2
+
 ## 0.19.1
 
 ## 0.19.0

diff --git a/packages/houdini-react/package.json b/packages/houdini-react/package.json
@@ -1,6 +1,6 @@
 {
     "name": "houdini-react",
-    "version": "0.19.1",
+    "version": "0.19.2",
     "private": true,
     "description": "The React plugin for houdini",
     "keywords": [

diff --git a/packages/houdini-svelte/CHANGELOG.md b/packages/houdini-svelte/CHANGELOG.md
@@ -1,5 +1,11 @@
 # houdini-svelte
 
+## 0.19.2
+
+### ✨ Features
+
+-   [#786](https://github.com/HoudiniGraphql/houdini/pull/786) [`0437769`](https://github.com/HoudiniGraphql/houdini/commit/043776906a1d7ec19e2e451ed4988614b14678e9) Thanks [@AlecAivazis](https://github.com/AlecAivazis)! - Static plugin config value can now be used to remove session infrastructure from application
+
 ## 0.19.1
 
 ## 0.19.0

diff --git a/packages/houdini-svelte/package.json b/packages/houdini-svelte/package.json
@@ -1,6 +1,6 @@
 {
     "name": "houdini-svelte",
-    "version": "0.19.1",
+    "version": "0.19.2",
     "description": "The svelte plugin for houdini",
     "keywords": [
         "typescript",

diff --git a/packages/houdini-svelte/src/plugin/fsPatch.ts b/packages/houdini-svelte/src/plugin/fsPatch.ts
@@ -1,11 +1,13 @@
 import filesystem, { Dirent, PathLike } from 'fs'
 import { fs, Plugin, path } from 'houdini'
 
+import { _config } from '.'
 import {
 	Framework,
 	is_root_layout,
 	is_root_layout_server,
 	is_route_script,
+	plugin_config,
 	resolve_relative,
 } from './kit'
 
@@ -193,7 +195,11 @@ filesystem.readdirSync = function (
 	}
 	// if we are in looking inside of src/routes and there's no +layout.server.js file
 	// we need to create one
-	if (is_root_route(posix_filepath) && !contains('+layout.server.js', '+layout.server.ts')) {
+	if (
+		is_root_route(posix_filepath) &&
+		!contains('+layout.server.js', '+layout.server.ts') &&
+		!plugin_config(_config).static
+	) {
 		result.push(virtual_file('+layout.server.js', options))
 	}
 

diff --git a/packages/houdini-svelte/src/plugin/index.ts b/packages/houdini-svelte/src/plugin/index.ts
@@ -1,4 +1,4 @@
-import { HoudiniError, PluginFactory, path, fs } from 'houdini'
+import { HoudiniError, PluginFactory, path, fs, type Config } from 'houdini'
 import * as url from 'url'
 import { loadEnv } from 'vite'
 
@@ -18,6 +18,8 @@ import validate from './validate'
 
 let framework: Framework = 'svelte'
 
+export let _config: Config
+
 const HoudiniSveltePlugin: PluginFactory = async () => ({
 	order: 'core',
 
@@ -131,6 +133,7 @@ export const error = svelteKitError
 	 */
 
 	async after_load(cfg) {
+		_config = cfg
 		const cfgPlugin = plugin_config(cfg)
 
 		let client_file_exists = false

diff --git a/packages/houdini/CHANGELOG.md b/packages/houdini/CHANGELOG.md
@@ -1,5 +1,7 @@
 # houdini
 
+## 0.19.2
+
 ## 0.19.1
 
 ### 🐛 Fixes

diff --git a/packages/houdini/package.json b/packages/houdini/package.json
@@ -1,6 +1,6 @@
 {
     "name": "houdini",
-    "version": "0.19.1",
+    "version": "0.19.2",
     "description": "The disappearing GraphQL clients",
     "keywords": [
         "typescript",

diff --git a/packages/houdini/src/codegen/transforms/lists.test.ts b/packages/houdini/src/codegen/transforms/lists.test.ts
@@ -467,7 +467,7 @@ test('cannot use list directive if id is not a valid field', async function () {
 		nbError++
 		// @ts-ignore
 		expect(error[0].description).toMatchInlineSnapshot(
-			'"@list on \\u001b[32mLegend\\u001b[37m\\u001b[0m as a configuration issue. Object identification missing: \\"\\u001b[33mid\\u001b[37m\\u001b[0m\\". Check \'Custom IDs\' if needed."'
+			'"@list on [32mLegend[37m[0m as a configuration issue. Object identification missing: \\"[33mid[37m[0m\\". Check \'Custom IDs\' if needed."'
 		)
 	}
 	expect(nbError).toBe(1)