@elaraai/east 0.0.1-beta.37 → 0.0.1-beta.38

package/dist/src/example.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+import type { CallableFunctionExpr } from "./expr/function.js";
+import type { CallableAsyncFunctionExpr } from "./expr/asyncfunction.js";
+import type { SubtypeExprOrValue } from "./expr/types.js";
+import { type EastType } from "./types.js";
+/**
+ * Defines an East example — an East function expression with metadata.
+ *
+ * The `fn` field is an `East.function()` — the exact same thing users write.
+ * Tests call it with `inputs` and assert the result equals `returns`.
+ * The index generator serializes `fn.toString()` for agent context.
+ *
+ * @example
+ * ```ts
+ * import { East, ArrayType, IntegerType } from "@elaraai/east";
+ * import { example } from "@elaraai/east";
+ *
+ * export const pushToArray = example({
+ *     keywords: ["array", "push", "pushLast", "mutation"],
+ *     description: "Push items to an array using pushLast",
+ *     fn: East.function([], ArrayType(IntegerType), ($) => {
+ *         const a = $.let([], ArrayType(IntegerType));
+ *         $(a.pushLast(1n));
+ *         $(a.pushLast(2n));
+ *         return a;
+ *     }),
+ *     inputs: [],
+ *     returns: [1n, 2n],
+ * });
+ *
+ * export const filterArray = example({
+ *     keywords: ["array", "filter"],
+ *     description: "Filter array elements greater than a threshold",
+ *     fn: East.function([ArrayType(IntegerType), IntegerType], ArrayType(IntegerType), ($, items, threshold) => {
+ *         return items.filter(($, x) => x.greater(threshold));
+ *     }),
+ *     inputs: [[1n, 5n, 3n, 8n, 2n], 3n],
+ *     returns: [5n, 8n],
+ * });
+ * ```
+ */
+export interface ExampleDef<I extends EastType[] = EastType[], O = any> {
+    /** Searchable keywords: API names, type names, concepts */
+    keywords: string[];
+    /** Human-readable description of what this example demonstrates */
+    description: string;
+    /** The East function expression — an East.function() or East.asyncFunction() call */
+    fn: CallableFunctionExpr<I, O> | CallableAsyncFunctionExpr<I, O>;
+    /** Default input values for testing */
+    inputs: {
+        [K in keyof I]: SubtypeExprOrValue<I[K]>;
+    };
+    /** Expected return value when called with inputs */
+    returns?: SubtypeExprOrValue<O>;
+}
+/**
+ * Creates an example definition. Identity function that provides
+ * type checking and marks the export for index generation.
+ */
+export declare function example<const I extends any[], O>(def: ExampleDef<I, O>): ExampleDef<I, O>;
+//# sourceMappingURL=example.d.ts.map

package/dist/src/example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,QAAQ,EAAE,GAAG,QAAQ,EAAE,EAAE,CAAC,GAAG,GAAG;IAClE,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,qFAAqF;IACrF,EAAE,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjE,uCAAuC;IACvC,MAAM,EAAE;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE,CAAC;IACrD,oDAAoD;IACpD,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAC5C,GAAG,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GACtB,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAElB"}

package/dist/src/example.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+import {} from "./types.js";
+/**
+ * Creates an example definition. Identity function that provides
+ * type checking and marks the export for index generation.
+ */
+export function example(def) {
+    return def;
+}
+//# sourceMappingURL=example.js.map

package/dist/src/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAiB,MAAM,YAAY,CAAC;AAmD3C;;;GAGG;AACH,MAAM,UAAU,OAAO,CACnB,GAAqB;IAErB,OAAO,GAAG,CAAC;AACf,CAAC"}

package/dist/src/index.d.ts

@@ -20,4 +20,5 @@ export * from './compile.js';
 export * from './default.js';
 export * from './eastir.js';
 export * from './patch/index.js';
+export * from './example.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC"}

package/dist/src/index.js

@@ -20,4 +20,5 @@ export * from './compile.js';
 export * from './default.js';
 export * from './eastir.js';
 export * from './patch/index.js';
+export * from './example.js';
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elaraai/east",
-  "version": "0.0.1-beta.37",
+  "version": "0.0.1-beta.38",
   "description": "East is a simple and fast language used by Elara AI Pty Ltd.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",