@proofkit/cli 1.0.0-beta.0

package/template/extras/fmaddon-auth/server/auth/utils/session.ts

@@ -0,0 +1,192 @@
+import {
+  encodeBase32LowerCaseNoPadding,
+  encodeHexLowerCase,
+} from "@oslojs/encoding";
+import { sha256 } from "@oslojs/crypto/sha2";
+import { cookies } from "next/headers";
+import { cache } from "react";
+import type { User } from "./user";
+
+import { sessionsLayout } from "../db/client";
+import { Tsessions as _Session } from "../db/sessions";
+
+/**
+ * Generate a random session token with sufficient entropy for a session ID.
+ * @returns The session token.
+ */
+export function generateSessionToken(): string {
+  const bytes = new Uint8Array(20);
+  crypto.getRandomValues(bytes);
+  const token = encodeBase32LowerCaseNoPadding(bytes);
+  return token;
+}
+
+/**
+ * Create a new session for a user and save it to the database.
+ * @param token - The session token.
+ * @param userId - The ID of the user.
+ * @returns The session.
+ */
+export async function createSession(
+  token: string,
+  userId: string,
+): Promise<Session> {
+  const sessionId = encodeHexLowerCase(sha256(new TextEncoder().encode(token)));
+  const session: Session = {
+    id: sessionId,
+    id_user: userId,
+    expiresAt: new Date(Date.now() + 1000 * 60 * 60 * 24 * 30),
+  };
+
+  // create session in DB
+  await sessionsLayout.create({
+    fieldData: {
+      id: session.id,
+      id_user: session.id_user,
+      expiresAt: Math.floor(session.expiresAt.getTime() / 1000),
+    },
+  });
+
+  return session;
+}
+
+/**
+ * Invalidate a session by deleting it from the database.
+ * @param sessionId - The ID of the session to invalidate.
+ */
+export async function invalidateSession(sessionId: string): Promise<void> {
+  const fmResult = await sessionsLayout.maybeFindFirst({
+    query: { id: `==${sessionId}` },
+  });
+  if (fmResult === null) {
+    return;
+  }
+  await sessionsLayout.delete({ recordId: fmResult.data.recordId });
+}
+
+/**
+ * Validate a session token to make sure it still exists in the database and hasn't expired.
+ * @param token - The session token.
+ * @returns The session, or null if it doesn't exist.
+ */
+export async function validateSessionToken(
+  token: string,
+): Promise<SessionValidationResult> {
+  const sessionId = encodeHexLowerCase(sha256(new TextEncoder().encode(token)));
+
+  const result = await sessionsLayout.maybeFindFirst({
+    query: { id: `==${sessionId}` },
+  });
+  if (result === null) {
+    return { session: null, user: null };
+  }
+
+  const fmResult = result.data.fieldData;
+  const recordId = result.data.recordId;
+  const session: Session = {
+    id: fmResult.id,
+    id_user: fmResult.id_user,
+    expiresAt: fmResult.expiresAt
+      ? new Date(fmResult.expiresAt * 1000)
+      : new Date(Date.now() + 1000 * 60 * 60 * 24 * 30),
+  };
+
+  const user: User = {
+    id: session.id_user,
+    email: fmResult["proofkit_auth_users::email"],
+    emailVerified: Boolean(fmResult["proofkit_auth_users::emailVerified"]),
+    username: fmResult["proofkit_auth_users::username"],
+  };
+
+  // delete session if it has expired
+  if (Date.now() >= session.expiresAt.getTime()) {
+    await sessionsLayout.delete({ recordId });
+    return { session: null, user: null };
+  }
+
+  // extend session if it's going to expire soon
+  // You may want to customize this logic to better suit your app's requirements
+  if (Date.now() >= session.expiresAt.getTime() - 1000 * 60 * 60 * 24 * 15) {
+    session.expiresAt = new Date(Date.now() + 1000 * 60 * 60 * 24 * 30);
+    await sessionsLayout.update({
+      recordId,
+      fieldData: {
+        expiresAt: Math.floor(session.expiresAt.getTime() / 1000),
+      },
+    });
+  }
+
+  return { session, user };
+}
+
+/**
+ * Get the current session from the cookie.
+ * Wrapped in a React cache to avoid calling the database more than once per request
+ * This function can be used in server components, server actions, and route handlers (but importantly not middleware).
+ * @returns The session, or null if it doesn't exist.
+ */
+export const getCurrentSession = cache(
+  async (): Promise<SessionValidationResult> => {
+    const token = (await cookies()).get("session")?.value ?? null;
+    if (token === null) {
+      return { session: null, user: null };
+    }
+    const result = await validateSessionToken(token);
+    return result;
+  },
+);
+
+/**
+ * Invalidate all sessions for a user by deleting them from the database.
+ * @param userId - The ID of the user.
+ */
+export async function invalidateUserSessions(userId: string): Promise<void> {
+  const sessions = await sessionsLayout.findAll({
+    query: { id_user: `==${userId}` },
+  });
+  for (const session of sessions) {
+    await sessionsLayout.delete({ recordId: session.recordId });
+  }
+}
+
+/**
+ * Set a cookie for a session.
+ * @param token - The session token.
+ * @param expiresAt - The expiration date of the session.
+ */
+export async function setSessionTokenCookie(
+  token: string,
+  expiresAt: Date,
+): Promise<void> {
+  (await cookies()).set("session", token, {
+    httpOnly: true,
+    path: "/",
+    secure: process.env.NODE_ENV === "production",
+    sameSite: "lax",
+    expires: expiresAt,
+  });
+}
+
+
+/**
+ * Delete the session cookie.
+ */
+export async function deleteSessionTokenCookie(): Promise<void> {
+  (await cookies()).set("session", "", {
+    httpOnly: true,
+    path: "/",
+    secure: process.env.NODE_ENV === "production",
+    sameSite: "lax",
+    maxAge: 0,
+  });
+}
+
+export interface Session {
+  id: string;
+  expiresAt: Date;
+  id_user: string;
+}
+
+type SessionValidationResult =
+  | { session: Session; user: User }
+  | { session: null; user: null };

