Skip to content
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.

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

Generate dts rollups for auth webextension and cordova #8251

Merged
merged 9 commits into from
May 23, 2024

Conversation

dlarocque
Copy link
Contributor

Fixes #8222

auth web-extension and cordova packages had typings that were not rolled up by dts, which caused some compilation errors to arise in the typings files.

The API extractor tool does not work with package names with more than one /, so we have to change the package names for these from @firebase/auth-web-extension -> @firebase/auth-web-extension, and @firebase/auth/cordova -> @firebase/auth-cordova. This does not affect the way we import these packages, since that's done through the firebase package, and the typings are resolved based on the directory name (e.g. ./auth/cordova) rather than the package name.

Note: There are a lot of warnings coming from the API extractor because it is not able to resolve @link's, since these packages don't actually export what their entrypoints export. I currently don't have any ideas on how to fix this.
Example: firebase-js-sdk/packages/auth/dist/web-extension-esm2017/index.web-extension.d.ts:3311:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@firebase/auth-web-extension" does not have an export "ProviderId"

@dlarocque dlarocque requested a review from hsubox76 May 16, 2024 15:43
@dlarocque dlarocque requested review from a team, lisajian, Xiaoshouzi-gh and sam-gc as code owners May 16, 2024 15:43
Copy link

changeset-bot bot commented May 16, 2024

🦋 Changeset detected

Latest commit: a4efa7a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@firebase/auth Patch
@firebase/auth-compat Patch
firebase Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 16, 2024

Size Report 1

Affected Products

  • @firebase/auth-cordova

    TypeBase (3883133)Merge (957db22)Diff
    browser?210 kB? (?)
    module?210 kB? (?)
  • @firebase/auth-web-extension

    TypeBase (3883133)Merge (957db22)Diff
    browser?137 kB? (?)
    main?152 kB? (?)
    module?137 kB? (?)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/ybtXwsHaRx.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 16, 2024

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.

@dlarocque dlarocque requested a review from a team as a code owner May 22, 2024 20:32
@dlarocque dlarocque force-pushed the dlarocque/auth-dts-rollup branch from dda3035 to 491e4ed Compare May 22, 2024 20:44
@dlarocque dlarocque force-pushed the dlarocque/auth-dts-rollup branch from 491e4ed to 138ea2f Compare May 22, 2024 20:49
Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

Looks good pending updating to public types.

@@ -39,11 +39,11 @@
"default": "./dist/esm2017/index.js"
},
"./cordova": {
"types": "./dist/cordova/index.cordova.d.ts",
"types": "./dist/cordova/auth-cordova.d.ts",
Copy link
Contributor

Choose a reason for hiding this comment

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

auth-cordova-public

"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.d.ts",
Copy link
Contributor

Choose a reason for hiding this comment

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

auth-web-extension-public

@dlarocque dlarocque merged commit 0af23e0 into master May 23, 2024
42 of 44 checks passed
@dlarocque dlarocque deleted the dlarocque/auth-dts-rollup branch May 23, 2024 17:12
@google-oss-bot google-oss-bot mentioned this pull request May 23, 2024
@firebase firebase locked and limited conversation to collaborators Jun 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typescript 5.4.5 tsc failing against firebase 10.11.1
3 participants