Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JS] chore: file cleanup and unit tests #1183

Merged
merged 17 commits into from
Jan 23, 2024
Merged

[JS] chore: file cleanup and unit tests #1183

merged 17 commits into from
Jan 23, 2024

Conversation

corinagum
Copy link
Collaborator

@corinagum corinagum commented Jan 19, 2024

Linked issues

Fixes: #1163, closes #1181
related to: #239 #54

Details

  • Fixes MemoryFork doc strings
  • Fixes TurnState doc strings
  • Adds missing docs to several classes/methods
    • Adaptive Cards
    • TurnState
    • OpenAIEmbeddings
    • Azure OpenAI Client
    • testing folder
    • Layout Engine
    • System Message
    • User Input Message
    • User Message
    • Action Response Validator
    • Default Response Validator
    • JSON Response Validator
    • Response
    • Teams Chef Bot files
  • Fix api-extractor script to generate an updated version of teams-ai.api.json -- it was very out of date
  • Fix typedocscript to work. I did not merge in generated docs though; we have never used the docs site and I'm not convinced we need it. But at least the script works for if we decide to keep it.
  • Move Test____.ts files into packages/src/internals/testing -- these are mini-modules used exclusively for testing, and for better findability I decided to move them.
  • Updated eslintrc for Teams Chef Bot to allow @remarks
  • dev packages:
    • remove typedoc (unused)
    • remove unused typedoc script

Attestation Checklist

  • My code follows the style guidelines of this project

  • I have checked for/fixed spelling, linting, and other errors

  • I have commented my code for clarity

  • I have made corresponding changes to the documentation (we use TypeDoc to document our code)

  • My changes generate no new warnings

  • I have added tests that validates my changes, and provides sufficient test coverage. I have tested with:

    • Local testing
    • E2E testing in Teams
  • New and existing unit tests pass locally with my changes

@corinagum corinagum changed the title [Draft] chore: file cleanup and unit tests [JS] chore: file cleanup and unit tests Jan 19, 2024
@corinagum corinagum marked this pull request as ready for review January 19, 2024 19:46
js/package.json Outdated Show resolved Hide resolved
@corinagum corinagum merged commit 8b51dbb into main Jan 23, 2024
13 of 14 checks passed
@corinagum corinagum deleted the cg/sp3-ut branch January 23, 2024 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: JS - Fix typedoc and api-extractor scripts [Bug]: Inaccurate doc for JS SDK
2 participants