diff --git a/.changeset/proud-trainers-live.md b/.changeset/proud-trainers-live.md new file mode 100644 index 00000000000..81eaae10686 --- /dev/null +++ b/.changeset/proud-trainers-live.md @@ -0,0 +1,5 @@ +--- +"@firebase/data-connect": patch +--- + +Removed exposed internal DataConnect constructor. diff --git a/common/api-review/data-connect.api.md b/common/api-review/data-connect.api.md index 27a9d4af201..e05b0add232 100644 --- a/common/api-review/data-connect.api.md +++ b/common/api-review/data-connect.api.md @@ -4,12 +4,9 @@ ```ts -import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types'; import { FirebaseApp } from '@firebase/app'; -import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { FirebaseError } from '@firebase/util'; import { LogLevelString } from '@firebase/logger'; -import { Provider } from '@firebase/component'; // @public export type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular'; @@ -53,7 +50,6 @@ export interface ConnectorConfig { // @public export class DataConnect { - constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider, _appCheckProvider: Provider); // (undocumented) readonly app: FirebaseApp; // (undocumented) @@ -97,12 +93,6 @@ export interface DataConnectOperationFailureResponseErrorInfo { readonly path: Array; } -// @public -export interface DataConnectOptions extends ConnectorConfig { - // (undocumented) - projectId: string; -} - // @public (undocumented) export interface DataConnectResult extends OpResult { // (undocumented) @@ -216,7 +206,7 @@ export type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR; // @public export interface RefInfo { // (undocumented) - connectorConfig: DataConnectOptions; + connectorConfig: ConnectorConfig; // (undocumented) name: string; // (undocumented) diff --git a/packages/data-connect/src/api/DataConnect.ts b/packages/data-connect/src/api/DataConnect.ts index 15e713ba23b..e3dd8419059 100644 --- a/packages/data-connect/src/api/DataConnect.ts +++ b/packages/data-connect/src/api/DataConnect.ts @@ -104,7 +104,10 @@ export class DataConnect { _isUsingGeneratedSdk: boolean = false; _callerSdkType: CallerSdkType = CallerSdkTypeEnum.Base; private _appCheckTokenProvider?: AppCheckTokenProvider; - // @internal + /** + * @hideconstructor + * @internal + */ constructor( public readonly app: FirebaseApp, // TODO(mtewani): Replace with _dataConnectOptions in the future diff --git a/packages/data-connect/src/api/Reference.ts b/packages/data-connect/src/api/Reference.ts index f9d7687dd18..1b1765bb741 100644 --- a/packages/data-connect/src/api/Reference.ts +++ b/packages/data-connect/src/api/Reference.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { DataConnect, DataConnectOptions } from './DataConnect'; +import { ConnectorConfig, DataConnect } from './DataConnect'; export const QUERY_STR = 'query'; export const MUTATION_STR = 'mutation'; export type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR; @@ -48,7 +48,7 @@ export interface DataConnectResult extends OpResult { export interface RefInfo { name: string; variables: Variables; - connectorConfig: DataConnectOptions; + connectorConfig: ConnectorConfig; } /** * Serialized Ref as a result of `QueryResult.toJSON()` diff --git a/packages/data-connect/src/api/index.ts b/packages/data-connect/src/api/index.ts index 72ee8b313e5..9bcd5d70751 100644 --- a/packages/data-connect/src/api/index.ts +++ b/packages/data-connect/src/api/index.ts @@ -16,7 +16,17 @@ */ export * from '../network'; -export * from './DataConnect'; +export { + ConnectorConfig, + DataConnect, + TransportOptions, + areTransportOptionsEqual, + connectDataConnectEmulator, + getDataConnect, + parseOptions, + terminate, + validateDCOptions +} from './DataConnect'; export * from './Reference'; export * from './Mutation'; export * from './query'; diff --git a/packages/data-connect/src/core/QueryManager.ts b/packages/data-connect/src/core/QueryManager.ts index 109f1d105b4..abcc4b54a91 100644 --- a/packages/data-connect/src/core/QueryManager.ts +++ b/packages/data-connect/src/core/QueryManager.ts @@ -68,7 +68,6 @@ function getRefSerializer( name: queryRef.name, variables: queryRef.variables, connectorConfig: { - projectId: queryRef.dataConnect.app.options.projectId!, ...queryRef.dataConnect.getSettings() } }, diff --git a/packages/data-connect/test/queries.test.ts b/packages/data-connect/test/queries.test.ts index 24db1e4508f..226014fcc05 100644 --- a/packages/data-connect/test/queries.test.ts +++ b/packages/data-connect/test/queries.test.ts @@ -35,7 +35,7 @@ import { terminate } from '../src'; -import { getConnectionConfig, initDatabase, PROJECT_ID } from './util'; +import { getConnectionConfig, initDatabase } from './util'; use(chaiAsPromised); @@ -146,8 +146,7 @@ describe('DataConnect Tests', async () => { fetchTime: Date.now().toLocaleString(), refInfo: { connectorConfig: { - ...getConnectionConfig(), - projectId: PROJECT_ID + ...getConnectionConfig() }, name: taskListQuery.name, variables: { testId: TEST_ID } diff --git a/packages/data-connect/test/unit/queries.test.ts b/packages/data-connect/test/unit/queries.test.ts index 02d19bf856e..a621a1b6467 100644 --- a/packages/data-connect/test/unit/queries.test.ts +++ b/packages/data-connect/test/unit/queries.test.ts @@ -22,7 +22,8 @@ import chaiAsPromised from 'chai-as-promised'; import * as sinon from 'sinon'; import sinonChai from 'sinon-chai'; -import { DataConnectOptions, QueryRef, queryRef, subscribe } from '../../src'; +import { QueryRef, queryRef, subscribe } from '../../src'; +import { DataConnectOptions } from '../../src/api/DataConnect'; import { AuthTokenListener, AuthTokenProvider