pure-effect 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aycan Gulez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,120 @@
+# Pure Effect
+
+**Pure Effect** is a tiny, zero-dependency effect system for writing pure, testable JavaScript without mocks.
+
+It implements the "Functional Core, Imperative Shell" pattern, allowing you to decouple your business logic from external side effects like database calls or API requests. Instead of executing side effects immediately, your functions return Commands which are executed later by an interpreter.
+
+## Installation
+
+```bash
+npm install pure-effect
+```
+
+## Usage
+
+Here is a complete example of a User Registration flow.
+
+```js
+import { Success, Failure, Command, effectPipe, runEffect } from 'pure-effect';
+
+const validateRegistration = (input) => {
+    if (!input.email.includes('@')) return Failure('Invalid email.');
+    if (input.password.length < 8) return Failure('Password too short.');
+    return Success(input);
+};
+
+// These functions do NOT run the DB call. They return a Command object.
+// The 'next' function defines what happens with the result of the async call.
+const findUser = (email) => {
+    const cmd = () => db.findUser(email); // The work to do later
+    const next = (user) => Success(user); // Wrap result in Success
+    return Command(cmd, next);
+};
+
+const saveUser = (input) => {
+    const cmd = () => db.saveUser(input);
+    const next = (saved) => Success(saved);
+    return Command(cmd, next);
+};
+
+const ensureEmailAvailable = (user) => {
+    return user ? Failure('Email already in use.') : Success(true);
+};
+
+// The Pipeline uses arrow functions to capture 'input' from the scope where needed.
+const registerUserFlow = (input) =>
+    effectPipe(
+        validateRegistration,
+        () => findUser(input.email),
+        ensureEmailAvailable,
+        () => saveUser(input)
+    )(input);
+
+// The Imperative Shell
+async function main() {
+    const input = { email: 'new@test.com', password: 'password123' };
+
+    // logic is just a data structure until we pass it to runEffect
+    const logic = registerUserFlow(input);
+
+    // runEffect performs the actual async work
+    const result = await runEffect(logic);
+
+    if (result.type === 'Success') {
+        console.log('User created:', result.value);
+    } else {
+        console.error('Error:', result.error);
+    }
+}
+
+main();
+```
+
+## Testing Without Mocks
+
+The biggest benefit of **Pure Effect** is testability. Because `registerUserFlow` returns a data structure (a tree of objects) instead of running a Promise, you can test your logic without mocking the database.
+
+```js
+import assert from 'assert';
+
+// 1. Test Validation Failure
+const badInput = { email: 'bad-email', password: '123' };
+const result = registerUserFlow(badInput);
+
+assert.deepEqual(result, Failure('Invalid email.'));
+// ✅ Logic tested instantly, no async needed.
+
+// 2. Test Flow Intent (Introspection)
+const goodInput = { email: 'test@test.com', password: 'password123' };
+const step1 = registerUserFlow(goodInput);
+
+// Check if the first thing the code does is try to find a user
+assert.equal(step1.type, 'Command');
+assert.equal(step1.cmd.name, 'findUser');
+// ✅ We verified the *intent* of the code without touching a real DB.
+```
+
+## API Reference
+
+### `Success(value)`
+
+Returns an object `{ type: 'Success', value }`. Represents a successful computation.
+
+### `Failure(error)`
+
+Returns an object `{ type: 'Failure', error }`. Represents a failed computation. Stops the pipeline immediately.
+
+### `Command(cmdFn, nextFn)`
+
+Returns an object `{ type: 'Command', cmd, next }`.
+
+-   `cmdFn`: A function (sync or async) that performs the side effect.
+-   `nextFn`: A function that receives the result of `cmdFn` and returns the next Effect (Success, Failure, or another Command).
+
+### `effectPipe(...functions)`
+
+A combinator that runs functions in sequence. It automatically handles unpacking `Success` values and passing them to the next function. If a `Failure` occurs, the pipe stops.
+
+### `runEffect(effect)`
+
+The interpreter. It takes an `effect` object, executes any nested Commands recursively using `async/await`, and returns the final `Success` or `Failure`.

