vla 0.1.3 → 0.1.5

package/README.md

@@ -1,8 +1,11 @@
-# Vla
-
-_A smooth dutch dessert that goes with everything._
-
-A TypeScript data layer kernel for backend- and fullstack apps. Compatible with whatever framework or library you're using.
+<p align="center">
+  <img src=".github/logo-large.png" width="400px" align="center" alt="Vla Logo" />
+  <h1 align="center">Vla – Smooth TypeScript Backends</h1>
+  <p align="center">
+    Vla is the missing backend layer for scalable TypeScript apps that integrates into any framework and existing codebases.
+  </p>
+</p>
+<br/>
 
 🚧 WIP, under development. Exports and names will very likely change often.
 
@@ -21,6 +24,12 @@ A TypeScript data layer kernel for backend- and fullstack apps. Compatible with
 - 🏗️ error handling
 - ...
 
+## Install
+
+```console
+npm install vla
+```
+
 ## Why?
 
 Many fullstack frameworks lack structure and conventions on the backend side (data layer), but they have lots of good structure and conventions on the frontend side (presentation layer). They are still great frameworks and they all have their own strengths. This is where Vla comes in. It aims to fill in the missing gap in the data layer, allowing you to write well-structured maintainable, scalable and testable code.
@@ -119,7 +128,7 @@ class UserRepo extends Users.Repo {
 }
 
 class Database extends Vla.Resource {
-  static override unwrap = "db"
+  static readonly unwrap = "db"
   // Unwraps a property when injecting the resource:
   // When another class injects the database with `this.inject(Database)`,
   // the `unwrap` will cause that it doesn't return the instance of the

package/dist/index.d.mts

@@ -19,6 +19,8 @@ type ModuleClass<ModuleName extends string, LayerName extends Layer = Layer, TVi
   readonly unwrap?: PropertyKey;
   readonly parentLayers: readonly Layer[];
 };
+type VlaInternalKeys = "inject" | "memo" | "devStable";
+type UserSurface<T> = T extends object ? Omit<T, VlaInternalKeys> : T;
 //#endregion
 //#region src/concerns/memo.d.ts
 type BaseCtor$1<T = object> = abstract new (...args: any[]) => T;
@@ -84,16 +86,6 @@ declare abstract class BaseAction {
   };
 }
 //#endregion
