@auth/edgedb-adapter 0.2.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022-2023, Balázs Orbán
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+<p align="center">
+  <br/>
+  <a href="https://authjs.dev" target="_blank">
+    <img height="64px" src="https://authjs.dev/img/logo/logo-sm.png" />
+  </a>
+  <a href="https://www.edgedb.com/" target="_blank">
+    <img height="64px" src="https://authjs.dev/img/adapters/edgedb.svg"/>
+  </a>
+  <h3 align="center"><b>Edge DB Adapter</b> - NextAuth.js / Auth.js</a></h3>
+  <p align="center" style="align: center;">
+    <a href="https://npm.im/@auth/edgedb-adapter">
+      <img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
+    </a>
+    <a href="https://npm.im/@auth/edgedb-adapter">
+      <img alt="npm" src="https://img.shields.io/npm/v/@auth/edgedb-adapter?color=green&label=@auth/edgedb-adapter&style=flat-square">
+    </a>
+    <a href="https://www.npmtrends.com/@auth/edgedb-adapter">
+      <img src="https://img.shields.io/npm/dm/@auth/edgedb-adapter?label=%20downloads&style=flat-square" alt="Downloads" />
+    </a>
+    <a href="https://github.com/nextauthjs/next-auth/stargazers">
+      <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="Github Stars" />
+    </a>
+  </p>
+</p>
+
+---
+
+Check out the documentation at [authjs.dev](https://authjs.dev/reference/adapter/edgedb).

package/index.d.ts

@@ -0,0 +1,286 @@
+/**
+ * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center", padding: 16}}>
+ *  <p style={{fontWeight: "normal"}}>Official <a href="https://www.edgedb.com/">Edge DB</a> adapter for Auth.js / NextAuth.js.</p>
+ *  <a href="https://www.edgedb.com/">
+ *   <img style={{display: "block"}} src="/img/adapters/edgedb.svg" width="38" />
+ *  </a>
+ * </div>
+ *
+ * ## Installation
+ *
+ * ```bash npm2yarn2pnpm
+ * npm install edgedb @auth/edgedb-adapter
+ * npm install @edgedb/generate --save-dev
+ * ```
+ *
+ * @module @auth/edgedb-adapter
+ */
+import type { Adapter } from "@auth/core/adapters";
+import type { Client } from "edgedb";
+/**
+ *
+ * To use this Adapter, you need to install `edgedb`, `@edgedb/generate`, and the separate `@auth/edgedb-adapter` package:
+ *
+ * ```bash npm2yarn2pnpm
+ * npm install edgedb @auth/edgedb-adapter
+ * npm install @edgedb/generate --save-dev
+ * ```
+ *
+ * ## Installation
+ *
+ * First, ensure you have the EdgeDB CLI installed.
+ *
+ * Follow the instructions below, or read the [EdgeDB quickstart](https://www.edgedb.com/docs/intro/quickstart) to install the EdgeDB CLI and initialize a project
+ *
+ * ### Linux or macOS
+ * ```bash
+ * curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh
+ * ```
+ *
+ * ### Windows
+ * ```powershell
+ * iwr https://ps1.edgedb.com -useb | iex
+ * ```
+ *
+ * Check that the CLI is available with the `edgedb --version` command. If you get a `Command not found` error, you may need to open a new terminal window before the `edgedb` command is available.
+ *
+ * Once the CLI is installed, initialize a project from the application’s root directory. You’ll be presented with a series of prompts.
+ *
+ * ```bash
+ * edgedb project init
+ * ```
+ *
+ * This process will spin up an EdgeDB instance and [“link”](https://www.edgedb.com/docs/cli/edgedb_instance/edgedb_instance_link#edgedb-instance-link) it with your current directory. As long as you’re inside that directory, CLI commands and client libraries will be able to connect to the linked instance automatically, without additional configuration.
+ *
+ * ## Setup
+ *
+ * ### NextAuth.js configuration
+ *
+ * Configure your NextAuth.js to use the EdgeDB Adapter:
+ *
+ * ```javascript title="pages/api/auth/[...nextauth].js"
+ * import NextAuth from "next-auth"
+ * import GoogleProvider from "next-auth/providers/google"
+ * import { EdgeDBAdapter } from "@auth/edgedb-adapter"
+ * import { createClient } from "edgedb"
+ *
+ * const client = createClient()
+ *
+ * export default NextAuth({
+ *   adapter: EdgeDBAdapter(client),
+ *   providers: [
+ *     GoogleProvider({
+ *       clientId: process.env.GOOGLE_CLIENT_ID,
+ *       clientSecret: process.env.GOOGLE_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Create the EdgeDB schema
+ *
+ * Replace the contents of the auto-generated file in `dbschema/default.esdl` with the following:
+ *
+ * > This schema is adapted for use in EdgeDB and based upon our main [schema](/adapters/models)
+ *
+ * ```json title="default.esdl"
+ * module default {
+ *     type User {
+ *         property name -> str;
+ *         required property email -> str {
+ *             constraint exclusive;
+ *         }
+ *         property emailVerified -> datetime;
+ *         property image -> str;
+ *         multi link accounts := .<user[is Account];
+ *         multi link sessions := .<user[is Session];
+ *         property createdAt -> datetime {
+ *             default := datetime_current();
+ *         };
+ *     }
+ *
+ *     type Account {
+ *        required property userId := .user.id;
+ *        required property type -> str;
+ *        required property provider -> str;
+ *        required property providerAccountId -> str {
+ *         constraint exclusive;
+ *        };
+ *        property refresh_token -> str;
+ *        property access_token -> str;
+ *        property expires_at -> int64;
+ *        property token_type -> str;
+ *        property scope -> str;
+ *        property id_token -> str;
+ *        property session_state -> str;
+ *        required link user -> User {
+ *             on target delete delete source;
+ *        };
+ *        property createdAt -> datetime {
+ *             default := datetime_current();
+ *         };
+ *
+ *        constraint exclusive on ((.provider, .providerAccountId))
+ *     }
+ *
+ *     type Session {
+ *         required property sessionToken -> str {
+ *             constraint exclusive;
+ *         }
+ *         required property userId := .user.id;
+ *         required property expires -> datetime;
+ *         required link user -> User {
+ *             on target delete delete source;
+ *         };
+ *         property createdAt -> datetime {
+ *             default := datetime_current();
+ *         };
+ *     }
+ *
+ *     type VerificationToken {
+ *         required property identifier -> str;
+ *         required property token -> str {
+ *             constraint exclusive;
+ *         }
+ *         required property expires -> datetime;
+ *         property createdAt -> datetime {
+ *             default := datetime_current();
+ *         };
+ *
+ *         constraint exclusive on ((.identifier, .token))
+ *     }
+ * }
+ *
+ * # Disable the application of access policies within access policies
+ * # themselves. This behavior will become the default in EdgeDB 3.0.
+ * # See: https://www.edgedb.com/docs/reference/ddl/access_policies#nonrecursive
+ * using future nonrecursive_access_policies;
+ * ```
+ *
+ * ### Migrate the database schema
+ *
+ * Create a migration
+ *
+ * ```
+ * edgedb migration create
+ * ```
+ *
+ * Apply the migration
+ *
+ * ```
+ * edgedb migrate
+ * ```
+ *
+ * To learn more about [EdgeDB migrations](https://www.edgedb.com/docs/intro/migrations#generate-a-migration), check out the [Migrations docs](https://www.edgedb.com/docs/intro/migrations).
+ *
+ * ### Generate the query builder
+ *
+ * ```npm2yarn2pnpm
+ * npx @edgedb/generate edgeql-js
+ * ```
+ *
+ * This will generate the [query builder](https://www.edgedb.com/docs/clients/js/querybuilder) so that you can write fully typed EdgeQL queries with TypeScript in a code-first way.
+ *
+ * For example
+ *
+ * ```ts
+ * const query = e.select(e.User, () => ({
+ *         id: true,
+ *         email: true,
+ *         emailVerified: true,
+ *         name: true,
+ *         image: true,
+ *         filter_single: { email: 'johndoe@example.com' },
+ *       }));
+ *
+ * return await query.run(client);
+ *
+ * // Return type:
+ * // {
+ * //     id: string;
+ * //     email: string;
+ * //     emailVerified: Date | null;
+ * //     image: string | null;
+ * //     name: string | null;
+ * // } | null
+ *
+ * ```
+ *
+ *
+ * ## Deploying
+ *
+ * ### Deploy EdgeDB
+ *
+ * First deploy an EdgeDB instance on your preferred cloud provider:
+ *
+ * [AWS](https://www.edgedb.com/docs/guides/deployment/aws_aurora_ecs)
+ *
+ * [Google Cloud](https://www.edgedb.com/docs/guides/deployment/gcp)
+ *
+ * [Azure](https://www.edgedb.com/docs/guides/deployment/azure_flexibleserver)
+ *
+ * [DigitalOcean](https://www.edgedb.com/docs/guides/deployment/digitalocean)
+ *
+ * [Fly.io](https://www.edgedb.com/docs/guides/deployment/fly_io)
+ *
+ * [Docker](https://www.edgedb.com/docs/guides/deployment/docker) (cloud-agnostic)
+ *
+ * ### Find your instance’s DSN
+ *
+ * The DSN is also known as a connection string. It will have the format `edgedb://username:password@hostname:port`. The exact instructions for this depend on which cloud you are deploying to.
+ *
+ * ### Set an environment variable
+ *
+ * ```env title=".env"
+ * EDGEDB_DSN=edgedb://johndoe:supersecure@myhost.com:420
+ * ```
+ *
+ * ### Update the client
+ *
+ * ```diff title="pages/api/auth/[...nextauth].js"
+ * import NextAuth from "next-auth"
+ * import GoogleProvider from "next-auth/providers/google"
+ * import { EdgeDBAdapter } from "@auth/edgedb-adapter"
+ * import { createClient } from "edgedb"
+ *
+ * - const client = createClient()
+ * + const client = createClient({ dsn: process.env.EDGEDB_DSN })
+ *
+ * export default NextAuth({
+ *   adapter: EdgeDBAdapter(client),
+ *   providers: [
+ *     GoogleProvider({
+ *       clientId: process.env.GOOGLE_CLIENT_ID,
+ *       clientSecret: process.env.GOOGLE_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ *
+ *
+ * ### Apply migrations
+ *
+ * Use the DSN to apply migrations against your remote instance.
+ *
+ * ```bash
+ * edgedb migrate --dsn <your-instance-dsn>
+ * ```
+ *
+ * ### Set up a `prebuild` script
+ *
+ * Add the following `prebuild` script to your `package.json`. When your hosting provider initializes the build, it will trigger this script which will generate the query builder. The `npx @edgedb/generate edgeql-js` command will read the value of the `EDGEDB_DSN` environment variable, connect to the database, and generate the query builder before your hosting provider starts building the project.
+ *
+ * ```diff title="package.json"
+ * "scripts": {
+ *   "dev": "next dev",
+ *   "build": "next build",
+ *   "start": "next start",
+ *   "lint": "next lint",
+ * +  "prebuild": "npx @edgedb/generate edgeql-js"
+ * },
+ * ```
+ *
+ */
+export declare function EdgeDBAdapter(client: Client): Adapter;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EACV,OAAO,EAIR,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwQG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAmUrD"}