@atlaspack/packager-html 2.15.3 → 2.15.4-typescript-17c3d1dec.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.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright (c) 2024 Atlassian US., Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,3 @@
1
+ import { Packager } from '@atlaspack/plugin';
2
+ declare const _default: Packager<unknown, unknown>;
3
+ export default _default;
@@ -64,8 +64,10 @@ var _default = exports.default = new (_plugin().Packager)({
64
64
  packageKey: '@atlaspack/packager-html'
65
65
  });
66
66
  return {
67
+ // @ts-expect-error TS2339
67
68
  render: posthtmlConfig === null || posthtmlConfig === void 0 || (_posthtmlConfig$conte = posthtmlConfig.contents) === null || _posthtmlConfig$conte === void 0 ? void 0 : _posthtmlConfig$conte.render,
68
- evaluateRootConditionalBundles: Boolean(conf === null || conf === void 0 || (_conf$contents = conf.contents) === null || _conf$contents === void 0 ? void 0 : _conf$contents.evaluateRootConditionalBundles)
69
+ evaluateRootConditionalBundles: Boolean( // @ts-expect-error TS2339
70
+ conf === null || conf === void 0 || (_conf$contents = conf.contents) === null || _conf$contents === void 0 ? void 0 : _conf$contents.evaluateRootConditionalBundles)
69
71
  };
70
72
  },
