GroqD 1.0 RC (#305)

* GroqD 1.0 - Docs (#302)

* fix(docs): added sample dataset types

* fix(docs): refactored "playground" module to external file

* fix(docs): added error handling to `require` method

* fix(docs): improved TS config

* fix(arcade): support `groq-builder-playground`

* Docs: updated README (#291)

* docs: duplicated the `README.md` from the root to the package

* docs: changeset

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>

* Version Packages (#292)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* groq-builder: support sanity typegen output (#293)

* docs: duplicated the `README.md` from the root to the package

* fix(sanity typegen): made generated types have optional reference symbols, to match sanity typegen

* fix(sanity typegen): added support for optional reference symbols

* fix(sanity typegen): changeset

* fix(sanity typegen): added "real" generated types

* fix(sanity typegen): added "real" generated types with --enforce-required-fields

* fix(sanity typegen): renamed old generated types

* fix(sanity typegen): updated all tests with new generated types

* fix(sanity typegen): updated changelog

* fix(docs): Hide details for "What is GROQ"

* fix(docs): added mention of "GroqD"

* fix(docs): allow easier configuration by manually filtering non-documents

* fix(docs): updated documentation around Sanity Schema Configuration

* fix(docs): updated documentation around Sanity Schema Configuration

* fix(docs): minor wording improvements

* fix(docs): removed unused ExtractDocumentTypes

* fix(docs): improved jsdocs for `createGroqBuilder`

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>

* Version Packages (#297)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix(arcade): refactored `extraLibs` extraction

* fix(arcade): removed unused code

* fix(arcade): generate .d.ts files for all playground files

* fix(arcade): improved docs for gather-types

* fix(arcade): improved error handling

* fix(arcade): runQuery supports GroqBuilder

* chore(typescript): improved the way we define the SchemaConfig to simplify TS messaging

* chore(typescript): improved the way we define the SchemaConfig to simplify TS messaging

* chore(typescript): improved error messages for runQuery

* chore(typescript): update Monaco to latest

* chore(typescript): added type-fest to build

* fix(arcade): improved examples with `deref` and validation

* docs: updated introduction

* docs: added usage example

* chore(typescript): simplify config by passing all `schemaTypes`

* docs: removed unused script

* docs: added configuration docs

* docs: Improved configuration content

* docs: improved introduction examples

* docs: improved configuration

* feat(fragment): added `fragmentForType` method, and improved error reporting for fragments

* docs: minor jsdoc improvements

* docs: changed "intro" to "overview"

* docs: api: organized outline of doc

* docs: api: added docs for `filterByType`

* docs: api: added docs for `slice`

* docs: api: added docs for `project`

* docs: api: added docs for `raw/params/validate/nullable/deref`

* docs: api: added docs for `zod` and `transform`

* docs: api: improved generated types for zod

* docs: api: removed `q.nullToUndefined` helper, in favor of simply `q.default`

* docs: api: fixed tests from zod type refactor

* docs: api: include `zod.literal`

* docs: api: updated tests and samples to new `schemaTypes`

* docs: api: docs for Zod Extras

* docs: api: reorder docs

* docs: api: updated advanced links

* docs: api: reordered all docs

* docs: api: split API docs into multiple files

* docs: api: added `Query Parameters` docs

* docs: api: added `Validation` docs

* docs: api: reorganized the `raw` docs

* docs: fragments: documented "creating fragments"

* docs: fragments: documented "fragment usage"

* docs: projection: "ellipsis operator"

* docs: conditionals: improved `_type` typings

* docs: conditionals: added test for "overlapping conditionals"

* docs: conditionals: ensure vitest is testing! yikes

* docs: conditionals: "inline conditionals"

* docs: conditionals: added "select" docs

* docs: conditionals: added inline docs

* docs: removed obsolete `fragments` docs

* docs: updated "migration" docs

* docs: removed legacy docs

* docs: lint fix

* docs: do not commit generated .d.ts files

* docs: lint fix

* docs: update dependencies

* docs: dedupe dependencies

* docs: upgrade docusaurus

* docs: ignore TS warnings

* docs: ignore generated files

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>
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>

* GroqD 1.0 Prep - Updated Arcade Samples (#304)

* feat(errors): extracted projection validation helpers

* feat(errors): export `ValidationErrors` class

* feat(errors): ensure we handle arrays with `field` projections

* feat(errors): added jsdocs for ValidationErrors

* docs: updated playground examples to new syntax

* docs: updated playground to show error messages

* feat(errors): use explicit output types for better compatibility

* feat(errors): switch error `path` to array

* docs(playground): format paths correctly

* test(conditionals): added test for `isExhaustive`

* docs(arcade): pretty-print queries

* docs(arcade): updated conditional example

* node engine (#303)

* docs(arcade): improved todo-list data

* docs(arcade): added "TODO" samples to Arcade

* feat(validation): simplified public api

* docs(arcade): consolidated pathId logic

* test(conditional): fixed isExhaustive test

* docs: eslint ignore compiled files

* chore: added "checks" script

* feat: renamed default method to `createGroqBuilderLite`

* docs: updated broken links

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>
Co-authored-by: Nathan Kluth <nlkluth@gmail.com>

* GroqD 1.0 RC - Build config (#306)

* build: release from RC branch

* build: added changeset

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>

* GroqD 1.0 RC - Build fixes (#307)

* build: release from RC branch

* build: added changeset

* build: ensure all workflows are using same `pnpm` version

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>

* Version Packages (#308)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* build: added "deprecated" notice

* build: added "deprecated" notice

* Version Packages (#309)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* GroqD 1.0 RC - Renamed to `groqd`, bumped to `1.0` (#310)

* docs: updated README

* docs: updated NPM description

* build: renamed to `groqd` official!

* build: renamed to `groqd-legacy`

* rc: added changeset

* rc: renamed from `groq-builder` to `groqd-1`

* rc: renamed from `groqd` to `groqd-legacy`

* rc: updated build scripts

* rc: updated imports

* arcade: simplified arcade examples to match docs

* fix: added explicit return type for `makeSafeQueryRunner` for improved compatibility

* fix: improved error messages for unnecessary parameters

* arcade: use relative paths for imports

* fix: export all new types from makeSafeQueryRunner

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>

* Version Packages (#311)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* build(groqd-legacy): do not publish groqd-legacy

* build: remove RC branch from release workflow

---------

Co-authored-by: scottrippey <scott.william.rippey@gmail.com>
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>
Co-authored-by: Nathan Kluth <nlkluth@gmail.com>

.eslintrc

@@ -1,7 +1,13 @@
 {
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint", "prettier"],
-  "extends": ["plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  "plugins": [
+    "@typescript-eslint",
+    "prettier"
+  ],
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
   "parserOptions": {
     "ecmaVersion": 12,
     "sourceType": "module"
@@ -15,5 +21,12 @@
     "@typescript-eslint/ban-types": "warn",
     "@typescript-eslint/no-var-requires": "off"
   },
-  "ignorePatterns": ["**/dist/**/*", "**/build/**/*", "**/node_modules/**/*", "**/public/**/*", "**/.docusaurus/**/*"]
+  "ignorePatterns": [
+    "**/dist/**/*",
+    "**/build/**/*",
+    "**/node_modules/**/*",
+    "**/public/**/*",
+    "**/.docusaurus/**/*",
+    "**/*.d.ts"
+  ]
 }

.github/workflows/release.yml

@@ -21,13 +21,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
         with:
-          version: 8.2.0
+          version: 9
       - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
-          node-version: 18.x
+          node-version: 18
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
+
       - name: Build packages
         run: pnpm run build:packages
       - name: PR or Publish

.github/workflows/static-analysis.yml

@@ -15,13 +15,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
         with:
-          version: 8.2.0
+          version: 9
       - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
           node-version: 18
       - name: Install dependencies
-        run: pnpm install
+        run: pnpm install --frozen-lockfile
+
       - name: Build library
         run: pnpm run build:lib
       - name: Type Check

.github/workflows/unit-test.yml

@@ -14,12 +14,13 @@ jobs:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
         with:
-          version: 8.2.0
+          version: 9
       - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
           node-version: 18
       - name: Install dependencies
-        run: pnpm install
+        run: pnpm install --frozen-lockfile
+
       - name: Unit Test
         run: pnpm run test

package.json

@@ -8,15 +8,15 @@
     "typecheck:shared": "tsc --project tsconfig.shared.json --noEmit",
     "typecheck": "pnpm run typecheck:shared && pnpm run -r typecheck",
     "check:ci": "pnpm run typecheck && pnpm run lint && pnpm run test",
-    "build:lib": "pnpm run --filter groqd --filter groq-builder build",
-    "build:packages": "pnpm run --filter groqd --filter groqd-playground build",
+    "build:lib": "pnpm run --filter groqd --filter groqd-legacy build",
+    "build:packages": "pnpm run --filter groqd --filter groqd-legacy --filter groqd-playground build",
     "build": "pnpm run -r build",
     "changeset": "changeset",
     "version": "pnpm changeset version && pnpm install --no-frozen-lockfile",
     "dev:docs": "pnpm run --filter website dev",
     "build:docs": "pnpm run build:lib && pnpm run --filter website build",
     "build:docs:vercel": "pnpm run build:lib && pnpm run --filter website build:vercel",
-    "dev:playground": "concurrently \"pnpm run --filter groqd dev\" \"pnpm run --filter groqd-playground-editor dev\" \"pnpm run --filter groqd-playground dev\" \"pnpm run --filter playground-example dev\"",
+    "dev:playground": "concurrently \"pnpm run --filter groqd-legacy dev\" \"pnpm run --filter groqd-playground-editor dev\" \"pnpm run --filter groqd-playground dev\" \"pnpm run --filter playground-example dev\"",
     "dev:editor": "pnpm run --filter playground-editor dev"
   },
   "devDependencies": {
@@ -30,9 +30,9 @@
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.4",
     "typescript": "^4.9.5",
-    "monaco-editor": "^0.37.1"
+    "monaco-editor": "^0.50.0"
   },
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}