@dereekb/dbx-firebase 12.6.19 → 12.6.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,6 +22,10 @@ export interface DbxFirebaseModelEntity {
22
22
  * Used for sorting/grouping by expected entity type.
23
23
  */
24
24
  readonly modelIdentity: FirestoreModelIdentity;
25
+ /**
26
+ * Optional name for
27
+ */
28
+ readonly name?: Maybe<string>;
25
29
  /**
26
30
  * An associated store for the document, if it is available.
27
31
  */
@@ -16,6 +16,8 @@ export declare class DbxFirebaseModelEntitiesEntityComponent implements OnDestro
16
16
  readonly type: import("dist/packages/firebase/src").FirestoreModelIdentityType;
17
17
  }>;
18
18
  readonly store$: Observable<import("@dereekb/dbx-firebase").DbxFirebaseDocumentReadOnlyStore<any, any>>;
19
+ readonly storeName$: Observable<Maybe<string>>;
20
+ readonly displayName$: Observable<Maybe<string>>;
19
21
  readonly loadingState$: Observable<import("@dereekb/rxjs").LoadingState<any>>;
20
22
  readonly currentData$: Observable<any>;
21
23
  readonly currentWidgetEntry$: Observable<import("./model.entities.widget.service").DbxFirebaseModelEntitiesWidgetEntry>;
@@ -24,6 +26,7 @@ export declare class DbxFirebaseModelEntitiesEntityComponent implements OnDestro
24
26
  readonly displayInfo$: Observable<DbxFirebaseModelDisplayInfo>;
25
27
  readonly widgetInjectionConfig$: Observable<import("./model.entities.widget").DbxFirebaseModelEntitiesWidgetInjectionConfig | null>;
26
28
  readonly hasTypeInfoSignal: import("@angular/core").Signal<boolean | undefined>;
29
+ readonly displayNameSignal: import("@angular/core").Signal<Maybe<string>>;
27
30
  readonly displayInfoSignal: import("@angular/core").Signal<import("@dereekb/dbx-core").IconAndTitle | undefined>;
