Skip to content

chore: Auto-generating typings from the source #1072

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

Merged
merged 17 commits into from
Nov 2, 2020
Merged

chore: Auto-generating typings from the source #1072

merged 17 commits into from
Nov 2, 2020

Conversation

hiranya911
Copy link
Contributor

@hiranya911 hiranya911 commented Oct 22, 2020

Merging the typegen branch into master. Changes include:

  • Removed the manually-curated typings files.
  • Added a single firebase-namespace.d.ts file that defines the typings for the top-level admin namespace. This was necessary to retain service lazy loading.
  • Declared service namespaces and public APIs at a series of {serviceName}/index.ts files.
    • Other implementation files now import public API types from these index files.
  • Updated the gulp file to bundle the generated typings files into the release artifact.
  • Updated the typedoc workflow to generate documentation from auto-generated typings files.

Original proposal for historic context: go/firebase-node-auto-typing
Updated and revamped proposal as implemented here: go/firebase-node-one-source

* chore: Removing ambient typing files

* chore: Added some TODOs to keep track of WIP
…ial (#1035)

* chore: Added the credentials API signatures and exposed admin.credential

* fix: Updated ServiceAccountCredential constructor signature
* chore: Added some TODOs to keep track of WIP

* chore: Declared admin and admin.app namespaces

* fix: Fixing an indentation issue
* chore(iid): Exposed admin.instanceId namespace

* fix: Fixing some bad indentation in comments
* chore(auth): Exposed admin.auth namespace

* fix(auth): Fixing unit tests for SAMLConfig

* fix(auth): Removing more auth. prefixed direct references

* fix(auth): Using CreateTenantRequest explicitly where appropriate
* chore(ml): Exposed admin.machineLearning namespace

* fix(ml): Fixing some code formatting issues
* chore(ml): Exposed admin.machineLearning namespace

* chore: Exposed admin.firestore and admin.storage namespaces

* chore: Merged with upstream; Re-enabled build:tests CI task
* chore: Experimental typedoc pipeline for doc generation

* chore: Adding RTDB type aliases to the API docs

* Updated comments

* Cleaned up the docgen script; Fixed a file name check warning

* fix: Fixed cross links; Fixed a faulty regex replacement in links

* fix: Fixing the remaining cross linkage errors
* chore: Enabled quotes rule in esline config

* fix: Enabled avoidEscape option

* fix: Fixed a typo in an error message
Copy link
Member

@lahirumaramba lahirumaramba left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM

@hiranya911 hiranya911 merged commit 5d72c1b into master Nov 2, 2020
BorntraegerMarc pushed a commit to BorntraegerMarc/firebase-admin-node that referenced this pull request Jan 28, 2021
* chore: Removing ambient typing files (firebase#1032)

* chore: Removing ambient typing files

* chore: Added some TODOs to keep track of WIP

* chore: Added the credentials API signatures and exposed admin.credential (firebase#1035)

* chore: Added the credentials API signatures and exposed admin.credential

* fix: Updated ServiceAccountCredential constructor signature

* chore: Declared admin and admin.app namespaces (firebase#1037)

* chore: Added some TODOs to keep track of WIP

* chore: Declared admin and admin.app namespaces

* fix: Fixing an indentation issue

* fix(rc): Exposed admin.remoteConfig namespace (firebase#1038)

* fix(fcm): Exposed admin.messaging namespace (firebase#1039)

* chore(iid): Exposed admin.instanceId namespace (firebase#1046)

* chore(iid): Exposed admin.instanceId namespace

* fix: Fixing some bad indentation in comments

* chore(rtdb): Exposed admin.database namespace (firebase#1043)

* chore(rules): Exposed admin.securiryRules namespace (firebase#1050)

* chore: Exposed admin.projectManagement namespace (firebase#1054)

* chore(auth): Exposed admin.auth namespace (firebase#1053)

* chore(auth): Exposed admin.auth namespace

* fix(auth): Fixing unit tests for SAMLConfig

* fix(auth): Removing more auth. prefixed direct references

* fix(auth): Using CreateTenantRequest explicitly where appropriate

* chore(ml): Exposed admin.machineLearning namespace (firebase#1055)

* chore(ml): Exposed admin.machineLearning namespace

* fix(ml): Fixing some code formatting issues

* chore: Exposed admin.storage and admin.firestore namespaces (firebase#1056)

* chore(ml): Exposed admin.machineLearning namespace

* chore: Exposed admin.firestore and admin.storage namespaces

* chore: Merged with upstream; Re-enabled build:tests CI task

* chore: Using public API types in FirebaseNamespace impl (firebase#1057)

* chore: Updated TypeDoc workflow to generate API docs (firebase#1060)

* chore: Experimental typedoc pipeline for doc generation

* chore: Adding RTDB type aliases to the API docs

* Updated comments

* Cleaned up the docgen script; Fixed a file name check warning

* fix: Fixed cross links; Fixed a faulty regex replacement in links

* fix: Fixing the remaining cross linkage errors

* chore: Enabled quotes rule in eslint config (firebase#1067)

* chore: Enabled quotes rule in esline config

* fix: Enabled avoidEscape option

* fix: Fixed a typo in an error message
@hiranya911 hiranya911 deleted the typegen branch May 18, 2021 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:stage Stage a release candidate release-note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants