@zuzjs/flare 0.2.7 → 0.2.8
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.
- package/README.md +67 -0
- package/dist/index.cjs +3 -3
- package/dist/index.d.cts +34 -24
- package/dist/index.d.ts +34 -24
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -483,13 +483,13 @@ declare function parseValue(val: string): any;
|
|
|
483
483
|
declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | void> {
|
|
484
484
|
private client;
|
|
485
485
|
private collection;
|
|
486
|
-
private
|
|
486
|
+
private docIdFromRef?;
|
|
487
487
|
private whereCondition?;
|
|
488
488
|
private updateData?;
|
|
489
489
|
private setData?;
|
|
490
490
|
private deleteOp;
|
|
491
491
|
private promise?;
|
|
492
|
-
constructor(client: FlareClient<any>, collection: string,
|
|
492
|
+
constructor(client: FlareClient<any>, collection: string, docIdFromRef?: string | undefined);
|
|
493
493
|
/**
|
|
494
494
|
* Set where condition
|
|
495
495
|
*/
|
|
@@ -507,7 +507,7 @@ declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | vo
|
|
|
507
507
|
*/
|
|
508
508
|
delete(): this;
|
|
509
509
|
/**
|
|
510
|
-
* Get the document ID from
|
|
510
|
+
* Get the document ID from doc() reference or where condition.
|
|
511
511
|
*/
|
|
512
512
|
private getDocId;
|
|
513
513
|
/**
|
|
@@ -533,9 +533,7 @@ declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | vo
|
|
|
533
533
|
onSnapshot(callback: SubscriptionCallback<T>): () => void;
|
|
534
534
|
}
|
|
535
535
|
|
|
536
|
-
/**
|
|
537
|
-
* Legacy document reference (for backward compatibility)
|
|
538
|
-
*/
|
|
536
|
+
/** Document reference */
|
|
539
537
|
declare class DocumentReference<T = any> {
|
|
540
538
|
private client;
|
|
541
539
|
readonly collection: string;
|
|
@@ -548,13 +546,8 @@ declare class DocumentReference<T = any> {
|
|
|
548
546
|
onSnapshot(callback: SubscriptionCallback<T>): () => void;
|
|
549
547
|
/**
|
|
550
548
|
* Fires when this document is updated / replaced.
|
|
551
|
-
* Aliases: onDocModified, onDocChange
|
|
552
549
|
*/
|
|
553
550
|
onDocUpdated(callback: DocUpdatedCallback<T>): () => void;
|
|
554
|
-
/** Alias for onDocUpdated */
|
|
555
|
-
onDocModified(callback: DocUpdatedCallback<T>): () => void;
|
|
556
|
-
/** Alias for onDocUpdated */
|
|
557
|
-
onDocChange(callback: DocUpdatedCallback<T>): () => void;
|
|
558
551
|
/**
|
|
559
552
|
* Fires when this document is deleted.
|
|
560
553
|
*/
|
|
@@ -585,6 +578,9 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
585
578
|
private appendAndFilters;
|
|
586
579
|
private toOrNode;
|
|
587
580
|
private toAndNode;
|
|
581
|
+
private isLeafFilter;
|
|
582
|
+
private isIdentityGuard;
|
|
583
|
+
private splitIdentityGuards;
|
|
588
584
|
private appendOrFilters;
|
|
589
585
|
private appendFilters;
|
|
590
586
|
with<Name extends keyof TPresetMap & string>(name: Name, params: QueryPresetParams<TPresetMap[Name]>): CollectionQuery<QueryPresetRow<TPresetMap[Name]>, TPresetMap>;
|
|
@@ -622,6 +618,8 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
622
618
|
orNotExists(field: string): CollectionQuery<T, TPresetMap>;
|
|
623
619
|
/** Get items starting from the most recently created (descending sequence) */
|
|
624
620
|
latest(): CollectionQuery<T, TPresetMap>;
|
|
621
|
+
/** Get items starting from the most recently created (descending sequence) */
|
|
622
|
+
newest(): CollectionQuery<T, TPresetMap>;
|
|
625
623
|
/** Get items starting from the first ever created (ascending sequence) */
|
|
626
624
|
oldest(): CollectionQuery<T, TPresetMap>;
|
|
627
625
|
orderBy(field: string, dir?: "asc" | "desc"): CollectionQuery<T, TPresetMap>;
|
|
@@ -641,6 +639,9 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
641
639
|
groupBy(...fields: string[]): CollectionQuery<T, TPresetMap>;
|
|
642
640
|
having(field: string, op: HavingClause['op'], value: number): CollectionQuery<T, TPresetMap>;
|
|
643
641
|
private buildStructuredJoin;
|
|
642
|
+
private cloneStructuredJoin;
|
|
643
|
+
private appendNestedJoinByAlias;
|
|
644
|
+
private parseRelationRef;
|
|
644
645
|
/**
|
|
645
646
|
* Join another collection into this query.
|
|
646
647
|
*
|
|
@@ -648,19 +649,26 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
648
649
|
* @param j Join mapping clause.
|
|
649
650
|
* @example
|
|
650
651
|
* flare.collection("boards")
|
|
651
|
-
* .
|
|
652
|
+
* .join("tasks", { source: "id", target: "boardId", as: "tasks" })
|
|
652
653
|
* .get();
|
|
653
654
|
*/
|
|
655
|
+
join(collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
656
|
+
/**
|
|
657
|
+
* Append a nested join under an existing join alias.
|
|
658
|
+
* Example:
|
|
659
|
+
* .join("lists", { source: "id", target: "boardId", as: "lists" })
|
|
660
|
+
* .joinNested("lists", "cards", { source: "id", target: "listId", as: "cards" })
|
|
661
|
+
*/
|
|
662
|
+
joinNested(parentAlias: string, collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
654
663
|
Join(collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
664
|
+
JoinNested(parentAlias: string, collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
655
665
|
/**
|
|
656
|
-
*
|
|
657
|
-
*
|
|
666
|
+
* SQL-like relation shorthand.
|
|
667
|
+
* Example: .withRelation("team.uid->users.id", { as: "teamMembers" })
|
|
658
668
|
*/
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
collection?: string;
|
|
663
|
-
}): CollectionQuery<T, TPresetMap>;
|
|
669
|
+
withRelation(relation: string, options?: (Omit<JoinClause, 'source' | 'target' | 'as'> & {
|
|
670
|
+
as?: string;
|
|
671
|
+
})): CollectionQuery<T, TPresetMap>;
|
|
664
672
|
select(...fields: string[]): CollectionQuery<T, TPresetMap>;
|
|
665
673
|
/** Returns unique values for a single field */
|
|
666
674
|
distinctField(field: string): CollectionQuery<T, TPresetMap>;
|
|
@@ -670,6 +678,10 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
670
678
|
* col.vectorSearch({ field: "embedding", vector: [...1536 numbers...], k: 10 })
|
|
671
679
|
*/
|
|
672
680
|
vectorSearch(opts: VectorSearchClause): CollectionQuery<T, TPresetMap>;
|
|
681
|
+
getRawQuery(): {
|
|
682
|
+
collection: string;
|
|
683
|
+
query: StructuredQuery;
|
|
684
|
+
};
|
|
673
685
|
get(): Promise<T[]>;
|
|
674
686
|
private _isStructured;
|
|
675
687
|
private _execute;
|
|
@@ -696,8 +708,6 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
696
708
|
asStore(options?: CollectionStreamOptions<T>): CollectionExternalStore<T>;
|
|
697
709
|
onDocAdded(callback: DocAddedCallback<T>): () => void;
|
|
698
710
|
onDocUpdated(callback: DocUpdatedCallback<T>): () => void;
|
|
699
|
-
onDocModified(callback: DocUpdatedCallback<T>): () => void;
|
|
700
|
-
onDocChange(callback: DocUpdatedCallback<T>): () => void;
|
|
701
711
|
onDocDeleted(callback: DocDeletedCallback<T>): () => void;
|
|
702
712
|
onDocChanged(callback: DocChangedCallback<T>): () => void;
|
|
703
713
|
add(data: Partial<T>): Promise<DocumentReference<T>>;
|
|
@@ -799,7 +809,7 @@ type ActiveSubscription = {
|
|
|
799
809
|
liveId: string;
|
|
800
810
|
collection: string;
|
|
801
811
|
docId?: string;
|
|
802
|
-
query?:
|
|
812
|
+
query?: StructuredQuery;
|
|
803
813
|
callback: SubscriptionCallback;
|
|
804
814
|
options: SubscribeOptions;
|
|
805
815
|
};
|
|
@@ -934,7 +944,7 @@ declare class FlareBase<TPresetMap extends QueryPresetMap = {}> {
|
|
|
934
944
|
protected toSubscriptionError(err: unknown): SubscriptionError;
|
|
935
945
|
protected emitSubscriptionError(baseId: string, error: SubscriptionError): void;
|
|
936
946
|
protected replayActiveSubscriptions(): Promise<void>;
|
|
937
|
-
subscribe(subId: string, collection: string, docId: string | undefined, query:
|
|
947
|
+
subscribe(subId: string, collection: string, docId: string | undefined, query: StructuredQuery | undefined, callback: SubscriptionCallback, options?: SubscribeOptions): SubscriptionHandle;
|
|
938
948
|
send(type: FlareAction, payload: any): Promise<any>;
|
|
939
949
|
private handleTransportError;
|
|
940
950
|
protected onConnected(): void;
|
|
@@ -1482,4 +1492,4 @@ declare const getFlare: () => FlareClient | null;
|
|
|
1482
1492
|
*/
|
|
1483
1493
|
declare const disconnectFlare: () => void;
|
|
1484
1494
|
|
|
1485
|
-
export { type AggregateFunction, type AggregateSpec, type AndFilter, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionExternalStore, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type CollectionStream, type CollectionStreamListener, type CollectionStreamMeta, type CollectionStreamOptions, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StreamFlushReason, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler,
|
|
1495
|
+
export { type AggregateFunction, type AggregateSpec, type AndFilter, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionExternalStore, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type CollectionStream, type CollectionStreamListener, type CollectionStreamMeta, type CollectionStreamOptions, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, FlareClient, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StreamFlushReason, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };
|
package/dist/index.d.ts
CHANGED
|
@@ -483,13 +483,13 @@ declare function parseValue(val: string): any;
|
|
|
483
483
|
declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | void> {
|
|
484
484
|
private client;
|
|
485
485
|
private collection;
|
|
486
|
-
private
|
|
486
|
+
private docIdFromRef?;
|
|
487
487
|
private whereCondition?;
|
|
488
488
|
private updateData?;
|
|
489
489
|
private setData?;
|
|
490
490
|
private deleteOp;
|
|
491
491
|
private promise?;
|
|
492
|
-
constructor(client: FlareClient<any>, collection: string,
|
|
492
|
+
constructor(client: FlareClient<any>, collection: string, docIdFromRef?: string | undefined);
|
|
493
493
|
/**
|
|
494
494
|
* Set where condition
|
|
495
495
|
*/
|
|
@@ -507,7 +507,7 @@ declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | vo
|
|
|
507
507
|
*/
|
|
508
508
|
delete(): this;
|
|
509
509
|
/**
|
|
510
|
-
* Get the document ID from
|
|
510
|
+
* Get the document ID from doc() reference or where condition.
|
|
511
511
|
*/
|
|
512
512
|
private getDocId;
|
|
513
513
|
/**
|
|
@@ -533,9 +533,7 @@ declare class DocumentQueryBuilder<T = any> implements PromiseLike<T | null | vo
|
|
|
533
533
|
onSnapshot(callback: SubscriptionCallback<T>): () => void;
|
|
534
534
|
}
|
|
535
535
|
|
|
536
|
-
/**
|
|
537
|
-
* Legacy document reference (for backward compatibility)
|
|
538
|
-
*/
|
|
536
|
+
/** Document reference */
|
|
539
537
|
declare class DocumentReference<T = any> {
|
|
540
538
|
private client;
|
|
541
539
|
readonly collection: string;
|
|
@@ -548,13 +546,8 @@ declare class DocumentReference<T = any> {
|
|
|
548
546
|
onSnapshot(callback: SubscriptionCallback<T>): () => void;
|
|
549
547
|
/**
|
|
550
548
|
* Fires when this document is updated / replaced.
|
|
551
|
-
* Aliases: onDocModified, onDocChange
|
|
552
549
|
*/
|
|
553
550
|
onDocUpdated(callback: DocUpdatedCallback<T>): () => void;
|
|
554
|
-
/** Alias for onDocUpdated */
|
|
555
|
-
onDocModified(callback: DocUpdatedCallback<T>): () => void;
|
|
556
|
-
/** Alias for onDocUpdated */
|
|
557
|
-
onDocChange(callback: DocUpdatedCallback<T>): () => void;
|
|
558
551
|
/**
|
|
559
552
|
* Fires when this document is deleted.
|
|
560
553
|
*/
|
|
@@ -585,6 +578,9 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
585
578
|
private appendAndFilters;
|
|
586
579
|
private toOrNode;
|
|
587
580
|
private toAndNode;
|
|
581
|
+
private isLeafFilter;
|
|
582
|
+
private isIdentityGuard;
|
|
583
|
+
private splitIdentityGuards;
|
|
588
584
|
private appendOrFilters;
|
|
589
585
|
private appendFilters;
|
|
590
586
|
with<Name extends keyof TPresetMap & string>(name: Name, params: QueryPresetParams<TPresetMap[Name]>): CollectionQuery<QueryPresetRow<TPresetMap[Name]>, TPresetMap>;
|
|
@@ -622,6 +618,8 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
622
618
|
orNotExists(field: string): CollectionQuery<T, TPresetMap>;
|
|
623
619
|
/** Get items starting from the most recently created (descending sequence) */
|
|
624
620
|
latest(): CollectionQuery<T, TPresetMap>;
|
|
621
|
+
/** Get items starting from the most recently created (descending sequence) */
|
|
622
|
+
newest(): CollectionQuery<T, TPresetMap>;
|
|
625
623
|
/** Get items starting from the first ever created (ascending sequence) */
|
|
626
624
|
oldest(): CollectionQuery<T, TPresetMap>;
|
|
627
625
|
orderBy(field: string, dir?: "asc" | "desc"): CollectionQuery<T, TPresetMap>;
|
|
@@ -641,6 +639,9 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
641
639
|
groupBy(...fields: string[]): CollectionQuery<T, TPresetMap>;
|
|
642
640
|
having(field: string, op: HavingClause['op'], value: number): CollectionQuery<T, TPresetMap>;
|
|
643
641
|
private buildStructuredJoin;
|
|
642
|
+
private cloneStructuredJoin;
|
|
643
|
+
private appendNestedJoinByAlias;
|
|
644
|
+
private parseRelationRef;
|
|
644
645
|
/**
|
|
645
646
|
* Join another collection into this query.
|
|
646
647
|
*
|
|
@@ -648,19 +649,26 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
648
649
|
* @param j Join mapping clause.
|
|
649
650
|
* @example
|
|
650
651
|
* flare.collection("boards")
|
|
651
|
-
* .
|
|
652
|
+
* .join("tasks", { source: "id", target: "boardId", as: "tasks" })
|
|
652
653
|
* .get();
|
|
653
654
|
*/
|
|
655
|
+
join(collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
656
|
+
/**
|
|
657
|
+
* Append a nested join under an existing join alias.
|
|
658
|
+
* Example:
|
|
659
|
+
* .join("lists", { source: "id", target: "boardId", as: "lists" })
|
|
660
|
+
* .joinNested("lists", "cards", { source: "id", target: "listId", as: "cards" })
|
|
661
|
+
*/
|
|
662
|
+
joinNested(parentAlias: string, collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
654
663
|
Join(collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
664
|
+
JoinNested(parentAlias: string, collectionName: string, j: JoinClause): CollectionQuery<T, TPresetMap>;
|
|
655
665
|
/**
|
|
656
|
-
*
|
|
657
|
-
*
|
|
666
|
+
* SQL-like relation shorthand.
|
|
667
|
+
* Example: .withRelation("team.uid->users.id", { as: "teamMembers" })
|
|
658
668
|
*/
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
collection?: string;
|
|
663
|
-
}): CollectionQuery<T, TPresetMap>;
|
|
669
|
+
withRelation(relation: string, options?: (Omit<JoinClause, 'source' | 'target' | 'as'> & {
|
|
670
|
+
as?: string;
|
|
671
|
+
})): CollectionQuery<T, TPresetMap>;
|
|
664
672
|
select(...fields: string[]): CollectionQuery<T, TPresetMap>;
|
|
665
673
|
/** Returns unique values for a single field */
|
|
666
674
|
distinctField(field: string): CollectionQuery<T, TPresetMap>;
|
|
@@ -670,6 +678,10 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
670
678
|
* col.vectorSearch({ field: "embedding", vector: [...1536 numbers...], k: 10 })
|
|
671
679
|
*/
|
|
672
680
|
vectorSearch(opts: VectorSearchClause): CollectionQuery<T, TPresetMap>;
|
|
681
|
+
getRawQuery(): {
|
|
682
|
+
collection: string;
|
|
683
|
+
query: StructuredQuery;
|
|
684
|
+
};
|
|
673
685
|
get(): Promise<T[]>;
|
|
674
686
|
private _isStructured;
|
|
675
687
|
private _execute;
|
|
@@ -696,8 +708,6 @@ declare class CollectionReference<T = any, TPresetMap extends QueryPresetMap = {
|
|
|
696
708
|
asStore(options?: CollectionStreamOptions<T>): CollectionExternalStore<T>;
|
|
697
709
|
onDocAdded(callback: DocAddedCallback<T>): () => void;
|
|
698
710
|
onDocUpdated(callback: DocUpdatedCallback<T>): () => void;
|
|
699
|
-
onDocModified(callback: DocUpdatedCallback<T>): () => void;
|
|
700
|
-
onDocChange(callback: DocUpdatedCallback<T>): () => void;
|
|
701
711
|
onDocDeleted(callback: DocDeletedCallback<T>): () => void;
|
|
702
712
|
onDocChanged(callback: DocChangedCallback<T>): () => void;
|
|
703
713
|
add(data: Partial<T>): Promise<DocumentReference<T>>;
|
|
@@ -799,7 +809,7 @@ type ActiveSubscription = {
|
|
|
799
809
|
liveId: string;
|
|
800
810
|
collection: string;
|
|
801
811
|
docId?: string;
|
|
802
|
-
query?:
|
|
812
|
+
query?: StructuredQuery;
|
|
803
813
|
callback: SubscriptionCallback;
|
|
804
814
|
options: SubscribeOptions;
|
|
805
815
|
};
|
|
@@ -934,7 +944,7 @@ declare class FlareBase<TPresetMap extends QueryPresetMap = {}> {
|
|
|
934
944
|
protected toSubscriptionError(err: unknown): SubscriptionError;
|
|
935
945
|
protected emitSubscriptionError(baseId: string, error: SubscriptionError): void;
|
|
936
946
|
protected replayActiveSubscriptions(): Promise<void>;
|
|
937
|
-
subscribe(subId: string, collection: string, docId: string | undefined, query:
|
|
947
|
+
subscribe(subId: string, collection: string, docId: string | undefined, query: StructuredQuery | undefined, callback: SubscriptionCallback, options?: SubscribeOptions): SubscriptionHandle;
|
|
938
948
|
send(type: FlareAction, payload: any): Promise<any>;
|
|
939
949
|
private handleTransportError;
|
|
940
950
|
protected onConnected(): void;
|
|
@@ -1482,4 +1492,4 @@ declare const getFlare: () => FlareClient | null;
|
|
|
1482
1492
|
*/
|
|
1483
1493
|
declare const disconnectFlare: () => void;
|
|
1484
1494
|
|
|
1485
|
-
export { type AggregateFunction, type AggregateSpec, type AndFilter, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionExternalStore, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type CollectionStream, type CollectionStreamListener, type CollectionStreamMeta, type CollectionStreamOptions, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StreamFlushReason, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler,
|
|
1495
|
+
export { type AggregateFunction, type AggregateSpec, type AndFilter, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionExternalStore, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type CollectionStream, type CollectionStreamListener, type CollectionStreamMeta, type CollectionStreamOptions, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, FlareClient, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StreamFlushReason, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };
|