@btst/stack 2.8.1 → 2.9.1

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

@@ -0,0 +1,286 @@
+import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
+import { a as StorageAdapter, b as S3UploadToken } from './stack.BttDsJJn.js';
+import { c as AssetListResult, l as listAssets, a as listFolders, A as AssetListParams } from './stack.CYSwntXC.js';
+import * as better_call from 'better-call';
+import { z } from 'zod';
+import { A as Asset, F as Folder } from './stack.CLcnSF_b.js';
+
+declare const AssetListQuerySchema: z.ZodObject<{
+    folderId: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodOptional<z.ZodString>;
+    query: z.ZodOptional<z.ZodString>;
+    offset: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+declare const updateAssetSchema: z.ZodObject<{
+    alt: z.ZodOptional<z.ZodString>;
+    folderId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const createFolderSchema: z.ZodObject<{
+    name: z.ZodString;
+    parentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+
+/**
+ * Context passed to media API hooks.
+ */
+interface MediaApiContext<TBody = unknown, TParams = unknown, TQuery = unknown> {
+    body?: TBody;
+    params?: TParams;
+    query?: TQuery;
+    request?: Request;
+    headers?: Headers;
+    [key: string]: unknown;
+}
+/**
+ * Configuration hooks for the media backend plugin.
+ * All hooks are optional and allow consumers to customise behaviour.
+ */
+interface MediaBackendHooks {
+    /**
+     * Called before a file upload is allowed (both direct and signed adapters).
+     * Throw an Error to reject the upload (e.g. if the user is not authenticated).
+     */
+    onBeforeUpload?: (meta: {
+        filename: string;
+        mimeType: string;
+        size?: number;
+    }, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called after an asset record is created in the database.
+     */
+    onAfterUpload?: (asset: Asset, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before an asset is deleted. Throw to prevent deletion.
+     */
+    onBeforeDelete?: (asset: Asset, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called after an asset has been deleted from the DB and storage.
+     */
+    onAfterDelete?: (assetId: string, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before listing assets. Throw to deny access.
+     */
+    onBeforeListAssets?: (filter: z.infer<typeof AssetListQuerySchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before updating an asset (PATCH). Throw to deny access.
+     */
+    onBeforeUpdateAsset?: (asset: Asset, updates: z.infer<typeof updateAssetSchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before listing folders. Throw to deny access.
+     */
+    onBeforeListFolders?: (filter: {
+        parentId?: string;
+    }, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before creating a folder. Throw to deny access.
+     */
+    onBeforeCreateFolder?: (input: z.infer<typeof createFolderSchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before deleting a folder. Throw to deny access.
+     */
+    onBeforeDeleteFolder?: (folder: Folder, context: MediaApiContext) => Promise<void> | void;
+}
+/**
+ * Configuration for the media backend plugin.
+ */
+interface MediaBackendConfig {
+    /**
+     * The storage adapter to use for file uploads.
+     * - `localAdapter()` — writes to the local filesystem (dev / self-hosted)
+     * - `s3Adapter()` — presigned PUT URL (AWS S3, Cloudflare R2, MinIO)
+     * - `vercelBlobAdapter()` — signed direct upload via Vercel Blob
+     */
+    storageAdapter: StorageAdapter;
+    /**
+     * Maximum file size in bytes.
+     * Enforced server-side for `localAdapter`.
+     * Passed into the Vercel Blob token for edge enforcement.
+     * Validated against the client-reported size for `s3Adapter`.
+     * @default 10485760 (10 MB)
+     */
+    maxFileSizeBytes?: number;
+    /**
+     * MIME type allowlist (e.g. `["image/jpeg", "image/png"]`).
+     * If omitted, all MIME types are accepted.
+     * Enforced server-side for `localAdapter`.
+     * Passed to Vercel Blob token for edge enforcement.
+     * Validated against the client-reported MIME type for `s3Adapter`.
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * URL prefixes that are allowed when creating asset records via `POST /media/assets`.
+     * When omitted the plugin automatically derives a safe default from the storage adapter:
+     * - `s3Adapter` → the configured `publicBaseUrl`
+     * - `vercelBlobAdapter` → any URL whose hostname ends with `.public.blob.vercel-storage.com`
+     * - `localAdapter` → rejects client-supplied URLs; use `POST /media/upload` instead
+     *
+     * Provide this option only when you need to override the automatic default (e.g. to allow
+     * assets from a CDN in front of your storage that uses a different domain). When using
+     * `localAdapter`, setting `allowedUrlPrefixes` explicitly opts `POST /media/assets` back in.
+     */
+    allowedUrlPrefixes?: string[];
+    /**
+     * Optional lifecycle hooks for the media backend plugin.
+     */
+    hooks?: MediaBackendHooks;
+}
+/**
+ * Media backend plugin.
+ * Provides API endpoints for managing media assets and folders, and supports
+ * local, S3-compatible, and Vercel Blob storage backends.
+ *
+ * @example
+ * ```ts
+ * import { mediaBackendPlugin, localAdapter } from "@btst/stack/plugins/media/api";
+ *
+ * mediaBackendPlugin({
+ *   storageAdapter: localAdapter(),
+ *   hooks: {
+ *     onBeforeUpload: async (_meta, ctx) => {
+ *       const session = await getSession(ctx.headers as Headers);
+ *       if (!session) throw new Error("Unauthorized");
+ *     },
+ *   },
+ * })
+ * ```
+ */
+declare const mediaBackendPlugin: (config: MediaBackendConfig) => _btst_stack_plugins_api.BackendPlugin<{
+    readonly listAssets: better_call.StrictEndpoint<"/media/assets", {} & {
+        method: "GET";
+    } & {
+        query: better_call.StandardSchemaV1<{
+            folderId?: string | undefined;
+            mimeType?: string | undefined;
+            query?: string | undefined;
+            offset?: unknown;
+            limit?: unknown;
+        }, {
+            folderId?: string | undefined;
+            mimeType?: string | undefined;
+            query?: string | undefined;
+            offset?: unknown;
+            limit?: unknown;
+        }>;
+    }, AssetListResult>;
+    readonly createAsset: better_call.StrictEndpoint<"/media/assets", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            filename: string;
+            originalName: string;
+            mimeType: string;
+            size: number;
+            url: string;
+            folderId?: string | undefined;
+            alt?: string | undefined;
+        }, {
+            filename: string;
+            originalName: string;
+            mimeType: string;
+            size: number;
+            url: string;
+            folderId?: string | undefined;
+            alt?: string | undefined;
+        }>;
+    }, Asset>;
+    readonly updateAsset: better_call.StrictEndpoint<"/media/assets/:id", {} & {
+        method: "PATCH";
+        body: better_call.StandardSchemaV1<{
+            alt?: string | undefined;
+            folderId?: string | null | undefined;
+        }, {
+            alt?: string | undefined;
+            folderId?: string | null | undefined;
+        }>;
+    }, Asset>;
+    readonly deleteAsset: better_call.StrictEndpoint<"/media/assets/:id", {} & {
+        method: "DELETE";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, {
+        success: boolean;
+    }>;
+    readonly listFolders: better_call.StrictEndpoint<"/media/folders", {} & {
+        method: "GET";
+    } & {
+        query: better_call.StandardSchemaV1<{
+            parentId?: string | undefined;
+        }, {
+            parentId?: string | undefined;
+        }>;
+    }, Folder[]>;
+    readonly createFolder: better_call.StrictEndpoint<"/media/folders", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            name: string;
+            parentId?: string | undefined;
+        }, {
+            name: string;
+            parentId?: string | undefined;
+        }>;
+    }, Folder>;
+    readonly deleteFolder: better_call.StrictEndpoint<"/media/folders/:id", {} & {
+        method: "DELETE";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, {
+        success: boolean;
+    }>;
+    readonly uploadDirect: better_call.StrictEndpoint<"/media/upload", {
+        metadata: {
+            allowedMediaTypes: string[];
+        };
+    } & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, Asset>;
+    readonly uploadToken: better_call.StrictEndpoint<"/media/upload/token", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            filename: string;
+            mimeType: string;
+            size: number;
+            folderId?: string | undefined;
+        }, {
+            filename: string;
+            mimeType: string;
+            size: number;
+            folderId?: string | undefined;
+        }>;
+    }, S3UploadToken>;
+    readonly uploadVercelBlob: better_call.StrictEndpoint<"/media/upload/vercel-blob", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, unknown>;
+}, {
+    listAssets: (params?: Parameters<typeof listAssets>[1]) => Promise<AssetListResult>;
+    getAssetById: (id: string) => Promise<Asset | null>;
+    listFolders: (params?: Parameters<typeof listFolders>[1]) => Promise<Folder[]>;
+    getFolderById: (id: string) => Promise<Folder | null>;
+}>;
+type MediaApiRouter = ReturnType<ReturnType<typeof mediaBackendPlugin>["routes"]>;
+
+/**
+ * Internal query key constants for the media plugin.
+ * Shared between query-keys.ts (HTTP path) and any SSR/SSG prefetching
+ * to prevent key drift between client and server.
+ */
+
+/**
+ * Discriminator for the asset list cache key.
+ */
+interface AssetListDiscriminator {
+    folderId: string | undefined;
+    mimeType: string | undefined;
+    query: string | undefined;
+    limit: number | undefined;
+    offset: number | undefined;
+}
+declare function assetListDiscriminator(params?: AssetListParams): AssetListDiscriminator;
+/** Full query key builders — use these with `queryClient.setQueryData()`. */
+declare const MEDIA_QUERY_KEYS: {
+    assetsList: (params?: AssetListParams) => readonly ["media", "assets", "list", AssetListDiscriminator];
+    assetDetail: (id: string) => readonly ["media", "assets", "detail", string];
+    foldersList: (parentId?: string | null) => readonly ["media", "folders", "list", string];
+};
+
+export { MEDIA_QUERY_KEYS as a, assetListDiscriminator as b, mediaBackendPlugin as m };
+export type { AssetListDiscriminator as A, MediaApiRouter as M, MediaApiContext as c, MediaBackendHooks as d, MediaBackendConfig as e };

package/dist/shared/{stack.BxFl46lB.d.cts → stack.DxQl8Wa1.d.cts}

@@ -141,6 +141,31 @@ interface KanbanPluginOverrides {
      * Optional headers to pass with API requests (e.g., for SSR auth)
      */
     headers?: HeadersInit;
+    /**
+     * Function used to upload a new image file from the task description editor
+     * and return its URL. This is separate from `imagePicker`, which selects an
+     * existing asset URL.
+     */
+    uploadImage?: (file: File) => Promise<string>;
+    /**
+     * Optional trigger component for a media picker.
+     * When provided, it appears inside the image insertion dialog of the task description editor,
+     * letting users browse and select previously uploaded assets.
+     *
+     * @example
+     * ```tsx
+     * imagePicker: ({ onSelect }) => (
+     *   <MediaPicker
+     *     trigger={<Button size="sm" variant="outline">Browse media</Button>}
+     *     accept={["image/*"]}
+     *     onSelect={(assets) => onSelect(assets[0].url)}
+     *   />
+     * )
+     * ```
+     */
+    imagePicker?: ComponentType<{
+        onSelect: (url: string) => void;
+    }>;
     /**
      * Resolve user info from an assigneeId
      * Called when rendering task cards/forms that have an assignee

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

@@ -0,0 +1,286 @@
+import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
+import { a as StorageAdapter, b as S3UploadToken } from './stack.BttDsJJn.mjs';
+import { c as AssetListResult, l as listAssets, a as listFolders, A as AssetListParams } from './stack.C7vfOBmO.mjs';
+import * as better_call from 'better-call';
+import { z } from 'zod';
+import { A as Asset, F as Folder } from './stack.CLcnSF_b.mjs';
+
+declare const AssetListQuerySchema: z.ZodObject<{
+    folderId: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodOptional<z.ZodString>;
+    query: z.ZodOptional<z.ZodString>;
+    offset: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+declare const updateAssetSchema: z.ZodObject<{
+    alt: z.ZodOptional<z.ZodString>;
+    folderId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const createFolderSchema: z.ZodObject<{
+    name: z.ZodString;
+    parentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+
+/**
+ * Context passed to media API hooks.
+ */
+interface MediaApiContext<TBody = unknown, TParams = unknown, TQuery = unknown> {
+    body?: TBody;
+    params?: TParams;
+    query?: TQuery;
+    request?: Request;
+    headers?: Headers;
+    [key: string]: unknown;
+}
+/**
+ * Configuration hooks for the media backend plugin.
+ * All hooks are optional and allow consumers to customise behaviour.
+ */
+interface MediaBackendHooks {
+    /**
+     * Called before a file upload is allowed (both direct and signed adapters).
+     * Throw an Error to reject the upload (e.g. if the user is not authenticated).
+     */
+    onBeforeUpload?: (meta: {
+        filename: string;
+        mimeType: string;
+        size?: number;
+    }, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called after an asset record is created in the database.
+     */
+    onAfterUpload?: (asset: Asset, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before an asset is deleted. Throw to prevent deletion.
+     */
+    onBeforeDelete?: (asset: Asset, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called after an asset has been deleted from the DB and storage.
+     */
+    onAfterDelete?: (assetId: string, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before listing assets. Throw to deny access.
+     */
+    onBeforeListAssets?: (filter: z.infer<typeof AssetListQuerySchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before updating an asset (PATCH). Throw to deny access.
+     */
+    onBeforeUpdateAsset?: (asset: Asset, updates: z.infer<typeof updateAssetSchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before listing folders. Throw to deny access.
+     */
+    onBeforeListFolders?: (filter: {
+        parentId?: string;
+    }, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before creating a folder. Throw to deny access.
+     */
+    onBeforeCreateFolder?: (input: z.infer<typeof createFolderSchema>, context: MediaApiContext) => Promise<void> | void;
+    /**
+     * Called before deleting a folder. Throw to deny access.
+     */
+    onBeforeDeleteFolder?: (folder: Folder, context: MediaApiContext) => Promise<void> | void;
+}
+/**
+ * Configuration for the media backend plugin.
+ */
+interface MediaBackendConfig {
+    /**
+     * The storage adapter to use for file uploads.
+     * - `localAdapter()` — writes to the local filesystem (dev / self-hosted)
+     * - `s3Adapter()` — presigned PUT URL (AWS S3, Cloudflare R2, MinIO)
+     * - `vercelBlobAdapter()` — signed direct upload via Vercel Blob
+     */
+    storageAdapter: StorageAdapter;
+    /**
+     * Maximum file size in bytes.
+     * Enforced server-side for `localAdapter`.
+     * Passed into the Vercel Blob token for edge enforcement.
+     * Validated against the client-reported size for `s3Adapter`.
+     * @default 10485760 (10 MB)
+     */
+    maxFileSizeBytes?: number;
+    /**
+     * MIME type allowlist (e.g. `["image/jpeg", "image/png"]`).
+     * If omitted, all MIME types are accepted.
+     * Enforced server-side for `localAdapter`.
+     * Passed to Vercel Blob token for edge enforcement.
+     * Validated against the client-reported MIME type for `s3Adapter`.
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * URL prefixes that are allowed when creating asset records via `POST /media/assets`.
+     * When omitted the plugin automatically derives a safe default from the storage adapter:
+     * - `s3Adapter` → the configured `publicBaseUrl`
+     * - `vercelBlobAdapter` → any URL whose hostname ends with `.public.blob.vercel-storage.com`
+     * - `localAdapter` → rejects client-supplied URLs; use `POST /media/upload` instead
+     *
+     * Provide this option only when you need to override the automatic default (e.g. to allow
+     * assets from a CDN in front of your storage that uses a different domain). When using
+     * `localAdapter`, setting `allowedUrlPrefixes` explicitly opts `POST /media/assets` back in.
+     */
+    allowedUrlPrefixes?: string[];
+    /**
+     * Optional lifecycle hooks for the media backend plugin.
+     */
+    hooks?: MediaBackendHooks;
+}
+/**
+ * Media backend plugin.
+ * Provides API endpoints for managing media assets and folders, and supports
+ * local, S3-compatible, and Vercel Blob storage backends.
+ *
+ * @example
+ * ```ts
+ * import { mediaBackendPlugin, localAdapter } from "@btst/stack/plugins/media/api";
+ *
+ * mediaBackendPlugin({
+ *   storageAdapter: localAdapter(),
+ *   hooks: {
+ *     onBeforeUpload: async (_meta, ctx) => {
+ *       const session = await getSession(ctx.headers as Headers);
+ *       if (!session) throw new Error("Unauthorized");
+ *     },
+ *   },
+ * })
+ * ```
+ */
+declare const mediaBackendPlugin: (config: MediaBackendConfig) => _btst_stack_plugins_api.BackendPlugin<{
+    readonly listAssets: better_call.StrictEndpoint<"/media/assets", {} & {
+        method: "GET";
+    } & {
+        query: better_call.StandardSchemaV1<{
+            folderId?: string | undefined;
+            mimeType?: string | undefined;
+            query?: string | undefined;
+            offset?: unknown;
+            limit?: unknown;
+        }, {
+            folderId?: string | undefined;
+            mimeType?: string | undefined;
+            query?: string | undefined;
+            offset?: unknown;
+            limit?: unknown;
+        }>;
+    }, AssetListResult>;
+    readonly createAsset: better_call.StrictEndpoint<"/media/assets", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            filename: string;
+            originalName: string;
+            mimeType: string;
+            size: number;
+            url: string;
+            folderId?: string | undefined;
+            alt?: string | undefined;
+        }, {
+            filename: string;
+            originalName: string;
+            mimeType: string;
+            size: number;
+            url: string;
+            folderId?: string | undefined;
+            alt?: string | undefined;
+        }>;
+    }, Asset>;
+    readonly updateAsset: better_call.StrictEndpoint<"/media/assets/:id", {} & {
+        method: "PATCH";
+        body: better_call.StandardSchemaV1<{
+            alt?: string | undefined;
+            folderId?: string | null | undefined;
+        }, {
+            alt?: string | undefined;
+            folderId?: string | null | undefined;
+        }>;
+    }, Asset>;
+    readonly deleteAsset: better_call.StrictEndpoint<"/media/assets/:id", {} & {
+        method: "DELETE";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, {
+        success: boolean;
+    }>;
+    readonly listFolders: better_call.StrictEndpoint<"/media/folders", {} & {
+        method: "GET";
+    } & {
+        query: better_call.StandardSchemaV1<{
+            parentId?: string | undefined;
+        }, {
+            parentId?: string | undefined;
+        }>;
+    }, Folder[]>;
+    readonly createFolder: better_call.StrictEndpoint<"/media/folders", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            name: string;
+            parentId?: string | undefined;
+        }, {
+            name: string;
+            parentId?: string | undefined;
+        }>;
+    }, Folder>;
+    readonly deleteFolder: better_call.StrictEndpoint<"/media/folders/:id", {} & {
+        method: "DELETE";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, {
+        success: boolean;
+    }>;
+    readonly uploadDirect: better_call.StrictEndpoint<"/media/upload", {
+        metadata: {
+            allowedMediaTypes: string[];
+        };
+    } & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, Asset>;
+    readonly uploadToken: better_call.StrictEndpoint<"/media/upload/token", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<{
+            filename: string;
+            mimeType: string;
+            size: number;
+            folderId?: string | undefined;
+        }, {
+            filename: string;
+            mimeType: string;
+            size: number;
+            folderId?: string | undefined;
+        }>;
+    }, S3UploadToken>;
+    readonly uploadVercelBlob: better_call.StrictEndpoint<"/media/upload/vercel-blob", {} & {
+        method: "POST";
+        body: better_call.StandardSchemaV1<unknown, unknown>;
+    }, unknown>;
+}, {
+    listAssets: (params?: Parameters<typeof listAssets>[1]) => Promise<AssetListResult>;
+    getAssetById: (id: string) => Promise<Asset | null>;
+    listFolders: (params?: Parameters<typeof listFolders>[1]) => Promise<Folder[]>;
+    getFolderById: (id: string) => Promise<Folder | null>;
+}>;
+type MediaApiRouter = ReturnType<ReturnType<typeof mediaBackendPlugin>["routes"]>;
+
+/**
+ * Internal query key constants for the media plugin.
+ * Shared between query-keys.ts (HTTP path) and any SSR/SSG prefetching
+ * to prevent key drift between client and server.
+ */
+
+/**
+ * Discriminator for the asset list cache key.
+ */
+interface AssetListDiscriminator {
+    folderId: string | undefined;
+    mimeType: string | undefined;
+    query: string | undefined;
+    limit: number | undefined;
+    offset: number | undefined;
+}
+declare function assetListDiscriminator(params?: AssetListParams): AssetListDiscriminator;
+/** Full query key builders — use these with `queryClient.setQueryData()`. */
+declare const MEDIA_QUERY_KEYS: {
+    assetsList: (params?: AssetListParams) => readonly ["media", "assets", "list", AssetListDiscriminator];
+    assetDetail: (id: string) => readonly ["media", "assets", "detail", string];
+    foldersList: (parentId?: string | null) => readonly ["media", "folders", "list", string];
+};
+
+export { MEDIA_QUERY_KEYS as a, assetListDiscriminator as b, mediaBackendPlugin as m };
+export type { AssetListDiscriminator as A, MediaApiRouter as M, MediaApiContext as c, MediaBackendHooks as d, MediaBackendConfig as e };