From 04d98c6bbc3848516bd6187808e27e683177a3da Mon Sep 17 00:00:00 2001 From: Jason Kuhrt Date: Sun, 22 Dec 2024 09:32:23 -0500 Subject: [PATCH] fix(document-builder): strip $ on enum-typed variables (#1288) --- examples/70_type_level/selection-sets.ts | 121 ++++++++++++++ ...tension_headers__dynamicHeaders.output.txt | 2 +- .../20_output/output_envelope.output.txt | 2 +- ...on_opentelemetry__opentelemetry.output.txt | 58 +++---- .../70_type_level/selection-sets.output.txt | 7 + examples/pnpm-lock.yaml | 16 +- package.json | 2 + src/lib/grafaid/request.ts | 25 +++ src/requestPipeline/RequestPipeline.ts | 4 +- .../70_type_level/selection-sets.test.ts | 19 +++ ....timestamp-1734877293576-49f423770518b.mjs | 148 ++++++++++++++++++ .../_snippets/example-links/selection-sets.md | 1 + .../extension/opentelemetry.detail.md | 58 +++---- .../examples/extension/opentelemetry.md | 58 +++---- .../examples/output/envelope.detail.md | 2 +- .../_snippets/examples/output/envelope.md | 2 +- .../transport-http/dynamic-headers.detail.md | 2 +- .../transport-http/dynamic-headers.md | 2 +- .../type_level/selection-sets.detail.md | 145 +++++++++++++++++ .../examples/type_level/selection-sets.md | 142 +++++++++++++++++ .../10_transport-http/dynamic-headers.md | 2 +- .../content/examples/20_output/envelope.md | 2 +- .../examples/60_extension/opentelemetry.md | 58 +++---- .../examples/70_type_level/selection-sets.md | 147 +++++++++++++++++ 24 files changed, 892 insertions(+), 133 deletions(-) create mode 100644 examples/70_type_level/selection-sets.ts create mode 100644 examples/__outputs__/70_type_level/selection-sets.output.txt create mode 100644 tests/examples/70_type_level/selection-sets.test.ts create mode 100644 website/.vitepress/config.ts.timestamp-1734877293576-49f423770518b.mjs create mode 100644 website/content/_snippets/example-links/selection-sets.md create mode 100644 website/content/_snippets/examples/type_level/selection-sets.detail.md create mode 100644 website/content/_snippets/examples/type_level/selection-sets.md create mode 100644 website/content/examples/70_type_level/selection-sets.md diff --git a/examples/70_type_level/selection-sets.ts b/examples/70_type_level/selection-sets.ts new file mode 100644 index 000000000..4f8b116ee --- /dev/null +++ b/examples/70_type_level/selection-sets.ts @@ -0,0 +1,121 @@ +/** + * This example shows how to work with the selection set types generated by Graffle. Selection set types reflect your GraphQL schema. + */ + +import { Graffle } from '../$/graffle/__.js' +import { showJson } from '../$/helpers.js' + +type _ = [ + // + // ======================== + // Primary TypeScript Types + // ======================== + // + // + // 1. GraphQL Types + // -------------- + // The SelectionSets namespace contains a TypeScript type for each GraphQL type. + // + Graffle.SelectionSets.Query, + Graffle.SelectionSets.Mutation, + Graffle.SelectionSets.Battle, + // ... + // + // Each type contains the selection set for that type. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query['trainers'], + Graffle.SelectionSets.Mutation['addPokemon'], + Graffle.SelectionSets.Battle['___on_BattleRoyale'], + + // 2. GraphQL Type Fields + // ------------------- + // Each name is also overloaded with a namespace. Within it, you will find more TypeScript types. + // One per selection set field in the respective GraphQL type. + // + Graffle.SelectionSets.Query.pokemons, + Graffle.SelectionSets.Query.trainers, + Graffle.SelectionSets.Mutation.addPokemon, + // ... + // + // Each GraphQL type field type has properties about the selection set set for that field. + // + Graffle.SelectionSets.Query.pokemons['$'], + Graffle.SelectionSets.Query.trainers['$skip'], + Graffle.SelectionSets.Mutation.addPokemon['id'], + // ... + // + // You may have already noticed but there is a relationship between these two things: + // - The GraphQL Type type properties + // - The GraphQL Type Field types. + // + // Use the kind of type that suites your use case. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query.pokemons, + // + // 3. TypeScript Types for Arguments + // ------------------------------ + // There are type definitions for GraphQL Type Field Arguments + // + Graffle.SelectionSets.Query.pokemons$Arguments, + Graffle.SelectionSets.Query.trainerByName$Arguments, + Graffle.SelectionSets.Mutation.addPokemon$Arguments, + // ... + // + // + // ====================== + // Niche TypeScript Types + // ====================== + // + // + // 4. "Expanded" Variants + // ------------------- + // You will find various type definitions with the suffix `$Expanded`. + // From a type-checking point of view they are identical to their non-expanded form. + // They differ in how they will be displayed in tooling, namely IDEs. + // You can leverage them to improve DX in your use-cases. + // For more details, refer to their JSDoc. + // + Graffle.SelectionSets.Query.pokemons$Expanded, + Graffle.SelectionSets.Mutation.addPokemon$Expanded, + // ... + // + // 5. Inline Fragments + // ---------------- + // + Graffle.SelectionSets.Query$FragmentInline, + Graffle.SelectionSets.Battle$FragmentInline, + // ... + // + // 6. Selection Sets Sans Union with Indicators + // ----------------------------------------- + // If the GraphQL field is a non-scalar OR scalar-with-arguments, then its type will be synonymous + // with its explicit selection set type. For example: + // + Graffle.SelectionSets.Query.beings, + Graffle.SelectionSets.Query.beings$SelectionSet, + // However, if the GraphQL field IS a scalar-without-arguments, then its type will become an + // indicator unioned with the "meta" selection set (meaning stuff like field directives). + // + // Meanwhile, the explicit selection set type will _only_ have those meta things, not the + // indicator. For example: + // + Graffle.SelectionSets.Pokemon.name, + Graffle.SelectionSets.Pokemon.name$SelectionSet, +] + +const graffle = Graffle.create() + +const getPokemonsLike = async (filter: Graffle.SelectionSets.Query.pokemons$Arguments['filter']) => + graffle.query.pokemons({ + $: { filter }, + hp: true, + name: true, + }) + +// todo add test coverage for $ stripping on arguments. +const pokemons = await getPokemonsLike({ $type: `water` }) + +// We don't lose any type safety. :) +showJson(pokemons) diff --git a/examples/__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt b/examples/__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt index c0e9b3fcd..df8a3be32 100644 --- a/examples/__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt +++ b/examples/__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt @@ -4,7 +4,7 @@ headers: Headers { accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8', 'content-type': 'application/json', - 'x-sent-at-time': '1734835236654' + 'x-sent-at-time': '1734877667965' }, method: 'post', url: 'http://localhost:3000/graphql', diff --git a/examples/__outputs__/20_output/output_envelope.output.txt b/examples/__outputs__/20_output/output_envelope.output.txt index dd1d94477..c171e75d8 100644 --- a/examples/__outputs__/20_output/output_envelope.output.txt +++ b/examples/__outputs__/20_output/output_envelope.output.txt @@ -16,7 +16,7 @@ headers: Headers { 'content-type': 'application/graphql-response+json; charset=utf-8', 'content-length': '142', - date: 'Sun, 22 Dec 2024 02:40:37 GMT', + date: 'Sun, 22 Dec 2024 14:27:48 GMT', connection: 'keep-alive', 'keep-alive': 'timeout=5' }, diff --git a/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt b/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt index cad31421c..9a03999da 100644 --- a/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt +++ b/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt @@ -9,14 +9,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'encode', - id: '57064bac33995f52', + id: 'e30897dc9cb51142', kind: 0, - timestamp: 1734835237807000, - duration: 985.375, + timestamp: 1734877668621000, + duration: 1060.917, attributes: {}, status: { code: 0 }, events: [], @@ -33,14 +33,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'pack', - id: '4160ec4bd017e345', + id: '893c1fed7b2256dd', kind: 0, - timestamp: 1734835237808000, - duration: 12389.166, + timestamp: 1734877668623000, + duration: 18450.083, attributes: {}, status: { code: 0 }, events: [], @@ -57,14 +57,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'exchange', - id: 'b605384e7351522a', + id: 'b0c30685f178d075', kind: 0, - timestamp: 1734835237821000, - duration: 21988.041, + timestamp: 1734877668642000, + duration: 25750.5, attributes: {}, status: { code: 0 }, events: [], @@ -81,14 +81,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'unpack', - id: '3dc693f1496eb20f', + id: 'c148fb01cd7693fa', kind: 0, - timestamp: 1734835237844000, - duration: 1031.333, + timestamp: 1734877668668000, + duration: 1080.291, attributes: {}, status: { code: 0 }, events: [], @@ -105,14 +105,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'decode', - id: '41886c6abbbe3566', + id: '634824deddb746e7', kind: 0, - timestamp: 1734835237845000, - duration: 457.25, + timestamp: 1734877668670000, + duration: 516.708, attributes: {}, status: { code: 0 }, events: [], @@ -129,14 +129,14 @@ } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', parentId: undefined, traceState: undefined, name: 'request', - id: '8e35291fef6405ac', + id: '6fcf4ddd316eb7dd', kind: 0, - timestamp: 1734835237806000, - duration: 39409.5, + timestamp: 1734877668621000, + duration: 49549.459, attributes: {}, status: { code: 0 }, events: [], diff --git a/examples/__outputs__/70_type_level/selection-sets.output.txt b/examples/__outputs__/70_type_level/selection-sets.output.txt new file mode 100644 index 000000000..626bdadcd --- /dev/null +++ b/examples/__outputs__/70_type_level/selection-sets.output.txt @@ -0,0 +1,7 @@ +---------------------------------------- SHOW ---------------------------------------- +[ + { + "hp": 44, + "name": "Squirtle" + } +] \ No newline at end of file diff --git a/examples/pnpm-lock.yaml b/examples/pnpm-lock.yaml index ead9521d3..1a64070c1 100644 --- a/examples/pnpm-lock.yaml +++ b/examples/pnpm-lock.yaml @@ -115,8 +115,8 @@ packages: resolution: {integrity: sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==} engines: {node: '>=12'} - chalk@5.3.0: - resolution: {integrity: sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==} + chalk@5.4.1: + resolution: {integrity: sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==} engines: {node: ^12.17.0 || ^14.13 || >=16.0.0} es-toolkit@1.30.1: @@ -181,8 +181,8 @@ packages: ts-toolbelt@9.6.0: resolution: {integrity: sha512-nsZd8ZeNUzukXPlJmTBwUAuABDe/9qtVDelJeT/qW0ow3ZS3BsQJtNkan1802aM9Uf68/Y8ljw86Hu0h5IUW3w==} - type-fest@4.30.1: - resolution: {integrity: sha512-ojFL7eDMX2NF0xMbDwPZJ8sb7ckqtlAi1GsmgsFXvErT9kFTk1r0DuQKvrCh73M6D4nngeHJmvogF9OluXs7Hw==} + type-fest@4.30.2: + resolution: {integrity: sha512-UJShLPYi1aWqCdq9HycOL/gwsuqda1OISdBO3t8RlXQC4QvtuIz4b5FCfe2dQIWEpmlRExKmcTBfP1r9bhY7ig==} engines: {node: '>=16'} typescript@5.7.2: @@ -207,14 +207,14 @@ snapshots: dependencies: '@molt/types': 0.2.0 alge: 0.8.1 - chalk: 5.3.0 + chalk: 5.4.1 lodash.camelcase: 4.3.0 lodash.snakecase: 4.1.1 readline-sync: 1.4.10 string-length: 6.0.0 strip-ansi: 7.1.0 ts-toolbelt: 9.6.0 - type-fest: 4.30.1 + type-fest: 4.30.2 zod: 3.24.1 '@molt/types@0.2.0': @@ -280,7 +280,7 @@ snapshots: ansi-regex@6.1.0: {} - chalk@5.3.0: {} + chalk@5.4.1: {} es-toolkit@1.30.1: {} @@ -321,7 +321,7 @@ snapshots: ts-toolbelt@9.6.0: {} - type-fest@4.30.1: {} + type-fest@4.30.2: {} typescript@5.7.2: {} diff --git a/package.json b/package.json index 4f6992bca..edbc55c97 100644 --- a/package.json +++ b/package.json @@ -92,6 +92,8 @@ "serve:pokemon": "tsx tests/_/services/pokemonManual.ts", "gen:graffle": "pnpm gen:graffle:tests && pnpm build && cd website && pnpm gen:graffle", "gen:graffle:tests": "tsx tests/_/schemas/generate.ts && pnpm graffle --project src/extensions/SchemaErrors/tests/fixture", + "gen:graffle:examples": "pnpm build && cd examples && pnpm i && pnpm gen:graffle", + "examples:link-mode": "cd examples && pnpm add ..", "graffle": "tsx ./src/generator/cli/generate.ts", "gen:examples": "tsx scripts/generate-examples-derivatives/generate.ts && pnpm format", "gen:examples:outputs": "tsx scripts/generate-examples-derivatives/generate.ts --outputs", diff --git a/src/lib/grafaid/request.ts b/src/lib/grafaid/request.ts index c1d1efa5e..d6aa23b26 100644 --- a/src/lib/grafaid/request.ts +++ b/src/lib/grafaid/request.ts @@ -1,3 +1,4 @@ +import { isPlainObject } from 'es-toolkit' import type { GraphQLError, OperationDefinitionNode, OperationTypeNode } from 'graphql' import type { Errors } from '../errors/__.js' import type { Grafaid } from './__.js' @@ -49,6 +50,7 @@ export const normalizeRequestToNode = <$R extends RequestInput | RequestAnalyzed never => { const query = normalizeDocumentToNode(request.query) + // we have to strip the $ from the variables keys (enum types) if (`operation` in request) { const operation = getOperationDefinition({ @@ -68,3 +70,26 @@ export const normalizeRequestToNode = <$R extends RequestInput | RequestAnalyzed query, } as any } + +// todo: refactor into concise visitor pattern. +export const normalizeVariables = (variables?: Variables): Variables => { + return normalizeVariables_(variables) +} + +const normalizeVariables_ = (value: unknown): any => { + if (value === undefined) return undefined + if (value === null) return null + if (typeof value !== `object`) return value + if (Array.isArray(value)) return value.map(normalizeVariables_) + if (!isPlainObject(value)) return value // todo: optimize + + const normalized: Variables = {} + + for (const key in value) { + const normalizedKey = key.replace(/^\$/, ``) + const normalizedValue = normalizeVariables_(value[key]) + normalized[normalizedKey] = normalizedValue + } + + return normalized +} diff --git a/src/requestPipeline/RequestPipeline.ts b/src/requestPipeline/RequestPipeline.ts index 3203caa5a..4d224ae34 100644 --- a/src/requestPipeline/RequestPipeline.ts +++ b/src/requestPipeline/RequestPipeline.ts @@ -3,7 +3,7 @@ import type { GraffleExecutionResultEnvelope } from '../client/handleOutput.js' import { Anyware } from '../lib/anyware/__.js' import type { Config } from '../lib/anyware/PipelineDef/Config.js' import type { Grafaid } from '../lib/grafaid/__.js' -import { normalizeRequestToNode } from '../lib/grafaid/request.js' +import { normalizeRequestToNode, normalizeVariables } from '../lib/grafaid/request.js' import { isAbortError } from '../lib/prelude.js' import type { Context } from '../types/context.js' import { decodeResultData } from './CustomScalars/decode.js' @@ -90,8 +90,10 @@ export const requestPipelineBaseDefinition: RequestPipelineBaseDefinition = Anyw input.request.query = request.query encodeRequestVariables({ sddm, scalars, request }) + // input.request.variables = request.variables // enum $ stripping } + input.request.variables = normalizeVariables(input.request.variables) return input }, }) diff --git a/tests/examples/70_type_level/selection-sets.test.ts b/tests/examples/70_type_level/selection-sets.test.ts new file mode 100644 index 000000000..8309ff38c --- /dev/null +++ b/tests/examples/70_type_level/selection-sets.test.ts @@ -0,0 +1,19 @@ +// @vitest-environment node + +// WARNING: +// This test is generated by scripts/generate-example-derivatives/generate.ts +// Do not modify this file directly. + +import { expect, test } from 'vitest' +import { runExample } from '../../../scripts/generate-examples-derivatives/helpers.js' + +test(`selection-sets`, async () => { + const exampleResult = await runExample(`./examples/70_type_level/selection-sets.ts`) + // Examples should output their data results. + const exampleResultMaybeEncoded = exampleResult + // If ever outputs vary by Node version, you can use this to snapshot by Node version. + // const nodeMajor = process.version.match(/v(\d+)/)?.[1] ?? `unknown` + await expect(exampleResultMaybeEncoded).toMatchFileSnapshot( + `../../../examples/__outputs__/70_type_level/selection-sets.output.txt`, + ) +}) diff --git a/website/.vitepress/config.ts.timestamp-1734877293576-49f423770518b.mjs b/website/.vitepress/config.ts.timestamp-1734877293576-49f423770518b.mjs new file mode 100644 index 000000000..de33e77c0 --- /dev/null +++ b/website/.vitepress/config.ts.timestamp-1734877293576-49f423770518b.mjs @@ -0,0 +1,148 @@ +// .vitepress/config.ts +import { createFileSystemTypesCache } from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/@shikijs+vitepress-twoslash@1.24.4_typescript@5.7.2/node_modules/@shikijs/vitepress-twoslash/dist/cache-fs.mjs' +import { transformerTwoslash } from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/@shikijs+vitepress-twoslash@1.24.4_typescript@5.7.2/node_modules/@shikijs/vitepress-twoslash/dist/index.mjs' +import { + ModuleKind, + ModuleResolutionKind, +} from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/typescript.js' +import { tabsMarkdownPlugin } from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/vitepress-plugin-tabs@0.5.0_vitepress@1.5.0_@algolia+client-search@5.18.0_postcss@8.4.49_sear_sjxfchr23nu2ftbpbwru3ytjyy/node_modules/vitepress-plugin-tabs/dist/index.js' +import { generateSidebar } from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/vitepress-sidebar@1.30.2/node_modules/vitepress-sidebar/dist/index.js' +import { defineConfig } from 'file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/node_modules/.pnpm/vitepress@1.5.0_@algolia+client-search@5.18.0_postcss@8.4.49_search-insights@2.17.3_typescript@5.7.2/node_modules/vitepress/dist/node/index.js' +var prefixPattern = /\d+_/g +var sidebarMultiVisitItems = (sidebarMulti, visitor) => { + Object.values(sidebarMulti).forEach((sidebar) => sidebar.items.forEach((_) => sidebarItemVisitItems(_, visitor))) + return sidebarMulti +} +var sidebarItemVisitItems = (sidebarItem, visitor) => { + visitor(sidebarItem) + sidebarItem.items?.forEach((_) => sidebarItemVisitItems(_, visitor)) +} +var fixLinks = (sidebarMulti) => { + return sidebarMultiVisitItems(sidebarMulti, (sidebarItem) => { + sidebarItem.link = sidebarItem.link?.replaceAll(prefixPattern, '') + }) +} +var sidebars = fixLinks(generateSidebar([ + { + scanStartPath: 'content/guides', + resolvePath: '/guides/', + prefixSeparator: '_', + removePrefixAfterOrdering: true, + useTitleFromFrontmatter: true, + useTitleFromFileHeading: true, + hyphenToSpace: true, + capitalizeEachWords: true, + keepMarkdownSyntaxFromTitle: true, + }, + { + hyphenToSpace: true, + capitalizeEachWords: true, + scanStartPath: 'content/examples', + resolvePath: '/examples/', + prefixSeparator: '_', + removePrefixAfterOrdering: true, + useTitleFromFrontmatter: true, + useTitleFromFileHeading: true, + keepMarkdownSyntaxFromTitle: true, + }, + { + hyphenToSpace: true, + capitalizeEachWords: true, + scanStartPath: 'content/extensions', + resolvePath: '/extensions/', + prefixSeparator: '_', + removePrefixAfterOrdering: true, + useTitleFromFrontmatter: true, + useTitleFromFileHeading: true, + keepMarkdownSyntaxFromTitle: true, + }, +])) +sidebars['/examples/'].items.find((_) => _.text === 'About').items.unshift({ text: 'Introduction', link: '/' }) +sidebars['/guides/'].items.unshift({ text: 'Introduction', link: '/' }) +var rootItems = sidebars['/guides/'].items.filter((_) => !_.items) +sidebars['/guides/'].items = sidebars['/guides/'].items.filter((_) => _.items && _.items.length > 0) +sidebars['/guides/'].items.unshift(...rootItems) +var config_default = defineConfig({ + rewrites: (path) => { + const newPath = path.replaceAll(prefixPattern, '') + return newPath + }, + title: 'Graffle', + description: 'Minimalist Progressively Type Safe GraphQL Client For JavaScript.', + cleanUrls: true, + // TODO, remove before going live. + ignoreDeadLinks: true, + sitemap: { + hostname: 'https://graffle.js.org', + }, + head: [ + // + ['script', { + defer: 'true', + 'data-domain': 'graffle.js.org', + src: 'https://plausible.io/js/script.js', + }], + ], + markdown: { + config(md) { + md.use(tabsMarkdownPlugin) + }, + codeTransformers: [ + ...process.env.disable_twoslash ? [] : [ + transformerTwoslash({ + typesCache: createFileSystemTypesCache({ + dir: './.vitepress/cache/types', + }), + twoslashOptions: { + handbookOptions: { + // noErrors: true, + // noErrorValidation: process.env.NODE_ENV !== 'development', + }, + compilerOptions: { + moduleResolution: ModuleResolutionKind.Bundler, + module: ModuleKind.ESNext, + // noErrorTruncation: true, + }, + shouldGetHoverInfo: (x, b, c) => { + const ignoreIdentifiers = ['console', 'log'] + return !ignoreIdentifiers.includes(x) + }, + }, + }), + ], + ], + }, + srcDir: './content', + themeConfig: { + footer: { + message: 'Released under the MIT License.', + copyright: 'Copyright \xA9 2024-present Jason Kuhrt', + }, + // @see https://github.com/vuejs/vitepress/issues/4141 + logo: { + light: '/_assets/logo-dark.svg', + dark: '/_assets/logo-light.svg', + }, + search: { + provider: 'local', + }, + docFooter: { + next: false, + prev: false, + }, + aside: 'left', + nav: [ + { text: 'Guides', link: '/guides' }, + { text: 'Examples', link: '/examples' }, + { text: 'Extensions', link: '/extensions' }, + ], + sidebar: { + ...sidebars, + }, + socialLinks: [ + { icon: 'github', link: 'https://github.com/graffle-js/graffle' }, + ], + }, +}) +export { config_default as default } +// # sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": [".vitepress/config.ts"],
  "sourcesContent": ["const __vite_injected_original_dirname = \"/Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/.vitepress\";const __vite_injected_original_filename = \"/Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/.vitepress/config.ts\";const __vite_injected_original_import_meta_url = \"file:///Users/jasonkuhrt/projects/jasonkuhrt/graffle/website/.vitepress/config.ts\";import { transformerTwoslash } from '@shikijs/vitepress-twoslash'\nimport { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'\nimport { ModuleKind, ModuleResolutionKind } from 'typescript'\nimport { defineConfig } from 'vitepress'\nimport { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'\nimport { generateSidebar } from 'vitepress-sidebar'\nimport { SidebarItem, SidebarMulti } from 'vitepress-sidebar/types'\n\nconst prefixPattern = /\\d+_/g\n\nconst sidebarMultiVisitItems = (sidebarMulti: SidebarMulti, visitor: (sidebarItem: SidebarItem) => void) => {\n  Object.values(sidebarMulti).forEach(sidebar => sidebar.items.forEach(_ => sidebarItemVisitItems(_, visitor)))\n  return sidebarMulti\n}\n\nconst sidebarItemVisitItems = (sidebarItem: SidebarItem, visitor: (sidebarItem: SidebarItem) => void) => {\n  visitor(sidebarItem)\n  sidebarItem.items?.forEach(_ => sidebarItemVisitItems(_, visitor))\n}\n\nconst fixLinks = (sidebarMulti: SidebarMulti) => {\n  return sidebarMultiVisitItems(sidebarMulti, (sidebarItem) => {\n    sidebarItem.link = sidebarItem.link?.replaceAll(prefixPattern, '')\n  })\n}\n\n/**\n * @see https://vitepress-sidebar.cdget.com/guide/api\n */\nconst sidebars = fixLinks(generateSidebar([\n  {\n    scanStartPath: 'content/guides',\n    resolvePath: '/guides/',\n    prefixSeparator: '_',\n    removePrefixAfterOrdering: true,\n    useTitleFromFrontmatter: true,\n    useTitleFromFileHeading: true,\n    hyphenToSpace: true,\n    capitalizeEachWords: true,\n    keepMarkdownSyntaxFromTitle: true,\n  },\n  {\n    hyphenToSpace: true,\n    capitalizeEachWords: true,\n    scanStartPath: 'content/examples',\n    resolvePath: '/examples/',\n    prefixSeparator: '_',\n    removePrefixAfterOrdering: true,\n    useTitleFromFrontmatter: true,\n    useTitleFromFileHeading: true,\n    keepMarkdownSyntaxFromTitle: true,\n  },\n  {\n    hyphenToSpace: true,\n    capitalizeEachWords: true,\n    scanStartPath: 'content/extensions',\n    resolvePath: '/extensions/',\n    prefixSeparator: '_',\n    removePrefixAfterOrdering: true,\n    useTitleFromFrontmatter: true,\n    useTitleFromFileHeading: true,\n    keepMarkdownSyntaxFromTitle: true,\n  },\n]) as SidebarMulti)\n\nsidebars['/examples/'].items.find(_ => _.text === 'About')!.items!.unshift({ text: 'Introduction', link: '/' })\nsidebars['/guides/'].items.unshift({ text: 'Introduction', link: '/' })\n\nconst rootItems = sidebars['/guides/'].items.filter(_ => !_.items)\n\nsidebars['/guides/'].items = sidebars['/guides/'].items.filter(_ => _.items && _.items.length > 0)\nsidebars['/guides/'].items.unshift(...rootItems)\n\n// https://vitepress.dev/reference/site-config\nexport default defineConfig({\n  rewrites: (path) => {\n    const newPath = path.replaceAll(prefixPattern, '')\n    return newPath\n  },\n  title: 'Graffle',\n  description: 'Minimalist Progressively Type Safe GraphQL Client For JavaScript.',\n  cleanUrls: true,\n  // TODO, remove before going live.\n  ignoreDeadLinks: true,\n  sitemap: {\n    hostname: 'https://graffle.js.org',\n  },\n  head: [\n    // <script defer data-domain=\"graffle.js.org\" src=\"https://plausible.io/js/script.js\"></script>\n    ['script', {\n      defer: 'true',\n      'data-domain': 'graffle.js.org',\n      src: 'https://plausible.io/js/script.js',\n    }],\n  ],\n  markdown: {\n    config(md) {\n      md.use(tabsMarkdownPlugin)\n    },\n    codeTransformers: [\n      ...(process.env.disable_twoslash ? [] : [\n        transformerTwoslash({\n          typesCache: createFileSystemTypesCache({\n            dir: './.vitepress/cache/types',\n          }),\n          twoslashOptions: {\n            handbookOptions: {\n              // noErrors: true,\n              // noErrorValidation: process.env.NODE_ENV !== 'development',\n            },\n            compilerOptions: {\n              moduleResolution: ModuleResolutionKind.Bundler,\n              module: ModuleKind.ESNext,\n              // noErrorTruncation: true,\n            },\n            shouldGetHoverInfo: (x, b, c) => {\n              const ignoreIdentifiers = ['console', 'log']\n              return !ignoreIdentifiers.includes(x)\n            },\n          },\n        }),\n      ]) as any,\n    ],\n  },\n  srcDir: './content',\n  themeConfig: {\n    footer: {\n      message: 'Released under the MIT License.',\n      copyright: 'Copyright \u00A9 2024-present Jason Kuhrt',\n    },\n    // @see https://github.com/vuejs/vitepress/issues/4141\n    logo: {\n      light: '/_assets/logo-dark.svg',\n      dark: '/_assets/logo-light.svg',\n    },\n    search: {\n      provider: 'local',\n    },\n    docFooter: {\n      next: false,\n      prev: false,\n    },\n    aside: 'left',\n    nav: [\n      { text: 'Guides', link: '/guides' },\n      { text: 'Examples', link: '/examples' },\n      { text: 'Extensions', link: '/extensions' },\n    ],\n    sidebar: {\n      ...sidebars,\n    },\n    socialLinks: [\n      { icon: 'github', link: 'https://github.com/graffle-js/graffle' },\n    ],\n  },\n})\n"],
  "mappings": ";AAAwW,SAAS,2BAA2B;AAC5Y,SAAS,kCAAkC;AAC3C,SAAS,YAAY,4BAA4B;AACjD,SAAS,oBAAoB;AAC7B,SAAS,0BAA0B;AACnC,SAAS,uBAAuB;AAGhC,IAAM,gBAAgB;AAEtB,IAAM,yBAAyB,CAAC,cAA4B,YAAgD;AAC1G,SAAO,OAAO,YAAY,EAAE,QAAQ,aAAW,QAAQ,MAAM,QAAQ,OAAK,sBAAsB,GAAG,OAAO,CAAC,CAAC;AAC5G,SAAO;AACT;AAEA,IAAM,wBAAwB,CAAC,aAA0B,YAAgD;AACvG,UAAQ,WAAW;AACnB,cAAY,OAAO,QAAQ,OAAK,sBAAsB,GAAG,OAAO,CAAC;AACnE;AAEA,IAAM,WAAW,CAAC,iBAA+B;AAC/C,SAAO,uBAAuB,cAAc,CAAC,gBAAgB;AAC3D,gBAAY,OAAO,YAAY,MAAM,WAAW,eAAe,EAAE;AAAA,EACnE,CAAC;AACH;AAKA,IAAM,WAAW,SAAS,gBAAgB;AAAA,EACxC;AAAA,IACE,eAAe;AAAA,IACf,aAAa;AAAA,IACb,iBAAiB;AAAA,IACjB,2BAA2B;AAAA,IAC3B,yBAAyB;AAAA,IACzB,yBAAyB;AAAA,IACzB,eAAe;AAAA,IACf,qBAAqB;AAAA,IACrB,6BAA6B;AAAA,EAC/B;AAAA,EACA;AAAA,IACE,eAAe;AAAA,IACf,qBAAqB;AAAA,IACrB,eAAe;AAAA,IACf,aAAa;AAAA,IACb,iBAAiB;AAAA,IACjB,2BAA2B;AAAA,IAC3B,yBAAyB;AAAA,IACzB,yBAAyB;AAAA,IACzB,6BAA6B;AAAA,EAC/B;AAAA,EACA;AAAA,IACE,eAAe;AAAA,IACf,qBAAqB;AAAA,IACrB,eAAe;AAAA,IACf,aAAa;AAAA,IACb,iBAAiB;AAAA,IACjB,2BAA2B;AAAA,IAC3B,yBAAyB;AAAA,IACzB,yBAAyB;AAAA,IACzB,6BAA6B;AAAA,EAC/B;AACF,CAAC,CAAiB;AAElB,SAAS,YAAY,EAAE,MAAM,KAAK,OAAK,EAAE,SAAS,OAAO,EAAG,MAAO,QAAQ,EAAE,MAAM,gBAAgB,MAAM,IAAI,CAAC;AAC9G,SAAS,UAAU,EAAE,MAAM,QAAQ,EAAE,MAAM,gBAAgB,MAAM,IAAI,CAAC;AAEtE,IAAM,YAAY,SAAS,UAAU,EAAE,MAAM,OAAO,OAAK,CAAC,EAAE,KAAK;AAEjE,SAAS,UAAU,EAAE,QAAQ,SAAS,UAAU,EAAE,MAAM,OAAO,OAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACjG,SAAS,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS;AAG/C,IAAO,iBAAQ,aAAa;AAAA,EAC1B,UAAU,CAAC,SAAS;AAClB,UAAM,UAAU,KAAK,WAAW,eAAe,EAAE;AACjD,WAAO;AAAA,EACT;AAAA,EACA,OAAO;AAAA,EACP,aAAa;AAAA,EACb,WAAW;AAAA;AAAA,EAEX,iBAAiB;AAAA,EACjB,SAAS;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,MAAM;AAAA;AAAA,IAEJ,CAAC,UAAU;AAAA,MACT,OAAO;AAAA,MACP,eAAe;AAAA,MACf,KAAK;AAAA,IACP,CAAC;AAAA,EACH;AAAA,EACA,UAAU;AAAA,IACR,OAAO,IAAI;AACT,SAAG,IAAI,kBAAkB;AAAA,IAC3B;AAAA,IACA,kBAAkB;AAAA,MAChB,GAAI,QAAQ,IAAI,mBAAmB,CAAC,IAAI;AAAA,QACtC,oBAAoB;AAAA,UAClB,YAAY,2BAA2B;AAAA,YACrC,KAAK;AAAA,UACP,CAAC;AAAA,UACD,iBAAiB;AAAA,YACf,iBAAiB;AAAA;AAAA;AAAA,YAGjB;AAAA,YACA,iBAAiB;AAAA,cACf,kBAAkB,qBAAqB;AAAA,cACvC,QAAQ,WAAW;AAAA;AAAA,YAErB;AAAA,YACA,oBAAoB,CAAC,GAAG,GAAG,MAAM;AAC/B,oBAAM,oBAAoB,CAAC,WAAW,KAAK;AAC3C,qBAAO,CAAC,kBAAkB,SAAS,CAAC;AAAA,YACtC;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EACA,QAAQ;AAAA,EACR,aAAa;AAAA,IACX,QAAQ;AAAA,MACN,SAAS;AAAA,MACT,WAAW;AAAA,IACb;AAAA;AAAA,IAEA,MAAM;AAAA,MACJ,OAAO;AAAA,MACP,MAAM;AAAA,IACR;AAAA,IACA,QAAQ;AAAA,MACN,UAAU;AAAA,IACZ;AAAA,IACA,WAAW;AAAA,MACT,MAAM;AAAA,MACN,MAAM;AAAA,IACR;AAAA,IACA,OAAO;AAAA,IACP,KAAK;AAAA,MACH,EAAE,MAAM,UAAU,MAAM,UAAU;AAAA,MAClC,EAAE,MAAM,YAAY,MAAM,YAAY;AAAA,MACtC,EAAE,MAAM,cAAc,MAAM,cAAc;AAAA,IAC5C;AAAA,IACA,SAAS;AAAA,MACP,GAAG;AAAA,IACL;AAAA,IACA,aAAa;AAAA,MACX,EAAE,MAAM,UAAU,MAAM,wCAAwC;AAAA,IAClE;AAAA,EACF;AACF,CAAC;",
  "names": []
}
 diff --git a/website/content/_snippets/example-links/selection-sets.md b/website/content/_snippets/example-links/selection-sets.md new file mode 100644 index 000000000..8b80ca4b6 --- /dev/null +++ b/website/content/_snippets/example-links/selection-sets.md @@ -0,0 +1 @@ +

