Add basic types for sub-encoder

[EvanHahn]

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 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
• tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

[typescript-bot]

@EvanHahn Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

• sub-encoder (new!) — on npm, on unpkg
  • 1 added owner: ✎@EvanHahn

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

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": 68390,
  "author": "EvanHahn",
  "headCommitOid": "eb6572e53925e4cd2b362ef89dd6812d5643fa20",
  "mergeBaseOid": "09544432db06d33976eb328945253b53a4e0b646",
  "lastPushDate": "2024-01-30T22:57:38.000Z",
  "lastActivityDate": "2024-02-02T21:14:44.000Z",
  "mergeOfferDate": "2024-02-02T20:42:49.000Z",
  "mergeRequestDate": "2024-02-02T21:14:44.000Z",
  "mergeRequestUser": "EvanHahn",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "sub-encoder",
      "kind": "add",
      "files": [
        {
          "path": "types/sub-encoder/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/sub-encoder/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/sub-encoder/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/sub-encoder/sub-encoder-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/sub-encoder/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "EvanHahn"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2024-02-02T20:42:07.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "codershiba",
      "date": "2024-01-31T15:31:27.000Z",
      "abbrOid": "50db144"
    }
  ],
  "mainBotCommentID": 1918054974,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @EvanHahn — 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...)

[EvanHahn]

There are several CI failures which seem unrelated to my changes. Apologies if I did something wrong here.

[EvanHahn]

@codershiba Happy to export those types, but why? (Not saying you're wrong, just that I don't know the reason.)

[codershiba]

For user consumption. Example could be the the tests itself where you have used JsonValue type. Also doesn't seem to be a harm to export these utility types which maybe used with the sub-encoder lib

[typescript-bot]

@EvanHahn 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.

[EvanHahn]

Actually, this doesn't work because this module has only one export. Reverted.

[typescript-bot]

@codershiba Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

[typescript-bot]

@peterblazejewicz, @codershiba Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

[peterblazejewicz]

LGTM!
@EvanHahn thanks!

[typescript-bot]

@EvanHahn: Everything looks good here. I am ready to merge this PR (at eb6572e) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

[EvanHahn]

Ready to merge