Supporting files

Author: benjie

.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+/dist

README.md

@@ -0,0 +1,60 @@
+# GraphQL SOCK
+
+SOCK: **Semantic Output Conversion Kit**
+
+## What is it?
+
+**Takes as input a GraphQL SDL and outputs a derived SDL wherein all
+semantic-non-null type modifiers have either been removed
+(`semantic-to-nullable`) or have been replaced with strict (traditional)
+non-null modifiers (`semantic-to-strict`).**
+
+In the latest proposals around semantic nullability, we introduce a new
+"Semantic Non Null" type modifier that means that the value is "null only on
+error". However, not all tools support this yet, so this library contains tools
+to convert a modern SDL into a more traditional one, to be used for code
+generation and other such functionality.
+
+Which command you use will depend on your setup; if you're using `graphql-toe`
+then you'll want `semantic-to-strict` to really capitalize on the benefits of
+semantic nullability. If you just want to use a semantic nullability SDL with
+traditional tools that don't yet understand it, then `semantic-to-nullable`
+will just strip out the semantic-non-null types for you.
+
+## Installation
+
+Pick the line that relates to your package manager:
+
+```bash
+npm install --save graphql-sock
+yarn add graphql-sock
+pnpm install --save graphql-sock
+```
+
+## Usage
+
+### `semantic-to-nullable`
+
+If a value is "null only on error" then it can be null. This conversion strips
+all semantic-non-null type wrappers from the SDL, making a schema that appears
+as it traditionally would. This means that you won't reap any of the benefits
+of semantic nullability, but you can support existing tools.
+
+```
+semantic-to-nullable -i input.graphql -o output.graphql
+```
+
+### `semantic-to-strict`
+
+If you're using [graphql-toe](https://github.com/graphile/graphql-toe) or a
+similar technique that means that when you read from an errored field the error
+will be thrown, then it will not be possible for you to read a `null` from a
+"null only on error" position. As such, this position becomes equivalent to a
+traditional non-null for you, so this conversion converts all semantic-non-null
+type wrappers into traditional non-null wrappers. Your type generators can
+therefore generate fewer nullables, and your frontend engineers have to do
+fewer null checks and are therefore happier.
+
+```
+semantic-to-strict -i input.graphql -o output.graphql
+```

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "graphql-sock",
+  "version": "0.0.0",
+  "description": "GraphQL Semantic Output Conversion Kit - converts a cutting edge SDL file that supports semantic nullability into a more traditional SDL file legacy tools can support.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "node --test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https+git://github.com/graphile/graphql-sock.git"
+  },
+  "bugs": {
+    "url": "https://github.com/graphile/graphql-sock/issues"
+  },
+  "homepage": "https://github.com/graphile/graphql-sock",
+  "keywords": [
+    "graphql",
+    "throw",
+    "error",
+    "errors",
+    "raise",
+    "exception",
+    "semantic",
+    "null",
+    "non-null",
+    "nullability",
+    "null",
+    "only",
+    "on",
+    "error",
+    "sdl",
+    "schema",
+    "convert",
+    "strip"
+  ],
+  "author": "Benjie Gillam <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "graphql": "^16.9.0-canary.pr.4192.1813397076f44a55e5798478e7321db9877de97a"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.7",
+    "@types/node": "^22.5.4",
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.2"
+  },
+  "prettier": {
+    "proseWrap": "always"
+  },
+  "files": [
+    "dist"
+  ]
+}

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@tsconfig/recommended/tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "rootDir": "src",
+    "declarationDir": "./dist",
+    "outDir": "./dist"
+  }
+}

yarn.lock

@@ -0,0 +1,35 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@tsconfig/recommended@^1.0.7":
+  version "1.0.7"
+  resolved "https://registry.yarnpkg.com/@tsconfig/recommended/-/recommended-1.0.7.tgz#fdd95fc2c8d643c8b4a8ca45fd68eea248512407"
+  integrity sha512-xiNMgCuoy4mCL4JTywk9XFs5xpRUcKxtWEcMR6FNMtsgewYTIgIR+nvlP4A4iRCAzRsHMnPhvTRrzp4AGcRTEA==
+
+"@types/node@^22.5.4":
+  version "22.5.5"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-22.5.5.tgz#52f939dd0f65fc552a4ad0b392f3c466cc5d7a44"
+  integrity sha512-Xjs4y5UPO/CLdzpgR6GirZJx36yScjh73+2NlLlkFRSoQN8B0DpfXPdZGnvVmLRLOsqDpOfTNv7D9trgGhmOIA==
+  dependencies:
+    undici-types "~6.19.2"
+
+graphql@^16.9.0-canary.pr.4192.1813397076f44a55e5798478e7321db9877de97a:
+  version "16.9.0"
+  resolved "https://registry.yarnpkg.com/graphql/-/graphql-16.9.0.tgz#1c310e63f16a49ce1fbb230bd0a000e99f6f115f"
+  integrity sha512-GGTKBX4SD7Wdb8mqeDLni2oaRGYQWjWHGKPQ24ZMnUtKfcsVoiv4uX8+LJr1K6U5VW2Lu1BwJnj7uiori0YtRw==
+
+prettier@^3.3.3:
+  version "3.3.3"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105"
+  integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==
+
+typescript@^5.6.2:
+  version "5.6.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.6.2.tgz#d1de67b6bef77c41823f822df8f0b3bcff60a5a0"
+  integrity sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==
+
+undici-types@~6.19.2:
+  version "6.19.8"
+  resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02"
+  integrity sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==