28
31
  readonly modelIdentitySignal: import("@angular/core").Signal<(import("dist/packages/firebase/src").FirestoreModelTypeRef<string> & import("dist/packages/firebase/src").FirestoreCollectionNameRef<string> & import("dist/packages/firebase/src").FirestoreCollectionTypeRef & {
29
32
  readonly type: import("dist/packages/firebase/src").FirestoreModelIdentityType;
@@ -7,8 +7,9 @@ import * as i0 from "@angular/core";
7
7
  export declare class DbxFirebaseModelKeyComponent {
8
8
  readonly dbxFirebaseModelTypesService: DbxFirebaseModelTypesService;
9
9
  readonly modelKey: import("@angular/core").InputSignal<string | undefined>;
10
- readonly oneWayFlatModelKey: import("@angular/core").Signal<string | undefined>;
11
- readonly twoWayFlatModelKey: import("@angular/core").Signal<string | undefined>;
10
+ readonly modelKeyIdSignal: import("@angular/core").Signal<string | undefined>;
11
+ readonly oneWayFlatModelKeySignal: import("@angular/core").Signal<string | undefined>;
12
+ readonly twoWayFlatModelKeySignal: import("@angular/core").Signal<string | undefined>;
12
13
  readonly modelKey$: import("rxjs").Observable<string | undefined>;
13
14
  readonly modelTypeInstance$: import("rxjs").Observable<DbxFirebaseModelTypesServiceInstance<any, string> | undefined>;
14
15
  readonly modelIdentity$: import("rxjs").Observable<import("@dereekb/firebase").FirestoreModelIdentity | undefined>;
@@ -7,6 +7,10 @@ import { type Observable, type Subscription } from 'rxjs';
7
7
  * Provides read-only accessors to a single model/document.
8
8
  */
9
9
  export interface DbxFirebaseDocumentReadOnlyStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
10
+ /**
11
+ * String used to identify the store. Typically only for debugging UI purposes.
12
+ */
13
+ readonly storeName$: Observable<Maybe<string>>;
10
14
  readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
11
15
  readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
12
16
  readonly currentInputId$: Observable<Maybe<FirestoreModelId>>;
@@ -44,6 +48,10 @@ export interface DbxFirebaseDocumentReadOnlyStore<T, D extends FirestoreDocument
44
48
  * Provides accessors to a single model/document.
45
49
  */
46
50
  export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseDocumentReadOnlyStore<T, D>, LockSetComponent {
51
+ /**
52
+ * Sets the name of the store.
53
+ */
54
+ readonly setStoreName: (observableOrValue: ObservableOrValue<Maybe<string>>) => Subscription;
47
55
  /**
48
56
  * Sets the id of the document to load.
49
57
  */
@@ -7,6 +7,7 @@ import { DbxFirebaseDocumentStore } from './store';
7
7
  import * as i0 from "@angular/core";
8
8
  export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, C extends DbxFirebaseDocumentStoreContextState<T, D> = DbxFirebaseDocumentStoreContextState<T, D>> extends LockSetComponentStore<C> implements DbxFirebaseDocumentStore<T, D> {
9
9
  protected constructor(initialState?: C);
10
+ readonly storeName$: Observable<Maybe<string>>;
10
11
  readonly currentFirestoreCollectionLike$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
11
12
  readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollection<T, D>>>;
12
13
  readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
@@ -48,6 +49,7 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
48
49
  readonly exists$: Observable<boolean>;
49
50
  readonly doesNotExist$: Observable<boolean>;
50
51
  readonly modelIdentity$: Observable<FirestoreModelIdentity>;
52
+ readonly setStoreName: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
51
53
  readonly setId: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
52
54
  readonly setKey: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
53
55
  readonly setFlatKey: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
@@ -89,6 +91,7 @@ export declare class AbstractRootSingleItemDbxFirebaseDocument<T, D extends Fire
89
91
  readonly clearRefs: () => void;
90
92
  }
91
93
  export interface DbxFirebaseDocumentStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
94
+ readonly storeName?: Maybe<string>;
92
95
  readonly firestoreCollectionLike?: Maybe<FirestoreCollectionLike<T, D>>;
93
96
  readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
94
97
  readonly streamMode?: FirestoreAccessorStreamMode;
@@ -10,11 +10,13 @@ import * as i0 from "@angular/core";
10
10
  * Abstract directive that contains a DbxFirebaseDocumentStore and provides an interface for communicating with other directives.
11
11
  */
12
12
  export declare abstract class DbxFirebaseDocumentStoreDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseDocumentStore<T, D> = DbxFirebaseDocumentStore<T, D>> implements DbxFirebaseDocumentStoreTwoWayKeyProvider, DbxRouteModelIdDirectiveDelegate, DbxRouteModelKeyDirectiveDelegate, OnDestroy {
13
+ readonly storeName: import("@angular/core").ModelSignal<Maybe<string>>;
13
14
  readonly documentId: import("@angular/core").ModelSignal<Maybe<string>>;
14
15
  readonly key: import("@angular/core").ModelSignal<Maybe<string>>;
15
16
  readonly flatKey: import("@angular/core").ModelSignal<Maybe<string>>;
16
17
  readonly ref: import("@angular/core").ModelSignal<Maybe<DocumentReference<T>>>;
17
18
  readonly streamMode: import("@angular/core").ModelSignal<FirestoreAccessorStreamMode>;
19
+ private readonly _storeName$;
18
20
  private readonly _documentId$;
19
21
  private readonly _key$;
20
22
  private readonly _flatKey$;
@@ -38,6 +40,7 @@ export declare abstract class DbxFirebaseDocumentStoreDirective<T = unknown, D e
38
40
  constructor(store: S);
39
41
  ngOnDestroy(): void;
40
42
  get store(): S;
43
+ setStoreName(storeName: Maybe<string>): void;
41
44
  setDocumentId(documentId: Maybe<FirestoreModelId>): void;
42
45
  setKey(key: Maybe<FirestoreModelKey>): void;
43
46
  setFlatKey(flatKey: Maybe<TwoWayFlatFirestoreModelKey>): void;
@@ -50,7 +53,7 @@ export declare abstract class DbxFirebaseDocumentStoreDirective<T = unknown, D e
50
53
  useRouteModelIdParamsObservable(idFromParams: Observable<Maybe<ModelKey>>): Subscription;
51
54
  useRouteModelKeyParamsObservable(keyFromParams: Observable<Maybe<TwoWayFlatFirestoreModelKey>>): Subscription;
52
55
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never>;
53
- static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never, never, { "documentId": { "alias": "documentId"; "required": false; "isSignal": true; }; "key": { "alias": "key"; "required": false; "isSignal": true; }; "flatKey": { "alias": "flatKey"; "required": false; "isSignal": true; }; "ref": { "alias": "ref"; "required": false; "isSignal": true; }; "streamMode": { "alias": "streamMode"; "required": false; "isSignal": true; }; }, { "documentId": "documentIdChange"; "key": "keyChange"; "flatKey": "flatKeyChange"; "ref": "refChange"; "streamMode": "streamModeChange"; }, never, never, false, never>;
56
+ static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never, never, { "storeName": { "alias": "storeName"; "required": false; "isSignal": true; }; "documentId": { "alias": "documentId"; "required": false; "isSignal": true; }; "key": { "alias": "key"; "required": false; "isSignal": true; }; "flatKey": { "alias": "flatKey"; "required": false; "isSignal": true; }; "ref": { "alias": "ref"; "required": false; "isSignal": true; }; "streamMode": { "alias": "streamMode"; "required": false; "isSignal": true; }; }, { "storeName": "storeNameChange"; "documentId": "documentIdChange"; "key": "keyChange"; "flatKey": "flatKeyChange"; "ref": "refChange"; "streamMode": "streamModeChange"; }, never, never, false, never>;
54
57
  }
55
58
  /**
56
59
  * Configures providers for a DbxFirebaseDocumentStoreDirective.
@@ -3,3 +3,5 @@ export * from './storagefile.collection.store.directive';
3
3
  export * from './storagefile.document.store';
4
4
  export * from './storagefile.document.store.directive';
5
5
  export * from './storagefile.upload.store';
6
+ export * from './storagefilegroup.document.store';
7
+ export * from './storagefilegroup.document.store.directive';
@@ -0,0 +1,11 @@
1
+ import { AbstractDbxFirebaseDocumentStore } from '../../../model/modules/store';
2
+ import { StorageFileGroup, StorageFileGroupDocument, StorageFileFunctions } from '@dereekb/firebase';
3
+ import * as i0 from "@angular/core";
4
+ export declare class StorageFileGroupDocumentStore extends AbstractDbxFirebaseDocumentStore<StorageFileGroup, StorageFileGroupDocument> {
5
+ readonly storageFileFunctions: StorageFileFunctions;
6
+ constructor();
7
+ readonly updateStorageFileGroup: import("../../../model/modules/store").DbxFirebaseDocumentStoreFunction<import("@dereekb/firebase").UpdateStorageFileGroupParams, void>;
8
+ readonly regenerateStorageFileGroupContent: import("../../../model/modules/store").DbxFirebaseDocumentStoreCrudFunction<import("@dereekb/firebase").RegenerateStorageFileGroupContentParams, import("@dereekb/firebase").RegenerateStorageFileGroupContentResult>;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<StorageFileGroupDocumentStore, never>;
10
+ static ɵprov: i0.ɵɵInjectableDeclaration<StorageFileGroupDocumentStore>;
11
+ }
@@ -0,0 +1,9 @@
1
+ import { DbxFirebaseDocumentStoreDirective } from '../../../model/modules/store';
2
+ import { StorageFileGroupDocumentStore } from './storagefilegroup.document.store';
3
+ import { StorageFileGroup, StorageFileGroupDocument } from '@dereekb/firebase';
4
+ import * as i0 from "@angular/core";
5
+ export declare class DbxFirebaseStorageFileGroupDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective<StorageFileGroup, StorageFileGroupDocument, StorageFileGroupDocumentStore> {
6
+ constructor(store: StorageFileGroupDocumentStore);
7
+ static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseStorageFileGroupDocumentStoreDirective, never>;
8
+ static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseStorageFileGroupDocumentStoreDirective, "[dbxFirebaseStorageFileGroupDocument]", never, {}, {}, never, never, true, never>;
9
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dereekb/dbx-firebase",
3
- "version": "12.6.19",
3
+ "version": "12.6.21",
4
4
  "peerDependencies": {
5
5
  "@angular/core": "^18.0.0",
6
6
  "@dereekb/dbx-analytics": "*",