firebase-functions 3.21.0 → 3.22.0

package/lib/v2/providers/identity.js

@@ -1,18 +1,49 @@
 "use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOpts = exports.beforeOperation = exports.beforeUserSignedIn = exports.beforeUserCreated = exports.HttpsError = void 0;
 const identity_1 = require("../../common/providers/identity");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return identity_1.HttpsError; } });
 const options = require("../options");
+/**
+ * Handles an event that is triggered before a user is created
+ * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation)
+ * @param handler? - If defined, an event handler which is run every time before a user is created
+ */
 function beforeUserCreated(optsOrHandler, handler) {
     return beforeOperation('beforeCreate', optsOrHandler, handler);
 }
 exports.beforeUserCreated = beforeUserCreated;
+/**
+ * Handles an event that is triggered before a user is signed in.
+ * @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin)
+ * @param handler - Event handler which is run every time before a user is signed in
+ */
 function beforeUserSignedIn(optsOrHandler, handler) {
     return beforeOperation('beforeSignIn', optsOrHandler, handler);
 }
 exports.beforeUserSignedIn = beforeUserSignedIn;
-/** @internal */
+/** @hidden */
 function beforeOperation(eventType, optsOrHandler, handler) {
     if (!handler || typeof optsOrHandler === 'function') {
         handler = optsOrHandler;
@@ -54,7 +85,7 @@ function beforeOperation(eventType, optsOrHandler, handler) {
     return func;
 }
 exports.beforeOperation = beforeOperation;
-/** @internal */
+/** @hidden */
 function getOpts(blockingOptions) {
     const accessToken = blockingOptions.accessToken || false;
     const idToken = blockingOptions.idToken || false;

package/lib/v2/providers/pubsub.d.ts

@@ -1,9 +1,30 @@
 import { CloudEvent, CloudFunction } from '../core';
 import * as options from '../options';
+/**
+ * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
+ * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
+ *
+ * This function triggers whenever a new pub/sub message is sent to a specific topic.
+ * You must specify the Pub/Sub topic name that you want to trigger your function, and set the event within the
+ * onPublish() event handler.
+ *
+ * PubSub Topic:
+ * <ul>
+ *   <li>A resource that you can publish messages to and then consume those messages via subscriptions.
+ *   <li>An isolated data stream for pub/sub messages.
+ *   <li>Messages are published to a topic.
+ *   <li>Messages are listened to via a subscription.
+ *   <li>Each subscription listens to the messages published to exactly one topic.
+ *
+ * Subscriptions - Resource that listens to the messages published by exactly one topic.
+ *
+ * [More info here](https://firebase.google.com/docs/functions/pubsub-events)
+ */
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
+ * @typeParam T - Type representing `Message.data`'s JSON format
  */
 export declare class Message<T> {
     /**
@@ -30,6 +51,10 @@ export declare class Message<T> {
     readonly orderingKey: string;
     /** @hidden */
     private _json;
+    /**
+     * @hidden
+     * @alpha
+     */
     constructor(data: any);
     /**
      * The JSON data payload of this message object, if any.
@@ -38,20 +63,112 @@ export declare class Message<T> {
     /**
      * 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;
 }
-/** The interface published in a Pub/Sub publish subscription. */
+/**
+ * The interface published in a Pub/Sub publish subscription.
+ * @typeParam T - Type representing `Message.data`'s JSON format
+ */
 export interface MessagePublishedData<T = any> {
+    /**  Google Cloud Pub/Sub message. */
     readonly message: Message<T>;
+    /** A subscription resource. */
     readonly subscription: string;
 }
 /** PubSubOptions extend EventHandlerOptions but must include a topic. */
 export interface PubSubOptions extends options.EventHandlerOptions {
+    /** The Pub/Sub topic to watch for message events */
     topic: string;
+    /**
+     * Region where functions should be deployed.
+     */
+    region?: options.SupportedRegion | string;
+    /**
+     * Amount of memory to allocate to a function.
+     * A value of null restores the defaults of 256MB.
+     */
+    memory?: options.MemoryOption | null;
+    /**
+     * Timeout for the function in sections, possible values are 0 to 540.
+     * HTTPS functions can specify a higher timeout.
+     * A value of null restores the default of 60s
+     * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
+     * function depends on the type of function: Event handling functions have a
+     * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
+     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * timeout of 1,800s (30 minutes)
+     */
+    timeoutSeconds?: number | null;
+    /**
+     * Min number of actual instances to be running at a given time.
+     * Instances will be billed for memory allocation and 10% of CPU allocation
+     * while idle.
+     * A value of null restores the default min instances.
+     */
+    minInstances?: number | null;
+    /**
+     * Max number of instances to be running in parallel.
+     * A value of null restores the default max instances.
+     */
+    maxInstances?: number | null;
+    /**
+     * Number of requests a function can serve at once.
+     * Can only be applied to functions running on Cloud Functions v2.
+     * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
+     * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
+     * The maximum value for concurrency is 1,000.
+     */
+    concurrency?: number | null;
+    /**
+     * Fractional number of CPUs to allocate to a function.
+     * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
+     * This is different from the defaults when using the gcloud utility and is different from
+     * the fixed amount assigned in Google Cloud Functions generation 1.
+     * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
+     * to the value "gcf_gen1"
+     */
+    cpu?: number | 'gcf_gen1';
+    /**
+     * Connect cloud function to specified VPC connector.
+     * A value of null removes the VPC connector
+     */
+    vpcConnector?: string | null;
+    /**
+     * Egress settings for VPC connector.
+     * A value of null turns off VPC connector egress settings
+     */
+    vpcConnectorEgressSettings?: options.VpcEgressSetting | null;
+    /**
+     * Specific service account for the function to run as.
+     * A value of null restores the default service account.
+     */
+    serviceAccount?: string | null;
+    /**
+     * Ingress settings which control where this function can be called from.
+     * A value of null turns off ingress settings.
+     */
+    ingressSettings?: options.IngressSetting | null;
+    /**
+     * User labels to set on the function.
+     */
+    labels?: Record<string, string>;
+    secrets?: string[];
+    /** Whether failed executions should be delivered again. */
+    retry?: boolean;
 }
-/** Handle a message being published to a Pub/Sub topic. */
+/**
+ * Handle a message being published to a Pub/Sub topic.
+ * @param topic - The Pub/Sub topic to watch for message events.
+ * @param handler - runs every time a Cloud Pub/Sub message is published
+ * @typeParam T - Type representing `Message.data`'s JSON format
+ */
 export declare function onMessagePublished<T = any>(topic: string, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;
-/** Handle a message being published to a Pub/Sub topic. */
+/**
+ * Handle a message being published to a Pub/Sub topic.
+ * @param options - Option containing information (topic) for event
+ * @param handler - runs every time a Cloud Pub/Sub message is published
+ * @typeParam T - Type representing `Message.data`'s JSON format
+ */
 export declare function onMessagePublished<T = any>(options: PubSubOptions, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;

package/lib/v2/providers/pubsub.js

@@ -1,14 +1,64 @@
 "use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onMessagePublished = exports.Message = void 0;
+/**
+ * Cloud functions to handle events from Google Cloud Pub/Sub.
+ * @packageDocumentation
+ */
 const encoding_1 = require("../../common/encoding");
 const options = require("../options");
+/**
+ * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
+ * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
+ *
+ * This function triggers whenever a new pub/sub message is sent to a specific topic.
+ * You must specify the Pub/Sub topic name that you want to trigger your function, and set the event within the
+ * onPublish() event handler.
+ *
+ * PubSub Topic:
+ * <ul>
+ *   <li>A resource that you can publish messages to and then consume those messages via subscriptions.
+ *   <li>An isolated data stream for pub/sub messages.
+ *   <li>Messages are published to a topic.
+ *   <li>Messages are listened to via a subscription.
+ *   <li>Each subscription listens to the messages published to exactly one topic.
+ *
+ * Subscriptions - Resource that listens to the messages published by exactly one topic.
+ *
+ * [More info here](https://firebase.google.com/docs/functions/pubsub-events)
+ */
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
+ * @typeParam T - Type representing `Message.data`'s JSON format
  */
 class Message {
+    /**
+     * @hidden
+     * @alpha
+     */
     constructor(data) {
         this.messageId = data.messageId;
         this.data = data.data;
@@ -34,7 +84,7 @@ 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() {
         const json = {
@@ -52,6 +102,12 @@ class Message {
     }
 }
 exports.Message = Message;
+/**
+ * Handle a message being published to a Pub/Sub topic.
+ * @param topicOrOptions - A string representing the PubSub topic or an option (which contains the topic)
+ * @param handler - runs every time a Cloud Pub/Sub message is published
+ * @typeParam T - Type representing `Message.data`'s JSON format
+ */
 function onMessagePublished(topicOrOptions, handler) {
     let topic;
     let opts;

package/lib/v2/providers/storage.d.ts

@@ -148,27 +148,215 @@ export interface CustomerEncryption {
      */
     keySha256?: string;
 }
+/** A CloudEvent that contains StorageObjectData */
 export interface StorageEvent extends CloudEvent<StorageObjectData> {
     /** The name of the bucket containing this object. */
     bucket: string;
 }
 /** StorageOptions extend EventHandlerOptions with a bucket name  */
 export interface StorageOptions extends options.EventHandlerOptions {
+    /** The name of the bucket containing this object. */
     bucket?: string;
+    /**
+     * Region where functions should be deployed.
+     */
+    region?: options.SupportedRegion | string;
+    /**
+     * Amount of memory to allocate to a function.
+     * A value of null restores the defaults of 256MB.
+     */
+    memory?: options.MemoryOption | null;
+    /**
+     * Timeout for the function in sections, possible values are 0 to 540.
+     * HTTPS functions can specify a higher timeout.
+     * A value of null restores the default of 60s
+     * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
+     * function depends on the type of function: Event handling functions have a
+     * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
+     * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
+     * timeout of 1,800s (30 minutes)
+     */
+    timeoutSeconds?: number | null;
+    /**
+     * Min number of actual instances to be running at a given time.
+     * Instances will be billed for memory allocation and 10% of CPU allocation
+     * while idle.
+     * A value of null restores the default min instances.
+     */
+    minInstances?: number | null;
+    /**
+     * Max number of instances to be running in parallel.
+     * A value of null restores the default max instances.
+     */
+    maxInstances?: number | null;
+    /**
+     * Number of requests a function can serve at once.
+     * Can only be applied to functions running on Cloud Functions v2.
+     * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
+     * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
+     * The maximum value for concurrency is 1,000.
+     */
+    concurrency?: number | null;
+    /**
+     * Fractional number of CPUs to allocate to a function.
+     * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
+     * This is different from the defaults when using the gcloud utility and is different from
+     * the fixed amount assigned in Google Cloud Functions generation 1.
+     * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
+     * to the value "gcf_gen1"
+     */
+    cpu?: number | 'gcf_gen1';
+    /**
+     * Connect cloud function to specified VPC connector.
+     * A value of null removes the VPC connector
+     */
+    vpcConnector?: string | null;
+    /**
+     * Egress settings for VPC connector.
+     * A value of null turns off VPC connector egress settings
+     */
+    vpcConnectorEgressSettings?: options.VpcEgressSetting | null;
+    /**
+     * Specific service account for the function to run as.
+     * A value of null restores the default service account.
+     */
+    serviceAccount?: string | null;
+    /**
+     * Ingress settings which control where this function can be called from.
+     * A value of null turns off ingress settings.
+     */
+    ingressSettings?: options.IngressSetting | null;
+    /**
+     * User labels to set on the function.
+     */
+    labels?: Record<string, string>;
+    secrets?: string[];
+    /** Whether failed executions should be delivered again. */
+    retry?: boolean;
 }
-/** Handle a storage object archived */
+/**
+ * Event handler sent only when a bucket has enabled object versioning.
+ * This event indicates that the live version of an object has become an
+ * archived version, either because it was archived or because it was
+ * overwritten by the upload of an object of the same name.
+ *
+ * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.
+ */
 export declare function onObjectArchived(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler sent only when a bucket has enabled object versioning.
+ * This event indicates that the live version of an object has become an
+ * archived version, either because it was archived or because it was
+ * overwritten by the upload of an object of the same name.
+ *
+ * @param bucket - The name of the bucket containing this object.
+ * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.
+ */
 export declare function onObjectArchived(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler sent only when a bucket has enabled object versioning.
+ * This event indicates that the live version of an object has become an
+ * archived version, either because it was archived or because it was
+ * overwritten by the upload of an object of the same name.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.
+ */
 export declare function onObjectArchived(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
-/** Handle a storage object finalized */
+/**
+ * Event handler which fires every time a Google Cloud Storage object
+ * creation occurs.
+ *
+ * Sent when a new object (or a new generation of an existing object)
+ * is successfully created in the bucket. This includes copying or rewriting
+ * an existing object. A failed upload does not trigger this event.
+ *
+ * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.
+ */
 export declare function onObjectFinalized(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time a Google Cloud Storage object
+ * creation occurs.
+ *
+ * Sent when a new object (or a new generation of an existing object)
+ * is successfully created in the bucket. This includes copying or rewriting
+ * an existing object. A failed upload does not trigger this event.
+ *
+ * @param bucket - The name of the bucket containing this object.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.
+ */
 export declare function onObjectFinalized(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time a Google Cloud Storage object
+ * creation occurs.
+ *
+ * Sent when a new object (or a new generation of an existing object)
+ * is successfully created in the bucket. This includes copying or rewriting
+ * an existing object. A failed upload does not trigger this event.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.
+ */
 export declare function onObjectFinalized(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
-/** Handle a storage object deleted */
+/**
+ * Event handler which fires every time a Google Cloud Storage deletion occurs.
+ *
+ * Sent when an object has been permanently deleted. This includes objects
+ * that are overwritten or are deleted as part of the bucket's lifecycle
+ * configuration. For buckets with object versioning enabled, this is not
+ * sent when an object is archived, even if archival occurs
+ * via the `storage.objects.delete` method.
+ *
+ * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs.
+ */
 export declare function onObjectDeleted(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time a Google Cloud Storage deletion occurs.
+ *
+ * Sent when an object has been permanently deleted. This includes objects
+ * that are overwritten or are deleted as part of the bucket's lifecycle
+ * configuration. For buckets with object versioning enabled, this is not
+ * sent when an object is archived, even if archival occurs
+ * via the `storage.objects.delete` method.
+ *
+ * @param bucket - The name of the bucket containing this object.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs.
+ */
 export declare function onObjectDeleted(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time a Google Cloud Storage deletion occurs.
+ *
+ * Sent when an object has been permanently deleted. This includes objects
+ * that are overwritten or are deleted as part of the bucket's lifecycle
+ * configuration. For buckets with object versioning enabled, this is not
+ * sent when an object is archived, even if archival occurs
+ * via the `storage.objects.delete` method.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs.
+ */
 export declare function onObjectDeleted(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
-/** Handle a storage object metadata updated */
+/**
+ * Event handler which fires every time the metadata of an existing object
+ * changes.
+ *
+ * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs.
+ */
 export declare function onObjectMetadataUpdated(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time the metadata of an existing object
+ * changes.
+ *
+ * @param bucket - The name of the bucket containing this object.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs.
+ */
 export declare function onObjectMetadataUpdated(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+/**
+ * Event handler which fires every time the metadata of an existing object
+ * changes.
+ *
+ * @param opts - Options that can be set on an individual event-handling function.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs.
+ */
 export declare function onObjectMetadataUpdated(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

package/lib/v2/providers/storage.js

@@ -1,7 +1,7 @@
 "use strict";
 // The MIT License (MIT)
 //
-// Copyright (c) 2017 Firebase
+// Copyright (c) 2022 Firebase
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -22,6 +22,10 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOptsAndBucket = exports.onOperation = exports.onObjectMetadataUpdated = exports.onObjectDeleted = exports.onObjectFinalized = exports.onObjectArchived = exports.metadataUpdatedEvent = exports.deletedEvent = exports.finalizedEvent = exports.archivedEvent = void 0;
+/**
+ * Cloud functions to handle events from Google Cloud Storage.
+ * @packageDocumentation
+ */
 const encoding_1 = require("../../common/encoding");
 const config_1 = require("../../config");
 const options = require("../options");
@@ -33,20 +37,59 @@ exports.finalizedEvent = 'google.cloud.storage.object.v1.finalized';
 exports.deletedEvent = 'google.cloud.storage.object.v1.deleted';
 /** @internal */
 exports.metadataUpdatedEvent = 'google.cloud.storage.object.v1.metadataUpdated';
-function onObjectArchived(buketOrOptsOrHandler, handler) {
-    return onOperation(exports.archivedEvent, buketOrOptsOrHandler, handler);
+/**
+ * Event handler sent only when a bucket has enabled object versioning.
+ * This event indicates that the live version of an object has become an
+ * archived version, either because it was archived or because it was
+ * overwritten by the upload of an object of the same name.
+ *
+ * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used.
+ * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs.
+ */
+function onObjectArchived(bucketOrOptsOrHandler, handler) {
+    return onOperation(exports.archivedEvent, bucketOrOptsOrHandler, handler);
 }
 exports.onObjectArchived = onObjectArchived;
-function onObjectFinalized(buketOrOptsOrHandler, handler) {
-    return onOperation(exports.finalizedEvent, buketOrOptsOrHandler, handler);
+/**
+ * Event handler which fires every time a Google Cloud Storage object
+ * creation occurs.
+ *
+ * Sent when a new object (or a new generation of an existing object)
+ * is successfully created in the bucket. This includes copying or rewriting
+ * an existing object. A failed upload does not trigger this event.
+ *
+ * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs.
+ */
+function onObjectFinalized(bucketOrOptsOrHandler, handler) {
+    return onOperation(exports.finalizedEvent, bucketOrOptsOrHandler, handler);
 }
 exports.onObjectFinalized = onObjectFinalized;
-function onObjectDeleted(buketOrOptsOrHandler, handler) {
-    return onOperation(exports.deletedEvent, buketOrOptsOrHandler, handler);
+/**
+ * Event handler which fires every time a Google Cloud Storage deletion occurs.
+ *
+ * Sent when an object has been permanently deleted. This includes objects
+ * that are overwritten or are deleted as part of the bucket's lifecycle
+ * configuration. For buckets with object versioning enabled, this is not
+ * sent when an object is archived, even if archival occurs
+ * via the `storage.objects.delete` method.
+ *
+ * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs.
+ */
+function onObjectDeleted(bucketOrOptsOrHandler, handler) {
+    return onOperation(exports.deletedEvent, bucketOrOptsOrHandler, handler);
 }
 exports.onObjectDeleted = onObjectDeleted;
-function onObjectMetadataUpdated(buketOrOptsOrHandler, handler) {
-    return onOperation(exports.metadataUpdatedEvent, buketOrOptsOrHandler, handler);
+/**
+ * Event handler which fires every time the metadata of an existing object
+ * changes.
+ *
+ * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used.
+ * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs.
+ */
+function onObjectMetadataUpdated(bucketOrOptsOrHandler, handler) {
+    return onOperation(exports.metadataUpdatedEvent, bucketOrOptsOrHandler, handler);
 }
 exports.onObjectMetadataUpdated = onObjectMetadataUpdated;
 /** @internal */