@kulupu-linku/sona 0.1.10 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/README.md +18 -3
  2. package/dist/client.d.ts +1 -802
  3. package/dist/client.js +98 -4
  4. package/dist/client.js.map +1 -0
  5. package/dist/index.d.ts +1 -1159
  6. package/dist/index.js +148 -168
  7. package/dist/index.js.map +1 -0
  8. package/dist/lib/client.d.ts +201 -0
  9. package/dist/lib/index.d.ts +959 -0
  10. package/dist/lib/types.d.ts +17 -0
  11. package/dist/lib/utils.d.ts +13 -0
  12. package/dist/utils-CnA4OULt.js +2777 -0
  13. package/dist/utils-CnA4OULt.js.map +1 -0
  14. package/dist/utils.d.ts +1 -16
  15. package/dist/utils.js +7 -12
  16. package/dist/utils.js.map +1 -0
  17. package/generated/languages.json +15 -0
  18. package/generated/sandbox.json +16 -3
  19. package/generated/word.json +16 -3
  20. package/generated/words.json +16 -3
  21. package/package.json +19 -15
  22. package/LICENSE +0 -674
  23. package/dist/chunk-QCIUEY5V.js +0 -38
  24. package/dist/types.d.ts +0 -2
  25. package/dist/types.js +0 -0
  26. package/generated/etymology.json +0 -20
  27. package/generated/representations.json +0 -43
  28. package/generated/resources.json +0 -30
package/README.md CHANGED
@@ -1,4 +1,19 @@
1
- # @linku/sona
1
+ # sona API
2
2
 
3
- This is a TypeScript library providing types for the sona API, a collaborative and open dataset,
4
- built by and for the Toki Pona community.
3
+ This folder holds the code for the sona API, hosted at https://api.linku.la/.
4
+
5
+ The API is built using TypeScript, [Vite](https://vitejs.dev/), and [Hono](https://hono.dev/), using Zod schemas verified against the source data.
6
+
7
+ ## Contributing
8
+
9
+ Requirements:
10
+
11
+ - [Node.js](https://nodejs.org/) (preferably latest)
12
+ - [pnpm](https://pnpm.io/) v8
13
+
14
+ How to contribute:
15
+
16
+ - Fork the repo and make any changes you want.
17
+ - Build the schemas in with `pnpm run generate`
18
+ - Run the dev server using `pnpm run dev` and verify that your changes work.
19
+ - Create a pull request back to the main branch and request a review from a maintainer.