package/template/extras/fmaddon-auth/server/auth/utils/user.ts

@@ -0,0 +1,147 @@
+import { usersLayout } from "../db/client";
+import { Tusers as _User } from "../db/users";
+
+export type User = Partial<
+  Omit<_User, "id" | "password_hash" | "recovery_code" | "emailVerified">
+> & {
+  id: string;
+  email: string;
+  emailVerified: boolean;
+};
+
+import { hashPassword, verifyPasswordHash } from "./password";
+
+/** An internal helper function to fetch a user from the database. */
+async function fetchUser(userId: string) {
+  const { data } = await usersLayout.findOne({
+    query: { id: `==${userId}` },
+  });
+  return data;
+}
+
+/** Create a new user in the database. */
+export async function createUser(
+  email: string,
+  password: string
+): Promise<User> {
+  const password_hash = await hashPassword(password);
+  const { recordId } = await usersLayout.create({
+    fieldData: {
+      email,
+      password_hash,
+      emailVerified: 0,
+    },
+  });
+  const fmResult = await usersLayout.get({ recordId });
+  const { fieldData } = fmResult.data[0];
+
+  const user: User = {
+    id: fieldData.id,
+    email,
+    emailVerified: false,
+    username: "",
+  };
+  return user;
+}
+
+/** Update a user's password in the database. */
+export async function updateUserPassword(
+  userId: string,
+  password: string
+): Promise<void> {
+  const password_hash = await hashPassword(password);
+  const { recordId } = await fetchUser(userId);
+
+  await usersLayout.update({ recordId, fieldData: { password_hash } });
+}
+
+export async function updateUserEmailAndSetEmailAsVerified(
+  userId: string,
+  email: string
+): Promise<void> {
+  const { recordId } = await fetchUser(userId);
+  await usersLayout.update({
+    recordId,
+    fieldData: { email, emailVerified: 1 },
+  });
+}
+
+export async function setUserAsEmailVerifiedIfEmailMatches(
+  userId: string,
+  email: string
+): Promise<boolean> {
+  try {
+    const {
+      data: { recordId },
+    } = await usersLayout.findOne({
+      query: { id: `==${userId}`, email: `==${email}` },
+    });
+    await usersLayout.update({ recordId, fieldData: { emailVerified: 1 } });
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+export async function getUserFromEmail(email: string): Promise<User | null> {
+  const fmResult = await usersLayout.maybeFindFirst({
+    query: { email: `==${email}` },
+  });
+  if (fmResult === null) return null;
+
+  const {
+    data: { fieldData },
+  } = fmResult;
+
+  const user: User = {
+    id: fieldData.id,
+    email: fieldData.email,
+    emailVerified: Boolean(fieldData.emailVerified),
+    username: fieldData.username,
+  };
+  return user;
+}
+
+/**
+ * Validate a user's email/password combination.
+ * @param email - The user's email.
+ * @param password - The user's password.
+ * @returns The user, or null if the login is invalid.
+ */
+export async function validateLogin(
+  email: string,
+  password: string
+): Promise<User | null> {
+  try {
+    const {
+      data: { fieldData },
+    } = await usersLayout.findOne({
+      query: { email: `==${email}` },
+    });
+
+    const validPassword = await verifyPasswordHash(
+      fieldData.password_hash,
+      password
+    );
+    if (!validPassword) {
+      return null;
+    }
+    const user: User = {
+      id: fieldData.id,
+      email: fieldData.email,
+      emailVerified: Boolean(fieldData.emailVerified),
+      username: fieldData.username,
+    };
+    return user;
+  } catch (error) {
+    return null;
+  }
+}
+
+export async function checkEmailAvailability(email: string): Promise<boolean> {
+  const { data } = await usersLayout.find({
+    query: { email: `==${email}` },
+    ignoreEmptyResult: true,
+  });
+  return data.length === 0;
+}

package/template/extras/prisma/schema/base-planetscale.prisma

@@ -0,0 +1,24 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+    provider        = "prisma-client-js"
+    previewFeatures = ["driverAdapters"]
+}
+
+datasource db {
+    provider = "mysql"
+    url      = env("DATABASE_URL")
+
+    // If you have enabled foreign key constraints for your database, remove this line.
+    relationMode = "prisma"
+}
+
+model Post {
+    id        Int      @id @default(autoincrement())
+    name      String
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    @@index([name])
+}

package/template/extras/prisma/schema/base.prisma

@@ -0,0 +1,20 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+    provider = "prisma-client-js"
+}
+
+datasource db {
+    provider = "sqlite"
+    url      = env("DATABASE_URL")
+}
+
+model Post {
+    id        Int      @id @default(autoincrement())
+    name      String
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    @@index([name])
+}

