@btst/stack 2.12.2 → 3.0.0-rc.2

package/dist/shared/{stack.CO1g47IS.d.mts → stack.C1ATQ3pd.d.ts}

@@ -1,5 +1,5 @@
 import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
-import { d as Comment, S as SerializedComment, C as CommentListResult } from './stack.C7KNNiJm.mjs';
+import { a as Comment, S as SerializedComment, C as CommentListResult } from './stack.C3GBG8in.js';
 import * as better_call from 'better-call';
 import { z } from 'zod';
 
@@ -331,5 +331,86 @@ declare const commentsBackendPlugin: (options: CommentsBackendOptions) => _btst_
 }>;
 type CommentsApiRouter = ReturnType<ReturnType<typeof commentsBackendPlugin>["routes"]>;
 
-export { CommentListParamsSchema as a, CommentCountQuerySchema as b, commentsBackendPlugin as c };
-export type { CommentsApiRouter as C, CommentsApiContext as d, CommentsBackendOptions as e };
+/**
+ * Internal query key constants for the Comments plugin.
+ * Shared between query-keys.ts (HTTP path) and any SSG/direct DB path
+ * to prevent key drift between loaders and prefetch calls.
+ */
+interface CommentsListDiscriminator {
+    resourceId: string | undefined;
+    resourceType: string | undefined;
+    parentId: string | null | undefined;
+    status: string | undefined;
+    currentUserId: string | undefined;
+    authorId: string | undefined;
+    sort: string | undefined;
+    limit: number;
+    offset: number;
+}
+interface CommentCountDiscriminator {
+    resourceId: string;
+    resourceType: string;
+    status: string | undefined;
+}
+/**
+ * Discriminator for the infinite thread query (top-level comments only).
+ * Intentionally excludes `offset` — pages are driven by `pageParam`, not the key.
+ */
+interface CommentsThreadDiscriminator {
+    resourceId: string | undefined;
+    resourceType: string | undefined;
+    parentId: string | null | undefined;
+    status: string | undefined;
+    currentUserId: string | undefined;
+    sort: string | undefined;
+    limit: number;
+}
+/** Full query key builders — use with queryClient.setQueryData() */
+declare const COMMENTS_QUERY_KEYS: {
+    /**
+     * Key for comments list query.
+     * Full key: ["comments", "list", { resourceId, resourceType, parentId, status, currentUserId, limit, offset }]
+     */
+    commentsList: (params?: {
+        resourceId?: string;
+        resourceType?: string;
+        parentId?: string | null;
+        status?: string;
+        currentUserId?: string;
+        authorId?: string;
+        sort?: string;
+        limit?: number;
+        offset?: number;
+    }) => readonly ["comments", "list", CommentsListDiscriminator];
+    /**
+     * Key for a single comment detail query.
+     * Full key: ["comments", "detail", id]
+     */
+    commentDetail: (id: string) => readonly ["comments", "detail", string];
+    /**
+     * Key for comment count query.
+     * Full key: ["comments", "count", { resourceId, resourceType, status }]
+     */
+    commentCount: (params: {
+        resourceId: string;
+        resourceType: string;
+        status?: string;
+    }) => readonly ["comments", "count", CommentCountDiscriminator];
+    /**
+     * Key for the infinite thread query (top-level comments, load-more).
+     * Full key: ["commentsThread", "list", { resourceId, resourceType, parentId, status, currentUserId, sort, limit }]
+     * Offset is excluded — it is driven by `pageParam`, not baked into the key.
+     */
+    commentsThread: (params?: {
+        resourceId?: string;
+        resourceType?: string;
+        parentId?: string | null;
+        status?: string;
+        currentUserId?: string;
+        sort?: string;
+        limit?: number;
+    }) => readonly ["commentsThread", "list", CommentsThreadDiscriminator];
+};
+
+export { CommentListParamsSchema as d, CommentCountQuerySchema as e, commentsBackendPlugin as f, COMMENTS_QUERY_KEYS as i };
+export type { CommentsListDiscriminator as C, CommentCountDiscriminator as a, CommentsThreadDiscriminator as b, CommentsApiRouter as c, CommentsApiContext as g, CommentsBackendOptions as h };

package/dist/shared/stack.C3GBG8in.d.cts

