Update Client Reporting for Data Connect

.github/workflows/prerelease-manual-deploy.yml

@@ -55,6 +55,7 @@ jobs:
             NPM_TOKEN_AUTH_INTEROP_TYPES: ${{secrets.NPM_TOKEN_AUTH_INTEROP_TYPES}}
             NPM_TOKEN_AUTH_TYPES: ${{secrets.NPM_TOKEN_AUTH_TYPES}}
             NPM_TOKEN_COMPONENT: ${{secrets.NPM_TOKEN_COMPONENT}}
+            NPM_TOKEN_DATA_CONNECT: ${{secrets.NPM_TOKEN_DATA_CONNECT}}
             NPM_TOKEN_DATABASE: ${{secrets.NPM_TOKEN_DATABASE}}
             NPM_TOKEN_DATABASE_TYPES: ${{secrets.NPM_TOKEN_DATABASE_TYPES}}
             NPM_TOKEN_FIRESTORE: ${{secrets.NPM_TOKEN_FIRESTORE}}

.github/workflows/release-prod.yml

@@ -65,6 +65,7 @@ jobs:
         NPM_TOKEN_AUTH_INTEROP_TYPES: ${{secrets.NPM_TOKEN_AUTH_INTEROP_TYPES}}
         NPM_TOKEN_AUTH_TYPES: ${{secrets.NPM_TOKEN_AUTH_TYPES}}
         NPM_TOKEN_COMPONENT: ${{secrets.NPM_TOKEN_COMPONENT}}
+        NPM_TOKEN_DATA_CONNECT: ${{secrets.NPM_TOKEN_DATA_CONNECT}}
         NPM_TOKEN_DATABASE: ${{secrets.NPM_TOKEN_DATABASE}}
         NPM_TOKEN_DATABASE_TYPES: ${{secrets.NPM_TOKEN_DATABASE_TYPES}}
         NPM_TOKEN_FIRESTORE: ${{secrets.NPM_TOKEN_FIRESTORE}}

.github/workflows/release-staging.yml

@@ -91,6 +91,7 @@ jobs:
         NPM_TOKEN_AUTH_INTEROP_TYPES: ${{secrets.NPM_TOKEN_AUTH_INTEROP_TYPES}}
         NPM_TOKEN_AUTH_TYPES: ${{secrets.NPM_TOKEN_AUTH_TYPES}}
         NPM_TOKEN_COMPONENT: ${{secrets.NPM_TOKEN_COMPONENT}}
+        NPM_TOKEN_DATA_CONNECT: ${{secrets.NPM_TOKEN_DATA_CONNECT}}
         NPM_TOKEN_DATABASE: ${{secrets.NPM_TOKEN_DATABASE}}
         NPM_TOKEN_DATABASE_TYPES: ${{secrets.NPM_TOKEN_DATABASE_TYPES}}
         NPM_TOKEN_FIRESTORE: ${{secrets.NPM_TOKEN_FIRESTORE}}

.vscode/settings.json

@@ -11,5 +11,6 @@
   },
   "typescript.tsdk": "node_modules/typescript/lib",
   "files.associations": { "*.json": "jsonc" },
-  "eslint.workingDirectories": [{ "mode": "auto" }]
+  "eslint.workingDirectories": [{ "mode": "auto" }],
+  "editor.wordWrap": "off",
 }

common/api-review/connect.api.md

@@ -0,0 +1,133 @@
+## API Report File for "@firebase/connect"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { FirebaseApp } from '@firebase/app';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+
+// @public (undocumented)
+export function connectDataConnectEmulator(dc: DataConnect, host: string, port: number, isSecure?: boolean): void;
+
+// @public (undocumented)
+export interface Converter<Response> {
+    // (undocumented)
+    fromDataConnect: (data: DataConnectSnapshot<unknown>) => Response;
+    // (undocumented)
+    fromResponse: (response: Response) => DataConnectSnapshot<unknown>;
+}
+
+// @public (undocumented)
+export class DataConnect {
+    constructor(firebaseApp: FirebaseApp, authProvider: Provider<FirebaseAuthInternalName>, transportOptions: TransportOptions, projectOptions: ProjectOptions, appCheckProvider?: Provider<AppCheckInternalComponentName>, useRest?: boolean);
+    // (undocumented)
+    enableEmulator(host: string, port: number, isSecure: boolean): void;
+    // (undocumented)
+    setInitialized(): void;
+    }
+
+// @public (undocumented)
+export interface DataConnectOptions {
+    // (undocumented)
+    projectOptions: ProjectOptions;
+    // (undocumented)
+    transportOptions?: TransportOptions;
+}
+
+// @public (undocumented)
+export interface DataConnectSnapshot<Response> {
+    // (undocumented)
+    data: Response;
+}
+
+// @public (undocumented)
+export interface DataConnectSubscription<Response> {
+    // (undocumented)
+    converter: Converter<Response>;
+    // (undocumented)
+    unsubscribe: () => void;
+    // (undocumented)
+    userCallback: (data: Response | undefined, error?: Error) => void;
+}
+
+// @public (undocumented)
+export function executeMutation<Response, Variables>(mutationRef: Mutation<Response, Variables>): Promise<Response>;
+
+// @public (undocumented)
+export function executeQuery<Response, Variables>(queryRef: Query<Response, Variables>): Promise<Response>;
+
+// @public (undocumented)
+export const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
+
+// @public (undocumented)
+export function getDataConnect(app: FirebaseApp, options: DataConnectOptions): DataConnect;
+
+// @public (undocumented)
+export function getDataConnect(options: DataConnectOptions): DataConnect;
+
+// @public (undocumented)
+export interface Mutation<Response, Variables> extends Reference<Response, Variables> {
+    // (undocumented)
+    dcInstance: DataConnect;
+}
+
+// @public (undocumented)
+export function mutationRef<Response, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): Mutation<Response, Variables>;
+
+// @public (undocumented)
+export interface ProjectOptions {
+    // (undocumented)
+    connector: string;
+    // (undocumented)
+    location: string;
+    // (undocumented)
+    project: string;
+    // (undocumented)
+    service: string;
+}
+
+// @public (undocumented)
+export interface Query<Response, Variables> extends Reference<Response, Variables> {
+    // (undocumented)
+    dcInstance: DataConnect;
+}
+
+// @public (undocumented)
+export function queryRef<Response, Variables = undefined>(dcInstance: DataConnect, queryName: string, variables?: Variables): Query<Response, Variables>;
+
+// @public (undocumented)
+export interface Reference<_Response, Variables> {
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    refType: ReferenceType;
+    // (undocumented)
+    variables: Variables;
+}
+
+// @public (undocumented)
+export enum ReferenceType {
+    // (undocumented)
+    Mutation = "m",
+    // (undocumented)
+    Query = "q"
+}
+
+// @public (undocumented)
+export function subscribe<Response, Variables>(queryRef: Query<Response, Variables>, onSubscribe: DataConnectSubscription<Response>['userCallback'], converter: Converter<Response>): void;
+
+// @public (undocumented)
+export interface TransportOptions {
+    // (undocumented)
+    host: string;
+    // (undocumented)
+    isSecure: boolean;
+    // (undocumented)
+    port: number;
+}
+
+
+```