@eide/uniformgen 0.1.0

package/README.md

@@ -0,0 +1,356 @@
+# @eide/uniformgen
+
+Type-safe code generator for Foir CMS. Generates TypeScript types, GraphQL operations, and React hooks from your project schemas.
+
+## Features
+
+- **Type Generation** - TypeScript interfaces for all your entity models
+- **GraphQL Documents** - Queries, mutations, and fragments for your schemas
+- **React Hooks** - Data fetching hooks with full type safety
+- **Schema Sync** - Pull schemas from your Foir project
+- **Schema Push** - Push local schema definitions to your project
+- **Content Seeding** - Seed content from local files
+
+## Installation
+
+```bash
+# Install globally
+npm install -g @eide/uniformgen
+
+# Or use with npx (no installation required)
+npx @eide/uniformgen
+
+# Or add as a dev dependency
+npm install -D @eide/uniformgen
+```
+
+## Authentication
+
+UniformGen uses interactive login to authenticate with your Foir project:
+
+```bash
+# Login to your Foir account
+uniformgen login
+
+# Check current authentication status
+uniformgen whoami
+
+# Logout
+uniformgen logout
+```
+
+After logging in, select your project:
+
+```bash
+uniformgen setup
+```
+
+This stores your credentials securely and associates the current directory with your Foir project.
+
+## Quick Start
+
+1. **Login and setup**:
+
+```bash
+uniformgen login
+uniformgen setup
+```
+
+2. **Sync schemas from your project**:
+
+```bash
+uniformgen sync
+```
+
+3. **Use the generated types in your app**:
+
+```typescript
+import type { Page, HeroBanner } from './foir/types';
+import { useGetPage } from './foir/hooks';
+
+function PageComponent({ slug }: { slug: string }) {
+  const { data, loading } = useGetPage({ slug });
+
+  if (loading) return <div>Loading...</div>;
+
+  const page = data?.resolveRoute?.content as Page;
+  return <h1>{page.title}</h1>;
+}
+```
+
+## Commands
+
+### `uniformgen login`
+
+Authenticate with your Foir account via browser-based OAuth flow.
+
+```bash
+uniformgen login
+```
+
+### `uniformgen setup`
+
+Select a project to work with and configure the current directory.
+
+```bash
+uniformgen setup
+```
+
+### `uniformgen sync`
+
+Sync schemas from your Foir project and generate types, documents, and hooks.
+
+```bash
+# Sync to default location (./foir)
+uniformgen sync
+
+# Sync to custom directory
+uniformgen sync --output ./src/generated/foir
+
+# Sync only schemas (no code generation)
+uniformgen sync --schemas ./schemas
+```
+
+**Options:**
+- `--output, -o <dir>` - Output directory for generated code (default: `./foir`)
+- `--schemas <dir>` - Output directory for schema files
+- `--skip-types` - Skip TypeScript type generation
+- `--skip-documents` - Skip GraphQL document generation
+- `--skip-hooks` - Skip React hook generation
+
+### `uniformgen push`
+
+Push local schema definitions to your Foir project.
+
+```bash
+# Push schemas from default location
+uniformgen push
+
+# Push from custom directory
+uniformgen push --schemas ./schemas
+```
+
+**Options:**
+- `--schemas <dir>` - Directory containing schema files (default: `./schemas`)
+- `--dry-run` - Preview changes without applying them
+
+### `uniformgen seed`
+
+Seed content from local files to your Foir project.
+
+```bash
+# Seed content
+uniformgen seed --seed ./seed
+
+# Seed and publish
+uniformgen seed --seed ./seed --publish
+
+# Preview without making changes
+uniformgen seed --seed ./seed --dry-run
+```
+
+**Options:**
+- `--seed <dir>` - Directory containing seed files (required)
+- `--publish` - Publish seeded content after creation
+- `--dry-run` - Preview changes without applying them
+
+### `uniformgen scaffold`
+
+Generate component scaffolds for your entity models.
+
+```bash
+uniformgen scaffold --components ./app/components/foir
+```
+
+**Options:**
+- `--components <dir>` - Output directory for component files
+
+### `uniformgen whoami`
+
+Display current authentication status and project info.
+
+```bash
+uniformgen whoami
+```
+
+### `uniformgen logout`
+
+Clear stored credentials.
+
+```bash
+uniformgen logout
+```
+
+## Configuration
+
+Create a `.uniformrc.ts` or `.uniformrc.js` file for advanced configuration:
+
+```typescript
+import { defineConfig } from '@eide/uniformgen';
+
+export default defineConfig({
+  // Output configuration
+  output: {
+    types: './src/foir/types',
+    documents: './src/foir/documents',
+    hooks: './src/foir/hooks',
+  },
+
+  // Generation options
+  generate: {
+    types: true,
+    documents: true,
+    hooks: true,
+    contexts: true,
+  },
+
+  // Type options
+  typeOptions: {
+    useUnknownForJSON: true,
+    generateInputTypes: true,
+  },
+
+  // Formatting
+  prettier: true,
+});
+```
+
+## Generated Output
+
+### Types
+
+```typescript
+// foir/types/page.ts
+export interface Page {
+  id: string;
+  title: string;
+  slug: string;
+  hero?: HeroBanner;
+  sections: ContentSection[];
+  seo?: SEOMetadata;
+}
+
+export interface HeroBanner {
+  heading: string;
+  subheading?: string;
+  image: FoirImage;
+  ctaText?: string;
+  ctaUrl?: string;
+}
+```
+
+### GraphQL Documents
+
+```graphql
+# foir/documents/page.graphql
+fragment PageFields on EntityRecord {
+  id
+  naturalKey
+  modelKey
+  content
+  translations
+}
+
+query GetPage($slug: String!) {
+  resolveRoute(path: $slug) {
+    record {
+      ...PageFields
+    }
+    content
+    variant
+  }
+}
+```
+
+### React Hooks
+
+```typescript
+// foir/hooks/usePage.ts
+export function useGetPage(variables: { slug: string }) {
+  return useQuery(GetPageDocument, { variables });
+}
+
+export function useCreatePage() {
+  return useMutation(CreatePageDocument);
+}
+```
+
+## Framework Integration
+
+### Remix / React Router
+
+```typescript
+// app/routes/($slug).tsx
+import { useLoaderData } from '@remix-run/react';
+import { EntityRenderer, createRegistry } from '@eide/foir-renderer';
+import type { Page } from '~/foir/types';
+
+export async function loader({ params }) {
+  const data = await foirClient.resolveRoute({ path: params.slug || '/' });
+  return { route: data };
+}
+
+export default function PageRoute() {
+  const { route } = useLoaderData<typeof loader>();
+  return <EntityRenderer data={route} registry={registry} />;
+}
+```
+
+### Next.js
+
+```typescript
+// app/[...slug]/page.tsx
+import { EntityRenderer, createRegistry } from '@eide/foir-renderer';
+import type { Page } from '@/foir/types';
+
+export default async function Page({ params }) {
+  const route = await foirClient.resolveRoute({
+    path: params.slug?.join('/') || '/'
+  });
+
+  return <EntityRenderer data={route} registry={registry} />;
+}
+```
+
+## CI/CD Integration
+
+Add schema sync to your CI pipeline:
+
+```yaml
+# .github/workflows/ci.yml
+jobs:
+  build:
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Sync Foir schemas
+        run: npx @eide/uniformgen sync
+        env:
+          FOIR_API_KEY: ${{ secrets.FOIR_API_KEY }}
+
+      - name: Type check
+        run: npm run typecheck
+```
+
+For CI environments, set the `FOIR_API_KEY` environment variable instead of using interactive login.
+
+## Requirements
+
+- Node.js 18.0.0 or higher
+- A Foir CMS project
+
+## Documentation
+
+For complete documentation, visit [docs.foir.dev](https://docs.foir.dev)
+
+## License
+
+Proprietary - All rights reserved.

package/dist/auth/credentials.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Stored credentials structure
+ */
+export interface StoredCredentials {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: string;
+    user: {
+        id: string;
+        email: string;
+        name: string;
+    };
+    selectedProject?: {
+        id: string;
+        name: string;
+        tenantId: string;
+        /** Auto-provisioned API key for public API access */
+        apiKey?: string;
+        /** API key ID (for rotation if needed) */
+        apiKeyId?: string;
+    };
+}
+/**
+ * Get the credentials directory path
+ */
+export declare function getCredentialsDir(): string;
+/**
+ * Get the credentials file path
+ */
+export declare function getCredentialsPath(): string;
+/**
+ * Read stored credentials
+ */
+export declare function getCredentials(): Promise<StoredCredentials | null>;
+/**
+ * Write credentials to file
+ */
+export declare function writeCredentials(credentials: StoredCredentials): Promise<void>;
+/**
+ * Update credentials with new values
+ */
+export declare function updateCredentials(updates: Partial<StoredCredentials>): Promise<void>;
+/**
+ * Delete credentials file
+ */
+export declare function deleteCredentials(): Promise<void>;
+/**
+ * Check if access token is expired (with 5 minute buffer)
+ */
+export declare function isTokenExpired(credentials: StoredCredentials): boolean;
+/**
+ * Get valid credentials, refreshing if necessary
+ */
+export declare function getValidCredentials(refreshFn?: (refreshToken: string) => Promise<{
+    accessToken: string;
+    expiresAt: string;
+}>): Promise<StoredCredentials | null>;
+//# sourceMappingURL=credentials.d.ts.map

package/dist/auth/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../../src/auth/credentials.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,eAAe,CAAC,EAAE;QAChB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,qDAAqD;QACrD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,0CAA0C;QAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAgBD;;GAEG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAUxE;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,iBAAiB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAClC,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;GAEG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAQvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAItE;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,SAAS,CAAC,EAAE,CACV,YAAY,EAAE,MAAM,KACjB,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,GACvD,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAqBnC"}

package/dist/auth/credentials.js

@@ -0,0 +1,107 @@
+import { promises as fs } from 'fs';
+import { join } from 'path';
+import { homedir } from 'os';
+/**
+ * Get the credentials directory path
+ */
+export function getCredentialsDir() {
+    return join(homedir(), '.uniformgen');
+}
+/**
+ * Get the credentials file path
+ */
+export function getCredentialsPath() {
+    return join(getCredentialsDir(), 'credentials.json');
+}
+/**
+ * Ensure the credentials directory exists
+ */
+async function ensureCredentialsDir() {
+    const dir = getCredentialsDir();
+    try {
+        await fs.mkdir(dir, { recursive: true, mode: 0o700 });
+    }
+    catch (error) {
+        if (error.code !== 'EEXIST') {
+            throw error;
+        }
+    }
+}
+/**
+ * Read stored credentials
+ */
+export async function getCredentials() {
+    try {
+        const content = await fs.readFile(getCredentialsPath(), 'utf-8');
+        return JSON.parse(content);
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            return null;
+        }
+        throw error;
+    }
+}
+/**
+ * Write credentials to file
+ */
+export async function writeCredentials(credentials) {
+    await ensureCredentialsDir();
+    const path = getCredentialsPath();
+    await fs.writeFile(path, JSON.stringify(credentials, null, 2), {
+        mode: 0o600,
+    });
+}
+/**
+ * Update credentials with new values
+ */
+export async function updateCredentials(updates) {
+    const existing = await getCredentials();
+    if (!existing) {
+        throw new Error('No credentials found. Run `uniformgen login` first.');
+    }
+    await writeCredentials({ ...existing, ...updates });
+}
+/**
+ * Delete credentials file
+ */
+export async function deleteCredentials() {
+    try {
+        await fs.unlink(getCredentialsPath());
+    }
+    catch (error) {
+        if (error.code !== 'ENOENT') {
+            throw error;
+        }
+    }
+}
+/**
+ * Check if access token is expired (with 5 minute buffer)
+ */
+export function isTokenExpired(credentials) {
+    const expiresAt = new Date(credentials.expiresAt);
+    const bufferMs = 5 * 60 * 1000; // 5 minutes
+    return Date.now() > expiresAt.getTime() - bufferMs;
+}
+/**
+ * Get valid credentials, refreshing if necessary
+ */
+export async function getValidCredentials(refreshFn) {
+    const credentials = await getCredentials();
+    if (!credentials) {
+        return null;
+    }
+    if (isTokenExpired(credentials) && refreshFn) {
+        try {
+            const { accessToken, expiresAt } = await refreshFn(credentials.refreshToken);
+            const updated = { ...credentials, accessToken, expiresAt };
+            await writeCredentials(updated);
+            return updated;
+        }
+        catch {
+            // If refresh fails, credentials are invalid
+            return null;
+        }
+    }
+    return credentials;
+}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}