@nextsparkjs/core 0.1.0-beta.1 → 0.1.0-beta.10

package/templates/contents/themes/starter/entities/tasks/migrations/002_task_metas.sql

@@ -0,0 +1,84 @@
+-- Migration: 002_task_metas.sql
+-- Description: Tasks metas (table, indexes, RLS) - Starter Theme
+-- Date: 2025-01-03
+
+-- ============================================
+-- TABLE
+-- ============================================
+CREATE TABLE IF NOT EXISTS public."tasks_metas" (
+  id             TEXT PRIMARY KEY DEFAULT gen_random_uuid()::text,
+  "entityId"     TEXT NOT NULL REFERENCES public."tasks"(id) ON DELETE CASCADE,
+  "metaKey"      TEXT NOT NULL,
+  "metaValue"    JSONB NOT NULL DEFAULT '{}'::jsonb,
+  "dataType"     TEXT DEFAULT 'json',
+  "isPublic"     BOOLEAN NOT NULL DEFAULT false,
+  "isSearchable" BOOLEAN NOT NULL DEFAULT false,
+  "createdAt"    TIMESTAMPTZ NOT NULL DEFAULT now(),
+  "updatedAt"    TIMESTAMPTZ NOT NULL DEFAULT now(),
+  CONSTRAINT tasks_metas_unique_key UNIQUE ("entityId", "metaKey")
+);
+
+COMMENT ON TABLE  public."tasks_metas"               IS 'Key-value metadata for tasks';
+COMMENT ON COLUMN public."tasks_metas"."entityId"    IS 'Reference to parent task (generic entityId)';
+COMMENT ON COLUMN public."tasks_metas"."metaKey"     IS 'Metadata key identifier';
+COMMENT ON COLUMN public."tasks_metas"."metaValue"   IS 'Metadata value in JSONB format';
+COMMENT ON COLUMN public."tasks_metas"."dataType"    IS 'Type hint for the value: json, string, number, boolean';
+COMMENT ON COLUMN public."tasks_metas"."isPublic"    IS 'Whether this metadata is publicly readable';
+COMMENT ON COLUMN public."tasks_metas"."isSearchable" IS 'Whether this metadata is searchable';
+
+-- ============================================
+-- TRIGGER updatedAt (uses Better Auth function)
+-- ============================================
+DROP TRIGGER IF EXISTS tasks_metas_set_updated_at ON public."tasks_metas";
+CREATE TRIGGER tasks_metas_set_updated_at
+  BEFORE UPDATE ON public."tasks_metas"
+  FOR EACH ROW EXECUTE FUNCTION public.set_updated_at();
+
+-- ============================================
+-- INDEXES
+-- ============================================
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_entity_id      ON public."tasks_metas"("entityId");
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_key            ON public."tasks_metas"("metaKey");
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_is_public      ON public."tasks_metas"("isPublic") WHERE "isPublic" = true;
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_is_searchable  ON public."tasks_metas"("isSearchable") WHERE "isSearchable" = true;
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_value_gin      ON public."tasks_metas" USING GIN ("metaValue");
+CREATE INDEX IF NOT EXISTS idx_tasks_metas_value_ops      ON public."tasks_metas" USING GIN ("metaValue" jsonb_path_ops);
+
+-- ============================================
+-- RLS
+-- ============================================
+ALTER TABLE public."tasks_metas" ENABLE ROW LEVEL SECURITY;
+
+-- Cleanup existing policies
+DROP POLICY IF EXISTS "Tasks metas owner can do all" ON public."tasks_metas";
+DROP POLICY IF EXISTS "Tasks metas team can do all"  ON public."tasks_metas";
+DROP POLICY IF EXISTS tasks_metas_owner_policy       ON public."tasks_metas";
+
+-- ============================
+-- RLS: TEAM ISOLATION VIA PARENT
+-- ============================
+-- Inherits isolation from parent task via teamId
+-- The access.shared logic is handled at APP LEVEL
+CREATE POLICY "Tasks metas team can do all"
+ON public."tasks_metas"
+FOR ALL TO authenticated
+USING (
+  -- Superadmin bypass
+  public.is_superadmin()
+  OR
+  -- Team isolation via parent task
+  EXISTS (
+    SELECT 1 FROM public."tasks" t
+    WHERE t.id = "entityId"
+      AND t."teamId" = ANY(public.get_user_team_ids())
+  )
+)
+WITH CHECK (
+  public.is_superadmin()
+  OR
+  EXISTS (
+    SELECT 1 FROM public."tasks" t
+    WHERE t.id = "entityId"
+      AND t."teamId" = ANY(public.get_user_team_ids())
+  )
+);

