Skip to content

Commit 1f5fa03

Browse files
committed
Updated typings
1 parent f08d28d commit 1f5fa03

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

common/api-review/data-connect.api.md

+32-8
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,35 @@ export class DataConnect {
5252
setInitialized(): void;
5353
}
5454

55+
// @public
56+
export class DataConnectError extends FirebaseError {
57+
}
58+
59+
// @public (undocumented)
60+
export type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
61+
62+
// @public
63+
export class DataConnectOperationError extends DataConnectError {
64+
/* Excluded from this release type: name */
65+
readonly response: DataConnectOperationResponse;
66+
}
67+
68+
// @public (undocumented)
69+
export interface DataConnectOperationErrorInfo {
70+
// (undocumented)
71+
readonly message: string;
72+
// (undocumented)
73+
readonly path: Array<string | number>;
74+
}
75+
76+
// @public (undocumented)
77+
export interface DataConnectOperationResponse {
78+
// (undocumented)
79+
readonly data?: Record<string, unknown> | null;
80+
// (undocumented)
81+
readonly errors: DataConnectOperationErrorInfo[];
82+
}
83+
5584
// @public
5685
export interface DataConnectOptions extends ConnectorConfig {
5786
// (undocumented)
@@ -67,7 +96,7 @@ export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
6796
// @public
6897
export interface DataConnectSubscription<Data, Variables> {
6998
// (undocumented)
70-
errCallback?: (e?: FirebaseError) => void;
99+
errCallback?: (e?: DataConnectError) => void;
71100
// (undocumented)
72101
unsubscribe: () => void;
73102
// (undocumented)
@@ -83,9 +112,6 @@ export function executeMutation<Data, Variables>(mutationRef: MutationRef<Data,
83112
// @public
84113
export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
85114

86-
// @public (undocumented)
87-
export const fdcSymbol: unique symbol;
88-
89115
// @public
90116
export function getDataConnect(options: ConnectorConfig): DataConnect;
91117

@@ -121,15 +147,13 @@ export interface MutationResult<Data, Variables> extends DataConnectResult<Data,
121147
export type OnCompleteSubscription = () => void;
122148

123149
// @public
124-
export type OnErrorSubscription = (err?: FirebaseError) => void;
150+
export type OnErrorSubscription = (err?: DataConnectError) => void;
125151

126152
// @public
127153
export type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
128154

129155
// @public (undocumented)
130-
export interface OperationRef<Data, Variables> {
131-
// (undocumented)
132-
[fdcSymbol]?: Data;
156+
export interface OperationRef<_Data, Variables> {
133157
// (undocumented)
134158
dataConnect: DataConnect;
135159
// (undocumented)

packages/data-connect/src/api/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export { validateArgs } from '../util/validateArgs';
2525

2626
export { DataConnectError, DataConnectOperationError } from '../core/error';
2727

28-
export type {
28+
export {
2929
DataConnectErrorCode,
3030
DataConnectOperationResponse,
3131
DataConnectOperationErrorInfo

0 commit comments

Comments
 (0)