Skip to content

Commit e1d5c08

Browse files
committed
make validateAdminArgs internal
1 parent 69c180b commit e1d5c08

5 files changed

Lines changed: 13 additions & 13 deletions

File tree

etc/firebase-admin.data-connect.api.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,6 @@ export interface OperationOptions {
7575
impersonate?: ImpersonateAuthenticated | ImpersonateUnauthenticated;
7676
}
7777

78-
// @public
79-
export function validateAdminArgs<Variables extends object>(connectorConfig: ConnectorConfig, dcOrVarsOrOptions?: DataConnect | Variables | OperationOptions, varsOrOptions?: Variables | OperationOptions, options?: OperationOptions, hasVars?: boolean, validateVars?: boolean): {
80-
dc: DataConnect;
81-
vars: Variables;
82-
options: OperationOptions;
83-
};
78+
// (No @packageDocumentation comment for this package)
8479

8580
```

src/data-connect/index.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
* @packageDocumentation
2222
*/
2323

24+
import { _validateAdminArgs } from './validate-admin-args';
2425
import { App, getApp } from '../app';
2526
import { FirebaseApp } from '../app/firebase-app';
2627
import { DataConnect, DataConnectService } from './data-connect';
@@ -39,9 +40,6 @@ export {
3940
export {
4041
DataConnect,
4142
} from './data-connect'
42-
export {
43-
validateAdminArgs
44-
} from './validate-admin-args'
4543

4644
/**
4745
* Gets the {@link DataConnect} service with the provided connector configuration
@@ -86,3 +84,8 @@ export function getDataConnect(connectorConfig: ConnectorConfig, app?: App): Dat
8684
const dataConnectService = firebaseApp.getOrInitService('dataConnect', (app) => new DataConnectService(app));
8785
return dataConnectService.getDataConnect(connectorConfig);
8886
}
87+
88+
/**
89+
* @internal
90+
*/
91+
export const validateAdminArgs = _validateAdminArgs;

src/data-connect/validate-admin-args.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import {
2424
} from './data-connect-api-client-internal';
2525

2626
/**
27+
* @internal
28+
*
2729
* The generated Admin SDK will allow the user to pass in variables, a Data Connect
2830
* instance, or operation options. The only required argument is the variables,
2931
* which are only required when the operation has at least one required variable.
@@ -47,7 +49,7 @@ import {
4749
* @param validateVars - boolean parameter indicating whether we should expect to find a value for realVars
4850
* @returns parsed DataConnect, Variables, and Options for the operation
4951
*/
50-
export function validateAdminArgs<Variables extends object>(
52+
export function _validateAdminArgs<Variables extends object>(
5153
connectorConfig: ConnectorConfig,
5254
dcOrVarsOrOptions?: DataConnect | Variables | OperationOptions,
5355
varsOrOptions?: Variables | OperationOptions,

test/integration/data-connect.spec.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
import * as chai from 'chai';
1818
import * as chaiAsPromised from 'chai-as-promised';
19-
import { getDataConnect, ConnectorConfig } from '../../lib/data-connect/index';
19+
import { getDataConnect, ConnectorConfig } from '../../src/data-connect/index';
2020
import firebase from '@firebase/app-compat';
2121
import { apiKey, projectId } from './setup';
22-
import { OperationOptions } from '../../lib/data-connect/data-connect-api';
22+
import { OperationOptions } from '../../src/data-connect/data-connect-api';
2323

2424
chai.should();
2525
chai.use(chaiAsPromised);

test/unit/data-connect/validate-admin-args.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { expect } from 'chai';
1818
import * as sinon from 'sinon';
1919
import { ConnectorConfig, validateAdminArgs } from '../../../src/data-connect';
2020
import { DataConnect } from '../../../src/data-connect/data-connect';
21-
import { OperationOptions } from '../../../lib/data-connect';
21+
import { OperationOptions } from '../../../src/data-connect';
2222
import {
2323
DATA_CONNECT_ERROR_CODE_MAPPING,
2424
FirebaseDataConnectError

0 commit comments

Comments
 (0)