@storybook/addon-docs 6.5.0-alpha.9 → 6.5.0-beta.0

package/dist/ts3.9/lib/convert/typescript/convert.d.ts

@@ -1,3 +0,0 @@
-import { SBType } from '@storybook/csf';
-import { TSType } from './types';
-export declare const convert: (type: TSType) => SBType | void;

package/dist/ts3.9/lib/convert/typescript/index.d.ts

@@ -1,2 +0,0 @@
-export * from './convert';
-export * from './types';

package/dist/ts3.9/lib/convert/typescript/types.d.ts

@@ -1,39 +0,0 @@
-interface TSBaseType {
-    name: string;
-    type?: string;
-    raw?: string;
-    required?: boolean;
-}
-declare type TSArgType = TSType;
-declare type TSCombinationType = TSBaseType & {
-    name: 'union' | 'intersection';
-    elements: TSType[];
-};
-declare type TSFuncSigType = TSBaseType & {
-    name: 'signature';
-    type: 'function';
-    signature: {
-        arguments: TSArgType[];
-        return: TSType;
-    };
-};
-declare type TSObjectSigType = TSBaseType & {
-    name: 'signature';
-    type: 'object';
-    signature: {
-        properties: {
-            key: string;
-            value: TSType;
-        }[];
-    };
-};
-declare type TSScalarType = TSBaseType & {
-    name: 'any' | 'boolean' | 'number' | 'void' | 'string' | 'symbol';
-};
-declare type TSArrayType = TSBaseType & {
-    name: 'Array';
-    elements: TSType[];
-};
-export declare type TSSigType = TSObjectSigType | TSFuncSigType;
-export declare type TSType = TSScalarType | TSCombinationType | TSSigType | TSArrayType;
-export {};

package/dist/ts3.9/lib/convert/utils.d.ts

@@ -1 +0,0 @@
-export declare const trimQuotes: (str: string) => string;

package/dist/ts3.9/lib/docgen/PropDef.d.ts

@@ -1,26 +0,0 @@
-export interface JsDocParam {
-    name: string;
-    description?: string;
-}
-export interface JsDocReturns {
-    description?: string;
-}
-export interface JsDocTags {
-    params?: JsDocParam[];
-    returns?: JsDocReturns;
-}
-export interface PropSummaryValue {
-    summary: string;
-    detail?: string;
-}
-export declare type PropType = PropSummaryValue;
-export declare type PropDefaultValue = PropSummaryValue;
-export interface PropDef {
-    name: string;
-    type: PropType;
-    sbType?: any;
-    required: boolean;
-    description?: string;
-    defaultValue?: PropDefaultValue;
-    jsDocTags?: JsDocTags;
-}

package/dist/ts3.9/lib/docgen/createPropDef.d.ts

@@ -1,8 +0,0 @@
-import { PropDef, TypeSystem, DocgenInfo } from './types';
-import { JsDocParsingResult } from '../jsdocParser';
-export declare type PropDefFactory = (propName: string, docgenInfo: DocgenInfo, jsDocParsingResult?: JsDocParsingResult) => PropDef;
-export declare const javaScriptFactory: PropDefFactory;
-export declare const tsFactory: PropDefFactory;
-export declare const flowFactory: PropDefFactory;
-export declare const unknownFactory: PropDefFactory;
-export declare const getPropDefFactory: (typeSystem: TypeSystem) => PropDefFactory;

package/dist/ts3.9/lib/docgen/extractDocgenProps.d.ts

@@ -1,14 +0,0 @@
-import { Component } from '../../blocks/types';
-import { ExtractedJsDoc } from '../jsdocParser';
-import { PropDef, DocgenInfo, TypeSystem } from './types';
-export interface ExtractedProp {
-    propDef: PropDef;
-    docgenInfo: DocgenInfo;
-    jsDocTags: ExtractedJsDoc;
-    typeSystem: TypeSystem;
-}
-export declare type ExtractProps = (component: Component, section: string) => ExtractedProp[];
-export declare const extractComponentSectionArray: (docgenSection: any) => any;
-export declare const extractComponentSectionObject: (docgenSection: any) => ExtractedProp[];
-export declare const extractComponentProps: ExtractProps;
-export declare function extractComponentDescription(component?: Component): string;

package/dist/ts3.9/lib/docgen/flow/createDefaultValue.d.ts

@@ -1,3 +0,0 @@
-import { PropDefaultValue } from '@storybook/components';
-import { DocgenPropDefaultValue, DocgenPropType } from '../types';
-export declare function createDefaultValue(defaultValue: DocgenPropDefaultValue, type: DocgenPropType): PropDefaultValue;

package/dist/ts3.9/lib/docgen/flow/createPropDef.d.ts

@@ -1,2 +0,0 @@
-import { PropDefFactory } from '../createPropDef';
-export declare const createFlowPropDef: PropDefFactory;

package/dist/ts3.9/lib/docgen/flow/createType.d.ts

@@ -1,3 +0,0 @@
-import { PropType } from '@storybook/components';
-import { DocgenFlowType } from '../types';
-export declare function createType(type: DocgenFlowType): PropType;

