@objectql/starter-basic 1.6.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ObjectQL Contributors
+
+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/README.md

@@ -0,0 +1,17 @@
+# Basic Script Example
+
+This is a minimal example demonstrating how to use ObjectQL as a library in a simple Node.js/TypeScript script.
+
+It demonstrates:
+1. How to initialize ObjectQL (`new ObjectQL(...)`)
+2. How to connect to a SQLite database
+3. How to define objects (`projects.object.yml`)
+4. How to perform CRUD operations in a script
+
+## Run
+
+```bash
+pnpm install
+pnpm run build
+node dist/index.js
+```

package/dist/demo.app.yml

@@ -0,0 +1,4 @@
+name: demo_app
+label: Demo Application
+description: "A showcase of ObjectQL capabilities including all field types."
+homepage: /kitchen_sink

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB"}

package/dist/main.menu.yml

@@ -0,0 +1,30 @@
+name: main
+label: Main Menu
+type: sidebar
+app: demo_app
+
+items:
+  - name: core_business
+    label: Core Business
+    icon: briefcase
+    type: section
+    items:
+      - object: projects
+      - object: tasks
+
+  - name: showcase
+    label: Showcase
+    icon: flask
+    type: section
+    items:
+      - object: kitchen_sink
+        label: Component Gallery
+
+  - name: reporting
+    label: Reporting
+    icon: bar-chart
+    type: section
+    items:
+      - type: url
+        label: Dashboard
+        path: /dashboard

package/dist/modules/kitchen-sink/kitchen_sink.data.yml

@@ -0,0 +1,18 @@
+- simple_text: "Hello World"
+  long_text: |
+    This is a long text.
+    It spans multiple lines.
+  rich_content: "# Markdown Header\n\n- List Item 1\n- List Item 2"
+  count: 42
+  price: 99.99
+  progress: 0.75
+  is_active: true
+  due_date: "2024-12-31"
+  meeting_time: "2024-12-31T10:00:00Z"
+  status: "published"
+  tags: ["tech", "blog"]
+  email_address: "test@example.com"
+  website: "https://objectql.org"
+  metadata:
+    source: "seed_data"
+    version: 1

package/dist/modules/kitchen-sink/kitchen_sink.object.yml

@@ -0,0 +1,154 @@
+label: "Kitchen Sink (All Fields)"
+description: "A demonstration of every supported field type in ObjectQL"
+icon: "layout-grid-line"
+
+fields:
+  # --- String Types ---
+  simple_text:
+    type: text
+    label: Simple Text
+    required: true
+    min_length: 3
+    max_length: 100
+    help_text: "Basic single-line text"
+
+  long_text:
+    type: textarea
+    label: Multi-line Text
+    rows: 4
+  
+  rich_content:
+    type: markdown
+    label: Markdown Content
+  
+  raw_html:
+    type: html
+    label: HTML Content
+    readonly: true # Usually HTML is generated or read-only
+
+  # --- Number Types ---
+  count:
+    type: number
+    label: Integer Count
+    scale: 0
+    
+  price:
+    type: currency
+    label: Price
+    currency: USD
+    scale: 2
+
+  progress:
+    type: percent
+    label: Progress
+    min: 0
+    max: 1
+    scale: 2 # 0.55 -> 55%
+
+  # --- Boolean ---
+  is_active:
+    type: boolean
+    label: Is Active
+    defaultValue: true
+
+  # --- Date & Time ---
+  due_date:
+    type: date
+    label: Due Date
+  
+  meeting_time:
+    type: datetime
+    label: Meeting (Date & Time)
+  
+  alarm:
+    type: time
+    label: Alarm Time
+
+  # --- Selection ---
+  status:
+    type: select
+    label: Status
+    options:
+      - label: Draft
+        value: draft
+      - label: Published
+        value: published
+      - label: Archived
+        value: archived
+    defaultValue: draft
+  
+  tags:
+    type: select
+    label: Tags
+    multiple: true
+    options:
+      - tech
+      - news
+      - blog # Simple string array shorthand
+
+  # --- Contact & Web ---
+  email_address:
+    type: email
+    label: Email
+  
+  phone_number:
+    type: phone
+    label: Phone
+  
+  website:
+    type: url
+    label: Website URL
+
+  # --- Media ---
+  profile_pic:
+    type: avatar
+    label: Avatar
+  
+  attachment:
+    type: file
+    label: Attachment document
+  
+  gallery:
+    type: image
+    label: Image Gallery
+    multiple: true
+
+  # --- Security ---
+  secret_code:
+    type: password
+    label: Secret Code
+
+  # --- Advanced / Complex ---
+  coords:
+    type: location
+    label: GPS Coordinates
+  
+  metadata:
+    type: object
+    label: JSON Metadata
+  
+  embedding:
+    type: vector
+    label: Vector Embedding
+    dimension: 1536 # e.g. OpenAI ada-002
+
+  # --- Relationships ---
+  related_project:
+    type: lookup
+    label: Related Project
+    reference_to: projects
+  
+  # Note: master_detail requires this object to be the detail side
+  # parent_project:
+  #   type: master_detail
+  #   reference_to: projects
+
+  # --- Computed ---
+  # auto_id:
+  #   type: auto_number
+  #   prefix: "KS-"
+    
+  # calc_value:
+  #   type: formula
+  #   expression: "{count} * 10"
+    