package/index.js

@@ -0,0 +1,32 @@
+const Success = (value) => ({ type: 'Success', value });
+const Failure = (error) => ({ type: 'Failure', error });
+const Command = (cmd, next) => ({ type: 'Command', cmd, next });
+
+const chain = (effect, fn) => {
+    switch (effect.type) {
+        case 'Success':
+            return fn(effect.value);
+        case 'Failure':
+            return effect;
+        case 'Command':
+            const next = (result) => chain(effect.next(result), fn);
+            return Command(effect.cmd, next);
+    }
+};
+
+const effectPipe = (...fns) => {
+    return (start) => fns.reduce(chain, Success(start));
+};
+
+async function runEffect(effect) {
+    while (effect.type === 'Command') {
+        try {
+            effect = effect.next(await effect.cmd());
+        } catch (e) {
+            return Failure(e);
+        }
+    }
+    return effect;
+}
+
+export { Success, Failure, Command, effectPipe, runEffect };

package/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "pure-effect",
+    "version": "0.1.0",
+    "description": "A tiny, zero-dependency effect system for writing pure, testable JavaScript without mocks.",
+    "type": "module",
+    "exports": "./index.js",
+    "scripts": {
+        "test": "mocha"
+    },
+    "author": "Aycan Gulez",
+    "homepage": "https://github.com/aycangulez/pure-effect",
+    "license": "MIT",
+    "devDependencies": {
+        "mocha": "^11.7.5"
+    }
+}

package/test/all.js

@@ -0,0 +1,75 @@
+import { strict as assert } from 'assert';
+import { Success, Failure, Command, effectPipe, runEffect } from '../index.js';
+
+const db = {
+    users: new Map(),
+    async findUserByEmail(email) {
+        return this.users.get(email) || null;
+    },
+    async saveUser(user) {
+        const u = { id: Date.now(), ...user };
+        this.users.set(user.email, u);
+        return u;
+    },
+};
+
+function validateRegistration(input) {
+    const { email, password } = input;
+    if (!email?.includes('@')) {
+        return Failure('Invalid email format.');
+    }
+    if (password?.length < 8) {
+        return Failure('Password must be at least 8 characters long.');
+    }
+    return Success(input);
+}
+
+function findUserByEmail(email) {
+    const cmdFindUser = () => db.findUserByEmail(email);
+    const next = (foundUser) => Success(foundUser);
+    return Command(cmdFindUser, next);
+}
+
+function ensureEmailIsAvailable(foundUser) {
+    return foundUser ? Failure('Email already in use.') : Success(true);
+}
+
+function saveUser(input) {
+    const { email, password } = input;
+    const hashedPassword = `hashed_${password}`;
+    const userToSave = { email, password: hashedPassword };
+    const cmdSaveUser = () => db.saveUser(userToSave);
+    const next = (savedUser) => Success(savedUser);
+    return Command(cmdSaveUser, next);
+}
+
+const registerUserFlow = (input) =>
+    effectPipe(
+        validateRegistration,
+        () => findUserByEmail(input.email),
+        ensureEmailIsAvailable,
+        () => saveUser(input)
+    )(input);
+
+async function registerUser(input) {
+    return await runEffect(registerUserFlow(input));
+}
+
+describe('Pure Effect', function () {
+    it('should return Failure when e-mail is invalid', async function () {
+        const input = { email: 'bad-email', password: '123' };
+        const effect = await registerUser(input);
+        assert.deepEqual(effect, Failure('Invalid email format.'));
+    });
+
+    it('should walk through the call tree', async function () {
+        const input = { email: 'test@test.com', password: 'password123' };
+        const step1 = registerUserFlow(input);
+        assert.equal(step1.type, 'Command');
+        assert.equal(step1.cmd.name, 'cmdFindUser');
+
+        const step2 = step1.next(null);
+        assert.equal(step2.type, 'Command');
+        assert.equal(step2.cmd.name, 'cmdSaveUser');
+    });
+});