[yauzl-promise] adjust types following v4 rewrite

[LucVidal360]

Please fill in this template.

• 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 pnpm test <package to test>.

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: https://github.com/overlookmotel/yauzl-promise
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

---

Description

Starting v4.0.0, yauzl-promise was rewritten from scratch. Cf. overlookmotel/yauzl-promise@v3.0.0...v4.0.0

As such, several class properties were deleted/added/modified.

This PR is an attempt to fix the types to match the current implementation.

Exported properties

I tried to reflect only the officially documented properties, even though several more exist in the implementation.
However, I left undocumented properties if they were already exported in DefinitelyTyped, to avoid unnecessary breaking changes.

comment and filename: string or Buffer?

I've exported ZipFile.comment, Entry.comment and Entry.filename as string.
However, if the decodeStrings option is explicitly set to false, these 3 properties will effectively be Buffers.

• I could have exported them as string | Buffer, but I suppose most of the library users use the default option, and expect strings.
• I probably could have make ZipFile and Entry generic classes, depending on the type of decodeStrings, but it felt overkill here, adding complexity.
• To alleviate this issue, I've added a jsdoc entry on the offending properties, to warn users of this fact.

[typescript-bot]

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

• yauzl-promise — on npm, on unpkg

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 a DT maintainer

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": 69641,
  "author": "LucVidal360",
  "headCommitOid": "f5b4bb0bfb375f40e437107f33ea202c4b05d6e8",
  "mergeBaseOid": "425f0ebe145ac9337b0bcbd1084a548d729b4963",
  "lastPushDate": "2024-05-18T21:08:09.000Z",
  "lastActivityDate": "2024-05-18T21:08:09.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "yauzl-promise",
      "kind": "edit",
      "files": [
        {
          "path": "types/yauzl-promise/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/yauzl-promise/yauzl-promise-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 2119003780,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @LucVidal360 — there are no owners, 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...)