create-vexcms 0.0.20 → 0.1.0-alpha.2

package/templates/base-nextjs/src/vex.types.ts

@@ -0,0 +1,293 @@
+// ⚠️ AUTO-GENERATED BY VEX CMS — DO NOT EDIT ⚠️
+// Run 'vex dev' or 'vex generate' to update this file.
+
+/* eslint-disable perfectionist/sort-union-types */
+/* eslint-disable perfectionist/sort-interfaces */
+/* eslint-disable perfectionist/sort-modules */
+
+import type { Id } from "@convex/_generated/dataModel"
+import type { VexDocument, VexDocumentGlobal } from "@vexcms/core"
+
+export interface UserDocument extends VexDocument {
+  _id: Id<"user">
+  name: string
+  email: string
+  emailVerified: boolean
+  image?: string
+  createdAt: number
+  updatedAt: number
+  role?: string
+  banned?: boolean
+  banReason?: string
+  banExpires?: number
+  isAnonymous?: boolean
+  userId?: string
+  roles: string[]
+}
+
+export interface SessionDocument extends VexDocument {
+  _id: Id<"session">
+  expiresAt: number
+  token: string
+  createdAt: number
+  updatedAt: number
+  ipAddress?: string
+  userAgent?: string
+  userId: string
+  impersonatedBy?: string
+  activeOrganizationId?: string
+}
+
+export interface AccountDocument extends VexDocument {
+  _id: Id<"account">
+  accountId: string
+  providerId: string
+  userId: string
+  accessToken?: string
+  refreshToken?: string
+  idToken?: string
+  accessTokenExpiresAt?: number
+  refreshTokenExpiresAt?: number
+  scope?: string
+  password?: string
+  createdAt: number
+  updatedAt: number
+}
+
+export interface VerificationDocument extends VexDocument {
+  _id: Id<"verification">
+  identifier: string
+  value: string
+  expiresAt: number
+  createdAt: number
+  updatedAt: number
+}
+
+export interface ApikeyDocument extends VexDocument {
+  _id: Id<"apikey">
+  configId: string
+  name?: string
+  start?: string
+  referenceId: string
+  prefix?: string
+  key: string
+  refillInterval?: number
+  refillAmount?: number
+  lastRefillAt?: number
+  enabled?: boolean
+  rateLimitEnabled?: boolean
+  rateLimitTimeWindow?: number
+  rateLimitMax?: number
+  requestCount?: number
+  remaining?: number
+  lastRequest?: number
+  expiresAt?: number
+  createdAt: number
+  updatedAt: number
+  permissions?: string
+  metadata?: string
+}
+
+export interface JwksDocument extends VexDocument {
+  _id: Id<"jwks">
+  publicKey: string
+  privateKey: string
+  createdAt: number
+  expiresAt?: number
+}
+
+export interface OrganizationDocument extends VexDocument {
+  _id: Id<"organization">
+  name: string
+  slug: string
+  logo?: string
+  createdAt: number
+  metadata?: string
+}
+
+export interface MemberDocument extends VexDocument {
+  _id: Id<"member">
+  organizationId: string
+  userId: string
+  role: string
+  createdAt: number
+}
+
+export interface InvitationDocument extends VexDocument {
+  _id: Id<"invitation">
+  organizationId: string
+  email: string
+  role?: string
+  status: string
+  expiresAt: number
+  createdAt: number
+  inviterId: string
+}
+
+export interface Image extends VexDocument {
+  _id: Id<"images">
+  filename: string
+  alt: string
+  mimeType: string
+  size: number
+  storageId: string
+  deleted?: boolean
+  src: string
+  width?: number
+  height?: number
+}
+
+export type CollectionSlug =
+  | "user"
+  | "session"
+  | "account"
+  | "verification"
+  | "apikey"
+  | "jwks"
+  | "organization"
+  | "member"
+  | "invitation"
+  | "images"
+
+export type GlobalSlug = never
+
+export type MediaCollectionSlug = "images"
+
+export type StorageAdapterSlug = "convex"
+
+export type DocumentBySlug = {
+  user: UserDocument
+  session: SessionDocument
+  account: AccountDocument
+  verification: VerificationDocument
+  apikey: ApikeyDocument
+  jwks: JwksDocument
+  organization: OrganizationDocument
+  member: MemberDocument
+  invitation: InvitationDocument
+  images: Image
+}
+
+declare module "@vexcms/core" {
+  interface GeneratedVexTypes {
+    CollectionSlug:
+      | "user"
+      | "session"
+      | "account"
+      | "verification"
+      | "apikey"
+      | "jwks"
+      | "organization"
+      | "member"
+      | "invitation"
+      | "images"
+    GlobalSlug: never
+    MediaCollectionSlug: "images"
+    StorageAdapterSlug: "convex"
+    DocumentBySlug: {
+      user: UserDocument
+      session: SessionDocument
+      account: AccountDocument
+      verification: VerificationDocument
+      apikey: ApikeyDocument
+      jwks: JwksDocument
+      organization: OrganizationDocument
+      member: MemberDocument
+      invitation: InvitationDocument
+      images: Image
+    }
+    GlobalDocumentBySlug: {}
+    CollectionsFieldTypeMap: {
+      user: {
+        text: "name" | "email" | "image" | "role" | "banReason" | "userId"
+        checkbox: "emailVerified" | "banned" | "isAnonymous"
+        date: "createdAt" | "updatedAt" | "banExpires"
+        array: "roles"
+      }
+      session: {
+        date: "expiresAt" | "createdAt" | "updatedAt"
+        text:
+          "token" | "ipAddress" | "userAgent" | "userId" | "impersonatedBy" | "activeOrganizationId"
+      }
+      account: {
+        text:
+          | "accountId"
+          | "providerId"
+          | "userId"
+          | "accessToken"
+          | "refreshToken"
+          | "idToken"
+          | "scope"
+          | "password"
+        date: "accessTokenExpiresAt" | "refreshTokenExpiresAt" | "createdAt" | "updatedAt"
+      }
+      verification: {
+        text: "identifier" | "value"
+        date: "expiresAt" | "createdAt" | "updatedAt"
+      }
+      apikey: {
+        text:
+          | "configId"
+          | "name"
+          | "start"
+          | "referenceId"
+          | "prefix"
+          | "key"
+          | "permissions"
+          | "metadata"
+        number:
+          | "refillInterval"
+          | "refillAmount"
+          | "rateLimitTimeWindow"
+          | "rateLimitMax"
+          | "requestCount"
+          | "remaining"
+        date: "lastRefillAt" | "lastRequest" | "expiresAt" | "createdAt" | "updatedAt"
+        checkbox: "enabled" | "rateLimitEnabled"
+      }
+      jwks: {
+        text: "publicKey" | "privateKey"
+        date: "createdAt" | "expiresAt"
+      }
+      organization: {
+        text: "name" | "slug" | "logo" | "metadata"
+        date: "createdAt"
+      }
+      member: {
+        text: "organizationId" | "userId" | "role"
+        date: "createdAt"
+      }
+      invitation: {
+        text: "organizationId" | "email" | "role" | "status" | "inviterId"
+        date: "expiresAt" | "createdAt"
+      }
+      images: {
+        text: "filename" | "alt" | "mimeType" | "storageId" | "src"
+        number: "size" | "width" | "height"
+        checkbox: "deleted"
+      }
+    }
+    GlobalsFieldTypeMap: {}
+    IndexFieldsBySlug: {
+      user: { by_email: readonly ["email"] }
+      session: { by_token: readonly ["token"]; by_userId: readonly ["userId"] }
+      account: { by_userId: readonly ["userId"] }
+      verification: { by_identifier: readonly ["identifier"] }
+      apikey: {
+        by_configId: readonly ["configId"]
+        by_referenceId: readonly ["referenceId"]
+        by_key: readonly ["key"]
+      }
+      jwks: {}
+      organization: { by_slug: readonly ["slug"] }
+      member: { by_organizationId: readonly ["organizationId"]; by_userId: readonly ["userId"] }
+      invitation: { by_organizationId: readonly ["organizationId"]; by_email: readonly ["email"] }
+      images: { by_deleted: readonly ["deleted"] }
+    }
+    CustomActionsBySlug: {}
+    AuthSlugs: {
+      user: "user"
+      organization: "organization"
+    }
+  }
+}

package/templates/base-nextjs/src/vexcms/collections/images.ts

@@ -0,0 +1,15 @@
+import { defineMediaCollection } from "@vexcms/file-storage-convex";
+
+import { TABLE_SLUG_IMAGES } from "~/db/constants";
+
+export const images = defineMediaCollection({
+  slug: TABLE_SLUG_IMAGES,
+  admin: {
+    icon: "Image",
+  },
+  labels: {
+    singular: "Image",
+    plural: "Images",
+  },
+  interfaceName: "Image",
+});

package/templates/base-nextjs/src/vexcms/collections/index.ts

@@ -1 +1,2 @@
-// Add your collection exports here
+export * from "./images"
+export * from "./users"

package/templates/base-nextjs/src/vexcms/collections/users.ts

@@ -1,46 +1,18 @@
-import { checkbox, defineCollection, imageUrl, select, text } from "@vexcms/core"
+import { defineCollection } from "@vexcms/core"
 
 import { TABLE_SLUG_USERS } from "~/db/constants"
-import { auth } from "~/vexcms/auth"
 
 export const users = defineCollection({
   slug: TABLE_SLUG_USERS,
   admin: {
-    defaultColumns: ["name", "email", "createdAt", "role"],
-    group: "Admin",
-    useAsTitle: "name",
-  },
-  auth,
-  fields: {
-    name: text({
-      label: "Name",
-      required: true,
-    }),
-    image: imageUrl({
-      label: "Image",
-    }),
-    role: select({
-      defaultValue: "user",
-      hasMany: true,
-      labels: {
-        plural: "Roles",
-        singular: "Role",
-      },
-      options: [
-        { label: "Admin", value: "admin" },
-        { label: "Editor", value: "editor" },
-        { label: "User", value: "user" },
-      ],
-      required: true,
-    }),
-    vex_onboarding_complete: checkbox({
-      admin: { hidden: true },
-      defaultValue: false,
-      label: "Onboarding Complete",
-    }),
+    icon: "Users",
   },
   labels: {
-    plural: "Users",
     singular: "User",
+    plural: "Users",
+  },
+  fields: {
+    // Add custom user fields here — the auth adapter already contributes
+    // name/email/roles/etc. from Better Auth's schema.
   },
 })