Examples -> Selection Sets

diff --git a/website/content/_snippets/examples/extension/opentelemetry.detail.md b/website/content/_snippets/examples/extension/opentelemetry.detail.md index 008f20a8d..ec3b28770 100644 --- a/website/content/_snippets/examples/extension/opentelemetry.detail.md +++ b/website/content/_snippets/examples/extension/opentelemetry.detail.md @@ -43,14 +43,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'encode', - id: '57064bac33995f52', + id: 'e30897dc9cb51142', kind: 0, - timestamp: 1734835237807000, - duration: 985.375, + timestamp: 1734877668621000, + duration: 1060.917, attributes: {}, status: { code: 0 }, events: [], @@ -70,14 +70,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'pack', - id: '4160ec4bd017e345', + id: '893c1fed7b2256dd', kind: 0, - timestamp: 1734835237808000, - duration: 12389.166, + timestamp: 1734877668623000, + duration: 18450.083, attributes: {}, status: { code: 0 }, events: [], @@ -97,14 +97,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'exchange', - id: 'b605384e7351522a', + id: 'b0c30685f178d075', kind: 0, - timestamp: 1734835237821000, - duration: 21988.041, + timestamp: 1734877668642000, + duration: 25750.5, attributes: {}, status: { code: 0 }, events: [], @@ -124,14 +124,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'unpack', - id: '3dc693f1496eb20f', + id: 'c148fb01cd7693fa', kind: 0, - timestamp: 1734835237844000, - duration: 1031.333, + timestamp: 1734877668668000, + duration: 1080.291, attributes: {}, status: { code: 0 }, events: [], @@ -151,14 +151,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'decode', - id: '41886c6abbbe3566', + id: '634824deddb746e7', kind: 0, - timestamp: 1734835237845000, - duration: 457.25, + timestamp: 1734877668670000, + duration: 516.708, attributes: {}, status: { code: 0 }, events: [], @@ -178,14 +178,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', parentId: undefined, traceState: undefined, name: 'request', - id: '8e35291fef6405ac', + id: '6fcf4ddd316eb7dd', kind: 0, - timestamp: 1734835237806000, - duration: 39409.5, + timestamp: 1734877668621000, + duration: 49549.459, attributes: {}, status: { code: 0 }, events: [], diff --git a/website/content/_snippets/examples/extension/opentelemetry.md b/website/content/_snippets/examples/extension/opentelemetry.md index 9da3ea31d..834df7c2f 100644 --- a/website/content/_snippets/examples/extension/opentelemetry.md +++ b/website/content/_snippets/examples/extension/opentelemetry.md @@ -41,14 +41,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'encode', - id: '57064bac33995f52', + id: 'e30897dc9cb51142', kind: 0, - timestamp: 1734835237807000, - duration: 985.375, + timestamp: 1734877668621000, + duration: 1060.917, attributes: {}, status: { code: 0 }, events: [], @@ -68,14 +68,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'pack', - id: '4160ec4bd017e345', + id: '893c1fed7b2256dd', kind: 0, - timestamp: 1734835237808000, - duration: 12389.166, + timestamp: 1734877668623000, + duration: 18450.083, attributes: {}, status: { code: 0 }, events: [], @@ -95,14 +95,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'exchange', - id: 'b605384e7351522a', + id: 'b0c30685f178d075', kind: 0, - timestamp: 1734835237821000, - duration: 21988.041, + timestamp: 1734877668642000, + duration: 25750.5, attributes: {}, status: { code: 0 }, events: [], @@ -122,14 +122,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'unpack', - id: '3dc693f1496eb20f', + id: 'c148fb01cd7693fa', kind: 0, - timestamp: 1734835237844000, - duration: 1031.333, + timestamp: 1734877668668000, + duration: 1080.291, attributes: {}, status: { code: 0 }, events: [], @@ -149,14 +149,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'decode', - id: '41886c6abbbe3566', + id: '634824deddb746e7', kind: 0, - timestamp: 1734835237845000, - duration: 457.25, + timestamp: 1734877668670000, + duration: 516.708, attributes: {}, status: { code: 0 }, events: [], @@ -176,14 +176,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', parentId: undefined, traceState: undefined, name: 'request', - id: '8e35291fef6405ac', + id: '6fcf4ddd316eb7dd', kind: 0, - timestamp: 1734835237806000, - duration: 39409.5, + timestamp: 1734877668621000, + duration: 49549.459, attributes: {}, status: { code: 0 }, events: [], diff --git a/website/content/_snippets/examples/output/envelope.detail.md b/website/content/_snippets/examples/output/envelope.detail.md index f5074eecf..413819c8e 100644 --- a/website/content/_snippets/examples/output/envelope.detail.md +++ b/website/content/_snippets/examples/output/envelope.detail.md @@ -44,7 +44,7 @@ console.log(result) headers: Headers { 'content-type': 'application/graphql-response+json; charset=utf-8', 'content-length': '142', - date: 'Sun, 22 Dec 2024 02:40:37 GMT', + date: 'Sun, 22 Dec 2024 14:27:48 GMT', connection: 'keep-alive', 'keep-alive': 'timeout=5' }, diff --git a/website/content/_snippets/examples/output/envelope.md b/website/content/_snippets/examples/output/envelope.md index 4f1fe975c..2e05163a5 100644 --- a/website/content/_snippets/examples/output/envelope.md +++ b/website/content/_snippets/examples/output/envelope.md @@ -42,7 +42,7 @@ console.log(result) headers: Headers { 'content-type': 'application/graphql-response+json; charset=utf-8', 'content-length': '142', - date: 'Sun, 22 Dec 2024 02:40:37 GMT', + date: 'Sun, 22 Dec 2024 14:27:48 GMT', connection: 'keep-alive', 'keep-alive': 'timeout=5' }, diff --git a/website/content/_snippets/examples/transport-http/dynamic-headers.detail.md b/website/content/_snippets/examples/transport-http/dynamic-headers.detail.md index d968a1d24..45c189ed8 100644 --- a/website/content/_snippets/examples/transport-http/dynamic-headers.detail.md +++ b/website/content/_snippets/examples/transport-http/dynamic-headers.detail.md @@ -46,7 +46,7 @@ await graffle.gql`{ pokemons { name } }`.send() headers: Headers { accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8', 'content-type': 'application/json', - 'x-sent-at-time': '1734835236654' + 'x-sent-at-time': '1734877667965' }, method: 'post', url: 'http://localhost:3000/graphql', diff --git a/website/content/_snippets/examples/transport-http/dynamic-headers.md b/website/content/_snippets/examples/transport-http/dynamic-headers.md index 97b773d14..77cbf4c39 100644 --- a/website/content/_snippets/examples/transport-http/dynamic-headers.md +++ b/website/content/_snippets/examples/transport-http/dynamic-headers.md @@ -44,7 +44,7 @@ await graffle.gql`{ pokemons { name } }`.send() headers: Headers { accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8', 'content-type': 'application/json', - 'x-sent-at-time': '1734835236654' + 'x-sent-at-time': '1734877667965' }, method: 'post', url: 'http://localhost:3000/graphql', diff --git a/website/content/_snippets/examples/type_level/selection-sets.detail.md b/website/content/_snippets/examples/type_level/selection-sets.detail.md new file mode 100644 index 000000000..ed6ba6d8f --- /dev/null +++ b/website/content/_snippets/examples/type_level/selection-sets.detail.md @@ -0,0 +1,145 @@ +::: details Example + +
+Selection Sets + + +```ts twoslash +// Our website uses Vitepress+Twoslash. Twoslash does not discover the generated Graffle modules. +// Perhaps we can configure Twoslash to include them. Until we figure that out, we have to +// explicitly import them like this. +import './graffle/modules/global.js' +// ---cut--- + +import { Graffle } from './graffle/__.js' + +type _ = [ + // + // ======================== + // Primary TypeScript Types + // ======================== + // + // + // 1. GraphQL Types + // -------------- + // The SelectionSets namespace contains a TypeScript type for each GraphQL type. + // + Graffle.SelectionSets.Query, + Graffle.SelectionSets.Mutation, + Graffle.SelectionSets.Battle, + // ... + // + // Each type contains the selection set for that type. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query['trainers'], + Graffle.SelectionSets.Mutation['addPokemon'], + Graffle.SelectionSets.Battle['___on_BattleRoyale'], + + // 2. GraphQL Type Fields + // ------------------- + // Each name is also overloaded with a namespace. Within it, you will find more TypeScript types. + // One per selection set field in the respective GraphQL type. + // + Graffle.SelectionSets.Query.pokemons, + Graffle.SelectionSets.Query.trainers, + Graffle.SelectionSets.Mutation.addPokemon, + // ... + // + // Each GraphQL type field type has properties about the selection set set for that field. + // + Graffle.SelectionSets.Query.pokemons['$'], + Graffle.SelectionSets.Query.trainers['$skip'], + Graffle.SelectionSets.Mutation.addPokemon['id'], + // ... + // + // You may have already noticed but there is a relationship between these two things: + // - The GraphQL Type type properties + // - The GraphQL Type Field types. + // + // Use the kind of type that suites your use case. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query.pokemons, + // + // 3. TypeScript Types for Arguments + // ------------------------------ + // There are type definitions for GraphQL Type Field Arguments + // + Graffle.SelectionSets.Query.pokemons$Arguments, + Graffle.SelectionSets.Query.trainerByName$Arguments, + Graffle.SelectionSets.Mutation.addPokemon$Arguments, + // ... + // + // + // ====================== + // Niche TypeScript Types + // ====================== + // + // + // 4. "Expanded" Variants + // ------------------- + // You will find various type definitions with the suffix `$Expanded`. + // From a type-checking point of view they are identical to their non-expanded form. + // They differ in how they will be displayed in tooling, namely IDEs. + // You can leverage them to improve DX in your use-cases. + // For more details, refer to their JSDoc. + // + Graffle.SelectionSets.Query.pokemons$Expanded, + Graffle.SelectionSets.Mutation.addPokemon$Expanded, + // ... + // + // 5. Inline Fragments + // ---------------- + // + Graffle.SelectionSets.Query$FragmentInline, + Graffle.SelectionSets.Battle$FragmentInline, + // ... + // + // 6. Selection Sets Sans Union with Indicators + // ----------------------------------------- + // If the GraphQL field is a non-scalar OR scalar-with-arguments, then its type will be synonymous + // with its explicit selection set type. For example: + // + Graffle.SelectionSets.Query.beings, + Graffle.SelectionSets.Query.beings$SelectionSet, + // However, if the GraphQL field IS a scalar-without-arguments, then its type will become an + // indicator unioned with the "meta" selection set (meaning stuff like field directives). + // + // Meanwhile, the explicit selection set type will _only_ have those meta things, not the + // indicator. For example: + // + Graffle.SelectionSets.Pokemon.name, + Graffle.SelectionSets.Pokemon.name$SelectionSet, +] + +const graffle = Graffle.create() + +const getPokemonsLike = async (filter: Graffle.SelectionSets.Query.pokemons$Arguments['filter']) => + graffle.query.pokemons({ + $: { filter }, + hp: true, + name: true, + }) + +// todo add test coverage for $ stripping on arguments. +const pokemons = await getPokemonsLike({ $type: `water` }) + +// We don't lose any type safety. :) +console.log(pokemons) +``` + + + +```json +[ + { + "hp": 44, + "name": "Squirtle" + } +] +``` + + +
+::: diff --git a/website/content/_snippets/examples/type_level/selection-sets.md b/website/content/_snippets/examples/type_level/selection-sets.md new file mode 100644 index 000000000..d19a5c2e2 --- /dev/null +++ b/website/content/_snippets/examples/type_level/selection-sets.md @@ -0,0 +1,142 @@ +
+Selection Sets + + +```ts twoslash +// Our website uses Vitepress+Twoslash. Twoslash does not discover the generated Graffle modules. +// Perhaps we can configure Twoslash to include them. Until we figure that out, we have to +// explicitly import them like this. +import './graffle/modules/global.js' +// ---cut--- + +import { Graffle } from './graffle/__.js' + +type _ = [ + // + // ======================== + // Primary TypeScript Types + // ======================== + // + // + // 1. GraphQL Types + // -------------- + // The SelectionSets namespace contains a TypeScript type for each GraphQL type. + // + Graffle.SelectionSets.Query, + Graffle.SelectionSets.Mutation, + Graffle.SelectionSets.Battle, + // ... + // + // Each type contains the selection set for that type. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query['trainers'], + Graffle.SelectionSets.Mutation['addPokemon'], + Graffle.SelectionSets.Battle['___on_BattleRoyale'], + + // 2. GraphQL Type Fields + // ------------------- + // Each name is also overloaded with a namespace. Within it, you will find more TypeScript types. + // One per selection set field in the respective GraphQL type. + // + Graffle.SelectionSets.Query.pokemons, + Graffle.SelectionSets.Query.trainers, + Graffle.SelectionSets.Mutation.addPokemon, + // ... + // + // Each GraphQL type field type has properties about the selection set set for that field. + // + Graffle.SelectionSets.Query.pokemons['$'], + Graffle.SelectionSets.Query.trainers['$skip'], + Graffle.SelectionSets.Mutation.addPokemon['id'], + // ... + // + // You may have already noticed but there is a relationship between these two things: + // - The GraphQL Type type properties + // - The GraphQL Type Field types. + // + // Use the kind of type that suites your use case. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query.pokemons, + // + // 3. TypeScript Types for Arguments + // ------------------------------ + // There are type definitions for GraphQL Type Field Arguments + // + Graffle.SelectionSets.Query.pokemons$Arguments, + Graffle.SelectionSets.Query.trainerByName$Arguments, + Graffle.SelectionSets.Mutation.addPokemon$Arguments, + // ... + // + // + // ====================== + // Niche TypeScript Types + // ====================== + // + // + // 4. "Expanded" Variants + // ------------------- + // You will find various type definitions with the suffix `$Expanded`. + // From a type-checking point of view they are identical to their non-expanded form. + // They differ in how they will be displayed in tooling, namely IDEs. + // You can leverage them to improve DX in your use-cases. + // For more details, refer to their JSDoc. + // + Graffle.SelectionSets.Query.pokemons$Expanded, + Graffle.SelectionSets.Mutation.addPokemon$Expanded, + // ... + // + // 5. Inline Fragments + // ---------------- + // + Graffle.SelectionSets.Query$FragmentInline, + Graffle.SelectionSets.Battle$FragmentInline, + // ... + // + // 6. Selection Sets Sans Union with Indicators + // ----------------------------------------- + // If the GraphQL field is a non-scalar OR scalar-with-arguments, then its type will be synonymous + // with its explicit selection set type. For example: + // + Graffle.SelectionSets.Query.beings, + Graffle.SelectionSets.Query.beings$SelectionSet, + // However, if the GraphQL field IS a scalar-without-arguments, then its type will become an + // indicator unioned with the "meta" selection set (meaning stuff like field directives). + // + // Meanwhile, the explicit selection set type will _only_ have those meta things, not the + // indicator. For example: + // + Graffle.SelectionSets.Pokemon.name, + Graffle.SelectionSets.Pokemon.name$SelectionSet, +] + +const graffle = Graffle.create() + +const getPokemonsLike = async (filter: Graffle.SelectionSets.Query.pokemons$Arguments['filter']) => + graffle.query.pokemons({ + $: { filter }, + hp: true, + name: true, + }) + +// todo add test coverage for $ stripping on arguments. +const pokemons = await getPokemonsLike({ $type: `water` }) + +// We don't lose any type safety. :) +console.log(pokemons) +``` + + + +```json +[ + { + "hp": 44, + "name": "Squirtle" + } +] +``` + + +
diff --git a/website/content/examples/10_transport-http/dynamic-headers.md b/website/content/examples/10_transport-http/dynamic-headers.md index bfdb6aaf6..2defe7d32 100644 --- a/website/content/examples/10_transport-http/dynamic-headers.md +++ b/website/content/examples/10_transport-http/dynamic-headers.md @@ -51,7 +51,7 @@ await graffle.gql`{ pokemons { name } }`.send() headers: Headers { accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8', 'content-type': 'application/json', - 'x-sent-at-time': '1734835236654' + 'x-sent-at-time': '1734877667965' }, method: 'post', url: 'http://localhost:3000/graphql', diff --git a/website/content/examples/20_output/envelope.md b/website/content/examples/20_output/envelope.md index a210d1a63..73c21f661 100644 --- a/website/content/examples/20_output/envelope.md +++ b/website/content/examples/20_output/envelope.md @@ -49,7 +49,7 @@ console.log(result) headers: Headers { 'content-type': 'application/graphql-response+json; charset=utf-8', 'content-length': '142', - date: 'Sun, 22 Dec 2024 02:40:37 GMT', + date: 'Sun, 22 Dec 2024 14:27:48 GMT', connection: 'keep-alive', 'keep-alive': 'timeout=5' }, diff --git a/website/content/examples/60_extension/opentelemetry.md b/website/content/examples/60_extension/opentelemetry.md index 662a221be..b4ee1a116 100644 --- a/website/content/examples/60_extension/opentelemetry.md +++ b/website/content/examples/60_extension/opentelemetry.md @@ -46,14 +46,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'encode', - id: '57064bac33995f52', + id: 'e30897dc9cb51142', kind: 0, - timestamp: 1734835237807000, - duration: 985.375, + timestamp: 1734877668621000, + duration: 1060.917, attributes: {}, status: { code: 0 }, events: [], @@ -73,14 +73,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'pack', - id: '4160ec4bd017e345', + id: '893c1fed7b2256dd', kind: 0, - timestamp: 1734835237808000, - duration: 12389.166, + timestamp: 1734877668623000, + duration: 18450.083, attributes: {}, status: { code: 0 }, events: [], @@ -100,14 +100,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'exchange', - id: 'b605384e7351522a', + id: 'b0c30685f178d075', kind: 0, - timestamp: 1734835237821000, - duration: 21988.041, + timestamp: 1734877668642000, + duration: 25750.5, attributes: {}, status: { code: 0 }, events: [], @@ -127,14 +127,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'unpack', - id: '3dc693f1496eb20f', + id: 'c148fb01cd7693fa', kind: 0, - timestamp: 1734835237844000, - duration: 1031.333, + timestamp: 1734877668668000, + duration: 1080.291, attributes: {}, status: { code: 0 }, events: [], @@ -154,14 +154,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', - parentId: '8e35291fef6405ac', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', + parentId: '6fcf4ddd316eb7dd', traceState: undefined, name: 'decode', - id: '41886c6abbbe3566', + id: '634824deddb746e7', kind: 0, - timestamp: 1734835237845000, - duration: 457.25, + timestamp: 1734877668670000, + duration: 516.708, attributes: {}, status: { code: 0 }, events: [], @@ -181,14 +181,14 @@ console.log(data) } }, instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined }, - traceId: 'e8d5df13d914fbbd4ccbdcfacd957ab0', + traceId: '0e52a2a1fb3ccb88d38cd44dded63dec', parentId: undefined, traceState: undefined, name: 'request', - id: '8e35291fef6405ac', + id: '6fcf4ddd316eb7dd', kind: 0, - timestamp: 1734835237806000, - duration: 39409.5, + timestamp: 1734877668621000, + duration: 49549.459, attributes: {}, status: { code: 0 }, events: [], diff --git a/website/content/examples/70_type_level/selection-sets.md b/website/content/examples/70_type_level/selection-sets.md new file mode 100644 index 000000000..d7c5f0a84 --- /dev/null +++ b/website/content/examples/70_type_level/selection-sets.md @@ -0,0 +1,147 @@ +--- +aside: false +--- + +# Selection Sets + +This example shows how to work with the selection set types generated by Graffle. Selection set types reflect your GraphQL schema. + + +```ts twoslash +// Our website uses Vitepress+Twoslash. Twoslash does not discover the generated Graffle modules. +// Perhaps we can configure Twoslash to include them. Until we figure that out, we have to +// explicitly import them like this. +import './graffle/modules/global.js' +// ---cut--- + +import { Graffle } from './graffle/__.js' + +type _ = [ + // + // ======================== + // Primary TypeScript Types + // ======================== + // + // + // 1. GraphQL Types + // -------------- + // The SelectionSets namespace contains a TypeScript type for each GraphQL type. + // + Graffle.SelectionSets.Query, + Graffle.SelectionSets.Mutation, + Graffle.SelectionSets.Battle, + // ... + // + // Each type contains the selection set for that type. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query['trainers'], + Graffle.SelectionSets.Mutation['addPokemon'], + Graffle.SelectionSets.Battle['___on_BattleRoyale'], + + // 2. GraphQL Type Fields + // ------------------- + // Each name is also overloaded with a namespace. Within it, you will find more TypeScript types. + // One per selection set field in the respective GraphQL type. + // + Graffle.SelectionSets.Query.pokemons, + Graffle.SelectionSets.Query.trainers, + Graffle.SelectionSets.Mutation.addPokemon, + // ... + // + // Each GraphQL type field type has properties about the selection set set for that field. + // + Graffle.SelectionSets.Query.pokemons['$'], + Graffle.SelectionSets.Query.trainers['$skip'], + Graffle.SelectionSets.Mutation.addPokemon['id'], + // ... + // + // You may have already noticed but there is a relationship between these two things: + // - The GraphQL Type type properties + // - The GraphQL Type Field types. + // + // Use the kind of type that suites your use case. + // + Graffle.SelectionSets.Query['pokemons'], + Graffle.SelectionSets.Query.pokemons, + // + // 3. TypeScript Types for Arguments + // ------------------------------ + // There are type definitions for GraphQL Type Field Arguments + // + Graffle.SelectionSets.Query.pokemons$Arguments, + Graffle.SelectionSets.Query.trainerByName$Arguments, + Graffle.SelectionSets.Mutation.addPokemon$Arguments, + // ... + // + // + // ====================== + // Niche TypeScript Types + // ====================== + // + // + // 4. "Expanded" Variants + // ------------------- + // You will find various type definitions with the suffix `$Expanded`. + // From a type-checking point of view they are identical to their non-expanded form. + // They differ in how they will be displayed in tooling, namely IDEs. + // You can leverage them to improve DX in your use-cases. + // For more details, refer to their JSDoc. + // + Graffle.SelectionSets.Query.pokemons$Expanded, + Graffle.SelectionSets.Mutation.addPokemon$Expanded, + // ... + // + // 5. Inline Fragments + // ---------------- + // + Graffle.SelectionSets.Query$FragmentInline, + Graffle.SelectionSets.Battle$FragmentInline, + // ... + // + // 6. Selection Sets Sans Union with Indicators + // ----------------------------------------- + // If the GraphQL field is a non-scalar OR scalar-with-arguments, then its type will be synonymous + // with its explicit selection set type. For example: + // + Graffle.SelectionSets.Query.beings, + Graffle.SelectionSets.Query.beings$SelectionSet, + // However, if the GraphQL field IS a scalar-without-arguments, then its type will become an + // indicator unioned with the "meta" selection set (meaning stuff like field directives). + // + // Meanwhile, the explicit selection set type will _only_ have those meta things, not the + // indicator. For example: + // + Graffle.SelectionSets.Pokemon.name, + Graffle.SelectionSets.Pokemon.name$SelectionSet, +] + +const graffle = Graffle.create() + +const getPokemonsLike = async (filter: Graffle.SelectionSets.Query.pokemons$Arguments['filter']) => + graffle.query.pokemons({ + $: { filter }, + hp: true, + name: true, + }) + +// todo add test coverage for $ stripping on arguments. +const pokemons = await getPokemonsLike({ $type: `water` }) + +// We don't lose any type safety. :) +console.log(pokemons) +``` + + +#### Outputs + + +```json +[ + { + "hp": 44, + "name": "Squirtle" + } +] +``` +