@nest-toolbox/typeorm-soft-delete 1.8.0

package/dist/soft-delete-operations.d.ts

@@ -0,0 +1,107 @@
+import { type FindManyOptions, type ObjectLiteral, type Repository } from 'typeorm';
+import type { CountOptions, RestoreOptions, SoftDeleteCriteria, SoftDeleteOptions, SoftDeleteResult } from './types';
+/**
+ * Soft delete entities by setting deletedAt to current timestamp
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @param options - Optional configuration
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * // Single ID
+ * await softDelete(userRepository, 123);
+ *
+ * // Multiple IDs
+ * await softDelete(userRepository, [1, 2, 3]);
+ *
+ * // With where clause
+ * await softDelete(userRepository, { email: 'test@example.com' });
+ * ```
+ */
+export declare function softDelete<T extends ObjectLiteral>(repository: Repository<T>, criteria: SoftDeleteCriteria<T>, options?: SoftDeleteOptions): Promise<SoftDeleteResult>;
+/**
+ * Restore soft-deleted entities by setting deletedAt back to null
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @param options - Optional configuration
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * await restore(userRepository, 123);
+ * ```
+ */
+export declare function restore<T extends ObjectLiteral>(repository: Repository<T>, criteria: SoftDeleteCriteria<T>, options?: RestoreOptions): Promise<SoftDeleteResult>;
+/**
+ * Permanently delete soft-deleted entities (hard delete)
+ * Only deletes records where deletedAt IS NOT NULL
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * await forceDelete(userRepository, 123);
+ * ```
+ */
+export declare function forceDelete<T extends ObjectLiteral>(repository: Repository<T>, criteria: SoftDeleteCriteria<T>): Promise<SoftDeleteResult>;
+/**
+ * Find entities including soft-deleted ones
+ *
+ * @param repository - TypeORM repository
+ * @param options - Find options
+ * @returns Promise with array of entities (including soft-deleted)
+ *
+ * @example
+ * ```typescript
+ * const allUsers = await findWithDeleted(userRepository);
+ * ```
+ */
+export declare function findWithDeleted<T extends ObjectLiteral>(repository: Repository<T>, options?: FindManyOptions<T>): Promise<T[]>;
+/**
+ * Find only soft-deleted entities
+ *
+ * @param repository - TypeORM repository
+ * @param options - Find options
+ * @returns Promise with array of soft-deleted entities
+ *
+ * @example
+ * ```typescript
+ * const deletedUsers = await findOnlyDeleted(userRepository);
+ * ```
+ */
+export declare function findOnlyDeleted<T extends ObjectLiteral>(repository: Repository<T>, options?: FindManyOptions<T>): Promise<T[]>;
+/**
+ * Count entities with optional inclusion of soft-deleted
+ *
+ * @param repository - TypeORM repository
+ * @param options - Count options
+ * @returns Promise with count of entities
+ *
+ * @example
+ * ```typescript
+ * const activeCount = await count(userRepository);
+ * const totalCount = await count(userRepository, { includeDeleted: true });
+ * ```
+ */
+export declare function count<T extends ObjectLiteral>(repository: Repository<T>, options?: CountOptions<T>): Promise<number>;
+/**
+ * Check if entity is soft-deleted
+ *
+ * @param repository - TypeORM repository
+ * @param id - Entity ID
+ * @returns Promise with boolean indicating if entity is soft-deleted
+ * @throws Error if entity not found
+ *
+ * @example
+ * ```typescript
+ * if (await isSoftDeleted(userRepository, 123)) {
+ *   console.log('User is deleted');
+ * }
+ * ```
+ */
+export declare function isSoftDeleted<T extends ObjectLiteral>(repository: Repository<T>, id: string | number): Promise<boolean>;

package/dist/soft-delete-operations.js