package/dist/modules/projects/pages/create_project_wizard.page.yml

@@ -0,0 +1,244 @@
+# Project Creation Wizard
+# A multi-step wizard for creating new projects
+
+name: create_project_wizard
+label: Create New Project
+description: Step-by-step wizard for creating a project
+icon: plus-circle
+layout: wizard
+
+# Only admins and managers can create projects
+permissions:
+  view: ['admin', 'manager']
+
+# Wizard steps
+components:
+  # Step 1: Basic Information
+  - id: step_basic
+    type: container
+    label: Basic Information
+    description: Enter the project name and description
+    config:
+      step: 1
+      icon: info
+    components:
+      - id: basic_form
+        type: form
+        config:
+          layout: vertical
+          fields:
+            - name: name
+              label: Project Name
+              type: text
+              required: true
+              placeholder: My Awesome Project
+              help_text: Choose a descriptive name for your project
+            - name: description
+              label: Project Description
+              type: textarea
+              rows: 5
+              placeholder: Describe what this project is about
+            - name: category
+              label: Category
+              type: select
+              options:
+                - label: Development
+                  value: development
+                - label: Marketing
+                  value: marketing
+                - label: Research
+                  value: research
+                - label: Operations
+                  value: operations
+        actions:
+          on_validate:
+            type: custom
+            handler: validateBasicInfo
+  
+  # Step 2: Team & Resources
+  - id: step_team
+    type: container
+    label: Team & Resources
+    description: Assign team members and set budget
+    config:
+      step: 2
+      icon: users
+    components:
+      - id: team_form
+        type: form
+        config:
+          layout: vertical
+          fields:
+            - name: owner
+              label: Project Manager
+              type: lookup
+              reference_to: users
+              required: true
+              help_text: Select the person responsible for this project
+            - name: team_members
+              label: Team Members
+              type: lookup
+              reference_to: users
+              multiple: true
+              help_text: Add team members who will work on this project
+            - name: budget
+              label: Budget
+              type: currency
+              currency: USD
+              help_text: Estimated budget for this project
+            - name: department
+              label: Department
+              type: select
+              options:
+                - label: Engineering
+                  value: engineering
+                - label: Product
+                  value: product
+                - label: Sales
+                  value: sales
+                - label: Marketing
+                  value: marketing
+  
+  # Step 3: Timeline
+  - id: step_timeline
+    type: container
+    label: Timeline
+    description: Set project dates and milestones
+    config:
+      step: 3
+      icon: calendar
+    components:
+      - id: timeline_form
+        type: form
+        config:
+          layout: vertical
+          fields:
+            - name: start_date
+              label: Start Date
+              type: date
+              required: true
+              defaultValue: '{{today}}'
+            - name: end_date
+              label: Target End Date
+              type: date
+              required: true
+              help_text: Expected completion date
+            - name: priority
+              label: Priority
+              type: select
+              required: true
+              options:
+                - label: Low
+                  value: low
+                - label: Medium
+                  value: medium
+                - label: High
+                  value: high
+                - label: Critical
+                  value: critical
+              defaultValue: medium
+            - name: milestones
+              label: Key Milestones
+              type: grid
+              help_text: Define important project milestones
+              config:
+                columns:
+                  - name: name
+                    label: Milestone
+                    type: text
+                  - name: date
+                    label: Target Date
+                    type: date
+                  - name: description
+                    label: Description
+                    type: text
+                allow_add: true
+                allow_delete: true
+  
+  # Step 4: Review & Create
+  - id: step_review
+    type: container
+    label: Review & Create
+    description: Review your project details before creating
+    config:
+      step: 4
+      icon: check-square
+    components:
+      - id: review_summary
+        type: detail_view
+        label: Project Summary
+        config:
+          mode: readonly
+          sections:
+            - label: Basic Information
+              fields: ['name', 'description', 'category']
+            - label: Team
+              fields: ['owner', 'team_members', 'budget', 'department']
+            - label: Timeline
+              fields: ['start_date', 'end_date', 'priority']
+      
+      - id: terms_checkbox
+        type: container
+        components:
+          - id: accept_terms
+            type: boolean
+            label: I confirm that all information is correct
+            required: true
+
+# Wizard navigation actions
+actions:
+  next_step:
+    type: custom
+    handler: validateAndProceed
+  
+  previous_step:
+    type: custom
+    handler: goToPreviousStep
+  
+  submit_wizard:
+    type: run_action
+    object: projects
+    action: create
+    success_message: Project created successfully!
+    on_error: show_modal
+  
+  save_draft:
+    type: custom
+    handler: saveDraft
+    success_message: Draft saved
+
+# Page state to track wizard progress
+state:
+  initial:
+    current_step: 1
+    completed_steps: []
+    form_data:
+      name: ''
+      description: ''
+      category: ''
+      owner: null
+      team_members: []
+      budget: 0
+      department: ''
+      start_date: null
+      end_date: null
+      priority: medium
+      milestones: []
+  persist: true
+  storage_key: project_wizard_draft
+
+# Page styling
+style:
+  max_width: 800px
+  margin: 0 auto
+  padding: 40px 20px
+
+# AI context
+ai_context:
+  intent: Guide users through project creation with validation
+  persona: Project managers and team leads
+  tasks:
+    - Create new projects step by step
+    - Validate input at each stage
+    - Review before submission
+    - Save drafts for later