flowscript-core 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,96 @@
+/**
+ * FlowScript Type Definitions
+ *
+ * Defines the type system for FlowScript tokens and IR (Intermediate Representation).
+ * Types match the formal specification in /spec/ir.schema.json
+ */
+export declare enum TokenType {
+    ARROW_RIGHT = "->",
+    ARROW_LEFT = "<-",
+    ARROW_BI = "<->",
+    ARROW_TEMPORAL = "=>",
+    TENSION = "><",
+    EQUALS = "=",
+    NOT_EQUALS = "!=",
+    DECIDED = "[decided]",
+    EXPLORING = "[exploring]",
+    BLOCKED = "[blocked]",
+    PARKING = "[parking]",
+    THOUGHT = "thought:",
+    QUESTION = "?",
+    CHECKMARK = "\u2713",
+    ACTION = "action:",
+    URGENT = "!",
+    POSITIVE = "++",
+    CONFIDENT = "*",
+    UNCERTAIN = "~",
+    BRACE_OPEN = "{",
+    BRACE_CLOSE = "}",
+    ALTERNATIVE = "||",
+    TEXT = "TEXT",
+    NEWLINE = "NEWLINE",
+    EOF = "EOF"
+}
+export interface Token {
+    type: TokenType;
+    value: string;
+    line: number;
+    column: number;
+}
+export interface Provenance {
+    source_file: string;
+    line_number: number;
+    timestamp: string;
+    author?: {
+        agent: string;
+        role: 'human' | 'ai';
+    };
+}
+export type NodeType = 'statement' | 'question' | 'thought' | 'action' | 'block' | 'decision' | 'blocker' | 'insight' | 'completion' | 'alternative' | 'exploring' | 'parking';
+export interface Node {
+    id: string;
+    type: NodeType;
+    content: string;
+    provenance: Provenance;
+    children?: string[];
+    modifiers?: string[];
+    ext?: Record<string, unknown>;
+}
+export type RelationType = 'causes' | 'temporal' | 'derives_from' | 'bidirectional' | 'tension' | 'equivalent' | 'different' | 'alternative' | 'alternative_worse' | 'alternative_better';
+export interface Relationship {
+    id: string;
+    type: RelationType;
+    source: string;
+    target: string;
+    axis_label?: string | null;
+    feedback?: boolean;
+    provenance: Provenance;
+    ext?: Record<string, unknown>;
+}
+export type StateType = 'decided' | 'exploring' | 'blocked' | 'parking';
+export interface State {
+    id: string;
+    type: StateType;
+    node_id: string;
+    fields: Record<string, string>;
+    provenance: Provenance;
+}
+export interface GraphInvariants {
+    causal_acyclic?: boolean;
+    all_nodes_reachable?: boolean;
+    tension_axes_labeled?: boolean;
+    state_fields_present?: boolean;
+}
+export interface IR {
+    version: '1.0.0';
+    nodes: Node[];
+    relationships: Relationship[];
+    states: State[];
+    invariants: GraphInvariants;
+    metadata?: {
+        source_files?: string[];
+        parsed_at?: string;
+        parser?: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,oBAAY,SAAS;IAEnB,WAAW,OAAO;IAClB,UAAU,OAAO;IACjB,QAAQ,QAAQ;IAChB,cAAc,OAAO;IACrB,OAAO,OAAO;IAGd,MAAM,MAAM;IACZ,UAAU,OAAO;IAGjB,OAAO,cAAc;IACrB,SAAS,gBAAgB;IACzB,OAAO,cAAc;IACrB,OAAO,cAAc;IAGrB,OAAO,aAAa;IACpB,QAAQ,MAAM;IACd,SAAS,WAAM;IAGf,MAAM,YAAY;IAGlB,MAAM,MAAM;IACZ,QAAQ,OAAO;IACf,SAAS,MAAM;IACf,SAAS,MAAM;IAGf,UAAU,MAAM;IAChB,WAAW,MAAM;IAGjB,WAAW,OAAO;IAGlB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAMD,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;KACtB,CAAC;CACH;AAED,MAAM,MAAM,QAAQ,GAChB,WAAW,GACX,UAAU,GACV,SAAS,GACT,QAAQ,GACR,OAAO,GACP,UAAU,GACV,SAAS,GACT,SAAS,GACT,YAAY,GACZ,aAAa,GACb,WAAW,GACX,SAAS,CAAC;AAEd,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,UAAU,GACV,cAAc,GACd,eAAe,GACf,SAAS,GACT,YAAY,GACZ,WAAW,GACX,aAAa,GACb,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,WAAW,GACX,SAAS,GACT,SAAS,CAAC;AAEd,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,EAAE;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,UAAU,EAAE,eAAe,CAAC;IAC5B,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH"}

package/dist/types.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * FlowScript Type Definitions
+ *
+ * Defines the type system for FlowScript tokens and IR (Intermediate Representation).
+ * Types match the formal specification in /spec/ir.schema.json
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenType = void 0;
+// ============================================================================
+// Token Types (for tokenizer)
+// ============================================================================
+var TokenType;
+(function (TokenType) {
+    // Core Relations
+    TokenType["ARROW_RIGHT"] = "->";
+    TokenType["ARROW_LEFT"] = "<-";
+    TokenType["ARROW_BI"] = "<->";
+    TokenType["ARROW_TEMPORAL"] = "=>";
+    TokenType["TENSION"] = "><";
+    // Definition
+    TokenType["EQUALS"] = "=";
+    TokenType["NOT_EQUALS"] = "!=";
+    // States
+    TokenType["DECIDED"] = "[decided]";
+    TokenType["EXPLORING"] = "[exploring]";
+    TokenType["BLOCKED"] = "[blocked]";
+    TokenType["PARKING"] = "[parking]";
+    // Insights & Questions
+    TokenType["THOUGHT"] = "thought:";
+    TokenType["QUESTION"] = "?";
+    TokenType["CHECKMARK"] = "\u2713";
+    // Commands
+    TokenType["ACTION"] = "action:";
+    // Modifiers
+    TokenType["URGENT"] = "!";
+    TokenType["POSITIVE"] = "++";
+    TokenType["CONFIDENT"] = "*";
+    TokenType["UNCERTAIN"] = "~";
+    // Structure
+    TokenType["BRACE_OPEN"] = "{";
+    TokenType["BRACE_CLOSE"] = "}";
+    // Alternative
+    TokenType["ALTERNATIVE"] = "||";
+    // Special
+    TokenType["TEXT"] = "TEXT";
+    TokenType["NEWLINE"] = "NEWLINE";
+    TokenType["EOF"] = "EOF";
+})(TokenType || (exports.TokenType = TokenType = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+EAA+E;AAC/E,8BAA8B;AAC9B,+EAA+E;AAE/E,IAAY,SA2CX;AA3CD,WAAY,SAAS;IACnB,iBAAiB;IACjB,+BAAkB,CAAA;IAClB,8BAAiB,CAAA;IACjB,6BAAgB,CAAA;IAChB,kCAAqB,CAAA;IACrB,2BAAc,CAAA;IAEd,aAAa;IACb,yBAAY,CAAA;IACZ,8BAAiB,CAAA;IAEjB,SAAS;IACT,kCAAqB,CAAA;IACrB,sCAAyB,CAAA;IACzB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IAErB,uBAAuB;IACvB,iCAAoB,CAAA;IACpB,2BAAc,CAAA;IACd,iCAAe,CAAA;IAEf,WAAW;IACX,+BAAkB,CAAA;IAElB,YAAY;IACZ,yBAAY,CAAA;IACZ,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IAEf,YAAY;IACZ,6BAAgB,CAAA;IAChB,8BAAiB,CAAA;IAEjB,cAAc;IACd,+BAAkB,CAAA;IAElB,UAAU;IACV,0BAAa,CAAA;IACb,gCAAmB,CAAA;IACnB,wBAAW,CAAA;AACb,CAAC,EA3CW,SAAS,yBAAT,SAAS,QA2CpB"}

package/dist/validate.d.ts

@@ -0,0 +1,18 @@
+/**
+ * FlowScript IR Validation
+ *
+ * Validates IR JSON against the canonical schema (spec/ir.schema.json)
+ */
+import { IR } from './types';
+export interface ValidationResult {
+    valid: boolean;
+    errors: any[];
+}
+/**
+ * Validate IR against the canonical schema
+ *
+ * @param ir - The IR object to validate
+ * @returns Validation result with errors if invalid
+ */
+export declare function validateIR(ir: IR): ValidationResult;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAE7B,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,GAAG,EAAE,CAAC;CACf;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,EAAE,GAAG,gBAAgB,CAgBnD"}

package/dist/validate.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * FlowScript IR Validation
+ *
+ * Validates IR JSON against the canonical schema (spec/ir.schema.json)
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateIR = validateIR;
+const ajv_1 = __importDefault(require("ajv"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Validate IR against the canonical schema
+ *
+ * @param ir - The IR object to validate
+ * @returns Validation result with errors if invalid
+ */
+function validateIR(ir) {
+    // Load schema
+    const schemaPath = path.join(__dirname, '../spec/ir.schema.json');
+    const schema = JSON.parse(fs.readFileSync(schemaPath, 'utf-8'));
+    // Create validator
+    const ajv = new ajv_1.default({ allErrors: true, strict: false });
+    const validate = ajv.compile(schema);
+    // Validate
+    const valid = validate(ir);
+    return {
+        valid,
+        errors: validate.errors || []
+    };
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBH,gCAgBC;AAhCD,8CAAsB;AACtB,uCAAyB;AACzB,2CAA6B;AAQ7B;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,EAAM;IAC/B,cAAc;IACd,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;IAClE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAEhE,mBAAmB;IACnB,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC,WAAW;IACX,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAY,CAAC;IAEtC,OAAO;QACL,KAAK;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM,IAAI,EAAE;KAC9B,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "flowscript-core",
+  "version": "1.0.0",
+  "description": "Decision intelligence for AI agents. Typed semantic queries over structured reasoning.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "bin",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "flowscript": "./bin/flowscript"
+  },
+  "scripts": {
+    "build": "tsc && cp src/grammar.ohm dist/grammar.ohm",
+    "test": "NODE_OPTIONS='--max-old-space-size=2048' jest",
+    "test:watch": "NODE_OPTIONS='--max-old-space-size=2048' jest --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "keywords": [
+    "flowscript",
+    "decision-intelligence",
+    "agent-memory",
+    "semantic-queries",
+    "ai-agents",
+    "query-engine",
+    "cognitive-architecture",
+    "llm-memory",
+    "agent-tools",
+    "reasoning",
+    "explainability",
+    "audit-trail"
+  ],
+  "author": "Phillip Clapham <me@phillipclapham.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/phillipclapham/flowscript.git"
+  },
+  "homepage": "https://flowscript.org",
+  "bugs": {
+    "url": "https://github.com/phillipclapham/flowscript/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "commander": "^11.0.0",
+    "ohm-js": "^17.2.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.2.0"
+  }
+}