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

Update Leaflet declaration to include missing methods, as of version 1.8 #61339

Merged
merged 10 commits into from Sep 15, 2022

Conversation

someonewithpc
Copy link
Contributor

@someonewithpc someonewithpc commented Jul 19, 2022

Please fill in this template.

Select one of these and delete the others:

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: DivOverlay.openOn, Class.callInitHooks
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 19, 2022

@someonewithpc 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

@someonewithpc: I see that you have added yourself as an owner, are you sure you want to become an owner?

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

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

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 61339,
  "author": "someonewithpc",
  "headCommitOid": "5ca069fa5d95e8b6b78ff7d4ce53899d8c918384",
  "mergeBaseOid": "935a0289ffea73f059baf4f501480a44543e45af",
  "lastPushDate": "2022-08-18T11:53:59.000Z",
  "lastActivityDate": "2022-09-15T20:34:55.000Z",
  "mergeOfferDate": "2022-09-15T20:21:31.000Z",
  "mergeRequestDate": "2022-09-15T20:34:55.000Z",
  "mergeRequestUser": "someonewithpc",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "leaflet",
      "kind": "edit",
      "files": [
        {
          "path": "types/leaflet/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/leaflet/leaflet-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "alejo90",
        "atd-schubert",
        "mcauer",
        "ronikar",
        "life777",
        "henrythasler",
        "captain-igloo"
      ],
      "addedOwners": [
        "someonewithpc"
      ],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "sandersn",
      "date": "2022-09-15T20:20:46.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "dev4ndy",
      "date": "2022-08-18T21:39:16.000Z",
      "isMaintainer": false
    },
    {
      "type": "approved",
      "reviewer": "oliverzm",
      "date": "2022-08-18T21:32:31.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1189534652,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Edits Owners This PR adds or removes owners Popular package This PR affects a popular package (as counted by NPM download counts). labels Jul 19, 2022
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Jul 19, 2022
@typescript-bot
Copy link
Contributor

🔔 @alejo90 @atd-schubert @mcauer @ronikar @life777 @henrythasler @captain-igloo — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jul 19, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 19, 2022
@typescript-bot
Copy link
Contributor

@someonewithpc The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jul 19, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 19, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jul 19, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 19, 2022
@typescript-bot
Copy link
Contributor

@someonewithpc The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@someonewithpc someonewithpc changed the title Update Leaflet declaration to include missing methods, as of version 1.8 Draft: Update Leaflet declaration to include missing methods, as of version 1.8 Jul 19, 2022
@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jul 20, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 20, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jul 20, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 20, 2022
@typescript-bot
Copy link
Contributor

@someonewithpc The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@someonewithpc
Copy link
Contributor Author

someonewithpc commented Jul 20, 2022

The tests on this package succeed, but some dependent packages fail. My TS skills aren't yet the best, so I'm currently struggling to fix the issues.

They seem to stem from the fact upstream added a export var Mixin = { Events: Events; } (here), which I tried to handle with this and this, but, while it doesn't produce errors in the local tests, it does in the ones in packages that depend on this one. Input would be greatly appreciated.

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jul 20, 2022
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 20, 2022
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jul 20, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 20, 2022
@typescript-bot
Copy link
Contributor

@someonewithpc The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@typescript-bot
Copy link
Contributor

@someonewithpc I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on Aug 19th (in a week) if the issues aren't addressed.

@someonewithpc
Copy link
Contributor Author

All tests pass, but I wouldn't consider this the best way to do things. Namely:

@dadagama
Copy link

hello guys.
I was expecting to see the referrerpolicy property for TitleLayer, as it was added in Leaflet 1.8.0, and documented in the changelog

Is there any reason why this type property is not here as part of this PR?

Thanks for all the hard work you guys doing with this keeping the types up-to-date

@someonewithpc
Copy link
Contributor Author

someonewithpc commented Aug 18, 2022

Stricken elements don't seem to require changes on our part

Leaflet ## 1.8.0 (2022-04-18) changelog:

⚠️ Breaking Changes

❇️ API changes

  - Make DivOverlay / Tooltip interactive (DefinitelyTyped#7531, DefinitelyTyped#7532 by @johnd0e)
  - Add openOn, close, toggle functions to DivOverlay (DefinitelyTyped#6639 by @johnd0e)
  - Introduce DomEvent.off(el) to remove all listeners (DefinitelyTyped#7125 by @johnd0e)
  - Allow preventing round-off errors by passing false to Util.formatNum / toGeoJSON (DefinitelyTyped#7100 by @johnd0e)
  - Add autoPanOnFocus to Marker (DefinitelyTyped#8042 by @IvanSanchez)
  - Add referrerPolicy to TileLayer (DefinitelyTyped#7945 by @natevw)
  - Add playsInline to VideoOverlay (DefinitelyTyped#7928 by @Falke-Design)
  - Add getCenter to ImageOverlay (DefinitelyTyped#7848 by @Falke-Design)
  - Fire a tileabort event when a TileLayer load is cancelled (DefinitelyTyped#6786 by @dstndstn)
  - Add crossOrigin to Icon (DefinitelyTyped#7298 by @syedmuhammadabid)
@typescript-bot typescript-bot added the Other Approved This PR was reviewed and signed-off by a community member. label Aug 18, 2022
@someonewithpc
Copy link
Contributor Author

@oliverzm Thanks for the approval, but can you suggest a better way to structure the Events and Evented classes? I'm not happy with the current "solution", which is just to duplicate the code

Copy link

@dev4ndy dev4ndy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please merge 💯

@typescript-bot typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Sep 11, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Sep 11, 2022
types/leaflet/index.d.ts Show resolved Hide resolved
types/leaflet/index.d.ts Show resolved Hide resolved
types/leaflet/index.d.ts Show resolved Hide resolved
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner and removed Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Sep 15, 2022
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Author to Merge in New Pull Request Status Board Sep 15, 2022
@someonewithpc
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Sep 15, 2022
@typescript-bot typescript-bot merged commit 061fed3 into DefinitelyTyped:master Sep 15, 2022
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Edits Owners This PR adds or removes owners Maintainer Approved Other Approved This PR was reviewed and signed-off by a community member. Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants