`@apollo/client^3.5.0` transpilation produces `error TS2688: Cannot find type definition file for 'zen-observable'.`` #9040

KeithGillette · 2021-11-10T17:01:51Z

Intended outcome:
Updating from 3.4.17 to ^3.5.0 should work without error.

Actual outcome:
Building a project depending on @apollo/[email protected] generates transpilation error TS2688: Cannot find type definition file for 'zen-observable'. when tsc is run with default skipLibCheck: false:

node_modules/@apollo/client/core/ApolloClient.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/core/ObservableQuery.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/core/QueryInfo.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/core/QueryInfo.d.ts:22:24 - error TS2503: Cannot find namespace 'ZenObservable'.

22     subscriptions: Set<ZenObservable.Subscription>;
                          ~~~~~~~~~~~~~

node_modules/@apollo/client/core/QueryManager.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/core/ApolloLink.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/core/types.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/error/index.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/retry/retryLink.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/utils/fromError.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/utils/fromPromise.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/utils/toPromise.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/link/ws/index.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/utilities/observables/asyncMap.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/utilities/observables/Concast.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

node_modules/@apollo/client/utilities/observables/subclassing.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />
                        ~~~~~~~~~~~~~~

How to reproduce the issue:
Run tsc on project including @apollo/[email protected] with tsconfig.json leaving default skipLibCheck: false.

Versions

System:
  OS: macOS 12.0.1
Binaries:
  Node: 14.18.1 - ~/.nvm/versions/node/v14.18.1/bin/node
  npm: 6.14.15 - ~/.nvm/versions/node/v14.18.1/bin/npm
Browsers:
  Chrome: 95.0.4638.69
  Firefox: 92.0.1
  Safari: 15.1
npmPackages:
  @apollo/client: 3.5.2 => 3.5.2 
  apollo-angular: 2.6.0 => 2.6.0 
  apollo-server-core: 3.5.0 => 3.5.0 
  apollo-server-express: 3.5.0 => 3.5.0

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

benjamn · 2021-11-16T20:04:04Z

@KeithGillette What version do you see in node_modules/@apollo/client/package.json? If @apollo/client was successfully updated to v3.5, there should no longer be any

/// <reference types="zen-observable" />

lines in the generated .d.ts files.

More background on why we decided to remove zen-observable and @types/zen-observable as dependencies: apollographql/zen-observable-ts#152

You might also need to run npm install by itself, to sort out the new dependencies?

KeithGillette · 2021-11-16T20:32:14Z

Hi, @benjamn — node_modules/@apollo/client/package.json shows version 3.5.2 after an individual package upgrade npm install --save-exact @apollo/[email protected], after a further npm install per your suggestion, and after another npm install following an rm -rf node_modules just to be safe. In all cases, I still receive the same output on project transpilation as originally reported.

{
  "_from": "@apollo/[email protected]",
  "_id": "@apollo/[email protected]",
  "_inBundle": false,
  "_integrity": "sha512-STC7ZQthcOGU+MXRIzcb3s1ULW9QQFEhXFEIUaK3Jdwy0RxncxYkg2LpwxXV0FqlYUjKEW92f+NUIZ2FhpKGug==",
  "_location": "/@apollo/client",
  "_phantomChildren": {},
  "_requested": {
    "type": "version",
    "registry": true,
    "raw": "@apollo/[email protected]",
    "name": "@apollo/client",
    "escapedName": "@apollo%2fclient",
    "scope": "@apollo",
    "rawSpec": "3.5.2",
    "saveSpec": null,
    "fetchSpec": "3.5.2"
  },
  "_requiredBy": [
    "#USER",
    "/"
  ],
  "_resolved": "https://registry.npmjs.org/@apollo/client/-/client-3.5.2.tgz",
  "_shasum": "f0a4d8cb42f045e0527f081da9bb21c4fb53aeaf",
  "_spec": "@apollo/[email protected]",
  "_where": "/Users/keith.gillette/Code/TaskTrain",
  "author": {
    "name": "[email protected]"
  },
  "bugs": {
    "url": "https://github.com/apollographql/apollo-client/issues"
  },
  "bundleDependencies": false,
  "dependencies": {
    "@graphql-typed-document-node/core": "^3.0.0",
    "@wry/context": "^0.6.0",
    "@wry/equality": "^0.5.0",
    "@wry/trie": "^0.3.0",
    "graphql-tag": "^2.12.3",
    "hoist-non-react-statics": "^3.3.2",
    "optimism": "^0.16.1",
    "prop-types": "^15.7.2",
    "symbol-observable": "^4.0.0",
    "ts-invariant": "^0.9.0",
    "tslib": "^2.3.0",
    "zen-observable-ts": "^1.2.0"
  },
  "deprecated": false,
  "description": "A fully-featured caching GraphQL client.",
  "devDependencies": {
    "@babel/parser": "7.16.2",
    "@graphql-tools/schema": "8.3.1",
    "@rollup/plugin-node-resolve": "11.2.1",
    "@testing-library/react": "9.5.0",
    "@testing-library/react-hooks": "7.0.2",
    "@types/fast-json-stable-stringify": "2.0.0",
    "@types/fetch-mock": "7.3.5",
    "@types/glob": "7.2.0",
    "@types/hoist-non-react-statics": "3.3.1",
    "@types/jest": "27.0.2",
    "@types/lodash": "4.14.176",
    "@types/node": "16.11.6",
    "@types/react": "17.0.34",
    "@types/react-dom": "17.0.2",
    "bundlesize": "0.18.1",
    "cross-fetch": "3.1.4",
    "crypto-hash": "1.3.0",
    "fetch-mock": "9.11.0",
    "glob": "7.2.0",
    "graphql": "^16.0.0",
    "jest": "27.3.1",
    "jest-fetch-mock": "3.0.3",
    "jest-junit": "13.0.0",
    "lodash": "4.17.21",
    "react": "17.0.2",
    "react-dom": "17.0.2",
    "recast": "0.20.5",
    "resolve": "1.20.0",
    "rimraf": "3.0.2",
    "rollup": "2.50.5",
    "rollup-plugin-terser": "7.0.2",
    "rxjs": "6.6.7",
    "subscriptions-transport-ws": "0.11.0",
    "terser": "5.9.0",
    "ts-jest": "27.0.7",
    "ts-node": "10.4.0",
    "typescript": "4.4.4",
    "wait-for-observables": "1.0.3",
    "whatwg-fetch": "3.6.2"
  },
  "homepage": "https://www.apollographql.com/docs/react/",
  "keywords": [
    "apollo",
    "graphql",
    "react",
    "hooks",
    "client",
    "cache"
  ],
  "license": "MIT",
  "main": "./main.cjs",
  "module": "./index.js",
  "name": "@apollo/client",
  "peerDependencies": {
    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0",
    "react": "^16.8.0 || ^17.0.0",
    "subscriptions-transport-ws": "^0.9.0 || ^0.11.0"
  },
  "peerDependenciesMeta": {
    "react": {
      "optional": true
    },
    "subscriptions-transport-ws": {
      "optional": true
    }
  },
  "private": false,
  "publishConfig": {
    "access": "public"
  },
  "react-native": {
    "./dist/cache/inmemory/fixPolyfills.js": "./cache/inmemory/fixPolyfills.native.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/apollographql/apollo-client.git"
  },
  "sideEffects": false,
  "type": "module",
  "types": "./index.d.ts",
  "version": "3.5.2"
}

benjamn · 2021-11-17T19:54:47Z

@KeithGillette Thanks for double checking!

While I'm confident @apollo/[email protected] (just published by me) will resolve this issue, I'm less sure about the explanation. I tried reverting the changes in #9073 and rebuilding (and then also rebuilding from v3.5.2), and neither rebuild brought back the <reference types="zen-observable" /> declarations (good, but strange they got published).

Since different people published v3.5.2 and v3.5.0-v3.5.2, it's possible we (@hwillson @brainkim and I) need to align our publishing workflows better. Good to know.

KeithGillette · 2021-11-18T01:18:34Z

Thanks, @benjamn. I confirm that release 3.5.3 resolves this typings issue.

You know that none of the 3.5 releases are published on NPMJS, right? 3.4.17 is still listed as the latest version in the registry.

brainkim · 2021-11-18T02:10:53Z

@KeithGillette Yep, we’re doing some additional checks live because no one would download the beta 😢 should be set to latest soon.

MaRuifeng · 2022-05-11T23:14:48Z

Has this issue been resolved indeed? I am getting below error message. I know it's reflected in a different library package
apollo-link-timeout, but downgrading "@apollo/client" from 3.6.1 to 3.3.6 fixed the issue. After downgrading I was able to see package @types/zen-observable being installed properly.

node_modules/apollo-link-timeout/lib/timeoutLink.d.ts:1:23 - error TS2688: Cannot find type definition file for 'zen-observable'.

1 /// <reference types="zen-observable" />

KeithGillette changed the title ~~@apollo/[email protected] transpilation produces error TS2688: Cannot find type definition file for 'zen-observable'.`~~ @apollo/client^3.5.0 transpilation produces error TS2688: Cannot find type definition file for 'zen-observable'.` Nov 10, 2021

brainkim self-assigned this Nov 11, 2021

brainkim added the ⛑ TypeScript label Nov 11, 2021

brainkim assigned benjamn and unassigned brainkim Nov 16, 2021

benjamn added this to the v3.5.x patch releases milestone Nov 17, 2021

KeithGillette closed this as completed Nov 18, 2021

nateql added 2021-11 labels Nov 18, 2021

github-actions bot locked as resolved and limited conversation to collaborators Feb 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`@apollo/client^3.5.0` transpilation produces `error TS2688: Cannot find type definition file for 'zen-observable'.`` #9040

