@42-lyon/42api-zod-schemas 1.0.0 → 1.0.2

package/README.md

@@ -12,93 +12,60 @@ This package centralises Zod schemas for common 42 API resources so downstream p
 
 
 ```bash
-# Navigate to your project
-cd <my-awsome-project>
-
-# clone this repository:
-git clone git@github.com:42-Lyon/42API-zod-schemas.git
-# or add it as a submodule
-git submodule add git@github.com:42-Lyon/42API-zod-schemas.git
-
-# Install the module as a local package
-npm install ./42API-zod-schemas
+npm install @42-lyon/42api-zod-schemas
+# or
+pnpm add @42-lyon/42api-zod-schemas
+# or
+yarn add @42-lyon/42api-zod-schemas
 ```
 
-This package is distributed as an ESM package and ships TypeScript types in `dist`.
-
-## Quick usage
+The package is ESM-only and ships bundled `.d.ts` definitions.
 
-Import a schema and parse/validate API responses. The package exports individual resource schemas from `src/resources`.
-
-Example (ESM / TypeScript):
+## Quick start
 
 ```ts
-import { intraUserSchema } from '42api-zod-schemas';
+import { intraUserSchema, type IntraUser } from '@42-lyon/42api-zod-schemas';
 
-// Validate a response body
 const response = await fetch('https://api.intra.42.fr/v2/users/cameo');
-const data = await response.json();
+const payload = await response.json();
 
-// Throws if validation fails
-const user = intraUserSchema.parse(data);
+// Throws on invalid payload
+const user: IntraUser = intraUserSchema.parse(payload);
 
-// Or use safe parsing
-const result = intraUserSchema.safeParse(data);
+// Or keep control over the error path
+const result = intraUserSchema.safeParse(payload);
 if (!result.success) {
-	console.error('Invalid user response', result.error);
-} else {
-	// Typed as the inferred type below
-	const typedUser = result.data;
-}
-
-```
-
-For each schema, a related type is also available
-```ts
-import { intraUserSchema, type IntraUser } from '42api-zod-schemas';
-
-const user: IntraUser = {
-	...
+	console.error(result.error.format());
 }
-
 ```
 
-## Exported schemas
-
-The package re-exports schemas from `src/resources`. As of this release it includes (but may not be limited to):
-
-- `achievement`
-- `bloc`
-- `campus`
-- `close`
-- `events`
-- `pool`
-- `project`
-- `quest`
-- `user`
-
-## Build
+### Tree-shakeable imports
 
-This package is authored in TypeScript. Build with:
+Schemas are exported individually so you can import only what you need:
 
-```bash
-npm run build
+```ts
+import { projectSchema } from '@42-lyon/42api-zod-schemas/project';
 ```
 
-That runs `tsc` and emits `dist` (see `package.json` `main`/`types` fields).
-
-## Contributing
-
-Contributions welcome. Suggested workflow:
+## Available schemas
 
-1. Fork the repo and create a feature branch.
-2. Add or update schemas under `src/resources`.
-3. Run `npm run build` to ensure types build correctly.
-4. Open a PR describing your changes.
+- achievements (`achievements` and `achievements_users`)
+- bloc
+- campus
+- close
+- events
+- experiences
+- pool
+- project
+- quest
+- team
+- transactions
+- user
 
-When adding schemas, follow the existing pattern: export a Zod schema and an inferred TypeScript type.
+Each schema is exported alongside its inferred type (e.g. `intraUserSchema` and `IntraUser`).
 
 ## Links
 
+- npm: https://www.npmjs.com/package/@42-lyon/42api-zod-schemas
 - Repository: https://github.com/42-Lyon/42API-zod-schemas
 - Issues: https://github.com/42-Lyon/42API-zod-schemas/issues

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@42-lyon/42api-zod-schemas",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Zod schemas and TypeScript types for validating and typing 42API response bodies",
   "homepage": "https://github.com/42-Lyon/42API-zod-schemas#readme",
   "bugs": {
@@ -39,4 +39,4 @@
     "dist",
     "README.md"
   ]
-}
+}