@arcote.tech/platform 0.4.1

package/src/types.ts

@@ -0,0 +1,165 @@
+import type { ComponentType, LazyExoticComponent, ReactNode } from "react";
+import type { ArcContextElementAny } from "@arcote.tech/arc";
+
+// ---------------------------------------------------------------------------
+// Slot IDs
+// ---------------------------------------------------------------------------
+
+export type SlotId = string & { readonly __brand?: "SlotId" };
+
+// ---------------------------------------------------------------------------
+// Ordering
+// ---------------------------------------------------------------------------
+
+export interface FragmentOrdering {
+  /** Niższy = wcześniej. Domyślnie 0. */
+  order?: number;
+  /** Renderuj po fragmencie o podanym id. */
+  after?: string;
+  /** Renderuj przed fragmentem o podanym id. */
+  before?: string;
+}
+
+// ---------------------------------------------------------------------------
+// Fragment base — unified interface for all fragments
+// ---------------------------------------------------------------------------
+
+export type ArcComponent = ComponentType<any> | LazyExoticComponent<ComponentType<any>>;
+
+interface FragmentBase {
+  readonly id: string;
+  readonly types: readonly string[];
+  moduleId: string;
+  is(type: string): boolean;
+}
+
+// ---------------------------------------------------------------------------
+// Concrete fragment types
+// ---------------------------------------------------------------------------
+
+export interface SlotFragment extends FragmentBase {
+  readonly types: readonly ["slot"];
+  readonly slotId: SlotId;
+  readonly component: ArcComponent;
+  readonly ordering: FragmentOrdering;
+}
+
+export type ArcLayoutComponent = ComponentType<{ children: ReactNode }>;
+
+export interface PageFragment<
+  TPath extends string = string,
+> extends FragmentBase {
+  readonly types: readonly ["page"];
+  readonly path: TPath;
+  readonly component: ArcComponent;
+  readonly layout?: ArcLayoutComponent;
+  readonly icon?: ComponentType<{ className?: string }>;
+  readonly label?: string | ReactNode;
+  readonly tooltip?: string | ReactNode;
+  readonly children?: readonly PageFragment[];
+}
+
+export type PageShellProps = {
+  children: ReactNode;
+  tabs: readonly PageFragment[];
+};
+
+export interface WrapperFragment extends FragmentBase {
+  readonly types: readonly ["wrapper"];
+  readonly component: ComponentType<{ children: ReactNode }>;
+  readonly ordering: FragmentOrdering;
+}
+
+export interface ContextElementFragment extends FragmentBase {
+  readonly types: readonly ["context-element"];
+  readonly element: ArcContextElementAny;
+}
+
+export type ArcFragment =
+  | SlotFragment
+  | PageFragment
+  | WrapperFragment
+  | ContextElementFragment;
+
+export type PublicArcFragment = ArcFragment;
+
+// ---------------------------------------------------------------------------
+// Moduł
+// ---------------------------------------------------------------------------
+
+export interface ArcModule {
+  readonly id: string;
+  readonly fragments: readonly ArcFragment[];
+  readonly publicFragments: readonly ArcFragment[];
+}
+
+// ---------------------------------------------------------------------------
+// Built Module — enriched return type from module().build()
+// ---------------------------------------------------------------------------
+
+export type ExtractPages<T> = {
+  readonly [K in keyof T]: T[K] extends PageFragment<infer P> ? P : never;
+};
+
+export type BuiltModule<
+  TPages = {},
+  TCtx = undefined,
+  TScope extends string | undefined = undefined,
+> = ArcModule & {
+  readonly pages: Readonly<TPages>;
+} & (TCtx extends undefined ? {} : { readonly context: TCtx })
+  & (TScope extends undefined ? {} : { readonly scope: TScope });
+
+// ---------------------------------------------------------------------------
+// Typed navigation
+// ---------------------------------------------------------------------------
+
+/** @deprecated Use module().build() pages field instead */
+export type PublicPaths<T extends ArcModule> =
+  T["publicFragments"][number] extends infer F
+    ? F extends PageFragment<infer P>
+      ? P
+      : never
+    : never;
+
+// ---------------------------------------------------------------------------
+// Factory (deprecated — use module() instead)
+// ---------------------------------------------------------------------------
+
+export interface SlotOptions extends FragmentOrdering {
+  id?: string;
+}
+
+export interface PageOptions {
+  id?: string;
+  layout?: ArcLayoutComponent;
+  icon?: ComponentType<{ className?: string }>;
+  label?: string | ReactNode;
+  tooltip?: string | ReactNode;
+  children?: PageFragment[];
+}
+
+export interface WrapperOptions extends FragmentOrdering {
+  id?: string;
+}
+
+export interface ArcFactoryMethods {
+  slot: (
+    slotId: SlotId | string,
+    component: ArcComponent,
+    options?: SlotOptions,
+  ) => SlotFragment;
+  page: <TPath extends string>(
+    path: TPath,
+    component: ArcComponent,
+    options?: PageOptions,
+  ) => PageFragment<TPath>;
+  wrapper: (
+    component: ComponentType<{ children: ReactNode }>,
+    options?: WrapperOptions,
+  ) => WrapperFragment;
+}
+
+export type ArcFactory = (
+  methods: ArcFactoryMethods,
+) => PublicArcFragment[] | void;