bunja 2.1.1 → 3.0.0-alpha.4

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@disjukr/bunja",
-  "version": "2.1.1",
+  "version": "3.0.0-alpha.4",
   "license": "Zlib",
   "exports": {
     ".": "./bunja.ts",

package/dist/{bunja-BvZKLiEP.d.ts → bunja-BxbzuHdH.d.cts}

@@ -1,13 +1,40 @@
 //#region bunja.d.ts
 interface BunjaFn {
-  <T>(init: () => T): Bunja<T>;
+  <T>(init: () => T): Bunja<T, NoSeed>;
+  withSeed: BunjaWithSeedFn;
   use: BunjaUseFn;
-  fork: BunjaForkFn;
+  will: BunjaWillFn;
   effect: BunjaEffectFn;
 }
 declare const bunja: BunjaFn;
-type BunjaUseFn = <T>(dep: Dep<T>) => T;
-type BunjaForkFn = <T>(bunja: Bunja<T>, scopeValuePairs: ScopeValuePair<any>[]) => T;
+declare const NO_SEED: unique symbol;
+type NoSeed = typeof NO_SEED;
+type BunjaWithSeedFn = <Seed, T>(defaultSeed: Seed, init: (seed: Seed) => T) => Bunja<T, Seed>;
+type ScopeValuePairs = ScopeValuePair<any>[];
+type BunjaRefBase<T, Seed> = {
+  bunja: Bunja<T, Seed>;
+  with?: ScopeValuePairs;
+};
+type BunjaGetRef<T, Seed = NoSeed> = BunjaRefBase<T, Seed> & ([Seed] extends [NoSeed] ? {
+  seed?: never;
+} : {
+  seed?: Seed;
+});
+type BunjaRef<T, Seed = NoSeed> = BunjaGetRef<T, Seed>;
+type BunjaPrebakeRef<T, Seed = NoSeed> = BunjaRefBase<T, Seed> & {
+  seed?: never;
+};
+interface BunjaUseFn {
+  <T>(dep: Scope<T>): T;
+  <T, Seed>(dep: Bunja<T, Seed>): T;
+  <T, Seed>(bunja: Bunja<T, Seed>, scopeValuePairs: ScopeValuePairs): T;
+  <T, Seed>(ref: BunjaRef<T, Seed>): T;
+}
+interface BunjaWillFn {
+  <T, Seed>(dep: Bunja<T, Seed>): () => T;
+  <T, Seed>(bunja: Bunja<T, Seed>, scopeValuePairs: ScopeValuePairs): () => T;
+  <T, Seed>(ref: BunjaRef<T, Seed>): () => T;
+}
 type BunjaEffectFn = (callback: BunjaEffectCallback) => void;
 type BunjaEffectCallback = () => (() => void) | void;
 declare function createScope<T>(hash?: HashFn<T>): Scope<T>;
@@ -15,12 +42,25 @@ interface CreateBunjaStoreConfig {
   wrapInstance?: WrapInstanceFn;
 }
 declare function createBunjaStore(config?: CreateBunjaStoreConfig): BunjaStore;
-type Dep<T> = Bunja<T> | Scope<T>;
+type Dep<T> = Bunja<T, any> | Scope<T>;
+type AnyBunja = Bunja<any, any>;
 interface InternalState {
   bunjas: Record<string, BunjaInstance>;
   scopes: Map<Scope<unknown>, Map<unknown, ScopeInstance>>;
   instantiating: boolean;
 }
+type AnyNormalizedBunjaRef = NormalizedBunjaRef<any, any>;
+interface NormalizedBunjaRef<T, Seed> {
+  bunja: Bunja<T, Seed>;
+  scopeValuePairs: ScopeValuePairs;
+}
+interface ActiveDependencyRecipe {
+  ref: AnyNormalizedBunjaRef;
+  seed: unknown;
+}
+interface BunjaInstanceRecipe {
+  activeDependencies: ActiveDependencyRecipe[];
+}
 type WrapInstanceFn = <T>(fn: (dispose: () => void) => T) => T;
 declare class BunjaStore {
   #private;
@@ -30,7 +70,8 @@ declare class BunjaStore {
   constructor();
   get _internalState(): InternalState | undefined;
   dispose(): void;
-  get<T>(bunja: Bunja<T>, readScope: ReadScope): BunjaStoreGetResult<T>;
+  get<T, Seed>(bunjaOrRef: Bunja<T, Seed> | BunjaGetRef<T, Seed>, readScope: ReadScope): BunjaStoreGetResult<T>;
+  prebake<T, Seed>(bunjaOrRef: Bunja<T, Seed> | BunjaPrebakeRef<T, Seed>, readScope: ReadScope): BunjaStorePrebakeResult;
 }
 type ReadScope = <T>(scope: Scope<T>) => T;
 declare function createReadScopeFn(scopeValuePairs: ScopeValuePair<any>[], readScope: ReadScope): ReadScope;
@@ -40,22 +81,33 @@ interface BunjaStoreGetResult<T> {
   deps: unknown[];
   bunjaInstance?: BunjaInstance;
 }
+interface BunjaStorePrebakeResult {
+  relatedBunjas: Bunja<any, any>[];
+  requiredScopes: Scope<unknown>[];
+}
 declare function delayUnmount(mount: () => () => void, ms?: number): () => () => void;
-declare class Bunja<T> {
+declare class Bunja<T, Seed = NoSeed> {
   #private;
-  init: () => T;
+  init: (seed: Seed) => T;
+  defaultSeed: Seed;
   private static counter;
   readonly id: string;
   debugLabel: string;
-  constructor(init: () => T);
+  constructor(init: (seed: Seed) => T, defaultSeed: Seed);
   get baked(): boolean;
-  get parents(): Bunja<unknown>[];
-  get relatedBunjas(): Bunja<unknown>[];
-  get relatedScopes(): Scope<unknown>[];
-  addParent(bunja: Bunja<unknown>): void;
+  get requiredBunjas(): AnyBunja[];
+  get optionalBunjas(): AnyBunja[];
+  get requiredBunjaRefs(): AnyNormalizedBunjaRef[];
+  get optionalBunjaRefs(): AnyNormalizedBunjaRef[];
+  get expandedRequiredBunjas(): AnyBunja[];
+  get relatedBunjas(): AnyBunja[];
+  get requiredScopes(): Scope<unknown>[];
+  addRequiredBunjaRef(ref: AnyNormalizedBunjaRef): void;
+  addOptionalBunjaRef(ref: AnyNormalizedBunjaRef): void;
   addScope(scope: Scope<unknown>): void;
   bake(): void;
-  calcInstanceId(scopeInstanceMap: Map<Scope<unknown>, ScopeInstance>): string;
+  calcBaseInstanceId(scopeInstanceMap: Map<Scope<unknown>, ScopeInstance>): string;
+  calcInstanceId(scopeInstanceMap: Map<Scope<unknown>, ScopeInstance>, activeDependencyIds?: Iterable<string>): string;
   toString(): string;
 }
 declare class Scope<T> {
@@ -79,10 +131,13 @@ declare abstract class RefCounter {
 declare class BunjaInstance extends RefCounter {
   #private;
   readonly id: string;
+  readonly baseId: string;
   readonly value: unknown;
-  readonly effect: BunjaEffectCallback;
+  private readonly dependencyMounts;
+  private readonly effects;
+  readonly recipe: BunjaInstanceRecipe;
   private readonly _dispose;
-  constructor(id: string, value: unknown, effect: BunjaEffectCallback, _dispose: () => void);
+  constructor(id: string, baseId: string, value: unknown, dependencyMounts: (() => () => void)[], effects: BunjaEffectCallback[], recipe: BunjaInstanceRecipe, _dispose: () => void);
   dispose(): void;
   add(): void;
 }
@@ -94,7 +149,7 @@ declare class ScopeInstance extends RefCounter {
   constructor(value: unknown, dispose: () => void);
 }
 interface BunjaDevtoolsGlobalHook {
-  bunjas: Record<string, Bunja<any>>;
+  bunjas: Record<string, Bunja<any, any>>;
   scopes: Record<string, Scope<any>>;
   listeners: Record<BunjaDevtoolsEventType, Set<(event: any) => void>>;
   emit<T extends BunjaDevtoolsEventType>(type: T, event: BunjaDevtoolsEvent[T]): void;
@@ -138,4 +193,4 @@ interface BunjaDevtoolsEvent {
 }
 type BunjaDevtoolsEventType = keyof BunjaDevtoolsEvent;
 //#endregion
-export { Bunja, BunjaDevtoolsEvent, BunjaDevtoolsEventType, BunjaDevtoolsGlobalHook, BunjaEffectCallback, BunjaEffectFn, BunjaFn, BunjaForkFn, BunjaStore, BunjaStoreGetResult, BunjaUseFn, CreateBunjaStoreConfig, Dep, HashFn, ReadScope, Scope, ScopeValuePair, WrapInstanceFn, bunja, createBunjaStore, createReadScopeFn, createScope, delayUnmount };
+export { Bunja, BunjaDevtoolsEvent, BunjaDevtoolsEventType, BunjaDevtoolsGlobalHook, BunjaEffectCallback, BunjaEffectFn, BunjaFn, BunjaGetRef, BunjaRef, BunjaStore, BunjaStoreGetResult, BunjaStorePrebakeResult, BunjaUseFn, BunjaWillFn, BunjaWithSeedFn, CreateBunjaStoreConfig, Dep, HashFn, NoSeed, ReadScope, Scope, ScopeValuePair, ScopeValuePairs, WrapInstanceFn, bunja, createBunjaStore, createReadScopeFn, createScope, delayUnmount };