Skip to content

Generate dts rollups for auth webextension and cordova #8251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 23, 2024
Merged

Generate dts rollups for auth webextension and cordova #8251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4583e82
Generate dts rollups for auth webextension and cordova
dlarocque May 16, 2024
371971a
Add changeset
dlarocque May 16, 2024
ff7cdf5
Disable API report generation
dlarocque May 16, 2024
1c3a494
Remove old API reports
dlarocque May 16, 2024
333bb0f
Create new typings file rather than overwrite entrypoint
dlarocque May 22, 2024
138ea2f
doc gen output
dlarocque May 22, 2024
4848399
Fix node esm typing files
dlarocque May 22, 2024
7b0765a
fix
dlarocque May 22, 2024
a4efa7a
Make auth cordova and webextension exports public typings
dlarocque May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wet-hotels-greet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/auth': patch
---

Generate dts rollups for auth web extension and cordova
16 changes: 16 additions & 0 deletions packages/auth/cordova/api-extractor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"extends": "../../../config/api-extractor.json",
"mainEntryPointFilePath": "<projectFolder>/dist/cordova/index.cordova.d.ts",
"apiReport": {
"enabled": false
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/cordova/<unscopedPackageName>.d.ts",
"publicTrimmedFilePath": "<projectFolder>/dist/cordova/<unscopedPackageName>-public.d.ts"
},
"docModel": {
"enabled": true,
"apiJsonFilePath": "<projectFolder>/temp/subpackages/<unscopedPackageName>.api.json"
}
}
4 changes: 2 additions & 2 deletions packages/auth/cordova/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@firebase/auth/cordova",
"name": "@firebase/auth-cordova",
"description": "A Cordova-specific build of the Firebase Auth JS SDK",
"browser": "../dist/cordova/index.js",
"module": "../dist/cordova/index.js",
"typings": "../dist/cordova/index.cordova.d.ts"
"typings": "../dist/cordova/auth-cordova-public.d.ts"
}
6 changes: 3 additions & 3 deletions packages/auth/package.json
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have to get lines 42 and 46 in this file. I think that Node ESM uses them.

Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@
"default": "./dist/esm2017/index.js"
},
"./cordova": {
"types": "./dist/cordova/index.cordova.d.ts",
"types": "./dist/cordova/auth-cordova-public.d.ts",
"default": "./dist/cordova/index.js"
},
"./web-extension": {
"types:": "./dist/web-extension-esm2017/index.web-extension.d.ts",
"types:": "./dist/web-extension-esm2017/auth-web-extension-public.d.ts",
"import": "./dist/web-extension-esm2017/index.js",
"require": "./dist/web-extension-cjs/index.js",
"default": "./dist/web-extension-esm2017/index.js"
Expand Down Expand Up @@ -111,7 +111,7 @@
"test:node:integration": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration",
"test:node:integration:local": "ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --integration --local",
"test:webdriver": "rollup -c test/integration/webdriver/static/rollup.config.js && ts-node -O '{\"module\": \"commonjs\", \"target\": \"es6\"}' scripts/run_node_tests.ts --webdriver",
"api-report": "api-extractor run --local --verbose",
"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",
"doc": "api-documenter markdown --input temp --output docs",
"build:doc": "yarn build && yarn doc",
"typings:public": "node ../../scripts/build/use_typings.js ./dist/auth-public.d.ts"
Expand Down
16 changes: 16 additions & 0 deletions packages/auth/web-extension/api-extractor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"extends": "../../../config/api-extractor.json",
"mainEntryPointFilePath": "<projectFolder>/dist/web-extension-esm2017/index.web-extension.d.ts",
"apiReport": {
"enabled": false
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/web-extension-esm2017/<unscopedPackageName>.d.ts",
"publicTrimmedFilePath": "<projectFolder>/dist/web-extension-esm2017/<unscopedPackageName>-public.d.ts"
},
"docModel": {
"enabled": true,
"apiJsonFilePath": "<projectFolder>/temp/subpackages/<unscopedPackageName>.api.json"
}
}
4 changes: 2 additions & 2 deletions packages/auth/web-extension/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@firebase/auth/web-extension",
"name": "@firebase/auth-web-extension",
"description": "A Chrome-Manifest-v3-specific build of the Firebase Auth JS SDK",
"main": "../dist/web-extension-cjs/index.js",
"browser": "../dist/web-extension-esm2017/index.js",
"module": "../dist/web-extension-esm2017/index.js",
"typings": "../dist/web-extension-esm2017/index.web-extension.d.ts"
"typings": "../dist/web-extension-esm2017/auth-web-extension-public.d.ts"
}