package/templates/base-nextjs/tsconfig.json

@@ -22,6 +22,9 @@
         "name": "next"
       }
     ],
+    "customConditions": [
+      "source"
+    ],
     "paths": {
       "~/*": [
         "./src/*"

package/templates/marketing-site/convex/_generated/api.d.ts

@@ -0,0 +1,81 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type * as auth_api from "../auth/api.js";
+import type * as auth_db from "../auth/db.js";
+import type * as auth_index from "../auth/index.js";
+import type * as auth_options from "../auth/options.js";
+import type * as auth_plugins_index from "../auth/plugins/index.js";
+import type * as auth_sessions from "../auth/sessions.js";
+import type * as footers from "../footers.js";
+import type * as headers from "../headers.js";
+import type * as http from "../http.js";
+import type * as pages from "../pages.js";
+import type * as seed from "../seed.js";
+import type * as siteSettings from "../siteSettings.js";
+import type * as theme from "../theme.js";
+import type * as vex from "../vex.js";
+import type * as vex_firstUser from "../vex/firstUser.js";
+import type * as vex_globals from "../vex/globals.js";
+import type * as vex_media from "../vex/media.js";
+
+import type {
+  ApiFromModules,
+  FilterApi,
+  FunctionReference,
+} from "convex/server";
+
+declare const fullApi: ApiFromModules<{
+  "auth/api": typeof auth_api;
+  "auth/db": typeof auth_db;
+  "auth/index": typeof auth_index;
+  "auth/options": typeof auth_options;
+  "auth/plugins/index": typeof auth_plugins_index;
+  "auth/sessions": typeof auth_sessions;
+  footers: typeof footers;
+  headers: typeof headers;
+  http: typeof http;
+  pages: typeof pages;
+  seed: typeof seed;
+  siteSettings: typeof siteSettings;
+  theme: typeof theme;
+  vex: typeof vex;
+  "vex/firstUser": typeof vex_firstUser;
+  "vex/globals": typeof vex_globals;
+  "vex/media": typeof vex_media;
+}>;
+
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export declare const api: FilterApi<
+  typeof fullApi,
+  FunctionReference<any, "public">
+>;
+
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export declare const internal: FilterApi<
+  typeof fullApi,
+  FunctionReference<any, "internal">
+>;
+
+export declare const components: {};

package/templates/marketing-site/convex/_generated/api.js

@@ -0,0 +1,23 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import { anyApi, componentsGeneric } from "convex/server";
+
+/**
+ * A utility for referencing Convex functions in your app's API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+export const internal = anyApi;
+export const components = componentsGeneric();

package/templates/marketing-site/convex/_generated/dataModel.d.ts

@@ -0,0 +1,60 @@
+/* eslint-disable */
+/**
+ * Generated data model types.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type {
+  DataModelFromSchemaDefinition,
+  DocumentByName,
+  TableNamesInDataModel,
+  SystemTableNames,
+} from "convex/server";
+import type { GenericId } from "convex/values";
+import schema from "../schema.js";
+
+/**
+ * The names of all of your Convex tables.
+ */
+export type TableNames = TableNamesInDataModel<DataModel>;
+
+/**
+ * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Doc<TableName extends TableNames> = DocumentByName<
+  DataModel,
+  TableName
+>;
+
+/**
+ * An identifier for a document in Convex.
+ *
+ * Convex documents are uniquely identified by their `Id`, which is accessible
+ * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
+ *
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
+ *
+ * IDs are just strings at runtime, but this type can be used to distinguish them from other
+ * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Id<TableName extends TableNames | SystemTableNames> =
+  GenericId<TableName>;
+
+/**
+ * A type describing your Convex data model.
+ *
+ * This type includes information about what tables you have, the type of
+ * documents stored in those tables, and the indexes defined on them.
+ *
+ * This type is used to parameterize methods like `queryGeneric` and
+ * `mutationGeneric` to make them type-safe.
+ */
+export type DataModel = DataModelFromSchemaDefinition<typeof schema>;

package/templates/marketing-site/convex/_generated/server.d.ts

@@ -0,0 +1,162 @@
+/* eslint-disable */
+/**
+ * Generated utilities for implementing server-side Convex query and mutation functions.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import {
+  ActionBuilder,
+  HttpActionBuilder,
+  MutationBuilder,
+  QueryBuilder,
+  GenericActionCtx,
+  GenericMutationCtx,
+  GenericQueryCtx,
+  GenericDatabaseReader,
+  GenericDatabaseWriter,
+} from "convex/server";
+import type { DataModel } from "./dataModel.js";
+
+/**
+ * Typesafe environment variables.
+ *
+ * This includes platform-provided env vars and any variables declared in
+ * `convex.config.ts`.
+ */
+type Env = {
+  readonly CONVEX_CLOUD_URL: string;
+  readonly CONVEX_SITE_URL: string;
+};
+
+/**
+ * Define a query in this Convex app's public API.
+ *
+ * This function will be allowed to read your Convex database and will be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export declare const query: QueryBuilder<DataModel, "public">;
+
+/**
+ * Define a query that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to read from your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalQuery: QueryBuilder<DataModel, "internal">;
+
+/**
+ * Define a mutation in this Convex app's public API.
+ *
+ * This function will be allowed to modify your Convex database and will be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export declare const mutation: MutationBuilder<DataModel, "public">;
+
+/**
+ * Define a mutation that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to modify your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalMutation: MutationBuilder<DataModel, "internal">;
+
+/**
+ * Define an action in this Convex app's public API.
+ *
+ * An action is a function which can execute any JavaScript code, including non-deterministic
+ * code and code with side-effects, like calling third-party services.
+ * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
+ * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
+ *
+ * @param func - The action. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
+ */
+export declare const action: ActionBuilder<DataModel, "public">;
+
+/**
+ * Define an action that is only accessible from other Convex functions (but not from the client).
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalAction: ActionBuilder<DataModel, "internal">;
+
+/**
+ * Define an HTTP action.
+ *
+ * The wrapped function will be used to respond to HTTP requests received
+ * by a Convex deployment if the requests matches the path and method where
+ * this action is routed. Be sure to route your httpAction in `convex/http.js`.
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument
+ * and a Fetch API `Request` object as its second.
+ * @returns The wrapped function. Import this function from `convex/http.js` and route it to hook it up.
+ */
+export declare const httpAction: HttpActionBuilder;
+
+/**
+ * Typesafe environment variables.
+ *
+ * This includes platform-provided env vars and any variables declared in
+ * `convex.config.ts`.
+ */
+export declare const env: Env;
+
+/**
+ * A set of services for use within Convex query functions.
+ *
+ * The query context is passed as the first argument to any Convex query
+ * function run on the server.
+ *
+ * This differs from the {@link MutationCtx} because all of the services are
+ * read-only.
+ */
+export type QueryCtx = GenericQueryCtx<DataModel>;
+
+/**
+ * A set of services for use within Convex mutation functions.
+ *
+ * The mutation context is passed as the first argument to any Convex mutation
+ * function run on the server.
+ */
+export type MutationCtx = GenericMutationCtx<DataModel>;
+
+/**
+ * A set of services for use within Convex action functions.
+ *
+ * The action context is passed as the first argument to any Convex action
+ * function run on the server.
+ */
+export type ActionCtx = GenericActionCtx<DataModel>;
+
+/**
+ * An interface to read from the database within Convex query functions.
+ *
+ * The two entry points are {@link DatabaseReader.get}, which fetches a single
+ * document by its {@link Id}, or {@link DatabaseReader.query}, which starts
+ * building a query.
+ */
+export type DatabaseReader = GenericDatabaseReader<DataModel>;
+
+/**
+ * An interface to read from and write to the database within Convex mutation
+ * functions.
+ *
+ * Convex guarantees that all writes within a single mutation are
+ * executed atomically, so you never have to worry about partial writes leaving
+ * your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control)
+ * for the guarantees Convex provides your functions.
+ */
+export type DatabaseWriter = GenericDatabaseWriter<DataModel>;