inrupt / inrupt/solid-client-authn-js

Session.onError not in types for solid-client-authn-node@1.11.2

Open
#1,794 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
77
Forks
49
Avg merge
18h 20m
Merged PRs (30d)
32

Description

Search terms you've used

I looked at every one of the 44 existing issues and this is the only similar one but it appears quite different

Impacted package

Which packages do you think might be impacted by the bug ?

  • solid-client-authn-browser
  • solid-client-authn-node
  • solid-client-authn-core
  • oidc-client-ext
  • Other (please specify): ...
Bug description

I see lots of other methods reflected in the types in Visual Studio Code, but onError isn't available.

I see the method referenced in the docs.

To Reproduce
  1. Install solid-client-authn-node@1.11.2 into a project you have loaded into Visual Studio Code
  2. Create a Session object and then make a call to the onError method:
import { Session } from "@inrupt/solid-client-authn-node";
const session = new Session()
session.onError(console.error)
Expected result
  • Visual Studio Code should find it in the types and no error should be shown
  • The code should compile
Actual result
  • Visual Studio Code does not find it in the types and reports the problem with a red squiggly line.
    image

image

  • The code does not compile
    image
Environment

Please run

npx envinfo --system --npmPackages --binaries --npmGlobalPackages --browsers

in your project folder and paste the output here:

  System:
    OS: Linux 5.14 Debian GNU/Linux 11 (bullseye) 11 (bullseye)
    CPU: (16) x64 Intel(R) Core(TM) i9-10885H CPU @ 2.40GHz
    Memory: 11.57 GB / 31.09 GB
    Container: Yes
    Shell: 5.1.4 - /bin/bash
  Binaries:
    Node: 16.13.0 - /usr/local/bin/node
    Yarn: 1.22.15 - /usr/bin/yarn
    npm: 8.1.0 - /usr/local/bin/npm
  npmPackages:
    @inrupt/solid-client-authn-node: * => 1.11.2 
    @inrupt/solid-client-notifications: * => 0.1.0 
    node-fetch: * => 2.6.1 
    rdflib: * => 2.2.10 
    ts-node: * => 10.4.0 
  npmGlobalPackages:
    eslint: 8.1.0
    tslint-to-eslint-config: 2.10.1
    typescript: 4.4.4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the exported Session type used by solid-client-authn-node@1.11.2 and reproduce the TypeScript snippet from the issue in Visual Studio Code. Compare the node package's declarations with the documented Session API, then verify that onError is discoverable and the example compiles.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
authentication
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.