@repobuddy/storybook 2.2.2 → 2.3.0

package/esm/index.d.ts

@@ -5,6 +5,7 @@ import * as react_jsx_runtime0 from "react/jsx-runtime";
 import { ClassNameProps, StyleProps } from "@just-web/css";
 import { Args, DecoratorFunction, Renderer } from "storybook/internal/csf";
 import { Decorator, Meta, StoryContext, StoryObj, StrictArgs } from "@storybook/react-vite";
+import { IsStringLiteral } from "type-plus";
 export * from "@repobuddy/test";
 
 //#region src/components/show_html.d.ts
@@ -645,6 +646,8 @@ declare function whenRunningInTest<TArgs = StrictArgs>(decoratorOrHandler: ((...
  * @template M - The base Meta type
  * @template E - The extension type containing tagType
  *
+ * @deprecated use `import { ExtendsMeta } from '@repobuddy/storybook'` instead.
+ *
  * @example
  * ```ts
  * // Create a generic Meta type for a project
@@ -665,6 +668,8 @@ type ExtendMeta<TCmpOrArgs, M extends Meta<TCmpOrArgs>, E extends {
  * @template S - The base StoryObj type
  * @template E - The extension type containing tagType
  *
+ * @deprecated use `import { ExtendsStoryObj } from '@repobuddy/storybook'` instead.
+ *
  * @example
  * ```ts
  * // Create a generic StoryObj type for a project
@@ -680,4 +685,79 @@ type ExtendStoryObj<TMetaOrCmpOrArgs, S extends StoryObj<TMetaOrCmpOrArgs>, E ex
   tags?: Array<E['tag'] | (string & {})> | undefined;
 };
 //#endregion
-export { ActionsParam, BackgroundsParam, DocsParam, ExtendMeta, ExtendStoryObj, GlobalApiBackgroundsParam, GlobalApiViewportParam, LayoutParam, ShowHtml, ShowHtmlProps, SourceProps, StoryCardProps, StorySortParam, StorybookBuiltInParams, TestParam, Viewport, ViewportParam, defineActionsParam, defineBackgroundsParam, defineDocsParam, defineLayoutParam, defineParameters, defineTestParam, defineViewportParam, showDocSource, whenRunningInTest, withStoryCard };
+//#region src/types/_extract_string_literals.d.ts
+type ExtractStringLiterals<T> = T extends any ? (string extends T ? never : T) : never;
+//#endregion
+//#region src/types/extends_meta.d.ts
+/**
+ * Extends the Storybook Meta type with custom tag types.
+ *
+ * This utility type allows you to extend the `tags` property of a Storybook Meta type
+ * with custom string literal types while preserving existing tag types from the base Meta.
+ *
+ * @template M - The base Meta type to extend
+ * @template E - The extension type containing a `tag` property with the custom tag types
+ *
+ * @example
+ * ```ts
+ * import type { ExtendsMeta } from '@repobuddy/storybook'
+ * import type { Args, Meta as M } from '@storybook/your-framework'
+ *
+ * // Create a generic Meta type for your project
+ * type Meta<TCmpOrArgs = Args> = ExtendsMeta<
+ *   M<TCmpOrArgs>,
+ *   { tag: 'new' | 'beta' | 'deprecated' }
+ * >
+ *
+ * // Use in component stories
+ * const meta: Meta<typeof Component> = {
+ *   tags: ['new'], // <--- gets auto-completion for 'new' | 'beta' | 'deprecated'
+ *   // ...
+ * }
+ * ```
+ */
+type ExtendsMeta<M extends {
+  tags?: string[] | undefined;
+}, E extends {
+  tag: string;
+}> = Omit<M, 'tags'> & {
+  tags?: ExtractStringLiterals<NonNullable<M['tags']>[number]> extends infer MT ? IsStringLiteral<MT> extends true ? Array<(string & {}) | MT | E['tag']> | undefined : Array<(string & {}) | E['tag']> | undefined : never;
+};
+//#endregion
+//#region src/types/extends_story_obj.d.ts
+/**
+ * Extends the Storybook StoryObj type with custom tag types.
+ *
+ * This utility type allows you to extend the `tags` property of a Storybook StoryObj type
+ * with custom string literal types while preserving existing tag types from the base StoryObj.
+ *
+ * @template S - The base StoryObj type to extend (must have an optional `tags` property)
+ * @template E - The extension type containing a `tag` property with the custom tag types
+ *
+ * @example
+ * ```ts
+ * import type { ExtendsStoryObj } from '@repobuddy/storybook'
+ * import type { Args, StoryObj as S } from '@storybook/your-framework'
+ *
+ * // Create a generic StoryObj type for your project
+ * type StoryObj<TCmpOrArgs = Args> = ExtendsStoryObj<
+ *   S<TCmpOrArgs>,
+ *   { tag: 'new' | 'beta' | 'deprecated' }
+ * >
+ *
+ * // Use in component stories
+ * const story: StoryObj<typeof Component> = {
+ *   tags: ['new'], // <--- gets auto-completion for 'new' | 'beta' | 'deprecated'
+ *   // ...
+ * }
+ * ```
+ */
+type ExtendsStoryObj<S extends {
+  tags?: string[] | undefined;
+}, E extends {
+  tag: string;
+}> = Omit<S, 'tags'> & {
+  tags?: ExtractStringLiterals<NonNullable<S['tags']>[number]> extends infer MT ? IsStringLiteral<MT> extends true ? Array<(string & {}) | MT | E['tag']> | undefined : Array<(string & {}) | E['tag']> | undefined : never;
+};
+//#endregion
+export { ActionsParam, BackgroundsParam, DocsParam, ExtendMeta, ExtendStoryObj, ExtendsMeta, ExtendsStoryObj, GlobalApiBackgroundsParam, GlobalApiViewportParam, LayoutParam, ShowHtml, ShowHtmlProps, SourceProps, StoryCardProps, StorySortParam, StorybookBuiltInParams, TestParam, Viewport, ViewportParam, defineActionsParam, defineBackgroundsParam, defineDocsParam, defineLayoutParam, defineParameters, defineTestParam, defineViewportParam, showDocSource, whenRunningInTest, withStoryCard };

package/esm/storybook-addon-tag-badges/index.d.ts

@@ -1,6 +1,7 @@
 
 import { TagBadgeParameters } from "storybook-addon-tag-badges/manager-helpers";
 import { Args, Meta as Meta$1, StoryObj as StoryObj$1 } from "@storybook/react-vite";
+import { IsStringLiteral } from "type-plus";
 
 //#region src/storybook-addon-tag-badges/tag_badges.d.ts
 type TagBadgeParameter = TagBadgeParameters[0];
@@ -44,32 +45,14 @@ declare const internalBadge: TagBadgeParameter;
 declare const tagBadges: TagBadgeParameters;
 //#endregion
 //#region src/types.d.ts
-/**
- * Extends the Storybook Meta type with custom tag types
- * @template TCmpOrArgs - The component or args type
- * @template M - The base Meta type
- * @template E - The extension type containing tagType
- *
- * @example
- * ```ts
- * // Create a generic Meta type for a project
- * type Meta<TCmpOrArgs = Args> = ExtendMeta<TCmpOrArgs, Meta<TCmpOrArgs>, { tagType: 'tag1' | 'tag2' }>
- *
- * // Create a specific Meta type for a component
- * type Meta = ExtendMeta<typeof Component, Meta<typeof Component>, { tagType: 'tag1' | 'tag2' }>
- * ```
- */
-type ExtendMeta<TCmpOrArgs, M extends Meta$1<TCmpOrArgs>, E extends {
-  tag: string;
-}> = Omit<M, 'tags'> & {
-  tags?: Array<E['tag'] | (string & {})> | undefined;
-};
 /**
  * Extends the Storybook StoryObj type with custom tag types
  * @template TMetaOrCmpOrArgs - The meta, component or args type
  * @template S - The base StoryObj type
  * @template E - The extension type containing tagType
  *
+ * @deprecated use `import { ExtendsStoryObj } from '@repobuddy/storybook'` instead.
+ *
  * @example
  * ```ts
  * // Create a generic StoryObj type for a project
@@ -85,8 +68,47 @@ type ExtendStoryObj<TMetaOrCmpOrArgs, S extends StoryObj$1<TMetaOrCmpOrArgs>, E
   tags?: Array<E['tag'] | (string & {})> | undefined;
 };
 //#endregion
+//#region src/types/_extract_string_literals.d.ts
+type ExtractStringLiterals<T> = T extends any ? (string extends T ? never : T) : never;
+//#endregion
+//#region src/types/extends_meta.d.ts
+/**
+ * Extends the Storybook Meta type with custom tag types.
+ *
+ * This utility type allows you to extend the `tags` property of a Storybook Meta type
+ * with custom string literal types while preserving existing tag types from the base Meta.
+ *
+ * @template M - The base Meta type to extend
+ * @template E - The extension type containing a `tag` property with the custom tag types
+ *
+ * @example
+ * ```ts
+ * import type { ExtendsMeta } from '@repobuddy/storybook'
+ * import type { Args, Meta as M } from '@storybook/your-framework'
+ *
+ * // Create a generic Meta type for your project
+ * type Meta<TCmpOrArgs = Args> = ExtendsMeta<
+ *   M<TCmpOrArgs>,
+ *   { tag: 'new' | 'beta' | 'deprecated' }
+ * >
+ *
+ * // Use in component stories
+ * const meta: Meta<typeof Component> = {
+ *   tags: ['new'], // <--- gets auto-completion for 'new' | 'beta' | 'deprecated'
+ *   // ...
+ * }
+ * ```
+ */
+type ExtendsMeta<M extends {
+  tags?: string[] | undefined;
+}, E extends {
+  tag: string;
+}> = Omit<M, 'tags'> & {
+  tags?: ExtractStringLiterals<NonNullable<M['tags']>[number]> extends infer MT ? IsStringLiteral<MT> extends true ? Array<(string & {}) | MT | E['tag']> | undefined : Array<(string & {}) | E['tag']> | undefined : never;
+};
+//#endregion
 //#region src/storybook-addon-tag-badges/types.d.ts
-type Meta<TCmpOrArgs = Args> = ExtendMeta<TCmpOrArgs, Meta$1<TCmpOrArgs>, {
+type Meta<TCmpOrArgs = Args> = ExtendsMeta<Meta$1<TCmpOrArgs>, {
   tag: TagNames;
 }>;
 type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryObj$1<TMetaOrCmpOrArgs>, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repobuddy/storybook",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "Storybook repo buddy",
   "keywords": [
     "storybook",

package/src/index.ts

@@ -12,3 +12,5 @@ export * from './parameters/define_viewport_param.ts'
 export * from './parameters/story_sort.ts'
 export * from './testing/decorators/when_running_in_test.tsx'
 export type * from './types.ts'
+export * from './types/extends_meta.ts'
+export * from './types/extends_story_obj.ts'

package/src/storybook-addon-tag-badges/types.ts

@@ -1,8 +1,9 @@
 import type { Args, Meta as M, StoryObj as SBO } from '@storybook/react-vite'
-import type { ExtendMeta, ExtendStoryObj } from '../types.js'
+import type { ExtendStoryObj } from '../types.js'
+import type { ExtendsMeta } from '../types/extends_meta.js'
 import type { TagNames } from './tag_badges.js'
 
-export type Meta<TCmpOrArgs = Args> = ExtendMeta<TCmpOrArgs, M<TCmpOrArgs>, { tag: TagNames }>
+export type Meta<TCmpOrArgs = Args> = ExtendsMeta<M<TCmpOrArgs>, { tag: TagNames }>
 
 export type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<
 	TMetaOrCmpOrArgs,

package/src/types/_extract_string_literals.ts

@@ -0,0 +1 @@
+export type ExtractStringLiterals<T> = T extends any ? (string extends T ? never : T) : never

package/src/types/extends_meta.ts

@@ -0,0 +1,37 @@
+import type { IsStringLiteral } from 'type-plus'
+import type { ExtractStringLiterals } from './_extract_string_literals.js'
+
+/**
+ * Extends the Storybook Meta type with custom tag types.
+ *
+ * This utility type allows you to extend the `tags` property of a Storybook Meta type
+ * with custom string literal types while preserving existing tag types from the base Meta.
+ *
+ * @template M - The base Meta type to extend
+ * @template E - The extension type containing a `tag` property with the custom tag types
+ *
+ * @example
+ * ```ts
+ * import type { ExtendsMeta } from '@repobuddy/storybook'
+ * import type { Args, Meta as M } from '@storybook/your-framework'
+ *
+ * // Create a generic Meta type for your project
+ * type Meta<TCmpOrArgs = Args> = ExtendsMeta<
+ *   M<TCmpOrArgs>,
+ *   { tag: 'new' | 'beta' | 'deprecated' }
+ * >
+ *
+ * // Use in component stories
+ * const meta: Meta<typeof Component> = {
+ *   tags: ['new'], // <--- gets auto-completion for 'new' | 'beta' | 'deprecated'
+ *   // ...
+ * }
+ * ```
+ */
+export type ExtendsMeta<M extends { tags?: string[] | undefined }, E extends { tag: string }> = Omit<M, 'tags'> & {
+	tags?: ExtractStringLiterals<NonNullable<M['tags']>[number]> extends infer MT
+		? IsStringLiteral<MT> extends true
+			? Array<(string & {}) | MT | E['tag']> | undefined
+			: Array<(string & {}) | E['tag']> | undefined
+		: never
+}

package/src/types/extends_story_obj.ts

@@ -0,0 +1,42 @@
+import type { IsStringLiteral } from 'type-plus'
+import type { ExtractStringLiterals } from './_extract_string_literals.js'
+
+/**
+ * Extends the Storybook StoryObj type with custom tag types.
+ *
+ * This utility type allows you to extend the `tags` property of a Storybook StoryObj type
+ * with custom string literal types while preserving existing tag types from the base StoryObj.
+ *
+ * @template S - The base StoryObj type to extend (must have an optional `tags` property)
+ * @template E - The extension type containing a `tag` property with the custom tag types
+ *
+ * @example
+ * ```ts
+ * import type { ExtendsStoryObj } from '@repobuddy/storybook'
+ * import type { Args, StoryObj as S } from '@storybook/your-framework'
+ *
+ * // Create a generic StoryObj type for your project
+ * type StoryObj<TCmpOrArgs = Args> = ExtendsStoryObj<
+ *   S<TCmpOrArgs>,
+ *   { tag: 'new' | 'beta' | 'deprecated' }
+ * >
+ *
+ * // Use in component stories
+ * const story: StoryObj<typeof Component> = {
+ *   tags: ['new'], // <--- gets auto-completion for 'new' | 'beta' | 'deprecated'
+ *   // ...
+ * }
+ * ```
+ */
+export type ExtendsStoryObj<
+	S extends { tags?: string[] | undefined },
+	E extends {
+		tag: string
+	}
+> = Omit<S, 'tags'> & {
+	tags?: ExtractStringLiterals<NonNullable<S['tags']>[number]> extends infer MT
+		? IsStringLiteral<MT> extends true
+			? Array<(string & {}) | MT | E['tag']> | undefined
+			: Array<(string & {}) | E['tag']> | undefined
+		: never
+}

package/src/types.ts

@@ -6,6 +6,8 @@ import type { Meta, StoryObj } from '@storybook/react-vite'
  * @template M - The base Meta type
  * @template E - The extension type containing tagType
  *
+ * @deprecated use `import { ExtendsMeta } from '@repobuddy/storybook'` instead.
+ *
  * @example
  * ```ts
  * // Create a generic Meta type for a project
@@ -31,6 +33,8 @@ export type ExtendMeta<
  * @template S - The base StoryObj type
  * @template E - The extension type containing tagType
  *
+ * @deprecated use `import { ExtendsStoryObj } from '@repobuddy/storybook'` instead.
+ *
  * @example
  * ```ts
  * // Create a generic StoryObj type for a project