Deployed the page to Github Pages.
This commit is contained in:
parent
1d79754e93
commit
2c89899458
62797 changed files with 6551425 additions and 15279 deletions
108
node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts
generated
vendored
Normal file
108
node_modules/@firebase/data-connect/dist/node-esm/src/api/DataConnect.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,108 @@
|
|||
/**
|
||||
* @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 { 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;
|
||||
private _appCheckTokenProvider?;
|
||||
constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
|
||||
_useGeneratedSdk(): void;
|
||||
_delete(): Promise<void>;
|
||||
getSettings(): ConnectorConfig;
|
||||
setInitialized(): void;
|
||||
enableEmulator(transportOptions: TransportOptions): void;
|
||||
}
|
||||
/**
|
||||
* 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>;
|
61
node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts
generated
vendored
Normal file
61
node_modules/@firebase/data-connect/dist/node-esm/src/api/Mutation.d.ts
generated
vendored
Normal file
|
@ -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 PromiseLike<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>;
|
51
node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts
generated
vendored
Normal file
51
node_modules/@firebase/data-connect/dist/node-esm/src/api/Reference.d.ts
generated
vendored
Normal file
|
@ -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 declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
|
||||
export declare const SOURCE_SERVER = "SERVER";
|
||||
export declare const SOURCE_CACHE = "CACHE";
|
||||
export declare 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>;
|
||||
}
|
23
node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts
generated
vendored
Normal file
23
node_modules/@firebase/data-connect/dist/node-esm/src/api/index.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,23 @@
|
|||
/**
|
||||
* @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';
|
96
node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts
generated
vendored
Normal file
96
node_modules/@firebase/data-connect/dist/node-esm/src/api/query.d.ts
generated
vendored
Normal file
|
@ -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 declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
|
||||
/**
|
||||
* Signature for `OnErrorSubscription` for `subscribe`
|
||||
*/
|
||||
export declare type OnErrorSubscription = (err?: DataConnectError) => void;
|
||||
/**
|
||||
* Signature for unsubscribe from `subscribe`
|
||||
*/
|
||||
export declare 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 PromiseLike<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 declare type OnCompleteSubscription = () => void;
|
||||
/**
|
||||
* Representation of full observer options in `subscribe`
|
||||
*/
|
||||
export interface SubscriptionOptions<Data, Variables> {
|
||||
onNext?: OnResultSubscription<Data, Variables>;
|
||||
onErr?: OnErrorSubscription;
|
||||
onComplete?: OnCompleteSubscription;
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue