strapi2front 0.4.2 → 0.5.0

package/README.md

@@ -1,45 +1,33 @@
-<div align="center">
-  <!-- <a href="https://strapi2front.dev">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://strapi2front.dev/logo-dark.svg">
-      <img alt="strapi2front logo" src="https://strapi2front.dev/logo-light.svg" height="128">
-    </picture>
-  </a> -->
-  <h1>strapi2front</h1>
+# strapi2front
 
 <a href="https://elevenestudio.com"><img alt="Made by Eleven Estudio" src="https://img.shields.io/badge/MADE%20BY%20Eleven%20Estudio-000000.svg?style=for-the-badge&labelColor=000"></a>
 <a href="https://www.npmjs.com/package/strapi2front"><img alt="NPM version" src="https://img.shields.io/npm/v/strapi2front.svg?style=for-the-badge&labelColor=000000"></a>
 <a href="https://github.com/Eleven-Estudio/strapi2front/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/npm/l/strapi2front.svg?style=for-the-badge&labelColor=000000"></a>
 
-</div>
 
-## The Strapi TypeScript Generator
+Generate TypeScript types, services, Zod schemas, and Astro Actions from your Strapi schema.
 
-`strapi2front` is a CLI tool that generates TypeScript types, services, and Astro Actions from your Strapi CMS schema. One command syncs everything, keeping your frontend perfectly typed.
+**[View Documentation →](https://strapi2front.dev/docs)**
 
-## Getting Started
+---
 
-Initialize strapi2front in your project:
+## Quick Start
 
 ```bash
 npx strapi2front@latest init
-```
-
-Then sync your types whenever your Strapi schema changes:
-
-```bash
 npx strapi2front sync
 ```
 
 ## Features
 
-⊹ **Type Generation** - Auto-generate TypeScript interfaces from your Strapi schema\
-⊹ **Service Generation** - Create typed service functions for all content types\
-⊹ **Astro Actions** - Generate type-safe Astro Actions for client/server data fetching\
-⊹ **JSDoc Support** - Generate JavaScript files with JSDoc annotations (no TypeScript required)\
-⊹ **Smart Detection** - Automatically detects framework, TypeScript, and package manager\
-⊹ **Strapi v4 & v5** - Full support for both Strapi versions\
-⊹ **By-Feature Structure** - Organize generated code by feature (screaming architecture)
+- **Type Generation** — TypeScript interfaces from your Strapi schema
+- **Service Generation** — Typed CRUD functions for all content types
+- **Zod Schemas** — Validation schemas for forms
+- **Astro Actions** — Type-safe server actions
+- **File Upload** — Upload helpers for Astro and browser
+- **JSDoc Support** — JavaScript files with JSDoc annotations (no TypeScript required)
+- **Strapi v4 & v5** — Full support for both versions
+- **By-Feature Structure** — Organize generated code by feature (screaming architecture)
 
 ## Generated Output
 
@@ -48,140 +36,50 @@ src/strapi/
 ├── collections/
 │   └── article/
 │       ├── types.ts      # TypeScript interfaces
+│       ├── schemas.ts    # Zod validation schemas
 │       ├── service.ts    # Data fetching functions
 │       └── actions.ts    # Astro Actions
 ├── singles/
 │   └── homepage/
 │       ├── types.ts
+│       ├── schemas.ts
 │       └── service.ts
 ├── components/
 │   └── seo.ts
 └── shared/
     ├── utils.ts          # Utility types
     ├── client.ts         # Strapi client
-    └── locales.ts        # i18n support
+    ├── locales.ts        # i18n support
+    └── upload-action.ts  # File upload helpers
 ```
 
-## Requirements
-
-- Node.js 18+
-- Strapi v4 or v5
-- Astro 4+ (for Astro Actions, more frameworks coming soon)
-
----
-
-## Quick Setup
-
-### 1. Create a Strapi API Token
-
-You need an API token with **read-only access** to the Content-Type Builder:
-
-1. Go to **Strapi Admin** → **Settings** → **API Tokens**
-2. Create a new **Custom** token
-3. Enable these permissions:
-   - **Content-type-builder**: `getComponents`, `getComponent`, `getContentTypes`, `getContentType`
-   - **I18n** (optional): `listLocales`
-4. Add the token to your `.env`:
-
-```env
-STRAPI_TOKEN=your-token-here
-```
-
-> This token only reads schema structure, not your content data.
-
-### 2. Initialize
-
-```bash
-npx strapi2front@latest init
-```
-
-### 3. Sync Types
-
-```bash
-npx strapi2front sync
-```
-
----
-
-## Configuration
-
-After init, a `strapi.config.ts` is created:
-
-```typescript
-import { defineConfig } from "strapi2front";
-
-export default defineConfig({
-  url: "http://localhost:1337",
-  strapiVersion: "v5",
-  apiPrefix: "/api",
-  output: {
-    path: "src/strapi",
-  },
-  features: {
-    types: true,
-    services: true,
-    actions: true,
-  },
-});
-```
-
-### Key Options
-
-| Option | Description |
-|--------|-------------|
-| `url` | Your Strapi instance URL |
-| `strapiVersion` | `"v4"` or `"v5"` |
-| `apiPrefix` | API prefix (default: `/api`) |
-| `outputFormat` | `"typescript"` or `"jsdoc"` |
-| `moduleType` | `"esm"` or `"commonjs"` (auto-detected) |
-| `output.path` | Where to generate files |
-| `output.structure` | `"by-feature"` or `"by-layer"` |
-
-### Environment Variables
-
-```env
-STRAPI_URL=http://localhost:1337
-STRAPI_TOKEN=your-api-token
-STRAPI_API_PREFIX=/api
-```
-
----
-
 ## Framework Support
 
-| Framework | Types | Services | Actions |
-|-----------|-------|----------|---------|
-| Astro 4+  | ✅    | ✅       | ✅      |
-| Next.js   | ✅    | ✅       | 🔜 Soon |
-| Nuxt      | ✅    | ✅       | 🔜 Soon |
-| Other     | ✅    | ✅       | ❌      |
 
----
-
-## Full Documentation
+| Framework      | Types | Services | Schemas | Actions |
+| -------------- | ----- | -------- | ------- | ------- |
+| Astro 4+       | ✅     | ✅        | ✅       | ✅       |
+| Next.js        | ✅     | ✅        | ✅       | 🔜      |
+| Nuxt           | ✅     | ✅        | ✅       | 🔜      |
+| SvelteKit      | ✅     | ✅        | ✅       | 🔜      |
+| TanStack Start | ✅     | ✅        | ✅       | 🔜      |
 
-For complete documentation including troubleshooting, advanced configuration, and examples, see the [main README](https://github.com/eleven-estudio/strapi2front#readme).
 
-## Contributing
+> Types, Services, and Schemas work with any framework. Actions are framework-specific and more are coming soon.
 
-We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING.md) for details.
+## Requirements
 
-## Security
+- Node.js 18+
+- Strapi v4 or v5
 
-If you believe you have found a security vulnerability, we encourage you to let us know right away.
+## Contributing
 
-Please report any issues to [hello@elevenestudio.com](mailto:hello@elevenestudio.com).
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
 
 ## License
 
-MIT - see [LICENSE](../../LICENSE) for details.
-
-## Disclaimer
-
-This is a community project and is not affiliated with, endorsed by, or officially connected to [Strapi](https://strapi.io). The name "Strapi" is used solely to indicate compatibility with the Strapi CMS.
+MIT © [Eleven Estudio](https://elevenestudio.com)
 
 ---
 
-<div align="center">
-  Made with ❤️ by <a href="https://elevenestudio.com">Eleven Estudio</a>
-</div>
+Made with ❤️ by [Eleven Estudio](https://elevenestudio.com)