vla 0.1.2 → 0.1.4

package/README.md

@@ -21,6 +21,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.

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;
@@ -126,7 +128,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): Resolved<TKey>;
+    } ? 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 +144,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): Resolved<TKey>;
+    } ? 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 +160,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): Resolved<TKey>;
+    } ? 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 +177,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): Resolved<TKey>;
+    } ? 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 +195,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): Resolved<TKey>;
+    } ? 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;
@@ -221,7 +223,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): Resolved<TKey>;
+    } ? 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 +239,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): Resolved<TKey>;
+    } ? 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 +255,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): Resolved<TKey>;
+    } ? 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 +272,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): Resolved<TKey>;
+    } ? 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 +290,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): Resolved<TKey>;
+    } ? 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 +306,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/package.json

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