Skip to content

Internal packages

Jump to bottom
Shu-Wei Hsu edited this page Jan 6, 2025 · 3 revisions

This page cover the internal packages under /libs/

recnet-api-model

recnet-api-model is basically the protocol of how recnet and recnet-api communicate. It defines

  1. The APIs request body, query parameters, and the response type for all available API endpoints in recnet-api.
  2. The type of common objects in recnet such as "user", "rec", and "article".

This package use zod to define the types and schemas. This is always the first place to update if you want to create a new recnet-api API.

recnet-date-fns

The "cutoff" and "time" are the core concept of RecNet. To ensure consistency across recnet and recnet-api, we created this package to unify the methods to get next cutoff, latest cutoff, and calculating time.

recnet-jwt

Just like what we discuss in Authentication Wiki, we have different JWTs such as "Firebase JWT" and "RecNet JWT". This package define these two types of JWTs and is mainly used by recnet-api to verify/validate JWTs at backend.

recnet-release-action

See GitHub Actions Wiki.

Clone this wiki locally