@storybook/csf 0.0.2--canary.7c6c115.0 → 0.0.2--canary.0899bb7.0

package/dist/story.d.ts

@@ -93,20 +93,26 @@ 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 StepLabel = string;
+export declare type StepFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (label: StepLabel, play: PlayFunction<TFramework, TArgs>) => 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<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>[];
     parameters?: Parameters;
     args?: Partial<TArgs>;
     argTypes?: Partial<ArgTypes<TArgs>>;
     loaders?: LoaderFunction<TFramework, Args>[];
-    render?: ArgsStoryFn<TFramework, Args>;
+    render?: ArgsStoryFn<TFramework, TArgs>;
 };
 export declare type ProjectAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
     argsEnhancers?: ArgsEnhancer<TFramework, Args>[];
@@ -114,6 +120,7 @@ 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> & {

package/dist/story.test.js

@@ -1,5 +1,9 @@
 "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() {
@@ -116,7 +120,7 @@ CSF2Story.args = {
   a: 1
 };
 var CSF3Story = {
-  render: function render() {
+  render: function render(args) {
     return 'Named Story';
   },
   name: 'Another name for story',
@@ -138,7 +142,7 @@ var CSF3Story = {
   }
 };
 var CSF3StoryStrict = {
-  render: function render() {
+  render: function render(args) {
     return 'Named Story';
   },
   name: 'Another name for story',
@@ -157,6 +161,31 @@ var CSF3StoryStrict = {
   }],
   args: {
     x: '1'
+  },
+  play: function play(_ref) {
+    var step = _ref.step;
+    step('a step', function (_ref2) {
+      var substep = _ref2.step;
+      substep('a substep', function () {});
+    });
+  }
+};
+var project = {
+  runStep: function runStep(label, play, context) {
+    return _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+      return regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              return _context.abrupt("return", play(context));
+
+            case 1:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }))();
   }
 }; // 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.7c6c115.0",
+  "version": "0.0.2--canary.0899bb7.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",

package/dist/includeConditionalArg.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/properties.d.ts

@@ -1,75 +0,0 @@
-export declare enum PropertyTypes {
-    TEXT = "text",
-    NUMBER = "number",
-    BOOLEAN = "boolean",
-    OPTIONS = "options",
-    DATE = "date",
-    COLOR = "color",
-    BUTTON = "button",
-    OBJECT = "object",
-    ARRAY = "array",
-    FILES = "files"
-}
-export interface StoryPropertyBase<T> {
-    type: PropertyTypes;
-    label?: string;
-    value?: T;
-    hideLabel?: boolean;
-    hidden?: boolean;
-    groupId?: string;
-    order?: number;
-}
-export interface StoryPropertyText extends StoryPropertyBase<string> {
-    type: PropertyTypes.TEXT;
-    placeholder?: string;
-    maxRows?: number;
-}
-export interface StoryPropertyBoolean extends StoryPropertyBase<boolean> {
-    type: PropertyTypes.BOOLEAN;
-}
-export interface StoryPropertyColor extends StoryPropertyBase<string> {
-    type: PropertyTypes.COLOR;
-}
-export interface StoryPropertyDate extends StoryPropertyBase<Date> {
-    type: PropertyTypes.DATE;
-    datePicker?: boolean;
-    timePicker?: boolean;
-}
-export interface StoryPropertyFiles extends StoryPropertyBase<string[]> {
-    type: PropertyTypes.FILES;
-    accept?: string;
-}
-export interface StoryPropertyArray extends StoryPropertyBase<string[]> {
-    type: PropertyTypes.ARRAY;
-    separator?: string;
-}
-export interface StoryPropertyObject extends StoryPropertyBase<object> {
-    type: PropertyTypes.OBJECT;
-}
-export interface StoryPropertyButton extends StoryPropertyBase<void> {
-    type: PropertyTypes.BUTTON;
-    onClick?: (prop: StoryPropertyButton) => void;
-}
-export declare type OptionsValueType<T = unknown> = T | string | number | string[] | number[] | {
-    label: string;
-    value: any;
-};
-export declare type OptionsListType<T = unknown> = {
-    [key: string]: T;
-} | OptionsValueType<T>[];
-export interface StoryPropertyOptions<T = unknown> extends StoryPropertyBase<OptionsValueType<T>> {
-    type: PropertyTypes.OPTIONS;
-    options: OptionsListType<T>;
-    display?: 'select' | 'multi-select' | 'radio' | 'inline-radio' | 'check' | 'inline-check';
-}
-export interface StoryPropertyNumber extends StoryPropertyBase<number> {
-    type: PropertyTypes.NUMBER;
-    range?: boolean;
-    min?: number;
-    max?: number;
-    step?: number;
-}
-export declare type StoryProperty = StoryPropertyText | StoryPropertyBoolean | StoryPropertyColor | StoryPropertyDate | StoryPropertyObject | StoryPropertyButton | StoryPropertyOptions | StoryPropertyNumber | StoryPropertyArray | StoryPropertyFiles;
-export interface StoryProperties {
-    [name: string]: StoryProperty;
-}

package/dist/properties.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PropertyTypes = void 0;
-
-/**
- * Property field types
- * examples are provided for the different types:
- *
- */
-var PropertyTypes;
-exports.PropertyTypes = PropertyTypes;
-
-(function (PropertyTypes) {
-  PropertyTypes["TEXT"] = "text";
-  PropertyTypes["NUMBER"] = "number";
-  PropertyTypes["BOOLEAN"] = "boolean";
-  PropertyTypes["OPTIONS"] = "options";
-  PropertyTypes["DATE"] = "date";
-  PropertyTypes["COLOR"] = "color";
-  PropertyTypes["BUTTON"] = "button";
-  PropertyTypes["OBJECT"] = "object";
-  PropertyTypes["ARRAY"] = "array";
-  PropertyTypes["FILES"] = "files";
-})(PropertyTypes || (exports.PropertyTypes = PropertyTypes = {}));

package/dist/properties.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/properties.test.js

@@ -1,14 +0,0 @@
-"use strict";
-
-var _ = require(".");
-
-describe('properties', function () {
-  it('type PropertyTypes.TEXT', function () {
-    expect(function () {
-      var prop = {
-        type: _.PropertyTypes.TEXT
-      };
-      return prop.type === 'text';
-    }).toBeTruthy();
-  });
-});