Skip to content

Commit d65d35f

Browse files
taeoldtaeold
authored
Change default entrypoint of the firebase-functions package to v2 instead of v1 (#1594)
* Change default entrypoint of firebase-functions to v2. * Add v2 namespace entrypoints to default namespace. * Uncommit extraneous files. * Fix prettier issue. * Add TS configurations. * Collocate v1 and v2 exports * Collocate v1 and v2 exports
1 parent c0b488a commit d65d35f

File tree

10 files changed

+89
-16
lines changed

10 files changed

+89
-16
lines changed

‎README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ _Please avoid double posting across multiple channels!_
2323

2424
```js
2525
// functions/index.js
26-
const functions = require("firebase-functions");
26+
const { onValueCreated } = require("firebase-functions/database");
27+
const logger = require("firebase-functions/logger");
2728
const notifyUsers = require("./notify-users");
2829

29-
exports.newPost = functions.database.ref("/posts/{postId}").onCreate((snapshot, context) => {
30-
functions.logger.info("Received new post with ID:", context.params.postId);
31-
return notifyUsers(snapshot.val());
30+
exports.newPost = onValueCreated({ ref: "/posts/{postId}" }, (event) => {
31+
logger.info("Received new post with ID:", event.params.postId);
32+
return notifyUsers(event.data.val());
3233
});
3334
```
3435

‎package.json

+76-4
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@
2222
"lib",
2323
"protos"
2424
],
25-
"main": "lib/v1/index.js",
25+
"main": "lib/v2/index.js",
2626
"bin": {
2727
"firebase-functions": "./lib/bin/firebase-functions.js"
2828
},
29-
"types": "lib/v1/index.d.ts",
29+
"types": "lib/v2/index.d.ts",
3030
"exports": {
31-
".": "./lib/v1/index.js",
3231
"./logger/compat": "./lib/logger/compat.js",
3332
"./logger": "./lib/logger/index.js",
3433
"./params": "./lib/params/index.js",
@@ -43,6 +42,25 @@
4342
"./v1/storage": "./lib/v1/providers/storage.js",
4443
"./v1/tasks": "./lib/v1/providers/tasks.js",
4544
"./v1/testLab": "./lib/v1/providers/testLab.js",
45+
".": "./lib/v2/index.js",
46+
"./core": "./lib/v2/core.js",
47+
"./options": "./lib/v2/options.js",
48+
"./https": "./lib/v2/providers/https.js",
49+
"./pubsub": "./lib/v2/providers/pubsub.js",
50+
"./storage": "./lib/v2/providers/storage.js",
51+
"./tasks": "./lib/v2/providers/tasks.js",
52+
"./alerts": "./lib/v2/providers/alerts/index.js",
53+
"./alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js",
54+
"./alerts/billing": "./lib/v2/providers/alerts/billing.js",
55+
"./alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
56+
"./alerts/performance": "./lib/v2/providers/alerts/performance.js",
57+
"./eventarc": "./lib/v2/providers/eventarc.js",
58+
"./identity": "./lib/v2/providers/identity.js",
59+
"./database": "./lib/v2/providers/database.js",
60+
"./scheduler": "./lib/v2/providers/scheduler.js",
61+
"./remoteConfig": "./lib/v2/providers/remoteConfig.js",
62+
"./testLab": "./lib/v2/providers/testLab.js",
63+
"./firestore": "./lib/v2/providers/firestore.js",
4664
"./v2": "./lib/v2/index.js",
4765
"./v2/core": "./lib/v2/core.js",
4866
"./v2/options": "./lib/v2/options.js",
@@ -107,6 +125,60 @@
107125
"v1/testLab": [
108126
"lib/v1/providers/testLab"
109127
],
128+
"core": [
129+
"./lib/v2/core"
130+
],
131+
"options": [
132+
"./lib/v2/options"
133+
],
134+
"https": [
135+
"./lib/v2/providers/https"
136+
],
137+
"pubsub": [
138+
"./lib/v2/providers/pubsub"
139+
],
140+
"storage": [
141+
"./lib/v2/providers/storage"
142+
],
143+
"tasks": [
144+
"./lib/v2/providers/tasks"
145+
],
146+
"alerts": [
147+
"./lib/v2/providers/alerts/index"
148+
],
149+
"alerts/appDistribution": [
150+
"./lib/v2/providers/alerts/appDistribution"
151+
],
152+
"alerts/billing": [
153+
"./lib/v2/providers/alerts/billing"
154+
],
155+
"alerts/crashlytics": [
156+
"./lib/v2/providers/alerts/crashlytics"
157+
],
158+
"alerts/performance": [
159+
"./lib/v2/providers/alerts/performance"
160+
],
161+
"eventarc": [
162+
"./lib/v2/providers/eventarc"
163+
],
164+
"identity": [
165+
"./lib/v2/providers/identity"
166+
],
167+
"database": [
168+
"./lib/v2/providers/database"
169+
],
170+
"scheduler": [
171+
"./lib/v2/providers/scheduler"
172+
],
173+
"remoteConfig": [
174+
"./lib/v2/providers/remoteConfig"
175+
],
176+
"testLab": [
177+
"./lib/v2/providers/testLab"
178+
],
179+
"firestore": [
180+
"./lib/v2/providers/firestore"
181+
],
110182
"v2": [
111183
"lib/v2"
112184
],
@@ -252,4 +324,4 @@
252324
"engines": {
253325
"node": ">=14.10.0"
254326
}
255-
}
327+
}

