@cellajs/create-cella 0.2.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CellaJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/configs/default-config.ts.template

@@ -9,33 +9,34 @@
  * NOTE: This file is NOT compiled or imported — it is copied and interpolated
  * as plain text. The import path below is relative to `shared/config/` (its destination).
  */
-import type { BaseAuthStrategies, BaseOAuthProviders, ConfigMode, RequiredConfig, S3Config } from '../src/builder/types';
+import type { ConfigMode, RequiredConfig, S3ConfigInput } from '../src/config-builder/types';
 
 // Re-export for external consumers
 export { roles, hierarchy } from './hierarchy-config';
 
+// Set these early for reuse
+const entityTypes = ['user', 'organization', 'attachment', 'page'] as const;
+const productEntityTypes = ['attachment', 'page'] as const;
+
 export const config = {
 
   /******************************************************************************
    * ENTITY DATA MODEL
    ******************************************************************************/
 
-  /** All entity types in the app - must match hierarchy.allTypes. Explicit tuple for Drizzle compatibility. */
-  entityTypes: ['user', 'organization', 'attachment', 'page'] as const,
+  /** All entity types in the app - must match hierarchy.allTypes. */
+  entityTypes,
 
-  /** Context entities with memberships - must match hierarchy.contextTypes. Explicit tuple for Drizzle compatibility. */
+  /** Context entities with memberships - must match hierarchy.contextTypes. */
   contextEntityTypes: ['organization'] as const,
-  
-  /** Product/content entities - must match hierarchy.productTypes. Explicit tuple for Drizzle compatibility. */
-  productEntityTypes: ['attachment', 'page'] as const,
+
+  /** Product/content entities - must match hierarchy.productTypes. */
+  productEntityTypes,
 
   /**
-   * Parentless product entities (no organization_id) - must match hierarchy.parentlessProductTypes.
-   * Explicit tuple required for Drizzle compatibility. Compile-time validated in shared/index.ts.
+   * Product entity types tracked for seen/unseen counts.
+   * Unseen counts are grouped by the parent context entity of each tracked type.
    */
-  parentlessProductEntityTypes: ['page'] as const,
-
-  /** Product entity types tracked for seen/unseen counts. Must be org-scoped (not parentless). */
   seenTrackedEntityTypes: ['attachment'] as const,
 
   /** Maps entity types to their ID column names - must match entityTypes */
@@ -52,12 +53,22 @@ export const config = {
   /** Resource types that are not entities but have activities logged */
   resourceTypes: ['request', 'membership', 'inactive_membership', 'tenant'] as const,
 
+  /**
+   * Entity embeddings: declares which entities are embedded as ID arrays inside
+   * other entities. Forks extend when adding new embedding relationships.
+   */
+  entityEmbeddings: [] as readonly {
+    readonly embeddedEntity: (typeof productEntityTypes)[number];
+    readonly hostEntity: (typeof productEntityTypes)[number];
+    readonly hostColumn: string;
+  }[],
+
   /**
    * User menu structure of context entities with optional nested subentities.
    * If subentityType is set, the table must include `${entity}Id` foreign key.
    */
   menuStructure: [
-    { entityType: 'organization',subentityType: null} as const,
+    { entityType: 'organization', subentityType: null } as const,
   ],
 
   /** Default restrictions for tenants (entity quotas and rate limits) */
@@ -72,17 +83,10 @@ export const config = {
     },
   } as const,
 
-  /** Public tenant for platform-wide content (pages, docs, etc.) */
-  publicTenant: { id: 'public',  name: 'Public' },
-
   /******************************************************************************
    * SYSTEM ROLES
    ******************************************************************************/
-  
-  /**
-   * System-wide roles stored in DB.
-   * Must include 'admin' for system administration access.
-   */
+
   systemRoles: ['admin'] as const,
 
   /******************************************************************************
@@ -99,7 +103,7 @@ export const config = {
   description: '__project_name__ — powered by Cella.',
   /** SEO keywords for search engines */
   keywords:
-    'starter kit, fullstack, monorepo, typescript, hono, honojs, drizzle, shadcn, react, postgres, pwa, offline, instant§ updates, realtime data, sync engine',
+    'starter kit, fullstack, monorepo, typescript, hono, honojs, drizzle, baseui, react, postgres, pwa, offline, instant updates, realtime data, sync engine',
 
   /******************************************************************************
    * URLS & ENDPOINTS
@@ -111,9 +115,29 @@ export const config = {
   backendUrl: 'https://api.__project_slug__.example.com',
   /** OAuth callback base URL */
   backendAuthUrl: 'https://api.__project_slug__.example.com/auth',
+  /** Yjs realtime relay URL */
+  yjsUrl: 'wss://yjs.__project_slug__.example.com',
+  /** AI service base URL */
+  aiUrl: 'https://ai.__project_slug__.example.com',
+  /**
+   * Per-service toggles and public URLs. `enabled` controls whether the service
+   * is wired up; `publicUrl` is the externally reachable endpoint.
+   */
+  services: {
+    frontend: { enabled: true as boolean, publicUrl: 'https://__project_slug__.example.com' },
+    backend: { enabled: true as boolean, publicUrl: 'https://api.__project_slug__.example.com' },
+    cdc: { enabled: true as boolean },
+    yjs: { enabled: false as boolean, publicUrl: 'wss://yjs.__project_slug__.example.com' },
+    ai: { enabled: false as boolean, publicUrl: 'https://ai.__project_slug__.example.com' },
+  },
+
+  // Cost escape hatch: when true the backend (MODE=api) also boots every enabled
+  // service in-process — one VM for previews/small forks. Default false keeps the
+  // split (one service per process). cdc co-hosting forfeits API blue-green.
+  singleVM: false as boolean,
 
   /** About page URL */
-  aboutUrl: 'https://__project_slug__.example.com/about',
+  aboutUrl: '/about',
   /** Status page URL for uptime monitoring */
   statusUrl: 'https://status.__project_slug__.example.com',
   /** Canonical production URL */
@@ -128,27 +152,25 @@ export const config = {
    * EMAIL
    ******************************************************************************/
 
-  /** Email address for user support inquiries */
-  supportEmail: 'support@__project_slug__.example.com',
-
   /** From address for system notifications */
   senderEmail: 'notifications@__project_slug__.example.com',
-
-    /** Receive security warnings */
+  /** Email address for user support inquiries */
+  supportEmail: 'support@__project_slug__.example.com',
+  /** Receive security warnings */
   securityEmail: 'security@__project_slug__.example.com',
 
   /******************************************************************************
    * MODE & FLAGS
    ******************************************************************************/
-  
+
   /** Runtime mode - overridden per environment file */
   mode: 'development' as ConfigMode,
-  /** Enable debug logging and dev tools */
-  debug: false,
   /** Enable maintenance mode (blocks all requests) */
   maintenance: false,
   /** Cookie version - increment when changing cookie structure to invalidate old cookies */
   cookieVersion: 'v1',
+  /** Persisted client query-cache shape - bump on a breaking change to a cached entity so clients wipe stale cache. See info/SCHEMA_EVOLUTION.md */
+  clientCacheVersion: 'v1',
 
   /******************************************************************************
    * FEATURE FLAGS
@@ -160,13 +182,15 @@ export const config = {
    */
   has: {
     /** Progressive Web App support for preloading static assets and offline support */
-    pwa: true,
+    pwa: true as boolean,
     /** Allow users to sign up. If false, the app is by invitation only */
-    registrationEnabled: true,
+    selfRegistration: false as boolean,
     /** Suggest a waitlist for unknown emails when sign up is disabled */
-    waitlist: true,
+    waitlist: false as boolean,
     /** S3 fully configured - if false, files will be stored in local browser (IndexedDB) */
-    uploadEnabled: false,
+    uploadEnabled: false as boolean,
+    /** Customer support chat widget (Gleap). Unrelated to the AI module. */
+    chatSupport: false as boolean,
   },
 
   /******************************************************************************
@@ -177,13 +201,13 @@ export const config = {
    * Enabled authentication strategies.
    * TOTP can only be used as MFA fallback with passkey as primary.
    */
-  enabledAuthStrategies: ['password', 'passkey', 'totp'] satisfies BaseAuthStrategies[],
+  enabledAuthStrategies: ['passkey', 'oauth', 'totp', 'magic'] as const,
 
   /** Enabled OAuth providers - currently supports: github, google, microsoft */
-  enabledOAuthProviders: [] satisfies BaseOAuthProviders[],
+  enabledOAuthProviders: ['github'] as const,
 
   /** Token types used for verification flows */
-  tokenTypes: ['email-verification', 'oauth-verification', 'password-reset', 'invitation', 'confirm-mfa'] as const,
+  tokenTypes: ['email-verification', 'oauth-verification', 'invitation', 'confirm-mfa', 'magic'] as const,
 
   /** TOTP configuration for MFA */
   totpConfig: {
@@ -199,12 +223,8 @@ export const config = {
   /** API version prefix for endpoints */
   apiVersion: 'v1',
   /** API documentation description shown in Scalar */
-  apiDescription: `⚠️ ATTENTION: PRERELEASE!  
-                  This API is organized into modules based on logical domains (e.g. \`auth\`, \`organizations\`, \`memberships\`).
-                  Each module includes a set of endpoints that expose functionality related to a specific resource or cross resource logic.
-
-                  The documentation is generated from source code using \`zod\` schemas, converted into OpenAPI via \`zod-openapi\` and served through the \`hono\` framework.`,
-
+  apiDescription: `⚠️ ATTENTION: PRERELEASE!
+                  This API is organized into modules based on logical domains.`,
 
   /******************************************************************************
    * REQUEST LIMITS
@@ -221,7 +241,7 @@ export const config = {
     organizations: 40,
     requests: 40,
     attachments: 40,
-    pages: 40,
+    pages: 100,
     pendingMemberships: 20,
   },
 
@@ -236,23 +256,11 @@ export const config = {
    * STORAGE & UPLOADS (S3)
    ******************************************************************************/
 
-  /** S3-compatible storage configuration */
+  /** S3-compatible storage configuration. Only region and host are required; the rest is derived from the slug. */
   s3: {
-    /** Prefix to namespace files when sharing a bucket across apps or envs */
-    bucketPrefix: '__project_slug__',
-    /** Public bucket name for publicly accessible files */
-    publicBucket: '',
-    /** Private bucket name for authenticated-only files */
-    privateBucket: '',
-    /** S3 region identifier */
     region: '',
-    /** S3 host endpoint */
     host: '',
-    /** CDN URL for private bucket (signed URLs) */
-    privateCDNUrl: '',
-    /** CDN URL for public bucket */
-    publicCDNUrl: '',
-  } satisfies S3Config,
+  } as S3ConfigInput,
 
   /** Upload template IDs for Transloadit processing pipelines */
   uploadTemplateIds: ['avatar', 'cover', 'attachment'] as const,
@@ -275,36 +283,28 @@ export const config = {
    * Controls which attachments are cached locally for offline access.
    */
   localBlobStorage: {
-    enabled: true, // Enable local blob caching
-    maxFileSize: 10 * 1024 * 1024, // 10MB - files larger than this are not cached locally
-    maxTotalSize: 100 * 1024 * 1024, // 100MB - total cache size, LRU eviction when exceeded
-    allowedContentTypes: [] as string[], // Empty = all types allowed
-    excludedContentTypes: ['video/*'] as string[], // Excluded types (takes precedence over allowed)
-    downloadConcurrency: 2, // Max concurrent background downloads
-    uploadRetryAttempts: 3, // Max retry attempts for failed uploads
-    uploadRetryDelays: [60000, 300000, 900000] as const, // Retry delays in ms (1min, 5min, 15min)
+    enabled: true,
+    maxFileSize: 10 * 1024 * 1024,
+    maxTotalSize: 100 * 1024 * 1024,
+    allowedContentTypes: [] as string[],
+    excludedContentTypes: ['video/*'] as string[],
+    downloadConcurrency: 2,
+    uploadRetryAttempts: 3,
+    uploadRetryDelays: [60000, 300000, 900000] as const,
   },
 
   /******************************************************************************
    * THIRD-PARTY SERVICES
    ******************************************************************************/
 
-  /** Paddle client token for payments */
-  paddleToken: '',
-  /** Paddle price IDs for subscription products */
-  paddlePriceIds: {
-    donate: '',
-  },
-  /** Sentry DSN for error tracking */
-  sentryDsn: '',
-  /** Upload source maps to Sentry on build */
-  sentSentrySourceMaps: false,
   /** Gleap token for customer support widget */
   gleapToken: '',
   /** Google Maps API key */
   googleMapsKey: '',
   /** Matrix homeserver URL for chat integration */
   matrixURL: 'https://matrix-client.matrix.org',
+  /** Maple.dev public ingest key, safe to embed in the frontend bundle (empty disables frontend export) */
+  maplePublicIngestKey: '',
 
   /******************************************************************************
    * THEMING & UI
@@ -320,9 +320,7 @@ export const config = {
       sidebarWidthCollapsed: '4rem',
       sheetPanelWidth: '20rem',
     },
-    colors: {
-      rose: '#e11d48',
-    },
+    colors: {},
     strokeWidth: 1.5,
     screenSizes: {
       xs: '420px',
@@ -380,7 +378,7 @@ export const config = {
     bankAccount: '',
     googleMapsUrl: '',
     scheduleCallUrl: '',
-    blueskyUrl: '',
+    socialUrl: '',
     blueskyHandle: '',
     element: '',
     githubUrl: '',