@storybook/csf 0.1.11 → 0.1.12-next.0

package/dist/index.d.ts

@@ -290,27 +290,27 @@ interface BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> {
      * Wrapper components or Storybook decorators that wrap a story.
      *
      * Decorators defined in Meta will be applied to every story variation.
-     * @see [Decorators](https://storybook.js.org/docs/addons/introduction/#1-decorators)
+     * @see [Decorators](https://storybook.js.org/docs/writing-stories/decorators)
      */
     decorators?: DecoratorFunction<TRenderer, Simplify<TArgs>>[] | DecoratorFunction<TRenderer, Simplify<TArgs>>;
     /**
      * Custom metadata for a story.
-     * @see [Parameters](https://storybook.js.org/docs/basics/writing-stories/#parameters)
+     * @see [Parameters](https://storybook.js.org/docs/writing-stories/parameters)
      */
     parameters?: Parameters;
     /**
      * Dynamic data that are provided (and possibly updated by) Storybook and its addons.
-     * @see [Arg story inputs](https://storybook.js.org/docs/react/api/csf#args-story-inputs)
+     * @see [Args](https://storybook.js.org/docs/writing-stories/args)
      */
     args?: Partial<TArgs>;
     /**
      * ArgTypes encode basic metadata for args, such as `name`, `description`, `defaultValue` for an arg. These get automatically filled in by Storybook Docs.
-     * @see [Control annotations](https://github.com/storybookjs/storybook/blob/91e9dee33faa8eff0b342a366845de7100415367/addons/controls/README.md#control-annotations)
+     * @see [ArgTypes](https://storybook.js.org/docs/api/arg-types)
      */
     argTypes?: Partial<ArgTypes<TArgs>>;
     /**
      * Asynchronous functions which provide data for a story.
-     * @see [Loaders](https://storybook.js.org/docs/react/writing-stories/loaders)
+     * @see [Loaders](https://storybook.js.org/docs/writing-stories/loaders)
      */
     loaders?: LoaderFunction<TRenderer, TArgs>[] | LoaderFunction<TRenderer, TArgs>;
     /**
@@ -371,7 +371,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      *   title: 'Design System/Atoms/Button'
      * }
      *
-     * @see [Story Hierarchy](https://storybook.js.org/docs/basics/writing-stories/#story-hierarchy)
+     * @see [Story Hierarchy](https://storybook.js.org/docs/writing-stories/naming-components-and-hierarchy#structure-and-hierarchy)
      */
     title?: ComponentTitle;
     /**
@@ -379,7 +379,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      *
      * By default is inferred from sanitizing the title
      *
-     * @see [Story Hierarchy](https://storybook.js.org/docs/basics/writing-stories/#story-hierarchy)
+     * @see [Permalink to stories](https://storybook.js.org/docs/configure/sidebar-and-urls#permalink-to-stories)
      */
     id?: ComponentId;
     /**
@@ -388,7 +388,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      * includeStories: ['SimpleStory', 'ComplexStory']
      * includeStories: /.*Story$/
      *
-     * @see [Non-story exports](https://storybook.js.org/docs/formats/component-story-format/#non-story-exports)
+     * @see [Non-story exports](https://storybook.js.org/docs/api/csf#non-story-exports)
      */
     includeStories?: StoryDescriptor$1;
     /**
@@ -397,7 +397,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      * excludeStories: ['simpleData', 'complexData']
      * excludeStories: /.*Data$/
      *
-     * @see [Non-story exports](https://storybook.js.org/docs/formats/component-story-format/#non-story-exports)
+     * @see [Non-story exports](https://storybook.js.org/docs/api/csf#non-story-exports)
      */
     excludeStories?: StoryDescriptor$1;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/csf",
-  "version": "0.1.11",
+  "version": "0.1.12-next.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",

package/CHANGELOG.md

@@ -1,218 +0,0 @@
-# v0.1.11 (Tue Jul 02 2024)
-
-#### 🐛 Bug Fix
-
-- Add mount to CSF [#100](https://github.com/ComponentDriven/csf/pull/100) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.10 (Tue Jul 02 2024)
-
-#### 🐛 Bug Fix
-
-- Consolidate loader, play and render context and add a self referencing context property [#98](https://github.com/ComponentDriven/csf/pull/98) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Add canvas prop to the context [#99](https://github.com/ComponentDriven/csf/pull/99) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.9 (Mon Jun 24 2024)
-
-#### 🐛 Bug Fix
-
-- Add `beforeAll` hook to CSF types [#96](https://github.com/ComponentDriven/csf/pull/96) ([@ghengeveld](https://github.com/ghengeveld))
-
-#### Authors: 2
-
-- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.8 (Mon Jun 03 2024)
-
-#### 🐛 Bug Fix
-
-- Add project initialGlobals & component/story globals, deprecate project globals [#92](https://github.com/ComponentDriven/csf/pull/92) ([@shilman](https://github.com/shilman))
-
-#### Authors: 1
-
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.7 (Mon May 06 2024)
-
-#### 🐛 Bug Fix
-
-- Fix the package name in the readme [#81](https://github.com/ComponentDriven/csf/pull/81) ([@stof](https://github.com/stof))
-- Add utility for tag combination & negation [#80](https://github.com/ComponentDriven/csf/pull/80) ([@shilman](https://github.com/shilman))
-
-#### Authors: 2
-
-- Christophe Coevoet ([@stof](https://github.com/stof))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.6 (Tue Apr 30 2024)
-
-#### 🐛 Bug Fix
-
-- Add the beforeEach hook [#82](https://github.com/ComponentDriven/csf/pull/82) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.5 (Thu Apr 25 2024)
-
-#### 🐛 Bug Fix
-
-- chore: resolve eslint issues [#87](https://github.com/ComponentDriven/csf/pull/87) ([@Cherry](https://github.com/Cherry))
-- fix: better handle readonly InputType options [#85](https://github.com/ComponentDriven/csf/pull/85) ([@Cherry](https://github.com/Cherry))
-
-#### Authors: 2
-
-- James Ross ([@Cherry](https://github.com/Cherry))
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.4 (Fri Apr 12 2024)
-
-#### 🐛 Bug Fix
-
-- Loosen control type and some fixes [#83](https://github.com/ComponentDriven/csf/pull/83) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.3 (Mon Mar 18 2024)
-
-#### 🐛 Bug Fix
-
-- Fix bad publish [#78](https://github.com/ComponentDriven/csf/pull/78) ([@shilman](https://github.com/shilman))
-- Improve InputType for controls [#75](https://github.com/ComponentDriven/csf/pull/75) ([@Shinigami92](https://github.com/Shinigami92) [@shilman](https://github.com/shilman))
-- Update README [#74](https://github.com/ComponentDriven/csf/pull/74) ([@nkabrown](https://github.com/nkabrown))
-
-#### Authors: 4
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-- Nathan Brown ([@nkabrown](https://github.com/nkabrown))
-- Shinigami ([@Shinigami92](https://github.com/Shinigami92))
-
----
-
-# v0.1.2 (Wed Nov 22 2023)
-
-#### 🐛 Bug Fix
-
-- Allow loaders to be synchronous or void [#71](https://github.com/ComponentDriven/csf/pull/71) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Move `types` condition to the front [#69](https://github.com/ComponentDriven/csf/pull/69) ([@Andarist](https://github.com/Andarist))
-
-#### Authors: 2
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Mateusz Burzyński ([@Andarist](https://github.com/Andarist))
-
----
-
-# v0.1.1 (Fri Jun 02 2023)
-
-#### 🐛 Bug Fix
-
-- Move `types` condition to the front [#70](https://github.com/ComponentDriven/csf/pull/70) ([@Andarist](https://github.com/Andarist))
-
-#### Authors: 1
-
-- Mateusz Burzyński ([@Andarist](https://github.com/Andarist))
-
----
-
-# v0.1.0 (Mon Apr 03 2023)
-
-#### 🚀 Enhancement
-
-
-#### 🐛 Bug Fix
-
-- Turn Args interfaces into types when passed to decorators [#65](https://github.com/ComponentDriven/csf/pull/65) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Improve the startcase implementation to mimick lodash's version more closely [#64](https://github.com/ComponentDriven/csf/pull/64) ([@ndelangen](https://github.com/ndelangen))
-- replace lodash [#62](https://github.com/ComponentDriven/csf/pull/62) ([@ndelangen](https://github.com/ndelangen))
-- Fix bug with meta not working well as generic parameter for StoryObj [#60](https://github.com/ComponentDriven/csf/pull/60) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Make sure that index signatures (used in decorators) don't cause unexpected types [#58](https://github.com/ComponentDriven/csf/pull/58) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Add strict variants for Args and Paramters to CSF [#57](https://github.com/ComponentDriven/csf/pull/57) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Revert stricter parameters [#56](https://github.com/ComponentDriven/csf/pull/56) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Use builtin installation of actions/setup-node [#55](https://github.com/ComponentDriven/csf/pull/55) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Rename Framework to Renderer [#54](https://github.com/ComponentDriven/csf/pull/54) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Rework Framework type to contain `canvasElement` [#53](https://github.com/ComponentDriven/csf/pull/53) ([@tmeasday](https://github.com/tmeasday))
-- Add tags annotation at all levels [#52](https://github.com/ComponentDriven/csf/pull/52) ([@tmeasday](https://github.com/tmeasday))
-- First attempt at bringing new types over [#29](https://github.com/ComponentDriven/csf/pull/29) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@ghengeveld](https://github.com/ghengeveld) [@wKich](https://github.com/wKich) [@kasperpeulen](https://github.com/kasperpeulen))
-- Revert "Play function can only be set at the story level" [#40](https://github.com/ComponentDriven/csf/pull/40) ([@wKich](https://github.com/wKich) [@shilman](https://github.com/shilman))
-- Add conditional arg types and metadata [#36](https://github.com/ComponentDriven/csf/pull/36) ([@shilman](https://github.com/shilman) [@tmeasday](https://github.com/tmeasday) [@kasperpeulen](https://github.com/kasperpeulen))
-- Re-apply `TArgs` to CSF `render` type [#43](https://github.com/ComponentDriven/csf/pull/43) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@kasperpeulen](https://github.com/kasperpeulen))
-- Add step to play context and `runStep` to project annotations [#48](https://github.com/ComponentDriven/csf/pull/48) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@kasperpeulen](https://github.com/kasperpeulen))
-- Sound arg types for CSF3 [#49](https://github.com/ComponentDriven/csf/pull/49) ([@kasperpeulen](https://github.com/kasperpeulen) [@shilman](https://github.com/shilman))
-- ArgsFromMeta utility and generic ArgsStoryFn RT [#51](https://github.com/ComponentDriven/csf/pull/51) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Configure Auto [#50](https://github.com/ComponentDriven/csf/pull/50) ([@shilman](https://github.com/shilman))
-- Only make `TArgs` parameterize `args` and `argTypes` in our default annotations [#33](https://github.com/ComponentDriven/csf/pull/33) ([@tmeasday](https://github.com/tmeasday))
-- Adding Components.studio as a tool using CSF [#13](https://github.com/ComponentDriven/csf/pull/13) ([@georges-gomes](https://github.com/georges-gomes) [@ghengeveld](https://github.com/ghengeveld))
-- Makes name argument for 'toId' optional [#17](https://github.com/ComponentDriven/csf/pull/17) ([@unematiii](https://github.com/unematiii) [@ghengeveld](https://github.com/ghengeveld))
-- use permanent url for the header image [#12](https://github.com/ComponentDriven/csf/pull/12) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- fix link to image [#10](https://github.com/ComponentDriven/csf/pull/10) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- Publish under @componentdriven and update README [#8](https://github.com/ComponentDriven/csf/pull/8) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- Add meta types for CSF [#5](https://github.com/ComponentDriven/csf/pull/5) ([@wKich](https://github.com/wKich))
-- types of csf properties [#3](https://github.com/ComponentDriven/csf/pull/3) ([@atanasster](https://github.com/atanasster) [@ndelangen](https://github.com/ndelangen))
-- Extract @storybook/csf from monorepo [#1](https://github.com/ComponentDriven/csf/pull/1) ([@shilman](https://github.com/shilman))
-
-#### ⚠️ Pushed to `master`
-
-- First commit ([@shilman](https://github.com/shilman))
-
-#### 📝 Documentation
-
-- added storyNameFromExport(key) in README.md [#2](https://github.com/ComponentDriven/csf/pull/2) ([@georges-gomes](https://github.com/georges-gomes) [@shilman](https://github.com/shilman))
-
-#### 🔩 Dependency Updates
-
-- Bump handlebars from 4.5.3 to 4.7.7 [#20](https://github.com/ComponentDriven/csf/pull/20) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump y18n from 4.0.0 to 4.0.3 [#32](https://github.com/ComponentDriven/csf/pull/32) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump ini from 1.3.5 to 1.3.8 [#18](https://github.com/ComponentDriven/csf/pull/18) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump yargs-parser from 13.1.1 to 13.1.2 [#15](https://github.com/ComponentDriven/csf/pull/15) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump lodash from 4.17.15 to 4.17.21 [#21](https://github.com/ComponentDriven/csf/pull/21) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump hosted-git-info from 2.8.5 to 2.8.9 [#22](https://github.com/ComponentDriven/csf/pull/22) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump path-parse from 1.0.6 to 1.0.7 [#25](https://github.com/ComponentDriven/csf/pull/25) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump browserslist from 4.11.1 to 4.16.6 [#23](https://github.com/ComponentDriven/csf/pull/23) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump acorn from 5.7.3 to 5.7.4 [#27](https://github.com/ComponentDriven/csf/pull/27) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump ws from 5.2.2 to 5.2.3 [#28](https://github.com/ComponentDriven/csf/pull/28) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump tar from 4.4.13 to 4.4.19 [#30](https://github.com/ComponentDriven/csf/pull/30) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump tmpl from 1.0.4 to 1.0.5 [#31](https://github.com/ComponentDriven/csf/pull/31) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-
-#### Authors: 12
-
-- [@dependabot[bot]](https://github.com/dependabot[bot])
-- Atanas Stoyanov ([@atanasster](https://github.com/atanasster))
-- Dmitriy Lazarev ([@wKich](https://github.com/wKich))
-- Dominic Nguyen ([@domyen](https://github.com/domyen))
-- Georges Gomes ([@georges-gomes](https://github.com/georges-gomes))
-- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Mati Kärner ([@unematiii](https://github.com/unematiii))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-- Norbert de Langen ([@ndelangen](https://github.com/ndelangen))
-- Tom Coleman ([@tmeasday](https://github.com/tmeasday))
-- Varun Vachhar ([@winkerVSbecks](https://github.com/winkerVSbecks))