@storybook/csf 0.0.2--canary.43.a3d8c69.0 → 0.0.2--canary.49.9d84710.0

package/dist/story.d.ts

@@ -64,10 +64,15 @@ export declare type StrictGlobalTypes = {
 export declare type AnyFramework = {
     component: unknown;
     storyResult: unknown;
+    T?: unknown;
 };
 export declare type StoryContextForEnhancers<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryIdentifier & {
-    component?: TFramework['component'];
-    subcomponents?: Record<string, TFramework['component']>;
+    component?: (TFramework & {
+        T: any;
+    })['component'];
+    subcomponents?: (TFramework & {
+        T: any;
+    })['component'];
     parameters: Parameters;
     initialArgs: TArgs;
     argTypes: StrictArgTypes<TArgs>;
@@ -93,19 +98,25 @@ export declare type StoryContext<TFramework extends AnyFramework = AnyFramework,
     abortSignal: AbortSignal;
     canvasElement: HTMLElement;
 };
-export declare type PlayFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (context: StoryContext<TFramework, TArgs>) => Promise<void> | void;
-export declare type PartialStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (update?: StoryContextUpdate<TArgs>) => TFramework['storyResult'];
+export declare type StepLabel = string;
+export declare type StepFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (label: StepLabel, play: PlayFunction<TFramework, TArgs>) => Promise<void> | void;
+export declare type PlayFunctionContext<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryContext<TFramework, TArgs> & {
+    step: StepFunction<TFramework, TArgs>;
+};
+export declare type PlayFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (context: PlayFunctionContext<TFramework, TArgs>) => Promise<void> | void;
+export declare type PartialStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TFramework['storyResult'];
 export declare type LegacyStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (context: StoryContext<TFramework, TArgs>) => TFramework['storyResult'];
 export declare type ArgsStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (args: TArgs, context: StoryContext<TFramework, TArgs>) => TFramework['storyResult'];
 export declare type StoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = LegacyStoryFn<TFramework, TArgs> | ArgsStoryFn<TFramework, TArgs>;
 export declare type DecoratorFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (fn: PartialStoryFn<TFramework, TArgs>, c: StoryContext<TFramework, TArgs>) => TFramework['storyResult'];
 export declare type DecoratorApplicator<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (storyFn: LegacyStoryFn<TFramework, TArgs>, decorators: DecoratorFunction<TFramework, TArgs>[]) => LegacyStoryFn<TFramework, TArgs>;
+export declare type StepRunner<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (label: StepLabel, play: PlayFunction<TFramework, TArgs>, context: PlayFunctionContext<TFramework, TArgs>) => Promise<void>;
 export declare type BaseAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = {
-    decorators?: DecoratorFunction<TFramework, Args>[];
+    decorators?: DecoratorFunction<TFramework, TArgs>[];
     parameters?: Parameters;
     args?: Partial<TArgs>;
     argTypes?: Partial<ArgTypes<TArgs>>;
-    loaders?: LoaderFunction<TFramework, Args>[];
+    loaders?: LoaderFunction<TFramework, TArgs>[];
     render?: ArgsStoryFn<TFramework, TArgs>;
 };
 export declare type ProjectAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
@@ -114,22 +125,29 @@ export declare type ProjectAnnotations<TFramework extends AnyFramework = AnyFram
     globals?: Globals;
     globalTypes?: GlobalTypes;
     applyDecorators?: DecoratorApplicator<TFramework, Args>;
+    runStep?: StepRunner<TFramework, TArgs>;
 };
 declare type StoryDescriptor = string[] | RegExp;
-export declare type ComponentAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
+export interface ComponentAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> extends BaseAnnotations<TFramework, TArgs> {
     title?: ComponentTitle;
     id?: ComponentId;
     includeStories?: StoryDescriptor;
     excludeStories?: StoryDescriptor;
-    component?: TFramework['component'];
+    component?: (TFramework & {
+        T: Args extends TArgs ? any : TArgs;
+    })['component'];
     subcomponents?: Record<string, TFramework['component']>;
-};
-export declare type StoryAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
+}
+export declare type StoryAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args, TArgsAnnotations = Partial<TArgs>> = BaseAnnotations<TFramework, TArgs> & {
     name?: StoryName;
     storyName?: StoryName;
     play?: PlayFunction<TFramework, TArgs>;
     story?: Omit<StoryAnnotations<TFramework, TArgs>, 'story'>;
-};
+} & ({} extends TArgsAnnotations ? {
+    args?: TArgsAnnotations;
+} : {
+    args: TArgsAnnotations;
+});
 export declare type LegacyAnnotatedStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryFn<TFramework, TArgs> & StoryAnnotations<TFramework, TArgs>;
 export declare type LegacyStoryAnnotationsOrFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = LegacyAnnotatedStoryFn<TFramework, TArgs> | StoryAnnotations<TFramework, TArgs>;
 export declare type AnnotatedStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = ArgsStoryFn<TFramework, TArgs> & StoryAnnotations<TFramework, TArgs>;

package/dist/story.test.js

@@ -1,12 +1,16 @@
 "use strict";
 
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
 // NOTE Example of internal type definition for @storybook/<X> (where X is a framework)
 // NOTE Examples of using types from @storybook/<X> in real project
-var Button = function Button() {
+var Button = function Button(props) {
   return 'Button';
-};
+}; // NOTE Various kind usages
+
 
-// NOTE Various kind usages
 var simple = {
   title: 'simple',
   component: Button,
@@ -26,10 +30,10 @@ var simple = {
     });
   }],
   args: {
-    a: 1
+    x: '1'
   },
   argTypes: {
-    a: {
+    x: {
       type: {
         name: 'string'
       }
@@ -157,6 +161,71 @@ var CSF3StoryStrict = {
   }],
   args: {
     x: '1'
+  },
+  play: function () {
+    var _play = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(_ref) {
+      var step;
+      return regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              step = _ref.step;
+              _context2.next = 3;
+              return step('a step', /*#__PURE__*/function () {
+                var _ref3 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(_ref2) {
+                  var substep;
+                  return regeneratorRuntime.wrap(function _callee$(_context) {
+                    while (1) {
+                      switch (_context.prev = _context.next) {
+                        case 0:
+                          substep = _ref2.step;
+                          _context.next = 3;
+                          return substep('a substep', function () {});
+
+                        case 3:
+                        case "end":
+                          return _context.stop();
+                      }
+                    }
+                  }, _callee);
+                }));
+
+                return function (_x2) {
+                  return _ref3.apply(this, arguments);
+                };
+              }());
+
+            case 3:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+
+    function play(_x) {
+      return _play.apply(this, arguments);
+    }
+
+    return play;
+  }()
+};
+var project = {
+  runStep: function runStep(label, play, context) {
+    return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
+      return regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              return _context3.abrupt("return", play(context));
+
+            case 1:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    }))();
   }
 }; // NOTE Jest forced to define at least one test in file
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/csf",
-  "version": "0.0.2--canary.43.a3d8c69.0",
+  "version": "0.0.2--canary.49.9d84710.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",
@@ -61,7 +61,7 @@
     "common-tags": "^1.8.0",
     "eslint": "^6.7.1",
     "jest": "^24.9.0",
-    "prettier": "^1.19.1",
+    "prettier": "^2.7.1",
     "typescript": "^3.7.2"
   },
   "auto": {