typescript definitions conflict with v6.0.0 & @google-cloud/storage and @google-cloud/firestore #358

ovaris · 2018-09-14T07:19:03Z

Hi,

I have a project which uses firebase-admin & @google-cloud/storage and @google-cloud/firestore.
After upgrading to firebase-admin v6.0.0 I get following typescript errors:

node_modules/@google-cloud/firestore/types/firestore.d.ts:23:1 - error TS6200: Definitions of the following identifiers conflict with those in another file: DocumentData, UpdateData, Firestore, GeoPoint, Transaction, WriteBatch, WriteResult, DocumentReference, DocumentSnapshot, QueryDocumentSnapshot, OrderByDirection, WhereFilterOp, Query, QuerySnapshot, DocumentChangeType, CollectionReference, FieldValue, FieldPath, Timestamp, FirebaseFirestore

23 declare namespace FirebaseFirestore {
   ~~~~~~~

  node_modules/firebase-admin/node_modules/@google-cloud/firestore/types/firestore.d.ts:23:1
    23 declare namespace FirebaseFirestore {
       ~~~~~~~
    Conflicts are in this file.

node_modules/@google-cloud/firestore/types/firestore.d.ts:79:5 - error TS2374: Duplicate string index signature.

79     [key: string]: any; // Accept other properties, such as GRPC settings.
       ~~~~~~~~~~~~~~~~~~~

node_modules/firebase-admin/lib/index.d.ts:18:9 - error TS2305: Module '"/Users/ovaris/programming/fs-server/node_modules/@google-cloud/storage/build/src/index"' has no exported member 'Bucket'.

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

node_modules/firebase-admin/node_modules/@google-cloud/firestore/types/firestore.d.ts:23:1 - error TS6200: Definitions of the following identifiers conflict with those in another file: DocumentData, UpdateData, Firestore, GeoPoint, Transaction, WriteBatch, WriteResult, DocumentReference, DocumentSnapshot, QueryDocumentSnapshot, OrderByDirection, WhereFilterOp, Query, QuerySnapshot, DocumentChangeType, CollectionReference, FieldValue, FieldPath, Timestamp, FirebaseFirestore

23 declare namespace FirebaseFirestore {
   ~~~~~~~

  node_modules/@google-cloud/firestore/types/firestore.d.ts:23:1
    23 declare namespace FirebaseFirestore {
       ~~~~~~~
    Conflicts are in this file

The text was updated successfully, but these errors were encountered:

google-oss-bot · 2018-09-14T07:19:07Z

I found a few problems with this issue:

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
This issue does not seem to follow the issue template. Make sure you provide all the required information.

ovaris · 2018-09-14T08:27:06Z

Actually it seems that culprit seems to be latest 0.17.0 version of @google-cloud/firestore.
Also 2.0.3 version of @google-cloud/storage has broke typings:

node_modules/firebase-admin/lib/index.d.ts:18:9 - error TS2305: Module '"...node_modules/@google-cloud/storage/build/src/index"' has no exported member 'Bucket'.

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

vdiaz1130 · 2018-09-19T00:44:30Z

Had the same issue. This fixed it for me:

npm i @google-cloud/storage@latest --save

ckmluna2 · 2018-09-24T07:02:54Z

@vdiaz1130 This did not seem to help. I'm still getting the same error.

minstn · 2018-09-26T06:18:52Z

Same problem here:

package versions

@google-cloud/[email protected]
@google-cloud/[email protected]

node version:
v8.12.0

node_modules/firebase-admin/lib/index.d.ts(18,9): error TS2305: Module '"/Users/mstonys/one/one/functions/node_modules/@google-cloud/storage/build/src/index"' has no exported member 'Bucket'. npm ERR! code ELIFECYCLE npm ERR! errno 2 npm ERR! functions@ build: tsc`
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the functions@ build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! /Users/one/.npm/_logs/2018-09-26T06_11_51_398Z-debug.log

Error: functions predeploy error: Command terminated with non-zero exit code2`

juliamazur · 2018-09-26T08:51:20Z

I have the same problem with the newest packages.

Meg4mi · 2018-09-26T16:07:07Z

I have the same issue here :)

rubio05 · 2018-09-26T19:57:50Z

Having the same issue

theoafactor · 2018-09-28T09:27:21Z

I have the same issue. Backward versions don't seem to help

lupas · 2018-09-29T16:49:59Z

Same issue here. I'm currently sticking with @google-cloud/storage v1.7.0 since an upgrade to v2 breaks with the error that @ovaris is mentioning.

gtcdevop · 2018-10-01T12:19:51Z

Same man, have a nice cup of coffee, and if I can help, I will !

Jbz797 · 2018-10-01T14:58:55Z

Some news about this issue ?

mlejva · 2018-10-08T09:04:51Z

Also having same issue. Shouldn't this be given higher priority since it's basically breaking Typescript build?

mlejva · 2018-10-08T09:31:58Z

I opened new issue at google-cloud/storage repo - here

otnielgomez · 2018-10-09T23:01:55Z

As a work arround in your /node_modules/firebase-admin/lib/index.d.ts replace:

Line 18
Instead of:
import {Bucket} from '@google-cloud/storage';

Use:
import {Storage} from '@google-cloud/storage';

AND Line 589

Instead of:
bucket(name?: string): Bucket;

Use:
bucket(name?: string): Storage;

And where you need to call it use it like this:

const {Storage} = require('@google-cloud/storage');
const gcs = new Storage();

It worked for me, im using:

"@google-cloud/storage": "^2.0.3",
"firebase-admin": "~5.12.1",
"firebase-functions": "^2.0.5"

lupas · 2018-10-14T21:05:19Z

seems to work again with the recently released "@google-cloud/storage": "^2.1.0", guess this can be closed.

mlejva · 2018-10-15T09:07:56Z

seems to work again with the recently released "@google-cloud/storage": "^2.1.0", guess this can be closed.

How are you importing Storage?

With

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

I'm getting following error

Module '"node_modules/@types/google-cloud__storage/index"' has no exported member 'Storage'.

lupas · 2018-10-15T09:17:21Z

How are you importing Storage?

With

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

I'm getting following error

Module '"node_modules/@types/google-cloud__storage/index"' has no exported member 'Storage'.

Using typescript, I'm doing:

import * as admin from 'firebase-admin'
const storage = admin.storage()

Which threw the error mentioned above before, but since v2.1.0 it works again for me.

ovaris · 2018-10-15T10:05:57Z

@lupas Issue still remains, you cannot use firebase-admin package together with latest @google-cloud/storage because of TS identifier conflicts . You are using storage from inside firebase-admin which I would not like to do.

ovaris · 2018-10-15T10:43:08Z

Created a PR #368

kmturley · 2018-10-18T01:36:57Z

Isn't this because firebase admin uses @types/google-cloud__storage:

"firebase-admin": {
     "version": "6.0.0",
     "requires": {
       "@firebase/app": "0.3.4",
       "@firebase/database": "0.3.6",
       "@google-cloud/firestore": "0.16.1",
       "@google-cloud/storage": "1.7.0",
       "@types/google-cloud__storage": "1.7.2",
       "@types/node": "8.10.36",
       "jsonwebtoken": "8.1.0",
       "node-forge": "0.7.4"
     }...

But the package already has it's own definitions?
https://www.npmjs.com/package/@google-cloud/storage
https://github.com/googleapis/nodejs-storage/blob/master/src/index.ts

If I do:
rm -rf node_modules/@types/google-cloud__storage

then it bypasses the error

UPDATE: Looks like a better potential workaround is to use:

import * as functions from 'firebase-functions';
import * as storage from '@google-cloud/storage';

const client = new storage.Storage({
 projectId: 'xxxx',
});

UPDATE 2: I got it working this different way

import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';
import * as Handlebars from 'handlebars';
import * as nodemailer from 'nodemailer';

const APP_BUCKET = 'project-id.appspot.com';
const APP_EMAIL = '[email protected]';
const APP_NAME = 'Cloud Storage for Firebase quickstart';

const mailTransport = nodemailer.createTransport({
  service: 'gmail',
  auth: {
    user: functions.config().gmail.email,
    pass: functions.config().gmail.password,
  },
});

export const SendWelcomeEmail = functions.auth.user().onCreate((user) => {
  return sendEmail('emails/signup.html', `Welcome to ${APP_NAME}!`, user);
});

export const SendByeEmail = functions.auth.user().onDelete((user) => {
  return sendEmail('emails/signout.html', `Goodbye from ${APP_NAME}!`, user);
});

async function sendEmail(path, subject, user) {
  const bucket = admin.storage().bucket(APP_BUCKET);
  const template = await bucket.file(path).download();
  const mailOptions = {
    from: `${APP_NAME} <${APP_EMAIL}>`,
    subject: subject,
    html: Handlebars.compile(template.toString())(user),
    to: user.email,
  };
  await mailTransport.sendMail(mailOptions);
  console.log('sendEmail', subject, user.email);
  return true;
}

You can read the related threads here:
DefinitelyTyped/DefinitelyTyped#28774
googleapis/nodejs-storage#392
googleapis/nodejs-storage#456

rodleviton · 2018-10-23T11:52:05Z

I know it is not pretty but here is a "temporary" workaround to get your code to compile and ignore the conflict. Inside your tsconfig.json add the following:

{
    "compilerOptions": {
        "skipLibCheck": true,
        ...
    },
}

Read more about this option here: https://github.com/Microsoft/TypeScript-Handbook/blob/master/pages/release%20notes/TypeScript%202.0.md#new---skiplibcheck

hiranya911 · 2018-12-21T18:22:14Z

This upgrade has been scheduled for the next major release. We are working internally to figure out the timeline.

JTR-Wang · 2018-12-31T13:19:39Z

Hi
In my project, i also have the same issue.
and i solve it, like this.
I hope this can help you

I have not use @google-cloud/firestore

dinvlad · 2019-01-29T19:51:51Z

Having the same issue with @google-cloud/firestore v0.20.0 upwards (v0.19.0 works fine). Is there any update on when it's resolved?

(OT here, but we have to resort to using @google-cloud/firestore only because of the timestampsInSnapshots warning)

hiranya911 · 2019-01-30T18:51:24Z

This has been fixed in the master branch, and included in the next major release. See #437 and #451 for progress.

Mikkelet · 2020-01-13T10:30:31Z

Im having this problem now. What's weirder is, I am using the EXACT same dependencies for the project thats tied to a test firestore database and IT has no problem deploying the functions. So weird.

whaatt · 2020-01-13T23:42:54Z

@Mikkelet Try using exact versions instead of approximate (~ or ^) versions, especially if you haven't upgraded to @google-cloud/firestore@3.

Thefirebase-admin module may not be using semantic versioning conventions, since the minor bump from 8.8.0 to 8.9.0 depends on a major bump (2.x.x to 3.x.x) for @google-cloud/firestore.

juliamazur mentioned this issue Sep 26, 2018

resize image before upload juliamazur/cookking-react-firebase#2

Closed

mlejva mentioned this issue Oct 8, 2018

Module has no exported member "Bucket" in typescript project googleapis/nodejs-storage#433

Closed

hiranya911 self-assigned this Dec 14, 2018

hiranya911 mentioned this issue Jan 8, 2019

Breaking changes for v7 release #437

Merged

hiranya911 closed this as completed Jan 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

typescript definitions conflict with v6.0.0 & @google-cloud/storage and @google-cloud/firestore #358

typescript definitions conflict with v6.0.0 & @google-cloud/storage and @google-cloud/firestore #358

ovaris commented Sep 14, 2018

google-oss-bot commented Sep 14, 2018

ovaris commented Sep 14, 2018 •

edited

Loading

vdiaz1130 commented Sep 19, 2018

ckmluna2 commented Sep 24, 2018

minstn commented Sep 26, 2018

juliamazur commented Sep 26, 2018

Meg4mi commented Sep 26, 2018

rubio05 commented Sep 26, 2018

theoafactor commented Sep 28, 2018

lupas commented Sep 29, 2018

gtcdevop commented Oct 1, 2018

Jbz797 commented Oct 1, 2018

mlejva commented Oct 8, 2018 •

edited

Loading

mlejva commented Oct 8, 2018

otnielgomez commented Oct 9, 2018 •

edited

Loading

lupas commented Oct 14, 2018

mlejva commented Oct 15, 2018

lupas commented Oct 15, 2018

ovaris commented Oct 15, 2018

ovaris commented Oct 15, 2018

kmturley commented Oct 18, 2018 •

edited

Loading

rodleviton commented Oct 23, 2018 •

edited

Loading

hiranya911 commented Dec 21, 2018

JTR-Wang commented Dec 31, 2018

dinvlad commented Jan 29, 2019

hiranya911 commented Jan 30, 2019

Mikkelet commented Jan 13, 2020

whaatt commented Jan 13, 2020

typescript definitions conflict with v6.0.0 & @google-cloud/storage and @google-cloud/firestore #358

typescript definitions conflict with v6.0.0 & @google-cloud/storage and @google-cloud/firestore #358

Comments

ovaris commented Sep 14, 2018

google-oss-bot commented Sep 14, 2018

ovaris commented Sep 14, 2018 • edited Loading

vdiaz1130 commented Sep 19, 2018

ckmluna2 commented Sep 24, 2018

minstn commented Sep 26, 2018

juliamazur commented Sep 26, 2018

Meg4mi commented Sep 26, 2018

rubio05 commented Sep 26, 2018

theoafactor commented Sep 28, 2018

lupas commented Sep 29, 2018

gtcdevop commented Oct 1, 2018

Jbz797 commented Oct 1, 2018

mlejva commented Oct 8, 2018 • edited Loading

mlejva commented Oct 8, 2018

otnielgomez commented Oct 9, 2018 • edited Loading

lupas commented Oct 14, 2018

mlejva commented Oct 15, 2018

lupas commented Oct 15, 2018

ovaris commented Oct 15, 2018

ovaris commented Oct 15, 2018

kmturley commented Oct 18, 2018 • edited Loading

rodleviton commented Oct 23, 2018 • edited Loading

hiranya911 commented Dec 21, 2018

JTR-Wang commented Dec 31, 2018

dinvlad commented Jan 29, 2019

hiranya911 commented Jan 30, 2019

Mikkelet commented Jan 13, 2020

whaatt commented Jan 13, 2020

ovaris commented Sep 14, 2018 •

edited

Loading

mlejva commented Oct 8, 2018 •

edited

Loading

otnielgomez commented Oct 9, 2018 •

edited

Loading

kmturley commented Oct 18, 2018 •

edited

Loading

rodleviton commented Oct 23, 2018 •

edited

Loading