`@apollo/client^3.5.0` transpilation produces `error TS2688: Cannot find type definition file for 'zen-observable'.`` #9040

KeithGillette commented Nov 10, 2021 •

edited

Loading

benjamn commented Nov 16, 2021

KeithGillette commented Nov 16, 2021

benjamn commented Nov 17, 2021

KeithGillette commented Nov 18, 2021

brainkim commented Nov 18, 2021

MaRuifeng commented May 11, 2022

@apollo/client^3.5.0 transpilation produces error TS2688: Cannot find type definition file for 'zen-observable'.` #9040

@apollo/client^3.5.0 transpilation produces error TS2688: Cannot find type definition file for 'zen-observable'.` #9040

Comments

KeithGillette commented Nov 10, 2021 • edited Loading

benjamn commented Nov 16, 2021

KeithGillette commented Nov 16, 2021

benjamn commented Nov 17, 2021

KeithGillette commented Nov 18, 2021

brainkim commented Nov 18, 2021

MaRuifeng commented May 11, 2022

`@apollo/client^3.5.0` transpilation produces `error TS2688: Cannot find type definition file for 'zen-observable'.`` #9040

`@apollo/client^3.5.0` transpilation produces `error TS2688: Cannot find type definition file for 'zen-observable'.`` #9040

KeithGillette commented Nov 10, 2021 •

edited

Loading