summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api
diff options
context:
space:
mode:
authoraltaf-creator <dev@altafcreator.com>2025-11-09 11:15:19 +0800
committeraltaf-creator <dev@altafcreator.com>2025-11-09 11:15:19 +0800
commit8eff962cab608341a6f2fedc640a0e32d96f26e2 (patch)
tree05534d1a720ddc3691d346c69b4972555820a061 /frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api
pain
Diffstat (limited to 'frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api')
-rw-r--r--frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts118
-rw-r--r--frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts61
-rw-r--r--frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts51
-rw-r--r--frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts24
-rw-r--r--frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts96
5 files changed, 350 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts
new file mode 100644
index 0000000..9b20a40
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts
@@ -0,0 +1,118 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseApp } from '@firebase/app';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+import { QueryManager } from '../core/QueryManager';
+import { CallerSdkType } from '../network';
+import { MutationManager } from './Mutation';
+/**
+ * Connector Config for calling Data Connect backend.
+ */
+export interface ConnectorConfig {
+ location: string;
+ connector: string;
+ service: string;
+}
+/**
+ * Options to connect to emulator
+ */
+export interface TransportOptions {
+ host: string;
+ sslEnabled?: boolean;
+ port?: number;
+}
+/**
+ *
+ * @param fullHost
+ * @returns TransportOptions
+ * @internal
+ */
+export declare function parseOptions(fullHost: string): TransportOptions;
+/**
+ * DataConnectOptions including project id
+ */
+export interface DataConnectOptions extends ConnectorConfig {
+ projectId: string;
+}
+/**
+ * Class representing Firebase Data Connect
+ */
+export declare class DataConnect {
+ readonly app: FirebaseApp;
+ private readonly dataConnectOptions;
+ private readonly _authProvider;
+ private readonly _appCheckProvider;
+ _queryManager: QueryManager;
+ _mutationManager: MutationManager;
+ isEmulator: boolean;
+ _initialized: boolean;
+ private _transport;
+ private _transportClass;
+ private _transportOptions?;
+ private _authTokenProvider?;
+ _isUsingGeneratedSdk: boolean;
+ _callerSdkType: CallerSdkType;
+ private _appCheckTokenProvider?;
+ constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
+ _useGeneratedSdk(): void;
+ _setCallerSdkType(callerSdkType: CallerSdkType): void;
+ _delete(): Promise<void>;
+ getSettings(): ConnectorConfig;
+ setInitialized(): void;
+ enableEmulator(transportOptions: TransportOptions): void;
+}
+/**
+ * @internal
+ * @param transportOptions1
+ * @param transportOptions2
+ * @returns
+ */
+export declare function areTransportOptionsEqual(transportOptions1: TransportOptions, transportOptions2: TransportOptions): boolean;
+/**
+ * Connect to the DataConnect Emulator
+ * @param dc Data Connect instance
+ * @param host host of emulator server
+ * @param port port of emulator server
+ * @param sslEnabled use https
+ */
+export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
+/**
+ * Initialize DataConnect instance
+ * @param options ConnectorConfig
+ */
+export declare function getDataConnect(options: ConnectorConfig): DataConnect;
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param options ConnectorConfig
+ */
+export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+/**
+ *
+ * @param dcOptions
+ * @returns {void}
+ * @internal
+ */
+export declare function validateDCOptions(dcOptions: ConnectorConfig): boolean;
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
+export declare function terminate(dataConnect: DataConnect): Promise<void>;
diff --git a/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts
new file mode 100644
index 0000000..5a9ddc3
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts
@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DataConnectTransport } from '../network/transport';
+import { DataConnect } from './DataConnect';
+import { DataConnectResult, MUTATION_STR, OperationRef } from './Reference';
+export interface MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
+ refType: typeof MUTATION_STR;
+}
+/**
+ * Creates a `MutationRef`
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ */
+export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName: string): MutationRef<Data, undefined>;
+/**
+ *
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ * @param variables variables to send with mutation
+ */
+export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
+/**
+ * @internal
+ */
+export declare class MutationManager {
+ private _transport;
+ private _inflight;
+ constructor(_transport: DataConnectTransport);
+ executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
+}
+/**
+ * Mutation Result from `executeMutation`
+ */
+export interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
+ ref: MutationRef<Data, Variables>;
+}
+/**
+ * Mutation return value from `executeMutation`
+ */
+export interface MutationPromise<Data, Variables> extends Promise<MutationResult<Data, Variables>> {
+}
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
+export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
diff --git a/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts
new file mode 100644
index 0000000..67549ef
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts
@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DataConnect, DataConnectOptions } from './DataConnect';
+export declare const QUERY_STR = "query";
+export declare const MUTATION_STR = "mutation";
+export type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
+export declare const SOURCE_SERVER = "SERVER";
+export declare const SOURCE_CACHE = "CACHE";
+export type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
+export interface OpResult<Data> {
+ data: Data;
+ source: DataSource;
+ fetchTime: string;
+}
+export interface OperationRef<_Data, Variables> {
+ name: string;
+ variables: Variables;
+ refType: ReferenceType;
+ dataConnect: DataConnect;
+}
+export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
+ ref: OperationRef<Data, Variables>;
+}
+/**
+ * Serialized RefInfo as a result of `QueryResult.toJSON().refInfo`
+ */
+export interface RefInfo<Variables> {
+ name: string;
+ variables: Variables;
+ connectorConfig: DataConnectOptions;
+}
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
+export interface SerializedRef<Data, Variables> extends OpResult<Data> {
+ refInfo: RefInfo<Variables>;
+}
diff --git a/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts
new file mode 100644
index 0000000..ceb0a89
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts
@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from '../network';
+export * from './DataConnect';
+export * from './Reference';
+export * from './Mutation';
+export * from './query';
+export { setLogLevel } from '../logger';
+export { validateArgs } from '../util/validateArgs';
+export { DataConnectErrorCode, Code, DataConnectError, DataConnectOperationError, DataConnectOperationFailureResponse, DataConnectOperationFailureResponseErrorInfo } from '../core/error';
diff --git a/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts
new file mode 100644
index 0000000..93d3863
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts
@@ -0,0 +1,96 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DataConnectError } from '../core/error';
+import { DataConnect } from './DataConnect';
+import { OperationRef, QUERY_STR, DataConnectResult, SerializedRef } from './Reference';
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
+export type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
+export type OnErrorSubscription = (err?: DataConnectError) => void;
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
+export type QueryUnsubscribe = () => void;
+/**
+ * Representation of user provided subscription options.
+ */
+export interface DataConnectSubscription<Data, Variables> {
+ userCallback: OnResultSubscription<Data, Variables>;
+ errCallback?: (e?: DataConnectError) => void;
+ unsubscribe: () => void;
+}
+/**
+ * QueryRef object
+ */
+export interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
+ refType: typeof QUERY_STR;
+}
+/**
+ * Result of `executeQuery`
+ */
+export interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
+ ref: QueryRef<Data, Variables>;
+ toJSON: () => SerializedRef<Data, Variables>;
+}
+/**
+ * Promise returned from `executeQuery`
+ */
+export interface QueryPromise<Data, Variables> extends Promise<QueryResult<Data, Variables>> {
+}
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
+export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @returns `QueryRef`
+ */
+export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @param variables Variables to execute with
+ * @returns `QueryRef`
+ */
+export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
+/**
+ * `OnCompleteSubscription`
+ */
+export type OnCompleteSubscription = () => void;
+/**
+ * Representation of full observer options in `subscribe`
+ */
+export interface SubscriptionOptions<Data, Variables> {
+ onNext?: OnResultSubscription<Data, Variables>;
+ onErr?: OnErrorSubscription;
+ onComplete?: OnCompleteSubscription;
+}