npm - @microsoft/api-documenter - Versions diffs - 7.28.8 → 7.29.0 - Mend

@microsoft/api-documenter 7.28.8 → 7.29.0

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.

Files changed (209) hide show

package/lib-esm/documenters/YamlDocumenter.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"YamlDocumenter.js","sourceRoot":"","sources":["../../src/documenters/YamlDocumenter.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAIlC,OAAO,EACL,QAAQ,EACR,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,aAAa,EAIb,YAAY,EACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAGL,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,UAAU,EAEV,qBAAqB,EAGrB,QAAQ,EACR,YAAY,EAKZ,kBAAkB,EAClB,yBAAyB,EAGzB,gBAAgB,EAIjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAEL,UAAU,EACV,OAAO,EACR,MAAM,yDAAyD,CAAC;AAYjE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,gBAAgB,MAAM,gCAAgC,CAAC;AAE9D,MAAM,aAAa,GAAe,UAAU,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;AAQhF,IAAK,WASJ;AATD,WAAK,WAAW;IACd,wEAAwE;IACxE,2FAA2B,CAAA;IAC3B,kDAAkD;IAClD,6EAAoB,CAAA;IACpB,4DAA4D;IAC5D,uEAAiB,CAAA;IACjB,yDAAyD;IACzD,iEAAc,CAAA;AAChB,CAAC,EATI,WAAW,KAAX,WAAW,QASf;AASD;;GAEG;AACH,MAAM,OAAO,cAAc;IASzB,YACE,QAAkB,EAClB,qBAA8B,KAAK,EACnC,aAAyB,KAAK;QAE9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,6BAA6B,GAAG,IAAI,GAAG,EAAmB,CAAC;QAEhE,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,eAAe;IACR,aAAa,CAAC,YAAoB;QACvC,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAEzC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YACjD,OAAO,CAAC,GAAG,CAAC,WAAW,UAAU,CAAC,IAAI,UAAU,CAAC,CAAC;YAClD,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YAC/B,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,eAAe;IACL,YAAY;QACpB,OAAO;YACL,IAAI,EAAE,gCAAgC;YACtC,IAAI,EAAE,0BAA0B;YAChC,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IAED,eAAe;IACL,mBAAmB,CAAC,QAAmB;QAC/C,UAAU;QACV,8BAA8B;IAChC,CAAC;IAEO,cAAc,CACpB,YAAoB,EACpB,OAA0B,EAC1B,cAAwC;QAExC,IAAI,mBAAgD,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,mBAAmB,GAAG,IAAI,CAAC,eAAe,CAAC;YAC3C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACnC,CAAC;QAED,MAAM,QAAQ,GAA0B,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpB,MAAM,IAAI,aAAa,CAAC,sBAAsB,CAAC,CAAC;YAClD,CAAC;YACD,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAiB;gBAChC,KAAK,EAAE,EAAE;aACV,CAAC;YACF,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC,MAAM,QAAQ,GAAc,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAC9D,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;oBACvC,IAAI,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;wBAC1D,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;4BACvB,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;wBACzB,CAAC;wBACD,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC9C,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;YAC3D,CAAC;YAED,IAAI,CAAC,eAAe,GAAG,mBAAmB,CAAC;YAE3C,MAAM,YAAY,GAAW,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAE1E,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACzC,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,YAAY,CAAC,CAAC;YACzC,CAAC;YAED,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,oBAAoB,EAAE,aAAa,CAAC,CAAC;YAEpF,IAAI,cAAc,EAAE,CAAC;gBACnB,kGAAkG;gBAClG,+EAA+E;gBAC/E,IAAI,CAAC,oBAAoB,CACvB,IAAI,CAAC,qBAAqB,EAAE,EAC5B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EACrB,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;oBAC7B,gBAAgB,EAAE,CAAC,IAAI,CAAC,kBAAkB;oBAC1C,gBAAgB,EAAE,IAAI;iBACvB,CAAC,EACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CACnF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,mBAAmB,CAAC,OAAgB;QAC5C,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;YACzC,gFAAgF;YAChF,IAAI,CAAC,kBAAkB,CACrB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAC1B,QAAQ,EACR,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAC/F,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,kBAAkB,CACrB,OAAO,CAAC,OAAO,EACf,QAAQ,EACR,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CACrF,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,2EAA2E;IAC3E,gEAAgE;IAChE,qBAAqB;IACrB,QAAQ;IACR,UAAU;IACV,YAAY;IACJ,kBAAkB,CACxB,KAA6B,EAC7B,WAAsB,EACtB,IAAiB;QAEjB,IAAI,uBAAuB,GAAY,KAAK,CAAC;QAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;gBACxC,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,WAAW,CAAC,cAAc;wBAC7B,4GAA4G;wBAC5G,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;wBAC/E,MAAM;oBACR,KAAK,WAAW,CAAC,oBAAoB,CAAC;oBACtC,KAAK,WAAW,CAAC,2BAA2B;wBAC1C,2GAA2G;wBAC3G,wCAAwC;wBAExC,wFAAwF;wBACxF,MAAM,KAAK,GAAW,WAAW,CAAC,MAAM,CAAC;wBACzC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAEvB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,oBAAoB,CAAC,EAAE,CAAC;4BAC1F,2DAA2D;4BAC3D,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;wBAC/B,CAAC;wBACD,MAAM;gBACV,CAAC;YACH,CAAC;iBAAM,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,WAAW,CAAC,cAAc,CAAC;oBAChC,KAAK,WAAW,CAAC,2BAA2B,CAAC;oBAC7C,KAAK,WAAW,CAAC,iBAAiB;wBAChC,4DAA4D;wBAC5D,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACvB,MAAM;gBACV,CAAC;gBACD,uBAAuB,GAAG,IAAI,CAAC;YACjC,CAAC;QACH,CAAC;QACD,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,YAAoB,EAAE,QAAgC;QAC1E,MAAM,OAAO,GAAiB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAE9D,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,eAAe;IACL,gBAAgB,CAAC,QAAgC;QACzD,MAAM,OAAO,GAAiB;YAC5B,KAAK,EAAE,EAAE;SACV,CAAC;QAEF,MAAM,QAAQ,GAAiB,IAAI,CAAC,YAAY,EAAE,CAAC;QACnD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE7B,QAAQ,CAAC,KAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,cAAc,CAAC,QAAgC;QACrD,MAAM,QAAQ,GAAmB,EAAE,CAAC;QACpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAqB,CAAC;YAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACvE,OAAO,GAAG;oBACR,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;iBACpC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,kEAAkE;oBAClE,SAAS;gBACX,CAAC;gBAED,OAAO,GAAG;oBACR,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;oBACnC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;iBAC3B,CAAC;YACJ,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEvB,MAAM,QAAQ,GAAc,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM,UAAU,GAAmB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,KAAK,GAAG,UAAU,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe;IACL,eAAe,CAAC,OAAgB;QACxC,IAAI,IAAY,CAAC;QACjB,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;YACzC,IAAI,GAAG,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,IAAI,KAAK,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3E,IAAI,IAAI,KAAK,OAAO,CAAC,IAAI,GAAG,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,YAAY,CAAC,WAAwB;QAC7C,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,WAAW,CAAC,KAAK,CAAC;YACvB,KAAK,WAAW,CAAC,OAAO,CAAC;YACzB,KAAK,WAAW,CAAC,SAAS,CAAC;YAC3B,KAAK,WAAW,CAAC,IAAI,CAAC;YACtB,KAAK,WAAW,CAAC,SAAS;gBACxB,OAAO,KAAK,CAAC;YACf,KAAK,WAAW,CAAC,SAAS;gBACxB,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACpC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,cAAc,CAAC,WAAwB;QAC/C,oDAAoD;QACpD,QAAQ,WAAW,EAAE,CAAC;YACpB,KAAK,WAAW,CAAC,aAAa,CAAC;YAC/B,KAAK,WAAW,CAAC,kBAAkB,CAAC;YACpC,KAAK,WAAW,CAAC,cAAc;gBAC7B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,iBAAiB,CAAC,OAA0B;QAClD,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,GAAG,GAAyB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAuB;YACnC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;SACpB,CAAC;QAEF,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,YAAY,GAAe,OAAO,CAAC,YAAY,CAAC;YACtD,IAAI,YAAY,CAAC,cAAc,EAAE,CAAC;gBAChC,MAAM,OAAO,GAAW,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;gBACnF,IAAI,OAAO,EAAE,CAAC;oBACZ,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;gBAC7B,CAAC;YACH,CAAC;YAED,IAAI,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC9B,MAAM,OAAO,GAAW,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACzF,IAAI,OAAO,EAAE,CAAC;oBACZ,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;gBAC7B,CAAC;YACH,CAAC;YAED,IAAI,YAAY,EAAE,CAAC;gBACjB,4BAA4B;gBAC5B,MAAM,aAAa,GAAe,YAAY,CAAC,YAAY,CAAC,MAAM,CAChE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,oBAAoB,KAAK,YAAY,CAAC,OAAO,CAAC,oBAAoB,CACrF,CAAC;gBAEF,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;oBACzC,MAAM,OAAO,GAAW,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAC5E,IAAI,OAAO,EAAE,CAAC;wBACZ,QAAQ,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;oBAC5D,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,YAAY,CAAC,eAAe,EAAE,CAAC;gBACjC,MAAM,iBAAiB,GAAW,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACtG,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;gBACvD,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,kBAAkB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9C,IAAI,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,KAAK,IAAI,OAAO,CAAC,UAAU,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;gBACtF,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;YAC7C,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,CAAC,IAAI,CAAC,kBAAkB;SAC3C,CAAC,CAAC;QACH,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;QACvG,QAAQ,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC;QAEhC,2DAA2D;QAC3D,6FAA6F;QAC7F,IACE,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS;YACtC,OAAO,CAAC,MAAM;YACd,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS;YAC7C,IAAI,CAAC,kBAAkB,EACvB,CAAC;YACD,QAAQ,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QACpE,CAAC;QAED,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,WAAW,CAAC,IAAI;gBACnB,QAAQ,CAAC,IAAI,GAAG,MAAM,CAAC;gBACvB,MAAM;YACR,KAAK,WAAW,CAAC,UAAU;gBACzB,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC;gBACxB,MAAM,UAAU,GAAkB,OAAwB,CAAC;gBAE3D,IAAI,UAAU,CAAC,kBAAkB,IAAI,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACnF,QAAQ,CAAC,YAAY,GAAG,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC;gBAC7D,CAAC;gBAED,MAAM;YACR,KAAK,WAAW,CAAC,KAAK;gBACpB,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC;gBACxB,IAAI,CAAC,6BAA6B,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAmB,CAAC,CAAC;gBACvE,MAAM;YACR,KAAK,WAAW,CAAC,SAAS;gBACxB,QAAQ,CAAC,IAAI,GAAG,WAAW,CAAC;gBAC5B,IAAI,CAAC,6BAA6B,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAuB,CAAC,CAAC;gBAC3E,MAAM;YACR,KAAK,WAAW,CAAC,MAAM,CAAC;YACxB,KAAK,WAAW,CAAC,eAAe;gBAC9B,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC;gBACzB,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAyC,CAAC,CAAC;gBACzF,MAAM;YAER,KAAK,WAAW,CAAC,WAAW;gBAC1B,QAAQ,CAAC,IAAI,GAAG,aAAa,CAAC;gBAC9B,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAyB,CAAC,CAAC;gBACzE,MAAM;YAER,KAAK,WAAW,CAAC,OAAO;gBACtB,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC;gBAC1B,MAAM;YACR,KAAK,WAAW,CAAC,SAAS;gBACxB,QAAQ,CAAC,IAAI,GAAG,WAAW,CAAC;gBAC5B,MAAM;YACR,KAAK,WAAW,CAAC,QAAQ,CAAC;YAC1B,KAAK,WAAW,CAAC,iBAAiB;gBAChC,MAAM,WAAW,GAAoB,OAA0B,CAAC;gBAChE,IAAI,WAAW,CAAC,eAAe,EAAE,CAAC;oBAChC,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,IAAI,GAAG,UAAU,CAAC;gBAC7B,CAAC;gBACD,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;gBACvD,MAAM;YAER,KAAK,WAAW,CAAC,QAAQ;gBACvB,QAAQ,CAAC,IAAI,GAAG,UAAU,CAAC;gBAC3B,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAsB,CAAC,CAAC;gBACtE,MAAM;YAER,KAAK,WAAW,CAAC,QAAQ;gBACvB,QAAQ,CAAC,IAAI,GAAG,UAAU,CAAC;gBAC3B,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAsB,CAAC,CAAC;gBAClE,MAAM;YAER,KAAK,WAAW,CAAC,SAAS;gBACxB,QAAQ,CAAC,IAAI,GAAG,WAAW,CAAC;gBAC5B,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAuB,CAAC,CAAC;gBACpE,MAAM;YAER;gBACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7E,MAAM,iBAAiB,GAA2B,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACjF,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,6CAA6C,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;YACvF,CAAC;YACD,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACrD,CAAC;QAED,OAAO,QAAqB,CAAC;IAC/B,CAAC;IAEO,2BAA2B,CACjC,UAAgC,EAChC,OAAkC;QAElC,MAAM,cAAc,GAAqB,EAAE,CAAC;QAC5C,KAAK,MAAM,gBAAgB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YACtD,MAAM,aAAa,GAAmB;gBACpC,EAAE,EAAE,gBAAgB,CAAC,IAAI;aAC1B,CAAC;YAEF,IAAI,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;gBACzC,aAAa,CAAC,WAAW,GAAG,IAAI,CAAC,eAAe,CAC9C,gBAAgB,CAAC,mBAAmB,CAAC,OAAO,EAC5C,OAAO,CACR,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;gBAChD,aAAa,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC1F,CAAC;YAED,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,6BAA6B,CACnC,GAAyB,EACzB,QAA4B,EAC5B,OAAgC;QAEhC,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxB,QAAQ,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACxE,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,QAAQ,CAAC,UAAU,GAAG,EAAE,CAAC;gBACzB,KAAK,MAAM,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;oBACrD,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC1E,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;gBACtB,KAAK,MAAM,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC/C,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5E,CAAC;YAED,MAAM,cAAc,GAAqB,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACxF,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC1B,QAAQ,CAAC,MAAM,GAAG,EAAE,cAAc,EAAE,CAAC;YACvC,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACnD,IAAI,aAAqB,CAAC;gBAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC;oBACvC,aAAa,GAAG,qEAAqE,CAAC;gBACxF,CAAC;qBAAM,CAAC;oBACN,aAAa,GAAG,+EAA+E,CAAC;gBAClG,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACtB,QAAQ,CAAC,OAAO,GAAG,aAAa,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,yBAAyB,CAC/B,GAAyB,EACzB,QAA4B,EAC5B,OAAsE;QAEtE,MAAM,MAAM,GAAgB;YAC1B,OAAO,EAAE,OAAO,CAAC,uBAAuB,EAAE;SAC3C,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAEzB,IAAI,kBAAkB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9C,MAAM,UAAU,GAAW,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAE5E,IAAI,iBAAiB,GAAW,EAAE,CAAC;YAEnC,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC9D,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7F,sFAAsF;gBACtF,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,UAAU,IAAI,iBAAiB,EAAE,CAAC;gBACpC,MAAM,CAAC,MAAM,GAAG;oBACd,IAAI,EAAE,CAAC,UAAU,CAAC;oBAClB,WAAW,EAAE,iBAAiB;iBAC/B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAqB,EAAE,CAAC;QACxC,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YAC9C,IAAI,oBAAoB,GAAW,EAAE,CAAC;YACtC,IAAI,YAAY,CAAC,eAAe,EAAE,CAAC;gBACjC,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7F,CAAC;YAED,UAAU,CAAC,IAAI,CAAC;gBACd,EAAE,EAAE,YAAY,CAAC,IAAI;gBACrB,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAAC;gBAChE,QAAQ,EAAE,YAAY,CAAC,UAAU;aAChB,CAAC,CAAC;QACvB,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,CAAC;QAED,IAAI,yBAAyB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAqB,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACxF,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,qBAAqB,CAC3B,GAAyB,EACzB,QAA4B,EAC5B,OAAwB;QAExB,MAAM,MAAM,GAAgB;YAC1B,OAAO,EAAE,OAAO,CAAC,uBAAuB,EAAE;SAC3C,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAEzB,IAAI,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM,CAAC,MAAM,GAAG;gBACd,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAC3D,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,qBAAqB,CAC3B,GAAyB,EACzB,QAA4B,EAC5B,OAAoB;QAEpB,MAAM,MAAM,GAAgB;YAC1B,OAAO,EAAE,OAAO,CAAC,uBAAuB,EAAE;SAC3C,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAEzB,IAAI,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;YACrC,MAAM,CAAC,MAAM,GAAG;gBACd,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAC3D,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,sBAAsB,CAC5B,GAAyB,EACzB,QAA4B,EAC5B,OAAqB;QAErB,MAAM,MAAM,GAAgB;YAC1B,OAAO,EAAE,OAAO,CAAC,uBAAuB,EAAE;SAC3C,CAAC;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAEzB,MAAM,cAAc,GAAqB,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACxF,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;QACzC,CAAC;QAED,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAC7B,MAAM,CAAC,MAAM,GAAG;gBACd,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;aACnD,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,eAAe,CAAC,UAAsB,EAAE,cAAuB;QACrE,MAAM,aAAa,GAAkB,IAAI,aAAa,EAAE,CAAC;QAEzD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE;YACpD,cAAc;YACd,uBAAuB,EAAE,CAAC,OAAgB,EAAE,EAAE;gBAC5C,kFAAkF;gBAClF,wCAAwC;gBAExC,0EAA0E;gBAC1E,8EAA8E;gBAC9E,wEAAwE;gBACxE,yEAAyE;gBACzE,0EAA0E;gBAC1E,uEAAuE;gBACvE,OAAO,SAAS,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;qBAC9C,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;qBAC9C,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;YACzE,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;IAEO,cAAc,CACpB,UAAc,EACd,QAAgB,EAChB,YAAoB,EACpB,MAA8B;QAE9B,QAAQ,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;QAEhD,IAAI,WAAW,GAAW,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAC9C,SAAS,EAAE,GAAG;SACf,CAAC,CAAC;QAEH,IAAI,YAAY,EAAE,CAAC;YACjB,WAAW,GAAG,gBAAgB,YAAY,IAAI,GAAG,WAAW,CAAC;QAC/D,CAAC;QAED,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE;YAC1C,kBAAkB,EAAE,WAAW,CAAC,IAAI;YACpC,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;QAEH,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,OAAO,CAAC,OAAgB;QAChC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAChD,CAAC;IAES,aAAa,CAAC,OAAgB;QACtC,OAAO,OAAO,CAAC,kBAAkB,CAAC;IACpC,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACK,sBAAsB,CAAC,OAAgB;QAC7C,IAAI,OAAO,CAAC,kBAAkB,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;YACtE,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QACzF,CAAC;QAED,4BAA4B;QAC5B,IAAI,qBAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACxC,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,qBAAqB;QAC3B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG;gBACrB,UAAU,EAAE,EAAE;gBACd,aAAa,EAAE,IAAI,GAAG,EAAE;gBACxB,wBAAwB,EAAE,IAAI,GAAG,EAAE;aACpC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,kBAAkB,CACxB,UAAgC,EAChC,aAA0C;QAE1C,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,IAAI,GAAW,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;YACxE,MAAM,eAAe,GAAyB,EAAE,IAAI,EAAE,CAAC;YACvD,MAAM,OAAO,GAAwB,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClF,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;oBAChC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;wBACxB,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;4BACjF,OAAO,CAAC,WAAW;yBACpB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;qBAAM,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;oBAC3C,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACpC,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CACnD,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAC3B,OAAO,CAAC,YAAY,CACrB,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,WAAW,CAAC,UAAgC,EAAE,WAAoB;QACxE,MAAM,aAAa,GAAmB,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,2BAA2B;QAEjG,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,0DAA0D;QAC1D,MAAM,SAAS,GAAiB,aAAa,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxE,IAAI,SAAS,CAAC,IAAI,KAAK,gBAAgB,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YAC1E,aAAa,CAAC,GAAG,EAAE,CAAC;YACpB,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAW,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAEjD,kFAAkF;QAClF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACtG,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,cAAc,GAAoB,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACrE,MAAM,WAAW,GAAuB,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEnF,iFAAiF;QACjF,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,6EAA6E;QAC7E,IACE,aAAa,CAAC,MAAM,KAAK,CAAC;YAC1B,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,SAAS;YACpD,aAAa,CAAC,CAAC,CAAC,CAAC,kBAAkB,EACnC,CAAC;YACD,MAAM,UAAU,GAAW,aAAa,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;YAC1E,MAAM,OAAO,GAAwB,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC,oBAAoB,CAC9B,cAAc,EACd,aAAa,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAC9C,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EACnD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAChF,CAAC;QACJ,CAAC;QAED,kGAAkG;QAClG,sBAAsB;QACtB,MAAM,OAAO,GAAW,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;QAElG,yFAAyF;QACzF,8CAA8C;QAC9C,MAAM,OAAO,GAAW,cAAc,CAAC,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClF,cAAc,CAAC,wBAAwB,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;QAElE,MAAM,GAAG,GAAW,UAAU;aAC3B,iBAAiB,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;aAClD,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC;aAChC,iBAAiB,CAAC,SAAS,CAAC;aAC5B,QAAQ,EAAE,CAAC;QAEd,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC3F,CAAC;IAEO,oBAAoB,CAC1B,cAA+B,EAC/B,GAAW,EACX,IAAY,EACZ,QAAgB,EAChB,aAA8B;QAE9B,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC;YAC7D,OAAO,GAAG,CAAC;QACb,CAAC;QAED,+CAA+C;QAC/C,MAAM,KAAK,GAAyB,EAAE,CAAC;QACvC,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,SAAS,EAAE,CAAC;oBAC9C,MAAM,IAAI,GAAuB,EAAE,CAAC;oBACpC,MAAM,OAAO,GAAuB,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;oBACpG,MAAM,OAAO,GAAwB,OAAO;wBAC1C,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,OAAO,CAAC;wBACjD,CAAC,CAAC,SAAS,CAAC;oBACd,IAAI,OAAO,EAAE,CAAC;wBACZ,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC;oBACrB,CAAC;oBACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;oBACvB,IAAI,CAAC,QAAQ,GAAG,OAAO;wBACrB,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE;wBACtC,CAAC,CAAC,KAAK,CAAC,kBAAkB;4BACxB,CAAC,CAAC,KAAK,CAAC,kBAAkB;iCACrB,UAAU,CAAC,SAAS,CAAC;iCACrB,WAAW,CAAC,SAAS,CAAC;iCACtB,iBAAiB,CAAC,SAAS,CAAC;iCAC5B,QAAQ,EAAE;4BACf,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;oBACjB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC;qBAAM,CAAC;oBACN,KAAK,CAAC,IAAI,CAAC;wBACT,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,QAAQ,EAAE,KAAK,CAAC,IAAI;qBACrB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,aAAa,GAAmB,EAAE,GAAG,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,aAAa,CAAC,IAAI,GAAG,KAAK;iBACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;iBAClB,IAAI,CAAC,EAAE,CAAC;iBACR,IAAI,EAAE,CAAC;YACV,aAAa,CAAC,QAAQ,GAAG,KAAK;iBAC3B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC;iBAChC,IAAI,CAAC,EAAE,CAAC;iBACR,IAAI,EAAE,CAAC;YACV,aAAa,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjB,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;YAC5B,CAAC;YACD,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC1C,aAAa,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACpC,CAAC;QACH,CAAC;QAED,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,gBAAgB,CAAC,OAAgB,EAAE,UAAwB,EAAE;QACnE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;QACvD,MAAM,QAAQ,GAAW,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QACzG,IACE,CAAC,gBAAgB,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAC;YAC5D,OAAO,CAAC,MAAM;YACd,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAC7C,CAAC;YACD,6FAA6F;YAC7F,EAAE;YACF,kBAAkB;YAClB,0BAA0B;YAC1B,uBAAuB;YACvB,4BAA4B;YAC5B,gCAAgC;YAChC,0DAA0D;YAC1D,wBAAwB;YACxB,UAAU;YACV,EAAE;YACF,EAAE;YACF,2BAA2B;YAC3B,yBAAyB;YACzB,+CAA+C;YAC/C,wDAAwD;YACxD,0BAA0B;YAC1B,YAAY;YACZ,UAAU;YACV,QAAQ;YACR,MAAM;YACN,EAAE;YACF,uGAAuG;YACvG,wGAAwG;YACxG,yGAAyG;YACzG,qCAAqC;YACrC,MAAM,SAAS,GAAa,CAAC,QAAQ,CAAC,CAAC;YAEvC,KAAK,IAAI,OAAO,GAAwB,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC1F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;oBAC3C,MAAM;gBACR,CAAC;gBAED,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,YAAoB,EAAE,OAAgB;QAC7D,IAAI,MAAM,GAAW,EAAE,CAAC;QAExB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;YAC7C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;gBACrB,KAAK,WAAW,CAAC,KAAK,CAAC;gBACvB,KAAK,WAAW,CAAC,UAAU;oBACzB,MAAM;gBACR,KAAK,WAAW,CAAC,OAAO;oBACtB,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;oBAC7F,MAAM;gBACR;oBACE,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;wBACrE,MAAM,IAAI,GAAG,CAAC;oBAChB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,GAAG,CAAC;oBAChB,CAAC;oBACD,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;oBAChE,MAAM;YACV,CAAC;QACH,CAAC;QAED,IAAI,aAAa,GAAW,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,aAAa,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC,CAAC;IAClE,CAAC;IAEO,qBAAqB,CAAC,YAAoB;QAChD,OAAO,CAAC,GAAG,CAAC,2BAA2B,GAAG,YAAY,CAAC,CAAC;QACxD,UAAU,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'node:path';\n\nimport yaml = require('js-yaml');\n\nimport {\n JsonFile,\n JsonSchema,\n PackageName,\n FileSystem,\n NewlineKind,\n InternalError\n} from '@rushstack/node-core-library';\nimport {\n StringBuilder,\n type DocSection,\n type DocComment,\n type DocBlock,\n StandardTags\n} from '@microsoft/tsdoc';\nimport {\n type ApiModel,\n type ApiItem,\n ApiItemKind,\n ApiDocumentedItem,\n ApiReleaseTagMixin,\n ReleaseTag,\n type ApiPropertyItem,\n ApiItemContainerMixin,\n type ApiPackage,\n type ApiEnumMember,\n ApiClass,\n ApiInterface,\n type ApiMethod,\n type ApiMethodSignature,\n type ApiConstructor,\n type ApiFunction,\n ApiReturnTypeMixin,\n ApiTypeParameterListMixin,\n type Excerpt,\n type ExcerptToken,\n ExcerptTokenKind,\n type HeritageType,\n type ApiVariable,\n type ApiTypeAlias\n} from '@microsoft/api-extractor-model';\nimport {\n type DeclarationReference,\n Navigation,\n Meaning\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport type {\n IYamlApiFile,\n IYamlItem,\n IYamlSyntax,\n IYamlParameter,\n IYamlReference,\n IYamlReferenceSpec,\n IYamlInheritanceTree\n} from '../yaml/IYamlApiFile';\nimport type { IYamlTocFile, IYamlTocItem } from '../yaml/IYamlTocFile';\nimport { Utilities } from '../utils/Utilities';\nimport { CustomMarkdownEmitter } from '../markdown/CustomMarkdownEmitter';\nimport { convertUDPYamlToSDP } from '../utils/ToSdpConvertHelper';\nimport typescriptSchema from '../yaml/typescript.schema.json';\n\nconst yamlApiSchema: JsonSchema = JsonSchema.fromLoadedObject(typescriptSchema);\n\ninterface IYamlReferences {\n references: IYamlReference[];\n typeNameToUid: Map<string, string>;\n uidTypeReferenceCounters: Map<string, number>;\n}\n\nenum FlattenMode {\n /** Include entries for nested namespaces and non-namespace children. */\n NestedNamespacesAndChildren,\n /** Include entries for nested namespaces only. */\n NestedNamespacesOnly,\n /** Include entries for non-namespace immediate children. */\n ImmediateChildren,\n /** Include entries for nested non-namespace children. */\n NestedChildren\n}\n\ninterface INameOptions {\n includeSignature?: boolean;\n includeNamespace?: boolean;\n}\n\nexport type YamlFormat = 'udp' | 'sdp';\n\n/**\n * Writes documentation in the Universal Reference YAML file format, as defined by typescript.schema.json.\n */\nexport class YamlDocumenter {\n protected readonly newDocfxNamespaces: boolean;\n private readonly _yamlFormat: string;\n private readonly _apiModel: ApiModel;\n private readonly _markdownEmitter: CustomMarkdownEmitter;\n\n private _apiItemsByCanonicalReference: Map<string, ApiItem>;\n private _yamlReferences: IYamlReferences | undefined;\n\n public constructor(\n apiModel: ApiModel,\n newDocfxNamespaces: boolean = false,\n yamlFormat: YamlFormat = 'sdp'\n ) {\n this._apiModel = apiModel;\n this.newDocfxNamespaces = newDocfxNamespaces;\n this._yamlFormat = yamlFormat;\n this._markdownEmitter = new CustomMarkdownEmitter(this._apiModel);\n this._apiItemsByCanonicalReference = new Map<string, ApiItem>();\n\n this._initApiItems();\n }\n\n /** @virtual */\n public generateFiles(outputFolder: string): void {\n console.log();\n this._deleteOldOutputFiles(outputFolder);\n\n for (const apiPackage of this._apiModel.packages) {\n console.log(`Writing ${apiPackage.name} package`);\n this._visitApiItems(outputFolder, apiPackage, undefined);\n }\n\n if (this._yamlFormat === 'sdp') {\n convertUDPYamlToSDP(outputFolder);\n }\n\n this._writeTocFile(outputFolder, this._apiModel.packages);\n }\n\n /** @virtual */\n protected onGetTocRoot(): IYamlTocItem {\n return {\n name: 'SharePoint Framework reference',\n href: '~/overview/sharepoint.md',\n items: []\n };\n }\n\n /** @virtual */\n protected onCustomizeYamlItem(yamlItem: IYamlItem): void {\n // virtual\n // (overridden by child class)\n }\n\n private _visitApiItems(\n outputFolder: string,\n apiItem: ApiDocumentedItem,\n parentYamlFile: IYamlApiFile | undefined\n ): boolean {\n let savedYamlReferences: IYamlReferences | undefined;\n if (!this._shouldEmbed(apiItem.kind)) {\n savedYamlReferences = this._yamlReferences;\n this._yamlReferences = undefined;\n }\n\n const yamlItem: IYamlItem | undefined = this._generateYamlItem(apiItem);\n if (!yamlItem) {\n return false;\n }\n\n this.onCustomizeYamlItem(yamlItem);\n\n if (this._shouldEmbed(apiItem.kind)) {\n if (!parentYamlFile) {\n throw new InternalError('Missing file context');\n }\n parentYamlFile.items.push(yamlItem);\n } else {\n const newYamlFile: IYamlApiFile = {\n items: []\n };\n newYamlFile.items.push(yamlItem);\n\n const children: ApiItem[] = this._getLogicalChildren(apiItem);\n for (const child of children) {\n if (child instanceof ApiDocumentedItem) {\n if (this._visitApiItems(outputFolder, child, newYamlFile)) {\n if (!yamlItem.children) {\n yamlItem.children = [];\n }\n yamlItem.children.push(this._getUid(child));\n }\n }\n }\n\n if (this._yamlReferences && this._yamlReferences.references.length > 0) {\n newYamlFile.references = this._yamlReferences.references;\n }\n\n this._yamlReferences = savedYamlReferences;\n\n const yamlFilePath: string = this._getYamlFilePath(outputFolder, apiItem);\n\n if (apiItem.kind === ApiItemKind.Package) {\n console.log('Writing ' + yamlFilePath);\n }\n\n this._writeYamlFile(newYamlFile, yamlFilePath, 'UniversalReference', yamlApiSchema);\n\n if (parentYamlFile) {\n // References should be recorded in the parent YAML file with the local name of the embedded item.\n // This avoids unnecessary repetition when listing items inside of a namespace.\n this._recordYamlReference(\n this._ensureYamlReferences(),\n this._getUid(apiItem),\n this._getYamlItemName(apiItem, {\n includeNamespace: !this.newDocfxNamespaces,\n includeSignature: true\n }),\n this._getYamlItemName(apiItem, { includeNamespace: true, includeSignature: true })\n );\n }\n }\n\n return true;\n }\n\n protected _getLogicalChildren(apiItem: ApiItem): ApiItem[] {\n const children: ApiItem[] = [];\n if (apiItem.kind === ApiItemKind.Package) {\n // Skip over the entry point, since it's not part of the documentation hierarchy\n this._flattenNamespaces(\n apiItem.members[0].members,\n children,\n this.newDocfxNamespaces ? FlattenMode.NestedNamespacesAndChildren : FlattenMode.NestedChildren\n );\n } else {\n this._flattenNamespaces(\n apiItem.members,\n children,\n this.newDocfxNamespaces ? FlattenMode.ImmediateChildren : FlattenMode.NestedChildren\n );\n }\n return children;\n }\n\n // Flattens nested namespaces into top level entries so that the following:\n // namespace X { export namespace Y { export namespace Z { } }\n // Is represented as:\n // - X\n // - X.Y\n // - X.Y.Z\n private _flattenNamespaces(\n items: ReadonlyArray<ApiItem>,\n childrenOut: ApiItem[],\n mode: FlattenMode\n ): boolean {\n let hasNonNamespaceChildren: boolean = false;\n for (const item of items) {\n if (item.kind === ApiItemKind.Namespace) {\n switch (mode) {\n case FlattenMode.NestedChildren:\n // Include children of namespaces, but not the namespaces themselves. This matches existing legacy behavior.\n this._flattenNamespaces(item.members, childrenOut, FlattenMode.NestedChildren);\n break;\n case FlattenMode.NestedNamespacesOnly:\n case FlattenMode.NestedNamespacesAndChildren:\n // At any level, always include a nested namespace if it has non-namespace children, but do not include its\n // non-namespace children in the result.\n\n // Record the offset at which the namespace is added in case we need to remove it later.\n const index: number = childrenOut.length;\n childrenOut.push(item);\n\n if (!this._flattenNamespaces(item.members, childrenOut, FlattenMode.NestedNamespacesOnly)) {\n // This namespace had no non-namespace children, remove it.\n childrenOut.splice(index, 1);\n }\n break;\n }\n } else if (this._shouldInclude(item.kind)) {\n switch (mode) {\n case FlattenMode.NestedChildren:\n case FlattenMode.NestedNamespacesAndChildren:\n case FlattenMode.ImmediateChildren:\n // At the top level, include non-namespace children as well.\n childrenOut.push(item);\n break;\n }\n hasNonNamespaceChildren = true;\n }\n }\n return hasNonNamespaceChildren;\n }\n\n /**\n * Write the table of contents\n */\n private _writeTocFile(outputFolder: string, apiItems: ReadonlyArray<ApiItem>): void {\n const tocFile: IYamlTocFile = this.buildYamlTocFile(apiItems);\n\n const tocFilePath: string = path.join(outputFolder, 'toc.yml');\n console.log('Writing ' + tocFilePath);\n this._writeYamlFile(tocFile, tocFilePath, '', undefined);\n }\n\n /** @virtual */\n protected buildYamlTocFile(apiItems: ReadonlyArray<ApiItem>): IYamlTocFile {\n const tocFile: IYamlTocFile = {\n items: []\n };\n\n const rootItem: IYamlTocItem = this.onGetTocRoot();\n tocFile.items.push(rootItem);\n\n rootItem.items!.push(...this._buildTocItems(apiItems));\n return tocFile;\n }\n\n private _buildTocItems(apiItems: ReadonlyArray<ApiItem>): IYamlTocItem[] {\n const tocItems: IYamlTocItem[] = [];\n for (const apiItem of apiItems) {\n let tocItem: IYamlTocItem;\n if (apiItem.kind === ApiItemKind.Namespace && !this.newDocfxNamespaces) {\n tocItem = {\n name: this._getTocItemName(apiItem)\n };\n } else {\n if (this._shouldEmbed(apiItem.kind)) {\n // Don't generate table of contents items for embedded definitions\n continue;\n }\n\n tocItem = {\n name: this._getTocItemName(apiItem),\n uid: this._getUid(apiItem)\n };\n }\n\n tocItems.push(tocItem);\n\n const children: ApiItem[] = this._getLogicalChildren(apiItem);\n const childItems: IYamlTocItem[] = this._buildTocItems(children);\n if (childItems.length > 0) {\n tocItem.items = childItems;\n }\n }\n return tocItems;\n }\n\n /** @virtual */\n protected _getTocItemName(apiItem: ApiItem): string {\n let name: string;\n if (apiItem.kind === ApiItemKind.Package) {\n name = PackageName.getUnscopedName(apiItem.displayName);\n } else {\n name = this._getYamlItemName(apiItem);\n }\n\n if (name === apiItem.displayName && apiItem.getMergedSiblings().length > 1) {\n name += ` (${apiItem.kind})`;\n }\n\n return name;\n }\n\n protected _shouldEmbed(apiItemKind: ApiItemKind): boolean {\n switch (apiItemKind) {\n case ApiItemKind.Class:\n case ApiItemKind.Package:\n case ApiItemKind.Interface:\n case ApiItemKind.Enum:\n case ApiItemKind.TypeAlias:\n return false;\n case ApiItemKind.Namespace:\n return !this.newDocfxNamespaces;\n }\n return true;\n }\n\n protected _shouldInclude(apiItemKind: ApiItemKind): boolean {\n // Filter out known items that are not yet supported\n switch (apiItemKind) {\n case ApiItemKind.CallSignature:\n case ApiItemKind.ConstructSignature:\n case ApiItemKind.IndexSignature:\n return false;\n }\n return true;\n }\n\n private _generateYamlItem(apiItem: ApiDocumentedItem): IYamlItem | undefined {\n // Filter out known items that are not yet supported\n if (!this._shouldInclude(apiItem.kind)) {\n return undefined;\n }\n\n const uid: DeclarationReference = this._getUidObject(apiItem);\n const yamlItem: Partial<IYamlItem> = {\n uid: uid.toString()\n };\n\n if (apiItem.tsdocComment) {\n const tsdocComment: DocComment = apiItem.tsdocComment;\n if (tsdocComment.summarySection) {\n const summary: string = this._renderMarkdown(tsdocComment.summarySection, apiItem);\n if (summary) {\n yamlItem.summary = summary;\n }\n }\n\n if (tsdocComment.remarksBlock) {\n const remarks: string = this._renderMarkdown(tsdocComment.remarksBlock.content, apiItem);\n if (remarks) {\n yamlItem.remarks = remarks;\n }\n }\n\n if (tsdocComment) {\n // Write the @example blocks\n const exampleBlocks: DocBlock[] = tsdocComment.customBlocks.filter(\n (x) => x.blockTag.tagNameWithUpperCase === StandardTags.example.tagNameWithUpperCase\n );\n\n for (const exampleBlock of exampleBlocks) {\n const example: string = this._renderMarkdown(exampleBlock.content, apiItem);\n if (example) {\n yamlItem.example = [...(yamlItem.example || []), example];\n }\n }\n }\n\n if (tsdocComment.deprecatedBlock) {\n const deprecatedMessage: string = this._renderMarkdown(tsdocComment.deprecatedBlock.content, apiItem);\n if (deprecatedMessage.length > 0) {\n yamlItem.deprecated = { content: deprecatedMessage };\n }\n }\n }\n\n if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {\n if (apiItem.releaseTag === ReleaseTag.Alpha || apiItem.releaseTag === ReleaseTag.Beta) {\n yamlItem.isPreview = true;\n }\n }\n\n yamlItem.name = this._getYamlItemName(apiItem, {\n includeSignature: true,\n includeNamespace: !this.newDocfxNamespaces\n });\n yamlItem.fullName = this._getYamlItemName(apiItem, { includeSignature: true, includeNamespace: true });\n yamlItem.langs = ['typeScript'];\n\n // Add the namespace of the item if it is contained in one.\n // Do not add the namespace parent of a namespace as they are flattened in the documentation.\n if (\n apiItem.kind !== ApiItemKind.Namespace &&\n apiItem.parent &&\n apiItem.parent.kind === ApiItemKind.Namespace &&\n this.newDocfxNamespaces\n ) {\n yamlItem.namespace = apiItem.parent.canonicalReference.toString();\n }\n\n switch (apiItem.kind) {\n case ApiItemKind.Enum:\n yamlItem.type = 'enum';\n break;\n case ApiItemKind.EnumMember:\n yamlItem.type = 'field';\n const enumMember: ApiEnumMember = apiItem as ApiEnumMember;\n\n if (enumMember.initializerExcerpt && enumMember.initializerExcerpt.text.length > 0) {\n yamlItem.numericValue = enumMember.initializerExcerpt.text;\n }\n\n break;\n case ApiItemKind.Class:\n yamlItem.type = 'class';\n this._populateYamlClassOrInterface(uid, yamlItem, apiItem as ApiClass);\n break;\n case ApiItemKind.Interface:\n yamlItem.type = 'interface';\n this._populateYamlClassOrInterface(uid, yamlItem, apiItem as ApiInterface);\n break;\n case ApiItemKind.Method:\n case ApiItemKind.MethodSignature:\n yamlItem.type = 'method';\n this._populateYamlFunctionLike(uid, yamlItem, apiItem as ApiMethod | ApiMethodSignature);\n break;\n\n case ApiItemKind.Constructor:\n yamlItem.type = 'constructor';\n this._populateYamlFunctionLike(uid, yamlItem, apiItem as ApiConstructor);\n break;\n\n case ApiItemKind.Package:\n yamlItem.type = 'package';\n break;\n case ApiItemKind.Namespace:\n yamlItem.type = 'namespace';\n break;\n case ApiItemKind.Property:\n case ApiItemKind.PropertySignature:\n const apiProperty: ApiPropertyItem = apiItem as ApiPropertyItem;\n if (apiProperty.isEventProperty) {\n yamlItem.type = 'event';\n } else {\n yamlItem.type = 'property';\n }\n this._populateYamlProperty(uid, yamlItem, apiProperty);\n break;\n\n case ApiItemKind.Function:\n yamlItem.type = 'function';\n this._populateYamlFunctionLike(uid, yamlItem, apiItem as ApiFunction);\n break;\n\n case ApiItemKind.Variable:\n yamlItem.type = 'variable';\n this._populateYamlVariable(uid, yamlItem, apiItem as ApiVariable);\n break;\n\n case ApiItemKind.TypeAlias:\n yamlItem.type = 'typealias';\n this._populateYamlTypeAlias(uid, yamlItem, apiItem as ApiTypeAlias);\n break;\n\n default:\n throw new Error('Unimplemented item kind: ' + apiItem.kind);\n }\n\n if (apiItem.kind !== ApiItemKind.Package && !this._shouldEmbed(apiItem.kind)) {\n const associatedPackage: ApiPackage | undefined = apiItem.getAssociatedPackage();\n if (!associatedPackage) {\n throw new Error('Unable to determine associated package for ' + apiItem.displayName);\n }\n yamlItem.package = this._getUid(associatedPackage);\n }\n\n return yamlItem as IYamlItem;\n }\n\n private _populateYamlTypeParameters(\n contextUid: DeclarationReference,\n apiItem: ApiTypeParameterListMixin\n ): IYamlParameter[] {\n const typeParameters: IYamlParameter[] = [];\n for (const apiTypeParameter of apiItem.typeParameters) {\n const typeParameter: IYamlParameter = {\n id: apiTypeParameter.name\n };\n\n if (apiTypeParameter.tsdocTypeParamBlock) {\n typeParameter.description = this._renderMarkdown(\n apiTypeParameter.tsdocTypeParamBlock.content,\n apiItem\n );\n }\n\n if (!apiTypeParameter.constraintExcerpt.isEmpty) {\n typeParameter.type = [this._renderType(contextUid, apiTypeParameter.constraintExcerpt)];\n }\n\n typeParameters.push(typeParameter);\n }\n return typeParameters;\n }\n\n private _populateYamlClassOrInterface(\n uid: DeclarationReference,\n yamlItem: Partial<IYamlItem>,\n apiItem: ApiClass | ApiInterface\n ): void {\n if (apiItem instanceof ApiClass) {\n if (apiItem.extendsType) {\n yamlItem.extends = [this._renderType(uid, apiItem.extendsType.excerpt)];\n yamlItem.inheritance = this._renderInheritance(uid, [apiItem.extendsType]);\n }\n if (apiItem.implementsTypes.length > 0) {\n yamlItem.implements = [];\n for (const implementsType of apiItem.implementsTypes) {\n yamlItem.implements.push(this._renderType(uid, implementsType.excerpt));\n }\n }\n } else if (apiItem instanceof ApiInterface) {\n if (apiItem.extendsTypes.length > 0) {\n yamlItem.extends = [];\n for (const extendsType of apiItem.extendsTypes) {\n yamlItem.extends.push(this._renderType(uid, extendsType.excerpt));\n }\n yamlItem.inheritance = this._renderInheritance(uid, apiItem.extendsTypes);\n }\n\n const typeParameters: IYamlParameter[] = this._populateYamlTypeParameters(uid, apiItem);\n if (typeParameters.length) {\n yamlItem.syntax = { typeParameters };\n }\n }\n\n if (apiItem.tsdocComment) {\n if (apiItem.tsdocComment.modifierTagSet.isSealed()) {\n let sealedMessage: string;\n if (apiItem.kind === ApiItemKind.Class) {\n sealedMessage = 'This class is marked as `@sealed`. Subclasses should not extend it.';\n } else {\n sealedMessage = 'This interface is marked as `@sealed`. Other interfaces should not extend it.';\n }\n if (!yamlItem.remarks) {\n yamlItem.remarks = sealedMessage;\n } else {\n yamlItem.remarks = sealedMessage + '\\n\\n' + yamlItem.remarks;\n }\n }\n }\n }\n\n private _populateYamlFunctionLike(\n uid: DeclarationReference,\n yamlItem: Partial<IYamlItem>,\n apiItem: ApiMethod | ApiMethodSignature | ApiConstructor | ApiFunction\n ): void {\n const syntax: IYamlSyntax = {\n content: apiItem.getExcerptWithModifiers()\n };\n yamlItem.syntax = syntax;\n\n if (ApiReturnTypeMixin.isBaseClassOf(apiItem)) {\n const returnType: string = this._renderType(uid, apiItem.returnTypeExcerpt);\n\n let returnDescription: string = '';\n\n if (apiItem.tsdocComment && apiItem.tsdocComment.returnsBlock) {\n returnDescription = this._renderMarkdown(apiItem.tsdocComment.returnsBlock.content, apiItem);\n // temporary workaround for people who mistakenly add a hyphen, e.g. \"@returns - blah\"\n returnDescription = returnDescription.replace(/^\\s*-\\s+/, '');\n }\n\n if (returnType || returnDescription) {\n syntax.return = {\n type: [returnType],\n description: returnDescription\n };\n }\n }\n\n const parameters: IYamlParameter[] = [];\n for (const apiParameter of apiItem.parameters) {\n let parameterDescription: string = '';\n if (apiParameter.tsdocParamBlock) {\n parameterDescription = this._renderMarkdown(apiParameter.tsdocParamBlock.content, apiItem);\n }\n\n parameters.push({\n id: apiParameter.name,\n description: parameterDescription,\n type: [this._renderType(uid, apiParameter.parameterTypeExcerpt)],\n optional: apiParameter.isOptional\n } as IYamlParameter);\n }\n\n if (parameters.length) {\n syntax.parameters = parameters;\n }\n\n if (ApiTypeParameterListMixin.isBaseClassOf(apiItem)) {\n const typeParameters: IYamlParameter[] = this._populateYamlTypeParameters(uid, apiItem);\n if (typeParameters.length) {\n syntax.typeParameters = typeParameters;\n }\n }\n }\n\n private _populateYamlProperty(\n uid: DeclarationReference,\n yamlItem: Partial<IYamlItem>,\n apiItem: ApiPropertyItem\n ): void {\n const syntax: IYamlSyntax = {\n content: apiItem.getExcerptWithModifiers()\n };\n yamlItem.syntax = syntax;\n\n if (apiItem.propertyTypeExcerpt.text) {\n syntax.return = {\n type: [this._renderType(uid, apiItem.propertyTypeExcerpt)]\n };\n }\n }\n\n private _populateYamlVariable(\n uid: DeclarationReference,\n yamlItem: Partial<IYamlItem>,\n apiItem: ApiVariable\n ): void {\n const syntax: IYamlSyntax = {\n content: apiItem.getExcerptWithModifiers()\n };\n yamlItem.syntax = syntax;\n\n if (apiItem.variableTypeExcerpt.text) {\n syntax.return = {\n type: [this._renderType(uid, apiItem.variableTypeExcerpt)]\n };\n }\n }\n\n private _populateYamlTypeAlias(\n uid: DeclarationReference,\n yamlItem: Partial<IYamlItem>,\n apiItem: ApiTypeAlias\n ): void {\n const syntax: IYamlSyntax = {\n content: apiItem.getExcerptWithModifiers()\n };\n yamlItem.syntax = syntax;\n\n const typeParameters: IYamlParameter[] = this._populateYamlTypeParameters(uid, apiItem);\n if (typeParameters.length) {\n syntax.typeParameters = typeParameters;\n }\n\n if (apiItem.typeExcerpt.text) {\n syntax.return = {\n type: [this._renderType(uid, apiItem.typeExcerpt)]\n };\n }\n }\n\n private _renderMarkdown(docSection: DocSection, contextApiItem: ApiItem): string {\n const stringBuilder: StringBuilder = new StringBuilder();\n\n this._markdownEmitter.emit(stringBuilder, docSection, {\n contextApiItem,\n onGetFilenameForApiItem: (apiItem: ApiItem) => {\n // NOTE: GitHub's markdown renderer does not resolve relative hyperlinks correctly\n // unless they start with \"./\" or \"../\".\n\n // To ensure the xref is properly escaped, we first encode the entire xref\n // to handle escaping of reserved characters. Then we must replace '#' and '?'\n // characters so that they are not interpreted as a querystring or hash.\n // We must also backslash-escape unbalanced `(` and `)` characters as the\n // markdown spec insists that they are only valid when balanced. To reduce\n // the overhead we only support balanced parenthesis with a depth of 1.\n return encodeURI(`xref:${this._getUid(apiItem)}`)\n .replace(/[#?]/g, (s) => encodeURIComponent(s))\n .replace(/(\$[^(]*\$)|[()]/g, (s, balanced) => balanced || '\\\\' + s);\n }\n });\n\n return stringBuilder.toString().trim();\n }\n\n private _writeYamlFile(\n dataObject: {},\n filePath: string,\n yamlMimeType: string,\n schema: JsonSchema | undefined\n ): void {\n JsonFile.validateNoUndefinedMembers(dataObject);\n\n let stringified: string = yaml.dump(dataObject, {\n lineWidth: 120\n });\n\n if (yamlMimeType) {\n stringified = `### YamlMime:${yamlMimeType}\\n` + stringified;\n }\n\n FileSystem.writeFile(filePath, stringified, {\n convertLineEndings: NewlineKind.CrLf,\n ensureFolderExists: true\n });\n\n if (schema) {\n schema.validateObject(dataObject, filePath);\n }\n }\n\n /**\n * Calculate the DocFX \"uid\" for the ApiItem\n * Example: `node-core-library!JsonFile#load`\n */\n protected _getUid(apiItem: ApiItem): string {\n return this._getUidObject(apiItem).toString();\n }\n\n protected _getUidObject(apiItem: ApiItem): DeclarationReference {\n return apiItem.canonicalReference;\n }\n\n /**\n * Initialize the _apiItemsByCanonicalReference data structure.\n */\n private _initApiItems(): void {\n this._initApiItemsRecursive(this._apiModel);\n }\n\n /**\n * Helper for _initApiItems()\n */\n private _initApiItemsRecursive(apiItem: ApiItem): void {\n if (apiItem.canonicalReference && !apiItem.canonicalReference.isEmpty) {\n this._apiItemsByCanonicalReference.set(apiItem.canonicalReference.toString(), apiItem);\n }\n\n // Recurse container members\n if (ApiItemContainerMixin.isBaseClassOf(apiItem)) {\n for (const apiMember of apiItem.members) {\n this._initApiItemsRecursive(apiMember);\n }\n }\n }\n\n private _ensureYamlReferences(): IYamlReferences {\n if (!this._yamlReferences) {\n this._yamlReferences = {\n references: [],\n typeNameToUid: new Map(),\n uidTypeReferenceCounters: new Map()\n };\n }\n return this._yamlReferences;\n }\n\n private _renderInheritance(\n contextUid: DeclarationReference,\n heritageTypes: ReadonlyArray<HeritageType>\n ): IYamlInheritanceTree[] {\n const result: IYamlInheritanceTree[] = [];\n for (const heritageType of heritageTypes) {\n const type: string = this._renderType(contextUid, heritageType.excerpt);\n const yamlInheritance: IYamlInheritanceTree = { type };\n const apiItem: ApiItem | undefined = this._apiItemsByCanonicalReference.get(type);\n if (apiItem) {\n if (apiItem instanceof ApiClass) {\n if (apiItem.extendsType) {\n yamlInheritance.inheritance = this._renderInheritance(this._getUidObject(apiItem), [\n apiItem.extendsType\n ]);\n }\n } else if (apiItem instanceof ApiInterface) {\n if (apiItem.extendsTypes.length > 0) {\n yamlInheritance.inheritance = this._renderInheritance(\n this._getUidObject(apiItem),\n apiItem.extendsTypes\n );\n }\n }\n }\n result.push(yamlInheritance);\n }\n return result;\n }\n\n private _renderType(contextUid: DeclarationReference, typeExcerpt: Excerpt): string {\n const excerptTokens: ExcerptToken[] = [...typeExcerpt.spannedTokens]; // copy the read-only array\n\n if (excerptTokens.length === 0) {\n return '';\n }\n\n // Remove the last token if it consists only of whitespace\n const lastToken: ExcerptToken = excerptTokens[excerptTokens.length - 1];\n if (lastToken.kind === ExcerptTokenKind.Content && !lastToken.text.trim()) {\n excerptTokens.pop();\n if (excerptTokens.length === 0) {\n return '';\n }\n }\n\n const typeName: string = typeExcerpt.text.trim();\n\n // If there are no references to be used for a complex type, return the type name.\n if (!excerptTokens.some((tok) => tok.kind === ExcerptTokenKind.Reference && !!tok.canonicalReference)) {\n return typeName;\n }\n\n const yamlReferences: IYamlReferences = this._ensureYamlReferences();\n const existingUid: string | undefined = yamlReferences.typeNameToUid.get(typeName);\n\n // If this type has already been referenced for the current file, return its uid.\n if (existingUid) {\n return existingUid;\n }\n\n // If the excerpt consists of a single reference token, record the reference.\n if (\n excerptTokens.length === 1 &&\n excerptTokens[0].kind === ExcerptTokenKind.Reference &&\n excerptTokens[0].canonicalReference\n ) {\n const excerptRef: string = excerptTokens[0].canonicalReference.toString();\n const apiItem: ApiItem | undefined = this._apiItemsByCanonicalReference.get(excerptRef);\n return this._recordYamlReference(\n yamlReferences,\n excerptTokens[0].canonicalReference.toString(),\n apiItem ? this._getYamlItemName(apiItem) : typeName,\n apiItem ? this._getYamlItemName(apiItem, { includeNamespace: true }) : typeName\n );\n }\n\n // Otherwise, the type is complex and consists of one or more reference tokens. Record a reference\n // and return its uid.\n const baseUid: string = contextUid.withMeaning(undefined).withOverloadIndex(undefined).toString();\n\n // Keep track of the count for the base uid (without meaning or overload index) to ensure\n // that each complex type reference is unique.\n const counter: number = yamlReferences.uidTypeReferenceCounters.get(baseUid) || 0;\n yamlReferences.uidTypeReferenceCounters.set(baseUid, counter + 1);\n\n const uid: string = contextUid\n .addNavigationStep(Navigation.Locals, `${counter}`)\n .withMeaning(Meaning.ComplexType)\n .withOverloadIndex(undefined)\n .toString();\n\n return this._recordYamlReference(yamlReferences, uid, typeName, typeName, excerptTokens);\n }\n\n private _recordYamlReference(\n yamlReferences: IYamlReferences,\n uid: string,\n name: string,\n fullName: string,\n excerptTokens?: ExcerptToken[]\n ): string {\n if (yamlReferences.references.some((ref) => ref.uid === uid)) {\n return uid;\n }\n\n // Fill in the reference spec from the excerpt.\n const specs: IYamlReferenceSpec[] = [];\n if (excerptTokens) {\n for (const token of excerptTokens) {\n if (token.kind === ExcerptTokenKind.Reference) {\n const spec: IYamlReferenceSpec = {};\n const specUid: string | undefined = token.canonicalReference && token.canonicalReference.toString();\n const apiItem: ApiItem | undefined = specUid\n ? this._apiItemsByCanonicalReference.get(specUid)\n : undefined;\n if (specUid) {\n spec.uid = specUid;\n }\n spec.name = token.text;\n spec.fullName = apiItem\n ? apiItem.getScopedNameWithinPackage()\n : token.canonicalReference\n ? token.canonicalReference\n .withSource(undefined)\n .withMeaning(undefined)\n .withOverloadIndex(undefined)\n .toString()\n : token.text;\n specs.push(spec);\n } else {\n specs.push({\n name: token.text,\n fullName: token.text\n });\n }\n }\n }\n\n const yamlReference: IYamlReference = { uid };\n if (specs.length > 0) {\n yamlReference.name = specs\n .map((s) => s.name)\n .join('')\n .trim();\n yamlReference.fullName = specs\n .map((s) => s.fullName || s.name)\n .join('')\n .trim();\n yamlReference['spec.typeScript'] = specs;\n } else {\n if (name !== uid) {\n yamlReference.name = name;\n }\n if (fullName !== uid && fullName !== name) {\n yamlReference.fullName = fullName;\n }\n }\n\n yamlReferences.references.push(yamlReference);\n return uid;\n }\n\n private _getYamlItemName(apiItem: ApiItem, options: INameOptions = {}): string {\n const { includeSignature, includeNamespace } = options;\n const baseName: string = includeSignature ? Utilities.getConciseSignature(apiItem) : apiItem.displayName;\n if (\n (includeNamespace || apiItem.kind === ApiItemKind.Namespace) &&\n apiItem.parent &&\n apiItem.parent.kind === ApiItemKind.Namespace\n ) {\n // If the immediate parent is a namespace, then add the namespaces to the name. For example:\n //\n // // Name: \"N1\"\n // export namespace N1 {\n // // Name: \"N1.N2\"\n // export namespace N2 {\n // // Name: \"N1.N2.f(x,y)\"\n // export function f(x: string, y: string): string {\n // return x + y;\n // }\n //\n //\n // // Name: \"N1.N2.C\"\n // export class C {\n // // Name: \"member(x,y)\" <===========\n // public member(x: string, y: string): string {\n // return x + y;\n // }\n // }\n // }\n // }\n //\n // In the above example, \"member(x, y)\" does not appear as \"N1.N2.C.member(x,y)\" because YamlDocumenter\n // embeds this entry in the web page for \"N1.N2.C\", so the container is obvious. Whereas \"N1.N2.f(x,y)\"\n // needs to be qualified because the DocFX template doesn't make pages for namespaces. Instead, they get\n // flattened into the package's page.\n const nameParts: string[] = [baseName];\n\n for (let current: ApiItem | undefined = apiItem.parent; current; current = current.parent) {\n if (current.kind !== ApiItemKind.Namespace) {\n break;\n }\n\n nameParts.unshift(current.displayName);\n }\n\n return nameParts.join('.');\n } else {\n return baseName;\n }\n }\n\n private _getYamlFilePath(outputFolder: string, apiItem: ApiItem): string {\n let result: string = '';\n\n for (const current of apiItem.getHierarchy()) {\n switch (current.kind) {\n case ApiItemKind.Model:\n case ApiItemKind.EntryPoint:\n break;\n case ApiItemKind.Package:\n result += Utilities.getSafeFilenameForName(PackageName.getUnscopedName(current.displayName));\n break;\n default:\n if (current.parent && current.parent.kind === ApiItemKind.EntryPoint) {\n result += '/';\n } else {\n result += '.';\n }\n result += Utilities.getSafeFilenameForName(current.displayName);\n break;\n }\n }\n\n let disambiguator: string = '';\n if (apiItem.getMergedSiblings().length > 1) {\n disambiguator = `-${apiItem.kind.toLowerCase()}`;\n }\n\n return path.join(outputFolder, result + disambiguator + '.yml');\n }\n\n private _deleteOldOutputFiles(outputFolder: string): void {\n console.log('Deleting old output from ' + outputFolder);\n FileSystem.ensureEmptyFolder(outputFolder);\n }\n}\n"]}

