Add list options and fix status object

[b0939261761]

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 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.
• Create it with dts-gen --dt, not by basing it on an existing project.
• 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.

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: <>
• 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.

If removing a declaration:

• If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
• Delete the package's directory.
• Add it to notNeededPackages.json.

[typescript-bot]

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

• imapflow — on npm, on unpkg
  • owner-approval: @martin-badin

Code Reviews

This PR can be merged once it's reviewed by a DT maintainer.

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 without tests

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": 64482,
  "author": "b0939261761",
  "headCommitOid": "a83784a6325f77c149058b5a6f79ff51d7dba635",
  "mergeBaseOid": "055ec5302dd094d1fc5fe24e02905a89e3a5b2a5",
  "lastPushDate": "2023-02-25T09:20:05.000Z",
  "lastActivityDate": "2023-03-18T06:47:05.000Z",
  "mergeOfferDate": "2023-03-17T17:29:19.000Z",
  "mergeRequestDate": "2023-03-18T06:47:05.000Z",
  "mergeRequestUser": "martin-badin",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "imapflow",
      "kind": "edit",
      "files": [
        {
          "path": "types/imapflow/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "jeffreyratton98",
        "martin-badin",
        "grayson-code"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "jakebailey",
      "date": "2023-03-17T17:28:33.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "martin-badin",
      "date": "2023-03-15T12:59:10.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1445039610,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @jeffreyratton98 @martin-badin @Grayson-code — 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.

[martin-badin]

You can extend this interface from StatusQuery. The interface has the same properties.

[b0939261761]

export interface StatusObject {
    path: string;
    messages?: number;
    recent?: number;
    uid?: number;
    uidValidity?: bigint;
    unseen?: number;
    highestModSeq?: bigint;
}


export interface StatusQuery {
    messages?: boolean;
    recent?: boolean;
    uidNext?: boolean;
    uidValidity?: boolean;
    unseen?: boolean;
    highestModseq?: boolean;
}

They have a different structure.

export interface StatusObject {
  path: string;
  uid?: number;
}

export interface StatusQuery {
  uidNext?: boolean;
}

Therefore, they cannot be StatusQuery extends StatusObject or StatusObject extends StatusQuery.

[typescript-bot]

Re-ping @jeffreyratton98, @martin-badin, @Grayson-code:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

[typescript-bot]

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, @b0939261761.

(Ping @jeffreyratton98, @Grayson-code.)

[typescript-bot]

⏳ Hi @b0939261761,

It's been a few days since this PR was approved by martin-badin and we're waiting for a DT maintainer to give a review.

If you would like to short-circuit this wait, you can edit some of the test files in the package which verify how the .d.ts files work. This would allow the PR to be merged by you or the DT module owners after a re-review.

[martin-badin]

Ready to merge