Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Updated package.json file for entry points #1176

Merged
merged 3 commits into from
Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:

strategy:
matrix:
node-version: [10.x, 12.x, 14.x]
node-version: [12.x, 14.x]

steps:
- uses: actions/checkout@v1
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v1
with:
node-version: 10.x
node-version: 12.x

- name: Install and build
run: |
Expand Down Expand Up @@ -115,7 +115,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v1
with:
node-version: 10.x
node-version: 12.x

- name: Publish preflight check
id: preflight
Expand Down
31 changes: 30 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"license": "Apache-2.0",
"homepage": "https://firebase.google.com/",
"engines": {
"node": ">=10.10.0"
"node": ">=12.7.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does Cloud Function still support Node 10? If so, will this prevents people from using admin-node with Node 10 in Cloud Function?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, otherwise

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Their early reaction was that this change is ok. Functions are already defaulting to Node 12 for all new deployments. We will of course bump our major version to indicate this change when we eventually release this.

},
"scripts": {
"build": "gulp build",
Expand Down Expand Up @@ -55,6 +55,35 @@
"package.json"
],
"types": "./lib/index.d.ts",
"typesVersions": {
"*": {
"app": ["lib/app"],
"auth": ["lib/auth"],
"database": ["lib/database"],
"firestore": ["lib/firestore"],
"instance-id": ["lib/instance-id"],
"machine-learning": ["lib/machine-learning"],
"messaging": ["lib/messaging"],
"project-management": ["lib/project-management"],
"remote-config": ["lib/remote-config"],
"security-rules": ["lib/security-rules"],
"storage": ["lib/storage"]
}
},
"exports": {
".": "./lib/index.js",
"./app": "./lib/app/index.js",
"./auth": "./lib/auth/index.js",
"./database": "./lib/database/index.js",
"./firestore": "./lib/firestore/index.js",
"./instance-id": "./lib/instance-id/index.js",
"./machine-learning": "./lib/machine-learning/index.js",
"./messaging": "./lib/messaging/index.js",
"./project-management": "./lib/project-management/index.js",
"./remote-config": "./lib/remote-config/index.js",
"./security-rules": "./lib/security-rules/index.js",
"./storage": "./lib/storage/index.js"
},
"dependencies": {
"@firebase/database": "^0.8.1",
"@firebase/database-types": "^0.6.1",
Expand Down
127 changes: 127 additions & 0 deletions test/integration/typescript/src/example-modular.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
/*!
* @license
* Copyright 2021 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import { expect } from 'chai';

import { cert, deleteApp, initializeApp, App } from 'firebase-admin/app';
import { getAuth, Auth } from 'firebase-admin/auth';
import { getDatabase, getDatabaseWithUrl, Database, ServerValue } from 'firebase-admin/database';
import { getFirestore, DocumentReference, Firestore, FieldValue } from 'firebase-admin/firestore';
import { getInstanceId, InstanceId } from 'firebase-admin/instance-id';
import { getMachineLearning, MachineLearning } from 'firebase-admin/machine-learning';
import { getMessaging, Messaging } from 'firebase-admin/messaging';
import { getProjectManagement, ProjectManagement } from 'firebase-admin/project-management';
import { getRemoteConfig, RemoteConfig } from 'firebase-admin/remote-config';
import { getSecurityRules, SecurityRules } from 'firebase-admin/security-rules';
import { getStorage, Storage } from 'firebase-admin/storage';

import { Bucket } from '@google-cloud/storage';


// eslint-disable-next-line @typescript-eslint/no-var-requires
const serviceAccount = require('../mock.key.json');

describe('Modular API', () => {
let app: App;

before(() => {
app = initializeApp({
credential: cert(serviceAccount),
databaseURL: 'https://mock.firebaseio.com'
}, 'TestApp');
});

after(() => {
return deleteApp(app);
});

it('Should return an initialized App', () => {
expect(app.name).to.equal('TestApp');
});

it('Should return an Auth client', () => {
const client = getAuth(app);
expect(client).to.be.instanceOf(Auth);
});

it('Should return a Messaging client', () => {
const client = getMessaging(app);
expect(client).to.be.instanceOf(Messaging);
});

it('Should return a ProjectManagement client', () => {
const client = getProjectManagement(app);
expect(client).to.be.instanceOf(ProjectManagement);
});

it('Should return a SecurityRules client', () => {
const client = getSecurityRules(app);
expect(client).to.be.instanceOf(SecurityRules);
});

it('Should return a Database client', () => {
const db: Database = getDatabase(app);
expect(db).to.be.not.undefined;
expect(typeof db.getRules).to.equal('function');
});

it('Should return a Database client for URL', () => {
const db: Database = getDatabaseWithUrl('https://other-mock.firebaseio.com', app);
expect(db).to.be.not.undefined;
expect(typeof db.getRules).to.equal('function');
});

it('Should return a Database ServerValue', () => {
expect(ServerValue.increment(1)).to.be.not.undefined;
});

it('Should return a Cloud Storage client', () => {
const storage = getStorage(app);
expect(storage).to.be.instanceOf(Storage)
const bucket: Bucket = storage.bucket('TestBucket');
expect(bucket.name).to.equal('TestBucket');
});

it('Should return a Firestore client', () => {
const firestore = getFirestore(app);
expect(firestore).to.be.instanceOf(Firestore);
});

it('Should return a Firestore FieldValue', () => {
expect(FieldValue.increment(1)).to.be.not.undefined;
});

it('Should return a DocumentReference', () => {
const ref = getFirestore(app).collection('test').doc();
expect(ref).to.be.instanceOf(DocumentReference);
});

it('Should return an InstanceId client', () => {
const client = getInstanceId(app);
expect(client).to.be.instanceOf(InstanceId);
});

it('Should return a MachineLearning client', () => {
const client = getMachineLearning(app);
expect(client).to.be.instanceOf(MachineLearning);
});

it('Should return a RemoteConfig client', () => {
const client = getRemoteConfig(app);
expect(client).to.be.instanceOf(RemoteConfig);
});
});
8 changes: 6 additions & 2 deletions test/integration/typescript/src/example.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@ import * as admin from 'firebase-admin';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const serviceAccount = require('../mock.key.json');

describe('Init App', () => {
const app: admin.app.App = initApp(serviceAccount, 'TestApp');
describe('Legacy API', () => {
let app: admin.app.App;

before(() => {
app = initApp(serviceAccount, 'TestApp');
});

after(() => {
return app.delete();
Expand Down