[euwa wrapper] Add types #63928

mannuelf · 2023-01-15T21:46:15Z

Creates types for Puzzel Chat EUWA Wrapper client as per:
https://help.puzzel.com/product-documents/user-guide/puzzel-contact-centre/puzzel-administration-portal/services/chat-configuration/euwa-wrapper-interface

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change.
Follow the advice from the readme.
Avoid common mistakes.
Run npm test <package to test>.

Select one of these and delete the others:

If adding a new definition:

The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
Represents shape of module/library correctly
tslint.json should contain { "extends": "@definitelytyped/dtslint/dt.json" }, and no additional rules.
tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

typescript-bot · 2023-09-26T05:51:51Z

@mannuelf Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

euwa-wrapper (new!) — on npm, on unpkg
- 1 added owner: ✎@mannuelf
- Config files to check:
  - euwa-wrapper/tslint.json: not the expected form (check: rules)

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

You can test the changes of this PR in the Playground.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
🕐 Only a DT maintainer can approve changes when there are new packages added

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 63928,
  "author": "mannuelf",
  "headCommitOid": "8397d684976b944ec7e0d05d03d11c56afc3b7b2",
  "mergeBaseOid": "540c106285ef0bc11e9546a03ee0fceb3cb76635",
  "lastPushDate": "2023-01-15T21:46:15.000Z",
  "lastActivityDate": "2023-10-14T12:50:56.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "euwa-wrapper",
      "kind": "add",
      "files": [
        {
          "path": "types/euwa-wrapper/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/euwa-wrapper/test/euwa-wrapper.tests.ts",
          "kind": "test"
        },
        {
          "path": "types/euwa-wrapper/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/euwa-wrapper/tslint.json",
          "kind": "package-meta",
          "suspect": "not [the expected form](https://github.com/DefinitelyTyped/DefinitelyTyped#user-content-linter-tslintjson) (check: `rules`)"
        }
      ],
      "owners": [],
      "addedOwners": [
        "mannuelf"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "changereq",
      "reviewer": "jakebailey",
      "date": "2023-10-13T03:49:27.000Z"
    }
  ],
  "mainBotCommentID": 1734872228,
  "ciResult": "pass"
}

typescript-bot · 2023-09-26T05:51:53Z

🔔 @mannuelf — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

typescript-bot · 2023-09-26T05:51:54Z

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @mannuelf.

(Ping @«anyone?».)

rbuckton · 2023-10-03T21:55:43Z

types/euwa-wrapper/index.d.ts

+     * It will open the chat window and show the next view
+     * @returns ChatState
+     */
+    getState: () => ChatState;


Are these supposed to be represented as fields or would methods make more sense?

Hi,

Following their example here I kept it as a method

declare interface ApplicationAPI { [method: string]: Function }

I created this for our own use on sats.no in our typescript/react site, and thought it would be nice to share it with one interested.

thanks for the review, my first time doing this, all tips & suggestions welcome :-)

peterblazejewicz · 2023-10-09T20:16:34Z

types/euwa-wrapper/test/euwa-wrapper.tests.ts

@@ -0,0 +1,39 @@
+import EUWA from 'euwa-wrapper';


this seems wrong, there is no 'euwa-wrapper' package in the ecosystem,
I could be wrong here, though. Is this real life-like code sample?

Hi, I used their real life example found here under the heading Basic Usage: click here

I used this same type in our website sats.no. Puzzel did not have any types published so I thought to publish the one I made and used in our site.

thanks for reviewing, all tips welcome this is my first time :-)

