shadow-css.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. /*
  2. Stencil Client Platform v2.18.1 | MIT Licensed | https://stenciljs.com
  3. */
  4. /**
  5. * @license
  6. * Copyright Google Inc. All Rights Reserved.
  7. *
  8. * Use of this source code is governed by an MIT-style license that can be
  9. * found in the LICENSE file at https://angular.io/license
  10. *
  11. * This file is a port of shadowCSS from webcomponents.js to TypeScript.
  12. * https://github.com/webcomponents/webcomponentsjs/blob/4efecd7e0e/src/ShadowCSS/ShadowCSS.js
  13. * https://github.com/angular/angular/blob/master/packages/compiler/src/shadow_css.ts
  14. */
  15. const safeSelector = (selector) => {
  16. const placeholders = [];
  17. let index = 0;
  18. // Replaces attribute selectors with placeholders.
  19. // The WS in [attr="va lue"] would otherwise be interpreted as a selector separator.
  20. selector = selector.replace(/(\[[^\]]*\])/g, (_, keep) => {
  21. const replaceBy = `__ph-${index}__`;
  22. placeholders.push(keep);
  23. index++;
  24. return replaceBy;
  25. });
  26. // Replaces the expression in `:nth-child(2n + 1)` with a placeholder.
  27. // WS and "+" would otherwise be interpreted as selector separators.
  28. const content = selector.replace(/(:nth-[-\w]+)(\([^)]+\))/g, (_, pseudo, exp) => {
  29. const replaceBy = `__ph-${index}__`;
  30. placeholders.push(exp);
  31. index++;
  32. return pseudo + replaceBy;
  33. });
  34. const ss = {
  35. content,
  36. placeholders,
  37. };
  38. return ss;
  39. };
  40. const restoreSafeSelector = (placeholders, content) => {
  41. return content.replace(/__ph-(\d+)__/g, (_, index) => placeholders[+index]);
  42. };
  43. const _polyfillHost = '-shadowcsshost';
  44. const _polyfillSlotted = '-shadowcssslotted';
  45. // note: :host-context pre-processed to -shadowcsshostcontext.
  46. const _polyfillHostContext = '-shadowcsscontext';
  47. const _parenSuffix = ')(?:\\((' + '(?:\\([^)(]*\\)|[^)(]*)+?' + ')\\))?([^,{]*)';
  48. const _cssColonHostRe = new RegExp('(' + _polyfillHost + _parenSuffix, 'gim');
  49. const _cssColonHostContextRe = new RegExp('(' + _polyfillHostContext + _parenSuffix, 'gim');
  50. const _cssColonSlottedRe = new RegExp('(' + _polyfillSlotted + _parenSuffix, 'gim');
  51. const _polyfillHostNoCombinator = _polyfillHost + '-no-combinator';
  52. const _polyfillHostNoCombinatorRe = /-shadowcsshost-no-combinator([^\s]*)/;
  53. const _shadowDOMSelectorsRe = [/::shadow/g, /::content/g];
  54. const _selectorReSuffix = '([>\\s~+[.,{:][\\s\\S]*)?$';
  55. const _polyfillHostRe = /-shadowcsshost/gim;
  56. const _colonHostRe = /:host/gim;
  57. const _colonSlottedRe = /::slotted/gim;
  58. const _colonHostContextRe = /:host-context/gim;
  59. const _commentRe = /\/\*\s*[\s\S]*?\*\//g;
  60. const stripComments = (input) => {
  61. return input.replace(_commentRe, '');
  62. };
  63. const _commentWithHashRe = /\/\*\s*#\s*source(Mapping)?URL=[\s\S]+?\*\//g;
  64. const extractCommentsWithHash = (input) => {
  65. return input.match(_commentWithHashRe) || [];
  66. };
  67. const _ruleRe = /(\s*)([^;\{\}]+?)(\s*)((?:{%BLOCK%}?\s*;?)|(?:\s*;))/g;
  68. const _curlyRe = /([{}])/g;
  69. const _selectorPartsRe = /(^.*?[^\\])??((:+)(.*)|$)/;
  70. const OPEN_CURLY = '{';
  71. const CLOSE_CURLY = '}';
  72. const BLOCK_PLACEHOLDER = '%BLOCK%';
  73. const processRules = (input, ruleCallback) => {
  74. const inputWithEscapedBlocks = escapeBlocks(input);
  75. let nextBlockIndex = 0;
  76. return inputWithEscapedBlocks.escapedString.replace(_ruleRe, (...m) => {
  77. const selector = m[2];
  78. let content = '';
  79. let suffix = m[4];
  80. let contentPrefix = '';
  81. if (suffix && suffix.startsWith('{' + BLOCK_PLACEHOLDER)) {
  82. content = inputWithEscapedBlocks.blocks[nextBlockIndex++];
  83. suffix = suffix.substring(BLOCK_PLACEHOLDER.length + 1);
  84. contentPrefix = '{';
  85. }
  86. const cssRule = {
  87. selector,
  88. content,
  89. };
  90. const rule = ruleCallback(cssRule);
  91. return `${m[1]}${rule.selector}${m[3]}${contentPrefix}${rule.content}${suffix}`;
  92. });
  93. };
  94. const escapeBlocks = (input) => {
  95. const inputParts = input.split(_curlyRe);
  96. const resultParts = [];
  97. const escapedBlocks = [];
  98. let bracketCount = 0;
  99. let currentBlockParts = [];
  100. for (let partIndex = 0; partIndex < inputParts.length; partIndex++) {
  101. const part = inputParts[partIndex];
  102. if (part === CLOSE_CURLY) {
  103. bracketCount--;
  104. }
  105. if (bracketCount > 0) {
  106. currentBlockParts.push(part);
  107. }
  108. else {
  109. if (currentBlockParts.length > 0) {
  110. escapedBlocks.push(currentBlockParts.join(''));
  111. resultParts.push(BLOCK_PLACEHOLDER);
  112. currentBlockParts = [];
  113. }
  114. resultParts.push(part);
  115. }
  116. if (part === OPEN_CURLY) {
  117. bracketCount++;
  118. }
  119. }
  120. if (currentBlockParts.length > 0) {
  121. escapedBlocks.push(currentBlockParts.join(''));
  122. resultParts.push(BLOCK_PLACEHOLDER);
  123. }
  124. const strEscapedBlocks = {
  125. escapedString: resultParts.join(''),
  126. blocks: escapedBlocks,
  127. };
  128. return strEscapedBlocks;
  129. };
  130. const insertPolyfillHostInCssText = (selector) => {
  131. selector = selector
  132. .replace(_colonHostContextRe, _polyfillHostContext)
  133. .replace(_colonHostRe, _polyfillHost)
  134. .replace(_colonSlottedRe, _polyfillSlotted);
  135. return selector;
  136. };
  137. const convertColonRule = (cssText, regExp, partReplacer) => {
  138. // m[1] = :host(-context), m[2] = contents of (), m[3] rest of rule
  139. return cssText.replace(regExp, (...m) => {
  140. if (m[2]) {
  141. const parts = m[2].split(',');
  142. const r = [];
  143. for (let i = 0; i < parts.length; i++) {
  144. const p = parts[i].trim();
  145. if (!p)
  146. break;
  147. r.push(partReplacer(_polyfillHostNoCombinator, p, m[3]));
  148. }
  149. return r.join(',');
  150. }
  151. else {
  152. return _polyfillHostNoCombinator + m[3];
  153. }
  154. });
  155. };
  156. const colonHostPartReplacer = (host, part, suffix) => {
  157. return host + part.replace(_polyfillHost, '') + suffix;
  158. };
  159. const convertColonHost = (cssText) => {
  160. return convertColonRule(cssText, _cssColonHostRe, colonHostPartReplacer);
  161. };
  162. const colonHostContextPartReplacer = (host, part, suffix) => {
  163. if (part.indexOf(_polyfillHost) > -1) {
  164. return colonHostPartReplacer(host, part, suffix);
  165. }
  166. else {
  167. return host + part + suffix + ', ' + part + ' ' + host + suffix;
  168. }
  169. };
  170. const convertColonSlotted = (cssText, slotScopeId) => {
  171. const slotClass = '.' + slotScopeId + ' > ';
  172. const selectors = [];
  173. cssText = cssText.replace(_cssColonSlottedRe, (...m) => {
  174. if (m[2]) {
  175. const compound = m[2].trim();
  176. const suffix = m[3];
  177. const slottedSelector = slotClass + compound + suffix;
  178. let prefixSelector = '';
  179. for (let i = m[4] - 1; i >= 0; i--) {
  180. const char = m[5][i];
  181. if (char === '}' || char === ',') {
  182. break;
  183. }
  184. prefixSelector = char + prefixSelector;
  185. }
  186. const orgSelector = prefixSelector + slottedSelector;
  187. const addedSelector = `${prefixSelector.trimRight()}${slottedSelector.trim()}`;
  188. if (orgSelector.trim() !== addedSelector.trim()) {
  189. const updatedSelector = `${addedSelector}, ${orgSelector}`;
  190. selectors.push({
  191. orgSelector,
  192. updatedSelector,
  193. });
  194. }
  195. return slottedSelector;
  196. }
  197. else {
  198. return _polyfillHostNoCombinator + m[3];
  199. }
  200. });
  201. return {
  202. selectors,
  203. cssText,
  204. };
  205. };
  206. const convertColonHostContext = (cssText) => {
  207. return convertColonRule(cssText, _cssColonHostContextRe, colonHostContextPartReplacer);
  208. };
  209. const convertShadowDOMSelectors = (cssText) => {
  210. return _shadowDOMSelectorsRe.reduce((result, pattern) => result.replace(pattern, ' '), cssText);
  211. };
  212. const makeScopeMatcher = (scopeSelector) => {
  213. const lre = /\[/g;
  214. const rre = /\]/g;
  215. scopeSelector = scopeSelector.replace(lre, '\\[').replace(rre, '\\]');
  216. return new RegExp('^(' + scopeSelector + ')' + _selectorReSuffix, 'm');
  217. };
  218. const selectorNeedsScoping = (selector, scopeSelector) => {
  219. const re = makeScopeMatcher(scopeSelector);
  220. return !re.test(selector);
  221. };
  222. const injectScopingSelector = (selector, scopingSelector) => {
  223. return selector.replace(_selectorPartsRe, (_, before = '', _colonGroup, colon = '', after = '') => {
  224. return before + scopingSelector + colon + after;
  225. });
  226. };
  227. const applySimpleSelectorScope = (selector, scopeSelector, hostSelector) => {
  228. // In Android browser, the lastIndex is not reset when the regex is used in String.replace()
  229. _polyfillHostRe.lastIndex = 0;
  230. if (_polyfillHostRe.test(selector)) {
  231. const replaceBy = `.${hostSelector}`;
  232. return selector
  233. .replace(_polyfillHostNoCombinatorRe, (_, selector) => injectScopingSelector(selector, replaceBy))
  234. .replace(_polyfillHostRe, replaceBy + ' ');
  235. }
  236. return scopeSelector + ' ' + selector;
  237. };
  238. const applyStrictSelectorScope = (selector, scopeSelector, hostSelector) => {
  239. const isRe = /\[is=([^\]]*)\]/g;
  240. scopeSelector = scopeSelector.replace(isRe, (_, ...parts) => parts[0]);
  241. const className = '.' + scopeSelector;
  242. const _scopeSelectorPart = (p) => {
  243. let scopedP = p.trim();
  244. if (!scopedP) {
  245. return '';
  246. }
  247. if (p.indexOf(_polyfillHostNoCombinator) > -1) {
  248. scopedP = applySimpleSelectorScope(p, scopeSelector, hostSelector);
  249. }
  250. else {
  251. // remove :host since it should be unnecessary
  252. const t = p.replace(_polyfillHostRe, '');
  253. if (t.length > 0) {
  254. scopedP = injectScopingSelector(t, className);
  255. }
  256. }
  257. return scopedP;
  258. };
  259. const safeContent = safeSelector(selector);
  260. selector = safeContent.content;
  261. let scopedSelector = '';
  262. let startIndex = 0;
  263. let res;
  264. const sep = /( |>|\+|~(?!=))\s*/g;
  265. // If a selector appears before :host it should not be shimmed as it
  266. // matches on ancestor elements and not on elements in the host's shadow
  267. // `:host-context(div)` is transformed to
  268. // `-shadowcsshost-no-combinatordiv, div -shadowcsshost-no-combinator`
  269. // the `div` is not part of the component in the 2nd selectors and should not be scoped.
  270. // Historically `component-tag:host` was matching the component so we also want to preserve
  271. // this behavior to avoid breaking legacy apps (it should not match).
  272. // The behavior should be:
  273. // - `tag:host` -> `tag[h]` (this is to avoid breaking legacy apps, should not match anything)
  274. // - `tag :host` -> `tag [h]` (`tag` is not scoped because it's considered part of a
  275. // `:host-context(tag)`)
  276. const hasHost = selector.indexOf(_polyfillHostNoCombinator) > -1;
  277. // Only scope parts after the first `-shadowcsshost-no-combinator` when it is present
  278. let shouldScope = !hasHost;
  279. while ((res = sep.exec(selector)) !== null) {
  280. const separator = res[1];
  281. const part = selector.slice(startIndex, res.index).trim();
  282. shouldScope = shouldScope || part.indexOf(_polyfillHostNoCombinator) > -1;
  283. const scopedPart = shouldScope ? _scopeSelectorPart(part) : part;
  284. scopedSelector += `${scopedPart} ${separator} `;
  285. startIndex = sep.lastIndex;
  286. }
  287. const part = selector.substring(startIndex);
  288. shouldScope = shouldScope || part.indexOf(_polyfillHostNoCombinator) > -1;
  289. scopedSelector += shouldScope ? _scopeSelectorPart(part) : part;
  290. // replace the placeholders with their original values
  291. return restoreSafeSelector(safeContent.placeholders, scopedSelector);
  292. };
  293. const scopeSelector = (selector, scopeSelectorText, hostSelector, slotSelector) => {
  294. return selector
  295. .split(',')
  296. .map((shallowPart) => {
  297. if (slotSelector && shallowPart.indexOf('.' + slotSelector) > -1) {
  298. return shallowPart.trim();
  299. }
  300. if (selectorNeedsScoping(shallowPart, scopeSelectorText)) {
  301. return applyStrictSelectorScope(shallowPart, scopeSelectorText, hostSelector).trim();
  302. }
  303. else {
  304. return shallowPart.trim();
  305. }
  306. })
  307. .join(', ');
  308. };
  309. const scopeSelectors = (cssText, scopeSelectorText, hostSelector, slotSelector, commentOriginalSelector) => {
  310. return processRules(cssText, (rule) => {
  311. let selector = rule.selector;
  312. let content = rule.content;
  313. if (rule.selector[0] !== '@') {
  314. selector = scopeSelector(rule.selector, scopeSelectorText, hostSelector, slotSelector);
  315. }
  316. else if (rule.selector.startsWith('@media') ||
  317. rule.selector.startsWith('@supports') ||
  318. rule.selector.startsWith('@page') ||
  319. rule.selector.startsWith('@document')) {
  320. content = scopeSelectors(rule.content, scopeSelectorText, hostSelector, slotSelector);
  321. }
  322. const cssRule = {
  323. selector: selector.replace(/\s{2,}/g, ' ').trim(),
  324. content,
  325. };
  326. return cssRule;
  327. });
  328. };
  329. const scopeCssText = (cssText, scopeId, hostScopeId, slotScopeId, commentOriginalSelector) => {
  330. cssText = insertPolyfillHostInCssText(cssText);
  331. cssText = convertColonHost(cssText);
  332. cssText = convertColonHostContext(cssText);
  333. const slotted = convertColonSlotted(cssText, slotScopeId);
  334. cssText = slotted.cssText;
  335. cssText = convertShadowDOMSelectors(cssText);
  336. if (scopeId) {
  337. cssText = scopeSelectors(cssText, scopeId, hostScopeId, slotScopeId);
  338. }
  339. cssText = cssText.replace(/-shadowcsshost-no-combinator/g, `.${hostScopeId}`);
  340. cssText = cssText.replace(/>\s*\*\s+([^{, ]+)/gm, ' $1 ');
  341. return {
  342. cssText: cssText.trim(),
  343. slottedSelectors: slotted.selectors,
  344. };
  345. };
  346. const scopeCss = (cssText, scopeId, commentOriginalSelector) => {
  347. const hostScopeId = scopeId + '-h';
  348. const slotScopeId = scopeId + '-s';
  349. const commentsWithHash = extractCommentsWithHash(cssText);
  350. cssText = stripComments(cssText);
  351. const orgSelectors = [];
  352. if (commentOriginalSelector) {
  353. const processCommentedSelector = (rule) => {
  354. const placeholder = `/*!@___${orgSelectors.length}___*/`;
  355. const comment = `/*!@${rule.selector}*/`;
  356. orgSelectors.push({ placeholder, comment });
  357. rule.selector = placeholder + rule.selector;
  358. return rule;
  359. };
  360. cssText = processRules(cssText, (rule) => {
  361. if (rule.selector[0] !== '@') {
  362. return processCommentedSelector(rule);
  363. }
  364. else if (rule.selector.startsWith('@media') ||
  365. rule.selector.startsWith('@supports') ||
  366. rule.selector.startsWith('@page') ||
  367. rule.selector.startsWith('@document')) {
  368. rule.content = processRules(rule.content, processCommentedSelector);
  369. return rule;
  370. }
  371. return rule;
  372. });
  373. }
  374. const scoped = scopeCssText(cssText, scopeId, hostScopeId, slotScopeId);
  375. cssText = [scoped.cssText, ...commentsWithHash].join('\n');
  376. if (commentOriginalSelector) {
  377. orgSelectors.forEach(({ placeholder, comment }) => {
  378. cssText = cssText.replace(placeholder, comment);
  379. });
  380. }
  381. scoped.slottedSelectors.forEach((slottedSelector) => {
  382. cssText = cssText.replace(slottedSelector.orgSelector, slottedSelector.updatedSelector);
  383. });
  384. return cssText;
  385. };
  386. export { scopeCss };