@@ -0,0 +1,62 @@
+/**
+ * Comment status values
+ */
+type CommentStatus = "pending" | "approved" | "spam";
+/**
+ * A comment record as stored in the database
+ */
+type Comment = {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    body: string;
+    status: CommentStatus;
+    likes: number;
+    editedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * A comment enriched with server-resolved author info and like status.
+ * All dates are ISO strings (safe for serialisation over HTTP / React Query cache).
+ */
+interface SerializedComment {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    /** Resolved from resolveUser(authorId). Falls back to "[deleted]" when user cannot be found. */
+    resolvedAuthorName: string;
+    /** Resolved avatar URL or null */
+    resolvedAvatarUrl: string | null;
+    body: string;
+    status: CommentStatus;
+    /** Denormalized counter — updated atomically on toggleLike */
+    likes: number;
+    /** True when the currentUserId query param matches an existing commentLike row */
+    isLikedByCurrentUser: boolean;
+    /** ISO string set when the comment body was edited; null for unedited comments */
+    editedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    /**
+     * Number of direct replies visible to the requesting user.
+     * Includes approved replies plus any pending replies authored by `currentUserId`.
+     * Always 0 for reply comments (non-null parentId).
+     */
+    replyCount: number;
+}
+/**
+ * Paginated list result for comments
+ */
+interface CommentListResult {
+    items: SerializedComment[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+
+export type { CommentListResult as C, SerializedComment as S, Comment as a };

package/dist/shared/stack.C3GBG8in.d.mts

@@ -0,0 +1,62 @@
+/**
+ * Comment status values
+ */
+type CommentStatus = "pending" | "approved" | "spam";
+/**
+ * A comment record as stored in the database
+ */
+type Comment = {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    body: string;
+    status: CommentStatus;
+    likes: number;
+    editedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * A comment enriched with server-resolved author info and like status.
+ * All dates are ISO strings (safe for serialisation over HTTP / React Query cache).
+ */
+interface SerializedComment {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    /** Resolved from resolveUser(authorId). Falls back to "[deleted]" when user cannot be found. */
+    resolvedAuthorName: string;
+    /** Resolved avatar URL or null */
+    resolvedAvatarUrl: string | null;
+    body: string;
+    status: CommentStatus;
+    /** Denormalized counter — updated atomically on toggleLike */
+    likes: number;
+    /** True when the currentUserId query param matches an existing commentLike row */
+    isLikedByCurrentUser: boolean;
+    /** ISO string set when the comment body was edited; null for unedited comments */
+    editedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    /**
+     * Number of direct replies visible to the requesting user.
+     * Includes approved replies plus any pending replies authored by `currentUserId`.
+     * Always 0 for reply comments (non-null parentId).
+     */
+    replyCount: number;
+}
+/**
+ * Paginated list result for comments
+ */
+interface CommentListResult {
+    items: SerializedComment[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+
+export type { CommentListResult as C, SerializedComment as S, Comment as a };

package/dist/shared/stack.C3GBG8in.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Comment status values
+ */
+type CommentStatus = "pending" | "approved" | "spam";
+/**
+ * A comment record as stored in the database
+ */
+type Comment = {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    body: string;
+    status: CommentStatus;
+    likes: number;
+    editedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * A comment enriched with server-resolved author info and like status.
+ * All dates are ISO strings (safe for serialisation over HTTP / React Query cache).
+ */
+interface SerializedComment {
+    id: string;
+    resourceId: string;
+    resourceType: string;
+    parentId: string | null;
+    authorId: string;
+    /** Resolved from resolveUser(authorId). Falls back to "[deleted]" when user cannot be found. */
+    resolvedAuthorName: string;
+    /** Resolved avatar URL or null */
+    resolvedAvatarUrl: string | null;
+    body: string;
+    status: CommentStatus;
+    /** Denormalized counter — updated atomically on toggleLike */
+    likes: number;
+    /** True when the currentUserId query param matches an existing commentLike row */
+    isLikedByCurrentUser: boolean;
+    /** ISO string set when the comment body was edited; null for unedited comments */
+    editedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    /**
+     * Number of direct replies visible to the requesting user.
+     * Includes approved replies plus any pending replies authored by `currentUserId`.
+     * Always 0 for reply comments (non-null parentId).
+     */
+    replyCount: number;
+}
+/**
+ * Paginated list result for comments
+ */
+interface CommentListResult {
+    items: SerializedComment[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+
+export type { CommentListResult as C, SerializedComment as S, Comment as a };

package/dist/shared/stack.C4_gEENS.d.cts

@@ -0,0 +1,97 @@
+/**
+ * Shared auth contract types used by both the client provider
+ * (`@btst/stack/context`) and the backend (`@btst/stack/api`).
+ *
+ * This module is intentionally type-only so it can be imported from server
+ * and client code alike.
+ */
+/**
+ * The identity of the current user as resolved by an auth provider.
+ * Extra provider-specific fields are allowed.
+ */
+interface StackIdentity {
+    /** Unique user id */
+    id: string;
+    /** Display name */
+    name?: string;
+    /** Email address */
+    email?: string;
+    /** Avatar image URL */
+    image?: string;
+    /** Additional provider-specific fields */
+    [key: string]: unknown;
+}
+/**
+ * A permission check request: "can the current user perform `action` on
+ * `resource`?" (e.g. resource `"blog:post"`, action `"delete"`).
+ */
+interface CanParams {
+    /** The resource being accessed (e.g. "blog:post", "comments:moderate") */
+    resource: string;
+    /** The action being performed (e.g. "read", "create", "delete") */
+    action: string;
+    /** Optional extra parameters (e.g. the specific record id) */
+    params?: Record<string, unknown>;
+}
+/**
+ * Client-side auth provider, passed to `StackProvider` via the `auth` prop.
+ *
+ * All fields besides `getIdentity` are optional:
+ * - Without `can`, every permission check resolves to `true`.
+ * - Without `loginPath`, denied route access is not redirected.
+ *
+ * @example
+ * ```tsx
+ * const authProvider: StackAuthProvider = {
+ *   getIdentity: () => authClient.getSession().then((s) => s?.user ?? null),
+ *   can: ({ resource, action }) => checkPermission(resource, action),
+ *   loginPath: "/login",
+ * };
+ *
+ * <StackProvider auth={authProvider} ...>
+ * ```
+ */
+interface StackAuthProvider {
+    /**
+     * Resolve the current user's identity. Return `null` when unauthenticated.
+     */
+    getIdentity: () => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Permission check. When omitted, all `useCan()` / `<CanAccess>` checks
+     * resolve to `true`.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+    }) => Promise<boolean> | boolean;
+    /**
+     * Path unauthenticated users are redirected to when route-level permission
+     * checks deny access (e.g. "/login").
+     */
+    loginPath?: string;
+}
+/**
+ * Server-side auth provider, passed to `stack()` via the `auth` config option.
+ * `stack()` resolves the identity lazily and at most once per request; plugin
+ * lifecycle hooks can read it via `getRequestIdentity(headers)` from
+ * `@btst/stack/api`.
+ */
+interface StackServerAuthProvider {
+    /**
+     * Resolve the identity for an incoming request (e.g. from a session
+     * cookie). Return `null` when unauthenticated.
+     */
+    getIdentity: (ctx: {
+        headers: Headers;
+        request: Request;
+    }) => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Optional server-side permission check, for consumers and plugins that
+     * want to share one `can` implementation across lifecycle hooks.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+        headers: Headers;
+    }) => Promise<boolean> | boolean;
+}
+
+export type { CanParams as C, StackServerAuthProvider as S, StackAuthProvider as a, StackIdentity as b };

package/dist/shared/stack.C4_gEENS.d.mts

@@ -0,0 +1,97 @@
+/**
+ * Shared auth contract types used by both the client provider
+ * (`@btst/stack/context`) and the backend (`@btst/stack/api`).
+ *
+ * This module is intentionally type-only so it can be imported from server
+ * and client code alike.
+ */
+/**
+ * The identity of the current user as resolved by an auth provider.
+ * Extra provider-specific fields are allowed.
+ */
+interface StackIdentity {
+    /** Unique user id */
+    id: string;
+    /** Display name */
+    name?: string;
+    /** Email address */
+    email?: string;
+    /** Avatar image URL */
+    image?: string;
+    /** Additional provider-specific fields */
+    [key: string]: unknown;
+}
+/**
+ * A permission check request: "can the current user perform `action` on
+ * `resource`?" (e.g. resource `"blog:post"`, action `"delete"`).
+ */
+interface CanParams {
+    /** The resource being accessed (e.g. "blog:post", "comments:moderate") */
+    resource: string;
+    /** The action being performed (e.g. "read", "create", "delete") */
+    action: string;
+    /** Optional extra parameters (e.g. the specific record id) */
+    params?: Record<string, unknown>;
+}
+/**
+ * Client-side auth provider, passed to `StackProvider` via the `auth` prop.
+ *
+ * All fields besides `getIdentity` are optional:
+ * - Without `can`, every permission check resolves to `true`.
+ * - Without `loginPath`, denied route access is not redirected.
+ *
+ * @example
+ * ```tsx
+ * const authProvider: StackAuthProvider = {
+ *   getIdentity: () => authClient.getSession().then((s) => s?.user ?? null),
+ *   can: ({ resource, action }) => checkPermission(resource, action),
+ *   loginPath: "/login",
+ * };
+ *
+ * <StackProvider auth={authProvider} ...>
+ * ```
+ */
+interface StackAuthProvider {
+    /**
+     * Resolve the current user's identity. Return `null` when unauthenticated.
+     */
+    getIdentity: () => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Permission check. When omitted, all `useCan()` / `<CanAccess>` checks
+     * resolve to `true`.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+    }) => Promise<boolean> | boolean;
+    /**
+     * Path unauthenticated users are redirected to when route-level permission
+     * checks deny access (e.g. "/login").
+     */
+    loginPath?: string;
+}
+/**
+ * Server-side auth provider, passed to `stack()` via the `auth` config option.
+ * `stack()` resolves the identity lazily and at most once per request; plugin
+ * lifecycle hooks can read it via `getRequestIdentity(headers)` from
+ * `@btst/stack/api`.
+ */
+interface StackServerAuthProvider {
+    /**
+     * Resolve the identity for an incoming request (e.g. from a session
+     * cookie). Return `null` when unauthenticated.
+     */
+    getIdentity: (ctx: {
+        headers: Headers;
+        request: Request;
+    }) => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Optional server-side permission check, for consumers and plugins that
+     * want to share one `can` implementation across lifecycle hooks.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+        headers: Headers;
+    }) => Promise<boolean> | boolean;
+}
+
+export type { CanParams as C, StackServerAuthProvider as S, StackAuthProvider as a, StackIdentity as b };

package/dist/shared/stack.C4_gEENS.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Shared auth contract types used by both the client provider
+ * (`@btst/stack/context`) and the backend (`@btst/stack/api`).
+ *
+ * This module is intentionally type-only so it can be imported from server
+ * and client code alike.
+ */
+/**
+ * The identity of the current user as resolved by an auth provider.
+ * Extra provider-specific fields are allowed.
+ */
+interface StackIdentity {
+    /** Unique user id */
+    id: string;
+    /** Display name */
+    name?: string;
+    /** Email address */
+    email?: string;
+    /** Avatar image URL */
+    image?: string;
+    /** Additional provider-specific fields */
+    [key: string]: unknown;
+}
+/**
+ * A permission check request: "can the current user perform `action` on
+ * `resource`?" (e.g. resource `"blog:post"`, action `"delete"`).
+ */
+interface CanParams {
+    /** The resource being accessed (e.g. "blog:post", "comments:moderate") */
+    resource: string;
+    /** The action being performed (e.g. "read", "create", "delete") */
+    action: string;
+    /** Optional extra parameters (e.g. the specific record id) */
+    params?: Record<string, unknown>;
+}
+/**
+ * Client-side auth provider, passed to `StackProvider` via the `auth` prop.
+ *
+ * All fields besides `getIdentity` are optional:
+ * - Without `can`, every permission check resolves to `true`.
+ * - Without `loginPath`, denied route access is not redirected.
+ *
+ * @example
+ * ```tsx
+ * const authProvider: StackAuthProvider = {
+ *   getIdentity: () => authClient.getSession().then((s) => s?.user ?? null),
+ *   can: ({ resource, action }) => checkPermission(resource, action),
+ *   loginPath: "/login",
+ * };
+ *
+ * <StackProvider auth={authProvider} ...>
+ * ```
+ */
+interface StackAuthProvider {
+    /**
+     * Resolve the current user's identity. Return `null` when unauthenticated.
+     */
+    getIdentity: () => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Permission check. When omitted, all `useCan()` / `<CanAccess>` checks
+     * resolve to `true`.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+    }) => Promise<boolean> | boolean;
+    /**
+     * Path unauthenticated users are redirected to when route-level permission
+     * checks deny access (e.g. "/login").
+     */
+    loginPath?: string;
+}
+/**
+ * Server-side auth provider, passed to `stack()` via the `auth` config option.
+ * `stack()` resolves the identity lazily and at most once per request; plugin
+ * lifecycle hooks can read it via `getRequestIdentity(headers)` from
+ * `@btst/stack/api`.
+ */
+interface StackServerAuthProvider {
+    /**
+     * Resolve the identity for an incoming request (e.g. from a session
+     * cookie). Return `null` when unauthenticated.
+     */
+    getIdentity: (ctx: {
+        headers: Headers;
+        request: Request;
+    }) => Promise<StackIdentity | null> | StackIdentity | null;
+    /**
+     * Optional server-side permission check, for consumers and plugins that
+     * want to share one `can` implementation across lifecycle hooks.
+     */
+    can?: (params: CanParams & {
+        identity: StackIdentity | null;
+        headers: Headers;
+    }) => Promise<boolean> | boolean;
+}
+
+export type { CanParams as C, StackServerAuthProvider as S, StackAuthProvider as a, StackIdentity as b };