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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,11 +2,11 @@ import type { CSSProperties, ReactNode } from "react";
2
2
  import type { TailorKitTheme } from "@tailorkit/core/schema";
3
3
  type PrimitiveProps = Record<string, unknown>;
4
4
  interface PrimitiveThemeContextValue {
5
- screenId: string;
5
+ viewId: string;
6
6
  theme: TailorKitTheme;
7
7
  }
8
8
  export declare const PrimitiveThemeContext: import("react").Context<PrimitiveThemeContextValue | null>;
9
- export declare const buildThemeCss: (screenId: string, theme: TailorKitTheme) => string;
9
+ export declare const buildThemeCss: (viewId: string, theme: TailorKitTheme) => string;
10
10
  export declare const primitives: {
11
11
  readonly Box: ({ props, children }: {
12
12
  props: PrimitiveProps;
@@ -0,0 +1,33 @@
1
+ import type { TailorKitSchemaSpecType } from "@tailorkit/core/spec";
2
+ import type { TailorKitApp } from "./tailor-kit";
3
+ export interface TailorKitAppsSnapshot {
4
+ apps: TailorKitApp[];
5
+ error: Error | null;
6
+ status: "error" | "idle" | "loading" | "ready";
7
+ }
8
+ interface TailorKitMetaSnapshot {
9
+ assetsBaseUrl: string | null;
10
+ error: Error | null;
11
+ schema: TailorKitSchemaSpecType | null;
12
+ status: "error" | "idle" | "loading" | "ready";
13
+ }
14
+ export type TailorKitStore = ReturnType<typeof createTailorKitStore>;
15
+ export declare function createTailorKitStore(baseUrlInput: string | URL, initialApps?: TailorKitApp[]): {
16
+ baseUrl: URL;
17
+ views: {
18
+ getSnapshot: () => import("@tailorkit/core/views").ActiveView | null;
19
+ subscribe(listener: () => void): () => void;
20
+ register(entry: Omit<import("./view-registry").ViewEntry, "order">): void;
21
+ unregister(id: symbol): void;
22
+ };
23
+ setProvidedApps(apps: TailorKitApp[] | undefined): void;
24
+ fetchApps: (options?: {
25
+ force?: boolean;
26
+ }) => Promise<void>;
27
+ fetchMeta: () => Promise<void>;
28
+ getAppsSnapshot: () => TailorKitAppsSnapshot;
29
+ getMetaSnapshot: () => TailorKitMetaSnapshot;
30
+ subscribe: (listener: () => void) => (() => void);
31
+ };
32
+ export declare function toBaseUrl(value: string | URL): URL;
33
+ export {};
@@ -1,10 +1,7 @@
1
1
  import type { ReactNode } from "react";
2
- import type { TailorKitSchemaSpecType } from "@tailorkit/core/spec";
3
- import type { TailorKitTheme, CallbackMap, ComponentDefinition, ComponentProps, Schema, ScreenDefinition, TailorKitSchema } from "@tailorkit/core/schema";
2
+ import type { TailorKitTheme, CallbackMap, ComponentDefinition, ComponentProps, Schema, ViewDefinition, SlotDefinitions, TailorKitSchema } from "@tailorkit/core/schema";
4
3
  import type { primitives } from "./primitives";
5
- import { Root } from "./components";
6
- import type { UseAppsResult } from "./hooks/use-apps";
7
- import type { CurrentScreenOptions, ScreenName } from "./hooks/use-current-screen";
4
+ import type { ViewOptions, ViewName } from "./hooks/use-view";
8
5
  type AnyComponentDefinition = ComponentDefinition<Schema | undefined, CallbackMap, boolean | undefined>;
9
6
  type ComponentRenderer<TComponent extends AnyComponentDefinition> = (args: {
10
7
  props: ComponentProps<TComponent>;
@@ -32,57 +29,56 @@ export interface TailorKitApp {
32
29
  } | null;
33
30
  name?: string;
34
31
  }
35
- export interface TailorKitAppsSnapshot {
36
- apps: TailorKitApp[];
37
- error: Error | null;
38
- status: "error" | "idle" | "loading" | "ready";
39
- }
40
- interface TailorKitMetaSnapshot {
41
- assetsBaseUrl: string | null;
42
- error: Error | null;
43
- schema: TailorKitSchemaSpecType | null;
44
- status: "error" | "idle" | "loading" | "ready";
45
- }
46
- export interface CurrentScreenEntry {
47
- context: unknown;
48
- id: symbol;
49
- order: number;
50
- screen: string;
51
- status: "error" | "loading" | "ready";
52
- }
53
32
  interface AppViewBaseProps {
54
33
  app: TailorKitApp;
55
34
  createIframe?: () => HTMLIFrameElement;
56
35
  fallback?: ReactNode;
57
36
  }
58
- type AppViewScreenProps<TScreens extends Record<string, ScreenDefinition>, TScreen extends ScreenName<TScreens> = ScreenName<TScreens>> = [ScreenName<TScreens>] extends [never] ? {
37
+ type AppViewViewProps<TViews extends Record<string, ViewDefinition>, TView extends ViewName<TViews> = ViewName<TViews>> = [ViewName<TViews>] extends [never] ? {
59
38
  context?: never;
60
- screen?: never;
39
+ view?: never;
61
40
  status?: never;
62
41
  } : {
63
42
  context?: never;
64
- screen?: never;
43
+ view?: never;
65
44
  status?: never;
66
- } | CurrentScreenOptions<TScreens, TScreen>;
67
- export type AppViewProps<TScreens extends Record<string, ScreenDefinition>, TScreen extends ScreenName<TScreens> = ScreenName<TScreens>> = AppViewBaseProps & AppViewScreenProps<TScreens, TScreen>;
68
- export interface TailorKitInstance<TScreens extends Record<string, ScreenDefinition> = Record<string, never>> {
69
- AppView: (props: AppViewProps<TScreens>) => ReactNode;
70
- Root: (props: Omit<Parameters<typeof Root>[0], "tailor">) => ReactNode;
71
- getApp: (id: string) => TailorKitApp | undefined;
72
- getApps: () => TailorKitApp[];
73
- useApps: () => UseAppsResult;
74
- useCurrentScreen: <TScreen extends ScreenName<TScreens>>(options: CurrentScreenOptions<TScreens, TScreen>) => void;
45
+ } | ViewOptions<TViews, TView>;
46
+ export type AppViewProps<TViews extends Record<string, ViewDefinition> = RegisteredViews, TView extends ViewName<TViews> = ViewName<TViews>> = {
47
+ [V in RegisteredSlots]: AppViewBaseProps & {
48
+ slot: V;
49
+ } & AppViewViewProps<TViews, Extract<TView, SlotView<V>>>;
50
+ }[RegisteredSlots];
51
+ export interface Register {
52
+ }
53
+ export type RegisteredViews = Register extends {
54
+ client: TailorKitInstance<infer S>;
55
+ } ? S : Record<`/${string}`, ViewDefinition>;
56
+ type RegisteredSlotMap = Register extends {
57
+ client: {
58
+ readonly $slots?: infer V;
59
+ };
60
+ } ? V : SlotDefinitions;
61
+ export type RegisteredSlots = keyof RegisteredSlotMap & string;
62
+ type SlotView<V extends RegisteredSlots> = RegisteredSlotMap[V] extends {
63
+ views: readonly (infer P)[];
64
+ } ? Extract<P, string> : never;
65
+ export interface TailorKitInstance<TViews extends Record<string, ViewDefinition> = Record<string, ViewDefinition>, TSlots extends SlotDefinitions = SlotDefinitions> {
66
+ readonly $slots?: TSlots;
67
+ readonly $views?: TViews;
68
+ readonly baseUrl: string | URL;
69
+ readonly components: Record<string, unknown>;
70
+ readonly theme: TailorKitTheme;
75
71
  }
76
72
  type PrimitiveRenderers = typeof primitives;
77
73
  type CustomComponentRenderers<TComponents extends Record<string, AnyComponentDefinition>> = {
78
74
  [TName in Exclude<keyof TComponents, keyof PrimitiveRenderers>]?: ComponentRenderer<TComponents[TName]>;
79
75
  };
80
- export declare function components<TComponents extends Record<string, AnyComponentDefinition>>(_schema: TailorKitSchema<TComponents, Record<string, ScreenDefinition>>, customComponents: CustomComponentRenderers<TComponents>): ComponentRenderers<TComponents>;
76
+ export declare function components<TComponents extends Record<string, AnyComponentDefinition>>(_schema: TailorKitSchema<TComponents, Record<string, ViewDefinition>>, customComponents: CustomComponentRenderers<TComponents>): ComponentRenderers<TComponents>;
81
77
  interface TailorKitServerShape {
82
78
  $internal: {
83
79
  schema: {
84
80
  components: Record<string, unknown>;
85
- screens: Record<string, unknown>;
81
+ views: Record<string, unknown>;
86
82
  };
87
83
  };
88
84
  }
@@ -90,29 +86,15 @@ type ServerComponentMap<TTailor extends TailorKitServerShape> = TTailor["$intern
90
86
  type ServerComponents<TTailor extends TailorKitServerShape> = {
91
87
  [TName in keyof ServerComponentMap<TTailor>]: ServerComponentMap<TTailor>[TName] extends AnyComponentDefinition ? ServerComponentMap<TTailor>[TName] : never;
92
88
  };
93
- type ServerScreenMap<TTailor extends TailorKitServerShape> = TTailor["$internal"]["schema"]["screens"];
94
- type ServerScreens<TTailor extends TailorKitServerShape> = {
95
- [TName in keyof ServerScreenMap<TTailor>]: ServerScreenMap<TTailor>[TName] extends ScreenDefinition ? ServerScreenMap<TTailor>[TName] : never;
89
+ type ServerViewMap<TTailor extends TailorKitServerShape> = TTailor["$internal"]["schema"]["views"];
90
+ type ServerViews<TTailor extends TailorKitServerShape> = {
91
+ [TName in keyof ServerViewMap<TTailor>]: ServerViewMap<TTailor>[TName] extends ViewDefinition ? ServerViewMap<TTailor>[TName] : never;
96
92
  };
97
93
  export declare function createTailorKitClient<TTailor extends TailorKitServerShape>(options: {
98
94
  baseUrl: string | URL;
99
95
  components?: CompleteComponentRenderers<ServerComponents<TTailor>>;
100
96
  theme?: TailorKitTheme;
101
- }): TailorKitInstance<ServerScreens<TTailor>>;
102
- export type TailorKitStore = ReturnType<typeof createTailorKitStore>;
103
- declare function createTailorKitStore(baseUrlInput: string | URL): {
104
- baseUrl: URL;
105
- fetchApps: (options?: {
106
- force?: boolean;
107
- }) => Promise<void>;
108
- fetchMeta: () => Promise<void>;
109
- getApp: (id: string) => TailorKitApp | undefined;
110
- getApps: () => TailorKitApp[];
111
- getAppsSnapshot: () => TailorKitAppsSnapshot;
112
- getCurrentScreen: () => CurrentScreenEntry | null;
113
- getMetaSnapshot: () => TailorKitMetaSnapshot;
114
- registerScreen: (entry: Omit<CurrentScreenEntry, "order">) => void;
115
- subscribe: (listener: () => void) => (() => void);
116
- unregisterScreen: (id: symbol) => void;
117
- };
118
- export type { CurrentScreenOptions } from "./hooks/use-current-screen";
97
+ }): TailorKitInstance<ServerViews<TTailor>, TTailor extends {
98
+ readonly $slots?: infer V extends SlotDefinitions;
99
+ } ? V : SlotDefinitions>;
100
+ export type { ViewOptions } from "./hooks/use-view";
@@ -0,0 +1,14 @@
1
+ import type { ActiveView, ViewStatus } from "@tailorkit/core/views";
2
+ export interface ViewEntry {
3
+ id: symbol;
4
+ view: string;
5
+ context: unknown;
6
+ status: ViewStatus;
7
+ order: number;
8
+ }
9
+ export declare function createViewRegistry(): {
10
+ getSnapshot: () => ActiveView | null;
11
+ subscribe(listener: () => void): () => void;
12
+ register(entry: Omit<ViewEntry, "order">): void;
13
+ unregister(id: symbol): void;
14
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tailorkit/react",
3
- "version": "0.1.0-beta.8",
3
+ "version": "0.1.0-beta.9",
4
4
  "license": "AGPL-3.0-only",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,8 +23,8 @@
23
23
  "dependencies": {
24
24
  "@floating-ui/react-dom": "^2.1.9",
25
25
  "@standard-schema/spec": "^1.1.0",
26
- "@tailorkit/core": "0.1.0-beta.8",
27
- "@tailorkit/sandbox": "0.1.0-beta.8"
26
+ "@tailorkit/core": "0.1.0-beta.9",
27
+ "@tailorkit/sandbox": "0.1.0-beta.9"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@tailorkit/config": "0.0.0",
@@ -1,23 +0,0 @@
1
- import type { StandardJSONSchemaV1 } from "@standard-schema/spec";
2
- import type { ScreenDefinition } from "@tailorkit/core/schema";
3
- import type { TailorKitStore } from "../tailor-kit";
4
- export type ScreenName<TScreens extends Record<string, ScreenDefinition>> = keyof TScreens & string;
5
- export type ScreenContext<TScreen> = TScreen extends ScreenDefinition<infer TContext> ? TContext extends StandardJSONSchemaV1 ? StandardJSONSchemaV1.InferOutput<TContext> : Record<string, never> : never;
6
- interface ReadyScreenOptions<TScreens extends Record<string, ScreenDefinition>, TScreen extends ScreenName<TScreens>> {
7
- context: ScreenContext<TScreens[TScreen]>;
8
- screen: TScreen;
9
- status?: "ready";
10
- }
11
- interface LoadingScreenOptions<TScreen extends string> {
12
- context?: never;
13
- screen: TScreen;
14
- status: "loading";
15
- }
16
- interface ErrorScreenOptions<TScreen extends string> {
17
- context?: never;
18
- screen: TScreen;
19
- status: "error";
20
- }
21
- export type CurrentScreenOptions<TScreens extends Record<string, ScreenDefinition>, TScreen extends ScreenName<TScreens> = ScreenName<TScreens>> = TScreen extends ScreenName<TScreens> ? ReadyScreenOptions<TScreens, TScreen> | LoadingScreenOptions<TScreen> | ErrorScreenOptions<TScreen> : never;
22
- export declare function createUseCurrentScreen<TScreens extends Record<string, ScreenDefinition>>(store: TailorKitStore): <TScreen extends ScreenName<TScreens>>(options: CurrentScreenOptions<TScreens, TScreen>) => void;
23
- export {};