likec4 1.32.2 → 1.34.0

package/react/index.d.mts

@@ -1,6 +1,6 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { CSSProperties, ComponentType, DependencyList, HTMLAttributes, JSX, MouseEvent as ReactMouseEvent, PropsWithChildren, ReactNode, WheelEvent as WheelEvent$1 } from 'react';
+import { CSSProperties, ComponentType, HTMLAttributes, JSX, MouseEvent as ReactMouseEvent, PropsWithChildren, ReactNode, WheelEvent as WheelEvent$1 } from 'react';
 
 type UnionToIntersection<Union> = (
 // `extends unknown` is always going to be the case and is used to convert the
@@ -120,6 +120,13 @@ interface Link {
 	relative?: string;
 }
 type Coalesce<V extends string, OrIfAny = string> = IsAny<V> extends true ? OrIfAny : V;
+type MarkdownOrString = {
+	txt: string;
+	md?: never;
+} | {
+	md: string;
+	txt?: never;
+};
 type BuiltInIcon = "none" | `${"aws" | "azure" | "gcp" | "tech"}:${string}`;
 type Icon = Tagged<string, "Icon"> | BuiltInIcon;
 type IconUrl = Icon;
@@ -181,43 +188,6 @@ type WithOptionalTags<A extends Any> = {
 type WithOptionalLinks = {
 	readonly links?: readonly Link[] | null;
 };
-type EqualOperator<V> = {
-	eq: V;
-	neq?: never;
-} | {
-	eq?: never;
-	neq: V;
-};
-type AllNever = {
-	not?: never;
-	and?: never;
-	or?: never;
-	tag?: never;
-	kind?: never;
-	participant?: never;
-	operator?: never;
-};
-type TagEqual<A extends Any> = Omit<AllNever, "tag"> & {
-	tag: EqualOperator<Tag$1<A>> | Tag$1<A>;
-};
-type KindEqual<A extends Any> = Omit<AllNever, "kind"> & {
-	kind: EqualOperator<AllKinds<A>> | AllKinds<A>;
-};
-type Participant = "source" | "target";
-type ParticipantOperator<A extends Any> = Omit<AllNever, "participant" | "operator"> & {
-	participant: Participant;
-	operator: KindEqual<A> | TagEqual<A>;
-};
-type NotOperator<A extends Any> = Omit<AllNever, "not"> & {
-	not: WhereOperator<A>;
-};
-type AndOperator<A extends Any> = Omit<AllNever, "and"> & {
-	and: NonEmptyArray<WhereOperator<A>>;
-};
-type OrOperator<A extends Any> = Omit<AllNever, "or"> & {
-	or: NonEmptyArray<WhereOperator<A>>;
-};
-type WhereOperator<A extends Any = Any> = TagEqual<A> | KindEqual<A> | ParticipantOperator<A> | NotOperator<A> | AndOperator<A> | OrOperator<A>;
 type SpacingSize = "xs" | "sm" | "md" | "lg" | "xl";
 type TextSize = "xs" | "sm" | "md" | "lg" | "xl";
 type ShapeSize = "xs" | "sm" | "md" | "lg" | "xl";
@@ -257,6 +227,43 @@ declare const ThemeColors: readonly [
 ];
 type ThemeColor = typeof ThemeColors[number];
 type Color = ThemeColor | ColorLiteral;
+type EqualOperator<V> = {
+	eq: V;
+	neq?: never;
+} | {
+	eq?: never;
+	neq: V;
+};
+type AllNever = {
+	not?: never;
+	and?: never;
+	or?: never;
+	tag?: never;
+	kind?: never;
+	participant?: never;
+	operator?: never;
+};
+type TagEqual<A extends Any> = Omit<AllNever, "tag"> & {
+	tag: EqualOperator<Tag$1<A>> | Tag$1<A>;
+};
+type KindEqual<A extends Any> = Omit<AllNever, "kind"> & {
+	kind: EqualOperator<AllKinds<A>> | AllKinds<A>;
+};
+type Participant = "source" | "target";
+type ParticipantOperator<A extends Any> = Omit<AllNever, "participant" | "operator"> & {
+	participant: Participant;
+	operator: KindEqual<A> | TagEqual<A>;
+};
+type NotOperator<A extends Any> = Omit<AllNever, "not"> & {
+	not: WhereOperator<A>;
+};
+type AndOperator<A extends Any> = Omit<AllNever, "and"> & {
+	and: NonEmptyArray<WhereOperator<A>>;
+};
+type OrOperator<A extends Any> = Omit<AllNever, "or"> & {
+	or: NonEmptyArray<WhereOperator<A>>;
+};
+type WhereOperator<A extends Any = Any> = TagEqual<A> | KindEqual<A> | ParticipantOperator<A> | NotOperator<A> | AndOperator<A> | OrOperator<A>;
 type Point = readonly [
 	x: number,
 	y: number
@@ -324,7 +331,7 @@ type ViewManualLayout = {
 interface BaseViewProperties<A extends Any> extends WithOptionalTags<A>, WithOptionalLinks {
 	readonly id: StrictViewId<A>;
 	readonly title: string | null;
-	readonly description: string | null;
+	readonly description: MarkdownOrString | null;
 	/**
 	 * For all views we find common ancestor path.
 	 * This is used to generate relative paths, i.e.:
@@ -381,16 +388,14 @@ interface ComputedNode<A extends Any = Any> extends WithOptionalLinks {
 	parent: NodeId | null;
 	/**
 	 * Reference to model element
-	 * If 1 - node id is a reference
 	 */
 	modelRef?: Fqn$1<A> | undefined;
 	/**
 	 * Reference to deployment element
-	 * If 1 - node id is a reference
 	 */
 	deploymentRef?: DeploymentFqn$1<A> | undefined;
 	title: string;
-	description?: string | null;
+	description?: MarkdownOrString | null;
 	technology?: string | null;
 	notation?: string;
 	children: NodeId[];
@@ -415,7 +420,7 @@ interface ComputedEdge<A extends Any = Any> extends WithOptionalTags<A> {
 	source: NodeId;
 	target: NodeId;
 	label: string | null;
-	description?: string;
+	description?: MarkdownOrString | null;
 	technology?: string;
 	relations: RelationId[];
 	kind?: RelationKind<A> | typeof StepEdgeKind;
@@ -500,6 +505,27 @@ interface LayoutedDynamicView<A extends Any = Any> extends BaseLayoutedViewPrope
 	readonly [_type]: "dynamic";
 }
 type LayoutedView<A extends Any = Any> = LayoutedElementView<A> | LayoutedDeploymentView<A> | LayoutedDynamicView<A>;
+interface RichTextEmpty {
+	readonly isEmpty: true;
+	readonly isMarkdown: false;
+	readonly nonEmpty: false;
+	readonly $source: null;
+	readonly text: null;
+	readonly md: null;
+	readonly html: null;
+	equals(other: unknown): boolean;
+}
+interface RichTextNonEmpty {
+	readonly isEmpty: false;
+	readonly nonEmpty: true;
+	readonly isMarkdown: boolean;
+	readonly $source: MarkdownOrString;
+	readonly text: string;
+	readonly md: string;
+	readonly html: string;
+	equals(other: unknown): boolean;
+}
+type RichTextOrEmpty = RichTextNonEmpty | RichTextEmpty;
 declare namespace ViewChange {
 	interface ChangeElementStyle {
 		op: "change-element-style";
@@ -2008,7 +2034,8 @@ type NonOptional<T extends object> = Simplify<{
 	[P in OptionalKeysOf<T>]-?: T[P] | undefined;
 }>;
 declare namespace Types {
-	type LeafNodeData = Base.NodeData & NonOptional<Pick<DiagramNode, "id" | "title" | "technology" | "description" | "color" | "shape" | "width" | "level" | "height" | "style" | "tags" | "position">> & {
+	type LeafNodeData = Base.NodeData & NonOptional<Pick<DiagramNode, "id" | "title" | "technology" | "color" | "shape" | "width" | "level" | "height" | "style" | "tags" | "position">> & {
+		description: RichTextOrEmpty;
 		/**
 		 * View this node belongs to
 		 */
@@ -2537,272 +2564,9 @@ export declare const LikeC4ModelProvider: (props: LikeC4ModelProviderProps) => J
 export declare const ViewNotFound: ({ viewId }: {
 	viewId: string;
 }) => import("react/jsx-runtime").JSX.Element;
-type AllKeys<T> = T extends any ? keyof T : never;
-type Primitive = boolean | number | string;
-type ReadonlyIfObject<Value> = Value extends undefined ? Value : Value extends (...args: any) => any ? Value : Value extends Primitive ? Value : Value extends object ? Readonly<Value> : Value;
-interface ReadableAtom<Value = any> {
-	/**
-	 * Get store value.
-	 *
-	 * In contrast with {@link ReadableAtom#value} this value will be always
-	 * initialized even if store had no listeners.
-	 *
-	 * ```js
-	 * $store.get()
-	 * ```
-	 *
-	 * @returns Store value.
-	 */
-	get(): Value;
-	/**
-	 * Listeners count.
-	 */
-	readonly lc: number;
-	/**
-	 * Subscribe to store changes.
-	 *
-	 * In contrast with {@link Store#subscribe} it do not call listener
-	 * immediately.
-	 *
-	 * @param listener Callback with store value and old value.
-	 * @returns Function to remove listener.
-	 */
-	listen(listener: (value: ReadonlyIfObject<Value>, oldValue: ReadonlyIfObject<Value>) => void): () => void;
-	/**
-	 * Low-level method to notify listeners about changes in the store.
-	 *
-	 * Can cause unexpected behaviour when combined with frontend frameworks
-	 * that perform equality checks for values, such as React.
-	 */
-	notify(oldValue?: ReadonlyIfObject<Value>): void;
-	/**
-	 * Unbind all listeners.
-	 */
-	off(): void;
-	/**
-	 * Subscribe to store changes and call listener immediately.
-	 *
-	 * ```
-	 * import { $router } from '../store'
-	 *
-	 * $router.subscribe(page => {
-	 *   console.log(page)
-	 * })
-	 * ```
-	 *
-	 * @param listener Callback with store value and old value.
-	 * @returns Function to remove listener.
-	 */
-	subscribe(listener: (value: ReadonlyIfObject<Value>, oldValue?: ReadonlyIfObject<Value>) => void): () => void;
-	/**
-	 * Low-level method to read store’s value without calling `onStart`.
-	 *
-	 * Try to use only {@link ReadableAtom#get}.
-	 * Without subscribers, value can be undefined.
-	 */
-	readonly value: undefined | Value;
-}
-interface WritableAtom<Value = any> extends ReadableAtom<Value> {
-	/**
-	 * Change store value.
-	 *
-	 * ```js
-	 * $router.set({ path: location.pathname, page: parse(location.pathname) })
-	 * ```
-	 *
-	 * @param newValue New store value.
-	 */
-	set(newValue: Value): void;
-}
-interface PreinitializedWritableAtom<Value> extends WritableAtom<Value> {
-	readonly value: Value;
-}
-type Atom<Value = any> = ReadableAtom<Value> | WritableAtom<Value>;
-declare function atom<Value, StoreExt = object>(...args: undefined extends Value ? [
-] | [
-	Value
-] : [
-	Value
-]): PreinitializedWritableAtom<Value> & StoreExt;
-type KeyofBase = keyof any;
-type Get<T, K extends KeyofBase> = Extract<T, {
-	[K1 in K]: any;
-}>[K];
-type HasIndexSignature<T> = string extends keyof T ? true : false;
-type ValueWithUndefinedForIndexSignatures<Value, Key extends keyof Value> = HasIndexSignature<Value> extends true ? undefined | Value[Key] : Value[Key];
-type WritableStore<Value = any> = (Value extends object ? MapStore<Value> : never) | WritableAtom<Value>;
-type Store<Value = any> = ReadableAtom<Value> | WritableStore<Value>;
-type AnyStore<Value = any> = {
-	get(): Value;
-	readonly value: undefined | Value;
-};
-type StoreValue<SomeStore> = SomeStore extends {
-	get(): infer Value;
-} ? Value : any;
-interface MapStore<Value extends object = any> extends WritableAtom<Value> {
-	/**
-	 * Subscribe to store changes.
-	 *
-	 * In contrast with {@link Store#subscribe} it do not call listener
-	 * immediately.
-	 *
-	 * @param listener Callback with store value and old value.
-	 * @param changedKey Key that was changed. Will present only if `setKey`
-	 *                   has been used to change a store.
-	 * @returns Function to remove listener.
-	 */
-	listen(listener: (value: ReadonlyIfObject<Value>, oldValue: ReadonlyIfObject<Value>, changedKey: AllKeys<Value>) => void): () => void;
-	/**
-	 * Low-level method to notify listeners about changes in the store.
-	 *
-	 * Can cause unexpected behaviour when combined with frontend frameworks
-	 * that perform equality checks for values, such as React.
-	 */
-	notify(oldValue?: ReadonlyIfObject<Value>, changedKey?: AllKeys<Value>): void;
-	/**
-	 * Change store value.
-	 *
-	 * ```js
-	 * $settings.set({ theme: 'dark' })
-	 * ```
-	 *
-	 * Operation is atomic, subscribers will be notified once with the new value.
-	 * `changedKey` will be undefined
-	 *
-	 * @param newValue New store value.
-	 */
-	set(newValue: Value): void;
-	/**
-	 * Change key in store value.
-	 *
-	 * ```js
-	 * $settings.setKey('theme', 'dark')
-	 * ```
-	 *
-	 * To delete key set `undefined`.
-	 *
-	 * ```js
-	 * $settings.setKey('theme', undefined)
-	 * ```
-	 *
-	 * @param key The key name.
-	 * @param value New value.
-	 */
-	setKey<Key extends AllKeys<Value>>(key: Key, value: Get<Value, Key> | ValueWithUndefinedForIndexSignatures<Value, Key>): void;
-	/**
-	 * Subscribe to store changes and call listener immediately.
-	 *
-	 * ```
-	 * import { $router } from '../store'
-	 *
-	 * $router.subscribe(page => {
-	 *   console.log(page)
-	 * })
-	 * ```
-	 *
-	 * @param listener Callback with store value and old value.
-	 * @param changedKey Key that was changed. Will present only
-	 *                   if `setKey` has been used to change a store.
-	 * @returns Function to remove listener.
-	 */
-	subscribe(listener: (value: ReadonlyIfObject<Value>, oldValue: ReadonlyIfObject<Value> | undefined, changedKey: AllKeys<Value> | undefined) => void): () => void;
-}
-interface PreinitializedMapStore<Value extends object = any> extends MapStore<Value> {
-	readonly value: Value;
-}
-declare function map<Value extends object, StoreExt extends object = object>(value?: Value): PreinitializedMapStore<Value> & StoreExt;
-interface Task<Value> extends Promise<Value> {
-	t: true;
-}
-type StoreValues<Stores extends AnyStore[]> = {
-	[Index in keyof Stores]: StoreValue<Stores[Index]>;
-};
-interface Computed {
-	<Value, OriginStore extends Store>(stores: OriginStore, cb: (value: StoreValue<OriginStore>) => Task<Value>): ReadableAtom<undefined | Value>;
-	<Value, OriginStores extends AnyStore[]>(stores: [
-		...OriginStores
-	], cb: (...values: StoreValues<OriginStores>) => Task<Value>): ReadableAtom<undefined | Value>;
-	<Value, OriginStore extends Store>(stores: OriginStore, cb: (value: StoreValue<OriginStore>) => Value): ReadableAtom<Value>;
-	/**
-	 * Create derived store, which use generates value from another stores.
-	 *
-	 * ```js
-	 * import { computed } from 'nanostores'
-	 *
-	 * import { $users } from './users.js'
-	 *
-	 * export const $admins = computed($users, users => {
-	 *   return users.filter(user => user.isAdmin)
-	 * })
-	 * ```
-	 *
-	 * An async function can be evaluated by using {@link task}.
-	 *
-	 * ```js
-	 * import { computed, task } from 'nanostores'
-	 *
-	 * import { $userId } from './users.js'
-	 *
-	 * export const $user = computed($userId, userId => task(async () => {
-	 *   const response = await fetch(`https://my-api/users/${userId}`)
-	 *   return response.json()
-	 * }))
-	 * ```
-	 */
-	<Value, OriginStores extends AnyStore[]>(stores: [
-		...OriginStores
-	], cb: (...values: StoreValues<OriginStores>) => Task<Value> | Value): ReadableAtom<Value>;
-}
-declare const computed: Computed;
-interface Batched {
-	<Value, OriginStore extends Store>(stores: OriginStore, cb: (value: StoreValue<OriginStore>) => Task<Value> | Value): ReadableAtom<Value>;
-	/**
-	 * Create derived store, which use generates value from another stores.
-	 *
-	 * ```js
-	 * import { batched } from 'nanostores'
-	 *
-	 * const $sortBy = atom('id')
-	 * const $category = atom('')
-	 *
-	 * export const $link = batched([$sortBy, $category], (sortBy, category) => {
-	 *   return `/api/entities?sortBy=${sortBy}&category=${category}`
-	 * })
-	 * ```
-	 */
-	<Value, OriginStores extends AnyStore[]>(stores: [
-		...OriginStores
-	], cb: (...values: StoreValues<OriginStores>) => Task<Value> | Value): ReadableAtom<Value>;
-}
-declare const batched: Batched;
-type StoreKeys<T> = T extends {
-	setKey: (k: infer K, v: any) => unknown;
-} ? K : never;
-interface UseStoreOptions<SomeStore> {
-	/**
-	 * @default
-	 * ```ts
-	 * [store, options.keys]
-	 * ```
-	 */
-	deps?: DependencyList;
-	/**
-	 * Will re-render components only on specific key changes.
-	 */
-	keys?: StoreKeys<SomeStore>[];
-}
-declare function useStore<SomeStore extends Store>(store: SomeStore, options?: UseStoreOptions<SomeStore>): StoreValue<SomeStore>;
-export declare const createHooksForModel: ($atom: WritableAtom) => any;
 
 declare namespace Base {
 	export { Dimmed, Edge$1 as Edge, EdgeData, Node$1 as Node, NodeData, NodeProps$2 as NodeProps, setData, setDimmed, setHovered };
 }
-declare namespace nano {
-	export { Atom, ReadableAtom, WritableAtom, atom, batched, computed, map, useStore };
-}
-
-export {
-	nano,
-};
 
 export {};