feat(generator): separate name and namespace name config (#1235)

.github/workflows/deploy-website.yml

@@ -43,6 +43,10 @@ jobs:
         id: deployment
         uses: actions/deploy-pages@v4
 
+# TODO Go back to building website in CI and NOT committing the dist to the repo.
+# Currently, the Twoslash results in CI are not consistent with local results.
+# E.g. We'll get some variable as `any` in CI versus an actual data type in local.
+
 # name: Deploy Website
 # on:
 #   push:

.vscode/settings.json

@@ -3,7 +3,8 @@
     "**/build": true,
     "**/__snapshots__": true,
     "**/pnpm-lock.yaml": true,
-    "**/*.tsbuildinfo": true
+    "**/*.tsbuildinfo": true,
+    "**/.vitepress/dist": true
   },
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.enablePromptUseWorkspaceTsdk": true,

dprint.json

@@ -11,7 +11,8 @@
     "**/node_modules",
     "**/*-lock.json",
     "website/pokemon",
-    "website/graffle"
+    "website/graffle",
+    "website/.vitepress/dist"
   ],
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.93.0.wasm",

examples/10_transport-http/transport-http_method-get.ts

@@ -3,10 +3,10 @@
  * to be sent over HTTP GET method. Note write-kind operations (mutation) are still sent over HTTP POST method.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const graffle = Pokemon
