@storybook/csf 0.0.2--canary.51.768ca23.0 → 0.0.2--canary.51.26e6539.0

package/dist/story.d.ts

@@ -1,164 +0,0 @@
-import { Simplify, UnionToIntersection } from 'type-fest';
-import { SBType, SBScalarType } from './SBType';
-export * from './SBType';
-export declare type StoryId = string;
-export declare type ComponentId = string;
-export declare type ComponentTitle = string;
-export declare type StoryName = string;
-export declare type StoryKind = ComponentTitle;
-export interface StoryIdentifier {
-    componentId: ComponentId;
-    title: ComponentTitle;
-    kind: ComponentTitle;
-    id: StoryId;
-    name: StoryName;
-    story: StoryName;
-}
-export declare type Parameters = {
-    [name: string]: any;
-};
-declare type ConditionalTest = {
-    truthy?: boolean;
-} | {
-    exists: boolean;
-} | {
-    eq: any;
-} | {
-    neq: any;
-};
-declare type ConditionalValue = {
-    arg: string;
-} | {
-    global: string;
-};
-export declare type Conditional = ConditionalValue & ConditionalTest;
-export interface InputType {
-    name?: string;
-    description?: string;
-    defaultValue?: any;
-    type?: SBType | SBScalarType['name'];
-    if?: Conditional;
-    [key: string]: any;
-}
-export interface StrictInputType extends InputType {
-    name: string;
-    type?: SBType;
-}
-export declare type Args = {
-    [name: string]: any;
-};
-export declare type ArgTypes<TArgs = Args> = {
-    [name in keyof TArgs]: InputType;
-};
-export declare type StrictArgTypes<TArgs = Args> = {
-    [name in keyof TArgs]: StrictInputType;
-};
-export declare type Globals = {
-    [name: string]: any;
-};
-export declare type GlobalTypes = {
-    [name: string]: InputType;
-};
-export declare type StrictGlobalTypes = {
-    [name: string]: StrictInputType;
-};
-export declare type AnyFramework = {
-    component: unknown;
-    storyResult: unknown;
-    T?: unknown;
-};
-export declare type StoryContextForEnhancers<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryIdentifier & {
-    component?: (TFramework & {
-        T: any;
-    })['component'];
-    subcomponents?: Record<string, (TFramework & {
-        T: any;
-    })['component']>;
-    parameters: Parameters;
-    initialArgs: TArgs;
-    argTypes: StrictArgTypes<TArgs>;
-};
-export declare type ArgsEnhancer<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (context: StoryContextForEnhancers<TFramework, TArgs>) => TArgs;
-export declare type ArgTypesEnhancer<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = ((context: StoryContextForEnhancers<TFramework, TArgs>) => StrictArgTypes<TArgs>) & {
-    secondPass?: boolean;
-};
-export declare type StoryContextUpdate<TArgs = Args> = {
-    args?: TArgs;
-    globals?: Globals;
-    [key: string]: any;
-};
-export declare type ViewMode = 'story' | 'docs';
-export declare type StoryContextForLoaders<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryContextForEnhancers<TFramework, TArgs> & Required<StoryContextUpdate<TArgs>> & {
-    hooks: unknown;
-    viewMode: ViewMode;
-    originalStoryFn: StoryFn<TFramework>;
-};
-export declare type LoaderFunction<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = (context: StoryContextForLoaders<TFramework, TArgs>) => Promise<Record<string, any>>;
-export declare type StoryContext<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryContextForLoaders<TFramework, TArgs> & {
-    loaded: Record<string, any>;
-    abortSignal: AbortSignal;
-    canvasElement: HTMLElement;
-};
-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 & {
-    T: TArgs;
-})['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, TArgs>[];
-    parameters?: Parameters;
-    args?: Partial<TArgs>;
-    argTypes?: Partial<ArgTypes<TArgs>>;
-    loaders?: LoaderFunction<TFramework, TArgs>[];
-    render?: ArgsStoryFn<TFramework, TArgs>;
-};
-export declare type ProjectAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
-    argsEnhancers?: ArgsEnhancer<TFramework, Args>[];
-    argTypesEnhancers?: ArgTypesEnhancer<TFramework, Args>[];
-    globals?: Globals;
-    globalTypes?: GlobalTypes;
-    applyDecorators?: DecoratorApplicator<TFramework, Args>;
-    runStep?: StepRunner<TFramework, TArgs>;
-};
-declare type StoryDescriptor = string[] | RegExp;
-export interface ComponentAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> extends BaseAnnotations<TFramework, TArgs> {
-    title?: ComponentTitle;
-    id?: ComponentId;
-    includeStories?: StoryDescriptor;
-    excludeStories?: StoryDescriptor;
-    component?: (TFramework & {
-        T: Args extends TArgs ? any : TArgs;
-    })['component'];
-    subcomponents?: Record<string, TFramework['component']>;
-}
-export declare type StoryAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TFramework, TArgs> & {
-    name?: StoryName;
-    storyName?: StoryName;
-    play?: PlayFunction<TFramework, TArgs>;
-    story?: Omit<StoryAnnotations<TFramework, TArgs>, 'story'>;
-} & ({} extends TRequiredArgs ? {
-    args?: TRequiredArgs;
-} : {
-    args: TRequiredArgs;
-});
-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>;
-export declare type StoryAnnotationsOrFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = AnnotatedStoryFn<TFramework, TArgs> | StoryAnnotations<TFramework, TArgs>;
-export declare type ArgsFromMeta<TFramework extends AnyFramework, Meta> = Meta extends {
-    render?: ArgsStoryFn<TFramework, infer RArgs>;
-    loaders?: (infer Loaders)[];
-    decorators?: (infer Decorators)[];
-} ? Simplify<RArgs & DecoratorsArgs<TFramework, Decorators> & LoaderArgs<TFramework, Loaders>> : unknown;
-declare type DecoratorsArgs<TFramework extends AnyFramework, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TFramework, infer Args> ? Args : unknown>;
-declare type LoaderArgs<TFramework extends AnyFramework, Loaders> = UnionToIntersection<Loaders extends LoaderFunction<TFramework, infer Args> ? Args : unknown>;

