Skip to content

twilic/hono

Repository files navigation

@twilic/hono

Hono helpers and middleware for Twilic binary request and response bodies.

Install

pnpm add @twilic/hono hono @twilic/core

Usage

import { Hono } from "hono";
import { twilicParser, twilicResponse } from "@twilic/hono";

const app = new Hono();

app.post("/users", twilicParser(), async (c) => {
  const input = c.var.twilicBody;
  return twilicResponse(c, { ok: true, received: input });
});

API

  • TWILIC_CONTENT_TYPE
  • parseTwilic(c)
  • twilicResponse(c, value, init?)
  • twilicParser(options?)
  • createTwilicHono(codec?)

Changelog

See docs/CHANGELOG.md.

Publish to npm

The package ships build artifacts from dist/.

Local dry run:

pnpm build
pnpm pack

GitHub Actions publish uses npm trusted publishing (OIDC)—no long-lived NPM_TOKEN secret.

One-time setup on npmjs.com: open the package → SettingsTrusted PublisherGitHub Actions, then set Organization or user twilic, Repository hono, and Workflow filename publish-npm.yml (exact name, including .yml). See also GitHub Actions OIDC.

Release steps:

  1. Update docs/CHANGELOG.md and bump version in package.json.
  2. Create and push matching tag v<version>.

Example:

git tag v0.1.0
git push origin v0.1.0

The workflow .github/workflows/publish-npm.yml verifies tag/version match, runs tests, and then runs npm publish (OIDC authentication via id-token: write).

Contributing

See docs/CONTRIBUTING.md.

License

This project is licensed under the MIT License — see the LICENSE file for details.

Packages

 
 
 

Contributors