fix: rename v1 Event to LegacyEvent to avoid api-extractor conflict (#1767)

* fix: rename v1 Event to LegacyEvent to avoid api-extractor conflict

* fix: add changelog entry for #1767

* rename type in specs.

* make formatter happy.

Author: taeold

CHANGELOG.md

@@ -4,3 +4,4 @@
 - BREAKING: Unhandled errors in async `onRequest` handlers in the Emulator now return a 500 error immediately. (#1755)
 - Add support for ESM (ECMAScript Modules) alongside CommonJS. (#1750)
 - Add `onMutationExecuted()` trigger for Firebase Data Connect. (#1727)
+- BREAKING: Rename v1 Event to LegacyEvent to avoid api-extractor conflict. (#1767)

spec/v1/cloud-functions.spec.ts

@@ -24,7 +24,7 @@ import { expect } from "chai";
 
 import {
   onInit,
-  Event,
+  LegacyEvent,
   EventContext,
   makeCloudFunction,
   MakeCloudFunctionArgs,
@@ -43,7 +43,7 @@ describe("makeCloudFunction", () => {
   };
 
   it("calls init function", async () => {
-    const test: Event = {
+    const test: LegacyEvent = {
       context: {
         eventId: "00000",
         timestamp: "2016-11-04T21:29:03.496Z",
@@ -253,7 +253,7 @@ describe("makeCloudFunction", () => {
       handler: (data: any, context: EventContext) => context,
     };
     const cf = makeCloudFunction(args);
-    const test: Event = {
+    const test: LegacyEvent = {
       context: {
         eventId: "00000",
         timestamp: "2016-11-04T21:29:03.496Z",
@@ -285,7 +285,7 @@ describe("makeCloudFunction", () => {
       triggerResource: () => null,
     };
     const cf = makeCloudFunction(args);
-    const test: Event = {
+    const test: LegacyEvent = {
       context: {
         eventId: "00000",
         timestamp: "2016-11-04T21:29:03.496Z",
@@ -325,7 +325,7 @@ describe("makeParams", () => {
   const cf = makeCloudFunction(args);
 
   it("should construct params from the event resource of events", () => {
-    const testEvent: Event = {
+    const testEvent: LegacyEvent = {
       context: {
         eventId: "111",
         timestamp: "2016-11-04T21:29:03.496Z",

spec/v1/providers/analytics.spec.ts

@@ -23,7 +23,7 @@
 import { expect } from "chai";
 
 import * as functions from "../../../src/v1";
-import { Event } from "../../../src/v1/cloud-functions";
+import { LegacyEvent } from "../../../src/v1/cloud-functions";
 import * as analytics from "../../../src/v1/providers/analytics";
 import * as analyticsSpecInput from "./analytics.spec.input";
 import { MINIMAL_V1_ENDPOINT } from "../../fixtures";
@@ -92,7 +92,7 @@ describe("Analytics Functions", () => {
 
         // The event data delivered over the wire will be the JSON for an AnalyticsEvent:
         // https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             userDim: {
               userId: "hi!",
@@ -126,7 +126,7 @@ describe("Analytics Functions", () => {
         // Incoming events will have four kinds of "xValue" fields: "intValue",
         // "stringValue", "doubleValue" and "floatValue". We expect those to get
         // flattened away, leaving just their values.
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             eventDim: [
               {
@@ -193,7 +193,7 @@ describe("Analytics Functions", () => {
           .event("first_open")
           .onLog((data: analytics.AnalyticsEvent) => data);
 
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             eventDim: [
               {
@@ -264,7 +264,7 @@ describe("Analytics Functions", () => {
         //
         // Separately, the input has a number of microsecond timestamps that we'd
         // like to rename and scale down to milliseconds.
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             eventDim: [
               {
@@ -311,7 +311,7 @@ describe("Analytics Functions", () => {
           .event("app_remove")
           .onLog((data: analytics.AnalyticsEvent) => data);
 
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             eventDim: [
               {

spec/v1/providers/auth.spec.ts

@@ -23,12 +23,12 @@
 import { expect } from "chai";
 import { UserRecord } from "../../../src/common/providers/identity";
 import * as functions from "../../../src/v1";
-import { CloudFunction, Event } from "../../../src/v1/cloud-functions";
+import { CloudFunction, LegacyEvent } from "../../../src/v1/cloud-functions";
 import * as auth from "../../../src/v1/providers/auth";
 import { MINIMAL_V1_ENDPOINT } from "../../fixtures";
 
 describe("Auth Functions", () => {
-  const event: Event = {
+  const event: LegacyEvent = {
     data: {
       metadata: {
         creationTime: "2016-12-15T19:37:37.059Z",

spec/v1/providers/pubsub.spec.ts

@@ -22,7 +22,7 @@
 
 import { expect } from "chai";
 
-import { Event, RESET_VALUE } from "../../../src/v1";
+import { LegacyEvent, RESET_VALUE } from "../../../src/v1";
 import { MINIMAL_V1_ENDPOINT } from "../../fixtures";
 import { MINIMAL_SCHEDULE_TRIGGER } from "./fixtures";
 import * as functions from "../../../src/v1";
@@ -125,7 +125,7 @@ describe("Pubsub Functions", () => {
 
       it("should properly handle a new-style event", () => {
         const raw = new Buffer('{"hello":"world"}', "utf8").toString("base64");
-        const event: Event = {
+        const event: LegacyEvent = {
           data: {
             data: raw,
             attributes: {

spec/v1/providers/remoteConfig.spec.ts

@@ -22,7 +22,7 @@
 import { expect } from "chai";
 
 import * as functions from "../../../src/v1";
-import { CloudFunction, Event } from "../../../src/v1/cloud-functions";
+import { CloudFunction, LegacyEvent } from "../../../src/v1/cloud-functions";
 import * as remoteConfig from "../../../src/v1/providers/remoteConfig";
 import { MINIMAL_V1_ENDPOINT } from "../../fixtures";
 
@@ -96,7 +96,7 @@ describe("RemoteConfig Functions", () => {
 
   describe("unwraps TemplateVersion", () => {
     let cloudFunctionUpdate: CloudFunction<remoteConfig.TemplateVersion>;
-    let event: Event;
+    let event: LegacyEvent;
 
     before(() => {
       process.env.GCLOUD_PROJECT = "project1";

spec/v1/providers/storage.spec.ts

@@ -21,7 +21,7 @@
 // SOFTWARE.
 
 import { expect } from "chai";
-import { Event } from "../../../src/v1";
+import { LegacyEvent } from "../../../src/v1";
 import * as config from "../../../src/common/config";
 import * as functions from "../../../src/v1";
 import * as storage from "../../../src/v1/providers/storage";
@@ -136,7 +136,7 @@ describe("Storage Functions", () => {
         const cloudFunction = storage.object().onArchive((data) => {
           return data.mediaLink;
         });
-        const goodMediaLinkEvent: Event = {
+        const goodMediaLinkEvent: LegacyEvent = {
           data: {
             mediaLink:
               "https://www.googleapis.com/storage/v1/b/mybucket.appspot.com" +

src/v1/cloud-functions.ts

@@ -54,7 +54,7 @@ const WILDCARD_REGEX = new RegExp("{[^/{}]*}", "g");
 /**
  * Wire format for an event.
  */
-export interface Event {
+export interface LegacyEvent {
   /**
    * Wire format for an event context.
    */
@@ -344,7 +344,7 @@ export interface BlockingFunction {
  * from your JavaScript file to define a Cloud Function.
  *
  * This type is a special JavaScript function which takes a templated
- * `Event` object as its only argument.
+ * `LegacyEvent` object as its only argument.
  */
 export interface CloudFunction<T> extends Runnable<T> {
   (input: any, context?: any): PromiseLike<any> | any;
@@ -361,10 +361,10 @@ export interface CloudFunction<T> extends Runnable<T> {
 
 /** @internal */
 export interface MakeCloudFunctionArgs<EventData> {
-  after?: (raw: Event) => void;
-  before?: (raw: Event) => void;
+  after?: (raw: LegacyEvent) => void;
+  before?: (raw: LegacyEvent) => void;
   contextOnlyHandler?: (context: EventContext) => PromiseLike<any> | any;
-  dataConstructor?: (raw: Event) => EventData;
+  dataConstructor?: (raw: LegacyEvent) => EventData;
   eventType: string;
   handler?: (data: EventData, context: EventContext) => PromiseLike<any> | any;
   labels?: Record<string, string>;
@@ -382,7 +382,7 @@ export interface MakeCloudFunctionArgs<EventData> {
 /** @internal */
 export function makeCloudFunction<EventData>({
   contextOnlyHandler,
-  dataConstructor = (raw: Event) => raw.data,
+  dataConstructor = (raw: LegacyEvent) => raw.data,
   eventType,
   handler,
   labels = {},
@@ -406,7 +406,7 @@ export function makeCloudFunction<EventData>({
       };
     }
 
-    const event: Event = {
+    const event: LegacyEvent = {
       data,
       context,
     };
@@ -550,7 +550,7 @@ function _makeParams(
   return params;
 }
 
-function _makeAuth(event: Event, authType: string) {
+function _makeAuth(event: LegacyEvent, authType: string) {
   if (authType === "UNAUTHENTICATED") {
     return null;
   }
@@ -560,7 +560,7 @@ function _makeAuth(event: Event, authType: string) {
   };
 }
 
-function _detectAuthType(event: Event) {
+function _detectAuthType(event: LegacyEvent) {
   if (event.context?.auth?.admin) {
     return "ADMIN";
   }

src/v1/providers/analytics.ts

@@ -20,7 +20,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-import { CloudFunction, Event, EventContext, makeCloudFunction } from "../cloud-functions";
+import { CloudFunction, LegacyEvent, EventContext, makeCloudFunction } from "../cloud-functions";
 import { DeploymentOptions } from "../function-configuration";
 
 /** @internal */
@@ -70,7 +70,7 @@ export class AnalyticsEventBuilder {
   onLog(
     handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike<any> | any
   ): CloudFunction<AnalyticsEvent> {
-    const dataConstructor = (raw: Event) => {
+    const dataConstructor = (raw: LegacyEvent) => {
       return new AnalyticsEvent(raw.data);
     };
     return makeCloudFunction({

src/v1/providers/auth.ts

@@ -40,7 +40,7 @@ import {
 import {
   BlockingFunction,
   CloudFunction,
-  Event,
+  LegacyEvent,
   EventContext,
   makeCloudFunction,
   optionsToEndpoint,
@@ -108,7 +108,7 @@ export function _userWithOptions(options: DeploymentOptions, userOptions: UserOp
  * @public
  */
 export class UserBuilder {
-  private static dataConstructor(raw: Event): UserRecord {
+  private static dataConstructor(raw: LegacyEvent): UserRecord {
     return userRecordConstructor(raw.data);
   }