Convert basic examples to proper package with typecheck support

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Author: Copilot

examples/README.md

@@ -60,10 +60,13 @@ pnpm --filter @objectstack/example-todo typecheck
 
 ### Use Basic Examples
 
-The [basic/](./basic/) examples are TypeScript files that demonstrate protocols:
+The [basic/](./basic/) examples are now a proper package for type checking:
 
 ```bash
-# Type check a basic example (requires @objectstack/spec built)
+# Type check basic examples
+pnpm --filter @objectstack/example-basic typecheck
+
+# Run a specific example with tsx
 npx tsx examples/basic/stack-definition-example.ts
 ```
 

examples/basic/README.md

@@ -1,6 +1,41 @@
 # Basic Protocol Examples
 
-This directory contains standalone examples demonstrating core ObjectStack protocols and features.
+A standalone package containing comprehensive examples demonstrating core ObjectStack protocols and features.
+
+## 📦 Package Information
+
+- **Package**: `@objectstack/example-basic`
+- **Type**: Demonstration/Reference
+- **Status**: Standalone examples with type checking
+
+## 🚀 Usage
+
+### Build and Type Check
+
+```bash
+# From monorepo root
+pnpm install
+
+# Build the spec package first
+pnpm --filter @objectstack/spec build
+
+# Type check the examples
+pnpm --filter @objectstack/example-basic typecheck
+
+# Or run directly with tsx
+npx tsx examples/basic/stack-definition-example.ts
+```
+
+### Running Examples
+
+Each example file can be run independently with `tsx`:
+
+```bash
+# Run a specific example
+npx tsx examples/basic/ai-rag-example.ts
+
+# Or uncomment the demonstration function calls at the end of each file
+```
 
 ## 📚 Examples
 
@@ -110,20 +145,20 @@ Shows automation capabilities in ObjectStack:
 
 ## 🎯 Usage
 
-These examples are TypeScript files that can be:
+These examples are TypeScript files in a proper package that can be:
 
-1. **Imported as references:**
-   ```typescript
-   import { taskManagementStack } from './examples/basic/stack-definition-example';
+1. **Type checked:**
+   ```bash
+   pnpm --filter @objectstack/example-basic typecheck
    ```
 
-2. **Run directly (if configured):**
+2. **Run directly:**
    ```bash
-   tsx examples/basic/stack-definition-example.ts
+   npx tsx examples/basic/stack-definition-example.ts
    ```
 
-3. **Used as templates:**
-   Copy and modify for your own projects
+3. **Used as references:**
+   Import types and patterns in your own projects
 
 ## 🔗 Related Resources
 

examples/basic/ai-rag-example.ts

@@ -379,8 +379,8 @@ export const advancedRAGPatterns = {
 // Usage
 // ============================================================================
 
-// Demonstrate RAG usage
-demonstrateRAGUsage();
+// Demonstrate RAG usage (uncomment to run)
+// demonstrateRAGUsage();
 
 // Export all examples
 export default {

examples/basic/api-discovery-example.ts

@@ -439,15 +439,13 @@ When helping users, respect these capabilities and limits.`;
 // Usage Examples
 // ============================================================================
 
-// Example: Initialize adaptive client
-const client = new AdaptiveClient();
+// Example: Initialize adaptive client (uncomment to run)
+// const client = new AdaptiveClient();
 // await client.initialize('https://api.example.com');
+// if (client.hasFeature('data', 'vectorSearch')) {
+//   console.log('✅ Vector search is available - AI/RAG features enabled');
+// }
 
-// Example: Check features before using them
-if (client.hasFeature('data', 'vectorSearch')) {
-  console.log('✅ Vector search is available - AI/RAG features enabled');
-}
-
-// Example: Generate AI prompt
-const systemPrompt = generateSystemPromptFromDiscovery(fullDiscoveryResponse);
-console.log('AI System Prompt:\n', systemPrompt);
+// Example: Generate AI prompt (uncomment to run)
+// const systemPrompt = generateSystemPromptFromDiscovery(fullDiscoveryResponse);
+// console.log('AI System Prompt:\n', systemPrompt);

examples/basic/auth-permission-example.ts

@@ -552,8 +552,8 @@ export function demonstratePermissions() {
   console.log('- Can access own opportunity:', checker.canAccessRecord(user, 'opportunity', opportunity));
 }
 
-// Run demonstration
-demonstratePermissions();
+// Run demonstration (uncomment to run)
+// demonstratePermissions();
 
 // Export all examples
 export default {

examples/basic/automation-example.ts

@@ -704,8 +704,8 @@ export function demonstrateAutomation() {
   console.log(`   - Source: ${dailyLeadImportETL.extract?.source.type}`);
 }
 
-// Run demonstration
-demonstrateAutomation();
+// Run demonstration (uncomment to run)
+// demonstrateAutomation();
 
 // Export all examples
 export default {

examples/basic/capabilities-example.ts

@@ -393,24 +393,24 @@ export function getEnabledCapabilities(
 }
 
 // ============================================================================
-// Usage Examples
+// Usage Examples (uncomment to run)
 // ============================================================================
 
 // Example: Check if vector search is available
-if (hasCapability(productionCapabilities, 'data', 'vectorSearch')) {
-  console.log('✅ Vector search is available for RAG workflows');
-}
+// if (hasCapability(productionCapabilities, 'data', 'vectorSearch')) {
+//   console.log('✅ Vector search is available for RAG workflows');
+// }
 
 // Example: Get all enabled ObjectUI capabilities
-const uiFeatures = getEnabledCapabilities(productionCapabilities, 'ui');
-console.log('Enabled UI features:', uiFeatures);
+// const uiFeatures = getEnabledCapabilities(productionCapabilities, 'ui');
+// console.log('Enabled UI features:', uiFeatures);
 
 // Example: Compare capabilities between environments
-console.log(
-  'Production has GraphQL?',
-  hasCapability(productionCapabilities, 'system', 'graphqlApi')
-);
-console.log(
-  'Development has GraphQL?',
-  hasCapability(developmentCapabilities, 'system', 'graphqlApi')
-);
+// console.log(
+//   'Production has GraphQL?',
+//   hasCapability(productionCapabilities, 'system', 'graphqlApi')
+// );
+// console.log(
+//   'Development has GraphQL?',
+//   hasCapability(developmentCapabilities, 'system', 'graphqlApi')
+// );

examples/basic/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@objectstack/example-basic",
+  "version": "0.6.1",
+  "description": "Basic protocol examples demonstrating ObjectStack core features",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc --noEmit",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@objectstack/spec": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "tsx": "^4.21.0"
+  }
+}

examples/basic/stack-definition-example.ts

@@ -489,6 +489,9 @@ export function demonstrateStackUsage() {
   }
 }
 
+// Run demonstration (uncomment to run)
+// demonstrateStackUsage();
+
 // ============================================================================
 // Export for use
 // ============================================================================

examples/basic/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": ".",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": false,
+    "noEmit": true
+  },
+  "include": [
+    "*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}