package/lib-esm/index.js ADDED Viewed

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+export { MarkdownDocumenterAccessor } from './plugin/MarkdownDocumenterAccessor';
+export { MarkdownDocumenterFeatureContext, MarkdownDocumenterFeature } from './plugin/MarkdownDocumenterFeature';
+export { PluginFeature, PluginFeatureContext, PluginFeatureInitialization } from './plugin/PluginFeature';
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAW3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,EACL,gCAAgC,EAGhC,yBAAyB,EAC1B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * API Documenter generates an API reference website from the .api.json files created by API Extractor.\n * The `@microsoft/api-documenter` package provides the command-line tool. It also exposes a developer API that you\n * can use to create plugins that customize how API Documenter generates documentation.\n *\n * @packageDocumentation\n */\n\nexport type { IFeatureDefinition, IApiDocumenterPluginManifest } from './plugin/IApiDocumenterPluginManifest';\nexport { MarkdownDocumenterAccessor } from './plugin/MarkdownDocumenterAccessor';\nexport {\n MarkdownDocumenterFeatureContext,\n type IMarkdownDocumenterFeatureOnBeforeWritePageArgs,\n type IMarkdownDocumenterFeatureOnFinishedArgs,\n MarkdownDocumenterFeature\n} from './plugin/MarkdownDocumenterFeature';\nexport { PluginFeature, PluginFeatureContext, PluginFeatureInitialization } from './plugin/PluginFeature';\n"]}

