siteon 1.3.2 → 1.3.4

package/Readme.md

@@ -1,112 +1,312 @@
-# SiteOn
+# Siteon Registry CLI
 
-A powerful code generation tool that automatically generates content fetching and form submission code for your workspace.
-
-## What is SiteOn?
-
-SiteOn streamlines your development workflow by analyzing your workspace configuration and generating ready-to-use code for:
-
-- **Content Fetching**: Automatically generate API calls and data fetching logic based on your workspace structure
-- **Form Submissions**: Create public form submission handlers with proper validation and error handling
-
-No more boilerplate code – SiteOn does the heavy lifting for you.
+A CLI tool to generate type-safe API clients for Siteon workspaces. Similar to shadcn/ui, this tool generates code directly into your project that you own and can customize.
 
 ## Installation
 
-### Quick Start with npx (Recommended)
+Since this is a private GitHub repository, you can run the CLI directly using:
 
-Run SiteOn without installing:
+1. Using npx
 
 ```bash
-npx siteon
+npx https://github.com/compitcomds/siteon-registry init
+# or
+npx github:compitcomds/siteon-registry init
 ```
 
-```bash
-pnpm dlx siteon
-```
+2. Using pnpm dlx
 
 ```bash
-bunx siteon
+pnpm dlx https://github.com/compitcomds/siteon-registry init
+# or
+pnpm dlx github:compitcomds/siteon-registry#main init
 ```
 
-### Global Installation
+## Usage
+
+### Initialize in your project
 
-Install globally for repeated use:
+Run the `init` command in your project root:
 
 ```bash
-npm install -g siteon
+siteon init
 ```
 
-Then run:
+You'll be prompted for:
 
-```bash
-siteon
+1. **Workspace ID** - Your Siteon workspace ID
+2. **Email & Password** - Your Siteon credentials (ADMIN access required)
+3. **Output Directory** - Where to place generated files (default: `src` if exists, otherwise root)
+4. **Project Type**:
+   - `Static` - Vanilla HTML/CSS/JS (ES modules)
+   - `Framework` - React, Next.js, Vue, Vite, etc.
+5. **Framework** (if framework selected) - Next.js, Vite, React, Vue, or Other
+6. **Language** (if framework) - TypeScript or JavaScript
+7. **HTTP Client** (if framework) - Fetch (native) or Axios
+8. **Config Storage** (if framework) - Environment variables (.env) or config file
+9. **React Cache** (if React-based) - Use React's `cache` function for caching (React 18+)
+10. **Form Selection** - All forms or select specific ones
+
+## Generated Structure
+
+```
+your-project/
+├── siteon.config.json          # CLI configuration
+├── .env                        # (optional) Environment variables
+└── src/
+    └── siteon/
+        ├── index.ts            # Main entry point
+        ├── config.ts           # Configuration (workspace ID, base URL)
+        ├── types.ts            # Type definitions
+        ├── http-client.ts      # HTTP client (axios or fetch)
+        ├── get-metadata.ts     # Base fetch function
+        ├── get-media.ts        # Media helper functions
+        └── forms/
+            ├── index.ts        # Re-exports all forms
+            ├── portfolio.ts    # Generated form file
+            └── blog-post.ts    # Generated form file
 ```
 
-## Usage
+## Generated Code Example
+
+For each form, the CLI generates strongly typed fetchers:
+
+```typescript
+// TypeScript example for a "Portfolio" form
+import { getMetaData } from "../get-metadata";
+import type { ResponseType, ResponseDataType, QueryParams } from "../types";
+import { cache } from "react"; // if using React cache
+
+export type PortfolioDataType = {
+  slug: string;
+  title: string;
+  featured_image: string[];
+  category: "Web Design" | "Graphic Design" | "Video Production";
+};
+
+export type PortfolioResolvedDataType = {
+  slug: string;
+  title: string;
+  featured_image: string[];
+  category: ResolvedRelation; // When resolveRelations is true
+};
+
+export type PortfolioQueryOptions = Omit<QueryParams, "resolveRelations"> & {
+  resolveRelations?: boolean;
+};
+
+// Fetch all items with full query options
+export async function getAllPortfolio(
+  options?: PortfolioQueryOptions & { resolveRelations?: false },
+): Promise<ResponseType<PortfolioDataType>>;
+export async function getAllPortfolio(
+  options: PortfolioQueryOptions & { resolveRelations: true },
+): Promise<ResponseType<PortfolioResolvedDataType>>;
+export async function getAllPortfolio(options: PortfolioQueryOptions = {}) {
+  // Implementation
+}
+
+// Fetch by slug (with optional React cache)
+export const getPortfolioBySlug = cache(
+  async (slug: string, options: { resolveRelations?: boolean } = {}) => {
+    // Implementation
+  },
+);
+```
+
+## Usage in Your App
+
+### Basic Usage
 
-1. Navigate to your project directory
-2. Run the command:
-   ```bash
-   npx siteon
-   ```
-3. SiteOn will:
-   - Analyze your workspace configuration
-   - Detect your content structure
-   - Generate appropriate code files
-   - Set up form submission endpoints
+```typescript
+import { getAllPortfolio, getPortfolioBySlug } from "@/siteon";
 
-## Features
+// Fetch all portfolio items
+const { data, pagination } = await getAllPortfolio();
 
-✨ **Automatic Code Generation** - Generates production-ready code based on your workspace
+// Fetch with filters and ordering
+const { data } = await getAllPortfolio({
+  filters: {
+    "data.category": { equals: "Web Design" },
+  },
+  orderBy: [{ field: "order", direction: "asc" }],
+  page: 1,
+  pageSize: 10,
+});
 
-🔍 **Workspace Detection** - Intelligently analyzes your project structure
+// Fetch with resolved relations
+const { data } = await getAllPortfolio({ resolveRelations: true });
 
-📝 **Form Handlers** - Creates public form submission code with validation
+// Fetch single item by slug
+const portfolio = await getPortfolioBySlug("my-project");
 
-🚀 **Zero Configuration** - Works out of the box with sensible defaults
+// Fetch single item by slug with resolved relations
+const portfolio = await getPortfolioBySlug("my-project", {
+  resolveRelations: true,
+});
+```
 
-⚡ **Fast & Lightweight** - Minimal dependencies, maximum efficiency
+### Filtering by Relation
+
+To filter by a relation field (e.g., get all blogs in a specific category):
+
+```typescript
+import { getAllBlog } from "@/siteon";
+
+// Filter by category relation ID
+const { data } = await getAllBlog({
+  filters: {
+    "data.category": { equals: "categoryId123" },
+  },
+});
+
+// Multiple conditions
+const { data } = await getAllBlog({
+  filters: {
+    AND: {
+      "data.category": { equals: "categoryId123" },
+      "data.published": { equals: true },
+    },
+  },
+});
+```
 
-## Generated Code
+### With Media Resolution
 
-SiteOn generates:
+```typescript
+import { getAllPortfolio, getMediaByIds } from "@/siteon";
 
-- Content fetching functions and API clients
-- Form submission handlers with validation
-- Type definitions (if applicable)
-- Configuration files for your workspace
+const { data } = await getAllPortfolio();
 