‎scripts/bin-test/sources/commonjs-grouped/g1.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const functions = require("firebase-functions");
1+
const functions = require("firebase-functions/v1");
22

33
exports.groupedhttp = functions.https.onRequest((req, resp) => {
44
resp.status(200).send("PASS");

‎scripts/bin-test/sources/commonjs-grouped/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const functions = require("firebase-functions");
1+
const functions = require("firebase-functions/v1");
22
const functionsv2 = require("firebase-functions/v2");
33
const firestoreTranslateText = require("@firebase-extensions/firebase-firestore-translate-text-sdk").firestoreTranslateText;
44
const backfill = require("@firebase-extensions/local-backfill-sdk").backfill;

‎scripts/bin-test/sources/commonjs-main/functions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const functions = require("firebase-functions");
1+
const functions = require("firebase-functions/v1");
22
const functionsv2 = require("firebase-functions/v2");
33
const firestoreTranslateText = require("@firebase-extensions/firebase-firestore-translate-text-sdk").firestoreTranslateText;
44
const backfill = require("@firebase-extensions/local-backfill-sdk").backfill;

‎scripts/bin-test/sources/commonjs-preserve/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const functions = require("firebase-functions");
1+
const functions = require("firebase-functions/v1");
22
const functionsv2 = require("firebase-functions/v2");
33
const firestoreTranslateText = require("@firebase-extensions/firebase-firestore-translate-text-sdk").firestoreTranslateText;
44
const backfill = require("@firebase-extensions/local-backfill-sdk").backfill;

‎scripts/bin-test/sources/commonjs/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const functions = require("firebase-functions");
1+
const functions = require("firebase-functions/v1");
22
const functionsv2 = require("firebase-functions/v2");
33
const firestoreTranslateText = require("@firebase-extensions/firebase-firestore-translate-text-sdk").firestoreTranslateText;
44
const backfill = require("@firebase-extensions/local-backfill-sdk").backfill;

‎scripts/bin-test/sources/esm-ext/index.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import * as functions from "firebase-functions";
1+
import * as functions from "firebase-functions/v1";
22
import * as functionsv2 from "firebase-functions/v2";
33
import { firestoreTranslateText } from "@firebase-extensions/firebase-firestore-translate-text-sdk";
44
import { backfill } from "@firebase-extensions/local-backfill-sdk";

‎scripts/bin-test/sources/esm-main/functions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import * as functions from "firebase-functions";
1+
import * as functions from "firebase-functions/v1";
22
import * as functionsv2 from "firebase-functions/v2";
33
import { firestoreTranslateText } from "@firebase-extensions/firebase-firestore-translate-text-sdk";
44
import { backfill } from "@firebase-extensions/local-backfill-sdk";

‎scripts/bin-test/sources/esm/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import * as functions from "firebase-functions";
1+
import * as functions from "firebase-functions/v1";
22
import * as functionsv2 from "firebase-functions/v2";
33
import { firestoreTranslateText } from "@firebase-extensions/firebase-firestore-translate-text-sdk";
44
import { backfill } from "@firebase-extensions/local-backfill-sdk";

0 commit comments

Comments
 (0)