@@ -25,10 +25,16 @@ const yaml = require('js-yaml');
2525
2626const repoPath = path . resolve ( `${ __dirname } ) ;
2727
28+ const defaultSources = [
29+ `${ repoPath } ,
30+ `${ repoPath } ,
31+ `${ repoPath } ,
32+ ] ;
33+
2834// Command-line options.
2935const { source : sourceFile } = yargs
3036 . option ( 'source' , {
31- default : ` ${ repoPath } /src/*.d.ts` ,
37+ default : defaultSources . join ( ' ' ) ,
3238 describe : 'Typescript source file(s)' ,
3339 type : 'string'
3440 } )
@@ -51,6 +57,17 @@ const firestoreHeader = `<section class="tsd-panel-group tsd-member-group ">
5157 <ul>` ;
5258const firestoreFooter = '\n </ul>\n</section>\n' ;
5359
60+ const databaseExcludes = [ 'enableLogging' ] ;
61+ const databaseHtmlPath = `${ docPath } ;
62+ const databaseHeader = `<section class="tsd-panel-group tsd-member-group ">
63+ <h2>Type aliases</h2>
64+ <div class="tsd-panel">
65+ <p>Following types are defined in the <code>@firebase/database</code> package
66+ and re-exported from this namespace for convenience.</p>
67+ </div>
68+ <ul>` ;
69+ const databaseFooter = '\n </ul>\n</section>\n' ;
70+
5471/**
5572 * Strips path prefix and returns only filename.
5673 * @param {string } path
@@ -99,7 +116,7 @@ function fixLinks(file) {
99116 . replace ( / ( m o d u l e s | i n t e r f a c e s | c l a s s e s | e n u m s ) \/ / g, '' ) ;
100117 let caseFixedLinks = flattenedLinks ;
101118 for ( const lower in lowerToUpperLookup ) {
102- const re = new RegExp ( lower , 'g' ) ;
119+ const re = new RegExp ( '\\b' + lower , 'g' ) ;
103120 caseFixedLinks = caseFixedLinks . replace ( re , lowerToUpperLookup [ lower ] ) ;
104121 }
105122 return fs . writeFile ( file , caseFixedLinks ) ;
@@ -119,7 +136,7 @@ function generateTempHomeMdFile(tocRaw, homeRaw) {
119136 const { toc } = yaml . safeLoad ( tocRaw ) ;
120137 let tocPageLines = [ homeRaw , '# API Reference' ] ;
121138 toc . forEach ( group => {
122- tocPageLines . push ( `\n## [${ group . title } ${ stripPath ( group . path ) } ) ;
139+ tocPageLines . push ( `\n## [${ group . title } ${ stripPath ( group . path ) } .html )` ) ;
123140 const section = group . section || [ ] ;
124141 section . forEach ( item => {
125142 tocPageLines . push ( `- [${ item . title } ${ stripPath ( item . path ) } ) ;
@@ -150,13 +167,13 @@ function checkForMissingFilesAndFixFilenameCase() {
150167 // Preferred filename for devsite should be capitalized and taken from
151168 // toc.yaml.
152169 const tocFilePath = `${ docPath } ${ filename } ;
153- // Generated filename from Typedoc will be lowercase.
154- const generatedFilePath = `${ docPath } ${ filename . toLowerCase ( ) } ;
170+ // Generated filename from Typedoc will be lowercase and won't have the admin prefix .
171+ const generatedFilePath = `${ docPath } ${ filename . toLowerCase ( ) . replace ( 'admin.' , '' ) } ;
155172 return fs . exists ( generatedFilePath ) . then ( exists => {
156173 if ( exists ) {
157174 // Store in a lookup table for link fixing.
158175 lowerToUpperLookup [
159- `${ filename . toLowerCase ( ) }
176+ `${ filename . toLowerCase ( ) . replace ( 'admin.' , '' ) }
160177 ] = `${ filename } ;
161178 return fs . rename ( generatedFilePath , tocFilePath ) ;
162179 } else {
@@ -167,6 +184,7 @@ function checkForMissingFilesAndFixFilenameCase() {
167184 }
168185 } ) ;
169186 } ) ;
187+
170188 return Promise . all ( fileCheckPromises ) . then ( ( ) => filenames ) ;
171189}
172190
@@ -253,15 +271,16 @@ function fixAllLinks(htmlFiles) {
253271 * Updates the auto-generated Firestore API references page, by appending
254272 * the specified HTML content block.
255273 *
274+ * @param {string } htmlPath Path of the HTML file to update.
256275 * @param {string } contentBlock The HTML content block to be added to the Firestore docs.
257276 */
258- function updateFirestoreHtml ( contentBlock ) {
259- const dom = new jsdom . JSDOM ( fs . readFileSync ( firestoreHtmlPath ) ) ;
277+ function updateHtml ( htmlPath , contentBlock ) {
278+ const dom = new jsdom . JSDOM ( fs . readFileSync ( htmlPath ) ) ;
260279 const contentNode = dom . window . document . body . querySelector ( '.col-12' ) ;
261280
262281 const newSection = new jsdom . JSDOM ( contentBlock ) ;
263282 contentNode . appendChild ( newSection . window . document . body . firstChild ) ;
264- fs . writeFileSync ( firestoreHtmlPath , dom . window . document . documentElement . outerHTML ) ;
283+ fs . writeFileSync ( htmlPath , dom . window . document . documentElement . outerHTML ) ;
265284}
266285
267286/**
@@ -272,7 +291,7 @@ function updateFirestoreHtml(contentBlock) {
272291 */
273292function addFirestoreTypeAliases ( ) {
274293 return new Promise ( ( resolve , reject ) => {
275- const fileStream = fs . createReadStream ( `${ repoPath } src /index.d.ts` ) ;
294+ const fileStream = fs . createReadStream ( `${ repoPath } lib/firestore /index.d.ts` ) ;
276295 fileStream . on ( 'error' , ( err ) => {
277296 reject ( err ) ;
278297 } ) ;
@@ -297,7 +316,49 @@ function addFirestoreTypeAliases() {
297316 lineReader . on ( 'close' , ( ) => {
298317 try {
299318 contentBlock += firestoreFooter ;
300- updateFirestoreHtml ( contentBlock ) ;
319+ updateHtml ( firestoreHtmlPath , contentBlock ) ;
320+ resolve ( ) ;
321+ } catch ( err ) {
322+ reject ( err ) ;
323+ }
324+ } ) ;
325+ } ) ;
326+ }
327+
328+ /**
329+ * Adds RTDB type aliases to the auto-generated API docs. These are the
330+ * types that are imported from the @firebase/database package, and
331+ * then re-exported from the admin.database namespace. Typedoc currently
332+ * does not handle these correctly, so we need this solution instead.
333+ */
334+ function addDatabaseTypeAliases ( ) {
335+ return new Promise ( ( resolve , reject ) => {
336+ const fileStream = fs . createReadStream ( `${ repoPath } ) ;
337+ fileStream . on ( 'error' , ( err ) => {
338+ reject ( err ) ;
339+ } ) ;
340+ const lineReader = readline . createInterface ( {
341+ input : fileStream ,
342+ } ) ;
343+
344+ let contentBlock = databaseHeader ;
345+ lineReader . on ( 'line' , ( line ) => {
346+ line = line . trim ( ) ;
347+ if ( line . startsWith ( 'export import' ) && line . indexOf ( 'rtdb.' ) >= 0 ) {
348+ const typeName = line . split ( ' ' ) [ 2 ] ;
349+ if ( databaseExcludes . indexOf ( typeName ) === - 1 ) {
350+ contentBlock += `
351+ <li>
352+ <a href="/docs/reference/js/firebase.database.${ typeName } ${ typeName }
353+ </li>` ;
354+ }
355+ }
356+ } ) ;
357+
358+ lineReader . on ( 'close' , ( ) => {
359+ try {
360+ contentBlock += databaseFooter ;
361+ updateHtml ( databaseHtmlPath , contentBlock ) ;
301362 resolve ( ) ;
302363 } catch ( err ) {
303364 reject ( err ) ;
@@ -349,6 +410,8 @@ Promise.all([
349410 moveFilesToRoot ( 'enums' ) ,
350411 ] ) ;
351412 } )
413+ // Rename the globals file to be the top-level admin doc.
414+ . then ( ( ) => fs . rename ( `${ docPath } , `${ docPath } ) )
352415 // Check for files listed in TOC that are missing and warn if so.
353416 // Not blocking.
354417 . then ( checkForMissingFilesAndFixFilenameCase )
@@ -366,6 +429,7 @@ Promise.all([
366429 // Add local variable include line to index.html (to access current SDK
367430 // version number).
368431 . then ( addFirestoreTypeAliases )
432+ . then ( addDatabaseTypeAliases )
369433 . then ( ( ) => {
370434 fs . readFile ( `${ docPath } , 'utf8' ) . then ( data => {
371435 // String to include devsite local variables.
0 commit comments