-## Examples
+// Resolve media IDs to URLs
+for (const item of data) {
+  const images = await getMediaByIds(item.data.featured_image);
+  console.log(images[0]?.url);
+}
+```
 
-### Basic Usage
+### Filter Operators
+
+Available filter operators:
+
+- `equals`, `not`
+- `gt`, `gte`, `lt`, `lte`
+- `contains`, `startsWith`, `endsWith`
+- `in`, `notIn`
+- `has`, `hasEvery`, `hasSome`
+- `isNull`
+
+```typescript
+// Complex filtering
+const { data } = await getAllPortfolio({
+  filters: {
+    AND: {
+      "data.category": { equals: "Web Design" },
+      "data.title": { contains: "Modern" },
+    },
+    OR: [{ "data.featured": { equals: true } }, { "data.order": { lt: 5 } }],
+  },
+});
+```
 
-```bash
-# In your project directory
-npx siteon
+## Static Sites (Vanilla JS)
+
+For static sites, use ES modules:
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>My Site</title>
+  </head>
+  <body>
+    <div id="app"></div>
+
+    <script type="module">
+      import { getAllPortfolio } from "./siteon/index.js";
+
+      const { data } = await getAllPortfolio();
+
+      const app = document.getElementById("app");
+      app.innerHTML = data
+        .map(
+          (item) => `
+      <div class="portfolio-item">
+        <h2>${item.data.title}</h2>
+      </div>
+    `,
+        )
+        .join("");
+    </script>
+  </body>
+</html>
+```
+
+## Configuration
+
+The `siteon.config.json` file stores your configuration:
+
+```json
+{
+  "workspaceId": "your-workspace-id",
+  "baseUrl": "https://api.compitcom.in",
+  "outputDir": "src",
+  "projectType": "framework",
+  "language": "typescript",
+  "httpClient": "fetch",
+  "framework": "next",
+  "envVarLocation": "env",
+  "forms": ["portfolio", "blog-post"],
+  "createdAt": "2024-01-01T00:00:00.000Z",
+  "updatedAt": "2024-01-01T00:00:00.000Z"
+}
 ```
 
-## How It Works
+## Environment Variables
 
-1. **Workspace Analysis**: SiteOn scans your workspace for content types, schemas, and configurations
-2. **Code Generation**: Based on the analysis, it generates optimized code tailored to your needs
-3. **File Output**: Generated code is saved to your project with clear organization
+If you chose to use environment variables, they are stored in `.env`:
 
-## License
+```env
+# Next.js
+NEXT_PUBLIC_SITEON_BASE_URL=https://api.compitcom.in
+NEXT_PUBLIC_SITEON_WORKSPACE_ID=your-workspace-id
+
+# Vite/Vue
+VITE_SITEON_BASE_URL=https://api.compitcom.in
+VITE_SITEON_WORKSPACE_ID=your-workspace-id
+
+# React (CRA)
+REACT_APP_SITEON_BASE_URL=https://api.compitcom.in
+REACT_APP_SITEON_WORKSPACE_ID=your-workspace-id
+```
 
-MIT
+## Field Type Mapping
 
-## Support
+| Form Field Type                      | TypeScript Type                             |
+| ------------------------------------ | ------------------------------------------- |
+| text, email, textarea, url, richtext | `string`                                    |
+| date, time, datetime                 | `string`                                    |
+| int, float                           | `number`                                    |
+| select, radio                        | Union of options                            |
+| checkbox                             | Array of options                            |
+| media, image, video                  | `string[]`                                  |
+| relation (single)                    | `string \| null` (ID) or `ResolvedRelation` |
+| relation (array)                     | `string[]` (IDs) or `ResolvedRelation[]`    |
+| repeator                             | `{ value: T }[]`                            |
 
-If you encounter any issues or have questions:
+## Development
 
-- Open an issue on [GitHub](https://github.com/yourusername/siteon)
-- Check the [documentation](https://github.com/yourusername/siteon#readme)
+```bash
+# Install dependencies
+bun install
 
-## Author
+# Build
+bun run build
 