package/dist/ts3.9/lib/docgen/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './utils';
-export * from './extractDocgenProps';

package/dist/ts3.9/lib/docgen/typeScript/createDefaultValue.d.ts

@@ -1,3 +0,0 @@
-import { PropDefaultValue } from '@storybook/components';
-import { DocgenInfo } from '../types';
-export declare function createDefaultValue({ defaultValue }: DocgenInfo): PropDefaultValue;

package/dist/ts3.9/lib/docgen/typeScript/createPropDef.d.ts

@@ -1,2 +0,0 @@
-import { PropDefFactory } from '../createPropDef';
-export declare const createTsPropDef: PropDefFactory;

package/dist/ts3.9/lib/docgen/typeScript/createType.d.ts

@@ -1,3 +0,0 @@
-import { PropType } from '@storybook/components';
-import { DocgenInfo } from '../types';
-export declare function createType({ tsType, required }: DocgenInfo): PropType;

package/dist/ts3.9/lib/docgen/types.d.ts

@@ -1,46 +0,0 @@
-import { StrictArgTypes } from '@storybook/csf';
-import { PropDef } from './PropDef';
-import { Component } from '../../blocks/types';
-export declare type PropsExtractor = (component: Component) => {
-    rows?: PropDef[];
-} | null;
-export declare type ArgTypesExtractor = (component: Component) => StrictArgTypes | null;
-export interface DocgenType {
-    name: string;
-    description?: string;
-    required?: boolean;
-    value?: any;
-}
-export interface DocgenPropType extends DocgenType {
-    value?: any;
-    raw?: string;
-    computed?: boolean;
-}
-export interface DocgenFlowType extends DocgenType {
-    type?: string;
-    raw?: string;
-    signature?: any;
-    elements?: any[];
-}
-export interface DocgenTypeScriptType extends DocgenType {
-}
-export interface DocgenPropDefaultValue {
-    value: string;
-    computed?: boolean;
-    func?: boolean;
-}
-export interface DocgenInfo {
-    type?: DocgenPropType;
-    flowType?: DocgenFlowType;
-    tsType?: DocgenTypeScriptType;
-    required: boolean;
-    description?: string;
-    defaultValue?: DocgenPropDefaultValue;
-}
-export declare enum TypeSystem {
-    JAVASCRIPT = "JavaScript",
-    FLOW = "Flow",
-    TYPESCRIPT = "TypeScript",
-    UNKNOWN = "Unknown"
-}
-export type { PropDef };

package/dist/ts3.9/lib/docgen/utils/defaultValue.d.ts

@@ -1 +0,0 @@
-export declare function isDefaultValueBlacklisted(value: string): boolean;

package/dist/ts3.9/lib/docgen/utils/docgenInfo.d.ts

@@ -1,5 +0,0 @@
-import { Component } from '../../../blocks/types';
-export declare function hasDocgen(component: Component): boolean;
-export declare function isValidDocgenSection(docgenSection: any): boolean;
-export declare function getDocgenSection(component: Component, section: string): any;
-export declare function getDocgenDescription(component: Component): string;

package/dist/ts3.9/lib/docgen/utils/index.d.ts

@@ -1,3 +0,0 @@
-export * from './defaultValue';
-export * from './string';
-export * from './docgenInfo';

package/dist/ts3.9/lib/docgen/utils/string.d.ts

@@ -1 +0,0 @@
-export declare const str: (obj: any) => string;

package/dist/ts3.9/lib/index.d.ts

@@ -1 +0,0 @@
-export * from './utils';

package/dist/ts3.9/lib/jsdocParser.d.ts

@@ -1,28 +0,0 @@
-export interface ExtractedJsDocParam {
-    name: string;
-    type?: any;
-    description?: string;
-    getPrettyName: () => string;
-    getTypeName: () => string;
-}
-export interface ExtractedJsDocReturns {
-    type?: any;
-    description?: string;
-    getTypeName: () => string;
-}
-export interface ExtractedJsDoc {
-    params?: ExtractedJsDocParam[];
-    returns?: ExtractedJsDocReturns;
-    ignore: boolean;
-}
-export interface JsDocParsingOptions {
-    tags?: string[];
-}
-export interface JsDocParsingResult {
-    includesJsDoc: boolean;
-    ignore: boolean;
-    description?: string;
-    extractedTags?: ExtractedJsDoc;
-}
-export declare type ParseJsDoc = (value?: string, options?: JsDocParsingOptions) => JsDocParsingResult;
-export declare const parseJsDoc: ParseJsDoc;

package/dist/ts3.9/lib/utils.d.ts

@@ -1,7 +0,0 @@
-import { PropSummaryValue } from '@storybook/components';
-export declare const MAX_TYPE_SUMMARY_LENGTH = 90;
-export declare const MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
-export declare function isTooLongForTypeSummary(value: string): boolean;
-export declare function isTooLongForDefaultValueSummary(value: string): boolean;
-export declare function createSummaryValue(summary: string, detail?: string): PropSummaryValue;
-export declare const normalizeNewlines: (string: string) => string;