package/lib-esm/markdown/CustomMarkdownEmitter.js ADDED Viewed

@@ -0,0 +1,146 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Colorize } from '@rushstack/terminal';
+import { CustomDocNodeKind } from '../nodes/CustomDocNodeKind';
+import { MarkdownEmitter } from './MarkdownEmitter';
+export class CustomMarkdownEmitter extends MarkdownEmitter {
+    constructor(apiModel) {
+        super();
+        this._apiModel = apiModel;
+    }
+    emit(stringBuilder, docNode, options) {
+        return super.emit(stringBuilder, docNode, options);
+    }
+    /** @override */
+    writeNode(docNode, context, docNodeSiblings) {
+        const writer = context.writer;
+        switch (docNode.kind) {
+            case CustomDocNodeKind.Heading: {
+                const docHeading = docNode;
+                writer.ensureSkippedLine();
+                let prefix;
+                switch (docHeading.level) {
+                    case 1:
+                        prefix = '##';
+                        break;
+                    case 2:
+                        prefix = '###';
+                        break;
+                    case 3:
+                        prefix = '###';
+                        break;
+                    default:
+                        prefix = '####';
+                }
+                writer.writeLine(prefix + ' ' + this.getEscapedText(docHeading.title));
+                writer.writeLine();
+                break;
+            }
+            case CustomDocNodeKind.NoteBox: {
+                const docNoteBox = docNode;
+                writer.ensureNewLine();
+                writer.increaseIndent('> ');
+                this.writeNode(docNoteBox.content, context, false);
+                writer.ensureNewLine();
+                writer.decreaseIndent();
+                writer.writeLine();
+                break;
+            }
+            case CustomDocNodeKind.Table: {
+                const docTable = docNode;
+                // GitHub's markdown renderer chokes on tables that don't have a blank line above them,
+                // whereas VS Code's renderer is totally fine with it.
+                writer.ensureSkippedLine();
+                // Markdown table rows can have inconsistent cell counts.  Size the table based on the longest row.
+                let columnCount = 0;
+                if (docTable.header) {
+                    columnCount = docTable.header.cells.length;
+                }
+                for (const row of docTable.rows) {
+                    if (row.cells.length > columnCount) {
+                        columnCount = row.cells.length;
+                    }
+                }
+                writer.write('<table>');
+                if (docTable.header) {
+                    writer.write('<thead><tr>');
+                    for (let i = 0; i < columnCount; ++i) {
+                        writer.write('<th>');
+                        writer.ensureNewLine();
+                        writer.writeLine();
+                        const cell = docTable.header.cells[i];
+                        if (cell) {
+                            this.writeNode(cell.content, context, false);
+                        }
+                        writer.ensureNewLine();
+                        writer.writeLine();
+                        writer.write('</th>');
+                    }
+                    writer.write('</tr></thead>');
+                }
+                writer.writeLine();
+                writer.write('<tbody>');
+                for (const row of docTable.rows) {
+                    writer.write('<tr>');
+                    for (const cell of row.cells) {
+                        writer.write('<td>');
+                        writer.ensureNewLine();
+                        writer.writeLine();
+                        this.writeNode(cell.content, context, false);
+                        writer.ensureNewLine();
+                        writer.writeLine();
+                        writer.write('</td>');
+                    }
+                    writer.write('</tr>');
+                    writer.writeLine();
+                }
+                writer.write('</tbody>');
+                writer.write('</table>');
+                writer.ensureSkippedLine();
+                break;
+            }
+            case CustomDocNodeKind.EmphasisSpan: {
+                const docEmphasisSpan = docNode;
+                const oldBold = context.boldRequested;
+                const oldItalic = context.italicRequested;
+                context.boldRequested = docEmphasisSpan.bold;
+                context.italicRequested = docEmphasisSpan.italic;
+                this.writeNodes(docEmphasisSpan.nodes, context);
+                context.boldRequested = oldBold;
+                context.italicRequested = oldItalic;
+                break;
+            }
+            default:
+                super.writeNode(docNode, context, docNodeSiblings);
+        }
+    }
+    /** @override */
+    writeLinkTagWithCodeDestination(docLinkTag, context) {
+        const options = context.options;
+        const result = this._apiModel.resolveDeclarationReference(docLinkTag.codeDestination, options.contextApiItem);
+        if (result.resolvedApiItem) {
+            const filename = options.onGetFilenameForApiItem(result.resolvedApiItem);
+            if (filename) {
+                let linkText = docLinkTag.linkText || '';
+                if (linkText.length === 0) {
+                    // Generate a name such as Namespace1.Namespace2.MyClass.myMethod()
+                    linkText = result.resolvedApiItem.getScopedNameWithinPackage();
+                }
+                if (linkText.length > 0) {
+                    const encodedLinkText = this.getEscapedText(linkText.replace(/\s+/g, ' '));
+                    context.writer.write('[');
+                    context.writer.write(encodedLinkText);
+                    context.writer.write(`](${filename})`);
+                }
+                else {
+                    console.log(Colorize.yellow('WARNING: Unable to determine link text'));
+                }
+            }
+        }
+        else if (result.errorMessage) {
+            console.log(Colorize.yellow(`WARNING: Unable to resolve reference "${docLinkTag.codeDestination.emitAsTsdoc()}": ` +
+                result.errorMessage));
+        }
+    }
+}
+//# sourceMappingURL=CustomMarkdownEmitter.js.map

