convex-cms 0.0.1

package/dist/component/mediaAssets.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Media Asset Query Functions
+ *
+ * Provides query functions for retrieving media assets from the CMS.
+ * Media assets are file records that reference Convex's built-in file storage,
+ * along with metadata like dimensions, MIME type, and organization tags.
+ */
+/**
+ * Query to retrieve a single media asset by ID.
+ *
+ * Returns the asset metadata along with a resolved storage URL and
+ * optimization hints for efficient frontend rendering.
+ *
+ * @param id - The media asset ID to retrieve
+ * @param includeDeleted - Whether to include soft-deleted assets (default: false)
+ * @returns The media asset document with URL and optimization hints, or null if not found
+ *
+ * @example
+ * ```typescript
+ * // Basic usage - get asset by ID
+ * const asset = await ctx.runQuery(api.mediaAssets.get, {
+ *   id: assetId,
+ * });
+ *
+ * if (asset) {
+ *   console.log("Asset URL:", asset.url);
+ *   console.log("Dimensions:", asset.width, "x", asset.height);
+ *
+ *   // Use optimization hints for responsive images
+ *   if (asset.optimizationHints.isResizable) {
+ *     console.log("Aspect ratio:", asset.optimizationHints.aspectRatio);
+ *     console.log("Max width:", asset.optimizationHints.suggestedMaxWidth);
+ *   }
+ * }
+ *
+ * // Including deleted assets (for admin recovery UI)
+ * const deletedAsset = await ctx.runQuery(api.mediaAssets.get, {
+ *   id: assetId,
+ *   includeDeleted: true,
+ * });
+ * ```
+ */
+export declare const get: import("convex/server").RegisteredQuery<"public", {
+    includeDeleted?: boolean | undefined;
+    id: import("convex/values").GenericId<"mediaItems">;
+}, Promise<{
+    url: string | null;
+    optimizationHints: {
+        isResizable: boolean;
+        aspectRatio?: number;
+        hasTransparency?: boolean;
+        isVector?: boolean;
+        suggestedMaxWidth?: number;
+        durationSeconds?: number;
+    };
+    _id: import("convex/values").GenericId<"mediaItems">;
+    _creationTime: number;
+    tags?: string[] | undefined;
+    description?: string | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    duration?: number | undefined;
+    altText?: string | undefined;
+    title?: string | undefined;
+    parentId?: import("convex/values").GenericId<"mediaItems"> | undefined;
+    size?: number | undefined;
+    metadata?: Record<string, any> | undefined;
+    deletedAt?: number | undefined;
+    createdBy?: string | undefined;
+    updatedBy?: string | undefined;
+    searchText?: string | undefined;
+    name: string;
+    kind: "asset";
+    storageId: import("convex/values").GenericId<"_storage">;
+    mimeType: string;
+    path: string;
+} | null>>;
+/**
+ * Query to list media assets with optional folder filter and pagination.
+ *
+ * Supports filtering by:
+ * - Folder: Filter to assets in a specific folder or root level
+ * - MIME type: Exact match or prefix match (e.g., "image/")
+ * - Media type: Category filter (image, video, audio, document, other)
+ * - Tags: Assets must contain ALL specified tags
+ * - Search: Full-text search on filename, title, description
+ *
+ * Supports sorting by:
+ * - _creationTime (default, descending)
+ * - filename
+ * - size
+ * - type
+ * - mimeType
+ *
+ * @param folderId - Filter to assets in this folder (optional)
+ * @param includeRootLevel - Include assets without a folder (default: false with folderId, true without)
+ * @param type - Filter by media type category
+ * @param mimeType - Filter by exact MIME type
+ * @param mimeTypePrefix - Filter by MIME type prefix (e.g., "image/")
+ * @param search - Full-text search term
+ * @param tags - Filter by tags (must match ALL)
+ * @param includeDeleted - Include soft-deleted assets (default: false)
+ * @param sortField - Field to sort by (default: "_creationTime")
+ * @param sortDirection - Sort direction (default: "desc")
+ * @param paginationOpts - Pagination options with numItems and cursor
+ * @returns Paginated list of media assets with URLs and optimization hints
+ *
+ * @example
+ * ```typescript
+ * // List all images in a specific folder
+ * const result = await ctx.runQuery(api.mediaAssets.list, {
+ *   folderId: folderId,
+ *   type: "image",
+ *   paginationOpts: { numItems: 20 }
+ * });
+ *
+ * // Search for assets by name
+ * const searchResult = await ctx.runQuery(api.mediaAssets.list, {
+ *   search: "hero banner",
+ *   mimeTypePrefix: "image/",
+ *   paginationOpts: { numItems: 10 }
+ * });
+ *
+ * // List all PDFs sorted by size
+ * const pdfs = await ctx.runQuery(api.mediaAssets.list, {
+ *   mimeType: "application/pdf",
+ *   sortField: "size",
+ *   sortDirection: "desc",
+ *   paginationOpts: { numItems: 50 }
+ * });
+ *
+ * // Paginate through results
+ * const nextPage = await ctx.runQuery(api.mediaAssets.list, {
+ *   paginationOpts: {
+ *     numItems: 20,
+ *     cursor: result.continueCursor
+ *   }
+ * });
+ * ```
+ */
+export declare const list: import("convex/server").RegisteredQuery<"public", {
+    tags?: string[] | undefined;
+    type?: "image" | "video" | "audio" | "document" | "other" | undefined;
+    mimeType?: string | undefined;
+    includeDeleted?: boolean | undefined;
+    search?: string | undefined;
+    folderId?: import("convex/values").GenericId<"mediaItems"> | undefined;
+    includeRootLevel?: boolean | undefined;
+    mimeTypePrefix?: string | undefined;
+    deletedOnly?: boolean | undefined;
+    sortField?: "type" | "mimeType" | "size" | "_creationTime" | "filename" | undefined;
+    sortDirection?: "asc" | "desc" | undefined;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<MediaAssetPaginationResult>>;
+interface MediaAssetPaginationResult {
+    page: any[];
+    continueCursor: string | null;
+    isDone: boolean;
+}
+export {};
+//# sourceMappingURL=mediaAssets.d.ts.map

package/dist/component/mediaAssets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mediaAssets.d.ts","sourceRoot":"","sources":["../../src/component/mediaAssets.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA2DH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,GAAG;;;;;;qBA4ED,OAAO;sBACN,MAAM;0BACF,OAAO;mBACd,OAAO;4BACE,MAAM;0BACR,MAAM;;;;;;;;;;;;;;;;;;;;;;;UAjDxB,CAAC;AA8HH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;uCAqEf,CAAC;AAMH,UAAU,0BAA0B;IAClC,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;CACjB"}