[BUG]: types don't resolve for `@octokit/core` on esm.sh #2762

ThisGuyCodes · 2024-11-19T22:30:32Z

What happened?

deno check ... consistently errors when using octokit via esm.sh

Versions

Octokit.js v4.0.2
Deno v2.0.6

Relevant log output

$ deno check *.ts **/*.ts --allow-import
error: Failed resolving types. Relative import path "@octokit/core/types" not prefixed with / or ./ or ../ and not in import map from "https://esm.sh/v135/[email protected]/X-ZS8q/dist-types/octokit.d.ts"
    at https://esm.sh/v135/[email protected]/X-ZS8q/dist-types/octokit.d.ts:4:59
$

Code of Conduct

I agree to follow this project's Code of Conduct

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

github-actions · 2024-11-19T22:30:44Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

wolfy1339 · 2024-11-19T22:33:32Z

This seems like an issue with esm.sh not resolving the import map

That import path is defined in package.json
https://unpkg.com/browse/@octokit/[email protected]/package.json (Line 67)

ThisGuyCodes · 2024-11-19T22:34:13Z

I honestly don't know if I'm doing something wrong, I also opened an issue with esm.sh about a bug with their deno cli integration, and they told me they're deprecating it, so maybe it's got something to do with the way that added it to my import map?

here's what my import map looks like:

  "imports": {
    "deno-slack-api/": "https://deno.land/x/[email protected]/",
    "deno-slack-sdk/": "https://deno.land/x/[email protected]/",
    "mock-fetch/": "https://deno.land/x/[email protected]/",
    "@octokit/webhooks-types": "https://esm.sh/v135/@octokit/[email protected]",
    "octokit": "https://esm.sh/v135/*[email protected]",
    "@std/testing": "jsr:@std/testing@^1.0.5"
  },
  "scopes": {
    "https://esm.sh/v135/": {
      "@octokit/app": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/core": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/oauth-app": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/plugin-paginate-graphql": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/plugin-paginate-rest": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/plugin-rest-endpoint-methods": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/plugin-retry": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/plugin-throttling": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/request-error": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/types": "https://esm.sh/v135/@octokit/[email protected]"
    }
  }

ThisGuyCodes · 2024-11-19T22:37:13Z

@wolfy1339 I notice you linked the @octokit/core package.json, but the error is saying it's not defined in the octokit package, is octokit somehow supposed to inherit the import map from @octokit/core?

(I genuinely have no idea how these things work)

wolfy1339 · 2024-11-19T22:47:42Z

The octokit module is built on multiple other Octokit libraries packaged together, like @octokit/core, @octokit/app, @octokit/webhooks.

Sorry, I meant export map
https://nodejs.org/api/packages.html#exports

It defines the exports of that package, in that case, there's 2 exports.
./ is the main entrypoint
./types is a special entrypoint to access some types not exported in the main entrypoint but needed elsewhere.

The problem lies with esm.sh not using the export map in order to map the import to the correct file.

In the mean time, try adding the following to your scopes

"@octokit/core/types": "https://esm.sh/v135/@octokit/[email protected]/dist-types/types.d.ts",

Also, to prevent any type errors ditch the @octokit/webhooks-types package in favour of the @octokit/openapi-webhooks-types package. The former are not compatible with v4 of Octokit

wolfy1339 · 2024-11-19T23:15:14Z

Closing as there is nothing else actionable for Octokit itself

ThisGuyCodes · 2024-11-19T23:48:22Z

@wolfy1339 thanks for the workaround. Though it seems this just moved on to something else :(

$ deno check test.ts
error: Failed resolving types. Relative import path "node" not prefixed with / or ./ or ../ and not in import map from "https://esm.sh/v135/@octokit/[email protected]/dist-types/RequestRequestOptions.d.ts"
    at https://esm.sh/v135/@octokit/[email protected]/dist-types/RequestRequestOptions.d.ts:1:22

it genuinely seems like I'm the only one doing this...

wolfy1339 · 2024-11-19T23:49:28Z

please try to force it to use version 13.6.1 of @octokit/types

ThisGuyCodes · 2024-11-19T23:53:49Z

my scopes already has this:

"@octokit/types": "https://esm.sh/v135/@octokit/[email protected]"

I seriously don't know how to do what you're asking

wolfy1339 · 2024-11-20T00:00:13Z

Nevermind that. It's esm.sh keeping an old version of @octokit/types around

As for that error you are getting, it's TypeScript trying to shoehorn NodeJS typings into the project.
The issue seems to stem from AbortSignal which is not a Node specific API

The line in question is the following (https://unpkg.com/browse/@octokit/[email protected]/dist-types/RequestRequestOptions.d.ts)

/// <reference types="node" resolution-mode="require"/>

See octokit/octokit.js#2762 (comment)

wolfy1339 · 2024-11-20T00:09:20Z

Will be fixed by octokit/types.ts#656

ThisGuyCodes · 2024-11-20T00:52:49Z

Also, to prevent any type errors ditch the @octokit/webhooks-types package in favour of the @octokit/openapi-webhooks-types package. The former are not compatible with v4 of Octokit

@wolfy1339 Can you elaborate a bit more? I use this package like this:

import { WebhookEvent } from "@octokit/webhooks-types";

const handleWebhook = (payload) => {
  const event = payload as WebhookEvent;

  // type narrowing via stuff like this:
  if ("state" in event) {
    // TypeScript now considers event to be of type `StatusEvent`
  }
}

I can't figure out how to solve for my needs with @octokit/openapi-webhooks-types

wolfy1339 · 2024-11-20T01:26:13Z

See https://github.com/octokit/webhooks.js/releases/tag/v13.0.0

The types were completely redone and are not compatible.

import type { webhooks as OpenAPIWebhooks } from "@octokit/openapi-webhooks-types";
export type WebhookEventDefinition<TEventName extends keyof OpenAPIWebhooks> =
  OpenAPIWebhooks[TEventName]["post"]["requestBody"]["content"]["application/json"];
export type StatusEvent = WebhookEventDefinition<"status">;

I am working on making a transition package that drops in and replaces @octokit/webhooks-types and will resolve everything into friendlier types

wolfy1339 · 2024-11-20T01:34:32Z

Try using @octokit/openapi-webhooks-types-transition

ThisGuyCodes · 2024-11-20T23:08:24Z

@wolfy1339 works perfect with no other code changes! ❤️

See octokit/octokit.js#2762 (comment)

This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@octokit/types](https://redirect.github.com/octokit/types.ts) | [`13.6.1` -> `13.6.2`](https://renovatebot.com/diffs/npm/@octokit%2ftypes/13.6.1/13.6.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@octokit%2ftypes/13.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@octokit%2ftypes/13.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@octokit%2ftypes/13.6.1/13.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@octokit%2ftypes/13.6.1/13.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>octokit/types.ts (@octokit/types)</summary> ### [`v13.6.2`](https://redirect.github.com/octokit/types.ts/releases/tag/v13.6.2) [Compare Source](https://redirect.github.com/octokit/types.ts/compare/v13.6.1...v13.6.2) ##### Bug Fixes - remove `@types/node` from generated types ([#656](https://redirect.github.com/octokit/types.ts/issues/656)) ([730a26d](https://redirect.github.com/octokit/types.ts/commit/730a26dc2d919f19ed5401ffdf83286181da8772)), closes [/github.com/octokit/octokit.js/issues/2762#issuecomment-2486997620](https://redirect.github.com//github.com/octokit/octokit.js/issues/2762/issues/issuecomment-2486997620) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" in timezone Europe/Berlin, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/WtfJoke/setup-tectonic).

wolfy1339 · 2024-12-28T01:13:44Z

@ThisGuyCodes
I managed to get deno check to work using the following import map

"scopes": {
    "https://esm.sh/v135/": {
      "@octokit/app": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/core": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/core/types": "https://esm.sh/v135/@octokit/[email protected]/dist-types/types.d.ts",
      "@octokit/oauth-app": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-paginate-graphql": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-paginate-rest": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-rest-endpoint-methods": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-retry": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-throttling": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/request-error": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/types": "https://esm.sh/v135/@octokit/[email protected]",
      "@octokit/request": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/graphql": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "before-after-hook": "https://esm.sh/v135/[email protected]"
    }
  }

I had to add the dependency override for esm.sh, as documented here: https://esm.sh/#specifying-dependencies

The esm.sh deno thingy missed adding @octokit/graphql, before-after-hook and @octokit/request

For some reason, TypeScript is including references to `@types/node` in the generated types. See octokit/types.ts#656 See octokit/octokit.js#2762 (comment)

wolfy1339 · 2025-01-08T19:49:10Z

We still have this issue to contend with, esm-dev/esm.sh#995.

I got rid of all @types/node on the Octokit side of things

I got deno check to work:

{
  "imports": {
    "octokit": "https://esm.sh/v135/*[email protected]?target=deno",
    "_http_agent": "node:_http_agent",
    "_http_client": "node:_http_client",
    "_http_common": "node:_http_common",
    "_http_incoming": "node:_http_incoming",
    "_http_outgoing": "node:_http_outgoing",
    "_http_server": "node:_http_server",
    "_stream_duplex": "node:_stream_duplex",
    "_stream_passthrough": "node:_stream_passthrough",
    "_stream_readable": "node:_stream_readable",
    "_stream_transform": "node:_stream_transform",
    "_stream_wrap": "node:_stream_wrap",
    "_stream_writable": "node:_stream_writable",
    "_tls_common": "node:_tls_common",
    "_tls_wrap": "node:_tls_wrap",
    "assert": "node:assert",
    "assert/strict": "node:assert/strict",
    "async_hooks": "node:async_hooks",
    "buffer": "node:buffer",
    "child_process": "node:child_process",
    "cluster": "node:cluster",
    "console": "node:console",
    "constants": "node:constants",
    "crypto": "node:crypto",
    "dgram": "node:dgram",
    "diagnostics_channel": "node:diagnostics_channel",
    "dns": "node:dns",
    "dns/promises": "node:dns/promises",
    "domain": "node:domain",
    "events": "node:events",
    "fs": "node:fs",
    "fs/promises": "node:fs/promises",
    "http": "node:http",
    "http2": "node:http2",
    "https": "node:https",
    "inspector": "node:inspector",
    "inspector/promises": "node:inspector/promises",
    "module": "node:module",
    "net": "node:net",
    "os": "node:os",
    "path": "node:path",
    "path/posix": "node:path/posix",
    "path/win32": "node:path/win32",
    "perf_hooks": "node:perf_hooks",
    "process": "node:process",
    "punycode": "node:punycode",
    "querystring": "node:querystring",
    "readline": "node:readline",
    "readline/promises": "node:readline/promises",
    "repl": "node:repl",
    "stream": "node:stream",
    "stream/consumers": "node:stream/consumers",
    "stream/promises": "node:stream/promises",
    "stream/web": "node:stream/web",
    "string_decoder": "node:string_decoder",
    "sys": "node:sys",
    "timers": "node:timers",
    "timers/promises": "node:timers/promises",
    "tls": "node:tls",
    "trace_events": "node:trace_events",
    "tty": "node:tty",
    "url": "node:url",
    "util": "node:util",
    "util/types": "node:util/types",
    "v8": "node:v8",
    "vm": "node:vm",
    "wasi": "node:wasi",
    "worker_threads": "node:worker_threads",
    "zlib": "node:zlib"
  },
  "scopes": {
    "https://esm.sh/v135/": {
      "@octokit/app": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/auth-app": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/auth-unauthenticated": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/core": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/core/types": "https://esm.sh/v135/@octokit/[email protected]/dist-types/types.d.ts?target=deno",
      "@octokit/oauth-app": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/plugin-paginate-graphql": "https://esm.sh/v135/@octokit/[email protected]?deps=@octokit/[email protected]",
      "@octokit/plugin-paginate-rest": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/plugin-rest-endpoint-methods": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/plugin-retry": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/plugin-throttling": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/request-error": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/types": "https://esm.sh/v135/@octokit/[email protected]?target=deno",
      "@octokit/webhooks": "https://esm.sh/v135/@octokit/[email protected]?target=deno"
    }
  }
}

ThisGuyCodes added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Nov 19, 2024

octokitbot added this to 🧰 Octokit Active Nov 19, 2024

github-project-automation bot moved this to 🆕 Triage in 🧰 Octokit Active Nov 19, 2024

wolfy1339 added Type: Support Any questions, information, or general needs around the SDK or GitHub APIs and removed Type: Bug Something isn't working as documented Status: Triage This is being looked at and prioritized labels Nov 19, 2024

wolfy1339 changed the title ~~[BUG]: types don't resolve in Deno~~ [BUG]: types don't resolve for @octokit/core on esm.sh Nov 19, 2024

ThisGuyCodes mentioned this issue Nov 19, 2024

Failed to import - octokit (types) esm-dev/esm.sh#918

Closed

wolfy1339 closed this as not planned Won't fix, can't repro, duplicate, stale Nov 19, 2024

github-project-automation bot moved this from 🆕 Triage to ✅ Done in 🧰 Octokit Active Nov 19, 2024

wolfy1339 added a commit to octokit/types.ts that referenced this issue Nov 20, 2024

fix: remove @types/node from generated types

a2db313

See octokit/octokit.js#2762 (comment)

wolfy1339 mentioned this issue Nov 20, 2024

fix: remove @types/node from generated types octokit/types.ts#656

Merged

4 tasks

ThisGuyCodes mentioned this issue Nov 20, 2024

[QUERY] How to deploy with npm module dependencies? slackapi/deno-slack-hooks#89

Open

wolfy1339 added a commit to octokit/types.ts that referenced this issue Nov 25, 2024

fix: remove @types/node from generated types (#656)

730a26d

See octokit/octokit.js#2762 (comment)

nickfloyd removed this from 🧰 Octokit Active Dec 26, 2024

This was referenced Dec 28, 2024

fix(deps): bump @octokit/types to fix deno compat octokit/request.js#730

Merged

fix(deps): bump @octokit/types to fix Deno compat octokit/request-error.js#483

Merged

wolfy1339 mentioned this issue Dec 28, 2024

fix(deps): remove @types/node from dependency tree octokit/oauth-app.js#579

Merged

4 tasks

wolfy1339 added the deno label Jan 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG]: types don't resolve for `@octokit/core` on esm.sh #2762

[BUG]: types don't resolve for `@octokit/core` on esm.sh #2762

ThisGuyCodes commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024 •

edited

Loading

wolfy1339 commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024 •

edited

Loading

ThisGuyCodes commented Nov 19, 2024 •

edited

Loading

wolfy1339 commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

ThisGuyCodes commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

ThisGuyCodes commented Nov 20, 2024

wolfy1339 commented Dec 28, 2024

wolfy1339 commented Jan 8, 2025 •

edited

Loading

[BUG]: types don't resolve for @octokit/core on esm.sh #2762

[BUG]: types don't resolve for @octokit/core on esm.sh #2762

Comments

ThisGuyCodes commented Nov 19, 2024

What happened?

Versions

Relevant log output

Code of Conduct

github-actions bot commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024 • edited Loading

wolfy1339 commented Nov 19, 2024

ThisGuyCodes commented Nov 19, 2024

wolfy1339 commented Nov 19, 2024 • edited Loading

ThisGuyCodes commented Nov 19, 2024 • edited Loading

wolfy1339 commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

ThisGuyCodes commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

wolfy1339 commented Nov 20, 2024

ThisGuyCodes commented Nov 20, 2024

wolfy1339 commented Dec 28, 2024

wolfy1339 commented Jan 8, 2025 • edited Loading

[BUG]: types don't resolve for `@octokit/core` on esm.sh #2762

[BUG]: types don't resolve for `@octokit/core` on esm.sh #2762

wolfy1339 commented Nov 19, 2024 •

edited

Loading

wolfy1339 commented Nov 19, 2024 •

edited

Loading

ThisGuyCodes commented Nov 19, 2024 •

edited

Loading

wolfy1339 commented Jan 8, 2025 •

edited

Loading