https://github.com/txstate-etc/fastify-txstate-shared

Types and any other code shared by both fastify APIs and the UIs they communicate with.
https://github.com/txstate-etc/fastify-txstate-shared

Last synced: about 1 month ago
JSON representation

Types and any other code shared by both fastify APIs and the UIs they communicate with.

• Host: GitHub
• URL: https://github.com/txstate-etc/fastify-txstate-shared
• Owner: txstate-etc
• License: mit
• Created: 2024-03-23T23:14:00.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-01T19:30:21.000Z (6 months ago)
• Last Synced: 2024-11-08T14:48:23.641Z (3 months ago)
• Language: TypeScript
• Size: 74.2 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fastify-txstate-shared

Types and any other code shared by both fastify APIs and the UIs they communicate with.

## InteractionEvent

A fastify-txstate API that opts into analytics will have a POST '/analytics' route where

the body accepts an InteractionEvent, appends more information to it, and sends it along

to the analytics database. This library provides both a json-schema and a typescript type

defining this event.

Pay close attention to the comments on each property, so you'll know how to fill it in.

If we all share an understanding of what the analytics data means, it will be cleaner when

we go to run our reports.

## Building this library

`npm run build` takes care of everything.

If you add a new json-schema that needs typescript types automatically generated, you

need to add a line to the `main()` function in `src/build.ts` executing `convert` on

your schema and giving its type a name.