likec4 1.59.4 → 1.61.0

package/vite-plugin-modules.d.ts

@@ -33,25 +33,17 @@ declare module 'likec4:projects-overview' {
 }
 
 declare module 'likec4:icons' {
-  import type { ReactNode } from 'react'
-
-  export type ElementIconRendererProps = {
-    node: {
-      id: string
-      title: string
-      icon?: string | null | undefined
-    }
-  }
+  import type { ElementIconRenderer, ElementIconRendererProps } from 'likec4/react'
 
-  export type ElementIconRenderer = (props: ElementIconRendererProps) => ReactNode
+  export type { ElementIconRenderer, ElementIconRendererProps }
   export function getProjectIcons(projectId: string): ElementIconRenderer
 }
 
 declare module 'likec4:model' {
-  import type { DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted } from 'likec4/model'
+  import type { DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted, ViewId } from 'likec4/model'
   import type { Atom } from 'likec4/vite-plugin/internal'
 
-  export type { Atom, DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted }
+  export type { Atom, DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted, ViewId }
 
   export function loadModel(projectId: string): Promise<{
     $likec4data: Atom<LayoutedLikeC4ModelData>
@@ -59,6 +51,7 @@ declare module 'likec4:model' {
     useLikeC4Model: () => LikeC4Model<UnknownLayouted>
     useLikeC4Views: () => ReadonlyArray<DiagramView<UnknownLayouted>>
     useLikeC4View: (viewId: string) => DiagramView<UnknownLayouted> | null
+    isLikeC4ViewId: (value: unknown) => value is ViewId
   }>
 }
 
@@ -69,15 +62,19 @@ declare module 'likec4:single-project' {
     LikeC4Model,
     types,
     UnknownLayouted,
+    ViewId,
   } from 'likec4/model'
   import type { Atom } from 'likec4/vite-plugin/internal'
   import type { ElementIconRenderer } from 'likec4:icons'
 
+  export type { Atom, DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted, ViewId }
+
   export const $likec4data: Atom<LayoutedLikeC4ModelData>
   export const $likec4model: Atom<LikeC4Model<UnknownLayouted>>
   export function useLikeC4Model(): LikeC4Model<UnknownLayouted>
   export function useLikeC4Views(): ReadonlyArray<DiagramView<UnknownLayouted>>
   export function useLikeC4View(viewId: string): DiagramView<UnknownLayouted> | null
+  export function isLikeC4ViewId(value: unknown): value is ViewId
 
   export const IconRenderer: ElementIconRenderer
 
@@ -85,23 +82,39 @@ declare module 'likec4:single-project' {
 }
 
 declare module 'likec4:react' {
-  import type { aux, DiagramView, LikeC4Model, UnknownLayouted } from 'likec4/model'
-  import type { LikeC4ViewProps, ReactLikeC4Props } from 'likec4/react'
+  import type {
+    aux,
+    DiagramView,
+    LayoutedLikeC4ModelData,
+    LayoutedView,
+    LikeC4Model,
+    UnknownLayouted,
+  } from 'likec4/model'
+  import type { ElementIconRendererProps, LikeC4ViewProps, ReactLikeC4Props } from 'likec4/react'
   import type { JSX, PropsWithChildren } from 'react'
+  import type { Atom } from 'likec4/vite-plugin/internal'
 
-  // This will be used later for augmenting the types
-  interface Types extends UnknownLayouted {
+  export type { Atom, DiagramView, LayoutedView, LikeC4Model, UnknownLayouted }
+
+  // This will be used for augmenting the types
+  export interface Register {
   }
+  export type $Types<T = Register> = T extends { aux: infer A extends aux.Any } ? A : UnknownLayouted
 
-  export type LikeC4ViewId = aux.ViewId<Types>
+  export type LikeC4ViewId = aux.ViewId<$Types>
 
-  export function useLikeC4Model(): LikeC4Model<Types>
-  export function useLikeC4Views(): ReadonlyArray<DiagramView<Types>>
-  export function useLikeC4View(viewId: LikeC4ViewId): DiagramView<Types> | null
+  // Re-export from likec4:model
+  export const $likec4data: Atom<LayoutedLikeC4ModelData<$Types>>
+  export const $likec4model: Atom<LikeC4Model<$Types>>
+  export function useLikeC4Model(): LikeC4Model<$Types>
+  export function useLikeC4Views(): ReadonlyArray<LayoutedView<$Types>>
+  export function useLikeC4View(viewId: LikeC4ViewId): LayoutedView<$Types> | null
+  export function isLikeC4ViewId(value: unknown): value is LikeC4ViewId
 
   export function LikeC4ModelProvider(props: PropsWithChildren): JSX.Element
-  export function LikeC4View({ viewId, ...props }: LikeC4ViewProps<Types>): JSX.Element
-  export function ReactLikeC4({ viewId, ...props }: ReactLikeC4Props<Types>): JSX.Element
+  export function LikeC4View({ viewId, ...props }: LikeC4ViewProps<$Types>): JSX.Element
+  export function ReactLikeC4({ viewId, ...props }: ReactLikeC4Props<$Types>): JSX.Element
+  export function IconRenderer(props: ElementIconRendererProps): JSX.Element
 }
 
 declare module 'likec4:dot' {
@@ -130,56 +143,102 @@ declare module 'likec4:drawio' {
     drawioEditUrl(this: void, viewId: string): string
   }>
 }
+declare module 'likec4:diffs' {
+  import type { DiffSummary, LayoutedView } from 'likec4/model'
+  import type { Atom } from 'likec4/vite-plugin/internal'
+
+  /**
+   * Diffs of the project, with the compare views of the views they change (by diff id, then by view id)
+   */
+  export interface ProjectDiffs {
+    diffs: DiffSummary[]
+    views: Record<string, Record<string, LayoutedView>>
+  }
+
+  export function loadDiffs(projectId: string): Promise<{
+    $diffs: Atom<ProjectDiffs>
+  }>
+}
 
 // Per project
 
+declare module 'likec4:diffs/*' {
+  import type { ProjectDiffs } from 'likec4:diffs'
+  import type { Atom } from 'likec4/vite-plugin/internal'
+
+  export const $diffs: Atom<ProjectDiffs>
+}
+
 declare module 'likec4:model/*' {
-  import type { aux, DiagramView, LayoutedLikeC4ModelData, LikeC4Model, UnknownLayouted } from 'likec4/model'
-  import type { Atom } from 'likec4:model'
+  import type {
+    aux,
+    DiagramView,
+    LayoutedLikeC4ModelData,
+    LayoutedView,
+    LikeC4Model,
+    UnknownLayouted,
+  } from 'likec4/model'
+  import type { ElementIconRendererProps, LikeC4ViewProps, ReactLikeC4Props } from 'likec4/react'
+  import type { Atom } from 'likec4/vite-plugin/internal'
+
+  export type { Atom, DiagramView, LayoutedView, LikeC4Model, UnknownLayouted }
 
-  // This will be used later for augmenting the types
-  interface Types extends UnknownLayouted {
+  // This will be used for augmenting the types
+  export interface Register {
   }
+  export type $Types<T = Register> = T extends { aux: infer A extends aux.Any } ? A : UnknownLayouted
 
-  export type LikeC4ViewId = aux.ViewId<Types>
+  export type LikeC4ViewId = aux.ViewId<$Types>
 
-  export const $likec4data: Atom<LayoutedLikeC4ModelData<Types>>
-  export const $likec4model: Atom<LikeC4Model<Types>>
-  export function useLikeC4Model(): LikeC4Model<Types>
-  export function useLikeC4Views(): ReadonlyArray<DiagramView<Types>>
-  export function useLikeC4View(viewId: LikeC4ViewId): DiagramView<Types> | null
+  export const $likec4data: Atom<LayoutedLikeC4ModelData<$Types>>
+  export const $likec4model: Atom<LikeC4Model<$Types>>
+  export function useLikeC4Model(): LikeC4Model<$Types>
+  export function useLikeC4Views(): ReadonlyArray<LayoutedView<$Types>>
+  export function useLikeC4View(viewId: LikeC4ViewId): LayoutedView<$Types> | null
+  export function isLikeC4ViewId(value: unknown): value is LikeC4ViewId
 }
 
 declare module 'likec4:icons/*' {
-  import type { ReactNode } from 'react'
-  type ElementIconRendererProps = {
-    node: {
-      id: string
-      title: string
-      icon?: string | null | undefined
-    }
-  }
-  export function IconRenderer(props: ElementIconRendererProps): ReactNode
+  import type { JSX } from 'react'
+  import type { ElementIconRendererProps } from 'likec4/react'
+
+  export function IconRenderer(props: ElementIconRendererProps): JSX.Element
 }
 
 declare module 'likec4:react/*' {
-  import type { aux, DiagramView, LikeC4Model, UnknownLayouted } from 'likec4/model'
-  import type { LikeC4ViewProps, ReactLikeC4Props } from 'likec4/react'
+  import type {
+    aux,
+    DiagramView,
+    LayoutedLikeC4ModelData,
+    LayoutedView,
+    LikeC4Model,
+    UnknownLayouted,
+  } from 'likec4/model'
+  import type { ElementIconRendererProps, LikeC4ViewProps, ReactLikeC4Props } from 'likec4/react'
   import type { JSX, PropsWithChildren } from 'react'
+  import type { Atom } from 'likec4/vite-plugin/internal'
 
-  // This will be used later for augmenting the types
-  interface Types extends UnknownLayouted {
+  export type { Atom, DiagramView, LayoutedView, LikeC4Model, UnknownLayouted }
+
+  // This will be used for augmenting the types
+  export interface Register {
   }
+  export type $Types<T = Register> = T extends { aux: infer A extends aux.Any } ? A : UnknownLayouted
 
-  export type LikeC4ViewId = aux.ViewId<Types>
+  export type LikeC4ViewId = aux.ViewId<$Types>
 
-  export function useLikeC4Model(): LikeC4Model<Types>
-  export function useLikeC4Views(): ReadonlyArray<DiagramView<Types>>
-  export function useLikeC4View(viewId: LikeC4ViewId): DiagramView<Types> | null
+  // Re-export from likec4:model
+  export const $likec4data: Atom<LayoutedLikeC4ModelData<$Types>>
+  export const $likec4model: Atom<LikeC4Model<$Types>>
+  export function useLikeC4Model(): LikeC4Model<$Types>
+  export function useLikeC4Views(): ReadonlyArray<LayoutedView<$Types>>
+  export function useLikeC4View(viewId: LikeC4ViewId): LayoutedView<$Types> | null
+  export function isLikeC4ViewId(value: unknown): value is LikeC4ViewId
 
   export function LikeC4ModelProvider(props: PropsWithChildren): JSX.Element
-  export function LikeC4View({ viewId, ...props }: LikeC4ViewProps<Types>): JSX.Element
-  export function ReactLikeC4({ viewId, ...props }: ReactLikeC4Props<Types>): JSX.Element
+  export function LikeC4View({ viewId, ...props }: LikeC4ViewProps<$Types>): JSX.Element
+  export function ReactLikeC4({ viewId, ...props }: ReactLikeC4Props<$Types>): JSX.Element
+  export function IconRenderer(props: ElementIconRendererProps): JSX.Element
 }
 
 declare module 'likec4:webcomponents/*' {
@@ -207,6 +266,9 @@ declare module 'likec4:rpc' {
 declare module 'likec4:app-config' {
   export let ComponentName: {
     View: string
+    /**
+     * @deprecated
+     */
     Browser: string
   }
   export let pageTitle: string
@@ -217,3 +279,16 @@ declare module 'likec4:app-config' {
   export let krokiD2SvgUrl: string
   export let krokiPumlSvgUrl: string
 }
+
+declare module 'likec4:customization' {
+  import type { CustomComponents } from 'likec4/react'
+  import type { Atom } from 'likec4/vite-plugin/internal'
+
+  export type { CustomComponents }
+
+  /**
+   * UI overrides from the file set in the `customization` option of the LikeC4 Vite plugin
+   */
+  export const $customComponents: Atom<CustomComponents | undefined>
+  export function useCustomComponents(): CustomComponents | undefined
+}