@storybook/csf 0.0.2--canary.87bc651.0 → 0.0.2--canary.507502b.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Args, InputType } from './story';
 export declare const sanitize: (string: string) => string;
 export declare const toId: (kind: string, name?: string | undefined) => string;
 export declare const storyNameFromExport: (key: string) => string;
@@ -15,4 +16,5 @@ export declare const parseKind: (kind: string, { rootSeparator, groupSeparator }
     root: string | null;
     groups: string[];
 };
+export declare const includeConditionalArg: (argType: InputType, args: Args) => boolean;
 export * from './story';

package/dist/index.js

@@ -8,10 +8,11 @@ var _exportNames = {
   toId: true,
   storyNameFromExport: true,
   isExportStory: true,
-  parseKind: true
+  parseKind: true,
+  includeConditionalArg: true
 };
 exports.isExportStory = isExportStory;
-exports.parseKind = exports.storyNameFromExport = exports.toId = exports.sanitize = void 0;
+exports.includeConditionalArg = exports.parseKind = exports.storyNameFromExport = exports.toId = exports.sanitize = void 0;
 
 var _startCase = _interopRequireDefault(require("lodash/startCase"));
 
@@ -125,5 +126,20 @@ var parseKind = function parseKind(kind, _ref2) {
     groups: groups
   };
 };
+/**
+ * Helper function to include/exclude an arg based on the value of other other args
+ * aka "conditional args"
+ */
+
+
+exports.parseKind = parseKind;
+
+var includeConditionalArg = function includeConditionalArg(argType, args) {
+  var addIf = argType.addIf,
+      removeIf = argType.removeIf;
+  if (addIf) return !!args[addIf];
+  if (removeIf) return !args[removeIf];
+  return true;
+};
 
-exports.parseKind = parseKind;
+exports.includeConditionalArg = includeConditionalArg;

package/dist/index.test.js

@@ -139,4 +139,24 @@ describe('isExportStory', function () {
       excludeStories: /b/
     })).toBeTruthy();
   });
+});
+describe('includeConditionalArg', function () {
+  it('dynamic values', function () {
+    expect((0, _.includeConditionalArg)({
+      addIf: 'foo'
+    }, {
+      foo: true
+    })).toBe(true);
+    expect((0, _.includeConditionalArg)({
+      addIf: 'bar'
+    }, {})).toBe(false);
+    expect((0, _.includeConditionalArg)({
+      removeIf: 'foo'
+    }, {
+      foo: true
+    })).toBe(false);
+    expect((0, _.includeConditionalArg)({
+      removeIf: 'bar'
+    }, {})).toBe(true);
+  });
 });

package/dist/story.d.ts

@@ -21,6 +21,8 @@ export interface InputType {
     description?: string;
     defaultValue?: any;
     type?: SBType | SBScalarType['name'];
+    addIf?: string;
+    removeIf?: string;
     [key: string]: any;
 }
 export interface StrictInputType extends InputType {
@@ -85,20 +87,19 @@ export declare type StoryFn<TFramework extends AnyFramework = AnyFramework, TArg
 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 BaseAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = {
-    decorators?: DecoratorFunction<TFramework, TArgs>[];
+    decorators?: DecoratorFunction<TFramework, Args>[];
     parameters?: Parameters;
     args?: Partial<TArgs>;
     argTypes?: Partial<ArgTypes<TArgs>>;
-    loaders?: LoaderFunction<TFramework, TArgs>[];
-    render?: ArgsStoryFn<TFramework, TArgs>;
-    play?: PlayFunction<TFramework, TArgs>;
+    loaders?: LoaderFunction<TFramework, Args>[];
+    render?: ArgsStoryFn<TFramework, Args>;
 };
 export declare type ProjectAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
-    argsEnhancers?: ArgsEnhancer<TFramework, TArgs>[];
-    argTypesEnhancers?: ArgTypesEnhancer<TFramework, TArgs>[];
+    argsEnhancers?: ArgsEnhancer<TFramework, Args>[];
+    argTypesEnhancers?: ArgTypesEnhancer<TFramework, Args>[];
     globals?: Globals;
     globalTypes?: GlobalTypes;
-    applyDecorators?: DecoratorApplicator<TFramework, TArgs>;
+    applyDecorators?: DecoratorApplicator<TFramework, Args>;
 };
 declare type StoryDescriptor = string[] | RegExp;
 export declare type ComponentAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
@@ -112,6 +113,7 @@ export declare type ComponentAnnotations<TFramework extends AnyFramework = AnyFr
 export declare type StoryAnnotations<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & {
     name?: StoryName;
     storyName?: StoryName;
+    play?: PlayFunction<TFramework, TArgs>;
     story?: Omit<StoryAnnotations<TFramework, TArgs>, 'story'>;
 };
 export declare type LegacyAnnotatedStoryFn<TFramework extends AnyFramework = AnyFramework, TArgs = Args> = StoryFn<TFramework, TArgs> & StoryAnnotations<TFramework, TArgs>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/csf",
-  "version": "0.0.2--canary.87bc651.0",
+  "version": "0.0.2--canary.507502b.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",