@tailorkit/app 0.1.0-beta.8 → 0.1.0-beta.9

package/dist/index.d.ts

@@ -1,67 +1,83 @@
 import { h } from "preact";
 import type { ComponentChild, ComponentChildren, VNode } from "preact";
-export interface TailorKitScreens {
+export interface TailorKitViews {
 }
-export type ScreenPath = Extract<keyof TailorKitScreens & string, `/${string}`>;
-export type AppScreenPath = ScreenPath;
-export type ScreenProps<TPath extends ScreenPath> = TailorKitScreens[TPath] extends object ? TailorKitScreens[TPath] : Record<string, never>;
-export type ScreenPropsForPath<TPath extends AppScreenPath> = TPath extends ScreenPath ? ScreenProps<TPath> : never;
-export type ScreenContext<TPath extends AppScreenPath> = ScreenPropsForPath<TPath> extends {
+export interface TailorKitSlots {
+}
+export type SlotName = keyof TailorKitSlots & string;
+export type ViewPath = Extract<keyof TailorKitViews & string, `/${string}`>;
+export type AppViewPath = ViewPath;
+export type ViewProps<TPath extends ViewPath> = TailorKitViews[TPath] extends object ? TailorKitViews[TPath] : Record<string, never>;
+export type ViewPropsForPath<TPath extends AppViewPath> = TPath extends ViewPath ? ViewProps<TPath> : never;
+export type ViewContext<TPath extends AppViewPath> = ViewPropsForPath<TPath> extends {
     context: infer TContext;
 } ? TContext : Record<string, never>;
 export type View<TProps extends object = Record<string, never>> = (props: TProps) => ComponentChild;
-export type ScreenRuntimeProps<TPath extends AppScreenPath> = {
-    context: ScreenContext<TPath>;
-    screen: TPath;
+export type ViewRuntimeProps<TPath extends AppViewPath> = {
+    context: ViewContext<TPath>;
+    view: TPath;
     status: "ready";
 } | {
     context?: never;
-    screen: TPath;
+    view: TPath;
     status: "loading";
 } | {
     context?: never;
-    screen: TPath;
+    view: TPath;
     status: "error";
 };
-export interface ScreenDefinition<TPath extends AppScreenPath = AppScreenPath> {
-    component: View<ScreenRuntimeProps<TPath>>;
+export interface ViewDefinition<TPath extends AppViewPath = AppViewPath> {
+    component: View<ViewRuntimeProps<TPath>>;
     path: TPath;
-    useContext: () => ScreenContext<TPath>;
+    useContext: () => ViewContext<TPath>;
 }
-type RegisteredScreens = {
-    [TPath in AppScreenPath]: ScreenDefinition<TPath>;
+type RegisteredViews = {
+    [TPath in AppViewPath]: ViewDefinition<TPath>;
+};
+type ViewDefinitions = Partial<{
+    [P in AppViewPath]: RegisteredViews[P] | false;
+}>;
+type InvalidViewPath<TViews> = Exclude<keyof TViews & string, AppViewPath>;
+type RequireViewPaths<TViews> = InvalidViewPath<TViews> extends never ? unknown : {
+    readonly __tailorkit_error__: `View paths must be declared by the host. Invalid view: ${InvalidViewPath<TViews>}`;
 };
-type ScreenDefinitions = Partial<RegisteredScreens>;
-type InvalidScreenPath<TScreens> = Exclude<keyof TScreens & string, `/${string}`>;
-type RequireScreenPaths<TScreens> = InvalidScreenPath<TScreens> extends never ? unknown : {
-    readonly __tailorkit_error__: `Screen paths must start with "/". Invalid screen: ${InvalidScreenPath<TScreens>}`;
+type ViewKeyPathMismatch<TViews> = {
+    [TPath in keyof TViews & string]: TViews[TPath] extends false ? never : TViews[TPath] extends ViewDefinition<infer TViewPath> ? TViewPath extends TPath ? never : TPath : TPath;
+}[keyof TViews & string];
+type RequireMatchingViewKeys<TViews> = ViewKeyPathMismatch<TViews> extends never ? unknown : {
+    readonly __tailorkit_error__: `View key must match createView path. Invalid view: ${ViewKeyPathMismatch<TViews>}`;
 };
-type ScreenKeyPathMismatch<TScreens> = {
-    [TPath in keyof TScreens & string]: TScreens[TPath] extends ScreenDefinition<infer TScreenPath> ? TScreenPath extends TPath ? never : TPath : TPath;
-}[keyof TScreens & string];
-type RequireMatchingScreenKeys<TScreens> = ScreenKeyPathMismatch<TScreens> extends never ? unknown : {
-    readonly __tailorkit_error__: `Screen key must match createScreen path. Invalid screen: ${ScreenKeyPathMismatch<TScreens>}`;
+export type SlotView<TSlot extends SlotName> = Extract<TailorKitSlots[TSlot], AppViewPath>;
+type SlotDefinitions = {
+    [V in SlotName]?: Pick<ViewDefinitions, SlotView<V>>;
 };
-export interface TailorKitClient<TScreens extends ScreenDefinitions = ScreenDefinitions> {
-    screens: TScreens;
+type RequireSlotViews<V, S> = V extends SlotName ? Exclude<keyof S, SlotView<V>> extends never ? unknown : {
+    readonly __tailorkit_error__: "View is not supported by this slot";
+} : never;
+export interface TailorKitClient<TSlots extends SlotDefinitions = SlotDefinitions> {
+    slots: TSlots;
 }
 export interface TailorKitClientMeta {
     preactVersion: string;
 }
 export interface TailorKitClientRuntime {
     h: typeof h;
-    render: (vnode: VNode, parent: Element | Document | ShadowRoot | DocumentFragment) => void;
+    render: (vnode: VNode | null, parent: Element | Document | ShadowRoot | DocumentFragment) => void;
 }
-export type TailorKitClientWithMeta<TScreens extends ScreenDefinitions = ScreenDefinitions> = TailorKitClient<TScreens> & {
+export type TailorKitClientWithMeta<TViews extends SlotDefinitions = SlotDefinitions> = TailorKitClient<TViews> & {
     $meta: TailorKitClientMeta;
     $runtime: TailorKitClientRuntime;
 };
-export declare const createScreen: <const TPath extends AppScreenPath>(path: TPath, options: {
+export declare const createView: <const TPath extends AppViewPath>(path: TPath, options: {
     component: View<Record<string, never>>;
     error?: View<Record<string, never>>;
     loading?: View<Record<string, never>>;
-}) => ScreenDefinition<TPath>;
-export declare const defineClient: <const TScreens extends ScreenDefinitions>(client: TailorKitClient<TScreens> & RequireScreenPaths<TScreens> & RequireMatchingScreenKeys<TScreens>) => TailorKitClientWithMeta<TScreens>;
+}) => ViewDefinition<TPath>;
+export declare const defineClient: <const TSlots extends SlotDefinitions>(client: TailorKitClient<TSlots> & {
+    slots: { [V in keyof TSlots]: TSlots[V] & RequireViewPaths<TSlots[V]> & RequireMatchingViewKeys<TSlots[V]> & RequireSlotViews<V, TSlots[V]>; };
+} & (Exclude<keyof TSlots, SlotName> extends never ? unknown : {
+    __tailorkit_error__: "Unknown slot";
+})) => TailorKitClientWithMeta<TSlots>;
 export declare const createRemoteComponent: <TProps extends object, TChildren extends boolean = false>(name: string, options?: {
     callbacks?: Record<string, number>;
     children?: TChildren;

package/dist/index.js

@@ -2,9 +2,9 @@
 import { createContext, h, render } from "preact";
 import { useContext } from "preact/hooks";
 var preactVersion = "10.29.8";
-var createScreen = (path, options) => {
+var createView = (path, options) => {
   const Context = createContext(null);
-  const Screen = (props) => {
+  const View = (props) => {
     if (props.status === "loading") {
       return options.loading ? h(options.loading, {}) : null;
     }
@@ -18,12 +18,12 @@ var createScreen = (path, options) => {
     );
   };
   return {
-    component: Screen,
+    component: View,
     path,
     useContext: () => {
       const context = useContext(Context);
       if (context === null) {
-        throw new Error(`Screen context is only available while rendering "${path}".`);
+        throw new Error(`View context is only available while rendering "${path}".`);
       }
       return context;
     }
@@ -31,13 +31,8 @@ var createScreen = (path, options) => {
 };
 var defineClient = (client) => ({
   ...client,
-  $meta: {
-    preactVersion
-  },
-  $runtime: {
-    h,
-    render
-  }
+  $meta: { preactVersion },
+  $runtime: { h, render }
 });
 var componentTagPrefix = "tailorkit-";
 var toComponentTagName = (name) => `${componentTagPrefix}${name.replaceAll(/([a-z0-9])([A-Z])/gu, "$1-$2").replaceAll(/[\s_]+/gu, "-").toLowerCase()}`;
@@ -73,6 +68,6 @@ var createRemoteComponent = (name, options = {}) => {
 };
 export {
   createRemoteComponent,
-  createScreen,
+  createView,
   defineClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailorkit/app",
-  "version": "0.1.0-beta.8",
+  "version": "0.1.0-beta.9",
   "license": "AGPL-3.0-only",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@tailorkit/core": "0.1.0-beta.8",
+    "@tailorkit/core": "0.1.0-beta.9",
     "cosmiconfig": "^10.0.0",
     "vite": "^8.2.2",
     "zod": "^4.4.3"