-//#region src/kernel/scoped-als.d.ts
-declare function withKernel<T>(scopedKernel: Kernel, fn: () => T): T;
-//#endregion
-//#region src/kernel/scoped-global.d.ts
-declare function setGlobalInvokeKernel(kernel: Kernel): void;
-//#endregion
-//#region src/kernel/scoped-provider.d.ts
-type CurrentKernelFn = () => Kernel | Promise<Kernel>;
-declare function setInvokeKernelProvider(fn: CurrentKernelFn): void;
-//#endregion
 //#region src/concerns/devstable.d.ts
 type BaseCtor<T = object> = abstract new (...args: any[]) => T;
 declare function DevStable<TBase extends BaseCtor>(Base: TBase): ((abstract new (...args: any[]) => {
@@ -126,7 +118,7 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<ModuleName, Layer> ? "service" extends infer T ? T extends "service" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
   }) & {
     readonly __vla_module: ModuleName;
     readonly __vla_layer: "service";
@@ -142,7 +134,7 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<ModuleName, Layer> ? "service" extends infer T ? T extends "service" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
   }) & {
     readonly __vla_module: ModuleName;
     readonly __vla_layer: "service";
@@ -158,7 +150,7 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<ModuleName, Layer> ? "repo" extends infer T ? T extends "repo" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     memo<Args extends unknown[], R>(fn: (...args: Args) => R): Memoized<Args, R>;
   }) & {
     readonly __vla_module: ModuleName;
@@ -175,7 +167,7 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<ModuleName, Layer> ? "action" extends infer T ? T extends "action" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     handle(...args: unknown[]): unknown | Promise<unknown>;
   }) & {
     readonly __vla_module: ModuleName;
@@ -193,7 +185,7 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<ModuleName, Layer> ? "resource" extends infer T ? T extends "resource" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     devStable<T>(key: string, init: () => T): T;
   }) & {
     readonly __vla_module: ModuleName;
@@ -209,6 +201,16 @@ declare function createModule<const ModuleName extends string>(moduleName: Modul
   DevStable: typeof DevStable;
 };
 //#endregion
+//#region src/kernel/scoped-als.d.ts
+declare function withKernel<T>(scopedKernel: Kernel, fn: () => T): T;
+//#endregion
+//#region src/kernel/scoped-global.d.ts
+declare function setGlobalInvokeKernel(kernel: Kernel): void;
+//#endregion
+//#region src/kernel/scoped-provider.d.ts
+type CurrentKernelFn = () => Kernel | Promise<Kernel>;
+declare function setInvokeKernelProvider(fn: CurrentKernelFn): void;
+//#endregion
 //#region src/index.d.ts
 declare const Vla: {
   createModule: typeof createModule;
@@ -216,12 +218,13 @@ declare const Vla: {
   withKernel: typeof withKernel;
   setGlobalInvokeKernel: typeof setGlobalInvokeKernel;
   setInvokeKernelProvider: typeof setInvokeKernelProvider;
+  Kernel: typeof Kernel;
   Facade: (abstract new () => {
     inject<TKey extends ModuleClass<string>>(key: TKey extends ModuleClass<string, infer TargetLayer extends Layer> ? TKey extends {
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<"Vla", Layer> ? "service" extends infer T ? T extends "service" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
   }) & {
     readonly __vla_module: "Vla";
     readonly __vla_layer: "service";
@@ -237,7 +240,7 @@ declare const Vla: {
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<"Vla", Layer> ? "service" extends infer T ? T extends "service" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
   }) & {
     readonly __vla_module: "Vla";
     readonly __vla_layer: "service";
@@ -253,7 +256,7 @@ declare const Vla: {
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<"Vla", Layer> ? "repo" extends infer T ? T extends "repo" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     memo<Args extends unknown[], R>(fn: (...args: Args) => R): Memoized<Args, R>;
   }) & {
     readonly __vla_module: "Vla";
@@ -270,7 +273,7 @@ declare const Vla: {
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<"Vla", Layer> ? "action" extends infer T ? T extends "action" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     handle(...args: unknown[]): unknown | Promise<unknown>;
   }) & {
     readonly __vla_module: "Vla";
@@ -288,7 +291,7 @@ declare const Vla: {
       readonly parentLayers: readonly Layer[];
     } ? TKey extends ModuleClass<"Vla", Layer> ? "resource" extends infer T ? T extends "resource" ? T extends TKey["parentLayers"][number] ? TKey : `A ${Capitalize<T>} is not allowed to inject a ${Capitalize<TargetLayer>}. Allowed parent layer: ${TKey["parentLayers"][number] extends Layer ? Capitalize<TKey["parentLayers"][number]> : never}` : never : never : TKey extends {
       readonly __vla_visibility: "global" | "public";
-    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey_1>>;
+    } ? TKey : `Cross-module ${Capitalize<TargetLayer>} dependency is not allowed. Use a Facade or Resource.` : never : TKey, scope?: Scope): UserSurface<Resolved<TKey>>;
     devStable<T>(key: string, init: () => T): T;
   }) & {
     readonly __vla_module: "Vla";
@@ -304,4 +307,4 @@ declare const Vla: {
   DevStable: typeof DevStable;
 };
 //#endregion
-export { InstantiableClass, Kernel, Layer, ModuleClass, Resolved, Scope, Token, UnwrapKey, Visibility, Vla, createContext, createModule, setGlobalInvokeKernel, setInvokeKernelProvider, withKernel };
+export { InstantiableClass, Kernel, Layer, ModuleClass, Resolved, Scope, Token, UnwrapKey, UserSurface, Visibility, Vla, VlaInternalKeys, createContext, createModule, setGlobalInvokeKernel, setInvokeKernelProvider, withKernel };

package/dist/index.mjs

@@ -413,7 +413,8 @@ const Vla = {
 	createContext,
 	withKernel,
 	setGlobalInvokeKernel,
-	setInvokeKernelProvider
+	setInvokeKernelProvider,
+	Kernel
 };
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vla",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Data layer kernel for backend- and fullstack apps",
   "author": "Timo Mämecke <hello@timo.wtf>",
   "license": "MIT",