UNPKG

@techdocs/cli

Version:

Utility CLI for managing TechDocs sites in Backstage.

6 lines (5 loc) • 16.2 kB
"use strict";(()=>{(self.webpackChunktechdocs_cli_embedded_app=self.webpackChunktechdocs_cli_embedded_app||[]).push([[2401],{52235:(I,d,t)=>{var e,o=t(4293),h=t(78920);e={value:!0},d.A=void 0;var f=h(t(14041)),T=o(t(74044)),g=(0,T.default)(f.createElement("path",{d:"M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"}),"ArrowForward");d.A=g},48514:(I,d,t)=>{t.d(d,{M:()=>g});var e=t(31085),o=t(58837),h=t(71677),f=t(72501);const T=(0,o.A)({container:{overflow:"visible !important"},typo:{fontSize:"inherit",overflow:"hidden",textOverflow:"ellipsis",display:"-webkit-box","-webkit-line-clamp":({line:m})=>m||1,"-webkit-box-orient":"vertical"}},{name:"BackstageOverflowTooltip"});function g(m){const P=T(m);return(0,e.jsx)(h.Ay,{title:m.title??(m.text||""),placement:m.placement,children:(0,e.jsx)(f.A,{className:P.typo,variant:"inherit",children:m.text})})}},48045:(I,d,t)=>{t.d(d,{n:()=>M});var e=t(31085),o=t(40703),h=t(59469),f=t(48653),T=t(45685),g=t(37197),m=t(58837),P=t(87051),u=t(53373),D=t.n(u),i=t(10394),y=t(72501),A=t(52235),r=t(72072);const p=(0,m.A)(n=>({root:{maxWidth:"fit-content",padding:n.spacing(2,2,2,2.5)},boxTitle:{margin:0,color:n.palette.textSubtle},arrow:{color:n.palette.textSubtle}}),{name:"BackstageBottomLink"});function v(n){const{link:s,title:l,onClick:S}=n,E=p();return(0,e.jsxs)(i.A,{children:[(0,e.jsx)(g.A,{}),(0,e.jsx)(r.N_,{to:s,onClick:S,underline:"none",children:(0,e.jsxs)(i.A,{display:"flex",alignItems:"center",className:E.root,children:[(0,e.jsx)(i.A,{className:E.boxTitle,fontWeight:"fontWeightBold",m:1,children:(0,e.jsx)(y.A,{children:(0,e.jsx)("strong",{children:l})})}),(0,e.jsx)(A.A,{className:E.arrow})]})})]})}var L=t(14041),c=t(73896),O=t(22020),K=t(10315),N=t(87849);const a=n=>{const{slackChannel:s}=n,{t:l}=(0,N.i)(K.O);if(s){if(typeof s=="string")return(0,e.jsx)(y.A,{children:l("errorBoundary.title",{slackChannel:s})});if(!s.href)return(0,e.jsx)(y.A,{children:l("errorBoundary.title",{slackChannel:s.name})})}else return null;return(0,e.jsx)(c.z,{to:s.href,variant:"contained",children:s.name})},R=class extends L.Component{constructor(s){super(s),this.state={error:void 0,errorInfo:void 0}}componentDidCatch(s,l){console.error(`ErrorBoundary, error: ${s}`,{error:s,errorInfo:l}),this.setState({error:s,errorInfo:l})}render(){const{slackChannel:s,children:l}=this.props,{error:S}=this.state;return S?(0,e.jsx)(O.b,{title:"Something Went Wrong",error:S,children:(0,e.jsx)(a,{slackChannel:s})}):l}},z=(0,m.A)(n=>({noPadding:{padding:0,"&:last-child":{paddingBottom:0}},contentAlignBottom:{display:"flex",alignItems:"self-end"},header:{padding:n.spacing(2,2,2,2.5)},headerTitle:{fontWeight:n.typography.fontWeightBold},headerSubheader:{paddingTop:n.spacing(1)},headerAvatar:{},headerAction:{},headerContent:{},subheader:{display:"flex"}}),{name:"BackstageInfoCard"}),C=(0,P.A)(n=>({root:{display:"inline-block",padding:n.spacing(8,8,0,0),float:"right"}}),{name:"BackstageInfoCardCardActionsTopRight"})(h.A),j={card:{flex:{display:"flex",flexDirection:"column"},fullHeight:{display:"flex",flexDirection:"column",height:"100%"},gridItem:{display:"flex",flexDirection:"column",height:"calc(100% - 10px)",marginBottom:"10px",breakInside:"avoid-page","@media print":{height:"auto"}}},cardContent:{fullHeight:{flex:1},gridItem:{flex:1}}};function M(n){const{title:s,subheader:l,divider:S=!0,deepLink:E,slackChannel:B,errorBoundaryProps:W,variant:H,alignContent:x="normal",children:U,headerStyle:k,headerProps:w,icon:F,action:Q,actionsClassName:G,actions:$,cardClassName:Z,actionsTopRight:J,className:q,noPadding:_,titleTypographyProps:tt,subheaderTypographyProps:et}=n,b=z();let V={},Y={};H&&H.split(/[\s]+/g).forEach(X=>{V={...V,...j.card[X]},Y={...Y,...j.cardContent[X]}});const nt=()=>!l&&!F?null:(0,e.jsxs)("div",{"data-testid":"info-card-subheader",children:[l&&(0,e.jsx)("div",{className:b.subheader,children:l}),F]}),ot=W||(B?{slackChannel:B}:{});return(0,e.jsx)(o.A,{style:V,className:q,children:(0,e.jsxs)(R,{...ot,children:[s&&(0,e.jsx)(T.A,{classes:{root:D()(b.header),title:b.headerTitle,subheader:b.headerSubheader,avatar:b.headerAvatar,action:b.headerAction,content:b.headerContent},title:s,subheader:nt(),action:Q,style:{...k},titleTypographyProps:tt,subheaderTypographyProps:et,...w}),J&&(0,e.jsx)(C,{children:J}),S&&(0,e.jsx)(g.A,{}),(0,e.jsx)(f.A,{className:D()(Z,{[b.noPadding]:_,[b.contentAlignBottom]:x==="bottom"}),style:Y,children:U}),$&&(0,e.jsx)(h.A,{className:G,children:$}),E&&(0,e.jsx)(v,{...E})]})})}},89648:(I,d,t)=>{t.d(d,{s:()=>r});var e=t(31085),o=t(58837),h=t(51372),f=t(48514),T=t(67871),g=t(90184),m=t(8859),P=t(34428);const u=Object.freeze({createEntityRefColumn(p){const{defaultKind:v}=p;function L(c){return c.metadata?.title||(0,g.S)(c,{defaultKind:v})}return{title:"Name",highlight:!0,customFilterAndSearch(c,O){return L(O).includes(c)},customSort(c,O){return L(c).localeCompare(L(O))},render:c=>(0,e.jsx)(m.z,{entityRef:c,defaultKind:v,title:c.metadata?.title})}},createEntityRelationColumn(p){const{title:v,relation:L,defaultKind:c,filter:O}=p;function K(a){return(0,T.t)(a,L,O)}function N(a){return K(a).map(R=>(0,g.S)(R,{defaultKind:c})).join(", ")}return{title:v,customFilterAndSearch(a,R){return N(R).includes(a)},customSort(a,R){return N(a).localeCompare(N(R))},render:a=>(0,e.jsx)(P.i,{entityRefs:K(a),defaultKind:c})}},createOwnerColumn(){return this.createEntityRelationColumn({title:"Owner",relation:h.vv,defaultKind:"group"})},createDomainColumn(){return this.createEntityRelationColumn({title:"Domain",relation:h.jn,defaultKind:"domain",filter:{kind:"domain"}})},createSystemColumn(){return this.createEntityRelationColumn({title:"System",relation:h.jn,defaultKind:"system",filter:{kind:"system"}})},createMetadataDescriptionColumn(){return{title:"Description",field:"metadata.description",render:p=>(0,e.jsx)(f.M,{text:p.metadata.description,placement:"bottom-start",line:2})}},createSpecLifecycleColumn(){return{title:"Lifecycle",field:"spec.lifecycle"}},createSpecTypeColumn(){return{title:"Type",field:"spec.type"}}}),D=[u.createEntityRefColumn({defaultKind:"system"}),u.createDomainColumn(),u.createOwnerColumn(),u.createMetadataDescriptionColumn()],i=[u.createEntityRefColumn({defaultKind:"component"}),u.createSystemColumn(),u.createOwnerColumn(),u.createSpecTypeColumn(),u.createSpecLifecycleColumn(),u.createMetadataDescriptionColumn()];var y=t(14209);const A=(0,o.A)(p=>({empty:{padding:p.spacing(2),display:"flex",justifyContent:"center"}})),r=p=>{const{entities:v,title:L,emptyContent:c,variant:O="gridItem",columns:K,tableOptions:N={}}=p,a=A(),R={minWidth:"0",width:"100%"};return O==="gridItem"&&(R.height="calc(100% - 10px)"),(0,e.jsx)(y.X,{columns:K,title:L,style:R,emptyContent:c&&(0,e.jsx)("div",{className:a.empty,children:c}),options:{search:!1,paging:!1,actionsColumnIndex:-1,padding:"dense",draggable:!1,...N},data:v})};r.columns=u,r.systemEntityColumns=D,r.componentEntityColumns=i},99538:(I,d,t)=>{t.d(d,{T7:()=>m,TY:()=>D,tN:()=>u});var e=t(31085),o=t(6820),h=t(25862),f=t(43836),T=t(10602);const g=(0,f.tK)("entity-context"),m=i=>{const{children:y,entity:A,loading:r,error:p,refresh:v}=i,L={entity:A,loading:r,error:p,refresh:v};return(0,e.jsx)(g.Provider,{value:(0,T.B)({1:L}),children:(0,e.jsx)(h.Ig,{attributes:{...A?{entityRef:(0,o.U2)(A)}:void 0},children:y})})},P=i=>_jsx(m,{entity:i.entity,loading:!i.entity,error:void 0,refresh:void 0,children:i.children});function u(){const i=(0,f.qO)("entity-context");if(!i)throw new Error("Entity context is not available");const y=i.atVersion(1);if(!y)throw new Error("EntityContext v1 not available");if(!y.entity)throw new Error("useEntity hook is being called outside of an EntityLayout where the entity has not been loaded. If this is intentional, please use useAsyncEntity instead.");return{entity:y.entity}}function D(){const i=(0,f.qO)("entity-context");if(!i)throw new Error("Entity context is not available");const y=i.atVersion(1);if(!y)throw new Error("EntityContext v1 not available");const{entity:A,loading:r,error:p,refresh:v}=y;return{entity:A,loading:r,error:p,refresh:v}}},90759:(I,d,t)=>{t.d(d,{W:()=>o});var e=t(93184);const o=(0,e.h)({id:"catalog",messages:{indexPage:{title:"{{orgName}} Catalog",createButtonTitle:"Create",supportButtonContent:"All your software catalog entities"},aboutCard:{title:"About",refreshButtonTitle:"Schedule entity refresh",editButtonTitle:"Edit Metadata",createSimilarButtonTitle:"Create something similar",refreshScheduledMessage:"Refresh scheduled",launchTemplate:"Launch Template",viewTechdocs:"View TechDocs",viewSource:"View Source",descriptionField:{label:"Description",value:"No description"},ownerField:{label:"Owner",value:"No Owner"},domainField:{label:"Domain",value:"No Domain"},systemField:{label:"System",value:"No System"},parentComponentField:{label:"Parent Component",value:"No Parent Component"},typeField:{label:"Type"},lifecycleField:{label:"Lifecycle"},tagsField:{label:"Tags",value:"No Tags"},targetsField:{label:"Targets"}},searchResultItem:{lifecycle:"Lifecycle",Owner:"Owner"},catalogTable:{warningPanelTitle:"Could not fetch catalog entities.",viewActionTitle:"View",editActionTitle:"Edit",starActionTitle:"Add to favorites",unStarActionTitle:"Remove from favorites"},dependencyOfComponentsCard:{title:"Dependency of components",emptyMessage:"No component depends on this component"},dependsOnComponentsCard:{title:"Depends on components",emptyMessage:"No component is a dependency of this component"},dependsOnResourcesCard:{title:"Depends on resources",emptyMessage:"No resource is a dependency of this component"},entityContextMenu:{copiedMessage:"Copied!",moreButtonTitle:"More",inspectMenuTitle:"Inspect entity",copyURLMenuTitle:"Copy entity URL",unregisterMenuTitle:"Unregister entity"},entityLabelsCard:{title:"Labels",emptyDescription:"No labels defined for this entity. You can add labels to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityLabels:{warningPanelTitle:"Entity not found",ownerLabel:"Owner",lifecycleLabel:"Lifecycle"},entityLinksCard:{title:"Links",emptyDescription:"No links defined for this entity. You can add links to your entity YAML as shown in the highlighted example below:",readMoreButtonTitle:"Read more"},entityNotFound:{title:"Entity was not found",description:"Want to help us build this? Check out our Getting Started documentation.",docButtonTitle:"DOCS"},deleteEntity:{dialogTitle:"Are you sure you want to delete this entity?",deleteButtonTitle:"Delete",cancelButtonTitle:"Cancel",description:"This entity is not referenced by any location and is therefore not receiving updates. Click here to delete."},entityProcessingErrorsDescription:"The error below originates from",entityRelationWarningDescription:`This entity has relations to other entities, which can't be found in the catalog. Entities not found are: `,hasComponentsCard:{title:"Has components",emptyMessage:"No component is part of this system"},hasResourcesCard:{title:"Has resources",emptyMessage:"No resource is part of this system"},hasSubcomponentsCard:{title:"Has subcomponents",emptyMessage:"No subcomponent is part of this component"},hasSubdomainsCard:{title:"Has subdomains",emptyMessage:"No subdomain is part of this domain"},hasSystemsCard:{title:"Has systems",emptyMessage:"No system is part of this domain"},relatedEntitiesCard:{emptyHelpLinkTitle:"Learn how to change this"},systemDiagramCard:{title:"System Diagram",description:"Use pinch & zoom to move around the diagram.",edgeLabels:{partOf:"part of",provides:"provides",dependsOn:"depends on"}}}})},59251:(I,d,t)=>{t.d(d,{p:()=>C});var e=t(31085),o=t(72501),h=t(99538),f=t(6820),T=t(72427),g=t(73466),m=t(7341);function P(j,M){const n=M?.type?.toLocaleLowerCase("en-US"),s=M?.kind?.toLocaleLowerCase("en-US"),l=(0,T.gf)(m.v),{loading:S,value:E,error:B}=(0,g.A)(async()=>{const W=j.relations?.filter(x=>(!n||x.type.toLocaleLowerCase("en-US")===n)&&(!s||(0,f.KU)(x.targetRef).kind===s));if(!W?.length)return[];const{items:H}=await l.getEntitiesByRefs({entityRefs:W.map(x=>x.targetRef)});return H.filter(x=>!!x)},[j,n,s]);return{entities:E,loading:S,error:B}}var u=t(89648),D=t(48045),i=t(68146),y=t(58837),A=t(37197),r=t(8109),p=t(5951),v=t(77310),L=t(37916),c=t(22020);const O=(0,y.A)(j=>({text:{fontFamily:"monospace",whiteSpace:"pre",overflowX:"auto",marginRight:j.spacing(2)},divider:{margin:j.spacing(2)}}),{name:"BackstageResponseErrorPanel"});function K(j){const{title:M,error:n,defaultExpanded:s}=j,l=O();if(n.name!=="ResponseError")return(0,e.jsx)(c.b,{title:M??n.message,defaultExpanded:s,error:n});const{body:S,cause:E}=n,{request:B,response:W}=S,H=`${W.statusCode}: ${E.name}`,x=B&&`${B.method} ${B.url}`,U=E.message.replace(/\\n/g,` `),k=E.stack?.replace(/\\n/g,` `),w=JSON.stringify(S,void 0,2);return(0,e.jsxs)(c.b,{title:M??n.message,defaultExpanded:s,error:{name:H,message:U,stack:k},children:[x&&(0,e.jsxs)(r.A,{alignItems:"flex-start",children:[(0,e.jsx)(p.A,{classes:{secondary:l.text},primary:"Request",secondary:B?`${x}`:void 0}),(0,e.jsx)(L.l,{text:x})]}),(0,e.jsxs)(e.Fragment,{children:[(0,e.jsx)(A.A,{component:"li",className:l.divider}),(0,e.jsx)(r.A,{alignItems:"flex-start",children:(0,e.jsx)(p.A,{classes:{secondary:l.text},primary:"Full Error as JSON"})}),(0,e.jsx)(v.z,{language:"json",text:w,showCopyCodeButton:!0})]})]})}var N=t(72072),a=t(48105),R=t(90759),z=t(87849);const C=j=>{const{variant:M="gridItem",title:n,columns:s,entityKind:l,relationType:S,emptyMessage:E,emptyHelpLink:B,asRenderableEntities:W,tableOptions:H={}}=j,{t:x}=(0,z.i)(R.W),{entity:U}=(0,h.tN)(),{entities:k,loading:w,error:F}=P(U,{type:S,kind:l});return w?(0,e.jsx)(D.n,{variant:M,title:n,children:(0,e.jsx)(i.k,{})}):F?(0,e.jsx)(D.n,{variant:M,title:n,children:(0,e.jsx)(K,{error:F})}):(0,e.jsx)(u.s,{title:n,variant:M,emptyContent:(0,e.jsxs)("div",{style:{textAlign:"center"},children:[(0,e.jsx)(o.A,{variant:"body1",children:E}),(0,e.jsx)(o.A,{variant:"body2",children:(0,e.jsx)(N.N_,{to:B,externalLinkIcon:!0,children:x("relatedEntitiesCard.emptyHelpLinkTitle")})})]}),columns:s,entities:W(k||[]),tableOptions:H})};C.componentEntityColumns=a.mz,C.componentEntityHelpLink=a.e2,C.asComponentEntities=a.xJ,C.resourceEntityColumns=a.v9,C.resourceEntityHelpLink=a.nz,C.asResourceEntities=a.eB,C.systemEntityColumns=a.MW,C.systemEntityHelpLink=a.iU,C.asSystemEntities=a.vy,C.domainEntityColums=a.xO,C.domainEntityHelpLink=a.Xr,C.asDomainEntities=a.QS},52401:(I,d,t)=>{t.r(d),t.d(d,{RelatedEntitiesCard:()=>e.p,asComponentEntities:()=>o.xJ,asDomainEntities:()=>o.QS,asResourceEntities:()=>o.eB,asSystemEntities:()=>o.vy,componentEntityColumns:()=>o.mz,componentEntityHelpLink:()=>o.e2,domainEntityColumns:()=>o.xO,domainEntityHelpLink:()=>o.Xr,resourceEntityColumns:()=>o.v9,resourceEntityHelpLink:()=>o.nz,systemEntityColumns:()=>o.MW,systemEntityHelpLink:()=>o.iU});var e=t(59251),o=t(48105)},48105:(I,d,t)=>{t.d(d,{MW:()=>P,QS:()=>A,Xr:()=>y,e2:()=>h,eB:()=>m,iU:()=>u,mz:()=>o,nz:()=>g,v9:()=>T,vy:()=>D,xJ:()=>f,xO:()=>i});var e=t(89648);const o=[e.s.columns.createEntityRefColumn({defaultKind:"component"}),e.s.columns.createOwnerColumn(),e.s.columns.createSpecTypeColumn(),e.s.columns.createSpecLifecycleColumn(),e.s.columns.createMetadataDescriptionColumn()],h="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component",f=r=>r,T=[e.s.columns.createEntityRefColumn({defaultKind:"resource"}),e.s.columns.createOwnerColumn(),e.s.columns.createSpecTypeColumn(),e.s.columns.createSpecLifecycleColumn(),e.s.columns.createMetadataDescriptionColumn()],g="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-resource",m=r=>r,P=[e.s.columns.createEntityRefColumn({defaultKind:"system"}),e.s.columns.createOwnerColumn(),e.s.columns.createMetadataDescriptionColumn()],u="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-system",D=r=>r,i=[e.s.columns.createEntityRefColumn({defaultKind:"domain"}),e.s.columns.createOwnerColumn(),e.s.columns.createMetadataDescriptionColumn()],y="https://backstage.io/docs/features/software-catalog/descriptor-format#kind-domain",A=r=>r}}]);})(); //# sourceMappingURL=2401.8910ad14.chunk.js.map