Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
1st1 committed Feb 15, 2025
1 parent 46755a1 commit 6000fb5
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/clients/js/driver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ JavaScript code. Here is an example:

.. code-block:: javascript
const email = "timmy@geldata.com"
const email = "timmy@example.com"
await client.transaction(async tx => {
await tx.execute(
Expand Down
2 changes: 1 addition & 1 deletion docs/datamodel/access_policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ Let's do some experiments.

.. code-block:: edgeql-repl
db> insert User { email := "test@geldata.com" };
db> insert User { email := "test@example.com" };
{default::User {id: be44b326-03db-11ed-b346-7f1594474966}}
db> set global current_user :=
... <uuid>"be44b326-03db-11ed-b346-7f1594474966";
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/auth/webauthn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -534,15 +534,15 @@ resulting credential or assertion to the server. Writing out the low-level
handling of serialization and deserialization of the WebAuthn data is beyond the
scope of this guide, but we publish a WebAuthn client library that you can use
to simlify this process. The library is available on npm as part of our
``@edgedb/auth-core`` library. Here is an example of how you might set up a form
``@gel/auth-core`` library. Here is an example of how you might set up a form
with appropriate click handlers to perform the WebAuthn sign in and sign up
ceremonies.
.. lint-off
.. code-block:: javascript
import { WebAuthnClient } from "@edgedb/auth-core/webauthn";
import { WebAuthnClient } from "@gel/auth-core/webauthn";
const webAuthnClient = new WebAuthnClient({
signupOptionsUrl: "http://localhost:3000/auth/webauthn/register/options",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/datamigrations/postgres.rst
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ this:
{
default::User {
name: 'Cameron',
email: 'cameron@edgedb.com',
email: 'cameron@example.com',
status: {},
badge: default::Badge {name: 'admin'},
bookmark: {
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/deployment/heroku.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ run during the build step on Heroku because it needs access to a running

.. code-block:: bash
$ yarn install && npx @edgedb/generate edgeql-js
$ yarn install && npx @gel/generate edgeql-js
The ``dbschema/edgeql-js`` directory was added to the ``.gitignore`` in the
upstream project so we'll remove it here.
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/tutorials/chatgpt_bot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -595,21 +595,21 @@ libraries that will help us.
$ npm install openai edgedb
$ npm install \
@edgedb/generate \
@gel/generate \
gpt-tokenizer \
dotenv \
tsx \
--save-dev
The ``@edgedb/generate`` package provides a set of code generation tools that
The ``@gel/generate`` package provides a set of code generation tools that
are useful when developing an Gel-backed applications with
TypeScript/JavaScript. We're going to write queries using our
:ref:`query builder <gel-js-qb>`, but before we can, we
need to run the query builder generator.
.. code-block:: bash
$ npx @edgedb/generate edgeql-js
$ npx @gel/generate edgeql-js
Answer "y" when asked about adding the query builder to ``.gitignore``.
Expand Down Expand Up @@ -1139,7 +1139,7 @@ Let's add a script to ``package.json`` that will invoke and execute
"typescript": "5.1.6"
},
"devDependencies": {
"@edgedb/generate": "^0.3.3",
"@gel/generate": "^0.3.3",
"@types/node": "20.4.8",
"@types/react": "18.2.18",
"@types/react-dom": "18.2.7",
Expand Down
20 changes: 10 additions & 10 deletions docs/guides/tutorials/nextjs_app_router.rst
Original file line number Diff line number Diff line change
Expand Up @@ -349,20 +349,20 @@ First, install the generator to your project.
.. code-block:: bash
$ npm install --save-dev @edgedb/generate
$ # or yarn add --dev @edgedb/generate
$ # or pnpm add --dev @edgedb/generate
$ # or bun add --dev @edgedb/generate
$ npm install --save-dev @gel/generate
$ # or yarn add --dev @gel/generate
$ # or pnpm add --dev @gel/generate
$ # or bun add --dev @gel/generate
Then generate the query builder with the following command.
.. code-block:: bash
$ npx @edgedb/generate edgeql-js
$ npx @gel/generate edgeql-js
Generating query builder...
Detected tsconfig.json, generating TypeScript files.
To override this, use the --target flag.
Run `npx @edgedb/generate --help` for full options.
Run `npx @gel/generate --help` for full options.
Introspecting database schema...
Writing files to ./dbschema/edgeql-js
Generation complete! 🤘
Expand Down Expand Up @@ -544,7 +544,7 @@ cloud instance.
Add the following ``prebuild`` script to your ``package.json``. When Vercel
initializes the build, it will trigger this script which will generate the
query builder. The ``npx @edgedb/generate edgeql-js`` command will read the
query builder. The ``npx @gel/generate edgeql-js`` command will read the
value of the ``EDGEDB_SECRET_KEY`` and ``EDGEDB_INSTANCE`` variables,
connect to the database, and generate the query builder before Vercel
starts building the project.
Expand All @@ -557,7 +557,7 @@ starts building the project.
"build": "next build",
"start": "next start",
"lint": "next lint",
+ "prebuild": "npx @edgedb/generate edgeql-js"
+ "prebuild": "npx @gel/generate edgeql-js"
},
**#3 Deploy to Vercel**
Expand Down Expand Up @@ -637,7 +637,7 @@ database. Open a REPL and ``insert`` some blog posts:
Add the following ``prebuild`` script to your ``package.json``. When Vercel
initializes the build, it will trigger this script which will generate the
query builder. The ``npx @edgedb/generate edgeql-js`` command will read the
query builder. The ``npx @gel/generate edgeql-js`` command will read the
value of the ``EDGEDB_DSN`` variable, connect to the database, and generate
the query builder before Vercel starts building the project.
Expand All @@ -649,7 +649,7 @@ the query builder before Vercel starts building the project.
"build": "next build",
"start": "next start",
"lint": "next lint",
+ "prebuild": "npx @edgedb/generate edgeql-js"
+ "prebuild": "npx @gel/generate edgeql-js"
},
**#5 Deploy to Vercel**
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/tutorials/nextjs_pages_router.rst
Original file line number Diff line number Diff line change
Expand Up @@ -358,17 +358,17 @@ First, install the generator to your project.
.. code-block:: bash
$ yarn add --dev @edgedb/generate
$ yarn add --dev @gel/generate
Then generate the query builder with the following command.
.. code-block:: bash
$ npx @edgedb/generate edgeql-js
$ npx @gel/generate edgeql-js
Generating query builder...
Detected tsconfig.json, generating TypeScript files.
To override this, use the --target flag.
Run `npx @edgedb/generate --help` for full options.
Run `npx @gel/generate --help` for full options.
Introspecting database schema...
Writing files to ./dbschema/edgeql-js
Generation complete! 🤘
Expand Down Expand Up @@ -597,7 +597,7 @@ database. Open a REPL and ``insert`` some blog posts:
Add the following ``prebuild`` script to your ``package.json``. When Vercel
initializes the build, it will trigger this script which will generate the
query builder. The ``npx @edgedb/generate edgeql-js`` command will read the
query builder. The ``npx @gel/generate edgeql-js`` command will read the
value of the ``EDGEDB_DSN`` variable, connect to the database, and generate the
query builder before Vercel starts building the project.
Expand All @@ -609,7 +609,7 @@ query builder before Vercel starts building the project.
"build": "next build",
"start": "next start",
"lint": "next lint",
+ "prebuild": "npx @edgedb/generate edgeql-js"
+ "prebuild": "npx @gel/generate edgeql-js"
},
**#5 Deploy to Vercel**
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/tutorials/trpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ context that provides the user session and Gel client to the tRPC API.
.. code-block:: typescript
import { createClient } from "edgedb";
import createAuth from "@edgedb/auth-nextjs/app";
import createAuth from "@gel/auth-nextjs/app";
// Initialize Gel client
export const edgedbClient = createClient();
Expand Down Expand Up @@ -375,7 +375,7 @@ authentication and context for tRPC procedures.
.. code-block:: typescript
import { createClient } from "edgedb";
import createExpressAuth from "@edgedb/auth-express";
import createExpressAuth from "@gel/auth-express";
// Initialize Gel client
const edgedbClient = createClient();
Expand Down

0 comments on commit 6000fb5

Please sign in to comment.