convex-cms 0.0.1

package/dist/component/bulkOperations.d.ts

@@ -0,0 +1,200 @@
+/**
+ * Bulk Operations for Content Entries
+ *
+ * Provides mutations for performing bulk operations on content entries:
+ * - bulkPublish: Publish multiple entries at once
+ * - bulkUnpublish: Revert multiple entries to draft
+ * - bulkDelete: Delete multiple entries (soft or hard)
+ * - bulkUpdate: Update multiple entries with the same changes
+ *
+ * All operations process entries in a single transaction for atomicity,
+ * respecting Convex limits (max 16,000 documents written per transaction).
+ * The BULK_OPERATION_BATCH_SIZE constant defines the maximum entries per call.
+ *
+ * For larger datasets, callers should batch IDs into chunks of BULK_OPERATION_BATCH_SIZE
+ * and call the appropriate bulk operation for each batch.
+ */
+import { Id } from "./_generated/dataModel.js";
+interface BulkOperationItemResult {
+    id: Id<"contentEntries">;
+    success: boolean;
+    error?: string;
+}
+interface BulkOperationResult {
+    total: number;
+    succeeded: number;
+    failed: number;
+    results: BulkOperationItemResult[];
+}
+/**
+ * Mutation to publish multiple content entries in a single transaction.
+ *
+ * Publishes entries that are in draft or scheduled status. Already published
+ * entries are skipped with a success status. Deleted or archived entries
+ * will fail with an error message.
+ *
+ * For each entry published:
+ * - Status is set to "published"
+ * - firstPublishedAt is set (if first publication)
+ * - lastPublishedAt is updated
+ * - Version is incremented
+ * - A version snapshot is created
+ *
+ * @param ids - Array of content entry IDs to publish (max BULK_OPERATION_BATCH_SIZE)
+ * @param changeDescription - Optional description for version history
+ * @param updatedBy - User ID for audit trail
+ *
+ * @returns BulkOperationResult with success/failure details for each entry
+ *
+ * @example
+ * ```typescript
+ * const result = await ctx.runMutation(api.bulkOperations.bulkPublish, {
+ *   ids: [entry1._id, entry2._id, entry3._id],
+ *   changeDescription: "Publishing launch content",
+ *   updatedBy: currentUserId,
+ * });
+ * console.log(`Published ${result.succeeded} of ${result.total} entries`);
+ * ```
+ */
+export declare const bulkPublish: import("convex/server").RegisteredMutation<"public", {
+    updatedBy?: string | undefined;
+    changeDescription?: string | undefined;
+    ids: import("convex/values").GenericId<"contentEntries">[];
+}, Promise<BulkOperationResult>>;
+/**
+ * Mutation to unpublish multiple content entries in a single transaction.
+ *
+ * Reverts published entries to draft status. Non-published entries are
+ * skipped with a success status (idempotent behavior). Deleted entries
+ * will fail with an error message.
+ *
+ * For each entry unpublished:
+ * - Status is set to "draft"
+ * - Version is incremented
+ * - Publication timestamps are preserved for history
+ *
+ * @param ids - Array of content entry IDs to unpublish (max BULK_OPERATION_BATCH_SIZE)
+ * @param updatedBy - User ID for audit trail
+ *
+ * @returns BulkOperationResult with success/failure details for each entry
+ *
+ * @example
+ * ```typescript
+ * const result = await ctx.runMutation(api.bulkOperations.bulkUnpublish, {
+ *   ids: [entry1._id, entry2._id],
+ *   updatedBy: currentUserId,
+ * });
+ * ```
+ */
+export declare const bulkUnpublish: import("convex/server").RegisteredMutation<"public", {
+    updatedBy?: string | undefined;
+    ids: import("convex/values").GenericId<"contentEntries">[];
+}, Promise<BulkOperationResult>>;
+/**
+ * Mutation to delete multiple content entries in a single transaction.
+ *
+ * By default, performs soft delete by setting deletedAt timestamp.
+ * When hardDelete is true, permanently removes entries and all versions.
+ *
+ * Soft Delete:
+ * - Sets deletedAt timestamp
+ * - Entries can be restored later
+ * - Already deleted entries are skipped
+ *
+ * Hard Delete:
+ * - Permanently removes entry document
+ * - Deletes all version snapshots
+ * - Cannot be undone
+ *
+ * @param ids - Array of content entry IDs to delete (max BULK_OPERATION_BATCH_SIZE)
+ * @param deletedBy - User ID for audit trail
+ * @param hardDelete - If true, permanently delete entries and versions
+ *
+ * @returns BulkOperationResult with success/failure details for each entry
+ *
+ * @example
+ * ```typescript
+ * // Soft delete (default)
+ * const result = await ctx.runMutation(api.bulkOperations.bulkDelete, {
+ *   ids: [entry1._id, entry2._id],
+ *   deletedBy: currentUserId,
+ * });
+ *
+ * // Hard delete
+ * const result = await ctx.runMutation(api.bulkOperations.bulkDelete, {
+ *   ids: [entry1._id, entry2._id],
+ *   deletedBy: currentUserId,
+ *   hardDelete: true,
+ * });
+ * ```
+ */
+export declare const bulkDelete: import("convex/server").RegisteredMutation<"public", {
+    hardDelete?: boolean | undefined;
+    deletedBy?: string | undefined;
+    ids: import("convex/values").GenericId<"contentEntries">[];
+}, Promise<BulkOperationResult>>;
+/**
+ * Mutation to update multiple content entries with the same changes.
+ *
+ * Applies the same data updates and/or status change to all specified entries.
+ * Each entry is validated against its content type schema before updating.
+ *
+ * Data is merged with existing data for each entry (partial updates).
+ * Status can be changed independently of data updates.
+ *
+ * @param ids - Array of content entry IDs to update (max BULK_OPERATION_BATCH_SIZE)
+ * @param data - Data to merge into each entry
+ * @param status - New status to apply to all entries
+ * @param updatedBy - User ID for audit trail
+ *
+ * @returns BulkOperationResult with success/failure details for each entry
+ *
+ * @example
+ * ```typescript
+ * // Update data for multiple entries
+ * const result = await ctx.runMutation(api.bulkOperations.bulkUpdate, {
+ *   ids: [entry1._id, entry2._id, entry3._id],
+ *   data: { featured: true, category: "news" },
+ *   updatedBy: currentUserId,
+ * });
+ *
+ * // Change status for multiple entries
+ * const result = await ctx.runMutation(api.bulkOperations.bulkUpdate, {
+ *   ids: [entry1._id, entry2._id],
+ *   status: "archived",
+ *   updatedBy: currentUserId,
+ * });
+ * ```
+ */
+export declare const bulkUpdate: import("convex/server").RegisteredMutation<"public", {
+    updatedBy?: string | undefined;
+    status?: string | undefined;
+    data?: any;
+    ids: import("convex/values").GenericId<"contentEntries">[];
+}, Promise<BulkOperationResult>>;
+/**
+ * Mutation to restore multiple soft-deleted content entries.
+ *
+ * Removes the deletedAt marker from entries, making them active again.
+ * Only works for soft-deleted entries. Non-deleted entries are skipped
+ * with a success status (idempotent behavior).
+ *
+ * @param ids - Array of content entry IDs to restore (max BULK_OPERATION_BATCH_SIZE)
+ * @param restoredBy - User ID for audit trail
+ *
+ * @returns BulkOperationResult with success/failure details for each entry
+ *
+ * @example
+ * ```typescript
+ * const result = await ctx.runMutation(api.bulkOperations.bulkRestore, {
+ *   ids: [deletedEntry1._id, deletedEntry2._id],
+ *   restoredBy: currentUserId,
+ * });
+ * ```
+ */
+export declare const bulkRestore: import("convex/server").RegisteredMutation<"public", {
+    restoredBy?: string | undefined;
+    ids: import("convex/values").GenericId<"contentEntries">[];
+}, Promise<BulkOperationResult>>;
+export {};
+//# sourceMappingURL=bulkOperations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bulkOperations.d.ts","sourceRoot":"","sources":["../../src/component/bulkOperations.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAiBH,OAAO,EAAE,EAAE,EAAE,MAAM,2BAA2B,CAAC;AAO/C,UAAU,uBAAuB;IAChC,EAAE,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,mBAAmB;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,uBAAuB,EAAE,CAAC;CACnC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,WAAW;;;;gCA+FtB,CAAC;AAMH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,aAAa;;;gCA+DxB,CAAC;AAMH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,UAAU;;;;gCA2ErB,CAAC;AAMH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,UAAU;;;;;gCAsKrB,CAAC;AAMH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW;;;gCA6DtB,CAAC"}