@typed/fx 0.0.3 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typed/fx",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "High-performance Asynchronous Effects",
   "type": "module",
   "main": "esm/index.js",
@@ -14,7 +14,7 @@
     "prebuild": "npx tsc -p ./tsconfig.build.tracing.json && mv ./.tracing-plugin/plugin.js ./.tracing-plugin/plugin.cjs",
     "build": "concurrently npm:build:esm npm:build:cjs && npm run build:package-exports",
     "eslint": "NODE_OPTIONS=--max-old-space-size=4096 eslint --ext .ts,.js,.json,.yaml --fix --cache src",
-    "mocha": "mocha 'src/**/*.test.ts'",
+    "mocha": "mocha 'src/**/*.test.ts' 'src/Atomic/Atomic.test.ts'",
     "coverage": "c8 --include 'src/**/*' --all npm run mocha",
     "typecheck": "NODE_OPTIONS=--max-old-space-size=4096 tsc --noEmit -p ./tsconfig.build.esm.json",
     "test": "concurrently npm:eslint npm:mocha npm:typecheck",
@@ -24,7 +24,8 @@
     "test:ttypescript-plugin:build": "tsc ./src/Tracing/test.ts --outDir dist/test",
     "preversion": "npm test",
     "postversion": "npm run build && npm publish --access=public",
-    "prepare": "ts-patch install -s"
+    "prepare": "ts-patch install -s",
+    "example": "node --loader @esbuild-kit/esm-loader --experimental-specifier-resolution=node ./src/example.ts"
   },
   "keywords": [
     "Fx",
@@ -255,6 +256,26 @@
         "types": "./esm/Duration/Duration.d.ts"
       }
     },
+    "./Effect": {
+      "require": {
+        "default": "./cjs/Effect/index.js",
+        "types": "./cjs/Effect/index.js"
+      },
+      "import": {
+        "default": "./esm/Effect/index.js",
+        "types": "./esm/Effect/index.js"
+      }
+    },
+    "./Effect/Effect": {
+      "require": {
+        "default": "./cjs/Effect/Effect.js",
+        "types": "./cjs/Effect/Effect.d.ts"
+      },
+      "import": {
+        "default": "./esm/Effect/Effect.js",
+        "types": "./esm/Effect/Effect.d.ts"
+      }
+    },
     "./Env": {
       "require": {
         "default": "./cjs/Env/index.js",
@@ -325,6 +346,26 @@
         "types": "./esm/Fiber/Fiber.d.ts"
       }
     },
+    "./Fiber/fromExit": {
+      "require": {
+        "default": "./cjs/Fiber/fromExit.js",
+        "types": "./cjs/Fiber/fromExit.d.ts"
+      },
+      "import": {
+        "default": "./esm/Fiber/fromExit.js",
+        "types": "./esm/Fiber/fromExit.d.ts"
+      }
+    },
+    "./Fiber/hkt": {
+      "require": {
+        "default": "./cjs/Fiber/hkt.js",
+        "types": "./cjs/Fiber/hkt.d.ts"
+      },
+      "import": {
+        "default": "./esm/Fiber/hkt.js",
+        "types": "./esm/Fiber/hkt.d.ts"
+      }
+    },
     "./FiberContext": {
       "require": {
         "default": "./cjs/FiberContext/index.js",
@@ -385,6 +426,16 @@
         "types": "./esm/FiberRef/FiberRef.d.ts"
       }
     },
+    "./FiberRef/builtins": {
+      "require": {
+        "default": "./cjs/FiberRef/builtins.js",
+        "types": "./cjs/FiberRef/builtins.d.ts"
+      },
+      "import": {
+        "default": "./esm/FiberRef/builtins.js",
+        "types": "./esm/FiberRef/builtins.d.ts"
+      }
+    },
     "./FiberRef/operations": {
       "require": {
         "default": "./cjs/FiberRef/operations.js",
@@ -555,6 +606,16 @@
         "types": "./esm/Fx/Instruction.d.ts"
       }
     },
+    "./Fx/fromLayer": {
+      "require": {
+        "default": "./cjs/Fx/fromLayer.js",
+        "types": "./cjs/Fx/fromLayer.d.ts"
+      },
+      "import": {
+        "default": "./esm/Fx/fromLayer.js",
+        "types": "./esm/Fx/fromLayer.d.ts"
+      }
+    },
     "./Fx/join": {
       "require": {
         "default": "./cjs/Fx/join.js",
@@ -705,64 +766,64 @@
         "types": "./esm/Logger/Logger.d.ts"
       }
     },
