@elaraai/east-node-std 0.0.1-beta.0 → 0.0.1-beta.10

package/dist/test.d.ts

@@ -1,40 +1,11 @@
-import { Expr, NullType, StringType, BlockBuilder, type SubtypeExprOrValue, type ExprType, type EastType } from "@elaraai/east";
-import type { PlatformFunction, PlatformFunctionDef } from "@elaraai/east/internal";
+import { Expr, NullType, StringType, type SubtypeExprOrValue } from "@elaraai/east";
+import type { BlockBuilder, PlatformFunction, TypeSymbol } from "@elaraai/east/internal";
 /**
- * Signals that a test assertion passed.
+ * Creates a test platform that uses Node.js assertions.
  *
- * This platform function is used internally by East test assertions to indicate
- * successful validation. When executed in Node.js, it performs no action (the test
- * continues normally). Other platform implementations may log or track passes.
- *
- * This function is primarily used within the {@link Test} assertion helpers rather
- * than being called directly in test code.
- *
- * @returns `null` - Has no meaningful return value
- *
- * @example
- * ```ts
- * import { East, NullType } from "@elaraai/east";
- * import { Test } from "@elaraai/east-node-std";
- *
- * // Used internally by Test assertions
- * const myTest = East.function([], NullType, $ => {
- *     // Test.equal internally calls testPass when the assertion succeeds
- *     $(Test.equal(East.value(42n), 42n));
- * });
- *
- * const compiled = East.compile(myTest.toIR(), Test.Implementation);
- * compiled();  // Test passes silently
- * ```
- *
- * @remarks
- * - Does not throw or produce output in Node.js implementation
- * - Used by all {@link Test} assertion methods to signal success
- * - Can be called directly for custom assertion logic
+ * @returns A platform object with `testPass`, `testFail`, `test`, and `describe` functions
  */
-export declare const testPass: PlatformFunctionDef<[], typeof NullType>;
-export declare const NodeTestTypes: any[];
-export declare const NodeTest: PlatformFunction[];
+export declare const TestImpl: PlatformFunction[];
 /**
  * Configuration options for East test suites.
  */
@@ -63,111 +34,53 @@ export interface DescribeEastOptions {
      * Runs even if the test fails.
      */
     afterEach?: ($: BlockBuilder<NullType>) => void;
+    /**
+     * If true (and if process.env.EXPORT_TEST_IR is a valid path), only exports the test IR without running the tests.
+     * Useful for generating test IR for other East implementations.
+     * Defaults to false.
+     * @default false
+     */
+    exportOnly?: boolean;
 }
 /**
- * Wrapper around Node.js `describe` that also exports test IR for cross-platform testing.
+ * Defines and runs an East test suite using platform functions.
  *
- * This function behaves exactly like Node.js `describe` - it runs all the tests normally.
- * Additionally, it creates a single East function that runs all tests in sequence,
- * making it easy to export the entire test suite for running in other East implementations.
+ * This creates a single East function that calls `describe` and `test` platform functions.
+ * The entire suite can be exported as IR and run on any East implementation that provides
+ * the test platform (testPass, testFail, test, describe).
  *
- * Supports lifecycle hooks (beforeAll, afterAll, beforeEach, afterEach) as East functions
- * to properly set up and tear down resources like database connections.
+ * When the `EXPORT_TEST_IR` environment variable is set to a directory path, the IR for
+ * each test suite is exported to `<path>/<suite_name>.json`.
  *
  * @param suiteName - The name of the test suite
  * @param builder - A function that receives a `test` function for defining tests
- * @param options - Configuration options including platform functions and lifecycle hooks
  *
  * @example
  * ```ts
- * // Basic usage with platform functions
  * describeEast("Array tests", (test) => {
  *   test("addition", $ => {
- *     $(Test.equal(East.value(1n).add(1n), 2n));
+ *     $(assertEast.equal(East.value(1n).add(1n), 2n));
  *   });
- * }, { platformFns: [] });
- * ```
- *
- * @example
- * ```ts
- * // With database cleanup hooks
- * import { SQL } from "@elaraai/east-node-io";
- *
- * describeEast("Database tests", (test) => {
- *   test("query users", $ => {
- *     const conn = $.let(SQL.Postgres.connect(config));
- *     const result = $.let(SQL.Postgres.query(conn, "SELECT * FROM users", []));
- *     $(Test.equal(result.rows.length(), 2n));
+ *   test("subtraction", $ => {
+ *     $(assertEast.equal(East.value(2n).subtract(1n), 1n));
  *   });
- * }, {
- *   platformFns: SQL.Postgres.Implementation,
- *   afterEach: $ => {
- *     // Close connections even if test fails
- *     const conn = $.let(SQL.Postgres.connect(config));
- *     $(SQL.Postgres.close(conn));
- *   }
  * });
  * ```
- */
-export declare function describeEast(suiteName: string, builder: (test: (name: string, body: ($: BlockBuilder<NullType>) => void) => void) => void, options?: DescribeEastOptions): void;
-/**
- * East assertion functions that match Node.js assert API naming.
  *
- * These functions generate East expressions that perform runtime assertions
- * using platform functions, enabling testing of East code.
+ * @example
+ * ```bash
+ * # Export test IR to a directory
+ * EXPORT_TEST_IR=./test-ir npm test
+ * ```
  */
