@synopackageland/ui 0.5.8 → 0.6.0

package/dist/json/describe.d.ts

@@ -0,0 +1,31 @@
+/** One line per catalog component: what it is, its required props, slots and events. */
+export declare function listSynoJsonComponents(): {
+    name: string;
+    description: string;
+    required: string[];
+    slots: string[];
+    events: string[];
+}[];
+/** The catalog name closest to a misspelled component, if any is close enough. */
+export declare function closestSynoJsonComponent(name: string): string | undefined;
+/** A component's props as JSON Schema, plus slots, events and a minimal valid element. */
+export declare function describeSynoJsonComponent(name: string): {
+    name: string;
+    description: string;
+    props: {
+        [k: string]: {
+            required: boolean;
+            schema: Record<string, unknown>;
+        };
+    };
+    slots: string[];
+    events: string[];
+    example: {
+        type: string;
+        props: {
+            [k: string]: unknown;
+        };
+        children: never[];
+    };
+} | undefined;
+export type SynoJsonComponentDescription = NonNullable<ReturnType<typeof describeSynoJsonComponent>>;