Skip to content

Commit a8bdda6

Browse files
google-oss-botgoogle-oss-bot
authored
Merge master into release
2 parents 7381f21 + 52d6266 commit a8bdda6

File tree

12 files changed

+660
-23
lines changed

12 files changed

+660
-23
lines changed

Diff for: ‎.changeset/empty-windows-push.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@firebase/vertexai-preview': patch
3+
---
4+
5+
Change `types` paths to point to rolled-up public `d.ts` files. This fixes some TypeScript compiler errors users are seeing.

Diff for: ‎.changeset/wet-hotels-greet.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@firebase/auth': patch
3+
---
4+
5+
Generate dts rollups for auth web extension and cordova

Diff for: ‎.github/workflows/canary-deploy.yml

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ jobs:
7474
NPM_TOKEN_TESTING: ${{secrets.NPM_TOKEN_TESTING}}
7575
NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
7676
NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}}
77+
NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}}
7778
NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
7879
NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
7980
NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

Diff for: ‎.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ tsdoc-metadata.json
9191
# generated html docs
9292
docs-rut/
9393
docs/
94-
toc/
9594

9695
# generated Terraform docs
9796
.terraform/*

Diff for: ‎packages/auth/cordova/api-extractor.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"extends": "../../../config/api-extractor.json",
3+
"mainEntryPointFilePath": "<projectFolder>/dist/cordova/index.cordova.d.ts",
4+
"apiReport": {
5+
"enabled": false
6+
},
7+
"dtsRollup": {
8+
"enabled": true,
9+
"untrimmedFilePath": "<projectFolder>/dist/cordova/<unscopedPackageName>.d.ts",
10+
"publicTrimmedFilePath": "<projectFolder>/dist/cordova/<unscopedPackageName>-public.d.ts"
11+
},
12+
"docModel": {
13+
"enabled": true,
14+
"apiJsonFilePath": "<projectFolder>/temp/subpackages/<unscopedPackageName>.api.json"
15+
}
16+
}

Diff for: ‎packages/auth/cordova/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@firebase/auth/cordova",
2+
"name": "@firebase/auth-cordova",
33
"description": "A Cordova-specific build of the Firebase Auth JS SDK",
44
"browser": "../dist/cordova/index.js",
55
"module": "../dist/cordova/index.js",
6-
"typings": "../dist/cordova/index.cordova.d.ts"
6+
"typings": "../dist/cordova/auth-cordova-public.d.ts"
77
}

Diff for: ‎packages/auth/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@
3939
"default": "./dist/esm2017/index.js"
4040
},
4141
"./cordova": {
42-
"types": "./dist/cordova/index.cordova.d.ts",
42+
"types": "./dist/cordova/auth-cordova-public.d.ts",
4343
"default": "./dist/cordova/index.js"
4444
},
4545
"./web-extension": {
46-
"types:": "./dist/web-extension-esm2017/index.web-extension.d.ts",
46+
"types:": "./dist/web-extension-esm2017/auth-web-extension-public.d.ts",
4747
"import": "./dist/web-extension-esm2017/index.js",
4848
"require": "./dist/web-extension-cjs/index.js",
4949
"default": "./dist/web-extension-esm2017/index.js"
@@ -111,7 +111,7 @@
111111
"test:node:integration": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration",
112112
"test:node:integration:local": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration --local",
113113
"test:webdriver": "rollup -c test/integration/webdriver/static/rollup.config.js && ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --webdriver",
114-
"api-report": "api-extractor run --local --verbose",
114+
"api-report": "api-extractor run --local --verbose --config ./api-extractor.json && api-extractor run --local --verbose --config ./web-extension/api-extractor.json && api-extractor run --local --verbose --config ./cordova/api-extractor.json",
115115
"doc": "api-documenter markdown --input temp --output docs",
116116
"build:doc": "yarn build && yarn doc",
117117
"typings:public": "node ../../scripts/build/use_typings.js ./dist/auth-public.d.ts"

Diff for: ‎packages/auth/web-extension/api-extractor.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"extends": "../../../config/api-extractor.json",
3+
"mainEntryPointFilePath": "<projectFolder>/dist/web-extension-esm2017/index.web-extension.d.ts",
4+
"apiReport": {
5+
"enabled": false
6+
},
7+
"dtsRollup": {
8+
"enabled": true,
9+
"untrimmedFilePath": "<projectFolder>/dist/web-extension-esm2017/<unscopedPackageName>.d.ts",
10+
"publicTrimmedFilePath": "<projectFolder>/dist/web-extension-esm2017/<unscopedPackageName>-public.d.ts"
11+
},
12+
"docModel": {
13+
"enabled": true,
14+
"apiJsonFilePath": "<projectFolder>/temp/subpackages/<unscopedPackageName>.api.json"
15+
}
16+
}

Diff for: ‎packages/auth/web-extension/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "@firebase/auth/web-extension",
2+
"name": "@firebase/auth-web-extension",
33
"description": "A Chrome-Manifest-v3-specific build of the Firebase Auth JS SDK",
44
"main": "../dist/web-extension-cjs/index.js",
55
"browser": "../dist/web-extension-esm2017/index.js",
66
"module": "../dist/web-extension-esm2017/index.js",
7-
"typings": "../dist/web-extension-esm2017/index.web-extension.d.ts"
7+
"typings": "../dist/web-extension-esm2017/auth-web-extension-public.d.ts"
88
}

Diff for: ‎packages/vertexai/package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"module": "dist/esm/index.esm2017.js",
1212
"exports": {
1313
".": {
14-
"types": "./dist/src/index.d.ts",
14+
"types": "./dist/vertexai-preview-public.d.ts",
1515
"node": {
1616
"require": "./dist/index.cjs.js",
1717
"import": "./dist/esm/index.esm2017.js"
@@ -37,7 +37,8 @@
3737
"test": "run-p --npm-path npm lint test:browser",
3838
"test:ci": "yarn testsetup && node ../../scripts/run_tests_in_ci.js -s test",
3939
"test:browser": "yarn testsetup && karma start --single-run",
40-
"api-report": "api-extractor run --local --verbose"
40+
"api-report": "api-extractor run --local --verbose",
41+
"typings:public": "node ../../scripts/build/use_typings.js ./dist/vertexai-preview-public.d.ts"
4142
},
4243
"peerDependencies": {
4344
"@firebase/app": "0.x",

Diff for: ‎scripts/docgen/docgen.ts

+52-13
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,50 @@ yargs
9090
.demandCommand()
9191
.help().argv;
9292

93+
process.on('exit', cleanup);
94+
process.on('SIGINT', cleanup);
95+
96+
let authApiReportOriginal: string;
97+
let authApiConfigOriginal: string;
98+
99+
function cleanup() {
100+
try {
101+
// Restore original auth api-extractor.json contents.
102+
if (authApiReportOriginal) {
103+
console.log(`Restoring original auth api-extractor.json contents.`);
104+
fs.writeFileSync(
105+
`${projectRoot}/packages/auth/api-extractor.json`,
106+
authApiConfigOriginal
107+
);
108+
}
109+
// Restore original auth.api.md
110+
if (authApiConfigOriginal) {
111+
console.log(`Restoring original auth.api.md contents.`);
112+
fs.writeFileSync(
113+
`${projectRoot}/common/api-review/auth.api.md`,
114+
authApiReportOriginal
115+
);
116+
}
117+
for (const excludedPackage of EXCLUDED_PACKAGES) {
118+
if (fs.existsSync(`${projectRoot}/temp/${excludedPackage}.skip`)) {
119+
console.log(
120+
`Restoring json files for excluded package: ${excludedPackage}.`
121+
);
122+
fs.renameSync(
123+
`${projectRoot}/temp/${excludedPackage}.skip`,
124+
`${projectRoot}/temp/${excludedPackage}.api.json`
125+
);
126+
}
127+
}
128+
} catch (e) {
129+
console.error(
130+
'Error cleaning up files on exit - ' +
131+
'check for temp modifications to md and json files.'
132+
);
133+
console.error(e);
134+
}
135+
}
136+
93137
async function generateToc() {
94138
console.log(`Temporarily renaming excluded packages' json files.`);
95139
for (const excludedPackage of EXCLUDED_PACKAGES) {
@@ -115,15 +159,7 @@ async function generateToc() {
115159
{ stdio: 'inherit' }
116160
);
117161
} finally {
118-
console.log(`Restoring excluded packages' json files.`);
119-
for (const excludedPackage of EXCLUDED_PACKAGES) {
120-
if (fs.existsSync(`${projectRoot}/temp/${excludedPackage}.skip`)) {
121-
fs.renameSync(
122-
`${projectRoot}/temp/${excludedPackage}.skip`,
123-
`${projectRoot}/temp/${excludedPackage}.api.json`
124-
);
125-
}
126-
}
162+
cleanup();
127163
}
128164
}
129165

@@ -137,12 +173,12 @@ async function generateDocs(
137173

138174
console.log(`Temporarily modifying auth api-extractor.json for docgen.`);
139175
// Use a special d.ts file for auth for doc gen only.
140-
const authApiConfigOriginal = fs.readFileSync(
176+
authApiConfigOriginal = fs.readFileSync(
141177
`${projectRoot}/packages/auth/api-extractor.json`,
142178
'utf8'
143179
);
144180
// Save original auth.md as well.
145-
const authApiReportOriginal = fs.readFileSync(
181+
authApiReportOriginal = fs.readFileSync(
146182
`${projectRoot}/common/api-review/auth.api.md`,
147183
'utf8'
148184
);
@@ -193,10 +229,13 @@ async function generateDocs(
193229
);
194230
}
195231

196-
if (!fs.existsSync(tmpDir)) {
197-
fs.mkdirSync(tmpDir);
232+
if (fs.existsSync(tmpDir)) {
233+
console.log(`Removing old json temp dir: ${tmpDir}.`);
234+
fs.rmSync(tmpDir, { recursive: true, force: true });
198235
}
199236

237+
fs.mkdirSync(tmpDir);
238+
200239
// TODO: Throw error if path doesn't exist once all packages add markdown support.
201240
const apiJsonDirectories = (
202241
await mapWorkspaceToPackages([`${projectRoot}/packages/*`])

0 commit comments

Comments
 (0)