+const graffle = Graffle
   .create({
     transport: {
       methodMode: `getReads`, // [!code highlight]

examples/20_output/output_default.ts

@@ -2,10 +2,10 @@
  * This example shows the default output behavior.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 const pokemons = await pokemon.query.pokemons({ name: true })
 

examples/20_output/output_envelope.ts

@@ -2,10 +2,10 @@
  * This example shows how to configure output to use the envelope.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const pokemon = Pokemon.create({
+const pokemon = Graffle.create({
   output: {
     envelope: true,
   },

examples/20_output/output_envelope_envelope-error__envelope-error.ts

@@ -2,11 +2,11 @@
  * This example shows how to configure output to embed errors into the envelope.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
 // dprint-ignore
-const pokemon = Pokemon
+const pokemon = Graffle
   .create({
     output: {
       envelope: {

examples/20_output/output_envelope_envelope_error-throw__envelope-error-throw.ts

@@ -2,10 +2,10 @@
  * This example shows how to configure output to throw errors even when using the envelope.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 
 // dprint-ignore
-const pokemon = Pokemon
+const pokemon = Graffle
   .create({
     output: {
       envelope: {

examples/20_output/output_return-error.ts

@@ -2,11 +2,11 @@
  * This example shows how to configure output to have errors returned instead of e.g. thrown.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
 // dprint-ignore
-const pokemon = Pokemon
+const pokemon = Graffle
   .create({
     output: {
       envelope: false,

examples/20_output/output_return-error_return-error-execution__return-error-execution.ts

@@ -2,10 +2,10 @@
  * This example shows how to configure output to have only certain kinds of errors returned while others thrown.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/show.js'
 
-const pokemon = Pokemon
+const pokemon = Graffle
   .create({
     output: {
       envelope: false,

examples/35_custom-scalar/custom-scalar.ts

@@ -3,10 +3,10 @@
  * have arguments and data automatically encoded and decoded respectively.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const graffle = Pokemon
+const graffle = Graffle
   .create()
   .scalar(`Date`, {
     decode: (value: string) => new Date(value),

examples/55_document-builder/document-builder_alias.ts

@@ -2,10 +2,10 @@
  * This example shows how to write GraphQL aliases in the TypeScript interface.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 const day = 1000 * 60 * 60 * 24
 const year = day * 365.25

examples/55_document-builder/document-builder_arguments.ts

@@ -2,10 +2,10 @@
  * This example shows how to write field arguments in TypeScript interface.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const atlas = Pokemon.create()
+const atlas = Graffle.create()
 
 // dprint-ignore
 const pokemons = await atlas.query.pokemons({

examples/55_document-builder/document-builder_batch.ts

@@ -2,10 +2,10 @@
  * This example shows how to write batches of GraphQL root fields (aka. entrypoints) in the TypeScript interface.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 // dprint-ignore
 const pokemons = await pokemon.query.$batch({

examples/55_document-builder/document-builder_directive.ts

@@ -3,10 +3,10 @@
  */
 
 // import { parse, print } from 'graphql'
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 // dprint-ignore
 const pokemons = await pokemon.query.$batch({

examples/55_document-builder/document-builder_document.ts

@@ -2,10 +2,10 @@
  * This example shows how to write whole GraphQL documents in the TypeScript interface.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 const pokemons = await pokemon.document({
   //                           ^^^^^^^^

examples/55_document-builder/document-builder_interface.ts

@@ -2,10 +2,10 @@
  * This example shows how to work with interface types.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 // dprint-ignore
 const beings = await pokemon.query.beings({

examples/55_document-builder/document-builder_root-field.ts

@@ -2,10 +2,10 @@
  * This example shows how to use dedicated root field methods to easily operate on one GraphQL root field at at time. If you need to work with multiple root fields, check out the `batch` example.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { showJson } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 const pokemons = await pokemon.query.pokemons({ name: true })
 //                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

examples/55_document-builder/document-builder_union.ts

@@ -2,10 +2,10 @@
  * This example shows how to work with GraphQL union types in the TypeScript interface.
  */
 
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { show } from '../$/helpers.js'
 
-const pokemon = Pokemon.create()
+const pokemon = Graffle.create()
 
 // dprint-ignore
 const battles = await pokemon.query.battles({

examples/60_extension/extension_introspection__introspection.ts

@@ -3,12 +3,12 @@
  */
 
 import { Introspection } from '../../src/entrypoints/extensions/introspection/runtime.js'
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { interceptAndShowUncaughtErrors, show } from '../$/show.js'
 
 interceptAndShowUncaughtErrors()
 
-const pokemon = Pokemon.create().use(Introspection())
+const pokemon = Graffle.create().use(Introspection())
 
 const data = await pokemon.introspect()
 show(data)

examples/60_extension/extension_opentelemetry__opentelemetry.ts

@@ -1,7 +1,7 @@
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'
 import { Opentelemetry } from '../../src/entrypoints/extensions/opentelemetry/runtime.js'
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { interceptAndShowOutput, show } from '../$/helpers.js'
 
 interceptAndShowOutput()
@@ -15,6 +15,6 @@ const provider = new NodeTracerProvider()
 provider.addSpanProcessor(processor)
 provider.register()
 
-const graffle = Pokemon.create().use(Opentelemetry())
+const graffle = Graffle.create().use(Opentelemetry())
 const data = await graffle.gql`query { pokemons { name } }`.send()
 show(data)

examples/60_extension/extension_throws__throws.ts

@@ -3,12 +3,12 @@
  */
 
 import { Throws } from '../../src/entrypoints/extensions/throws/runtime.js'
-import { Pokemon } from '../../tests/_/schemas/pokemon/graffle/__.js'
+import { Graffle } from '../../tests/_/schemas/pokemon/graffle/__.js'
 import { interceptAndShowUncaughtErrors, show } from '../$/show.js'
 
 interceptAndShowUncaughtErrors()
 
-const pokemon = Pokemon
+const pokemon = Graffle
   .create({ output: { defaults: { errorChannel: `return` } } })
   .use(Throws())
   .anyware(({ encode: _ }) => {

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': '1730084002612'
+    'x-sent-at-time': '1730125688291'
   },
   signal: undefined,
   method: 'post',

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: 'Mon, 28 Oct 2024 02:53:23 GMT',
+      date: 'Mon, 28 Oct 2024 14:28:09 GMT',
       connection: 'keep-alive',
       'keep-alive': 'timeout=5'
     },