package/template/extras/prisma/schema/with-auth-planetscale.prisma

@@ -0,0 +1,77 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+    provider        = "prisma-client-js"
+    previewFeatures = ["driverAdapters"]
+}
+
+datasource db {
+    provider = "mysql"
+    url      = env("DATABASE_URL")
+
+    // If you have enabled foreign key constraints for your database, remove this line.
+    relationMode = "prisma"
+}
+
+model Post {
+    id        Int      @id @default(autoincrement())
+    name      String
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    createdBy   User   @relation(fields: [createdById], references: [id])
+    createdById String
+
+    @@index([name])
+    @@index([createdById])
+}
+
+// Necessary for Next auth
+model Account {
+    id                String  @id @default(cuid())
+    userId            String
+    type              String
+    provider          String
+    providerAccountId String
+    refresh_token     String? @db.Text
+    access_token      String? @db.Text
+    expires_at        Int?
+    token_type        String?
+    scope             String?
+    id_token          String? @db.Text
+    session_state     String?
+    user              User    @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+    @@unique([provider, providerAccountId])
+    @@index([userId])
+}
+
+model Session {
+    id           String   @id @default(cuid())
+    sessionToken String   @unique
+    userId       String
+    expires      DateTime
+    user         User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+    @@index([userId])
+}
+
+model User {
+    id            String    @id @default(cuid())
+    name          String?
+    email         String?   @unique
+    emailVerified DateTime?
+    image         String?
+    accounts      Account[]
+    sessions      Session[]
+    posts         Post[]
+}
+
+model VerificationToken {
+    identifier String
+    token      String   @unique
+    expires    DateTime
+
+    @@unique([identifier, token])
+}

package/template/extras/prisma/schema/with-auth.prisma

@@ -0,0 +1,74 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+    provider = "prisma-client-js"
+}
+
+datasource db {
+    provider = "sqlite"
+    // NOTE: When using mysql or sqlserver, uncomment the @db.Text annotations in model Account below
+    // Further reading:
+    // https://next-auth.js.org/adapters/prisma#create-the-prisma-schema
+    // https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference#string
+    url      = env("DATABASE_URL")
+}
+
+model Post {
+    id        Int      @id @default(autoincrement())
+    name      String
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+
+    createdBy   User   @relation(fields: [createdById], references: [id])
+    createdById String
+
+    @@index([name])
+}
+
+// Necessary for Next auth
+model Account {
+    id                       String  @id @default(cuid())
+    userId                   String
+    type                     String
+    provider                 String
+    providerAccountId        String
+    refresh_token            String? // @db.Text
+    access_token             String? // @db.Text
+    expires_at               Int?
+    token_type               String?
+    scope                    String?
+    id_token                 String? // @db.Text
+    session_state            String?
+    user                     User    @relation(fields: [userId], references: [id], onDelete: Cascade)
+    refresh_token_expires_in Int?
+
+    @@unique([provider, providerAccountId])
+}
+
+model Session {
+    id           String   @id @default(cuid())
+    sessionToken String   @unique
+    userId       String
+    expires      DateTime
+    user         User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+}
+
+model User {
+    id            String    @id @default(cuid())
+    name          String?
+    email         String?   @unique
+    emailVerified DateTime?
+    image         String?
+    accounts      Account[]
+    sessions      Session[]
+    posts         Post[]
+}
+
+model VerificationToken {
+    identifier String
+    token      String   @unique
+    expires    DateTime
+
+    @@unique([identifier, token])
+}