@@ -0,0 +1,227 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.softDelete = softDelete;
+exports.restore = restore;
+exports.forceDelete = forceDelete;
+exports.findWithDeleted = findWithDeleted;
+exports.findOnlyDeleted = findOnlyDeleted;
+exports.count = count;
+exports.isSoftDeleted = isSoftDeleted;
+const typeorm_1 = require("typeorm");
+const utils_1 = require("./utils");
+/**
+ * Soft delete entities by setting deletedAt to current timestamp
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @param options - Optional configuration
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * // Single ID
+ * await softDelete(userRepository, 123);
+ *
+ * // Multiple IDs
+ * await softDelete(userRepository, [1, 2, 3]);
+ *
+ * // With where clause
+ * await softDelete(userRepository, { email: 'test@example.com' });
+ * ```
+ */
+async function softDelete(repository, criteria, options) {
+    var _a;
+    (0, utils_1.validateSoftDeleteSupport)(repository);
+    const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+    const qb = repository
+        .createQueryBuilder()
+        .update()
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM QueryBuilder set requires any for dynamic keys
+        .set({ [deleteColumn]: () => 'CURRENT_TIMESTAMP' })
+        .andWhere(`${deleteColumn} IS NULL`); // Only delete non-deleted records
+    // Handle different criteria types
+    if (typeof criteria === 'string' || typeof criteria === 'number') {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} = :id`, { id: criteria });
+    }
+    else if (Array.isArray(criteria)) {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} IN (:...ids)`, { ids: criteria });
+    }
+    else {
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM QueryBuilder where clause requires any for dynamic types
+        qb.where(criteria);
+    }
+    const result = await qb.execute();
+    if ((options === null || options === void 0 ? void 0 : options.validateExists) && result.affected === 0) {
+        throw new Error('Entity not found or already deleted');
+    }
+    return { affected: (_a = result.affected) !== null && _a !== void 0 ? _a : 0 };
+}
+/**
+ * Restore soft-deleted entities by setting deletedAt back to null
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @param options - Optional configuration
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * await restore(userRepository, 123);
+ * ```
+ */
+async function restore(repository, criteria, options) {
+    var _a;
+    (0, utils_1.validateSoftDeleteSupport)(repository);
+    const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+    const qb = repository
+        .createQueryBuilder()
+        .update()
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM QueryBuilder set requires any for dynamic keys
+        .set({ [deleteColumn]: null })
+        .andWhere(`${deleteColumn} IS NOT NULL`); // Only restore deleted records
+    // Handle different criteria types
+    if (typeof criteria === 'string' || typeof criteria === 'number') {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} = :id`, { id: criteria });
+    }
+    else if (Array.isArray(criteria)) {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} IN (:...ids)`, { ids: criteria });
+    }
+    else {
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM QueryBuilder where clause requires any for dynamic types
+        qb.where(criteria);
+    }
+    const result = await qb.execute();
+    if ((options === null || options === void 0 ? void 0 : options.validateExists) && result.affected === 0) {
+        throw new Error('Entity not found or not soft-deleted');
+    }
+    return { affected: (_a = result.affected) !== null && _a !== void 0 ? _a : 0 };
+}
+/**
+ * Permanently delete soft-deleted entities (hard delete)
+ * Only deletes records where deletedAt IS NOT NULL
+ *
+ * @param repository - TypeORM repository
+ * @param criteria - Entity ID(s) or FindOptionsWhere clause
+ * @returns Promise with number of affected records
+ *
+ * @example
+ * ```typescript
+ * await forceDelete(userRepository, 123);
+ * ```
+ */
+async function forceDelete(repository, criteria) {
+    var _a;
+    (0, utils_1.validateSoftDeleteSupport)(repository);
+    const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+    const qb = repository.createQueryBuilder().delete().andWhere(`${deleteColumn} IS NOT NULL`); // Only hard delete already soft-deleted records
+    // Handle criteria
+    if (typeof criteria === 'string' || typeof criteria === 'number') {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} = :id`, { id: criteria });
+    }
+    else if (Array.isArray(criteria)) {
+        const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+        qb.where(`${primaryColumns[0]} IN (:...ids)`, { ids: criteria });
+    }
+    else {
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM QueryBuilder where clause requires any for dynamic types
+        qb.where(criteria);
+    }
+    const result = await qb.execute();
+    return { affected: (_a = result.affected) !== null && _a !== void 0 ? _a : 0 };
+}
+/**
+ * Find entities including soft-deleted ones
+ *
+ * @param repository - TypeORM repository
+ * @param options - Find options
+ * @returns Promise with array of entities (including soft-deleted)
+ *
+ * @example
+ * ```typescript
+ * const allUsers = await findWithDeleted(userRepository);
+ * ```
+ */
+async function findWithDeleted(repository, options) {
+    return repository.find(Object.assign(Object.assign({}, options), { withDeleted: true }));
+}
+/**
+ * Find only soft-deleted entities
+ *
+ * @param repository - TypeORM repository
+ * @param options - Find options
+ * @returns Promise with array of soft-deleted entities
+ *
+ * @example
+ * ```typescript
+ * const deletedUsers = await findOnlyDeleted(userRepository);
+ * ```
+ */
+async function findOnlyDeleted(repository, options) {
+    (0, utils_1.validateSoftDeleteSupport)(repository);
+    const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+    return repository.find(Object.assign(Object.assign({}, options), { where: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.where), { [deleteColumn]: (0, typeorm_1.Not)((0, typeorm_1.IsNull)()) }), withDeleted: true }));
+}
+/**
+ * Count entities with optional inclusion of soft-deleted
+ *
+ * @param repository - TypeORM repository
+ * @param options - Count options
+ * @returns Promise with count of entities
+ *
+ * @example
+ * ```typescript
+ * const activeCount = await count(userRepository);
+ * const totalCount = await count(userRepository, { includeDeleted: true });
+ * ```
+ */
+async function count(repository, options) {
+    const _a = options || {}, { includeDeleted } = _a, countOptions = __rest(_a, ["includeDeleted"]);
+    return repository.count(Object.assign(Object.assign({}, countOptions), { withDeleted: includeDeleted }));
+}
+/**
+ * Check if entity is soft-deleted
+ *
+ * @param repository - TypeORM repository
+ * @param id - Entity ID
+ * @returns Promise with boolean indicating if entity is soft-deleted
+ * @throws Error if entity not found
+ *
+ * @example
+ * ```typescript
+ * if (await isSoftDeleted(userRepository, 123)) {
+ *   console.log('User is deleted');
+ * }
+ * ```
+ */
+async function isSoftDeleted(repository, id) {
+    (0, utils_1.validateSoftDeleteSupport)(repository);
+    const primaryColumns = (0, utils_1.getPrimaryColumns)(repository);
+    const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+    const entity = await repository.findOne({
+        where: {
+            [primaryColumns[0]]: id, // biome-ignore lint/suspicious/noExplicitAny: TypeORM where object requires any
+        },
+        withDeleted: true,
+    });
+    if (!entity) {
+        throw new Error('Entity not found');
+    }
+    return entity[deleteColumn] !== null;
+}
+//# sourceMappingURL=soft-delete-operations.js.map

package/dist/soft-delete-operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft-delete-operations.js","sourceRoot":"","sources":["../src/soft-delete-operations.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAwBA,gCAkCC;AAeD,0BAkCC;AAeD,kCAoBC;AAcD,0CAKC;AAcD,0CAeC;AAeD,sBAOC;AAiBD,sCAkBC;AAvPD,qCAAiG;AAEjG,mCAAgG;AAEhG;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,UAAU,CAC9B,UAAyB,EACzB,QAA+B,EAC/B,OAA2B;;IAE3B,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,UAAU;SAClB,kBAAkB,EAAE;SACpB,MAAM,EAAE;QACT,qGAAqG;SACpG,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,mBAAmB,EAAS,CAAC;SACzD,QAAQ,CAAC,GAAG,YAAY,UAAU,CAAC,CAAC,CAAC,kCAAkC;IAE1E,kCAAkC;IAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjE,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,+GAA+G;QAC/G,EAAE,CAAC,KAAK,CAAC,QAAe,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;IAElC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,KAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,CAAC,EAAE,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,OAAO,CAC3B,UAAyB,EACzB,QAA+B,EAC/B,OAAwB;;IAExB,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,UAAU;SAClB,kBAAkB,EAAE;SACpB,MAAM,EAAE;QACT,qGAAqG;SACpG,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAS,CAAC;SACpC,QAAQ,CAAC,GAAG,YAAY,cAAc,CAAC,CAAC,CAAC,+BAA+B;IAE3E,kCAAkC;IAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjE,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,+GAA+G;QAC/G,EAAE,CAAC,KAAK,CAAC,QAAe,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;IAElC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,KAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,CAAC,EAAE,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,WAAW,CAA0B,UAAyB,EAAE,QAA+B;;IACnH,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,UAAU,CAAC,kBAAkB,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,YAAY,cAAc,CAAC,CAAC,CAAC,gDAAgD;IAE7I,kBAAkB;IAClB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjE,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;QACrD,EAAE,CAAC,KAAK,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,+GAA+G;QAC/G,EAAE,CAAC,KAAK,CAAC,QAAe,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;IAClC,OAAO,EAAE,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,CAAC,EAAE,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,eAAe,CAA0B,UAAyB,EAAE,OAA4B;IACpH,OAAO,UAAU,CAAC,IAAI,iCACjB,OAAO,KACV,WAAW,EAAE,IAAI,IACjB,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,eAAe,CAA0B,UAAyB,EAAE,OAA4B;IACpH,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;IAEzD,OAAO,UAAU,CAAC,IAAI,iCACjB,OAAO,KACV,KAAK,EAAE,gCAED,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAa,KAC1B,CAAC,YAAY,CAAC,EAAE,IAAA,aAAG,EAAC,IAAA,gBAAM,GAAE,CAAC,GAEvB,EACR,WAAW,EAAE,IAAI,IACjB,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,KAAK,CAA0B,UAAyB,EAAE,OAAyB;IACvG,MAAM,KAAsC,OAAO,IAAI,EAAE,EAAnD,EAAE,cAAc,OAAmC,EAA9B,YAAY,cAAjC,kBAAmC,CAAgB,CAAC;IAE1D,OAAO,UAAU,CAAC,KAAK,iCAClB,YAAY,KACf,WAAW,EAAE,cAAc,IAC3B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,aAAa,CAA0B,UAAyB,EAAE,EAAmB;IACzG,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,cAAc,GAAG,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC;QACtC,KAAK,EAAE;YACL,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,gFAAgF;SACnG;QACR,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;AACvC,CAAC"}

package/dist/soft-delete-paginate.d.ts

@@ -0,0 +1,82 @@
+import { type FindOptionsWhere, type ObjectLiteral, type Repository } from 'typeorm';
+/**
+ * Options for pagination with soft delete awareness
+ */
+export interface PaginationWithDeletedOptions<T extends ObjectLiteral> {
+    /**
+     * TypeORM repository
+     */
+    repository: Repository<T>;
+    /**
+     * Where clause for filtering entities
+     */
+    where: FindOptionsWhere<T> | FindOptionsWhere<T>[];
+    /**
+     * Number of records per page
+     * @default 100
+     */
+    limit?: number;
+    /**
+     * Starting offset
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * Whether to include soft-deleted records
+     * @default false
+     */
+    includeDeleted?: boolean;
+}
+/**
+ * Result row with pagination metadata
+ */
+export interface PaginatedRow<T extends ObjectLiteral> {
+    /**
+     * The entity data
+     */
+    data: T;
+    /**
+     * Zero-based index of the current row
+     */
+    index: number;
+    /**
+     * Progress percentage (0-1)
+     */
+    progress: number;
+}
+/**
+ * Paginate with soft delete awareness
+ * By default excludes soft-deleted records
+ *
+ * @param options - Pagination options
+ * @yields Paginated rows with metadata
+ *
+ * @example
+ * ```typescript
+ * for await (const row of rowsWithDeleted({
+ *   repository: userRepo,
+ *   where: {},
+ *   includeDeleted: true
+ * })) {
+ *   console.log(row.data, row.progress);
+ * }
+ * ```
+ */
+export declare function rowsWithDeleted<T extends ObjectLiteral>(options: PaginationWithDeletedOptions<T>): AsyncGenerator<PaginatedRow<T>>;
+/**
+ * Paginate only soft-deleted records
+ *
+ * @param options - Pagination options
+ * @yields Soft-deleted rows with metadata
+ *
+ * @example
+ * ```typescript
+ * for await (const row of rowsOnlyDeleted({
+ *   repository: userRepo,
+ *   where: {}
+ * })) {
+ *   console.log('Deleted user:', row.data);
+ * }
+ * ```
+ */
+export declare function rowsOnlyDeleted<T extends ObjectLiteral>(options: Omit<PaginationWithDeletedOptions<T>, 'includeDeleted'>): AsyncGenerator<PaginatedRow<T>>;

package/dist/soft-delete-paginate.js

@@ -0,0 +1,119 @@
+"use strict";
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rowsWithDeleted = rowsWithDeleted;
+exports.rowsOnlyDeleted = rowsOnlyDeleted;
+const typeorm_1 = require("typeorm");
+const utils_1 = require("./utils");
+/**
+ * Paginate with soft delete awareness
+ * By default excludes soft-deleted records
+ *
+ * @param options - Pagination options
+ * @yields Paginated rows with metadata
+ *
+ * @example
+ * ```typescript
+ * for await (const row of rowsWithDeleted({
+ *   repository: userRepo,
+ *   where: {},
+ *   includeDeleted: true
+ * })) {
+ *   console.log(row.data, row.progress);
+ * }
+ * ```
+ */
+function rowsWithDeleted(options) {
+    return __asyncGenerator(this, arguments, function* rowsWithDeleted_1() {
+        const { repository, where, limit = 100, offset = 0, includeDeleted = false } = options;
+        // Build where clause with soft delete filter
+        let finalWhere = where;
+        if (!includeDeleted && (0, utils_1.supportsSoftDelete)(repository)) {
+            const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+            finalWhere = Array.isArray(where) ? where.map((w) => (Object.assign(Object.assign({}, w), { [deleteColumn]: (0, typeorm_1.IsNull)() }))) : Object.assign(Object.assign({}, where), { [deleteColumn]: (0, typeorm_1.IsNull)() });
+        }
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM where requires any for dynamic types
+        const total = yield __await(repository.count({ where: finalWhere, withDeleted: includeDeleted }));
+        let currentOffset = offset;
+        let index = 0;
+        while (currentOffset < total) {
+            const rows = yield __await(repository.find({
+                // biome-ignore lint/suspicious/noExplicitAny: TypeORM where requires any for dynamic types
+                where: finalWhere,
+                skip: currentOffset,
+                take: limit,
+                withDeleted: includeDeleted,
+            }));
+            for (const row of rows) {
+                yield yield __await({
+                    data: row,
+                    index: index++,
+                    progress: total > 0 ? index / total : 1,
+                });
+            }
+            currentOffset += limit;
+        }
+    });
+}
+/**
+ * Paginate only soft-deleted records
+ *
+ * @param options - Pagination options
+ * @yields Soft-deleted rows with metadata
+ *
+ * @example
+ * ```typescript
+ * for await (const row of rowsOnlyDeleted({
+ *   repository: userRepo,
+ *   where: {}
+ * })) {
+ *   console.log('Deleted user:', row.data);
+ * }
+ * ```
+ */
+function rowsOnlyDeleted(options) {
+    return __asyncGenerator(this, arguments, function* rowsOnlyDeleted_1() {
+        const { repository, where, limit = 100, offset = 0 } = options;
+        (0, utils_1.validateSoftDeleteSupport)(repository);
+        const deleteColumn = (0, utils_1.getDeleteDateColumnName)(repository);
+        // Add deletedAt IS NOT NULL filter
+        const finalWhere = Array.isArray(where) ? where.map((w) => (Object.assign(Object.assign({}, w), { [deleteColumn]: (0, typeorm_1.Not)((0, typeorm_1.IsNull)()) }))) : Object.assign(Object.assign({}, where), { [deleteColumn]: (0, typeorm_1.Not)((0, typeorm_1.IsNull)()) });
+        const total = yield __await(repository.count({
+            // biome-ignore lint/suspicious/noExplicitAny: TypeORM where requires any for dynamic types
+            where: finalWhere,
+            withDeleted: true,
+        }));
+        let currentOffset = offset;
+        let index = 0;
+        while (currentOffset < total) {
+            const rows = yield __await(repository.find({
+                // biome-ignore lint/suspicious/noExplicitAny: TypeORM where requires any for dynamic types
+                where: finalWhere,
+                skip: currentOffset,
+                take: limit,
+                withDeleted: true,
+            }));
+            for (const row of rows) {
+                yield yield __await({
+                    data: row,
+                    index: index++,
+                    progress: total > 0 ? index / total : 1,
+                });
+            }
+            currentOffset += limit;
+        }
+    });
+}
+//# sourceMappingURL=soft-delete-paginate.js.map

package/dist/soft-delete-paginate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft-delete-paginate.js","sourceRoot":"","sources":["../src/soft-delete-paginate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AA0EA,0CAkCC;AAkBD,0CAuCC;AArKD,qCAAkG;AAClG,mCAAiG;AAuDjG;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAuB,eAAe,CAA0B,OAAwC;;QACtG,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEvF,6CAA6C;QAC7C,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,cAAc,IAAI,IAAA,0BAAkB,EAAC,UAAU,CAAC,EAAE,CAAC;YACtD,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;YACzD,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAM,CAAC,KAAE,CAAC,YAAY,CAAC,EAAE,IAAA,gBAAM,GAAE,IAAG,CAAC,CAAC,CAAC,iCAAM,KAAK,KAAE,CAAC,YAAY,CAAC,EAAE,IAAA,gBAAM,GAAE,GAAE,CAAC;QACtI,CAAC;QAED,2FAA2F;QAC3F,MAAM,KAAK,GAAG,cAAM,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,UAAiB,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAA,CAAC;QAChG,IAAI,aAAa,GAAG,MAAM,CAAC;QAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,OAAO,aAAa,GAAG,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,cAAM,UAAU,CAAC,IAAI,CAAC;gBACjC,2FAA2F;gBAC3F,KAAK,EAAE,UAAiB;gBACxB,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,cAAc;aAC5B,CAAC,CAAA,CAAC;YAEH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,oBAAM;oBACJ,IAAI,EAAE,GAAG;oBACT,KAAK,EAAE,KAAK,EAAE;oBACd,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;iBACxC,CAAA,CAAC;YACJ,CAAC;YAED,aAAa,IAAI,KAAK,CAAC;QACzB,CAAC;IACH,CAAC;CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAuB,eAAe,CACpC,OAAgE;;QAEhE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;QAE/D,IAAA,iCAAyB,EAAC,UAAU,CAAC,CAAC;QACtC,MAAM,YAAY,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,CAAC;QAEzD,mCAAmC;QACnC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAM,CAAC,KAAE,CAAC,YAAY,CAAC,EAAE,IAAA,aAAG,EAAC,IAAA,gBAAM,GAAE,CAAC,IAAG,CAAC,CAAC,CAAC,iCAAM,KAAK,KAAE,CAAC,YAAY,CAAC,EAAE,IAAA,aAAG,EAAC,IAAA,gBAAM,GAAE,CAAC,GAAE,CAAC;QAEpJ,MAAM,KAAK,GAAG,cAAM,UAAU,CAAC,KAAK,CAAC;YACnC,2FAA2F;YAC3F,KAAK,EAAE,UAAiB;YACxB,WAAW,EAAE,IAAI;SAClB,CAAC,CAAA,CAAC;QAEH,IAAI,aAAa,GAAG,MAAM,CAAC;QAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,OAAO,aAAa,GAAG,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,cAAM,UAAU,CAAC,IAAI,CAAC;gBACjC,2FAA2F;gBAC3F,KAAK,EAAE,UAAiB;gBACxB,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,IAAI;aAClB,CAAC,CAAA,CAAC;YAEH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,oBAAM;oBACJ,IAAI,EAAE,GAAG;oBACT,KAAK,EAAE,KAAK,EAAE;oBACd,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;iBACxC,CAAA,CAAC;YACJ,CAAC;YAED,aAAa,IAAI,KAAK,CAAC;QACzB,CAAC;IACH,CAAC;CAAA"}

package/dist/soft-delete-repository.d.ts

@@ -0,0 +1,42 @@
+import type { FindManyOptions, FindOneOptions, ObjectLiteral, Repository } from 'typeorm';
+import type { CountOptions, RestoreOptions, SoftDeleteOptions, SoftDeleteResult } from './types';
+/**
+ * Optional wrapper class providing repository-style API
+ * Users can choose between functions or this wrapper
+ *
+ * @example
+ * ```typescript
+ * const repo = withSoftDelete(userRepository);
+ * await repo.softDelete(123);
+ * await repo.restore(123);
+ * ```
+ */
+export declare class SoftDeleteRepository<T extends ObjectLiteral> {
+    private readonly repository;
+    constructor(repository: Repository<T>);
+    softDelete(criteria: string | number | (string | number)[] | Record<string, any>, options?: SoftDeleteOptions): Promise<SoftDeleteResult>;
+    restore(criteria: string | number | (string | number)[] | Record<string, any>, options?: RestoreOptions): Promise<SoftDeleteResult>;
+    forceDelete(criteria: string | number | (string | number)[] | Record<string, any>): Promise<SoftDeleteResult>;
+    findWithDeleted(options?: FindManyOptions<T>): Promise<T[]>;
+    findOnlyDeleted(options?: FindManyOptions<T>): Promise<T[]>;
+    count(options?: CountOptions<T>): Promise<number>;
+    isSoftDeleted(id: string | number): Promise<boolean>;
+    find(options?: FindManyOptions<T>): Promise<T[]>;
+    findOne(options: FindOneOptions<T>): Promise<T | null>;
+    save<E extends T>(entity: E): Promise<E>;
+    save<E extends T>(entities: E[]): Promise<E[]>;
+    remove(entity: T): Promise<T>;
+    remove(entities: T[]): Promise<T[]>;
+}
+/**
+ * Factory function to create wrapped repository
+ *
+ * @param repository - TypeORM repository to wrap
+ * @returns Wrapped repository with soft delete methods
+ *
+ * @example
+ * ```typescript
+ * const userRepo = withSoftDelete(userRepository);
+ * ```
+ */
+export declare function withSoftDelete<T extends ObjectLiteral>(repository: Repository<T>): SoftDeleteRepository<T>;

package/dist/soft-delete-repository.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SoftDeleteRepository = void 0;
+exports.withSoftDelete = withSoftDelete;
+const soft_delete_operations_1 = require("./soft-delete-operations");
+/**
+ * Optional wrapper class providing repository-style API
+ * Users can choose between functions or this wrapper
+ *
+ * @example
+ * ```typescript
+ * const repo = withSoftDelete(userRepository);
+ * await repo.softDelete(123);
+ * await repo.restore(123);
+ * ```
+ */
+class SoftDeleteRepository {
+    constructor(repository) {
+        this.repository = repository;
+    }
+    // biome-ignore lint/suspicious/noExplicitAny: Generic Record requires any for dynamic keys
+    async softDelete(criteria, options) {
+        return (0, soft_delete_operations_1.softDelete)(this.repository, criteria, options);
+    }
+    // biome-ignore lint/suspicious/noExplicitAny: Generic Record requires any for dynamic keys
+    async restore(criteria, options) {
+        return (0, soft_delete_operations_1.restore)(this.repository, criteria, options);
+    }
+    // biome-ignore lint/suspicious/noExplicitAny: Generic Record requires any for dynamic keys
+    async forceDelete(criteria) {
+        return (0, soft_delete_operations_1.forceDelete)(this.repository, criteria);
+    }
+    async findWithDeleted(options) {
+        return (0, soft_delete_operations_1.findWithDeleted)(this.repository, options);
+    }
+    async findOnlyDeleted(options) {
+        return (0, soft_delete_operations_1.findOnlyDeleted)(this.repository, options);
+    }
+    async count(options) {
+        return (0, soft_delete_operations_1.count)(this.repository, options);
+    }
+    async isSoftDeleted(id) {
+        return (0, soft_delete_operations_1.isSoftDeleted)(this.repository, id);
+    }
+    // Delegate to underlying repository for normal operations
+    find(options) {
+        return this.repository.find(options);
+    }
+    findOne(options) {
+        return this.repository.findOne(options);
+    }
+    async save(entityOrEntities) {
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM save overload requires any
+        return this.repository.save(entityOrEntities);
+    }
+    async remove(entityOrEntities) {
+        // biome-ignore lint/suspicious/noExplicitAny: TypeORM remove overload requires any
+        return this.repository.remove(entityOrEntities);
+    }
+}
+exports.SoftDeleteRepository = SoftDeleteRepository;
+/**
+ * Factory function to create wrapped repository
+ *
+ * @param repository - TypeORM repository to wrap
+ * @returns Wrapped repository with soft delete methods
+ *
+ * @example
+ * ```typescript
+ * const userRepo = withSoftDelete(userRepository);
+ * ```
+ */
+function withSoftDelete(repository) {
+    return new SoftDeleteRepository(repository);
+}
+//# sourceMappingURL=soft-delete-repository.js.map

package/dist/soft-delete-repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft-delete-repository.js","sourceRoot":"","sources":["../src/soft-delete-repository.ts"],"names":[],"mappings":";;;AAoFA,wCAEC;AArFD,qEAAoI;AAGpI;;;;;;;;;;GAUG;AACH,MAAa,oBAAoB;IAC/B,YAA6B,UAAyB;QAAzB,eAAU,GAAV,UAAU,CAAe;IAAG,CAAC;IAE1D,2FAA2F;IAC3F,KAAK,CAAC,UAAU,CAAC,QAAqE,EAAE,OAA2B;QACjH,OAAO,IAAA,mCAAU,EAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,OAAO,CAAC,QAAqE,EAAE,OAAwB;QAC3G,OAAO,IAAA,gCAAO,EAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,WAAW,CAAC,QAAqE;QACrF,OAAO,IAAA,oCAAW,EAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,OAA4B;QAChD,OAAO,IAAA,wCAAe,EAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,OAA4B;QAChD,OAAO,IAAA,wCAAe,EAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAyB;QACnC,OAAO,IAAA,8BAAK,EAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAmB;QACrC,OAAO,IAAA,sCAAa,EAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,0DAA0D;IAC1D,IAAI,CAAC,OAA4B;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,CAAC,OAA0B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAID,KAAK,CAAC,IAAI,CAAc,gBAAyB;QAC/C,iFAAiF;QACjF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAuB,CAAC,CAAC;IACvD,CAAC;IAID,KAAK,CAAC,MAAM,CAAC,gBAAyB;QACpC,mFAAmF;QACnF,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,gBAAuB,CAAC,CAAC;IACzD,CAAC;CACF;AAxDD,oDAwDC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAA0B,UAAyB;IAC/E,OAAO,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAC9C,CAAC"}