-    "./Platform": {
+    "./Node": {
       "require": {
-        "default": "./cjs/Platform/index.js",
-        "types": "./cjs/Platform/index.d.ts"
+        "default": "./cjs/Node/index.js",
+        "types": "./cjs/Node/index.d.ts"
       },
       "import": {
-        "default": "./esm/Platform/index.js",
-        "types": "./esm/Platform/index.d.ts"
+        "default": "./esm/Node/index.js",
+        "types": "./esm/Node/index.d.ts"
       }
     },
-    "./Platform/Platform": {
+    "./Node/Runtime": {
       "require": {
-        "default": "./cjs/Platform/Platform.js",
-        "types": "./cjs/Platform/Platform.d.ts"
+        "default": "./cjs/Node/Runtime.js",
+        "types": "./cjs/Node/Runtime.d.ts"
       },
       "import": {
-        "default": "./esm/Platform/Platform.js",
-        "types": "./esm/Platform/Platform.d.ts"
+        "default": "./esm/Node/Runtime.js",
+        "types": "./esm/Node/Runtime.d.ts"
       }
     },
-    "./Platform/TestPlatform": {
+    "./Node/gracefulShutdown": {
       "require": {
-        "default": "./cjs/Platform/TestPlatform.js",
-        "types": "./cjs/Platform/TestPlatform.d.ts"
+        "default": "./cjs/Node/gracefulShutdown.js",
+        "types": "./cjs/Node/gracefulShutdown.d.ts"
       },
       "import": {
-        "default": "./esm/Platform/TestPlatform.js",
-        "types": "./esm/Platform/TestPlatform.d.ts"
+        "default": "./esm/Node/gracefulShutdown.js",
+        "types": "./esm/Node/gracefulShutdown.d.ts"
       }
     },
-    "./Ref": {
+    "./Platform": {
       "require": {
-        "default": "./cjs/Ref/index.js",
-        "types": "./cjs/Ref/index.d.ts"
+        "default": "./cjs/Platform/index.js",
+        "types": "./cjs/Platform/index.d.ts"
       },
       "import": {
-        "default": "./esm/Ref/index.js",
-        "types": "./esm/Ref/index.d.ts"
+        "default": "./esm/Platform/index.js",
+        "types": "./esm/Platform/index.d.ts"
       }
     },
-    "./Ref/Ref": {
+    "./Platform/Platform": {
       "require": {
-        "default": "./cjs/Ref/Ref.js",
-        "types": "./cjs/Ref/Ref.d.ts"
+        "default": "./cjs/Platform/Platform.js",
+        "types": "./cjs/Platform/Platform.d.ts"
       },
       "import": {
-        "default": "./esm/Ref/Ref.js",
-        "types": "./esm/Ref/Ref.d.ts"
+        "default": "./esm/Platform/Platform.js",
+        "types": "./esm/Platform/Platform.d.ts"
       }
     },
-    "./Ref/atomic": {
+    "./Platform/TestPlatform": {
       "require": {
-        "default": "./cjs/Ref/atomic.js",
-        "types": "./cjs/Ref/atomic.d.ts"
+        "default": "./cjs/Platform/TestPlatform.js",
+        "types": "./cjs/Platform/TestPlatform.d.ts"
       },
       "import": {
-        "default": "./esm/Ref/atomic.js",
-        "types": "./esm/Ref/atomic.d.ts"
+        "default": "./esm/Platform/TestPlatform.js",
+        "types": "./esm/Platform/TestPlatform.d.ts"
       }
     },
     "./Runtime": {
@@ -865,14 +926,14 @@
         "types": "./esm/Scheduler/callbackScheduler.d.ts"
       }
     },
-    "./Scheduler/scheduled": {
+    "./Scheduler/runSchedule": {
       "require": {
-        "default": "./cjs/Scheduler/scheduled.js",
-        "types": "./cjs/Scheduler/scheduled.d.ts"
+        "default": "./cjs/Scheduler/runSchedule.js",
+        "types": "./cjs/Scheduler/runSchedule.d.ts"
       },
       "import": {
-        "default": "./esm/Scheduler/scheduled.js",
-        "types": "./esm/Scheduler/scheduled.d.ts"
+        "default": "./esm/Scheduler/runSchedule.js",
+        "types": "./esm/Scheduler/runSchedule.d.ts"
       }
     },
     "./Scope": {
@@ -995,6 +1056,16 @@
         "types": "./esm/Service/Service.d.ts"
       }
     },
+    "./Service/fn": {
+      "require": {
+        "default": "./cjs/Service/fn.js",
+        "types": "./cjs/Service/fn.d.ts"
+      },
+      "import": {
+        "default": "./esm/Service/fn.js",
+        "types": "./esm/Service/fn.d.ts"
+      }
+    },
     "./Service/tagged": {
       "require": {
         "default": "./cjs/Service/tagged.js",
@@ -1105,6 +1176,26 @@
         "types": "./esm/Stream/Stream.d.ts"
       }
     },
+    "./Stream/bimap": {
+      "require": {
+        "default": "./cjs/Stream/bimap.js",
+        "types": "./cjs/Stream/bimap.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/bimap.js",
+        "types": "./esm/Stream/bimap.d.ts"
+      }
+    },
+    "./Stream/continueWith": {
+      "require": {
+        "default": "./cjs/Stream/continueWith.js",
+        "types": "./cjs/Stream/continueWith.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/continueWith.js",
+        "types": "./esm/Stream/continueWith.d.ts"
+      }
+    },
     "./Stream/drain": {
       "require": {
         "default": "./cjs/Stream/drain.js",
@@ -1115,6 +1206,46 @@
         "types": "./esm/Stream/drain.d.ts"
       }
     },
+    "./Stream/empty": {
+      "require": {
+        "default": "./cjs/Stream/empty.js",
+        "types": "./cjs/Stream/empty.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/empty.js",
+        "types": "./esm/Stream/empty.d.ts"
+      }
+    },
+    "./Stream/flatMap": {
+      "require": {
+        "default": "./cjs/Stream/flatMap.js",
+        "types": "./cjs/Stream/flatMap.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/flatMap.js",
+        "types": "./esm/Stream/flatMap.d.ts"
+      }
+    },
+    "./Stream/flatMapFx": {
+      "require": {
+        "default": "./cjs/Stream/flatMapFx.js",
+        "types": "./cjs/Stream/flatMapFx.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/flatMapFx.js",
+        "types": "./esm/Stream/flatMapFx.d.ts"
+      }
+    },
+    "./Stream/fromCallback": {
+      "require": {
+        "default": "./cjs/Stream/fromCallback.js",
+        "types": "./cjs/Stream/fromCallback.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/fromCallback.js",
+        "types": "./esm/Stream/fromCallback.d.ts"
+      }
+    },
     "./Stream/fromFx": {
       "require": {
         "default": "./cjs/Stream/fromFx.js",
@@ -1125,6 +1256,66 @@
         "types": "./esm/Stream/fromFx.d.ts"
       }
     },
+    "./Stream/hkt": {
+      "require": {
+        "default": "./cjs/Stream/hkt.js",
+        "types": "./cjs/Stream/hkt.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/hkt.js",
+        "types": "./esm/Stream/hkt.d.ts"
+      }
+    },
+    "./Stream/map": {
+      "require": {
+        "default": "./cjs/Stream/map.js",
+        "types": "./cjs/Stream/map.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/map.js",
+        "types": "./esm/Stream/map.d.ts"
+      }
+    },
+    "./Stream/periodic": {
+      "require": {
+        "default": "./cjs/Stream/periodic.js",
+        "types": "./cjs/Stream/periodic.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/periodic.js",
+        "types": "./esm/Stream/periodic.d.ts"
+      }
+    },
+    "./Stream/run": {
+      "require": {
+        "default": "./cjs/Stream/run.js",
+        "types": "./cjs/Stream/run.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/run.js",
+        "types": "./esm/Stream/run.d.ts"
+      }
+    },
+    "./Stream/scheduled": {
+      "require": {
+        "default": "./cjs/Stream/scheduled.js",
+        "types": "./cjs/Stream/scheduled.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/scheduled.js",
+        "types": "./esm/Stream/scheduled.d.ts"
+      }
+    },
+    "./Stream/tap": {
+      "require": {
+        "default": "./cjs/Stream/tap.js",
+        "types": "./cjs/Stream/tap.d.ts"
+      },
+      "import": {
+        "default": "./esm/Stream/tap.js",
+        "types": "./esm/Stream/tap.d.ts"
+      }
+    },
     "./Supervisor": {
       "require": {
         "default": "./cjs/Supervisor/index.js",
@@ -1145,6 +1336,26 @@
         "types": "./esm/Supervisor/Supervisor.d.ts"
       }
     },
+    "./Supervisor/maxFailures": {
+      "require": {
+        "default": "./cjs/Supervisor/maxFailures.js",
+        "types": "./cjs/Supervisor/maxFailures.d.ts"
+      },
+      "import": {
+        "default": "./esm/Supervisor/maxFailures.js",
+        "types": "./esm/Supervisor/maxFailures.d.ts"
+      }
+    },
+    "./Supervisor/trackIn": {
+      "require": {
+        "default": "./cjs/Supervisor/trackIn.js",
+        "types": "./cjs/Supervisor/trackIn.d.ts"
+      },
+      "import": {
+        "default": "./esm/Supervisor/trackIn.js",
+        "types": "./esm/Supervisor/trackIn.d.ts"
+      }
+    },
     "./Tagged": {
       "require": {
         "default": "./cjs/Tagged/index.js",
@@ -1265,6 +1476,26 @@
         "types": "./esm/Tracing/vite.d.ts"
       }
     },
+    "./_internal": {
+      "require": {
+        "default": "./cjs/_internal/index.js",
+        "types": "./cjs/_internal/index.js"
+      },
+      "import": {
+        "default": "./esm/_internal/index.js",
+        "types": "./esm/_internal/index.js"
+      }
+    },
+    "./_internal/suite": {
+      "require": {
+        "default": "./cjs/_internal/suite.js",
+        "types": "./cjs/_internal/suite.d.ts"
+      },
+      "import": {
+        "default": "./esm/_internal/suite.js",
+        "types": "./esm/_internal/suite.d.ts"
+      }
+    },
     "./test": {
       "require": {
         "default": "./cjs/test.js",

package/readme.md

@@ -14,7 +14,6 @@ The Fiber runtime interprets these generators into running applications that pro
 - Streams - Push-based streams, modeled after [@most/core](https://github.com/mostjs/core), with full Fx integration.
 - Tracing - Use our TypeScript/Vite plugin to use the TypeScript compiler to augment your stack traces with more useful information.
 - Logging - Built-in Loggers w/ configurable backends
-- Metrics - Track metrics occurring throughout your application.
 - State Management - Manage and synchronize state effortlessly across all your running processes.
 
 ## Target 
@@ -24,7 +23,7 @@ bundle size, parse time, memory constraints, etc. are of great concern. There wi
 these metrics, ergonomics, and feature-set. We'll attempt to tread these lines as best we can, but Fx is highly feature-rich
 as it is, and can be used to build many many more abstractions that are not yet available as 3rd party plugins.
 
-The full library, and its dependencies, are about 50kb minified + gzipped. 
+The full library, and its dependencies, are about 20kb minified + gzipped. 
 However, it is provided as ES modules and is highly tree-shakeable. Take only what you need.
 
 ## Come Back Soon

package/src/Atomic/Atomic.test.ts

@@ -0,0 +1,33 @@
+import { deepStrictEqual } from 'assert'
+
+import { Atomic } from './Atomic.js'
+
+import { testSuite } from '@/_internal/suite.js'
+
+testSuite(import.meta.url, () => {
+  describe(Atomic.name, () => {
+    it('allows getting/setting data', () => {
+      const initialValue = Math.random()
+      const atomic = Atomic(initialValue)
+
+      deepStrictEqual(atomic.get(), initialValue)
+
+      const nextValue = Math.random()
+      atomic.set(nextValue)
+
+      deepStrictEqual(atomic.get(), nextValue)
+    })
+
+    it('allows modifying data', () => {
+      const initialValue = Math.random()
+      const atomic = Atomic(initialValue)
+
+      deepStrictEqual(
+        atomic.modify((value) => [value, value + 1]),
+        initialValue,
+      )
+
+      deepStrictEqual(atomic.get(), initialValue + 1)
+    })
+  })
+})

package/src/Atomic/Atomic.ts

@@ -3,13 +3,13 @@ import { Endomorphism } from 'hkt-ts/Endomorphism'
 import { Just, Maybe, Nothing } from 'hkt-ts/Maybe'
 import { Associative, First } from 'hkt-ts/Typeclass/Associative'
 import { Eq } from 'hkt-ts/Typeclass/Eq'
-import { Identity } from 'hkt-ts/Typeclass/Identity'
 
 /**
  * Atomic represents an a mutable reference to immutable data
  * that can be modified and joined back together.
  */
-export interface Atomic<A> extends Identity<A> {
+export interface Atomic<A> extends Associative<A> {
+  readonly initial: A
   readonly get: () => A
   readonly modify: <B>(f: (a: A) => readonly [B, A]) => B
   readonly set: (a: A) => A
@@ -22,7 +22,7 @@ export function Atomic<A>(initial: A, A: Associative<A> = First): Atomic<A> {
   let current = initial
 
   return {
-    id: initial,
+    initial,
     concat: A.concat,
     get: () => current,
     modify: (f) => {

package/src/Effect/Effect.ts

@@ -0,0 +1,109 @@
+import * as F from 'hkt-ts/function'
+
+import * as C from '@/Cause/index.js'
+import { Cause } from '@/Cause/index.js'
+import { Exit } from '@/Exit/Exit.js'
+
+// TODO: Track yields as a Tuple?
+// TODO: Track Return HKTs?
+
+export abstract class EffectBrand<R, E, A> {
+  readonly __EFFECT__!: {
+    readonly _R: () => R
+    readonly _E: () => E
+    readonly _A: () => A
+  }
+}
+
+export abstract class Instr<out I, out R, out E, out A> extends EffectBrand<R, E, A> {
+  static tag: string
+  abstract readonly tag: string
+
+  constructor(readonly input: I, readonly __trace?: string) {
+    super()
+  }
+
+  *[Symbol.iterator](): Generator<this, A, any> {
+    return yield this
+  }
+}
+
+export const instr = <Tag extends string>(tag: Tag) =>
+  class Instruction<I, R, E, A> extends Instr<I, R, E, A> {
+    static tag: Tag = tag
+    readonly tag: Tag = tag
+  }
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+export type YieldOf<T> = T extends EffectBrand<infer _R, infer _E, infer _A> ? _R : never
+export type ErrorsOf<T> = T extends EffectBrand<infer _R, infer _E, infer _A> ? _E : never
+export type OutputOf<T> = T extends EffectBrand<infer _R, infer _E, infer _A> ? _A : never
+/* eslint-enable @typescript-eslint/no-unused-vars */
+
+export type Effect<R, E, A> =
+  // Constructors
+  | Now<A>
+  | FromLazy<A>
+  | FromCause<E>
+  | LazyEffect<R, E, A>
+  // Control Flow
+  | MapEffect<R, E, any, A>
+  | FlatMapEffect<R, E, any, R, E, A>
+  | OrElseEffect<R, any, A, R, E, A>
+  | EnsuringEffect<R, any, any, R, E, A>
+  | YieldNow
+  // Efeccts
+  | YieldEffect<R>
+
+export class Now<A> extends instr('Now')<A, never, never, A> {}
+
+export class FromLazy<A> extends instr('FromLazy')<F.Lazy<A>, never, never, A> {}
+
+export class FromCause<E> extends instr('FromCause')<C.Cause<E>, never, E, never> {}
+
+export class LazyEffect<R, E, A> extends instr('LazyEffect')<F.Lazy<Effect<R, E, A>>, R, E, A> {}
+
+export class MapEffect<R, E, A, B> extends instr('MapEffect')<
+  readonly [Effect<R, E, A>, (a: A) => B],
+  R,
+  E,
+  B
+> {}
+
+export class FlatMapEffect<R, E, A, R2, E2, B> extends instr('FlatMapEffect')<
+  readonly [Effect<R, E, A>, (a: A) => Effect<R2, E2, B>],
+  R | R2,
+  E | E2,
+  B
+> {}
+
+export class OrElseEffect<R, E, A, R2, E2, B> extends instr('OrElseEffect')<
+  readonly [Effect<R, E, A>, (cause: Cause<E>) => Effect<R2, E2, B>],
+  R | R2,
+  E2,
+  A | B
+> {}
+
+export class EnsuringEffect<R, E, A, R2, E2, B> extends instr('Ensuring')<
+  readonly [Effect<R, E, A>, (cause: Exit<E, A>) => Effect<R2, E2, B>],
+  R | R2,
+  E2,
+  B
+> {}
+
+export class YieldNow extends instr('YieldNow')<never, never, never, void> {}
+
+export class YieldEffect<R> extends instr('YieldEffect')<
+  R,
+  R | YieldOf<R>,
+  ErrorsOf<R>,
+  OutputOf<R>
+> {}
+
+// TODO: ProvideHandler + Handler
+// TODO: GetHandlers - Use HKT to track return values?
+// TODO: StackMap + References
+// TODO: Interrupts
+// TODO: Tracing
+// TODO: Supervision
+// TODO: Multiple Resumes