71
73
  async package({
@@ -74,6 +76,7 @@ var _default = exports.default = new (_plugin().Packager)({
74
76
  getInlineBundleContents,
75
77
  config
76
78
  }) {
79
+ // @ts-expect-error TS2552
77
80
  let assets = [];
78
81
  bundle.traverseAssets(asset => {
79
82
  assets.push(asset);
@@ -88,14 +91,13 @@ var _default = exports.default = new (_plugin().Packager)({
88
91
  let referencedBundles = [...(0, _utils().setSymmetricDifference)(new Set(referencedBundlesRecursive), new Set(bundleGraph.getReferencedBundles(bundle, {
89
92
  recursive: false
90
93
  })))];
91
-
92
- // $FlowFixMe
93
94
  let conditionalBundles = config.evaluateRootConditionalBundles ? (0, _utils().setDifference)(getReferencedConditionalScripts(bundleGraph, referencedBundlesRecursive), new Set(referencedBundles)) : new Set();
94
- // $FlowFixMe
95
95
  let renderConfig = config === null || config === void 0 ? void 0 : config.render;
96
96
  let {
97
97
  html
98
- } = await (0, _posthtml().default)([tree => insertBundleReferences([...conditionalBundles, ...referencedBundles], tree, conditionalBundles), tree => replaceInlineAssetContent(bundleGraph, getInlineBundleContents, tree)]).process(code, {
98
+ } = await (0, _posthtml().default)([tree => insertBundleReferences(
99
+ // @ts-expect-error TS2345
100
+ [...conditionalBundles, ...referencedBundles], tree, conditionalBundles), tree => replaceInlineAssetContent(bundleGraph, getInlineBundleContents, tree)]).process(code, {
99
101
  ...renderConfig,
100
102
  xmlMode: bundle.type === 'xhtml',
101
103
  closingSingleTag: bundle.type === 'xhtml' ? 'slash' : undefined
@@ -145,6 +147,7 @@ async function getAssetContent(bundleGraph, getInlineBundleContents, assetId) {
145
147
  }
146
148
  async function replaceInlineAssetContent(bundleGraph, getInlineBundleContents, tree) {
147
149
  const inlineNodes = [];
150
+ // @ts-expect-error TS7006
148
151
  tree.walk(node => {
149
152
  if (node.attrs && node.attrs['data-parcel-key']) {
150
153
  inlineNodes.push(node);
@@ -209,14 +212,18 @@ function insertBundleReferences(siblingBundles, tree, conditionalBundles) {
209
212
  }
210
213
  addBundlesToTree(bundles, tree);
211
214
  }
215
+
216
+ // @ts-expect-error TS7006
212
217
  function addBundlesToTree(bundles, tree) {
213
218
  const main = find(tree, 'head') || find(tree, 'html');
219
+ // @ts-expect-error TS2339
214
220
  const content = main ? main.content || (main.content = []) : tree;
215
221
  const index = findBundleInsertIndex(content);
216
222
  content.splice(index, 0, ...bundles);
217
223
  }
218
224
  function find(tree, tag) {
219
225
  let res;
226
+ // @ts-expect-error TS7006
220
227
  tree.match({
221
228
  tag
222
229
  }, node => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaspack/packager-html",
3
- "version": "2.15.3",
3
+ "version": "2.15.4-typescript-17c3d1dec.0",
4
4
  "license": "(MIT OR Apache-2.0)",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -9,18 +9,23 @@
9
9
  "type": "git",
10
10
  "url": "https://github.com/atlassian-labs/atlaspack.git"
11
11
  },
12
- "main": "lib/HTMLPackager.js",
13
- "source": "src/HTMLPackager.js",
12
+ "main": "./lib/HTMLPackager.js",
13
+ "source": "./src/HTMLPackager.ts",
14
+ "types": "./lib/HTMLPackager.d.ts",
14
15
  "engines": {
15
16
  "node": ">= 16.0.0"
16
17
  },
17
18
  "dependencies": {
18
- "@atlaspack/plugin": "2.14.21",
19
- "@atlaspack/types": "2.15.11",
20
- "@atlaspack/utils": "2.17.3",
21
- "@atlaspack/feature-flags": "2.20.0",
19
+ "@atlaspack/feature-flags": "2.20.1-typescript-17c3d1dec.0",
20
+ "@atlaspack/plugin": "2.14.22-typescript-17c3d1dec.0",
21
+ "@atlaspack/types": "2.15.12-typescript-17c3d1dec.0",
22
+ "@atlaspack/utils": "2.17.4-typescript-17c3d1dec.0",
22
23
  "nullthrows": "^1.1.1",
23
24
  "posthtml": "^0.16.5"
24
25
  },
25
- "type": "commonjs"
26
- }
26
+ "type": "commonjs",
27
+ "scripts": {
28
+ "check-ts": "tsc --emitDeclarationOnly --rootDir src"
29
+ },
30
+ "gitHead": "17c3d1decf641e688fcfe3ca985e80e9897b7573"
31
+ }
@@ -1,4 +1,3 @@
1
- // @flow strict-local
2
1
  import type {Bundle, BundleGraph, NamedBundle} from '@atlaspack/types';
3
2
 
4
3
  import assert from 'assert';
@@ -26,7 +25,7 @@ const metadataContent = new Set([
26
25
  'title',
27
26
  ]);
28
27
 
29
- export default (new Packager({
28
+ export default new Packager({
30
29
  async loadConfig({config, options}) {
31
30
  let posthtmlConfig = await config.getConfig(
32
31
  [
@@ -48,14 +47,17 @@ export default (new Packager({
48
47
  });
49
48
 
50
49
  return {
50
+ // @ts-expect-error TS2339
51
51
  render: posthtmlConfig?.contents?.render,
52
52
  evaluateRootConditionalBundles: Boolean(
53
+ // @ts-expect-error TS2339
53
54
  conf?.contents?.evaluateRootConditionalBundles,
54
55
  ),
55
56
  };
56
57
  },
57
58
  async package({bundle, bundleGraph, getInlineBundleContents, config}) {
58
- let assets = [];
59
+ // @ts-expect-error TS2552
60
+ let assets: Array<Asset> = [];
59
61
  bundle.traverseAssets((asset) => {
60
62
  assets.push(asset);
61
63
  });
@@ -75,7 +77,6 @@ export default (new Packager({
75
77
  ),
76
78
  ];
77
79
 
78
- // $FlowFixMe
79
80
  let conditionalBundles = config.evaluateRootConditionalBundles
80
81
  ? setDifference(
81
82
  getReferencedConditionalScripts(
@@ -85,17 +86,17 @@ export default (new Packager({
85
86
  new Set(referencedBundles),
86
87
  )
87
88
  : new Set();
88
- // $FlowFixMe
89
89
  let renderConfig = config?.render;
90
90
 
91
91
  let {html} = await posthtml([
92
- (tree) =>
92
+ (tree: any) =>
93
93
  insertBundleReferences(
94
+ // @ts-expect-error TS2345
94
95
  [...conditionalBundles, ...referencedBundles],
95
96
  tree,
96
97
  conditionalBundles,
97
98
  ),
98
- (tree) =>
99
+ (tree: any) =>
99
100
  replaceInlineAssetContent(bundleGraph, getInlineBundleContents, tree),
100
101
  ]).process(code, {
101
102
  ...renderConfig,
@@ -123,14 +124,20 @@ export default (new Packager({
123
124
  map,
124
125
  });
125
126
  },
126
- }): Packager<mixed, mixed>);
127
+ }) as Packager<unknown, unknown>;
127
128
 
128
129
  async function getAssetContent(
129
130
  bundleGraph: BundleGraph<NamedBundle>,
130
- getInlineBundleContents,
131
- assetId,
131
+ getInlineBundleContents: (
132
+ arg1: Bundle,
133
+ arg2: BundleGraph<NamedBundle>,
134
+ // @ts-expect-error TS2304
135
+ ) => Async<{
136
+ contents: Blob;
137
+ }>,
138
+ assetId: any,
132
139
  ) {
133
- let inlineBundle: ?Bundle;
140
+ let inlineBundle: Bundle | null | undefined;
134
141
  bundleGraph.traverseBundles((bundle, context, {stop}) => {
135
142
  let entryAssets = bundle.getEntryAssets();
136
143
  if (entryAssets.some((a) => a.uniqueKey === assetId)) {
@@ -153,10 +160,17 @@ async function getAssetContent(
153
160
 
154
161
  async function replaceInlineAssetContent(
155
162
  bundleGraph: BundleGraph<NamedBundle>,
156
- getInlineBundleContents,
157
- tree,
163
+ getInlineBundleContents: (
164
+ arg1: Bundle,
165
+ arg2: BundleGraph<NamedBundle>,
166
+ // @ts-expect-error TS2304
167
+ ) => Async<{
168
+ contents: Blob;
169
+ }>,
170
+ tree: any,
158
171
  ) {
159
- const inlineNodes = [];
172
+ const inlineNodes: Array<any> = [];
173
+ // @ts-expect-error TS7006
160
174
  tree.walk((node) => {
161
175
  if (node.attrs && node.attrs['data-parcel-key']) {
162
176
  inlineNodes.push(node);
@@ -207,7 +221,11 @@ async function replaceInlineAssetContent(
207
221
  return tree;
208
222
  }
209
223
 
210
- function insertBundleReferences(siblingBundles, tree, conditionalBundles) {
224
+ function insertBundleReferences(
225
+ siblingBundles: Array<NamedBundle>,
226
+ tree: any,
227
+ conditionalBundles: Set<NamedBundle>,
228
+ ) {
211
229
  const bundles = [];
212
230
 
213
231
  for (let bundle of siblingBundles) {
@@ -240,16 +258,19 @@ function insertBundleReferences(siblingBundles, tree, conditionalBundles) {
240
258
  addBundlesToTree(bundles, tree);
241
259
  }
242
260
 
243
- function addBundlesToTree(bundles, tree) {
261
+ // @ts-expect-error TS7006
262
+ function addBundlesToTree(bundles, tree: any) {
244
263
  const main = find(tree, 'head') || find(tree, 'html');
264
+ // @ts-expect-error TS2339
245
265
  const content = main ? main.content || (main.content = []) : tree;
246
266
  const index = findBundleInsertIndex(content);
247
267
 
248
268
  content.splice(index, 0, ...bundles);
249
269
  }
250
270
 
251
- function find(tree, tag) {
271
+ function find(tree: any, tag: string) {
252
272
  let res;
273
+ // @ts-expect-error TS7006
253
274
  tree.match({tag}, (node) => {
254
275
  res = node;
255
276
  return node;
@@ -258,7 +279,7 @@ function find(tree, tag) {
258
279
  return res;
259
280
  }
260
281
 
261
- function findBundleInsertIndex(content) {
282
+ function findBundleInsertIndex(content: any) {
262
283
  // HTML document order (https://html.spec.whatwg.org/multipage/syntax.html#writing)
263
284
  // - Any number of comments and ASCII whitespace.
264
285
  // - A DOCTYPE.
@@ -291,7 +312,7 @@ function getReferencedConditionalScripts(
291
312
  ): Set<NamedBundle> {
292
313
  const conditionalBundleMapping = bundleGraph.getConditionalBundleMapping();
293
314
 
294
- const bundles = [];
315
+ const bundles: Array<NamedBundle> = [];
295
316
  for (const bundle of referencedBundles) {
296
317
  const conditions = conditionalBundleMapping.get(bundle.id);
297
318
  if (conditions) {
package/tsconfig.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "extends": "../../../tsconfig.json",
3
+ "include": ["src"]
4
+ }