package/lib-esm/markdown/CustomMarkdownEmitter.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"CustomMarkdownEmitter.js","sourceRoot":"","sources":["../../src/markdown/CustomMarkdownEmitter.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAI3D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAM/D,OAAO,EACL,eAAe,EAGhB,MAAM,mBAAmB,CAAC;AAS3B,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAGxD,YAAmB,QAAkB;QACnC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,IAAI,CACT,aAA4B,EAC5B,OAAgB,EAChB,OAAsC;QAEtC,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACN,SAAS,CAAC,OAAgB,EAAE,OAAgC,EAAE,eAAwB;QAC9F,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC/B,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAE3B,IAAI,MAAc,CAAC;gBACnB,QAAQ,UAAU,CAAC,KAAK,EAAE,CAAC;oBACzB,KAAK,CAAC;wBACJ,MAAM,GAAG,IAAI,CAAC;wBACd,MAAM;oBACR,KAAK,CAAC;wBACJ,MAAM,GAAG,KAAK,CAAC;wBACf,MAAM;oBACR,KAAK,CAAC;wBACJ,MAAM,GAAG,KAAK,CAAC;wBACf,MAAM;oBACR;wBACE,MAAM,GAAG,MAAM,CAAC;gBACpB,CAAC;gBAED,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvE,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YACD,KAAK,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC/B,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,MAAM,CAAC,aAAa,EAAE,CAAC;gBAEvB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAE5B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBACnD,MAAM,CAAC,aAAa,EAAE,CAAC;gBAEvB,MAAM,CAAC,cAAc,EAAE,CAAC;gBAExB,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YACD,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7B,MAAM,QAAQ,GAAa,OAAmB,CAAC;gBAC/C,uFAAuF;gBACvF,sDAAsD;gBACtD,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAE3B,mGAAmG;gBACnG,IAAI,WAAW,GAAW,CAAC,CAAC;gBAC5B,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACpB,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;gBAC7C,CAAC;gBACD,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAChC,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;wBACnC,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;oBACjC,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACpB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;oBAC5B,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,EAAE,CAAC,EAAE,CAAC;wBAC7C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBACrB,MAAM,CAAC,aAAa,EAAE,CAAC;wBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;wBACnB,MAAM,IAAI,GAA6B,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAChE,IAAI,IAAI,EAAE,CAAC;4BACT,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;wBAC/C,CAAC;wBACD,MAAM,CAAC,aAAa,EAAE,CAAC;wBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;wBACnB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBACxB,CAAC;oBACD,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM,CAAC,SAAS,EAAE,CAAC;gBAEnB,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBACxB,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAChC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACrB,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;wBAC7B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBACrB,MAAM,CAAC,aAAa,EAAE,CAAC;wBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;wBACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;wBAC7C,MAAM,CAAC,aAAa,EAAE,CAAC;wBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;wBACnB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBACxB,CAAC;oBACD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBACtB,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBACzB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBACzB,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAE3B,MAAM;YACR,CAAC;YACD,KAAK,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;gBACpC,MAAM,eAAe,GAAoB,OAA0B,CAAC;gBACpE,MAAM,OAAO,GAAY,OAAO,CAAC,aAAa,CAAC;gBAC/C,MAAM,SAAS,GAAY,OAAO,CAAC,eAAe,CAAC;gBACnD,OAAO,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC;gBAC7C,OAAO,CAAC,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;gBACjD,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAChD,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC;gBAChC,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;gBACpC,MAAM;YACR,CAAC;YACD;gBACE,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,gBAAgB;IACN,+BAA+B,CACvC,UAAsB,EACtB,OAA+D;QAE/D,MAAM,OAAO,GAAkC,OAAO,CAAC,OAAO,CAAC;QAE/D,MAAM,MAAM,GAAuC,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAC3F,UAAU,CAAC,eAAgB,EAC3B,OAAO,CAAC,cAAc,CACvB,CAAC;QAEF,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAuB,OAAO,CAAC,uBAAuB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAE7F,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,QAAQ,GAAW,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC;gBACjD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC1B,mEAAmE;oBACnE,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,0BAA0B,EAAE,CAAC;gBACjE,CAAC;gBACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxB,MAAM,eAAe,GAAW,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;oBAEnF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;oBACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,QAAS,GAAG,CAAC,CAAC;gBAC1C,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,wCAAwC,CAAC,CAAC,CAAC;gBACzE,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,CACT,QAAQ,CAAC,MAAM,CACb,yCAAyC,UAAU,CAAC,eAAgB,CAAC,WAAW,EAAE,KAAK;gBACrF,MAAM,CAAC,YAAY,CACtB,CACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';\nimport type { ApiModel, IResolveDeclarationReferenceResult, ApiItem } from '@microsoft/api-extractor-model';\nimport { Colorize } from '@rushstack/terminal';\n\nimport { CustomDocNodeKind } from '../nodes/CustomDocNodeKind';\nimport type { DocHeading } from '../nodes/DocHeading';\nimport type { DocNoteBox } from '../nodes/DocNoteBox';\nimport type { DocTable } from '../nodes/DocTable';\nimport type { DocTableCell } from '../nodes/DocTableCell';\nimport type { DocEmphasisSpan } from '../nodes/DocEmphasisSpan';\nimport {\n MarkdownEmitter,\n type IMarkdownEmitterContext,\n type IMarkdownEmitterOptions\n} from './MarkdownEmitter';\nimport type { IndentedWriter } from '../utils/IndentedWriter';\n\nexport interface ICustomMarkdownEmitterOptions extends IMarkdownEmitterOptions {\n contextApiItem: ApiItem | undefined;\n\n onGetFilenameForApiItem: (apiItem: ApiItem) => string | undefined;\n}\n\nexport class CustomMarkdownEmitter extends MarkdownEmitter {\n private _apiModel: ApiModel;\n\n public constructor(apiModel: ApiModel) {\n super();\n\n this._apiModel = apiModel;\n }\n\n public emit(\n stringBuilder: StringBuilder,\n docNode: DocNode,\n options: ICustomMarkdownEmitterOptions\n ): string {\n return super.emit(stringBuilder, docNode, options);\n }\n\n /** @override */\n protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void {\n const writer: IndentedWriter = context.writer;\n\n switch (docNode.kind) {\n case CustomDocNodeKind.Heading: {\n const docHeading: DocHeading = docNode as DocHeading;\n writer.ensureSkippedLine();\n\n let prefix: string;\n switch (docHeading.level) {\n case 1:\n prefix = '##';\n break;\n case 2:\n prefix = '###';\n break;\n case 3:\n prefix = '###';\n break;\n default:\n prefix = '####';\n }\n\n writer.writeLine(prefix + ' ' + this.getEscapedText(docHeading.title));\n writer.writeLine();\n break;\n }\n case CustomDocNodeKind.NoteBox: {\n const docNoteBox: DocNoteBox = docNode as DocNoteBox;\n writer.ensureNewLine();\n\n writer.increaseIndent('> ');\n\n this.writeNode(docNoteBox.content, context, false);\n writer.ensureNewLine();\n\n writer.decreaseIndent();\n\n writer.writeLine();\n break;\n }\n case CustomDocNodeKind.Table: {\n const docTable: DocTable = docNode as DocTable;\n // GitHub's markdown renderer chokes on tables that don't have a blank line above them,\n // whereas VS Code's renderer is totally fine with it.\n writer.ensureSkippedLine();\n\n // Markdown table rows can have inconsistent cell counts. Size the table based on the longest row.\n let columnCount: number = 0;\n if (docTable.header) {\n columnCount = docTable.header.cells.length;\n }\n for (const row of docTable.rows) {\n if (row.cells.length > columnCount) {\n columnCount = row.cells.length;\n }\n }\n\n writer.write('<table>');\n if (docTable.header) {\n writer.write('<thead><tr>');\n for (let i: number = 0; i < columnCount; ++i) {\n writer.write('<th>');\n writer.ensureNewLine();\n writer.writeLine();\n const cell: DocTableCell | undefined = docTable.header.cells[i];\n if (cell) {\n this.writeNode(cell.content, context, false);\n }\n writer.ensureNewLine();\n writer.writeLine();\n writer.write('</th>');\n }\n writer.write('</tr></thead>');\n }\n writer.writeLine();\n\n writer.write('<tbody>');\n for (const row of docTable.rows) {\n writer.write('<tr>');\n for (const cell of row.cells) {\n writer.write('<td>');\n writer.ensureNewLine();\n writer.writeLine();\n this.writeNode(cell.content, context, false);\n writer.ensureNewLine();\n writer.writeLine();\n writer.write('</td>');\n }\n writer.write('</tr>');\n writer.writeLine();\n }\n writer.write('</tbody>');\n writer.write('</table>');\n writer.ensureSkippedLine();\n\n break;\n }\n case CustomDocNodeKind.EmphasisSpan: {\n const docEmphasisSpan: DocEmphasisSpan = docNode as DocEmphasisSpan;\n const oldBold: boolean = context.boldRequested;\n const oldItalic: boolean = context.italicRequested;\n context.boldRequested = docEmphasisSpan.bold;\n context.italicRequested = docEmphasisSpan.italic;\n this.writeNodes(docEmphasisSpan.nodes, context);\n context.boldRequested = oldBold;\n context.italicRequested = oldItalic;\n break;\n }\n default:\n super.writeNode(docNode, context, docNodeSiblings);\n }\n }\n\n /** @override */\n protected writeLinkTagWithCodeDestination(\n docLinkTag: DocLinkTag,\n context: IMarkdownEmitterContext<ICustomMarkdownEmitterOptions>\n ): void {\n const options: ICustomMarkdownEmitterOptions = context.options;\n\n const result: IResolveDeclarationReferenceResult = this._apiModel.resolveDeclarationReference(\n docLinkTag.codeDestination!,\n options.contextApiItem\n );\n\n if (result.resolvedApiItem) {\n const filename: string | undefined = options.onGetFilenameForApiItem(result.resolvedApiItem);\n\n if (filename) {\n let linkText: string = docLinkTag.linkText || '';\n if (linkText.length === 0) {\n // Generate a name such as Namespace1.Namespace2.MyClass.myMethod()\n linkText = result.resolvedApiItem.getScopedNameWithinPackage();\n }\n if (linkText.length > 0) {\n const encodedLinkText: string = this.getEscapedText(linkText.replace(/\\s+/g, ' '));\n\n context.writer.write('[');\n context.writer.write(encodedLinkText);\n context.writer.write(`](${filename!})`);\n } else {\n console.log(Colorize.yellow('WARNING: Unable to determine link text'));\n }\n }\n } else if (result.errorMessage) {\n console.log(\n Colorize.yellow(\n `WARNING: Unable to resolve reference \"${docLinkTag.codeDestination!.emitAsTsdoc()}\": ` +\n result.errorMessage\n )\n );\n }\n }\n}\n"]}