oh yeah their registry is not on npm :-(

Connecting to the NPM Registry A .npmrc file should be created either in your project or on user level. Read more about .npmrc on https://docs.npmjs.com/cli/v6/configuring-npm/npmrc The following lines should be added: @puzzel:registry=https://puzzel.pkgs.visualstudio.com/public/_packaging/main/npm/registry/ always-auth=true

I've used their instructions to download their package, and it indeed doesn't have types. But, this package is not on npm, not a global script (like jquery, youtube, etc), and not a runtime (node, bun, etc).

Additionally, there doesn't seem to be a license on that page that says whether or not these types can be copied and republished. The package that gets downloaded doesn't include a license at all!

I'm not convinced that this should (or can) be published on DefinitelyTyped. Can the authors be convinced to publish their code on npm with the the types? Or at least publish in a public registry with some sort of license on the types?

Thanks @jakebailey for double checking, I will contact them and ask them if they want to do this. In the meantime should I put this PR draft mode again while I discuss with them, or should I close the PR?

Whichever; the bot will probably close this if it's not merged in a few weeks, so a draft may be more representative.

jakebailey · 2023-10-13T03:49:25Z

types/euwa-wrapper/test/euwa-wrapper.tests.ts

@@ -0,0 +1,39 @@
+import EUWA from 'euwa-wrapper';


I've used their instructions to download their package, and it indeed doesn't have types. But, this package is not on npm, not a global script (like jquery, youtube, etc), and not a runtime (node, bun, etc).

Additionally, there doesn't seem to be a license on that page that says whether or not these types can be copied and republished. The package that gets downloaded doesn't include a license at all!

I'm not convinced that this should (or can) be published on DefinitelyTyped. Can the authors be convinced to publish their code on npm with the the types? Or at least publish in a public registry with some sort of license on the types?

typescript-bot · 2023-10-13T03:50:17Z

@mannuelf One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

DangerBotOSS · 2023-10-14T12:56:13Z

Formatting

The following files are not formatted:

types/euwa-wrapper/test/euwa-wrapper.tests.ts

Consider running npx dprint fmt on these files to make review easier.

Generated by 🚫 dangerJS against 8397d68

jakebailey

After #67332, this PR will need to be updated to include an .npmignore. See https://github.com/DefinitelyTyped/DefinitelyTyped#npmignore

typescript-bot added this to Needs Author Action in New Pull Request Status Board Jan 15, 2023

mannuelf added 23 commits September 26, 2023 06:29

adds starter directory

ba8d96f

adds tslint config as per base64-js example

1dfba01

refactor name

63d5b58

Adds attribution comment

5ed7a47

Adds types declarations

2be7fe8

adds puzzel test file path

b80ffa7

add doc blocks

7bded5e

Adds documention per method

244605a

add test file, showing api in use

84e1267

refactors package name and creates test

a015a39

update customerkey

5ac9901

rename folder to match package name

f7c3b09

adds comment and test

1431451

add optional variables example

7619869

refactors to match npm package name

f1b967a

removes reduntant export

1ffd337

exports default class

ced7112

prefer interface over types

66db2e4

adds version to header. fixes dont use function as type

0816b9d

removes redundant types, adds major minor version to header

74b9665

fixes prefer specific function type

143900b

updates header

b23efc1

updates header

73c2e1d

mannuelf force-pushed the add-types/euwa-wrapper branch from d0f53df to 73c2e1d Compare September 26, 2023 04:29

mannuelf added 3 commits September 26, 2023 06:33

fix: pust test in the test folder

62a487c

fix: adds more documentation

981c3f4

fix: jsdoc formatting

8397d68

mannuelf marked this pull request as ready for review September 26, 2023 05:51

typescript-bot added New Definition This PR creates a new definition package. Check Config Changes a module config files Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Sep 26, 2023

typescript-bot moved this from Needs Author Action to Needs Maintainer Action in New Pull Request Status Board Sep 26, 2023

rbuckton reviewed Oct 3, 2023

View reviewed changes

peterblazejewicz reviewed Oct 9, 2023

View reviewed changes

jakebailey requested changes Oct 13, 2023

View reviewed changes

typescript-bot added Revision needed This PR needs code changes before it can be merged. and removed Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Oct 13, 2023

typescript-bot moved this from Needs Maintainer Action to Needs Author Action in New Pull Request Status Board Oct 13, 2023

mannuelf closed this Oct 14, 2023

mannuelf reopened this Oct 14, 2023

mannuelf marked this pull request as draft October 14, 2023 12:51

jakebailey requested changes Nov 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[euwa wrapper] Add types #63928

[euwa wrapper] Add types #63928

mannuelf commented Jan 15, 2023

typescript-bot commented Sep 26, 2023 •

edited

typescript-bot commented Sep 26, 2023

typescript-bot commented Sep 26, 2023

rbuckton Oct 3, 2023

mannuelf Oct 11, 2023

peterblazejewicz Oct 9, 2023

mannuelf Oct 11, 2023

mannuelf Oct 11, 2023

jakebailey Oct 13, 2023 •

edited

mannuelf Oct 13, 2023

jakebailey Oct 13, 2023

jakebailey Oct 13, 2023 •

edited

typescript-bot commented Oct 13, 2023

DangerBotOSS commented Oct 14, 2023

jakebailey left a comment

[euwa wrapper] Add types #63928

Are you sure you want to change the base?

[euwa wrapper] Add types #63928

Conversation

mannuelf commented Jan 15, 2023

typescript-bot commented Sep 26, 2023 • edited

1 package in this PR

Code Reviews

Status

typescript-bot commented Sep 26, 2023

typescript-bot commented Sep 26, 2023

rbuckton Oct 3, 2023

Choose a reason for hiding this comment

mannuelf Oct 11, 2023

Choose a reason for hiding this comment

peterblazejewicz Oct 9, 2023

Choose a reason for hiding this comment

mannuelf Oct 11, 2023

Choose a reason for hiding this comment

mannuelf Oct 11, 2023

Choose a reason for hiding this comment

jakebailey Oct 13, 2023 • edited

Choose a reason for hiding this comment

mannuelf Oct 13, 2023

Choose a reason for hiding this comment

jakebailey Oct 13, 2023

Choose a reason for hiding this comment

jakebailey Oct 13, 2023 • edited

Choose a reason for hiding this comment

typescript-bot commented Oct 13, 2023

DangerBotOSS commented Oct 14, 2023

Formatting

jakebailey left a comment

Choose a reason for hiding this comment

typescript-bot commented Sep 26, 2023 •

edited

jakebailey Oct 13, 2023 •

edited

jakebailey Oct 13, 2023 •

edited