+export declare function describeEast(suiteName: string, builder: (test: (name: string, body: ($: BlockBuilder<NullType>) => void) => void) => void, options?: DescribeEastOptions): Promise<null> | undefined;
 /**
  * East assertion functions that match Node.js assert API naming.
  *
  * These functions generate East expressions that perform runtime assertions
  * using platform functions, enabling testing of East code.
  */
-export declare const Test: {
-    /**
-     * Platform function that signals a test assertion passed.
-     *
-     * Used internally by assertion methods to indicate successful validation.
-     * Does nothing in Node.js implementation - test continues normally.
-     *
-     * @returns An East expression that returns `null`
-     *
-     * @example
-     * ```ts
-     * import { East, NullType } from "@elaraai/east";
-     * import { Test } from "@elaraai/east-node-std";
-     *
-     * const customAssertion = East.function([], NullType, $ => {
-     *     return East.value(true).ifElse(
-     *         _ => Test.pass(),
-     *         _ => Test.fail("Condition was false")
-     *     );
-     * });
-     * ```
-     */
-    pass: PlatformFunctionDef<[], NullType>;
-    /**
-     * Platform function that signals a test assertion failed.
-     *
-     * Used internally by assertion methods to indicate validation failures.
-     * Throws an assertion error in Node.js implementation - test fails immediately.
-     *
-     * @param message - Error message describing the failure
-     * @returns An East expression that returns `null` (never actually returns - throws)
-     *
-     * @example
-     * ```ts
-     * import { East, StringType, NullType } from "@elaraai/east";
-     * import { Test } from "@elaraai/east-node-std";
-     *
-     * const validateRange = East.function([IntegerType], NullType, ($, value) => {
-     *     return value.between(0n, 100n).ifElse(
-     *         _ => Test.pass(),
-     *         _ => Test.fail("Value must be between 0 and 100")
-     *     );
-     * });
-     * ```
-     */
-    fail: PlatformFunctionDef<[StringType], NullType>;
+export declare const Assert: {
     /**
      * Asserts that two values are the same reference (meaning if one is mutated, the other reflects the change - and they are always equal).
      *
@@ -176,7 +89,7 @@ export declare const Test: {
      * @param expected - The expected value to compare against
      * @returns An East expression that performs the equality check
      */
-    is<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    is<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that two values are equal.
      *
@@ -185,7 +98,7 @@ export declare const Test: {
      * @param expected - The expected value to compare against
      * @returns An East expression that performs the equality check
      */
-    equal<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    equal<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that two values are not equal.
      *
@@ -194,7 +107,7 @@ export declare const Test: {
      * @param expected - The value that should not be equal
      * @returns An East expression that performs the inequality check
      */
-    notEqual<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    notEqual<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that actual is less than expected.
      *
@@ -203,7 +116,7 @@ export declare const Test: {
      * @param expected - The value that actual should be less than
      * @returns An East expression that performs the less-than check
      */
-    less<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    less<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that actual is less than or equal to expected.
      *
@@ -212,7 +125,7 @@ export declare const Test: {
      * @param expected - The value that actual should be less than or equal to
      * @returns An East expression that performs the less-than-or-equal check
      */
-    lessEqual<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    lessEqual<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that actual is greater than expected.
      *
@@ -221,7 +134,7 @@ export declare const Test: {
      * @param expected - The value that actual should be greater than
      * @returns An East expression that performs the greater-than check
      */
-    greater<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    greater<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that actual is greater than or equal to expected.
      *
@@ -230,7 +143,7 @@ export declare const Test: {
      * @param expected - The value that actual should be greater than or equal to
      * @returns An East expression that performs the greater-than-or-equal check
      */
-    greaterEqual<E extends EastType>(actual: Expr<E>, expected: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    greaterEqual<E extends Expr>(actual: E, expected: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that actual is between min and max (inclusive).
      *
@@ -240,7 +153,7 @@ export declare const Test: {
      * @param max - The maximum value (inclusive)
      * @returns An East expression that performs the range check
      */
-    between<E extends EastType>(actual: Expr<E>, min: SubtypeExprOrValue<NoInfer<E>>, max: SubtypeExprOrValue<NoInfer<E>>): ExprType<NullType>;
+    between<E extends Expr>(actual: E, min: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>, max: SubtypeExprOrValue<NoInfer<E>[TypeSymbol]>): import("@elaraai/east").NullExpr;
     /**
      * Asserts that an expression throws an error.
      *
@@ -248,6 +161,13 @@ export declare const Test: {
      * @param pattern - Optional regex pattern to match against the error message
      * @returns An East expression that verifies an error is thrown
      */
-    throws(fn: Expr<any>, pattern?: RegExp): ExprType<NullType>;
+    throws(fn: Expr<any>, pattern?: RegExp): import("@elaraai/east").NullExpr;
+    /**
+     * Fails a test with the given message.
+     *
+     * @param message
+     * @returns An East expression that unconditionally fails the test
+     */
+    fail(message: SubtypeExprOrValue<StringType>): import("@elaraai/east").NullExpr;
 };
 //# sourceMappingURL=test.d.ts.map

package/dist/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,IAAI,EAAgB,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAgB,MAAM,eAAe,CAAC;AAClK,OAAO,KAAK,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAIpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,QAAQ,EAAE,mBAAmB,CAAC,EAAE,EAAE,OAAO,QAAQ,CAA2C,CAAC;AAwD1G,eAAO,MAAM,aAAa,EAAE,GAAG,EAK9B,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,gBAAgB,EAmBtC,CAAC;AAGF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEjC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,YAAY,CACxB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,KAAK,IAAI,KAAK,IAAI,EAC1F,OAAO,GAAE,mBAAwB,QAgCpC;AAED;;;;;GAKG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,IAAI;IACb;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;OAOG;OACA,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgBrG;;;;;;;OAOG;UACG,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgBxG;;;;;;;OAOG;aACM,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgB3G;;;;;;;OAOG;SACE,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgBvG;;;;;;;OAOG;cACO,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgB5G;;;;;;;OAOG;YACK,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgB1G;;;;;;;OAOG;iBACU,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgB/G;;;;;;;;OAQG;YACK,CAAC,SAAS,QAAQ,UAAU,IAAI,CAAC,CAAC,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAgB1I;;;;;;OAMG;eACQ,IAAI,CAAC,GAAG,CAAC,YAAY,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC;CAsB9D,CAAC"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AASA,OAAO,EAA2B,IAAI,EAAwB,QAAQ,EAAE,UAAU,EAAa,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC9I,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAkDzF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EAAE,gBAAgB,EAQtC,CAAA;AAID;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEjC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,YAAY,CACxB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,IAAI,KAAK,IAAI,KAAK,IAAI,EAC1F,OAAO,CAAC,EAAE,mBAAmB,6BA+DhC;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM;IACf;;;;;;;OAOG;OACA,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBlF;;;;;;;OAOG;UACG,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBrF;;;;;;;OAOG;aACM,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBxF;;;;;;;OAOG;SACE,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBpF;;;;;;;OAOG;cACO,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBzF;;;;;;;OAOG;YACK,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBvF;;;;;;;OAOG;iBACU,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgB5F;;;;;;;;OAQG;YACK,CAAC,SAAS,IAAI,UAAU,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAgBnI;;;;;;OAMG;eACQ,IAAI,CAAC,GAAG,CAAC,YAAY,MAAM;IAuBtC;;;;;OAKG;kBACW,kBAAkB,CAAC,UAAU,CAAC;CAK/C,CAAC"}