package/dist/story.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _SBType = require("./SBType");
-
-Object.keys(_SBType).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _SBType[key];
-    }
-  });
-});

package/dist/story.test.js

@@ -1,236 +0,0 @@
-"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(props) {
-  return 'Button';
-}; // NOTE Various kind usages
-
-
-var simple = {
-  title: 'simple',
-  component: Button,
-  decorators: [function (storyFn, context) {
-    return "withDecorator(".concat(storyFn(context), ")");
-  }],
-  parameters: {
-    a: function a() {
-      return null;
-    },
-    b: NaN,
-    c: Symbol('symbol')
-  },
-  loaders: [function () {
-    return Promise.resolve({
-      d: '3'
-    });
-  }],
-  args: {
-    x: '1'
-  },
-  argTypes: {
-    x: {
-      type: {
-        name: 'string'
-      }
-    }
-  }
-};
-var strict = {
-  title: 'simple',
-  component: Button,
-  decorators: [function (storyFn, context) {
-    return "withDecorator(".concat(storyFn(context), ")");
-  }],
-  parameters: {
-    a: function a() {
-      return null;
-    },
-    b: NaN,
-    c: Symbol('symbol')
-  },
-  loaders: [function () {
-    return Promise.resolve({
-      d: '3'
-    });
-  }],
-  args: {
-    x: '1'
-  },
-  argTypes: {
-    x: {
-      type: {
-        name: 'string'
-      }
-    }
-  }
-}; // NOTE Various story usages
-
-var Simple = function Simple() {
-  return 'Simple';
-};
-
-var CSF1Story = function CSF1Story() {
-  return 'Named Story';
-};
-
-CSF1Story.story = {
-  name: 'Another name for story',
-  decorators: [function (storyFn) {
-    return "Wrapped(".concat(storyFn());
-  }],
-  parameters: {
-    a: [1, '2', {}],
-    b: undefined,
-    c: Button
-  },
-  loaders: [function () {
-    return Promise.resolve({
-      d: '3'
-    });
-  }],
-  args: {
-    a: 1
-  }
-};
-
-var CSF2Story = function CSF2Story() {
-  return 'Named Story';
-};
-
-CSF2Story.storyName = 'Another name for story';
-CSF2Story.decorators = [function (storyFn) {
-  return "Wrapped(".concat(storyFn());
-}];
-CSF2Story.parameters = {
-  a: [1, '2', {}],
-  b: undefined,
-  c: Button
-};
-CSF2Story.loaders = [function () {
-  return Promise.resolve({
-    d: '3'
-  });
-}];
-CSF2Story.args = {
-  a: 1
-};
-var CSF3Story = {
-  render: function render(args) {
-    return 'Named Story';
-  },
-  name: 'Another name for story',
-  decorators: [function (storyFn) {
-    return "Wrapped(".concat(storyFn());
-  }],
-  parameters: {
-    a: [1, '2', {}],
-    b: undefined,
-    c: Button
-  },
-  loaders: [function () {
-    return Promise.resolve({
-      d: '3'
-    });
-  }],
-  args: {
-    a: 1
-  }
-};
-var CSF3StoryStrict = {
-  render: function render(args) {
-    return 'Named Story';
-  },
-  name: 'Another name for story',
-  decorators: [function (storyFn) {
-    return "Wrapped(".concat(storyFn());
-  }],
-  parameters: {
-    a: [1, '2', {}],
-    b: undefined,
-    c: Button
-  },
-  loaders: [function () {
-    return Promise.resolve({
-      d: '3'
-    });
-  }],
-  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
-
-describe('story', function () {
-  test('true', function () {
-    return expect(true).toBe(true);
-  });
-});