Adds MetaJson types (#568)

* Adds types for meta.json

* Adds optional generic to MetaJson types for story meta

* Adds changeset

* Makes the MetaJsonStory.meta type more strict

---------

Co-authored-by: Vojtech Miksu <[email protected]>

Author: hiddenist

.changeset/dirty-zoos-jam.md

@@ -0,0 +1,5 @@
+---
+"@ladle/react": patch
+---
+
+Exports meta.json types from library

packages/ladle/lib/app/exports.ts

@@ -8,6 +8,9 @@ import {
   ModeState,
   GlobalAction,
   Config,
+  KnownMeta,
+  MetaJson as BaseMetaJson,
+  MetaJsonStory as BaseMetaJsonStory,
 } from "../shared/types";
 
 import * as msw from "msw";
@@ -135,9 +138,9 @@ export type ArgTypes<
   [key in keyof P]?: ArgType<P[key]>;
 };
 
-export interface Meta {
-  iframed?: boolean;
-  width?: string | number | "xsmall" | "small" | "medium" | "large";
-  mockDate?: string;
+export interface Meta extends KnownMeta {
   [key: string]: any;
 }
+
+export type MetaJson = BaseMetaJson<Meta>;
+export type MetaJsonStory = BaseMetaJsonStory<Meta>;

packages/ladle/lib/cli/vite-plugin/generate/get-meta-json.js

@@ -2,6 +2,7 @@ import { storyIdToMeta } from "../naming-utils.js";
 
 /**
  * @param entryData {import('../../../shared/types').EntryData}
+ * @returns {import('../../../shared/types').MetaJson}
  */
 export const getMetaJson = (entryData) => {
   /** @type {string[]} */
@@ -20,14 +21,15 @@ export const getMetaJson = (entryData) => {
     );
     storyParams = { ...storyParams, ...entryData[entry].storyParams };
   });
+
+  /** @type {import('../../../shared/types').MetaJson} */
   const result = {
     about: {
       homepage: "https://www.ladle.dev",
       github: "https://github.com/tajo/ladle",
       version: 1,
     },
-    stories:
-      /** @type {{[key: string]: {name: string; levels: string[]; meta: any, locStart: number; locEnd: number;}}} */ ({}),
+    stories: {},
   };
   storyIds.forEach((storyId) => {
     result.stories[storyId] = {

packages/ladle/lib/shared/types.ts

@@ -280,3 +280,26 @@ export type GetUserViteConfig = {
 export type EntryData = {
   [key: string]: ParsedStoriesResult;
 };
+
+export type MetaJson<M extends KnownMeta = KnownMeta> = {
+  about: {
+    homepage: string;
+    github: string;
+    version: number;
+  };
+  stories: { [key: string]: MetaJsonStory<M> };
+};
+
+export type MetaJsonStory<M extends KnownMeta = KnownMeta> = {
+  name: string;
+  levels: string[];
+  meta: M;
+  locStart: number;
+  locEnd: number;
+};
+
+export interface KnownMeta {
+  iframed?: boolean;
+  width?: string | number | "xsmall" | "small" | "medium" | "large";
+  mockDate?: string;
+}