-Created with ❤️ by the SiteOn team
+# Watch mode
+bun run dev
+```
 
----
+## License
 
-**Happy Coding!** 🎉
+Private - Compitcom

package/bun.lock

@@ -0,0 +1,80 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "siteon",
+      "dependencies": {
+        "chalk": "^5.3.0",
+        "commander": "^12.1.0",
+        "enquirer": "^2.4.1",
+        "ora": "^8.0.1",
+      },
+      "devDependencies": {
+        "@types/bun": "^1.1.0",
+        "@types/node": "^20.11.0",
+        "typescript": "^5.3.3",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.3.6", "", { "dependencies": { "bun-types": "1.3.6" } }, "sha512-uWCv6FO/8LcpREhenN1d1b6fcspAB+cefwD7uti8C8VffIv0Um08TKMn98FynpTiU38+y2dUO55T11NgDt8VAA=="],
+
+    "@types/node": ["@types/node@20.19.30", "", { "dependencies": { "undici-types": "~6.21.0" } }, "sha512-WJtwWJu7UdlvzEAUm484QNg5eAoq5QR08KDNx7g45Usrs2NtOPiX8ugDqmKdXkyL03rBqU5dYNYVQetEpBHq2g=="],
+
+    "ansi-colors": ["ansi-colors@4.1.3", "", {}, "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw=="],
+
+    "ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="],
+
+    "bun-types": ["bun-types@1.3.6", "", { "dependencies": { "@types/node": "*" } }, "sha512-OlFwHcnNV99r//9v5IIOgQ9Uk37gZqrNMCcqEaExdkVq3Avwqok1bJFmvGMCkCE0FqzdY8VMOZpfpR3lwI+CsQ=="],
+
+    "chalk": ["chalk@5.6.2", "", {}, "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA=="],
+
+    "cli-cursor": ["cli-cursor@5.0.0", "", { "dependencies": { "restore-cursor": "^5.0.0" } }, "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw=="],
+
+    "cli-spinners": ["cli-spinners@2.9.2", "", {}, "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg=="],
+
+    "commander": ["commander@12.1.0", "", {}, "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA=="],
+
+    "emoji-regex": ["emoji-regex@10.6.0", "", {}, "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A=="],
+
+    "enquirer": ["enquirer@2.4.1", "", { "dependencies": { "ansi-colors": "^4.1.1", "strip-ansi": "^6.0.1" } }, "sha512-rRqJg/6gd538VHvR3PSrdRBb/1Vy2YfzHqzvbhGIQpDRKIa4FgV/54b5Q1xYSxOOwKvjXweS26E0Q+nAMwp2pQ=="],
+
+    "get-east-asian-width": ["get-east-asian-width@1.4.0", "", {}, "sha512-QZjmEOC+IT1uk6Rx0sX22V6uHWVwbdbxf1faPqJ1QhLdGgsRGCZoyaQBm/piRdJy/D2um6hM1UP7ZEeQ4EkP+Q=="],
+
+    "is-interactive": ["is-interactive@2.0.0", "", {}, "sha512-qP1vozQRI+BMOPcjFzrjXuQvdak2pHNUMZoeG2eRbiSqyvbEf/wQtEOTOX1guk6E3t36RkaqiSt8A/6YElNxLQ=="],
+
+    "is-unicode-supported": ["is-unicode-supported@2.1.0", "", {}, "sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ=="],
+
+    "log-symbols": ["log-symbols@6.0.0", "", { "dependencies": { "chalk": "^5.3.0", "is-unicode-supported": "^1.3.0" } }, "sha512-i24m8rpwhmPIS4zscNzK6MSEhk0DUWa/8iYQWxhffV8jkI4Phvs3F+quL5xvS0gdQR0FyTCMMH33Y78dDTzzIw=="],
+
+    "mimic-function": ["mimic-function@5.0.1", "", {}, "sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA=="],
+
+    "onetime": ["onetime@7.0.0", "", { "dependencies": { "mimic-function": "^5.0.0" } }, "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ=="],
+
+    "ora": ["ora@8.2.0", "", { "dependencies": { "chalk": "^5.3.0", "cli-cursor": "^5.0.0", "cli-spinners": "^2.9.2", "is-interactive": "^2.0.0", "is-unicode-supported": "^2.0.0", "log-symbols": "^6.0.0", "stdin-discarder": "^0.2.2", "string-width": "^7.2.0", "strip-ansi": "^7.1.0" } }, "sha512-weP+BZ8MVNnlCm8c0Qdc1WSWq4Qn7I+9CJGm7Qali6g44e/PUzbjNqJX5NJ9ljlNMosfJvg1fKEGILklK9cwnw=="],
+
+    "restore-cursor": ["restore-cursor@5.1.0", "", { "dependencies": { "onetime": "^7.0.0", "signal-exit": "^4.1.0" } }, "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA=="],
+
+    "signal-exit": ["signal-exit@4.1.0", "", {}, "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw=="],
+
+    "stdin-discarder": ["stdin-discarder@0.2.2", "", {}, "sha512-UhDfHmA92YAlNnCfhmq0VeNL5bDbiZGg7sZ2IvPsXubGkiNa9EC+tUTsjBRsYUAz87btI6/1wf4XoVvQ3uRnmQ=="],
+
+    "string-width": ["string-width@7.2.0", "", { "dependencies": { "emoji-regex": "^10.3.0", "get-east-asian-width": "^1.0.0", "strip-ansi": "^7.1.0" } }, "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ=="],
+
+    "strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="],
+
+    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
+
+    "undici-types": ["undici-types@6.21.0", "", {}, "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ=="],
+
+    "log-symbols/is-unicode-supported": ["is-unicode-supported@1.3.0", "", {}, "sha512-43r2mRvz+8JRIKnWJ+3j8JtjRKZ6GmjzfaE/qiBJnikNnYv/6bagRJ1kUhNk8R5EX/GkobD+r+sfxCPJsiKBLQ=="],
+
+    "ora/strip-ansi": ["strip-ansi@7.1.2", "", { "dependencies": { "ansi-regex": "^6.0.1" } }, "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA=="],
+
+    "string-width/strip-ansi": ["strip-ansi@7.1.2", "", { "dependencies": { "ansi-regex": "^6.0.1" } }, "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA=="],
+
+    "ora/strip-ansi/ansi-regex": ["ansi-regex@6.2.2", "", {}, "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg=="],
+
+    "string-width/strip-ansi/ansi-regex": ["ansi-regex@6.2.2", "", {}, "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg=="],
+  }
+}

package/dist/Readme.md

@@ -0,0 +1,112 @@
+# SiteOn
+
+A powerful code generation tool that automatically generates content fetching and form submission code for your workspace.
+
+## What is SiteOn?
+
+SiteOn streamlines your development workflow by analyzing your workspace configuration and generating ready-to-use code for:
+
+- **Content Fetching**: Automatically generate API calls and data fetching logic based on your workspace structure
+- **Form Submissions**: Create public form submission handlers with proper validation and error handling
+
+No more boilerplate code – SiteOn does the heavy lifting for you.
+
+## Installation
+
+### Quick Start with npx (Recommended)
+
+Run SiteOn without installing:
+
+```bash
+npx siteon
+```
+
+```bash
+pnpm dlx siteon
+```
+
+```bash
+bunx siteon
+```
+
+### Global Installation
+
+Install globally for repeated use:
+
+```bash
+npm install -g siteon
+```
+
+Then run:
+
+```bash
+siteon
+```
+
+## Usage
+
+1. Navigate to your project directory
+2. Run the command:
+   ```bash
+   npx siteon
+   ```
+3. SiteOn will:
+   - Analyze your workspace configuration
+   - Detect your content structure
+   - Generate appropriate code files
+   - Set up form submission endpoints
+
+## Features
+
+✨ **Automatic Code Generation** - Generates production-ready code based on your workspace
+
+🔍 **Workspace Detection** - Intelligently analyzes your project structure
+
+📝 **Form Handlers** - Creates public form submission code with validation
+
+🚀 **Zero Configuration** - Works out of the box with sensible defaults
+
+⚡ **Fast & Lightweight** - Minimal dependencies, maximum efficiency
+
+## Generated Code
+
+SiteOn generates:
+
+- Content fetching functions and API clients
+- Form submission handlers with validation
+- Type definitions (if applicable)
+- Configuration files for your workspace
+
+## Examples
+
+### Basic Usage
+
+```bash
+# In your project directory
+npx siteon
+```
+
+## How It Works
+
+1. **Workspace Analysis**: SiteOn scans your workspace for content types, schemas, and configurations
+2. **Code Generation**: Based on the analysis, it generates optimized code tailored to your needs
+3. **File Output**: Generated code is saved to your project with clear organization
+
+## License
+
+MIT
+
+## Support
+
+If you encounter any issues or have questions:
+
+- Open an issue on [GitHub](https://github.com/yourusername/siteon)
+- Check the [documentation](https://github.com/yourusername/siteon#readme)
+
+## Author
+
+Created with ❤️ by the SiteOn team
+
+---
+
+**Happy Coding!** 🎉