Fix namespace v1 docs (#1204)

* added missing info to analytics

* fixing https package

* fixing pubsub

* adding storage

* change return to returns

* Make it a link!

* Unnecessary internal tag.

Co-authored-by: Daniel Lee <[email protected]>

Author: colerogers

src/common/providers/https.ts

@@ -36,7 +36,7 @@ import { TaskContext } from "./tasks";
 
 const JWT_REGEX = /^[a-zA-Z0-9\-_=]+?\.[a-zA-Z0-9\-_=]+?\.([a-zA-Z0-9\-_=]+)?$/;
 
-/** @hidden */
+/** An express request with the wire format representation of the request body. */
 export interface Request extends express.Request {
   /** The wire format representation of the request body. */
   rawBody: Buffer;
@@ -121,9 +121,9 @@ export interface CallableRequest<T = any> {
 
 /**
  * The set of Firebase Functions status codes. The codes are the same at the
- * ones exposed by gRPC here:
- * https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+ * ones exposed by {@link https://github.com/grpc/grpc/blob/master/doc/statuscodes.md | gRPC}.
  *
+ * @remarks
  * Possible values:
  *
  * - `cancelled`: The operation was cancelled (typically by the caller).
@@ -527,7 +527,7 @@ export function unsafeDecodeAppCheckToken(token: string): DecodedAppCheckToken {
  *
  * @param {Request} req - Request sent to the Callable function.
  * @param {CallableContext} ctx - Context to be sent to callable function handler.
- * @return {CallableTokenStatus} Status of the token verifications.
+ * @returns {CallableTokenStatus} Status of the token verifications.
  */
 /** @internal */
 async function checkTokens(req: Request, ctx: CallableContext): Promise<CallableTokenStatus> {

src/v1/cloud-functions.ts

@@ -170,6 +170,7 @@ export interface Resource {
  * function - useful for unit testing.
  */
 export interface Runnable<T> {
+  /** Directly invoke the user defined function. */
   run: (data: T, context: any) => PromiseLike<any> | any;
 }
 

src/v1/config.ts

@@ -27,10 +27,7 @@ export { firebaseConfig } from "../common/config";
 
 let singleton: Record<string, any>;
 
-/**
- * @hidden
- * @internal
- */
+/** @internal */
 export function resetCache(): void {
   singleton = undefined;
 }

src/v1/providers/analytics.ts

@@ -23,9 +23,9 @@
 import { CloudFunction, Event, EventContext, makeCloudFunction } from "../cloud-functions";
 import { DeploymentOptions } from "../function-configuration";
 
-/** @hidden */
+/** @internal */
 export const provider = "google.analytics";
-/** @hidden */
+/** @internal */
 export const service = "app-measurement.com";
 
 /**
@@ -34,13 +34,13 @@ export const service = "app-measurement.com";
  * @param analyticsEventType Name of the analytics event type to which
  *   this Cloud Function is scoped.
  *
- * @return Analytics event builder interface.
+ * @returns Analytics event builder interface.
  */
 export function event(analyticsEventType: string) {
   return _eventWithOptions(analyticsEventType, {});
 }
 
-/** @hidden */
+/** @internal */
 export function _eventWithOptions(analyticsEventType: string, options: DeploymentOptions) {
   return new AnalyticsEventBuilder(() => {
     if (!process.env.GCLOUD_PROJECT) {
@@ -53,7 +53,7 @@ export function _eventWithOptions(analyticsEventType: string, options: Deploymen
 /**
  * The Firebase Analytics event builder interface.
  *
- * Access via [`functions.analytics.event()`](functions.analytics#.event).
+ * Access via `functions.analytics.event()`.
  */
 export class AnalyticsEventBuilder {
   /** @hidden */
@@ -65,7 +65,7 @@ export class AnalyticsEventBuilder {
    * @param handler Event handler that fires every time a Firebase Analytics event
    *   occurs.
    *
-   * @return A function that you can export and deploy.
+   * @returns A function that you can export and deploy.
    */
   onLog(
     handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike<any> | any

src/v1/providers/https.ts

@@ -56,7 +56,7 @@ export function onCall(
   return _onCallWithOptions(handler, {});
 }
 
-/** @hidden */
+/** @internal */
 export function _onRequestWithOptions(
   handler: (req: Request, resp: express.Response) => void | Promise<void>,
   options: DeploymentOptions
@@ -82,7 +82,7 @@ export function _onRequestWithOptions(
   return cloudFunction;
 }
 
-/** @hidden */
+/** @internal */
 export function _onCallWithOptions(
   handler: (data: any, context: CallableContext) => any | Promise<any>,
   options: DeploymentOptions

src/v1/providers/pubsub.ts

@@ -23,9 +23,9 @@
 import { CloudFunction, EventContext, makeCloudFunction } from "../cloud-functions";
 import { DeploymentOptions, ScheduleRetryConfig } from "../function-configuration";
 
-/** @hidden */
+/** @internal */
 export const provider = "google.pubsub";
-/** @hidden */
+/** @internal */
 export const service = "pubsub.googleapis.com";
 
 /**
@@ -39,7 +39,7 @@ export function topic(topic: string) {
   return _topicWithOptions(topic, {});
 }
 
-/** @hidden */
+/** @internal */
 export function _topicWithOptions(topic: string, options: DeploymentOptions): TopicBuilder {
   if (topic.indexOf("/") !== -1) {
     throw new Error("Topic name may not have a /");
@@ -56,7 +56,7 @@ export function _topicWithOptions(topic: string, options: DeploymentOptions): To
 /**
  * The Google Cloud Pub/Sub topic builder.
  *
- * Access via [`functions.pubsub.topic()`](providers_pubsub_.html#topic).
+ * Access via `functions.pubsub.topic()`.
  */
 export class TopicBuilder {
   /** @hidden */
@@ -68,7 +68,7 @@ export class TopicBuilder {
    *
    * @param handler - Event handler that runs every time a Cloud Pub/Sub message
    *   is published.
-   * @return A Cloud Function that you can export and deploy.
+   * @returns A Cloud Function that you can export and deploy.
    */
   onPublish(
     handler: (message: Message, context: EventContext) => PromiseLike<any> | any
@@ -89,13 +89,13 @@ export class TopicBuilder {
  * Registers a Cloud Function to run at specified times.
  *
  * @param schedule - The schedule, in Unix Crontab or AppEngine syntax.
- * @return ScheduleBuilder interface.
+ * @returns ScheduleBuilder interface.
  */
 export function schedule(schedule: string): ScheduleBuilder {
   return _scheduleWithOptions(schedule, {});
 }
 
-/** @hidden */
+/** @internal */
 export function _scheduleWithOptions(
   schedule: string,
   options: DeploymentOptions
@@ -120,7 +120,7 @@ export function _scheduleWithOptions(
  * frequency. For more information, see
  * [Schedule functions](/docs/functions/schedule-functions).
  *
- * Access via [`functions.pubsub.schedule()`](providers_pubsub_.html#schedule).
+ * Access via `functions.pubsub.schedule()`.
  */
 export class ScheduleBuilder {
   /** @hidden */
@@ -142,7 +142,7 @@ export class ScheduleBuilder {
    *
    * @param handler - Handler that fires whenever the associated
    *   scheduler job sends a Pub/Sub message.
-   * @return A Cloud Function that you can export and deploy.
+   * @returns A Cloud Function that you can export and deploy.
    */
   onRun(handler: (context: EventContext) => PromiseLike<any> | any) {
     const cloudFunction = makeCloudFunction({
@@ -195,7 +195,7 @@ export class Message {
   /**
    * Returns a JSON-serializable representation of this object.
    *
-   * @return A JSON-serializable representation of this object.
+   * @returns A JSON-serializable representation of this object.
    */
   toJSON(): any {
     return {

src/v1/providers/storage.ts

@@ -24,9 +24,9 @@ import { firebaseConfig } from "../../common/config";
 import { CloudFunction, EventContext, makeCloudFunction } from "../cloud-functions";
 import { DeploymentOptions } from "../function-configuration";
 
-/** @hidden */
+/** @internal */
 export const provider = "google.storage";
-/** @hidden */
+/** @internal */
 export const service = "storage.googleapis.com";
 
 /**
@@ -35,7 +35,7 @@ export const service = "storage.googleapis.com";
  * @param bucket Name of the bucket to which this Cloud Function is
  *   scoped.
  *
- * @return Storage bucket builder interface.
+ * @returns Storage bucket builder interface.
  */
 export function bucket(bucket?: string) {
   return _bucketWithOptions({}, bucket);
@@ -45,13 +45,13 @@ export function bucket(bucket?: string) {
  * Registers a Cloud Function scoped to the default storage bucket for the
  * project.
  *
- * @return Storage object builder interface.
+ * @returns Storage object builder interface.
  */
 export function object() {
   return _objectWithOptions({});
 }
 
-/** @hidden */
+/** @internal */
 export function _bucketWithOptions(options: DeploymentOptions, bucket?: string): BucketBuilder {
   const resourceGetter = () => {
     bucket = bucket || firebaseConfig().storageBucket;
@@ -69,24 +69,24 @@ export function _bucketWithOptions(options: DeploymentOptions, bucket?: string):
   return new BucketBuilder(resourceGetter, options);
 }
 
-/** @hidden */
+/** @internal */
 export function _objectWithOptions(options: DeploymentOptions): ObjectBuilder {
   return _bucketWithOptions(options).object();
 }
 
 /**
  * The Google Cloud Storage bucket builder interface.
  *
- * Access via [`functions.storage.bucket()`](providers_storage_.html#bucket).
+ * Access via `functions.storage.bucket()`.
  */
 export class BucketBuilder {
-  /** @hidden */
+  /** @internal */
   constructor(private triggerResource: () => string, private options: DeploymentOptions) {}
 
   /**
    * Event handler which fires every time a Google Cloud Storage change occurs.
    *
-   * @return Storage object builder interface scoped to the specified storage
+   * @returns Storage object builder interface scoped to the specified storage
    *   bucket.
    */
   object() {
@@ -97,13 +97,13 @@ export class BucketBuilder {
 /**
  * The Google Cloud Storage object builder interface.
  *
- * Access via [`functions.storage.object()`](providers_storage_.html#object).
+ * Access via `functions.storage.object()`.
  */
 export class ObjectBuilder {
-  /** @hidden */
+  /** @internal */
   constructor(private triggerResource: () => string, private options: DeploymentOptions) {}
 
-  /** @hidden */
+  /** @internal */
   onChange(): Error {
     throw new Error(
       '"onChange" is now deprecated, please use "onArchive", "onDelete", ' +
@@ -120,7 +120,7 @@ export class ObjectBuilder {
    * @param handler Event handler which is run every time a Google Cloud Storage
    *   archival occurs.
    *
-   * @return A Cloud Function which you can export and deploy.
+   * @returns A Cloud Function which you can export and deploy.
    */
   onArchive(
     handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any
@@ -140,7 +140,7 @@ export class ObjectBuilder {
    * @param handler Event handler which is run every time a Google Cloud Storage
    *   deletion occurs.
    *
-   * @return A Cloud Function which you can export and deploy.
+   * @returns A Cloud Function which you can export and deploy.
    */
   onDelete(
     handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any
@@ -159,7 +159,7 @@ export class ObjectBuilder {
    * @param handler Event handler which is run every time a Google Cloud Storage
    *   object creation occurs.
    *
-   * @return A Cloud Function which you can export and deploy.
+   * @returns A Cloud Function which you can export and deploy.
    */
   onFinalize(
     handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any
@@ -174,7 +174,7 @@ export class ObjectBuilder {
    * @param handler Event handler which is run every time a Google Cloud Storage
    *   metadata update occurs.
    *
-   * @return A Cloud Function which you can export and deploy.
+   * @returns A Cloud Function which you can export and deploy.
    */
   onMetadataUpdate(
     handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any