microsoft / microsoft/BotFramework-WebChat

Typing for Direct Line objects

Open
#3,953 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
HTML
Stars
1.8k
Forks
1.6k
Avg merge
22h 58m
Merged PRs (30d)
2

Description

Feature Request

As we start to add typings to all of our code, we specifically didn't type Direct Line objects because we didn't think out the plan to correctly type these objects:

  1. Import typings from DirectLineJS
    • It's outdated
  2. Import typings from botframework-schema
    • It depends on botbuilder-stdlib, which is not a small library
    • Some undocumented code is using botbuilder-stdlib and they are related to assertions
    • We could import { IActivity } from 'botframework-schema/lib/activityInterfaces' but seems a bit hacky
    • We could reach SDK team for a further discussion
  3. Write our owns
    • Bigger effort
    • We can fully understand what fields we used
    • When we move to ACS later, understanding these fields helps
    • When we move to ACS, we could consider having our own schema, bringing best of both world

[feature-request]

Contributor guide

Open the contributing guide

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 reviewing the three typing approaches listed in the issue: DirectLineJS, botframework-schema, and writing project-owned types. The issue does not name files, tests, or an entry point, and completion is not defined beyond selecting and implementing a typing strategy for Direct Line objects, so clarification is needed before starting.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.