package/templates/contents/themes/starter/entities/tasks/migrations/003_tasks_sample_data.sql

@@ -0,0 +1,172 @@
+-- Migration: 003_tasks_sample_data.sql
+-- Description: Sample data for tasks - Starter Theme
+-- Date: 2025-01-03
+-- Note: teamId and userId references should match your seed data
+
+-- ============================================
+-- SAMPLE TASKS
+-- ============================================
+INSERT INTO public."tasks" (
+  id,
+  "userId",
+  "teamId",
+  title,
+  description,
+  completed,
+  status,
+  priority,
+  tags,
+  "dueDate",
+  "estimatedHours",
+  "createdAt",
+  "updatedAt"
+) VALUES
+  -- ========================================
+  -- SAMPLE TASKS FOR TESTING
+  -- ========================================
+  (
+    'task-sample-001',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Set up project documentation',
+    'Create comprehensive documentation for the project including README, API docs, and contribution guidelines.',
+    false,
+    'todo',
+    'high',
+    '["documentation", "setup"]'::jsonb,
+    CURRENT_DATE + INTERVAL '7 days',
+    4.0,
+    NOW() - INTERVAL '3 days',
+    NOW() - INTERVAL '1 day'
+  ),
+  (
+    'task-sample-002',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Implement user authentication',
+    'Set up authentication system with login, registration, and password recovery functionality.',
+    false,
+    'in-progress',
+    'urgent',
+    '["auth", "backend", "security"]'::jsonb,
+    CURRENT_DATE + INTERVAL '3 days',
+    8.0,
+    NOW() - INTERVAL '5 days',
+    NOW()
+  ),
+  (
+    'task-sample-003',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Design dashboard layout',
+    'Create responsive dashboard layout with sidebar navigation and main content area.',
+    true,
+    'done',
+    'medium',
+    '["design", "frontend", "ui"]'::jsonb,
+    CURRENT_DATE - INTERVAL '2 days',
+    6.0,
+    NOW() - INTERVAL '10 days',
+    NOW() - INTERVAL '2 days'
+  ),
+  (
+    'task-sample-004',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Write unit tests',
+    'Create comprehensive unit tests for all service layer functions.',
+    false,
+    'review',
+    'high',
+    '["testing", "quality"]'::jsonb,
+    CURRENT_DATE + INTERVAL '5 days',
+    10.0,
+    NOW() - INTERVAL '4 days',
+    NOW() - INTERVAL '1 day'
+  ),
+  (
+    'task-sample-005',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Optimize database queries',
+    'Review and optimize slow database queries. Add appropriate indexes.',
+    false,
+    'blocked',
+    'medium',
+    '["database", "performance", "optimization"]'::jsonb,
+    CURRENT_DATE + INTERVAL '14 days',
+    5.0,
+    NOW() - INTERVAL '2 days',
+    NOW()
+  ),
+  (
+    'task-sample-006',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Set up CI/CD pipeline',
+    'Configure automated testing and deployment using GitHub Actions.',
+    false,
+    'todo',
+    'high',
+    '["devops", "automation"]'::jsonb,
+    CURRENT_DATE + INTERVAL '10 days',
+    6.0,
+    NOW() - INTERVAL '1 day',
+    NOW()
+  ),
+  (
+    'task-sample-007',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Create API documentation',
+    'Document all REST API endpoints with examples and response schemas.',
+    true,
+    'done',
+    'low',
+    '["documentation", "api"]'::jsonb,
+    CURRENT_DATE - INTERVAL '5 days',
+    3.0,
+    NOW() - INTERVAL '14 days',
+    NOW() - INTERVAL '5 days'
+  ),
+  (
+    'task-sample-008',
+    'test-member-cypress-001',
+    'team-personal-member-001',
+    'Review code quality',
+    'Perform code review and address any linting issues or code smells.',
+    false,
+    'in-progress',
+    'medium',
+    '["code-review", "quality"]'::jsonb,
+    CURRENT_DATE + INTERVAL '2 days',
+    4.0,
+    NOW() - INTERVAL '3 days',
+    NOW()
+  )
+ON CONFLICT (id) DO NOTHING;
+
+-- ============================================
+-- SAMPLE META DATA
+-- ============================================
+INSERT INTO public."tasks_metas" (
+  "entityId",
+  "metaKey",
+  "metaValue",
+  "dataType",
+  "isPublic",
+  "isSearchable"
+) VALUES
+  -- Task metadata examples
+  ('task-sample-001', 'category', '"Documentation"', 'string', true, true),
+  ('task-sample-001', 'assignee', '"John Doe"', 'string', true, true),
+  ('task-sample-002', 'category', '"Backend"', 'string', true, true),
+  ('task-sample-002', 'complexity', '"high"', 'string', true, true),
+  ('task-sample-003', 'category', '"Design"', 'string', true, true),
+  ('task-sample-004', 'category', '"Testing"', 'string', true, true),
+  ('task-sample-005', 'category', '"Database"', 'string', true, true),
+  ('task-sample-005', 'blockedBy', '"Waiting for production access"', 'string', true, false),
+  ('task-sample-006', 'category', '"DevOps"', 'string', true, true),
+  ('task-sample-007', 'category', '"Documentation"', 'string', true, true),
+  ('task-sample-008', 'category', '"Quality"', 'string', true, true)
+ON CONFLICT ("entityId", "metaKey") DO NOTHING;