package/lib-esm/markdown/MarkdownEmitter.js ADDED Viewed

@@ -0,0 +1,190 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DocNodeKind, DocNodeTransforms } from '@microsoft/tsdoc';
+import { InternalError } from '@rushstack/node-core-library';
+import { IndentedWriter } from '../utils/IndentedWriter';
+/**
+ * Renders MarkupElement content in the Markdown file format.
+ * For more info:  https://en.wikipedia.org/wiki/Markdown
+ */
+export class MarkdownEmitter {
+    emit(stringBuilder, docNode, options) {
+        const writer = new IndentedWriter(stringBuilder);
+        const context = {
+            writer,
+            boldRequested: false,
+            italicRequested: false,
+            writingBold: false,
+            writingItalic: false,
+            options
+        };
+        this.writeNode(docNode, context, false);
+        writer.ensureNewLine(); // finish the last line
+        return writer.toString();
+    }
+    getEscapedText(text) {
+        const textWithBackslashes = text
+            .replace(/\\/g, '\\\\') // first replace the escape character
+            .replace(/[*#[\]_|`~]/g, (x) => '\\' + x) // then escape any special characters
+            .replace(/---/g, '\\-\\-\\-') // hyphens only if it's 3 or more
+            .replace(/&/g, '&amp;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;');
+        return textWithBackslashes;
+    }
+    getTableEscapedText(text) {
+        return text
+            .replace(/&/g, '&amp;')
+            .replace(/"/g, '&quot;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/\|/g, '&#124;');
+    }
+    /**
+     * @virtual
+     */
+    writeNode(docNode, context, docNodeSiblings) {
+        const writer = context.writer;
+        switch (docNode.kind) {
+            case DocNodeKind.PlainText: {
+                const docPlainText = docNode;
+                this.writePlainText(docPlainText.text, context);
+                break;
+            }
+            case DocNodeKind.HtmlStartTag:
+            case DocNodeKind.HtmlEndTag: {
+                const docHtmlTag = docNode;
+                // write the HTML element verbatim into the output
+                writer.write(docHtmlTag.emitAsHtml());
+                break;
+            }
+            case DocNodeKind.CodeSpan: {
+                const docCodeSpan = docNode;
+                writer.write('`');
+                writer.write(docCodeSpan.code);
+                writer.write('`');
+                break;
+            }
+            case DocNodeKind.LinkTag: {
+                const docLinkTag = docNode;
+                if (docLinkTag.codeDestination) {
+                    this.writeLinkTagWithCodeDestination(docLinkTag, context);
+                }
+                else if (docLinkTag.urlDestination) {
+                    this.writeLinkTagWithUrlDestination(docLinkTag, context);
+                }
+                else if (docLinkTag.linkText) {
+                    this.writePlainText(docLinkTag.linkText, context);
+                }
+                break;
+            }
+            case DocNodeKind.Paragraph: {
+                const docParagraph = docNode;
+                const trimmedParagraph = DocNodeTransforms.trimSpacesInParagraph(docParagraph);
+                this.writeNodes(trimmedParagraph.nodes, context);
+                writer.ensureNewLine();
+                writer.writeLine();
+                break;
+            }
+            case DocNodeKind.FencedCode: {
+                const docFencedCode = docNode;
+                writer.ensureNewLine();
+                writer.write('```');
+                writer.write(docFencedCode.language);
+                writer.writeLine();
+                writer.write(docFencedCode.code);
+                writer.ensureNewLine();
+                writer.writeLine('```');
+                break;
+            }
+            case DocNodeKind.Section: {
+                const docSection = docNode;
+                this.writeNodes(docSection.nodes, context);
+                break;
+            }
+            case DocNodeKind.SoftBreak: {
+                if (!/^\s?$/.test(writer.peekLastCharacter())) {
+                    writer.write(' ');
+                }
+                break;
+            }
+            case DocNodeKind.EscapedText: {
+                const docEscapedText = docNode;
+                this.writePlainText(docEscapedText.decodedText, context);
+                break;
+            }
+            case DocNodeKind.ErrorText: {
+                const docErrorText = docNode;
+                this.writePlainText(docErrorText.text, context);
+                break;
+            }
+            case DocNodeKind.InlineTag: {
+                break;
+            }
+            case DocNodeKind.BlockTag: {
+                const tagNode = docNode;
+                console.warn('Unsupported block tag: ' + tagNode.tagName);
+                break;
+            }
+            default:
+                throw new InternalError('Unsupported DocNodeKind kind: ' + docNode.kind);
+        }
+    }
+    /** @virtual */
+    writeLinkTagWithCodeDestination(docLinkTag, context) {
+        // The subclass needs to implement this to support code destinations
+        throw new InternalError('writeLinkTagWithCodeDestination()');
+    }
+    /** @virtual */
+    writeLinkTagWithUrlDestination(docLinkTag, context) {
+        const linkText = docLinkTag.linkText !== undefined ? docLinkTag.linkText : docLinkTag.urlDestination;
+        const encodedLinkText = this.getEscapedText(linkText.replace(/\s+/g, ' '));
+        context.writer.write('[');
+        context.writer.write(encodedLinkText);
+        context.writer.write(`](${docLinkTag.urlDestination})`);
+    }
+    writePlainText(text, context) {
+        const writer = context.writer;
+        // split out the [ leading whitespace, content, trailing whitespace ]
+        const parts = text.match(/^(\s*)(.*?)(\s*)$/) || [];
+        writer.write(parts[1]); // write leading whitespace
+        const middle = parts[2];
+        if (middle !== '') {
+            switch (writer.peekLastCharacter()) {
+                case '':
+                case '\n':
+                case ' ':
+                case '[':
+                case '>':
+                    // okay to put a symbol
+                    break;
+                default:
+                    // This is no problem:        "**one** *two* **three**"
+                    // But this is trouble:       "**one***two***three**"
+                    // The most general solution: "**one**<!-- -->*two*<!-- -->**three**"
+                    writer.write('<!-- -->');
+                    break;
+            }
+            if (context.boldRequested) {
+                writer.write('**');
+            }
+            if (context.italicRequested) {
+                writer.write('_');
+            }
+            writer.write(this.getEscapedText(middle));
+            if (context.italicRequested) {
+                writer.write('_');
+            }
+            if (context.boldRequested) {
+                writer.write('**');
+            }
+        }
+        writer.write(parts[3]); // write trailing whitespace
+    }
+    writeNodes(docNodes, context) {
+        for (const docNode of docNodes) {
+            this.writeNode(docNode, context, docNodes.length > 1);
+        }
+    }
+}
+//# sourceMappingURL=MarkdownEmitter.js.map

package/lib-esm/markdown/MarkdownEmitter.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"MarkdownEmitter.js","sourceRoot":"","sources":["../../src/markdown/MarkdownEmitter.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAEL,WAAW,EAUX,iBAAiB,EAIlB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAgBzD;;;GAGG;AACH,MAAM,OAAO,eAAe;IACnB,IAAI,CAAC,aAA4B,EAAE,OAAgB,EAAE,OAAgC;QAC1F,MAAM,MAAM,GAAmB,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC;QAEjE,MAAM,OAAO,GAA4B;YACvC,MAAM;YAEN,aAAa,EAAE,KAAK;YACpB,eAAe,EAAE,KAAK;YAEtB,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,KAAK;YAEpB,OAAO;SACR,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAExC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,uBAAuB;QAE/C,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAES,cAAc,CAAC,IAAY;QACnC,MAAM,mBAAmB,GAAW,IAAI;aACrC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,qCAAqC;aAC5D,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,qCAAqC;aAC9E,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,iCAAiC;aAC9D,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAES,mBAAmB,CAAC,IAAY;QACxC,OAAO,IAAI;aACR,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aACvB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,OAAgB,EAAE,OAAgC,EAAE,eAAwB;QAC9F,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,YAAY,CAAC;YAC9B,KAAK,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC5B,MAAM,UAAU,GAAoC,OAA0C,CAAC;gBAC/F,kDAAkD;gBAClD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC1B,MAAM,WAAW,GAAgB,OAAsB,CAAC;gBACxD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACzB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC;oBAC/B,IAAI,CAAC,+BAA+B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC5D,CAAC;qBAAM,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;oBACrC,IAAI,CAAC,8BAA8B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC3D,CAAC;qBAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,MAAM,gBAAgB,GAAiB,iBAAiB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;gBAE7F,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBACjD,MAAM,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC5B,MAAM,aAAa,GAAkB,OAAwB,CAAC;gBAC9D,MAAM,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBACrC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACxB,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACzB,MAAM,UAAU,GAAe,OAAqB,CAAC;gBACrD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;oBAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7B,MAAM,cAAc,GAAmB,OAAyB,CAAC;gBACjE,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM,YAAY,GAAiB,OAAuB,CAAC;gBAC3D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3B,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC1B,MAAM,OAAO,GAAgB,OAAsB,CAAC;gBACpD,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC1D,MAAM;YACR,CAAC;YACD;gBACE,MAAM,IAAI,aAAa,CAAC,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAED,eAAe;IACL,+BAA+B,CAAC,UAAsB,EAAE,OAAgC;QAChG,oEAAoE;QACpE,MAAM,IAAI,aAAa,CAAC,mCAAmC,CAAC,CAAC;IAC/D,CAAC;IAED,eAAe;IACL,8BAA8B,CAAC,UAAsB,EAAE,OAAgC;QAC/F,MAAM,QAAQ,GACZ,UAAU,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,cAAe,CAAC;QAEvF,MAAM,eAAe,GAAW,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAEnF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,cAAe,GAAG,CAAC,CAAC;IAC3D,CAAC;IAES,cAAc,CAAC,IAAY,EAAE,OAAgC;QACrE,MAAM,MAAM,GAAmB,OAAO,CAAC,MAAM,CAAC;QAE9C,qEAAqE;QACrE,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;QAE9D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,2BAA2B;QAEnD,MAAM,MAAM,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;QAEhC,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;YAClB,QAAQ,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBACnC,KAAK,EAAE,CAAC;gBACR,KAAK,IAAI,CAAC;gBACV,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG;oBACN,uBAAuB;oBACvB,MAAM;gBACR;oBACE,uDAAuD;oBACvD,qDAAqD;oBACrD,qEAAqE;oBACrE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACzB,MAAM;YACV,CAAC;YAED,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC1B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;YACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;YAE1C,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YACD,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC1B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,4BAA4B;IACtD,CAAC;IAES,UAAU,CAAC,QAAgC,EAAE,OAAgC;QACrF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport {\n type DocNode,\n DocNodeKind,\n type StringBuilder,\n type DocPlainText,\n type DocHtmlStartTag,\n type DocHtmlEndTag,\n type DocCodeSpan,\n type DocLinkTag,\n type DocParagraph,\n type DocFencedCode,\n type DocSection,\n DocNodeTransforms,\n type DocEscapedText,\n type DocErrorText,\n type DocBlockTag\n} from '@microsoft/tsdoc';\nimport { InternalError } from '@rushstack/node-core-library';\n\nimport { IndentedWriter } from '../utils/IndentedWriter';\n\nexport interface IMarkdownEmitterOptions {}\n\nexport interface IMarkdownEmitterContext<TOptions = IMarkdownEmitterOptions> {\n writer: IndentedWriter;\n\n boldRequested: boolean;\n italicRequested: boolean;\n\n writingBold: boolean;\n writingItalic: boolean;\n\n options: TOptions;\n}\n\n/**\n * Renders MarkupElement content in the Markdown file format.\n * For more info: https://en.wikipedia.org/wiki/Markdown\n */\nexport class MarkdownEmitter {\n public emit(stringBuilder: StringBuilder, docNode: DocNode, options: IMarkdownEmitterOptions): string {\n const writer: IndentedWriter = new IndentedWriter(stringBuilder);\n\n const context: IMarkdownEmitterContext = {\n writer,\n\n boldRequested: false,\n italicRequested: false,\n\n writingBold: false,\n writingItalic: false,\n\n options\n };\n\n this.writeNode(docNode, context, false);\n\n writer.ensureNewLine(); // finish the last line\n\n return writer.toString();\n }\n\n protected getEscapedText(text: string): string {\n const textWithBackslashes: string = text\n .replace(/\\\\/g, '\\\\\\\\') // first replace the escape character\n .replace(/[*#[\\]_|`~]/g, (x) => '\\\\' + x) // then escape any special characters\n .replace(/---/g, '\\\\-\\\\-\\\\-') // hyphens only if it's 3 or more\n .replace(/&/g, '&')\n .replace(/</g, '<')\n .replace(/>/g, '>');\n return textWithBackslashes;\n }\n\n protected getTableEscapedText(text: string): string {\n return text\n .replace(/&/g, '&')\n .replace(/\"/g, '"')\n .replace(/</g, '<')\n .replace(/>/g, '>')\n .replace(/\\|/g, '|');\n }\n\n /**\n * @virtual\n */\n protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void {\n const writer: IndentedWriter = context.writer;\n\n switch (docNode.kind) {\n case DocNodeKind.PlainText: {\n const docPlainText: DocPlainText = docNode as DocPlainText;\n this.writePlainText(docPlainText.text, context);\n break;\n }\n case DocNodeKind.HtmlStartTag:\n case DocNodeKind.HtmlEndTag: {\n const docHtmlTag: DocHtmlStartTag | DocHtmlEndTag = docNode as DocHtmlStartTag | DocHtmlEndTag;\n // write the HTML element verbatim into the output\n writer.write(docHtmlTag.emitAsHtml());\n break;\n }\n case DocNodeKind.CodeSpan: {\n const docCodeSpan: DocCodeSpan = docNode as DocCodeSpan;\n writer.write('`');\n writer.write(docCodeSpan.code);\n writer.write('`');\n break;\n }\n case DocNodeKind.LinkTag: {\n const docLinkTag: DocLinkTag = docNode as DocLinkTag;\n if (docLinkTag.codeDestination) {\n this.writeLinkTagWithCodeDestination(docLinkTag, context);\n } else if (docLinkTag.urlDestination) {\n this.writeLinkTagWithUrlDestination(docLinkTag, context);\n } else if (docLinkTag.linkText) {\n this.writePlainText(docLinkTag.linkText, context);\n }\n break;\n }\n case DocNodeKind.Paragraph: {\n const docParagraph: DocParagraph = docNode as DocParagraph;\n const trimmedParagraph: DocParagraph = DocNodeTransforms.trimSpacesInParagraph(docParagraph);\n\n this.writeNodes(trimmedParagraph.nodes, context);\n writer.ensureNewLine();\n writer.writeLine();\n break;\n }\n case DocNodeKind.FencedCode: {\n const docFencedCode: DocFencedCode = docNode as DocFencedCode;\n writer.ensureNewLine();\n writer.write('```');\n writer.write(docFencedCode.language);\n writer.writeLine();\n writer.write(docFencedCode.code);\n writer.ensureNewLine();\n writer.writeLine('```');\n break;\n }\n case DocNodeKind.Section: {\n const docSection: DocSection = docNode as DocSection;\n this.writeNodes(docSection.nodes, context);\n break;\n }\n case DocNodeKind.SoftBreak: {\n if (!/^\\s?$/.test(writer.peekLastCharacter())) {\n writer.write(' ');\n }\n break;\n }\n case DocNodeKind.EscapedText: {\n const docEscapedText: DocEscapedText = docNode as DocEscapedText;\n this.writePlainText(docEscapedText.decodedText, context);\n break;\n }\n case DocNodeKind.ErrorText: {\n const docErrorText: DocErrorText = docNode as DocErrorText;\n this.writePlainText(docErrorText.text, context);\n break;\n }\n case DocNodeKind.InlineTag: {\n break;\n }\n case DocNodeKind.BlockTag: {\n const tagNode: DocBlockTag = docNode as DocBlockTag;\n console.warn('Unsupported block tag: ' + tagNode.tagName);\n break;\n }\n default:\n throw new InternalError('Unsupported DocNodeKind kind: ' + docNode.kind);\n }\n }\n\n /** @virtual */\n protected writeLinkTagWithCodeDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void {\n // The subclass needs to implement this to support code destinations\n throw new InternalError('writeLinkTagWithCodeDestination()');\n }\n\n /** @virtual */\n protected writeLinkTagWithUrlDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void {\n const linkText: string =\n docLinkTag.linkText !== undefined ? docLinkTag.linkText : docLinkTag.urlDestination!;\n\n const encodedLinkText: string = this.getEscapedText(linkText.replace(/\\s+/g, ' '));\n\n context.writer.write('[');\n context.writer.write(encodedLinkText);\n context.writer.write(`](${docLinkTag.urlDestination!})`);\n }\n\n protected writePlainText(text: string, context: IMarkdownEmitterContext): void {\n const writer: IndentedWriter = context.writer;\n\n // split out the [ leading whitespace, content, trailing whitespace ]\n const parts: string[] = text.match(/^(\\s*)(.*?)(\\s*)$/) || [];\n\n writer.write(parts[1]); // write leading whitespace\n\n const middle: string = parts[2];\n\n if (middle !== '') {\n switch (writer.peekLastCharacter()) {\n case '':\n case '\\n':\n case ' ':\n case '[':\n case '>':\n // okay to put a symbol\n break;\n default:\n // This is no problem: \"**one** *two* **three**\"\n // But this is trouble: \"**one***two***three**\"\n // The most general solution: \"**one***two***three**\"\n writer.write('');\n break;\n }\n\n if (context.boldRequested) {\n writer.write('**');\n }\n if (context.italicRequested) {\n writer.write('_');\n }\n\n writer.write(this.getEscapedText(middle));\n\n if (context.italicRequested) {\n writer.write('_');\n }\n if (context.boldRequested) {\n writer.write('**');\n }\n }\n\n writer.write(parts[3]); // write trailing whitespace\n }\n\n protected writeNodes(docNodes: ReadonlyArray<DocNode>, context: IMarkdownEmitterContext): void {\n for (const docNode of docNodes) {\n this.writeNode(docNode, context, docNodes.length > 1);\n }\n }\n}\n"]}

package/lib-esm/nodes/CustomDocNodeKind.js ADDED Viewed

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TSDocConfiguration, DocNodeKind } from '@microsoft/tsdoc';
+import { DocEmphasisSpan } from './DocEmphasisSpan';
+import { DocHeading } from './DocHeading';
+import { DocNoteBox } from './DocNoteBox';
+import { DocTable } from './DocTable';
+import { DocTableCell } from './DocTableCell';
+import { DocTableRow } from './DocTableRow';
+/**
+ * Identifies custom subclasses of {@link DocNode}.
+ */
+export var CustomDocNodeKind;
+(function (CustomDocNodeKind) {
+    CustomDocNodeKind["EmphasisSpan"] = "EmphasisSpan";
+    CustomDocNodeKind["Heading"] = "Heading";
+    CustomDocNodeKind["NoteBox"] = "NoteBox";
+    CustomDocNodeKind["Table"] = "Table";
+    CustomDocNodeKind["TableCell"] = "TableCell";
+    CustomDocNodeKind["TableRow"] = "TableRow";
+})(CustomDocNodeKind || (CustomDocNodeKind = {}));
+export class CustomDocNodes {
+    static get configuration() {
+        if (CustomDocNodes._configuration === undefined) {
+            const configuration = new TSDocConfiguration();
+            configuration.docNodeManager.registerDocNodes('@micrososft/api-documenter', [
+                { docNodeKind: CustomDocNodeKind.EmphasisSpan, constructor: DocEmphasisSpan },
+                { docNodeKind: CustomDocNodeKind.Heading, constructor: DocHeading },
+                { docNodeKind: CustomDocNodeKind.NoteBox, constructor: DocNoteBox },
+                { docNodeKind: CustomDocNodeKind.Table, constructor: DocTable },
+                { docNodeKind: CustomDocNodeKind.TableCell, constructor: DocTableCell },
+                { docNodeKind: CustomDocNodeKind.TableRow, constructor: DocTableRow }
+            ]);
+            configuration.docNodeManager.registerAllowableChildren(CustomDocNodeKind.EmphasisSpan, [
+                DocNodeKind.PlainText,
+                DocNodeKind.SoftBreak
+            ]);
+            configuration.docNodeManager.registerAllowableChildren(DocNodeKind.Section, [
+                CustomDocNodeKind.Heading,
+                CustomDocNodeKind.NoteBox,
+                CustomDocNodeKind.Table
+            ]);
+            configuration.docNodeManager.registerAllowableChildren(DocNodeKind.Paragraph, [
+                CustomDocNodeKind.EmphasisSpan
+            ]);
+            CustomDocNodes._configuration = configuration;
+        }
+        return CustomDocNodes._configuration;
+    }
+}
+//# sourceMappingURL=CustomDocNodeKind.js.map

package/lib-esm/nodes/CustomDocNodeKind.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"CustomDocNodeKind.js","sourceRoot":"","sources":["../../src/nodes/CustomDocNodeKind.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,wCAAmB,CAAA;IACnB,wCAAmB,CAAA;IACnB,oCAAe,CAAA;IACf,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;AACvB,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAED,MAAM,OAAO,cAAc;IAGlB,MAAM,KAAK,aAAa;QAC7B,IAAI,cAAc,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAChD,MAAM,aAAa,GAAuB,IAAI,kBAAkB,EAAE,CAAC;YAEnE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,4BAA4B,EAAE;gBAC1E,EAAE,WAAW,EAAE,iBAAiB,CAAC,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE;gBAC7E,EAAE,WAAW,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE;gBACnE,EAAE,WAAW,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE;gBACnE,EAAE,WAAW,EAAE,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE;gBAC/D,EAAE,WAAW,EAAE,iBAAiB,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE;gBACvE,EAAE,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE;aACtE,CAAC,CAAC;YAEH,aAAa,CAAC,cAAc,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,YAAY,EAAE;gBACrF,WAAW,CAAC,SAAS;gBACrB,WAAW,CAAC,SAAS;aACtB,CAAC,CAAC;YAEH,aAAa,CAAC,cAAc,CAAC,yBAAyB,CAAC,WAAW,CAAC,OAAO,EAAE;gBAC1E,iBAAiB,CAAC,OAAO;gBACzB,iBAAiB,CAAC,OAAO;gBACzB,iBAAiB,CAAC,KAAK;aACxB,CAAC,CAAC;YAEH,aAAa,CAAC,cAAc,CAAC,yBAAyB,CAAC,WAAW,CAAC,SAAS,EAAE;gBAC5E,iBAAiB,CAAC,YAAY;aAC/B,CAAC,CAAC;YAEH,cAAc,CAAC,cAAc,GAAG,aAAa,CAAC;QAChD,CAAC;QACD,OAAO,cAAc,CAAC,cAAc,CAAC;IACvC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { TSDocConfiguration, DocNodeKind } from '@microsoft/tsdoc';\n\nimport { DocEmphasisSpan } from './DocEmphasisSpan';\nimport { DocHeading } from './DocHeading';\nimport { DocNoteBox } from './DocNoteBox';\nimport { DocTable } from './DocTable';\nimport { DocTableCell } from './DocTableCell';\nimport { DocTableRow } from './DocTableRow';\n\n/**\n * Identifies custom subclasses of {@link DocNode}.\n */\nexport enum CustomDocNodeKind {\n EmphasisSpan = 'EmphasisSpan',\n Heading = 'Heading',\n NoteBox = 'NoteBox',\n Table = 'Table',\n TableCell = 'TableCell',\n TableRow = 'TableRow'\n}\n\nexport class CustomDocNodes {\n private static _configuration: TSDocConfiguration | undefined;\n\n public static get configuration(): TSDocConfiguration {\n if (CustomDocNodes._configuration === undefined) {\n const configuration: TSDocConfiguration = new TSDocConfiguration();\n\n configuration.docNodeManager.registerDocNodes('@micrososft/api-documenter', [\n { docNodeKind: CustomDocNodeKind.EmphasisSpan, constructor: DocEmphasisSpan },\n { docNodeKind: CustomDocNodeKind.Heading, constructor: DocHeading },\n { docNodeKind: CustomDocNodeKind.NoteBox, constructor: DocNoteBox },\n { docNodeKind: CustomDocNodeKind.Table, constructor: DocTable },\n { docNodeKind: CustomDocNodeKind.TableCell, constructor: DocTableCell },\n { docNodeKind: CustomDocNodeKind.TableRow, constructor: DocTableRow }\n ]);\n\n configuration.docNodeManager.registerAllowableChildren(CustomDocNodeKind.EmphasisSpan, [\n DocNodeKind.PlainText,\n DocNodeKind.SoftBreak\n ]);\n\n configuration.docNodeManager.registerAllowableChildren(DocNodeKind.Section, [\n CustomDocNodeKind.Heading,\n CustomDocNodeKind.NoteBox,\n CustomDocNodeKind.Table\n ]);\n\n configuration.docNodeManager.registerAllowableChildren(DocNodeKind.Paragraph, [\n CustomDocNodeKind.EmphasisSpan\n ]);\n\n CustomDocNodes._configuration = configuration;\n }\n return CustomDocNodes._configuration;\n }\n}\n"]}