@dereekb/dbx-core 12.6.21 → 12.7.0

package/lib/router/router/transition/transition.watcher.directive.d.ts

@@ -1,14 +1,12 @@
-import { NgZone, OnDestroy, OnInit } from '@angular/core';
+import { NgZone } from '@angular/core';
 import { AbstractTransitionDirective } from './transition.directive';
 import * as i0 from "@angular/core";
 /**
  * Abstract directive that listens to onSuccess transition events and runs a function.
  */
-export declare abstract class AbstractTransitionWatcherDirective extends AbstractTransitionDirective implements OnInit, OnDestroy {
-    private readonly _transitionSub;
+export declare abstract class AbstractTransitionWatcherDirective extends AbstractTransitionDirective {
     protected readonly ngZone: NgZone;
-    ngOnInit(): void;
-    ngOnDestroy(): void;
+    constructor();
     protected zoneUpdateForSuccessfulTransition(): void;
     protected abstract updateForSuccessfulTransition(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractTransitionWatcherDirective, never>;

package/lib/rxjs/clean.d.ts

@@ -0,0 +1,16 @@
+import { type Destroyable, type DestroyFunction } from '@dereekb/util';
+import { type Subject } from 'rxjs';
+/**
+ * Wraps a Destroyable in a function that registers the input Destroyable to be destroyed
+ * when the DestroyRef is destroyed in the context.
+ *
+ * Must be run in an Angular injection context.
+ */
+export declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
+/**
+ * Wraps a Subject in a function that registers the input Subject to be completed
+ * when the DestroyRef is destroyed in the context.
+ *
+ * Must be run in an Angular injection context.
+ */
+export declare function completeOnDestroy<T extends Pick<Subject<any>, 'complete' | 'error'>>(input: T): T;

package/lib/rxjs/destroy.d.ts

@@ -0,0 +1,7 @@
+import { type DestroyFunction, DestroyFunctionObject, type Maybe } from '@dereekb/util';
+/**
+ * Creates a new DestroyFunctionObject that is automatically destroyed when the context is destroyed.
+ *
+ * Must be run within an Angular injection context.
+ */
+export declare function cleanDestroy(input?: Maybe<DestroyFunction>): DestroyFunctionObject;

package/lib/rxjs/index.d.ts

@@ -0,0 +1,6 @@
+export * from './clean';
+export * from './rxjs.directive';
+export * from './lockset';
+export * from './subscription';
+export * from './loading';
+export * from './destroy';

package/lib/rxjs/loading.d.ts

@@ -0,0 +1,13 @@
+import { type LoadingState, type LoadingContextEvent, type LoadingStateContextInput, type MutableLoadingStateContext, type ListLoadingState, type ListLoadingStateContextInput, type MutableListLoadingStateContext } from '@dereekb/rxjs';
+/**
+ * Creates a new LoadingStateContext that is automatically destroyed when the context is destroyed.
+ *
+ * Must be run within an Angular injection context.
+ */
+export declare function cleanLoadingContext<T = unknown, S extends LoadingState<T> = LoadingState<T>, E extends LoadingContextEvent = LoadingContextEvent & S>(input?: LoadingStateContextInput<T, S, E>): MutableLoadingStateContext<T, S, E>;
+/**
+ * Creates a new ListLoadingStateContext that is automatically destroyed when the context is destroyed.
+ *
+ * Must be run within an Angular injection context.
+ */
+export declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState<L> = ListLoadingState<L>>(input?: ListLoadingStateContextInput<L, S>): MutableListLoadingStateContext<L, S>;

package/lib/rxjs/lockset.d.ts

@@ -0,0 +1,47 @@
+import { type DestroyOnNextUnlockConfig, LockSet, SubscriptionObject } from '@dereekb/rxjs';
+import { type DestroyFunction, type GetterOrValue, type Maybe } from '@dereekb/util';
+import { type Unsubscribable } from 'rxjs';
+export interface CleanLockSetConfig {
+    /**
+     * Arbitrary onDestroy function to call when onDestroy is called by the internal DestroyRef.
+     */
+    readonly onDestroy?: Maybe<() => void>;
+    /**
+     * Called when the LockSet is finally destroyed.
+     */
+    readonly onLockSetDestroy?: Maybe<() => void>;
+    /**
+     * Configures when the lockset should be destroyed.
+     */
+    readonly destroyLocksetTiming?: Maybe<DestroyOnNextUnlockConfig>;
+}
+/**
+ * Creates a new LockSet that is automatically destroyed when the component is destroyed.
+ *
+ * Must be run within an Angular injection context.
+ *
+ * @param onLockSetDestroy Optional callback to run when the lockset is unlocked.
+ */
+export declare function cleanLockSet(config?: Maybe<CleanLockSetConfig>): LockSet;
+/**
+ * Runs the given onDestroy function when the context is destroyed, and the lock set's next unlock occurs.
+ *
+ * Must be run within an Angular injection context.
+ *
+ * @param lockSet The lockset to use.
+ * @param onDestroy The function to run when the lockset is unlocked.
+ */
+export declare function cleanWithLockSet(lockSet: LockSet, onDestroy: DestroyFunction): void;
+/**
+ * Config for cleanSubscriptionWithLockSet()
+ */
+export interface CleanSubscriptionWithLockSetConfig<T extends Unsubscribable = Unsubscribable> {
+    readonly lockSet: LockSet;
+    readonly sub?: Maybe<GetterOrValue<T>>;
+}
+/**
+ * Creates a new SubscriptionObject that is automatically destroyed when the context is destroyed, and the lock set's next unlock occurs.
+ *
+ * Must be run within an Angular injection context.
+ */
+export declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubscribable>(input: CleanSubscriptionWithLockSetConfig<T>): SubscriptionObject<T>;

package/lib/{subscription/subscription.directive.d.ts → rxjs/rxjs.directive.d.ts}

@@ -5,6 +5,8 @@ import { type Maybe } from '@dereekb/util';
 import * as i0 from "@angular/core";
 /**
  * Abstract component that contains a SubscriptionObject and will clean it up automatically.
+ *
+ * @deprecated Consider using cleanSubscription() directly instead, as it performs the same functionality
  */
 export declare abstract class AbstractSubscriptionDirective<T extends Unsubscribable = Unsubscribable> implements OnDestroy {
     private readonly _subscriptionObject;
@@ -15,6 +17,8 @@ export declare abstract class AbstractSubscriptionDirective<T extends Unsubscrib
 }
 /**
  * AbstractSubscriptionDirective extension that prevents the OnDestroy from occuring until the lockset is unlocked.
+ *
+ * @deprecated Consider using cleanLockSet() directly instead, as it performs the same functionality.
  */
 export declare abstract class AbstractLockSetSubscriptionDirective<T extends Unsubscribable = Unsubscribable> extends AbstractSubscriptionDirective<T> implements OnDestroy {
     readonly lockSet: LockSet;

package/lib/rxjs/subscription.d.ts

@@ -0,0 +1,9 @@
+import { SubscriptionObject } from '@dereekb/rxjs';
+import { type GetterOrValue, type Maybe } from '@dereekb/util';
+import { type Unsubscribable } from 'rxjs';
+/**
+ * Creates a new SubscriptionObject that is automatically destroyed when the context is destroyed.
+ *
+ * Must be run within an Angular injection context.
+ */
+export declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(sub?: Maybe<GetterOrValue<T>>): SubscriptionObject<T>;

package/lib/view/if.directive.d.ts

@@ -1,17 +1,17 @@
 import { OnInit } from '@angular/core';
 import { Observable } from 'rxjs';
-import { AbstractSubscriptionDirective } from '../subscription';
 import * as i0 from "@angular/core";
 /**
  * Abstract directive class that watches a show$ observable and behaves like *ngIf.
  */
-export declare abstract class AbstractIfDirective extends AbstractSubscriptionDirective implements OnInit {
+export declare abstract class AbstractIfDirective implements OnInit {
     private readonly _templateRef;
     private readonly _viewContainer;
     /**
      * Observable that is watched for showing/hiding.
      */
     abstract readonly show$: Observable<boolean>;
+    private readonly _sub;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractIfDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractIfDirective, never, never, {}, {}, never, never, false, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-core",
-  "version": "12.6.21",
+  "version": "12.7.0",
   "peerDependencies": {
     "@dereekb/util": "*",
     "@dereekb/rxjs": "*",

package/esm2022/lib/subscription/index.mjs

@@ -1,2 +0,0 @@
-export * from './subscription.directive';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9wYWNrYWdlcy9kYngtY29yZS9zcmMvbGliL3N1YnNjcmlwdGlvbi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLDBCQUEwQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9zdWJzY3JpcHRpb24uZGlyZWN0aXZlJztcbiJdfQ==

package/esm2022/lib/subscription/subscription.directive.mjs

@@ -1,38 +0,0 @@
-import { Directive } from '@angular/core';
-import { SubscriptionObject, LockSet } from '@dereekb/rxjs';
-import * as i0 from "@angular/core";
-/**
- * Abstract component that contains a SubscriptionObject and will clean it up automatically.
- */
-export class AbstractSubscriptionDirective {
-    _subscriptionObject = new SubscriptionObject();
-    ngOnDestroy() {
-        this._subscriptionObject.destroy();
-    }
-    set sub(subscription) {
-        this._subscriptionObject.subscription = subscription;
-    }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: AbstractSubscriptionDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
-    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "18.2.13", type: AbstractSubscriptionDirective, ngImport: i0 });
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: AbstractSubscriptionDirective, decorators: [{
-            type: Directive
-        }] });
-/**
- * AbstractSubscriptionDirective extension that prevents the OnDestroy from occuring until the lockset is unlocked.
- */
-export class AbstractLockSetSubscriptionDirective extends AbstractSubscriptionDirective {
-    lockSet = new LockSet();
-    ngOnDestroy() {
-        this.lockSet.onNextUnlock(() => this.onLockSetDestroy());
-    }
-    onLockSetDestroy() {
-        super.ngOnDestroy();
-    }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: AbstractLockSetSubscriptionDirective, deps: null, target: i0.ɵɵFactoryTarget.Directive });
-    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "18.2.13", type: AbstractLockSetSubscriptionDirective, usesInheritance: true, ngImport: i0 });
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: AbstractLockSetSubscriptionDirective, decorators: [{
-            type: Directive
-        }] });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3Vic2NyaXB0aW9uLmRpcmVjdGl2ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2RieC1jb3JlL3NyYy9saWIvc3Vic2NyaXB0aW9uL3N1YnNjcmlwdGlvbi5kaXJlY3RpdmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFhLFNBQVMsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUVyRCxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsT0FBTyxFQUFFLE1BQU0sZUFBZSxDQUFDOztBQUc1RDs7R0FFRztBQUVILE1BQU0sT0FBZ0IsNkJBQTZCO0lBQ2hDLG1CQUFtQixHQUFHLElBQUksa0JBQWtCLEVBQUUsQ0FBQztJQUVoRSxXQUFXO1FBQ1QsSUFBSSxDQUFDLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ3JDLENBQUM7SUFFRCxJQUFjLEdBQUcsQ0FBQyxZQUE2QjtRQUM3QyxJQUFJLENBQUMsbUJBQW1CLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztJQUN2RCxDQUFDO3dHQVRtQiw2QkFBNkI7NEZBQTdCLDZCQUE2Qjs7NEZBQTdCLDZCQUE2QjtrQkFEbEQsU0FBUzs7QUFhVjs7R0FFRztBQUVILE1BQU0sT0FBZ0Isb0NBQWdGLFNBQVEsNkJBQWdDO0lBQ25JLE9BQU8sR0FBRyxJQUFJLE9BQU8sRUFBRSxDQUFDO0lBRXhCLFdBQVc7UUFDbEIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsR0FBRyxFQUFFLENBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFFLENBQUMsQ0FBQztJQUMzRCxDQUFDO0lBRVMsZ0JBQWdCO1FBQ3hCLEtBQUssQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUN0QixDQUFDO3dHQVRtQixvQ0FBb0M7NEZBQXBDLG9DQUFvQzs7NEZBQXBDLG9DQUFvQztrQkFEekQsU0FBUyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE9uRGVzdHJveSwgRGlyZWN0aXZlIH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XG5pbXBvcnQgeyBVbnN1YnNjcmliYWJsZSB9IGZyb20gJ3J4anMnO1xuaW1wb3J0IHsgU3Vic2NyaXB0aW9uT2JqZWN0LCBMb2NrU2V0IH0gZnJvbSAnQGRlcmVla2Ivcnhqcyc7XG5pbXBvcnQgeyB0eXBlIE1heWJlIH0gZnJvbSAnQGRlcmVla2IvdXRpbCc7XG5cbi8qKlxuICogQWJzdHJhY3QgY29tcG9uZW50IHRoYXQgY29udGFpbnMgYSBTdWJzY3JpcHRpb25PYmplY3QgYW5kIHdpbGwgY2xlYW4gaXQgdXAgYXV0b21hdGljYWxseS5cbiAqL1xuQERpcmVjdGl2ZSgpXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgQWJzdHJhY3RTdWJzY3JpcHRpb25EaXJlY3RpdmU8VCBleHRlbmRzIFVuc3Vic2NyaWJhYmxlID0gVW5zdWJzY3JpYmFibGU+IGltcGxlbWVudHMgT25EZXN0cm95IHtcbiAgcHJpdmF0ZSByZWFkb25seSBfc3Vic2NyaXB0aW9uT2JqZWN0ID0gbmV3IFN1YnNjcmlwdGlvbk9iamVjdCgpO1xuXG4gIG5nT25EZXN0cm95KCk6IHZvaWQge1xuICAgIHRoaXMuX3N1YnNjcmlwdGlvbk9iamVjdC5kZXN0cm95KCk7XG4gIH1cblxuICBwcm90ZWN0ZWQgc2V0IHN1YihzdWJzY3JpcHRpb246IE1heWJlPFQgfCB2b2lkPikge1xuICAgIHRoaXMuX3N1YnNjcmlwdGlvbk9iamVjdC5zdWJzY3JpcHRpb24gPSBzdWJzY3JpcHRpb247XG4gIH1cbn1cblxuLyoqXG4gKiBBYnN0cmFjdFN1YnNjcmlwdGlvbkRpcmVjdGl2ZSBleHRlbnNpb24gdGhhdCBwcmV2ZW50cyB0aGUgT25EZXN0cm95IGZyb20gb2NjdXJpbmcgdW50aWwgdGhlIGxvY2tzZXQgaXMgdW5sb2NrZWQuXG4gKi9cbkBEaXJlY3RpdmUoKVxuZXhwb3J0IGFic3RyYWN0IGNsYXNzIEFic3RyYWN0TG9ja1NldFN1YnNjcmlwdGlvbkRpcmVjdGl2ZTxUIGV4dGVuZHMgVW5zdWJzY3JpYmFibGUgPSBVbnN1YnNjcmliYWJsZT4gZXh0ZW5kcyBBYnN0cmFjdFN1YnNjcmlwdGlvbkRpcmVjdGl2ZTxUPiBpbXBsZW1lbnRzIE9uRGVzdHJveSB7XG4gIHJlYWRvbmx5IGxvY2tTZXQgPSBuZXcgTG9ja1NldCgpO1xuXG4gIG92ZXJyaWRlIG5nT25EZXN0cm95KCk6IHZvaWQge1xuICAgIHRoaXMubG9ja1NldC5vbk5leHRVbmxvY2soKCkgPT4gdGhpcy5vbkxvY2tTZXREZXN0cm95KCkpO1xuICB9XG5cbiAgcHJvdGVjdGVkIG9uTG9ja1NldERlc3Ryb3koKTogdm9pZCB7XG4gICAgc3VwZXIubmdPbkRlc3Ryb3koKTtcbiAgfVxufVxuIl19

package/lib/subscription/index.d.ts

@@ -1 +0,0 @@
-export * from './subscription.directive';