@storybook/telemetry 7.0.0-alpha.46 → 7.0.0-alpha.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +6 -8
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
|
@@ -910,7 +910,6 @@ interface CoreCommon_StoryIndex {
|
|
|
910
910
|
interface CoreCommon_StoryIndexer {
|
|
911
911
|
test: RegExp;
|
|
912
912
|
indexer: (fileName: string, options: CoreCommon_IndexerOptions) => Promise<CoreCommon_StoryIndex>;
|
|
913
|
-
addDocsTemplate?: boolean;
|
|
914
913
|
}
|
|
915
914
|
/**
|
|
916
915
|
* Options for TypeScript usage within Storybook.
|
|
@@ -971,9 +970,10 @@ declare type DocsOptions = {
|
|
|
971
970
|
*/
|
|
972
971
|
defaultName?: string;
|
|
973
972
|
/**
|
|
974
|
-
* Should we generate a docs entry per CSF file?
|
|
973
|
+
* Should we generate a docs entry per CSF file with the `docsPage` tag?
|
|
974
|
+
* Set to 'automatic' to generate an entry irrespective of tag.
|
|
975
975
|
*/
|
|
976
|
-
docsPage?: boolean;
|
|
976
|
+
docsPage?: boolean | 'automatic';
|
|
977
977
|
/**
|
|
978
978
|
* Only show doc entries in the side bar (usually set with the `--docs` CLI flag)
|
|
979
979
|
*/
|
|
@@ -1111,14 +1111,12 @@ declare type StorybookMetadata = {
|
|
|
1111
1111
|
storybookVersion: string;
|
|
1112
1112
|
generatedAt?: number;
|
|
1113
1113
|
language: 'typescript' | 'javascript';
|
|
1114
|
-
framework
|
|
1114
|
+
framework?: {
|
|
1115
1115
|
name: string;
|
|
1116
1116
|
options?: any;
|
|
1117
1117
|
};
|
|
1118
|
-
builder?:
|
|
1119
|
-
|
|
1120
|
-
options?: Record<string, any>;
|
|
1121
|
-
};
|
|
1118
|
+
builder?: string;
|
|
1119
|
+
renderer?: string;
|
|
1122
1120
|
monorepo?: MonorepoType;
|
|
1123
1121
|
packageManager?: {
|
|
1124
1122
|
type: PM;
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var
|
|
2
|
-
[telemetry]`),
|
|
1
|
+
"use strict";var ye=Object.create;var u=Object.defineProperty;var pe=Object.getOwnPropertyDescriptor;var me=Object.getOwnPropertyNames;var fe=Object.getPrototypeOf,le=Object.prototype.hasOwnProperty;var de=(e,t)=>{for(var o in t)u(e,o,{get:t[o],enumerable:!0})},F=(e,t,o,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of me(t))!le.call(e,n)&&n!==o&&u(e,n,{get:()=>t[n],enumerable:!(r=pe(t,n))||r.enumerable});return e};var p=(e,t,o)=>(o=e!=null?ye(fe(e)):{},F(t||!e||!e.__esModule?u(o,"default",{value:e,enumerable:!0}):o,e)),ge=e=>F(u({},"__esModule",{value:!0}),e);var xe={};de(xe,{computeStorybookMetadata:()=>q,getStorybookMetadata:()=>M,metaFrameworks:()=>O,sanitizeAddonName:()=>R,telemetry:()=>Pe});module.exports=ge(xe);var C=require("@storybook/client-logger");var J=p(require("read-pkg-up")),P=require("detect-package-manager"),m=require("@storybook/core-common");var L=p(require("path")),j=async e=>{let t=Object.keys(e);return Promise.all(t.map(v))},v=async e=>{try{let t=await D(e);return{name:e,version:t.version}}catch{return{name:e,version:null}}},D=async e=>require(L.default.join(e,"package.json"));var k=p(require("fs-extra")),b=p(require("path")),Y=require("@storybook/core-common"),W={Nx:"nx.json",Turborepo:"turbo.json",Lerna:"lerna.json",Rush:"rush.json",Lage:"lage.config.json"},_=()=>{let e=(0,Y.getProjectRoot)();if(!e)return;let o=Object.keys(W).find(n=>{let s=b.default.join(e,W[n]);return k.default.existsSync(s)});if(o)return o;if(!k.default.existsSync(b.default.join(e,"package.json")))return;let r=k.default.readJsonSync(b.default.join(e,"package.json"));if(r!=null&&r.workspaces)return"Workspaces"};var T=require("path");function z(e){return e.replace(/[-[/{}()*+?.\\^$|]/g,"\\$&")}function E(e,t=T.sep){if(!e)return e;let o=process.cwd().split(t);for(;o.length>1;){let r=o.join(t),n=new RegExp(z(r),"g");e=e.replace(n,"$SNIP");let s=o.join(t+t),f=new RegExp(z(s),"g");e=e.replace(f,"$SNIP"),o.pop()}return e}function h(e,t=T.sep){e=JSON.parse(JSON.stringify(e,Object.getOwnPropertyNames(e)));let o=E(JSON.stringify(e),t);return JSON.parse(o)}var ue=["html","react","svelte","vue3","preact","server","vue","web-components","angular","ember"],ke=["builder-webpack5","builder-vite"];function U(e,t){let{name:o="",version:r,dependencies:n,devDependencies:s,peerDependencies:f}=e,c={[o]:r,...n,...s,...f};return t.map(y=>`@storybook/${y}`).find(y=>c[y])}async function H(e){let{framework:t}=e;if(!t)return{};let o=typeof t=="string"?{name:t}:t,r=await D(o.name),n=U(r,ke),s=U(r,ue);return{framework:o,builder:n,renderer:s}}var O={next:"Next","react-scripts":"CRA",gatsby:"Gatsby","@nuxtjs/storybook":"nuxt","@nrwl/storybook":"nx","@vue/cli-service":"vue-cli","@sveltejs/kit":"svelte-kit"},R=e=>E(e).replace(/\/dist\/.*/,"").replace(/\.[mc]?[tj]?s[x]?$/,"").replace(/\/register$/,"").replace(/\/manager$/,"").replace(/\/preset$/,""),q=async({packageJson:e,mainConfig:t})=>{var B;let o={generatedAt:new Date().getTime(),hasCustomBabel:!1,hasCustomWebpack:!1,hasStaticDirs:!1,hasStorybookEslint:!1,refCount:0},r={...e==null?void 0:e.dependencies,...e==null?void 0:e.devDependencies,...e==null?void 0:e.peerDependencies},n=Object.keys(r).find(a=>!!O[a]);if(n){let{version:a}=await v(n);o.metaFramework={name:O[n],packageName:n,version:a}}let s=_();s&&(o.monorepo=s);try{let a=await(0,P.detect)({cwd:(0,m.getProjectRoot)()}),i=await(0,P.getNpmVersion)(a);o.packageManager={type:a,version:i}}catch{}o.hasCustomBabel=!!t.babel,o.hasCustomWebpack=!!t.webpackFinal,o.hasStaticDirs=!!t.staticDirs,t.typescript&&(o.typescriptOptions=t.typescript);let f=await H(t);t.refs&&(o.refCount=Object.keys(t.refs).length),t.features&&(o.features=t.features);let c={};t.addons&&t.addons.forEach(a=>{let i,V;typeof a=="string"?i=R(a):(V=a.options,i=R(a.name)),c[i]={options:V,version:void 0}}),(await j(c)).forEach(({name:a,version:i})=>{c[a].version=i});let l=Object.keys(c),g=Object.keys(r).filter(a=>a.includes("storybook")&&!l.includes(a)).reduce((a,i)=>({...a,[i]:{version:void 0}}),{});(await j(g)).forEach(({name:a,version:i})=>{g[a].version=i});let se=r.typescript?"typescript":"javascript",ie=!!r["eslint-plugin-storybook"],$=(0,m.getStorybookInfo)(e),ce=((B=g[$.frameworkPackage])==null?void 0:B.version)||$.version;return{...o,...f,storybookVersion:ce,language:se,storybookPackages:g,addons:c,hasStorybookEslint:ie}},w,M=async e=>{var n;if(w)return w;let{packageJson:t={}}=J.default.sync({cwd:process.cwd(),normalize:!1})||{},o=(e||(0,m.getStorybookConfiguration)(((n=t==null?void 0:t.scripts)==null?void 0:n.storybook)||"","-c","--config-dir"))??".storybook",r=(0,m.loadMainConfig)({configDir:o});return w=await q({mainConfig:r,packageJson:t}),w};var te=p(require("isomorphic-unfetch")),oe=p(require("fetch-retry")),N=require("nanoid");var Q=p(require("path")),X=require("child_process"),Z=require("@storybook/core-common");var G=require("crypto"),K=e=>{let t=(0,G.createHash)("sha256");return t.update("storybook-telemetry-salt"),t.update(e),t.digest("hex")};var x,ee=()=>{if(x)return x;let e;try{let t=(0,Z.getProjectRoot)(),o=Q.default.relative(t,process.cwd()),r=(0,X.execSync)("git config --local --get remote.origin.url",{timeout:1e3,stdio:"pipe"});e=`${String(r).trim()}${o}`,x=K(e)}catch{}return x};var be="https://storybook.js.org/event-log",he=(0,oe.default)(te.default),S=[],we=(0,N.nanoid)();async function re(e,t={retryDelay:1e3,immediate:!1}){let{payload:o,metadata:r,...n}=e,s=t.stripMetadata?{}:{anonymousId:ee(),inCI:Boolean(process.env.CI)},f=(0,N.nanoid)(),c={...n,eventId:f,sessionId:we,metadata:r,payload:o,context:s},y;try{y=he(be,{method:"POST",body:JSON.stringify(c),headers:{"Content-Type":"application/json"},retries:3,retryOn:[503,504],retryDelay:l=>2**l*(typeof(t==null?void 0:t.retryDelay)=="number"&&!Number.isNaN(t==null?void 0:t.retryDelay)?t.retryDelay:1e3)}),S.push(y),t.immediate?await Promise.all(S):await y}catch{}finally{S=S.filter(l=>l!==y)}}var I=p(require("chalk")),A=require("@storybook/core-common"),ne="telemetry-notification-date",d=console,ae=async()=>{await A.cache.get(ne,null)||(A.cache.set(ne,Date.now()),d.log(),d.log(`${I.default.magenta.bold("attention")} => Storybook now collects completely anonymous telemetry regarding usage.`),d.log("This information is used to shape Storybook's roadmap and prioritize features."),d.log("You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:"),d.log(I.default.cyan("https://storybook.js.org/telemetry")),d.log())};var Pe=async(e,t={},o={})=>{var n;e!=="boot"&&await ae();let r={eventType:e,payload:t};try{o!=null&&o.stripMetadata||(r.metadata=await M(o==null?void 0:o.configDir))}catch(s){r.payload.metadataErrorMessage=h(s).message,o!=null&&o.enableCrashReports&&(r.payload.metadataError=h(s))}finally{let{error:s}=r.payload;s&&(r.payload.error=h(s)),(!r.payload.error||(o==null?void 0:o.enableCrashReports))&&((n=process.env)!=null&&n.STORYBOOK_TELEMETRY_DEBUG&&(C.logger.info(`
|
|
2
|
+
[telemetry]`),C.logger.info(JSON.stringify(r,null,2))),await re(r,o))}};0&&(module.exports={computeStorybookMetadata,getStorybookMetadata,metaFrameworks,sanitizeAddonName,telemetry});
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var
|
|
2
|
-
[telemetry]`),
|
|
1
|
+
var T=(e=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(e,{get:(t,o)=>(typeof require!="undefined"?require:t)[o]}):e)(function(e){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+e+'" is not supported')});var i={};import{logger as z}from"@storybook/client-logger";import ee from"read-pkg-up";import{detect as te,getNpmVersion as oe}from"detect-package-manager";import{loadMainConfig as re,getStorybookInfo as ne,getStorybookConfiguration as ae,getProjectRoot as se}from"@storybook/core-common";import K from"path";var h=async e=>{let t=Object.keys(e);return Promise.all(t.map(w))},w=async e=>{try{let t=await P(e);return{name:e,version:t.version}}catch{return{name:e,version:null}}},P=async e=>T(K.join(e,"package.json"));import x from"fs-extra";import S from"path";import{getProjectRoot as Q}from"@storybook/core-common";var E={Nx:"nx.json",Turborepo:"turbo.json",Lerna:"lerna.json",Rush:"rush.json",Lage:"lage.config.json"},O=()=>{let e=Q();if(!e)return;let o=Object.keys(E).find(a=>{let s=S.join(e,E[a]);return x.existsSync(s)});if(o)return o;if(!x.existsSync(S.join(e,"package.json")))return;if(x.readJsonSync(S.join(e,"package.json"))?.workspaces)return"Workspaces"};import{sep as M}from"path";function R(e){return e.replace(/[-[/{}()*+?.\\^$|]/g,"\\$&")}function j(e,t=M){if(!e)return e;let o=process.cwd().split(t);for(;o.length>1;){let r=o.join(t),a=new RegExp(R(r),"g");e=e.replace(a,"$SNIP");let s=o.join(t+t),m=new RegExp(R(s),"g");e=e.replace(m,"$SNIP"),o.pop()}return e}function d(e,t=M){e=JSON.parse(JSON.stringify(e,Object.getOwnPropertyNames(e)));let o=j(JSON.stringify(e),t);return JSON.parse(o)}var X=["html","react","svelte","vue3","preact","server","vue","web-components","angular","ember"],Z=["builder-webpack5","builder-vite"];function N(e,t){let{name:o="",version:r,dependencies:a,devDependencies:s,peerDependencies:m}=e,p={[o]:r,...a,...s,...m};return t.map(y=>`@storybook/${y}`).find(y=>p[y])}async function J(e){let{framework:t}=e;if(!t)return{};let o=typeof t=="string"?{name:t}:t,r=await P(o.name),a=N(r,Z),s=N(r,X);return{framework:o,builder:a,renderer:s}}var I={next:"Next","react-scripts":"CRA",gatsby:"Gatsby","@nuxtjs/storybook":"nuxt","@nrwl/storybook":"nx","@vue/cli-service":"vue-cli","@sveltejs/kit":"svelte-kit"},A=e=>j(e).replace(/\/dist\/.*/,"").replace(/\.[mc]?[tj]?s[x]?$/,"").replace(/\/register$/,"").replace(/\/manager$/,"").replace(/\/preset$/,""),ie=async({packageJson:e,mainConfig:t})=>{let o={generatedAt:new Date().getTime(),hasCustomBabel:!1,hasCustomWebpack:!1,hasStaticDirs:!1,hasStorybookEslint:!1,refCount:0},r={...e?.dependencies,...e?.devDependencies,...e?.peerDependencies},a=Object.keys(r).find(n=>!!I[n]);if(a){let{version:n}=await w(a);o.metaFramework={name:I[a],packageName:a,version:n}}let s=O();s&&(o.monorepo=s);try{let n=await te({cwd:se()}),c=await oe(n);o.packageManager={type:n,version:c}}catch{}o.hasCustomBabel=!!t.babel,o.hasCustomWebpack=!!t.webpackFinal,o.hasStaticDirs=!!t.staticDirs,t.typescript&&(o.typescriptOptions=t.typescript);let m=await J(t);t.refs&&(o.refCount=Object.keys(t.refs).length),t.features&&(o.features=t.features);let p={};t.addons&&t.addons.forEach(n=>{let c,D;typeof n=="string"?c=A(n):(D=n.options,c=A(n.name)),p[c]={options:D,version:void 0}}),(await h(p)).forEach(({name:n,version:c})=>{p[n].version=c});let f=Object.keys(p),g=Object.keys(r).filter(n=>n.includes("storybook")&&!f.includes(n)).reduce((n,c)=>({...n,[c]:{version:void 0}}),{});(await h(g)).forEach(({name:n,version:c})=>{g[n].version=c});let U=r.typescript?"typescript":"javascript",H=!!r["eslint-plugin-storybook"],v=ne(e),q=g[v.frameworkPackage]?.version||v.version;return{...o,...m,storybookVersion:q,language:U,storybookPackages:g,addons:p,hasStorybookEslint:H}},u,C=async e=>{if(u)return u;let{packageJson:t={}}=ee.sync({cwd:process.cwd(),normalize:!1})||{},o=(e||ae(t?.scripts?.storybook||"","-c","--config-dir"))??".storybook",r=re({configDir:o});return u=await ie({mainConfig:r,packageJson:t}),u};import fe from"isomorphic-unfetch";import le from"fetch-retry";import{nanoid as V}from"nanoid";import pe from"path";import{execSync as ye}from"child_process";import{getProjectRoot as me}from"@storybook/core-common";import{createHash as ce}from"crypto";var $=e=>{let t=ce("sha256");return t.update("storybook-telemetry-salt"),t.update(e),t.digest("hex")};var k,B=()=>{if(k)return k;let e;try{let t=me(),o=pe.relative(t,process.cwd()),r=ye("git config --local --get remote.origin.url",{timeout:1e3,stdio:"pipe"});e=`${String(r).trim()}${o}`,k=$(e)}catch{}return k};var ge="https://storybook.js.org/event-log",de=le(fe),b=[],ue=V();async function F(e,t={retryDelay:1e3,immediate:!1}){let{payload:o,metadata:r,...a}=e,s=t.stripMetadata?{}:{anonymousId:B(),inCI:Boolean(i.CI)},m=V(),p={...a,eventId:m,sessionId:ue,metadata:r,payload:o,context:s},y;try{y=de(ge,{method:"POST",body:JSON.stringify(p),headers:{"Content-Type":"application/json"},retries:3,retryOn:[503,504],retryDelay:f=>2**f*(typeof t?.retryDelay=="number"&&!Number.isNaN(t?.retryDelay)?t.retryDelay:1e3)}),b.push(y),t.immediate?await Promise.all(b):await y}catch{}finally{b=b.filter(f=>f!==y)}}import L from"chalk";import{cache as W}from"@storybook/core-common";var Y="telemetry-notification-date",l=console,_=async()=>{await W.get(Y,null)||(W.set(Y,Date.now()),l.log(),l.log(`${L.magenta.bold("attention")} => Storybook now collects completely anonymous telemetry regarding usage.`),l.log("This information is used to shape Storybook's roadmap and prioritize features."),l.log("You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:"),l.log(L.cyan("https://storybook.js.org/telemetry")),l.log())};var nt=async(e,t={},o={})=>{e!=="boot"&&await _();let r={eventType:e,payload:t};try{o?.stripMetadata||(r.metadata=await C(o?.configDir))}catch(a){r.payload.metadataErrorMessage=d(a).message,o?.enableCrashReports&&(r.payload.metadataError=d(a))}finally{let{error:a}=r.payload;a&&(r.payload.error=d(a)),(!r.payload.error||o?.enableCrashReports)&&(i?.STORYBOOK_TELEMETRY_DEBUG&&(z.info(`
|
|
2
|
+
[telemetry]`),z.info(JSON.stringify(r,null,2))),await F(r,o))}};export{ie as computeStorybookMetadata,C as getStorybookMetadata,I as metaFrameworks,A as sanitizeAddonName,nt as telemetry};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/telemetry",
|
|
3
|
-
"version": "7.0.0-alpha.
|
|
3
|
+
"version": "7.0.0-alpha.48",
|
|
4
4
|
"description": "Telemetry logging for crash reports and usage statistics",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"storybook"
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"prep": "../../../scripts/prepare/bundle.ts"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@storybook/client-logger": "7.0.0-alpha.
|
|
46
|
-
"@storybook/core-common": "7.0.0-alpha.
|
|
45
|
+
"@storybook/client-logger": "7.0.0-alpha.48",
|
|
46
|
+
"@storybook/core-common": "7.0.0-alpha.48",
|
|
47
47
|
"chalk": "^4.1.0",
|
|
48
48
|
"detect-package-manager": "^2.0.1",
|
|
49
49
|
"fetch-retry": "^5.0.2",
|
|
@@ -64,5 +64,5 @@
|
|
|
64
64
|
],
|
|
65
65
|
"platform": "node"
|
|
66
66
|
},
|
|
67
|
-
"gitHead": "
|
|
67
|
+
"gitHead": "b58a29b785462f8a8b711b6bb2d7223fd6dc17fd"
|
|
68
68
|
}
|