Socket
Socket
Sign inDemoInstall

@storybook/docs-tools

Package Overview
Dependencies
244
Maintainers
26
Versions
673
Alerts
File Explorer

Advanced tools

npm Scripts

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.0.0-pr-26853-sha-b51db447 to 0.0.0-pr-26875-sha-1378113c

2

dist/index.js

@@ -1,1 +0,1 @@

"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{ADDON_ID:()=>ADDON_ID,MAX_DEFAULT_VALUE_SUMMARY_LENGTH:()=>MAX_DEFAULT_VALUE_SUMMARY_LENGTH,MAX_TYPE_SUMMARY_LENGTH:()=>MAX_TYPE_SUMMARY_LENGTH,PANEL_ID:()=>PANEL_ID,PARAM_KEY:()=>PARAM_KEY,SNIPPET_RENDERED:()=>SNIPPET_RENDERED,SourceType:()=>SourceType,TypeSystem:()=>TypeSystem,convert:()=>convert4,createSummaryValue:()=>createSummaryValue,enhanceArgTypes:()=>enhanceArgTypes,extractComponentDescription:()=>extractComponentDescription,extractComponentProps:()=>extractComponentProps,extractComponentSectionArray:()=>extractComponentSectionArray,extractComponentSectionObject:()=>extractComponentSectionObject,getDocgenDescription:()=>getDocgenDescription,getDocgenSection:()=>getDocgenSection,hasDocgen:()=>hasDocgen,hasDocsOrControls:()=>hasDocsOrControls,isDefaultValueBlacklisted:()=>isDefaultValueBlacklisted,isTooLongForDefaultValueSummary:()=>isTooLongForDefaultValueSummary,isTooLongForTypeSummary:()=>isTooLongForTypeSummary,isValidDocgenSection:()=>isValidDocgenSection,normalizeNewlines:()=>normalizeNewlines,parseJsDoc:()=>parseJsDoc,str:()=>str});module.exports=__toCommonJS(src_exports);var QUOTE_REGEX=/^['"]|['"]$/g,trimQuotes=str2=>str2.replace(QUOTE_REGEX,""),includesQuotes=str2=>QUOTE_REGEX.test(str2),parseLiteral=str2=>{let trimmedValue=trimQuotes(str2);return includesQuotes(str2)||Number.isNaN(Number(trimmedValue))?trimmedValue:Number(trimmedValue)};var convertSig=type=>{switch(type.type){case"function":return{name:"function"};case"object":let values={};return type.signature.properties.forEach(prop=>{values[prop.key]=convert(prop.value)}),{name:"object",value:values};default:throw new Error(`Unknown: ${type}`)}},convert=type=>{let{name,raw}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),type.name){case"string":case"number":case"symbol":case"boolean":return{...base,name};case"Array":return{...base,name:"array",value:type.elements.map(convert)};case"signature":return{...base,...convertSig(type)};case"union":let result;return type.elements?.every(element=>element.name==="literal")?result={...base,name:"enum",value:type.elements?.map(v=>parseLiteral(v.value))}:result={...base,name,value:type.elements?.map(convert)},result;case"intersection":return{...base,name,value:type.elements?.map(convert)};default:return{...base,name:"other",value:name}}};var isLiteral=type=>type.name==="literal",toEnumOption=element=>element.value.replace(/['|"]/g,""),convertSig2=type=>{switch(type.type){case"function":return{name:"function"};case"object":let values={};return type.signature.properties.forEach(prop=>{values[prop.key]=convert2(prop.value)}),{name:"object",value:values};default:throw new Error(`Unknown: ${type}`)}},convert2=type=>{let{name,raw}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),type.name){case"literal":return{...base,name:"other",value:type.value};case"string":case"number":case"symbol":case"boolean":return{...base,name};case"Array":return{...base,name:"array",value:type.elements.map(convert2)};case"signature":return{...base,...convertSig2(type)};case"union":return type.elements?.every(isLiteral)?{...base,name:"enum",value:type.elements?.map(toEnumOption)}:{...base,name,value:type.elements?.map(convert2)};case"intersection":return{...base,name,value:type.elements?.map(convert2)};default:return{...base,name:"other",value:name}}};var import_mapValues=__toESM(require("lodash/mapValues.js"));var SIGNATURE_REGEXP=/^\(.*\) => /,convert3=type=>{let{name,raw,computed,value}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),name){case"enum":{let values2=computed?value:value.map(v=>parseLiteral(v.value));return{...base,name,value:values2}}case"string":case"number":case"symbol":return{...base,name};case"func":return{...base,name:"function"};case"bool":case"boolean":return{...base,name:"boolean"};case"arrayOf":case"array":return{...base,name:"array",value:value&&convert3(value)};case"object":return{...base,name};case"objectOf":return{...base,name,value:convert3(value)};case"shape":case"exact":let values=(0,import_mapValues.default)(value,field=>convert3(field));return{...base,name:"object",value:values};case"union":return{...base,name:"union",value:value.map(v=>convert3(v))};case"instanceOf":case"element":case"elementType":default:{if(name?.indexOf("|")>0)try{let literalValues=name.split("|").map(v=>JSON.parse(v));return{...base,name:"enum",value:literalValues}}catch{}let otherVal=value?`${name}(${value})`:name,otherName=SIGNATURE_REGEXP.test(name)?"function":"other";return{...base,name:otherName,value:otherVal}}}};var convert4=docgenInfo=>{let{type,tsType,flowType}=docgenInfo;return type!=null?convert3(type):tsType!=null?convert(tsType):flowType!=null?convert2(flowType):null};var TypeSystem=(TypeSystem2=>(TypeSystem2.JAVASCRIPT="JavaScript",TypeSystem2.FLOW="Flow",TypeSystem2.TYPESCRIPT="TypeScript",TypeSystem2.UNKNOWN="Unknown",TypeSystem2))(TypeSystem||{});var BLACKLIST=["null","undefined"];function isDefaultValueBlacklisted(value){return BLACKLIST.some(x=>x===value)}var str=obj=>{if(!obj)return"";if(typeof obj=="string")return obj;throw new Error(`Description: expected string, got: ${JSON.stringify(obj)}`)};function hasDocgen(component){return!!component.__docgenInfo}function isValidDocgenSection(docgenSection){return docgenSection!=null&&Object.keys(docgenSection).length>0}function getDocgenSection(component,section){return hasDocgen(component)?component.__docgenInfo[section]:null}function getDocgenDescription(component){return hasDocgen(component)?str(component.__docgenInfo.description):""}var import_doctrine=__toESM(require("doctrine"));function containsJsDoc(value){return value!=null&&value.includes("@")}function parse(content,tags){let ast;try{ast=import_doctrine.default.parse(content??"",{tags,sloppy:!0})}catch(e){throw console.error(e),new Error("Cannot parse JSDoc tags.")}return ast}var DEFAULT_OPTIONS={tags:["param","arg","argument","returns","ignore","deprecated"]},parseJsDoc=(value,options=DEFAULT_OPTIONS)=>{if(!containsJsDoc(value))return{includesJsDoc:!1,ignore:!1};let jsDocAst=parse(value,options.tags),extractedTags=extractJsDocTags(jsDocAst);return extractedTags.ignore?{includesJsDoc:!0,ignore:!0}:{includesJsDoc:!0,ignore:!1,description:jsDocAst.description,extractedTags}};function extractJsDocTags(ast){let extractedTags={params:null,deprecated:null,returns:null,ignore:!1};for(let i=0;i<ast.tags.length;i+=1){let tag=ast.tags[i];if(tag.title==="ignore"){extractedTags.ignore=!0;break}else switch(tag.title){case"param":case"arg":case"argument":{let paramTag=extractParam(tag);paramTag!=null&&(extractedTags.params==null&&(extractedTags.params=[]),extractedTags.params.push(paramTag));break}case"deprecated":{let deprecatedTag=extractDeprecated(tag);deprecatedTag!=null&&(extractedTags.deprecated=deprecatedTag);break}case"returns":{let returnsTag=extractReturns(tag);returnsTag!=null&&(extractedTags.returns=returnsTag);break}default:break}}return extractedTags}function extractParam(tag){let paramName=tag.name;return paramName!=null&&paramName!=="null-null"?{name:tag.name,type:tag.type,description:tag.description,getPrettyName:()=>paramName.includes("null")?paramName.replace("-null","").replace(".null",""):tag.name,getTypeName:()=>tag.type!=null?extractTypeName(tag.type):null}:null}function extractDeprecated(tag){return tag.title!=null?tag.description:null}function extractReturns(tag){return tag.type!=null?{type:tag.type,description:tag.description,getTypeName:()=>extractTypeName(tag.type)}:null}function extractTypeName(type){return type?.type==="NameExpression"?type.name:type?.type==="RecordType"?`({${type.fields.map(field=>{if(field.type==="FieldType"&&field.value!=null){let valueTypeName=extractTypeName(field.value);return`${field.key}: ${valueTypeName}`}return field.key}).join(", ")}})`:type?.type==="UnionType"?`(${type.elements.map(extractTypeName).join("|")})`:type?.type==="ArrayType"?"[]":type?.type==="TypeApplication"&&type.expression!=null&&type.expression.name==="Array"?`${extractTypeName(type.applications[0])}[]`:type?.type==="NullableType"||type?.type==="NonNullableType"||type?.type==="OptionalType"?extractTypeName(type.expression):type?.type==="AllLiteral"?"any":null}var MAX_TYPE_SUMMARY_LENGTH=90,MAX_DEFAULT_VALUE_SUMMARY_LENGTH=50;function isTooLongForTypeSummary(value){return value.length>90}function isTooLongForDefaultValueSummary(value){return value.length>50}function createSummaryValue(summary,detail){return summary===detail?{summary}:{summary,detail}}var normalizeNewlines=string=>string.replace(/\\r\\n/g,"\\n");function generateUnionElement({name,value,elements,raw}){return value??(elements!=null?elements.map(generateUnionElement).join(" | "):raw??name)}function generateUnion({name,raw,elements}){return elements!=null?createSummaryValue(elements.map(generateUnionElement).join(" | ")):raw!=null?createSummaryValue(raw.replace(/^\|\s*/,"")):createSummaryValue(name)}function generateFuncSignature({type,raw}){return raw!=null?createSummaryValue(raw):createSummaryValue(type)}function generateObjectSignature({type,raw}){return raw!=null?isTooLongForTypeSummary(raw)?createSummaryValue(type,raw):createSummaryValue(raw):createSummaryValue(type)}function generateSignature(flowType){let{type}=flowType;return type==="object"?generateObjectSignature(flowType):generateFuncSignature(flowType)}function generateDefault({name,raw}){return raw!=null?isTooLongForTypeSummary(raw)?createSummaryValue(name,raw):createSummaryValue(raw):createSummaryValue(name)}function createType(type){if(type==null)return null;switch(type.name){case"union":return generateUnion(type);case"signature":return generateSignature(type);default:return generateDefault(type)}}function createDefaultValue(defaultValue,type){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return isTooLongForDefaultValueSummary(value)?createSummaryValue(type?.name,value):createSummaryValue(value)}return null}var createFlowPropDef=(propName,docgenInfo)=>{let{flowType,description,required,defaultValue}=docgenInfo;return{name:propName,type:createType(flowType),required,description,defaultValue:createDefaultValue(defaultValue??null,flowType??null)}};function createType2({tsType,required}){if(tsType==null)return null;let typeName=tsType.name;return required||(typeName=typeName.replace(" | undefined","")),createSummaryValue(["Array","Record","signature"].includes(tsType.name)?tsType.raw:typeName)}function createDefaultValue2({defaultValue}){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return createSummaryValue(value)}return null}var createTsPropDef=(propName,docgenInfo)=>{let{description,required}=docgenInfo;return{name:propName,type:createType2(docgenInfo),required,description,defaultValue:createDefaultValue2(docgenInfo)}};function createType3(type){return type!=null?createSummaryValue(type.name):null}function isReactDocgenTypescript(defaultValue){let{computed,func}=defaultValue;return typeof computed>"u"&&typeof func>"u"}function isStringValued(type){return type?type.name==="string"?!0:type.name==="enum"?Array.isArray(type.value)&&type.value.every(({value:tv})=>typeof tv=="string"&&tv[0]==='"'&&tv[tv.length-1]==='"'):!1:!1}function createDefaultValue3(defaultValue,type){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return isReactDocgenTypescript(defaultValue)&&isStringValued(type)?createSummaryValue(JSON.stringify(value)):createSummaryValue(value)}return null}function createBasicPropDef(name,type,docgenInfo){let{description,required,defaultValue}=docgenInfo;return{name,type:createType3(type),required,description,defaultValue:createDefaultValue3(defaultValue,type)}}function applyJsDocResult(propDef,jsDocParsingResult){if(jsDocParsingResult?.includesJsDoc){let{description,extractedTags}=jsDocParsingResult;description!=null&&(propDef.description=jsDocParsingResult.description);let value={...extractedTags,params:extractedTags?.params?.map(x=>({name:x.getPrettyName(),description:x.description}))};Object.values(value).filter(Boolean).length>0&&(propDef.jsDocTags=value)}return propDef}var javaScriptFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createBasicPropDef(propName,docgenInfo.type,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},tsFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createTsPropDef(propName,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},flowFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createFlowPropDef(propName,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},unknownFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createBasicPropDef(propName,{name:"unknown"},docgenInfo);return applyJsDocResult(propDef,jsDocParsingResult)},getPropDefFactory=typeSystem=>{switch(typeSystem){case"JavaScript":return javaScriptFactory;case"TypeScript":return tsFactory;case"Flow":return flowFactory;default:return unknownFactory}};var getTypeSystem=docgenInfo=>docgenInfo.type!=null?"JavaScript":docgenInfo.flowType!=null?"Flow":docgenInfo.tsType!=null?"TypeScript":"Unknown",extractComponentSectionArray=docgenSection=>{let typeSystem=getTypeSystem(docgenSection[0]),createPropDef=getPropDefFactory(typeSystem);return docgenSection.map(item=>{let sanitizedItem=item;return item.type?.elements&&(sanitizedItem={...item,type:{...item.type,value:item.type.elements}}),extractProp(sanitizedItem.name,sanitizedItem,typeSystem,createPropDef)})},extractComponentSectionObject=docgenSection=>{let docgenPropsKeys=Object.keys(docgenSection),typeSystem=getTypeSystem(docgenSection[docgenPropsKeys[0]]),createPropDef=getPropDefFactory(typeSystem);return docgenPropsKeys.map(propName=>{let docgenInfo=docgenSection[propName];return docgenInfo!=null?extractProp(propName,docgenInfo,typeSystem,createPropDef):null}).filter(Boolean)},extractComponentProps=(component,section)=>{let docgenSection=getDocgenSection(component,section);return isValidDocgenSection(docgenSection)?Array.isArray(docgenSection)?extractComponentSectionArray(docgenSection):extractComponentSectionObject(docgenSection):[]};function extractProp(propName,docgenInfo,typeSystem,createPropDef){let jsDocParsingResult=parseJsDoc(docgenInfo.description);return jsDocParsingResult.includesJsDoc&&jsDocParsingResult.ignore?null:{propDef:createPropDef(propName,docgenInfo,jsDocParsingResult),jsDocTags:jsDocParsingResult.extractedTags,docgenInfo,typeSystem}}function extractComponentDescription(component){return component!=null?getDocgenDescription(component):""}var import_preview_api=require("@storybook/preview-api"),enhanceArgTypes=context=>{let{component,argTypes:userArgTypes,parameters:{docs={}}}=context,{extractArgTypes}=docs,extractedArgTypes=extractArgTypes&&component?extractArgTypes(component):{};return extractedArgTypes?(0,import_preview_api.combineParameters)(extractedArgTypes,userArgTypes):userArgTypes};var ADDON_ID="storybook/docs",PANEL_ID=`${ADDON_ID}/panel`,PARAM_KEY="docs",SNIPPET_RENDERED=`${ADDON_ID}/snippet-rendered`,SourceType=(SourceType2=>(SourceType2.AUTO="auto",SourceType2.CODE="code",SourceType2.DYNAMIC="dynamic",SourceType2))(SourceType||{});var packageRe=/(addons\/|addon-|addon-essentials\/)(docs|controls)/,hasDocsOrControls=options=>options.presetsList?.some(preset=>packageRe.test(preset.name));0&&(module.exports={ADDON_ID,MAX_DEFAULT_VALUE_SUMMARY_LENGTH,MAX_TYPE_SUMMARY_LENGTH,PANEL_ID,PARAM_KEY,SNIPPET_RENDERED,SourceType,TypeSystem,convert,createSummaryValue,enhanceArgTypes,extractComponentDescription,extractComponentProps,extractComponentSectionArray,extractComponentSectionObject,getDocgenDescription,getDocgenSection,hasDocgen,hasDocsOrControls,isDefaultValueBlacklisted,isTooLongForDefaultValueSummary,isTooLongForTypeSummary,isValidDocgenSection,normalizeNewlines,parseJsDoc,str});
"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{ADDON_ID:()=>ADDON_ID,MAX_DEFAULT_VALUE_SUMMARY_LENGTH:()=>MAX_DEFAULT_VALUE_SUMMARY_LENGTH,MAX_TYPE_SUMMARY_LENGTH:()=>MAX_TYPE_SUMMARY_LENGTH,PANEL_ID:()=>PANEL_ID,PARAM_KEY:()=>PARAM_KEY,SNIPPET_RENDERED:()=>SNIPPET_RENDERED,SourceType:()=>SourceType,TypeSystem:()=>TypeSystem,convert:()=>convert4,createSummaryValue:()=>createSummaryValue,enhanceArgTypes:()=>enhanceArgTypes,extractComponentDescription:()=>extractComponentDescription,extractComponentProps:()=>extractComponentProps,extractComponentSectionArray:()=>extractComponentSectionArray,extractComponentSectionObject:()=>extractComponentSectionObject,getDocgenDescription:()=>getDocgenDescription,getDocgenSection:()=>getDocgenSection,hasDocgen:()=>hasDocgen,hasDocsOrControls:()=>hasDocsOrControls,isDefaultValueBlacklisted:()=>isDefaultValueBlacklisted,isTooLongForDefaultValueSummary:()=>isTooLongForDefaultValueSummary,isTooLongForTypeSummary:()=>isTooLongForTypeSummary,isValidDocgenSection:()=>isValidDocgenSection,normalizeNewlines:()=>normalizeNewlines,parseJsDoc:()=>parseJsDoc,str:()=>str});module.exports=__toCommonJS(src_exports);var import_preview_errors=require("@storybook/core-events/preview-errors");var QUOTE_REGEX=/^['"]|['"]$/g,trimQuotes=str2=>str2.replace(QUOTE_REGEX,""),includesQuotes=str2=>QUOTE_REGEX.test(str2),parseLiteral=str2=>{let trimmedValue=trimQuotes(str2);return includesQuotes(str2)||Number.isNaN(Number(trimmedValue))?trimmedValue:Number(trimmedValue)};var convertSig=type=>{switch(type.type){case"function":return{name:"function"};case"object":let values={};return type.signature.properties.forEach(prop=>{values[prop.key]=convert(prop.value)}),{name:"object",value:values};default:throw new import_preview_errors.UnknownArgTypesError({type,language:"Typescript"})}},convert=type=>{let{name,raw}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),type.name){case"string":case"number":case"symbol":case"boolean":return{...base,name};case"Array":return{...base,name:"array",value:type.elements.map(convert)};case"signature":return{...base,...convertSig(type)};case"union":let result;return type.elements?.every(element=>element.name==="literal")?result={...base,name:"enum",value:type.elements?.map(v=>parseLiteral(v.value))}:result={...base,name,value:type.elements?.map(convert)},result;case"intersection":return{...base,name,value:type.elements?.map(convert)};default:return{...base,name:"other",value:name}}};var import_preview_errors2=require("@storybook/core-events/preview-errors"),isLiteral=type=>type.name==="literal",toEnumOption=element=>element.value.replace(/['|"]/g,""),convertSig2=type=>{switch(type.type){case"function":return{name:"function"};case"object":let values={};return type.signature.properties.forEach(prop=>{values[prop.key]=convert2(prop.value)}),{name:"object",value:values};default:throw new import_preview_errors2.UnknownArgTypesError({type,language:"Flow"})}},convert2=type=>{let{name,raw}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),type.name){case"literal":return{...base,name:"other",value:type.value};case"string":case"number":case"symbol":case"boolean":return{...base,name};case"Array":return{...base,name:"array",value:type.elements.map(convert2)};case"signature":return{...base,...convertSig2(type)};case"union":return type.elements?.every(isLiteral)?{...base,name:"enum",value:type.elements?.map(toEnumOption)}:{...base,name,value:type.elements?.map(convert2)};case"intersection":return{...base,name,value:type.elements?.map(convert2)};default:return{...base,name:"other",value:name}}};var import_mapValues=__toESM(require("lodash/mapValues.js"));var SIGNATURE_REGEXP=/^\(.*\) => /,convert3=type=>{let{name,raw,computed,value}=type,base={};switch(typeof raw<"u"&&(base.raw=raw),name){case"enum":{let values2=computed?value:value.map(v=>parseLiteral(v.value));return{...base,name,value:values2}}case"string":case"number":case"symbol":return{...base,name};case"func":return{...base,name:"function"};case"bool":case"boolean":return{...base,name:"boolean"};case"arrayOf":case"array":return{...base,name:"array",value:value&&convert3(value)};case"object":return{...base,name};case"objectOf":return{...base,name,value:convert3(value)};case"shape":case"exact":let values=(0,import_mapValues.default)(value,field=>convert3(field));return{...base,name:"object",value:values};case"union":return{...base,name:"union",value:value.map(v=>convert3(v))};case"instanceOf":case"element":case"elementType":default:{if(name?.indexOf("|")>0)try{let literalValues=name.split("|").map(v=>JSON.parse(v));return{...base,name:"enum",value:literalValues}}catch{}let otherVal=value?`${name}(${value})`:name,otherName=SIGNATURE_REGEXP.test(name)?"function":"other";return{...base,name:otherName,value:otherVal}}}};var convert4=docgenInfo=>{let{type,tsType,flowType}=docgenInfo;return type!=null?convert3(type):tsType!=null?convert(tsType):flowType!=null?convert2(flowType):null};var TypeSystem=(TypeSystem2=>(TypeSystem2.JAVASCRIPT="JavaScript",TypeSystem2.FLOW="Flow",TypeSystem2.TYPESCRIPT="TypeScript",TypeSystem2.UNKNOWN="Unknown",TypeSystem2))(TypeSystem||{});var BLACKLIST=["null","undefined"];function isDefaultValueBlacklisted(value){return BLACKLIST.some(x=>x===value)}var str=obj=>{if(!obj)return"";if(typeof obj=="string")return obj;throw new Error(`Description: expected string, got: ${JSON.stringify(obj)}`)};function hasDocgen(component){return!!component.__docgenInfo}function isValidDocgenSection(docgenSection){return docgenSection!=null&&Object.keys(docgenSection).length>0}function getDocgenSection(component,section){return hasDocgen(component)?component.__docgenInfo[section]:null}function getDocgenDescription(component){return hasDocgen(component)?str(component.__docgenInfo.description):""}var import_doctrine=__toESM(require("doctrine"));function containsJsDoc(value){return value!=null&&value.includes("@")}function parse(content,tags){let ast;try{ast=import_doctrine.default.parse(content??"",{tags,sloppy:!0})}catch(e){throw console.error(e),new Error("Cannot parse JSDoc tags.")}return ast}var DEFAULT_OPTIONS={tags:["param","arg","argument","returns","ignore","deprecated"]},parseJsDoc=(value,options=DEFAULT_OPTIONS)=>{if(!containsJsDoc(value))return{includesJsDoc:!1,ignore:!1};let jsDocAst=parse(value,options.tags),extractedTags=extractJsDocTags(jsDocAst);return extractedTags.ignore?{includesJsDoc:!0,ignore:!0}:{includesJsDoc:!0,ignore:!1,description:jsDocAst.description,extractedTags}};function extractJsDocTags(ast){let extractedTags={params:null,deprecated:null,returns:null,ignore:!1};for(let i=0;i<ast.tags.length;i+=1){let tag=ast.tags[i];if(tag.title==="ignore"){extractedTags.ignore=!0;break}else switch(tag.title){case"param":case"arg":case"argument":{let paramTag=extractParam(tag);paramTag!=null&&(extractedTags.params==null&&(extractedTags.params=[]),extractedTags.params.push(paramTag));break}case"deprecated":{let deprecatedTag=extractDeprecated(tag);deprecatedTag!=null&&(extractedTags.deprecated=deprecatedTag);break}case"returns":{let returnsTag=extractReturns(tag);returnsTag!=null&&(extractedTags.returns=returnsTag);break}default:break}}return extractedTags}function extractParam(tag){let paramName=tag.name;return paramName!=null&&paramName!=="null-null"?{name:tag.name,type:tag.type,description:tag.description,getPrettyName:()=>paramName.includes("null")?paramName.replace("-null","").replace(".null",""):tag.name,getTypeName:()=>tag.type!=null?extractTypeName(tag.type):null}:null}function extractDeprecated(tag){return tag.title!=null?tag.description:null}function extractReturns(tag){return tag.type!=null?{type:tag.type,description:tag.description,getTypeName:()=>extractTypeName(tag.type)}:null}function extractTypeName(type){return type?.type==="NameExpression"?type.name:type?.type==="RecordType"?`({${type.fields.map(field=>{if(field.type==="FieldType"&&field.value!=null){let valueTypeName=extractTypeName(field.value);return`${field.key}: ${valueTypeName}`}return field.key}).join(", ")}})`:type?.type==="UnionType"?`(${type.elements.map(extractTypeName).join("|")})`:type?.type==="ArrayType"?"[]":type?.type==="TypeApplication"&&type.expression!=null&&type.expression.name==="Array"?`${extractTypeName(type.applications[0])}[]`:type?.type==="NullableType"||type?.type==="NonNullableType"||type?.type==="OptionalType"?extractTypeName(type.expression):type?.type==="AllLiteral"?"any":null}var MAX_TYPE_SUMMARY_LENGTH=90,MAX_DEFAULT_VALUE_SUMMARY_LENGTH=50;function isTooLongForTypeSummary(value){return value.length>90}function isTooLongForDefaultValueSummary(value){return value.length>50}function createSummaryValue(summary,detail){return summary===detail?{summary}:{summary,detail}}var normalizeNewlines=string=>string.replace(/\\r\\n/g,"\\n");function generateUnionElement({name,value,elements,raw}){return value??(elements!=null?elements.map(generateUnionElement).join(" | "):raw??name)}function generateUnion({name,raw,elements}){return elements!=null?createSummaryValue(elements.map(generateUnionElement).join(" | ")):raw!=null?createSummaryValue(raw.replace(/^\|\s*/,"")):createSummaryValue(name)}function generateFuncSignature({type,raw}){return raw!=null?createSummaryValue(raw):createSummaryValue(type)}function generateObjectSignature({type,raw}){return raw!=null?isTooLongForTypeSummary(raw)?createSummaryValue(type,raw):createSummaryValue(raw):createSummaryValue(type)}function generateSignature(flowType){let{type}=flowType;return type==="object"?generateObjectSignature(flowType):generateFuncSignature(flowType)}function generateDefault({name,raw}){return raw!=null?isTooLongForTypeSummary(raw)?createSummaryValue(name,raw):createSummaryValue(raw):createSummaryValue(name)}function createType(type){if(type==null)return null;switch(type.name){case"union":return generateUnion(type);case"signature":return generateSignature(type);default:return generateDefault(type)}}function createDefaultValue(defaultValue,type){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return isTooLongForDefaultValueSummary(value)?createSummaryValue(type?.name,value):createSummaryValue(value)}return null}var createFlowPropDef=(propName,docgenInfo)=>{let{flowType,description,required,defaultValue}=docgenInfo;return{name:propName,type:createType(flowType),required,description,defaultValue:createDefaultValue(defaultValue??null,flowType??null)}};function createType2({tsType,required}){if(tsType==null)return null;let typeName=tsType.name;return required||(typeName=typeName.replace(" | undefined","")),createSummaryValue(["Array","Record","signature"].includes(tsType.name)?tsType.raw:typeName)}function createDefaultValue2({defaultValue}){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return createSummaryValue(value)}return null}var createTsPropDef=(propName,docgenInfo)=>{let{description,required}=docgenInfo;return{name:propName,type:createType2(docgenInfo),required,description,defaultValue:createDefaultValue2(docgenInfo)}};function createType3(type){return type!=null?createSummaryValue(type.name):null}function isReactDocgenTypescript(defaultValue){let{computed,func}=defaultValue;return typeof computed>"u"&&typeof func>"u"}function isStringValued(type){return type?type.name==="string"?!0:type.name==="enum"?Array.isArray(type.value)&&type.value.every(({value:tv})=>typeof tv=="string"&&tv[0]==='"'&&tv[tv.length-1]==='"'):!1:!1}function createDefaultValue3(defaultValue,type){if(defaultValue!=null){let{value}=defaultValue;if(!isDefaultValueBlacklisted(value))return isReactDocgenTypescript(defaultValue)&&isStringValued(type)?createSummaryValue(JSON.stringify(value)):createSummaryValue(value)}return null}function createBasicPropDef(name,type,docgenInfo){let{description,required,defaultValue}=docgenInfo;return{name,type:createType3(type),required,description,defaultValue:createDefaultValue3(defaultValue,type)}}function applyJsDocResult(propDef,jsDocParsingResult){if(jsDocParsingResult?.includesJsDoc){let{description,extractedTags}=jsDocParsingResult;description!=null&&(propDef.description=jsDocParsingResult.description);let value={...extractedTags,params:extractedTags?.params?.map(x=>({name:x.getPrettyName(),description:x.description}))};Object.values(value).filter(Boolean).length>0&&(propDef.jsDocTags=value)}return propDef}var javaScriptFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createBasicPropDef(propName,docgenInfo.type,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},tsFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createTsPropDef(propName,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},flowFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createFlowPropDef(propName,docgenInfo);return propDef.sbType=convert4(docgenInfo),applyJsDocResult(propDef,jsDocParsingResult)},unknownFactory=(propName,docgenInfo,jsDocParsingResult)=>{let propDef=createBasicPropDef(propName,{name:"unknown"},docgenInfo);return applyJsDocResult(propDef,jsDocParsingResult)},getPropDefFactory=typeSystem=>{switch(typeSystem){case"JavaScript":return javaScriptFactory;case"TypeScript":return tsFactory;case"Flow":return flowFactory;default:return unknownFactory}};var getTypeSystem=docgenInfo=>docgenInfo.type!=null?"JavaScript":docgenInfo.flowType!=null?"Flow":docgenInfo.tsType!=null?"TypeScript":"Unknown",extractComponentSectionArray=docgenSection=>{let typeSystem=getTypeSystem(docgenSection[0]),createPropDef=getPropDefFactory(typeSystem);return docgenSection.map(item=>{let sanitizedItem=item;return item.type?.elements&&(sanitizedItem={...item,type:{...item.type,value:item.type.elements}}),extractProp(sanitizedItem.name,sanitizedItem,typeSystem,createPropDef)})},extractComponentSectionObject=docgenSection=>{let docgenPropsKeys=Object.keys(docgenSection),typeSystem=getTypeSystem(docgenSection[docgenPropsKeys[0]]),createPropDef=getPropDefFactory(typeSystem);return docgenPropsKeys.map(propName=>{let docgenInfo=docgenSection[propName];return docgenInfo!=null?extractProp(propName,docgenInfo,typeSystem,createPropDef):null}).filter(Boolean)},extractComponentProps=(component,section)=>{let docgenSection=getDocgenSection(component,section);return isValidDocgenSection(docgenSection)?Array.isArray(docgenSection)?extractComponentSectionArray(docgenSection):extractComponentSectionObject(docgenSection):[]};function extractProp(propName,docgenInfo,typeSystem,createPropDef){let jsDocParsingResult=parseJsDoc(docgenInfo.description);return jsDocParsingResult.includesJsDoc&&jsDocParsingResult.ignore?null:{propDef:createPropDef(propName,docgenInfo,jsDocParsingResult),jsDocTags:jsDocParsingResult.extractedTags,docgenInfo,typeSystem}}function extractComponentDescription(component){return component!=null?getDocgenDescription(component):""}var import_preview_api=require("@storybook/preview-api"),enhanceArgTypes=context=>{let{component,argTypes:userArgTypes,parameters:{docs={}}}=context,{extractArgTypes}=docs,extractedArgTypes=extractArgTypes&&component?extractArgTypes(component):{};return extractedArgTypes?(0,import_preview_api.combineParameters)(extractedArgTypes,userArgTypes):userArgTypes};var ADDON_ID="storybook/docs",PANEL_ID=`${ADDON_ID}/panel`,PARAM_KEY="docs",SNIPPET_RENDERED=`${ADDON_ID}/snippet-rendered`,SourceType=(SourceType2=>(SourceType2.AUTO="auto",SourceType2.CODE="code",SourceType2.DYNAMIC="dynamic",SourceType2))(SourceType||{});var packageRe=/(addons\/|addon-|addon-essentials\/)(docs|controls)/,hasDocsOrControls=options=>options.presetsList?.some(preset=>packageRe.test(preset.name));0&&(module.exports={ADDON_ID,MAX_DEFAULT_VALUE_SUMMARY_LENGTH,MAX_TYPE_SUMMARY_LENGTH,PANEL_ID,PARAM_KEY,SNIPPET_RENDERED,SourceType,TypeSystem,convert,createSummaryValue,enhanceArgTypes,extractComponentDescription,extractComponentProps,extractComponentSectionArray,extractComponentSectionObject,getDocgenDescription,getDocgenSection,hasDocgen,hasDocsOrControls,isDefaultValueBlacklisted,isTooLongForDefaultValueSummary,isTooLongForTypeSummary,isValidDocgenSection,normalizeNewlines,parseJsDoc,str});

9

package.json
{
"name": "@storybook/docs-tools",
"version": "0.0.0-pr-26853-sha-b51db447",
"version": "0.0.0-pr-26875-sha-1378113c",
"description": "Shared utility functions for frameworks to implement docs",

@@ -47,5 +47,6 @@ "keywords": [

"dependencies": {
"@storybook/core-common": "0.0.0-pr-26853-sha-b51db447",
"@storybook/preview-api": "0.0.0-pr-26853-sha-b51db447",
"@storybook/types": "0.0.0-pr-26853-sha-b51db447",
"@storybook/core-common": "0.0.0-pr-26875-sha-1378113c",
"@storybook/core-events": "0.0.0-pr-26875-sha-1378113c",
"@storybook/preview-api": "0.0.0-pr-26875-sha-1378113c",
"@storybook/types": "0.0.0-pr-26875-sha-1378113c",
"@types/doctrine": "^0.0.3",

@@ -52,0 +53,0 @@ "assert": "^2.1.0",

dist/index.mjs

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc