@safaricom-mxl/web-cli 0.0.4
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 +201 -0
- package/README.md +45 -0
- package/dist/index.mjs +288 -0
- package/package.json +51 -0
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 [yyyy] [name of copyright owner]
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# MXL Web SDK CLI
|
|
2
|
+
|
|
3
|
+
This tool is intended to help with build-time tasks for the [MXL Web SDK](../web-sdk/README.md).
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
npm:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install --save-dev @safaricom-mxl/web-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
yarn:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
yarn add -D @safaricom-mxl/web-cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Upload sourcemaps
|
|
20
|
+
|
|
21
|
+
To upload sourcemaps to MXL as part of your build process you will require the following:
|
|
22
|
+
* Your MXL App ID
|
|
23
|
+
* Your MXL `Symbol Upload` API token (found in your MXL dashboard in
|
|
24
|
+
[Settings->API](https://mxl.apps.ocpthikadev01.safaricom.net/settings/organization/api))
|
|
25
|
+
* The path to where the built JS files live
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
npx mxl-web-cli upload -a "YOUR_MXL_APP_ID" -t "YOUR_MXL_UPLOAD_API_TOKEN" -p "BUILD_PATH"
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
> [!WARNING]
|
|
32
|
+
> The CLI must be run BEFORE the files are packaged (e.g., before creating a Docker image or deployment archive).
|
|
33
|
+
> The CLI injects a comment and a short function to the end of bundle files to enable symbolication, so it needs to
|
|
34
|
+
> happen before packaging.
|
|
35
|
+
|
|
36
|
+
## Setting app version
|
|
37
|
+
|
|
38
|
+
The same `upload` sub-command as above can be used to inject your app's version into your bundle if the value is only
|
|
39
|
+
known at build time. If the version is known prior to build time you can provide it when initializing the SDK as
|
|
40
|
+
described in [Keeping your app version up-to-date](../web-sdk/README.md#keeping-your-app-version-up-to-date).
|
|
41
|
+
Execute the same command as above while also providing your app's version:
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
npx mxl-web-cli upload -a "YOUR_MXL_APP_ID" -t "YOUR_MXL_UPLOAD_API_TOKEN" -p "BUILD_PATH" --app-version "APP_VERSION"
|
|
45
|
+
```
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,288 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { Command, Option } from "commander";
|
|
3
|
+
import crypto from "node:crypto";
|
|
4
|
+
import fs from "node:fs";
|
|
5
|
+
import path from "node:path";
|
|
6
|
+
import zlib from "node:zlib";
|
|
7
|
+
|
|
8
|
+
//#region src/constants.ts
|
|
9
|
+
const CLI_VERSION = "0.0.4";
|
|
10
|
+
const CLI_NAME = "@safaricom-mxl/web-cli";
|
|
11
|
+
const CLI_DESCRIPTION = "MXL Web CLI to help setup the MXL SDK in your web app";
|
|
12
|
+
const DEFAULT_FILE_ENCODING = "utf8";
|
|
13
|
+
const SOURCE_MAP_UPLOAD_HOST = "https://dsym-store.mxl-api.com";
|
|
14
|
+
const SOURCE_MAP_UPLOAD_PATH = "/v2/store/";
|
|
15
|
+
const TEMPLATE_APP_VERSION = "EmbIOAppVersionX.X.X";
|
|
16
|
+
|
|
17
|
+
//#endregion
|
|
18
|
+
//#region src/uploadToApi.ts
|
|
19
|
+
const uploadToApi = async ({ jsContent, mapContent, bundleID, token, appID, host, pathForUpload, storeType, cliVersion }) => {
|
|
20
|
+
if (!token) throw new Error("Token is required for upload");
|
|
21
|
+
const body = new Blob([zlib.gzipSync(JSON.stringify({
|
|
22
|
+
bundle: jsContent,
|
|
23
|
+
sourcemap: mapContent
|
|
24
|
+
}))]);
|
|
25
|
+
const formData = new FormData();
|
|
26
|
+
formData.append("id", bundleID);
|
|
27
|
+
formData.append("app", appID);
|
|
28
|
+
formData.append("token", token);
|
|
29
|
+
formData.append("file", body);
|
|
30
|
+
try {
|
|
31
|
+
console.log(`Uploading to API bundle ID ${bundleID}, appID ${appID}`);
|
|
32
|
+
const response = await fetch(host + pathForUpload + storeType, {
|
|
33
|
+
method: "POST",
|
|
34
|
+
headers: { "User-Agent": `mxl_symbol_upload/${cliVersion} (${process.version})` },
|
|
35
|
+
body: formData
|
|
36
|
+
});
|
|
37
|
+
if (!response.ok) {
|
|
38
|
+
const errorText = await response.text();
|
|
39
|
+
throw new Error(`API returned ${response.status.toString()}: ${response.statusText} - ${errorText}`);
|
|
40
|
+
}
|
|
41
|
+
console.log("API Response status:", response.status);
|
|
42
|
+
} catch (error) {
|
|
43
|
+
console.error("Error uploading to API:", error);
|
|
44
|
+
throw error;
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
//#endregion
|
|
49
|
+
//#region src/validateInput.ts
|
|
50
|
+
const validateInput = ({ buildPath, token, appID, host, pathForUpload, storeType, cliVersion, appVersion, templateAppVersion, upload }) => {
|
|
51
|
+
if (!buildPath.trim()) return "buildPath cannot be empty.";
|
|
52
|
+
if (appVersion !== void 0) {
|
|
53
|
+
const trimmedAppVersion = appVersion.trim();
|
|
54
|
+
if (trimmedAppVersion === "") return "appVersion cannot be an empty string.";
|
|
55
|
+
if (trimmedAppVersion.length > 20) return "appVersion cannot be longer than 20 characters.";
|
|
56
|
+
}
|
|
57
|
+
if (upload && !token?.trim()) return "Token cannot be empty.";
|
|
58
|
+
if (upload && token && token.length !== 32) return "Token must be 32 characters long.";
|
|
59
|
+
if (!appID.trim()) return "App ID cannot be empty.";
|
|
60
|
+
if (appID.length !== 5) return "App ID must be 5 characters long.";
|
|
61
|
+
if (!host.trim()) return "Host cannot be empty.";
|
|
62
|
+
if (!pathForUpload.trim()) return "Path cannot be empty.";
|
|
63
|
+
if (!storeType.trim()) return "Store type cannot be empty.";
|
|
64
|
+
if (!cliVersion.trim()) return "CLI version cannot be empty.";
|
|
65
|
+
if (!templateAppVersion.trim()) return "Template App version cannot be empty.";
|
|
66
|
+
if (templateAppVersion.length !== 20) return "Template App version must be 20 characters long.";
|
|
67
|
+
try {
|
|
68
|
+
if (!fs.statSync(buildPath).isDirectory()) return "buildPath needs to be a valid directory.";
|
|
69
|
+
} catch (_) {
|
|
70
|
+
return "buildPath not found.";
|
|
71
|
+
}
|
|
72
|
+
return null;
|
|
73
|
+
};
|
|
74
|
+
|
|
75
|
+
//#endregion
|
|
76
|
+
//#region src/processSourceFiles.ts
|
|
77
|
+
var MapSecurityError = class extends Error {
|
|
78
|
+
constructor(message) {
|
|
79
|
+
super(message);
|
|
80
|
+
this.name = "MapSecurityError";
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
const FILE_BUNDLE_ID_CODE_SNIPPET_TEMPLATE = "EmbIOFileBundleID";
|
|
84
|
+
const FILE_BUNDLE_IDS_CODE_SNIPPET = `;(E=>{try{const _=globalThis,c=(new _.Error).stack;c&&(_[E]=_[E]||{},_[E][c]="${FILE_BUNDLE_ID_CODE_SNIPPET_TEMPLATE}")}catch(E){}})("_MXLFileBundleIDs");`;
|
|
85
|
+
const INJECTION_MARKER = "// Injected by MXL Web CLI:";
|
|
86
|
+
const UUID_WITH_HYPHENS_REGEX = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
|
|
87
|
+
const UUID_WITHOUT_HYPHENS_REGEX = /^[0-9a-fA-F]{32}$/;
|
|
88
|
+
const UUID_PARTS_REGEX = /([0-9a-fA-F]{8})([0-9a-fA-F]{4})([0-9a-fA-F]{4})([0-9a-fA-F]{4})([0-9a-fA-F]{12})/;
|
|
89
|
+
const addHyphensToUuid = (uuidStr) => {
|
|
90
|
+
if (!UUID_WITHOUT_HYPHENS_REGEX.test(uuidStr)) throw new Error("Invalid UUID string: Must be 32 hexadecimal characters.");
|
|
91
|
+
return uuidStr.replace(UUID_PARTS_REGEX, "$1-$2-$3-$4-$5");
|
|
92
|
+
};
|
|
93
|
+
const isAlreadyInjected = (sourceFile) => {
|
|
94
|
+
return sourceFile.includes(INJECTION_MARKER);
|
|
95
|
+
};
|
|
96
|
+
const injectBundleIDToSourceFile = (sourceFile, bundleID) => {
|
|
97
|
+
const jsLines = sourceFile.split("\n");
|
|
98
|
+
const sourceMapCommentIndex = jsLines.findIndex((line) => line.trim().startsWith("//# sourceMappingURL="));
|
|
99
|
+
const injectIndex = sourceMapCommentIndex === -1 ? jsLines.length : sourceMapCommentIndex;
|
|
100
|
+
const snippet = FILE_BUNDLE_IDS_CODE_SNIPPET.replace(FILE_BUNDLE_ID_CODE_SNIPPET_TEMPLATE, bundleID);
|
|
101
|
+
jsLines.splice(injectIndex, 0, snippet);
|
|
102
|
+
jsLines.splice(injectIndex, 0, INJECTION_MARKER);
|
|
103
|
+
return jsLines.join("\n");
|
|
104
|
+
};
|
|
105
|
+
const extractSourceMapUrl = (jsContent) => {
|
|
106
|
+
return jsContent.match(/^\/\/# sourceMappingURL=(.+)$/m)?.[1]?.trim() || null;
|
|
107
|
+
};
|
|
108
|
+
const findSourceMapForJsFile = (jsFileName, jsContent, realPath) => {
|
|
109
|
+
const sourceMapUrl = extractSourceMapUrl(jsContent);
|
|
110
|
+
if (sourceMapUrl) return sourceMapUrl;
|
|
111
|
+
const fallbackMapPath = `${jsFileName}.map`;
|
|
112
|
+
const fallbackMapFilePath = path.join(realPath, fallbackMapPath);
|
|
113
|
+
if (fs.existsSync(fallbackMapFilePath)) {
|
|
114
|
+
console.log(`Using fallback source map ${fallbackMapPath} for ${jsFileName}`);
|
|
115
|
+
return fallbackMapPath;
|
|
116
|
+
}
|
|
117
|
+
return null;
|
|
118
|
+
};
|
|
119
|
+
const validateMapSecurity = (mapFilePath, searchRoot, sourceMapUrl, jsFileName) => {
|
|
120
|
+
const mapFileRealPath = fs.realpathSync(mapFilePath);
|
|
121
|
+
const relativePath = path.relative(searchRoot, mapFileRealPath);
|
|
122
|
+
if (relativePath.startsWith("..") || path.isAbsolute(relativePath)) throw new MapSecurityError(`Source map '${sourceMapUrl}' in ${jsFileName} resolves outside the search directory (${mapFileRealPath} is not within ${searchRoot}). This is not allowed to prevent path traversal attacks.`);
|
|
123
|
+
};
|
|
124
|
+
const findJSFilesRecursively = (dirPath, rootPath) => {
|
|
125
|
+
const results = [];
|
|
126
|
+
const realPath = fs.realpathSync(dirPath);
|
|
127
|
+
const searchRoot = rootPath ?? realPath;
|
|
128
|
+
const files = fs.readdirSync(realPath);
|
|
129
|
+
const jsFiles = files.filter((file) => file.endsWith(".js"));
|
|
130
|
+
for (const jsFileName of jsFiles) {
|
|
131
|
+
const jsFilePath = path.join(realPath, jsFileName);
|
|
132
|
+
try {
|
|
133
|
+
const sourceMapUrl = findSourceMapForJsFile(jsFileName, fs.readFileSync(jsFilePath, "utf-8"), realPath);
|
|
134
|
+
if (!sourceMapUrl) {
|
|
135
|
+
console.warn(`Skipping ${jsFileName} - no source map found`);
|
|
136
|
+
continue;
|
|
137
|
+
}
|
|
138
|
+
const mapFilePath = path.resolve(realPath, sourceMapUrl);
|
|
139
|
+
if (!fs.existsSync(mapFilePath)) {
|
|
140
|
+
console.warn(`Skipping ${jsFileName} - source map file not found at ${mapFilePath}`);
|
|
141
|
+
continue;
|
|
142
|
+
}
|
|
143
|
+
validateMapSecurity(mapFilePath, searchRoot, sourceMapUrl, jsFileName);
|
|
144
|
+
results.push({
|
|
145
|
+
jsFilePath,
|
|
146
|
+
mapFilePath
|
|
147
|
+
});
|
|
148
|
+
} catch (err) {
|
|
149
|
+
if (err instanceof MapSecurityError) throw err;
|
|
150
|
+
console.warn(`Error reading ${jsFileName}:`, err);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
for (const file of files) {
|
|
154
|
+
const fullPath = path.join(realPath, file);
|
|
155
|
+
try {
|
|
156
|
+
if (fs.statSync(fullPath).isDirectory()) results.push(...findJSFilesRecursively(fullPath, searchRoot));
|
|
157
|
+
} catch (err) {
|
|
158
|
+
console.warn(`Error reading ${fullPath}:`, err);
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
return results;
|
|
162
|
+
};
|
|
163
|
+
const processSourceFiles = async ({ buildPath, token, appID, host, pathForUpload, storeType, cliVersion, templateAppVersion, dryRun, replaceBundleID, upload, fileEncoding, appVersion }) => {
|
|
164
|
+
const validationError = validateInput({
|
|
165
|
+
buildPath,
|
|
166
|
+
token,
|
|
167
|
+
appID,
|
|
168
|
+
host,
|
|
169
|
+
pathForUpload,
|
|
170
|
+
storeType,
|
|
171
|
+
cliVersion,
|
|
172
|
+
appVersion,
|
|
173
|
+
templateAppVersion,
|
|
174
|
+
upload
|
|
175
|
+
});
|
|
176
|
+
if (validationError) {
|
|
177
|
+
console.error("Input Validation Error: ", validationError);
|
|
178
|
+
process.exit(1);
|
|
179
|
+
}
|
|
180
|
+
if (!fs.statSync(buildPath).isDirectory()) {
|
|
181
|
+
console.error(`Path must be a directory: ${buildPath}`);
|
|
182
|
+
process.exit(1);
|
|
183
|
+
}
|
|
184
|
+
try {
|
|
185
|
+
const jsFiles = findJSFilesRecursively(buildPath);
|
|
186
|
+
console.log(`Found ${jsFiles.length} JavaScript files in directory tree: ${buildPath}`);
|
|
187
|
+
let appVersionReplaced = false;
|
|
188
|
+
for (const { jsFilePath, mapFilePath } of jsFiles) {
|
|
189
|
+
console.log(`Processing ${jsFilePath} and ${mapFilePath}...`);
|
|
190
|
+
let jsContent = fs.readFileSync(jsFilePath, fileEncoding);
|
|
191
|
+
let mapContent = fs.readFileSync(mapFilePath, fileEncoding);
|
|
192
|
+
if (appVersion) {
|
|
193
|
+
const paddedAppVersion = appVersion.length < 20 ? appVersion.padStart(20, " ") : appVersion;
|
|
194
|
+
const newJsContent = jsContent.replace(templateAppVersion, paddedAppVersion);
|
|
195
|
+
const newMapContent = mapContent.replace(templateAppVersion, paddedAppVersion);
|
|
196
|
+
if (newJsContent === jsContent && newMapContent === mapContent) console.warn(`Template App version not found in ${jsFilePath}`);
|
|
197
|
+
else appVersionReplaced = true;
|
|
198
|
+
jsContent = newJsContent;
|
|
199
|
+
mapContent = newMapContent;
|
|
200
|
+
}
|
|
201
|
+
let bundleID = "";
|
|
202
|
+
let debugID = "";
|
|
203
|
+
const sourceMap = JSON.parse(mapContent);
|
|
204
|
+
if (sourceMap.debugId) {
|
|
205
|
+
if (!UUID_WITH_HYPHENS_REGEX.test(sourceMap.debugId)) throw new Error(`SourceMap file at ${mapFilePath} contains a debugID that is not a valid UUID string: '${sourceMap.debugId}'.\nIf you are generating these debugIDs manually, you should make sure the generated ids are valid UUIDs.\nIf you are using a build tool that generates these ids, we suggest that you disable that, and our cli will generate them automatically.`);
|
|
206
|
+
bundleID = sourceMap.debugId.replaceAll("-", "");
|
|
207
|
+
debugID = sourceMap.debugId;
|
|
208
|
+
console.log(`Using debugID ${debugID} from sourceMap for ${jsFilePath}`);
|
|
209
|
+
} else {
|
|
210
|
+
bundleID = crypto.createHash("md5").update(jsContent).digest("hex");
|
|
211
|
+
debugID = addHyphensToUuid(bundleID);
|
|
212
|
+
sourceMap.debugId = debugID;
|
|
213
|
+
mapContent = JSON.stringify(sourceMap);
|
|
214
|
+
console.log(`Generated debugID ${debugID} for ${jsFilePath}`);
|
|
215
|
+
}
|
|
216
|
+
if (isAlreadyInjected(jsContent)) console.log(`Skipping injection for ${jsFilePath} - already processed`);
|
|
217
|
+
else jsContent = injectBundleIDToSourceFile(jsContent, bundleID);
|
|
218
|
+
console.log(`${replaceBundleID && !dryRun ? "Replacing" : "Dry run mode, not replacing"} the contents for ${jsFilePath} and ${mapFilePath}`);
|
|
219
|
+
if (!dryRun && replaceBundleID) {
|
|
220
|
+
fs.writeFileSync(jsFilePath, jsContent, fileEncoding);
|
|
221
|
+
fs.writeFileSync(mapFilePath, mapContent, fileEncoding);
|
|
222
|
+
}
|
|
223
|
+
if (dryRun) console.log("Dry run, skipping upload");
|
|
224
|
+
else if (upload) {
|
|
225
|
+
console.log("Uploading file to MXL API");
|
|
226
|
+
await uploadToApi({
|
|
227
|
+
jsContent,
|
|
228
|
+
mapContent,
|
|
229
|
+
bundleID,
|
|
230
|
+
token,
|
|
231
|
+
appID,
|
|
232
|
+
host,
|
|
233
|
+
pathForUpload,
|
|
234
|
+
storeType,
|
|
235
|
+
cliVersion
|
|
236
|
+
});
|
|
237
|
+
console.log(`Uploaded ${jsFilePath} and ${mapFilePath}`);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
if (appVersion && !appVersionReplaced) {
|
|
241
|
+
console.error(`Template App version not found in any of the js files. Exiting.`);
|
|
242
|
+
process.exit(1);
|
|
243
|
+
}
|
|
244
|
+
} catch (err) {
|
|
245
|
+
console.error("Error processing files:", err);
|
|
246
|
+
process.exit(1);
|
|
247
|
+
}
|
|
248
|
+
};
|
|
249
|
+
|
|
250
|
+
//#endregion
|
|
251
|
+
//#region src/index.ts
|
|
252
|
+
const program = new Command();
|
|
253
|
+
program.name(CLI_NAME).description(CLI_DESCRIPTION).version(CLI_VERSION);
|
|
254
|
+
program.command("upload").description(CLI_DESCRIPTION).addOption(new Option("-p, --build-path <buildPath>", "Path to where the built JS files live").env("MXL_BUILD_PATH").makeOptionMandatory()).addOption(new Option("-t, --token <token>", "API token to authenticate with MXL").env("MXL_SOURCE_UPLOAD_API_TOKEN")).addOption(new Option("-a, --app-id <appID>", "Application ID").env("MXL_APP_ID").makeOptionMandatory()).addOption(new Option("--app-version <appVersion>", "Application Version. Usually the version of the app under package.json -> version").env("MXL_APP_VERSION")).addOption(new Option("--cli-version [cliVersion]", "Version of this CLI tool").env("MXL_CLI_VERSION").default(CLI_VERSION).makeOptionMandatory().hideHelp()).addOption(new Option("-d, --dry-run", "Make a dry run without uploading or saving the replacements. This is the same as using --no-upload and --no-replaceBundleID").env("MXL_DRY_RUN")).addOption(new Option("--no-upload", "Turn off uploading source maps to MXL").env("MXL_NO_UPLOAD")).addOption(new Option("--no-replaceBundleID", "Turn off editing the original source bundle and map files to include the bundle ID").env("MXL_NO_REPLACE_BUNDLE_ID")).addOption(new Option("-e, --encoding [fileEncoding]", "File encoding for reading and writing the JS and map files").env("MXL_ENCODING").choices([
|
|
255
|
+
"ascii",
|
|
256
|
+
"utf8",
|
|
257
|
+
"utf-8",
|
|
258
|
+
"utf16le",
|
|
259
|
+
"utf-16le",
|
|
260
|
+
"ucs2",
|
|
261
|
+
"ucs-2",
|
|
262
|
+
"base64",
|
|
263
|
+
"base64url",
|
|
264
|
+
"latin1",
|
|
265
|
+
"binary",
|
|
266
|
+
"hex"
|
|
267
|
+
]).default(DEFAULT_FILE_ENCODING)).addOption(new Option("--host [host]", "MXL URL host to upload source maps to").env("MXL_SOURCE_MAP_UPLOAD_HOST").default(SOURCE_MAP_UPLOAD_HOST).makeOptionMandatory().hideHelp()).addOption(new Option("--path-for-upload [pathForUpload]", "MXL URL path to upload source maps to").env("MXL_SOURCE_MAP_UPLOAD_PATH").default(SOURCE_MAP_UPLOAD_PATH).makeOptionMandatory().hideHelp()).addOption(new Option("--store-type [storeType]", "MXL store type for the upload").env("MXL_STORE_TYPE").default("sourcemap").makeOptionMandatory().hideHelp()).addOption(new Option("--template-app-version [templateAppVersion]", "MXL Template App Version build into the SDK source code for replacement").env("MXL_TEMPLATE_APP_VERSION").default(TEMPLATE_APP_VERSION).makeOptionMandatory().hideHelp()).action(async (options) => {
|
|
268
|
+
const { buildPath, token, appId, host, pathForUpload, storeType, templateAppVersion, cliVersion, dryRun, upload, replaceBundleID, appVersion, encoding } = options;
|
|
269
|
+
await processSourceFiles({
|
|
270
|
+
buildPath,
|
|
271
|
+
token,
|
|
272
|
+
appID: appId,
|
|
273
|
+
host,
|
|
274
|
+
pathForUpload,
|
|
275
|
+
storeType,
|
|
276
|
+
templateAppVersion,
|
|
277
|
+
cliVersion,
|
|
278
|
+
fileEncoding: encoding,
|
|
279
|
+
dryRun,
|
|
280
|
+
appVersion,
|
|
281
|
+
upload,
|
|
282
|
+
replaceBundleID
|
|
283
|
+
});
|
|
284
|
+
});
|
|
285
|
+
program.parse(process.argv);
|
|
286
|
+
|
|
287
|
+
//#endregion
|
|
288
|
+
export { };
|
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@safaricom-mxl/web-cli",
|
|
3
|
+
"bin": {
|
|
4
|
+
"mxl-web-cli": "dist/index.mjs"
|
|
5
|
+
},
|
|
6
|
+
"version": "0.0.4",
|
|
7
|
+
"description": "MXL Web CLI for uploading sourcemaps and versioning bundles",
|
|
8
|
+
"type": "module",
|
|
9
|
+
"publishConfig": {
|
|
10
|
+
"access": "public"
|
|
11
|
+
},
|
|
12
|
+
"scripts": {
|
|
13
|
+
"clean": "npx -y rimraf dist",
|
|
14
|
+
"build": "tsdown",
|
|
15
|
+
"dev": "tsdown --watch --no-clean",
|
|
16
|
+
"check": "tsc",
|
|
17
|
+
"test": "tsx --test src/**/*.test.ts",
|
|
18
|
+
"validate": "tsx scripts/validate.ts"
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"dist"
|
|
22
|
+
],
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://gitlab.safaricom.co.ke/mxl/apm/mxl-web-sdk/-/issues",
|
|
25
|
+
"email": "ServiceAvailability@Safaricom.co.ke"
|
|
26
|
+
},
|
|
27
|
+
"homepage": "https://gitlab.safaricom.co.ke/mxl/apm/mxl-web-sdk",
|
|
28
|
+
"author": "MXL <ServiceAvailability@Safaricom.co.ke> (https://mxl.apps.ocpthikadev01.safaricom.net/)",
|
|
29
|
+
"license": "Apache-2.0",
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "https://gitlab.safaricom.co.ke/mxl/apm/mxl-web-sdk.git",
|
|
33
|
+
"directory": "packages/web-cli"
|
|
34
|
+
},
|
|
35
|
+
"keywords": [
|
|
36
|
+
"mxl",
|
|
37
|
+
"web",
|
|
38
|
+
"tracking",
|
|
39
|
+
"observability",
|
|
40
|
+
"instrumentation",
|
|
41
|
+
"telemetry",
|
|
42
|
+
"otel",
|
|
43
|
+
"cli"
|
|
44
|
+
],
|
|
45
|
+
"dependencies": {
|
|
46
|
+
"commander": "14.0.2"
|
|
47
|
+
},
|
|
48
|
+
"engines": {
|
|
49
|
+
"node": ">=18.0.0"
|
|
50
|
+
}
|
|
51
|
+
}
|