package/templates/contents/themes/starter/entities/tasks/tasks.config.ts

@@ -0,0 +1,116 @@
+/**
+ * Task Entity Configuration - Starter Theme
+ *
+ * 5-section structure for entity configuration.
+ * All table names, API paths, and metadata are derived automatically from slug.
+ */
+
+import { CheckSquare } from 'lucide-react'
+import type { EntityConfig } from '@nextsparkjs/core/lib/entities/types'
+import { taskFields } from './tasks.fields'
+
+export const taskEntityConfig: EntityConfig = {
+  // ==========================================
+  // 1. BASIC IDENTIFICATION
+  // ==========================================
+  slug: 'tasks', // Single source of truth - derives tableName, apiPath, metaTableName, i18nNamespace
+  enabled: true,
+  names: {
+    singular: 'task',
+    plural: 'Tasks',
+  },
+  icon: CheckSquare,
+
+  // ==========================================
+  // 2. ACCESS AND SCOPE CONFIGURATION
+  // ==========================================
+  access: {
+    public: false, // If accessible without authentication, requires RLS (anon can select)
+    api: true, // If has external API via API key
+    metadata: true, // If supports metadata system
+    shared: false, // CASE 2: Any authenticated user can access all records (no userId filter)
+  },
+
+  // ==========================================
+  // 3. UI/UX FEATURES
+  // ==========================================
+  ui: {
+    dashboard: {
+      showInMenu: true,
+      showInTopbar: true,
+    },
+    public: {
+      hasArchivePage: false,
+      hasSinglePage: false,
+    },
+    features: {
+      searchable: true,
+      sortable: true,
+      filterable: true,
+      bulkOperations: true,
+      importExport: false,
+    },
+  },
+
+  // ==========================================
+  // 4. PERMISSIONS SYSTEM
+  // ==========================================
+  permissions: {
+    actions: [
+      {
+        action: 'create',
+        label: 'Create tasks',
+        description: 'Can create new tasks',
+        roles: ['owner', 'admin', 'member'],
+      },
+      {
+        action: 'read',
+        label: 'View tasks',
+        description: 'Can view task details',
+        roles: ['owner', 'admin', 'member'],
+      },
+      {
+        action: 'list',
+        label: 'List tasks',
+        description: 'Can see the tasks list',
+        roles: ['owner', 'admin', 'member'],
+      },
+      {
+        action: 'update',
+        label: 'Edit tasks',
+        description: 'Can modify task information',
+        roles: ['owner', 'admin', 'member'],
+      },
+      {
+        action: 'delete',
+        label: 'Delete tasks',
+        description: 'Can delete tasks',
+        roles: ['owner', 'admin'],
+        dangerous: true,
+      },
+    ],
+    customActions: [
+      {
+        action: 'assign',
+        label: 'Assign tasks',
+        description: 'Can assign tasks to team members',
+        roles: ['owner', 'admin'],
+      },
+    ],
+  },
+
+  // ==========================================
+  // FIELDS (imported from separate file)
+  // ==========================================
+  fields: taskFields,
+
+  // ==========================================
+  // AUTOMATIC SYSTEM DERIVATIONS
+  // ==========================================
+  // The following properties are automatically derived from the slug:
+  // - tableName: 'tasks' (slug)
+  // - metaTableName: 'tasks_metas' (slug + '_metas')
+  // - apiPath: '/api/v1/tasks' (slug API Route)
+  // - i18nNamespace: 'tasks' (slug as namespace)
+  // - foreignKey in metadata: 'entityId' (generic for all entities)
+}

package/templates/contents/themes/starter/entities/tasks/tasks.fields.ts

