Installation

npm install @directive-run/core

pnpm add @directive-run/core

yarn add @directive-run/core

// Core API – modules, systems, and type builders
import { createModule, createSystem, t } from '@directive-run/core';

// React adapter – reactive hooks for facts and derivations
import { useFact, useDerived, useDispatch } from '@directive-run/react';

// Plugins – extend the system with logging, devtools, or persistence
import { loggingPlugin, devtoolsPlugin, persistencePlugin } from '@directive-run/core/plugins';

// Testing utilities – mock resolvers and control async timing
import { createTestSystem, createMockResolver, flushMicrotasks } from '@directive-run/core/testing';

{
  "compilerOptions": {
    "strict": true,                  // Required for full type inference
    "moduleResolution": "bundler",   // Enables scoped package resolution
    "target": "ES2022"               // Proxy and WeakRef support
  }
}

import { createSystem } from '@directive-run/core';
import { useFact, useDerived } from '@directive-run/react';
import { userModule } from './modules/user';

// Create and start the system at module scope
const system = createSystem({ module: userModule });
system.start();

// No provider needed – pass the system directly to hooks
function App() {
  const displayName = useDerived(system, "displayName");

  return <div>Hello, {displayName}</div>;
}

<script setup>
import { createSystem } from '@directive-run/core';
import { useFact } from '@directive-run/vue';
import { userModule } from './modules/user';

// Create the system
const system = createSystem({ module: userModule });
system.start();

// Pass system explicitly to hooks
const name = useFact(system, 'name');
</script>

<script>
  import { createSystem } from '@directive-run/core';
  import { useFact } from '@directive-run/svelte';
  import { userModule } from './modules/user';

  // Create the system
  const system = createSystem({ module: userModule });
  system.start();

  // Pass system explicitly to hooks
  const name = useFact(system, 'name');
</script>

import { createSystem } from '@directive-run/core';
import { userModule } from './modules/user';

const system = createSystem({ module: userModule });
system.start();

// Subscribe to derivation changes with a callback
system.watch("displayName", (newValue, prevValue) => {
  console.log('Display name changed:', newValue);
});

// Setting a fact triggers constraints and resolvers automatically
system.facts.userId = 123;

// Wait for all async resolvers to finish before reading results
await system.settle();

pnpm add @directive-run/core @directive-run/ai

import { createAgentStack } from '@directive-run/ai';
import { createOpenAIRunner } from '@directive-run/ai/openai';

const runner = createOpenAIRunner({ apiKey: process.env.OPENAI_API_KEY! });
const stack = createAgentStack({ runner, agents: { assistant: { instructions: "You are helpful." } } });

import { createAgentStack } from '@directive-run/ai';
import { createAnthropicRunner } from '@directive-run/ai/anthropic';

const runner = createAnthropicRunner({ apiKey: process.env.ANTHROPIC_API_KEY! });

import { createAgentStack } from '@directive-run/ai';
import { createOllamaRunner } from '@directive-run/ai/ollama';

const runner = createOllamaRunner(); // defaults to localhost:11434

import { createSystem } from '@directive-run/core';
import { devtoolsPlugin, loggingPlugin } from '@directive-run/core/plugins';
import { userModule } from './modules/user';

const system = createSystem({
  module: userModule,

  // Stack plugins for visibility into every state change
  plugins: [
    loggingPlugin({ level: 'debug' }),
    devtoolsPlugin(),
  ],

  // Enable time-travel to step through state history
  debug: {
    timeTravel: true,
    maxSnapshots: 100,
  },
});

system.start();

<script type="module">
  // Import directly from a CDN – no build step needed
  import { createModule, createSystem, t } from 'https://esm.sh/@directive-run/core';

  // Define a minimal counter module
  const counterModule = createModule("counter", {
    schema: {
      facts: { count: t.number() },
      derivations: {},
      events: {},
      requirements: {},
    },
    init: (facts) => { facts.count = 0; },
  });

  // Wire it up and start
  const system = createSystem({ module: counterModule });
  system.start();

  // Mutate facts directly – the proxy tracks the change
  system.facts.count++;
  console.log(system.facts.count); // 1
</script>

{
  "compilerOptions": {
    "moduleResolution": "bundler"
  }
}

// Pulls in everything, defeating tree-shaking
import * as Directive from '@directive-run/core'; // Don't do this

// Import only what you need – unused exports are removed at build time
import { createModule, createSystem } from '@directive-run/core';