package/template/extras/src/app/_components/post-tw.tsx

@@ -0,0 +1,50 @@
+"use client";
+
+import { useState } from "react";
+
+import { api } from "~/trpc/react";
+
+export function LatestPost() {
+  const [latestPost] = api.post.getLatest.useSuspenseQuery();
+
+  const utils = api.useUtils();
+  const [name, setName] = useState("");
+  const createPost = api.post.create.useMutation({
+    onSuccess: async () => {
+      await utils.post.invalidate();
+      setName("");
+    },
+  });
+
+  return (
+    <div className="w-full max-w-xs">
+      {latestPost ? (
+        <p className="truncate">Your most recent post: {latestPost.name}</p>
+      ) : (
+        <p>You have no posts yet.</p>
+      )}
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          createPost.mutate({ name });
+        }}
+        className="flex flex-col gap-2"
+      >
+        <input
+          type="text"
+          placeholder="Title"
+          value={name}
+          onChange={(e) => setName(e.target.value)}
+          className="w-full rounded-full px-4 py-2 text-black"
+        />
+        <button
+          type="submit"
+          className="rounded-full bg-white/10 px-10 py-3 font-semibold transition hover:bg-white/20"
+          disabled={createPost.isPending}
+        >
+          {createPost.isPending ? "Submitting..." : "Submit"}
+        </button>
+      </form>
+    </div>
+  );
+}

package/template/extras/src/app/_components/post.tsx

@@ -0,0 +1,54 @@
+"use client";
+
+import { useState } from "react";
+
+import { api } from "~/trpc/react";
+import styles from "../index.module.css";
+
+export function LatestPost() {
+  const [latestPost] = api.post.getLatest.useSuspenseQuery();
+
+  const utils = api.useUtils();
+  const [name, setName] = useState("");
+  const createPost = api.post.create.useMutation({
+    onSuccess: async () => {
+      await utils.post.invalidate();
+      setName("");
+    },
+  });
+
+  return (
+    <div className={styles.showcaseContainer}>
+      {latestPost ? (
+        <p className={styles.showcaseText}>
+          Your most recent post: {latestPost.name}
+        </p>
+      ) : (
+        <p className={styles.showcaseText}>You have no posts yet.</p>
+      )}
+
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          createPost.mutate({ name });
+        }}
+        className={styles.form}
+      >
+        <input
+          type="text"
+          placeholder="Title"
+          value={name}
+          onChange={(e) => setName(e.target.value)}
+          className={styles.input}
+        />
+        <button
+          type="submit"
+          className={styles.submitButton}
+          disabled={createPost.isPending}
+        >
+          {createPost.isPending ? "Submitting..." : "Submit"}
+        </button>
+      </form>
+    </div>
+  );
+}

package/template/extras/src/app/api/auth/[...nextauth]/route.ts

@@ -0,0 +1,4 @@
+import { handlers } from "@/server/auth"; // Referring to the auth.ts we just created
+
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+export const { GET, POST } = handlers;

package/template/extras/src/app/api/trpc/[trpc]/route.ts

@@ -0,0 +1,34 @@
+import { fetchRequestHandler } from "@trpc/server/adapters/fetch";
+import { type NextRequest } from "next/server";
+
+import { env } from "~/env";
+import { appRouter } from "~/server/api/root";
+import { createTRPCContext } from "~/server/api/trpc";
+
+/**
+ * This wraps the `createTRPCContext` helper and provides the required context for the tRPC API when
+ * handling a HTTP request (e.g. when you make requests from Client Components).
+ */
+const createContext = async (req: NextRequest) => {
+  return createTRPCContext({
+    headers: req.headers,
+  });
+};
+
+const handler = (req: NextRequest) =>
+  fetchRequestHandler({
+    endpoint: "/api/trpc",
+    req,
+    router: appRouter,
+    createContext: () => createContext(req),
+    onError:
+      env.NODE_ENV === "development"
+        ? ({ path, error }) => {
+            console.error(
+              `❌ tRPC failed on ${path ?? "<no-path>"}: ${error.message}`
+            );
+          }
+        : undefined,
+  });
+
+export { handler as GET, handler as POST };

package/template/extras/src/app/clerk-auth/layout.tsx

@@ -0,0 +1,10 @@
+import { Center } from "@mantine/core";
+import React from "react";
+
+export default function AuthLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return <Center h="100vh">{children}</Center>;
+}

package/template/extras/src/app/clerk-auth/signin/[[...sign-in]]/page.tsx

@@ -0,0 +1,5 @@
+import { SignIn } from "@clerk/nextjs";
+
+export default function Page() {
+  return <SignIn />;
+}