@@ -0,0 +1,188 @@
+/**
+ * Task Entity Fields Configuration - Starter Theme
+ *
+ * Contains all field definitions for the tasks entity.
+ */
+
+import type { EntityField } from '@nextsparkjs/core/lib/entities/types'
+
+export const taskFields: EntityField[] = [
+  {
+    name: 'title',
+    type: 'text',
+    required: true,
+    display: {
+      label: 'Title',
+      description: 'Task title or name',
+      placeholder: 'Enter task title...',
+      showInList: true,
+      showInDetail: true,
+      showInForm: true,
+      order: 1,
+      columnWidth: 12,
+    },
+    api: {
+      readOnly: false,
+      searchable: true,
+      sortable: true,
+    },
+  },
+  {
+    name: 'description',
+    type: 'textarea',
+    required: false,
+    display: {
+      label: 'Description',
+      description: 'Detailed task description',
+      placeholder: 'Enter task description...',
+      showInList: false,
+      showInDetail: true,
+      showInForm: true,
+      order: 2,
+      columnWidth: 12,
+    },
+    api: {
+      readOnly: false,
+      searchable: true,
+      sortable: false,
+    },
+  },
+  {
+    name: 'status',
+    type: 'select',
+    required: false,
+    defaultValue: 'todo',
+    options: [
+      { value: 'todo', label: 'To Do' },
+      { value: 'in-progress', label: 'In Progress' },
+      { value: 'review', label: 'In Review' },
+      { value: 'done', label: 'Done' },
+      { value: 'blocked', label: 'Blocked' },
+    ],
+    display: {
+      label: 'Status',
+      description: 'Current task status',
+      placeholder: 'Select status...',
+      showInList: true,
+      showInDetail: true,
+      showInForm: true,
+      order: 3,
+      columnWidth: 4,
+    },
+    api: {
+      readOnly: false,
+      searchable: false,
+      sortable: true,
+    },
+  },
+  {
+    name: 'priority',
+    type: 'select',
+    required: false,
+    defaultValue: 'medium',
+    options: [
+      { value: 'low', label: 'Low' },
+      { value: 'medium', label: 'Medium' },
+      { value: 'high', label: 'High' },
+      { value: 'urgent', label: 'Urgent' },
+    ],
+    display: {
+      label: 'Priority',
+      description: 'Task priority level',
+      placeholder: 'Select priority...',
+      showInList: true,
+      showInDetail: true,
+      showInForm: true,
+      order: 4,
+      columnWidth: 4,
+    },
+    api: {
+      readOnly: false,
+      searchable: false,
+      sortable: true,
+    },
+  },
+  {
+    name: 'tags',
+    type: 'tags',
+    required: false,
+    display: {
+      label: 'Tags',
+      description: 'Task tags for categorization',
+      placeholder: 'Add tags...',
+      showInList: false,
+      showInDetail: true,
+      showInForm: true,
+      order: 5,
+      columnWidth: 6,
+    },
+    api: {
+      readOnly: false,
+      searchable: true,
+      sortable: false,
+    },
+  },
+  {
+    name: 'dueDate',
+    type: 'date',
+    required: false,
+    display: {
+      label: 'Due Date',
+      description: 'Task deadline',
+      placeholder: 'Select due date...',
+      showInList: true,
+      showInDetail: true,
+      showInForm: true,
+      order: 6,
+      columnWidth: 4,
+    },
+    api: {
+      readOnly: false,
+      searchable: false,
+      sortable: true,
+    },
+  },
+  {
+    name: 'estimatedHours',
+    type: 'number',
+    required: false,
+    display: {
+      label: 'Estimated Hours',
+      description: 'Estimated time to complete (in hours)',
+      placeholder: '0',
+      showInList: false,
+      showInDetail: true,
+      showInForm: true,
+      order: 7,
+      columnWidth: 4,
+    },
+    api: {
+      readOnly: false,
+      searchable: false,
+      sortable: true,
+    },
+  },
+  {
+    name: 'completed',
+    type: 'boolean',
+    required: false,
+    defaultValue: false,
+    display: {
+      label: 'Completed',
+      description: 'Mark as completed (legacy field, use status instead)',
+      showInList: false,
+      showInDetail: true,
+      showInForm: false,
+      order: 8,
+      columnWidth: 4,
+    },
+    api: {
+      readOnly: false,
+      searchable: false,
+      sortable: true,
+    },
+  },
+  // NOTE: createdAt and updatedAt are implicit system fields
+  // They are automatically included by the API and frontend components
+  // Do NOT declare them here - see core/lib/entities/system-fields.ts
+]