@alwaysmeticulous/downloading-helpers 2.89.0 → 2.91.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/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/scripts/replays.d.ts +2 -1
- package/dist/scripts/replays.js +30 -20
- package/dist/scripts/replays.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { sanitizeFilename } from "./file-downloads/local-data.utils";
|
|
2
|
-
export { getOrFetchReplay, getOrFetchReplayArchive } from "./scripts/replays";
|
|
2
|
+
export { getOrFetchReplay, getOrFetchReplayArchive, DownloadScope, } from "./scripts/replays";
|
|
3
3
|
export { getOrFetchRecordedSession, getOrFetchRecordedSessionData, } from "./file-downloads/sessions";
|
|
4
4
|
export { fetchAsset } from "./scripts/replay-assets";
|
|
5
5
|
export { downloadFile, downloadAndExtractFile, } from "./file-downloads/download-file";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,sEAAqE;AAA5D,oHAAA,gBAAgB,OAAA;AACzB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,sEAAqE;AAA5D,oHAAA,gBAAgB,OAAA;AACzB,6CAI2B;AAHzB,2GAAA,gBAAgB,OAAA;AAChB,kHAAA,uBAAuB,OAAA;AAGzB,sDAGmC;AAFjC,qHAAA,yBAAyB,OAAA;AACzB,yHAAA,6BAA6B,OAAA;AAE/B,yDAAqD;AAA5C,2GAAA,UAAU,OAAA;AACnB,gEAGwC;AAFtC,6GAAA,YAAY,OAAA;AACZ,uHAAA,sBAAsB,OAAA;AAExB,6CAAiD;AAAxC,uGAAA,YAAY,OAAA"}
|
|
@@ -2,7 +2,8 @@ import { AxiosInstance } from "axios";
|
|
|
2
2
|
export declare const getOrFetchReplay: (client: AxiosInstance, replayId: string) => Promise<{
|
|
3
3
|
fileName: string;
|
|
4
4
|
}>;
|
|
5
|
-
export
|
|
5
|
+
export type DownloadScope = "everything" | "screenshots-only";
|
|
6
|
+
export declare const getOrFetchReplayArchive: (client: AxiosInstance, replayId: string, downloadScope?: DownloadScope) => Promise<{
|
|
6
7
|
fileName: string;
|
|
7
8
|
}>;
|
|
8
9
|
export declare const getReplayDir: (replayId: string) => string;
|
package/dist/scripts/replays.js
CHANGED
|
@@ -29,7 +29,7 @@ const getOrFetchReplay = async (client, replayId) => {
|
|
|
29
29
|
return { fileName: replayFile };
|
|
30
30
|
};
|
|
31
31
|
exports.getOrFetchReplay = getOrFetchReplay;
|
|
32
|
-
const getOrFetchReplayArchive = async (client, replayId) => {
|
|
32
|
+
const getOrFetchReplayArchive = async (client, replayId, downloadScope = "everything") => {
|
|
33
33
|
const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
|
|
34
34
|
const replayDir = (0, exports.getReplayDir)(replayId);
|
|
35
35
|
await (0, promises_1.mkdir)(replayDir, { recursive: true });
|
|
@@ -47,7 +47,7 @@ const getOrFetchReplayArchive = async (client, replayId) => {
|
|
|
47
47
|
await downloadReplayV2Archive(client, replayId, replayDir);
|
|
48
48
|
}
|
|
49
49
|
else if (replay.version === "v3") {
|
|
50
|
-
await downloadReplayV3Files(client, replayId, replayDir);
|
|
50
|
+
await downloadReplayV3Files(client, replayId, replayDir, downloadScope);
|
|
51
51
|
}
|
|
52
52
|
else {
|
|
53
53
|
throw new Error(`Error: Unknown replay version "${replay.version}". This may be an invalid replay`);
|
|
@@ -70,39 +70,49 @@ const downloadReplayV2Archive = async (client, replayId, replayDir) => {
|
|
|
70
70
|
await (0, extract_zip_1.default)(replayArchiveFile, { dir: replayDir });
|
|
71
71
|
await (0, promises_1.rm)(replayArchiveFile);
|
|
72
72
|
};
|
|
73
|
-
const downloadReplayV3Files = async (client, replayId, replayDir) => {
|
|
73
|
+
const downloadReplayV3Files = async (client, replayId, replayDir, downloadScope) => {
|
|
74
74
|
const downloadUrls = await (0, client_1.getReplayV3DownloadUrls)(client, replayId);
|
|
75
75
|
if (!downloadUrls) {
|
|
76
76
|
throw new Error("Error: Could not retrieve replay download URLs. This may be an invalid replay");
|
|
77
77
|
}
|
|
78
78
|
const { screenshots, snapshottedAssets, ...rest } = downloadUrls;
|
|
79
79
|
await (0, promises_1.mkdir)((0, path_1.join)(replayDir, "screenshots"), { recursive: true });
|
|
80
|
-
const filePromises =
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
80
|
+
const filePromises = downloadScope === "everything"
|
|
81
|
+
? Object.entries(rest).map(([fileName, data]) => {
|
|
82
|
+
const filePath = (0, path_1.join)(replayDir, fileName);
|
|
83
|
+
return () => (0, download_file_1.downloadAndExtractFile)(data.signedUrl, filePath, replayDir);
|
|
84
|
+
})
|
|
85
|
+
: [];
|
|
84
86
|
const screenshotPromises = Object.values(screenshots).flatMap((data) => {
|
|
85
87
|
const imageFilePath = (0, path_1.join)(replayDir, data.image.filePath);
|
|
86
|
-
const
|
|
88
|
+
const metadata = data.metadata;
|
|
89
|
+
if ((metadata === null || metadata === void 0 ? void 0 : metadata.filePath) == null) {
|
|
90
|
+
return [() => (0, download_file_1.downloadFile)(data.image.signedUrl, imageFilePath)];
|
|
91
|
+
}
|
|
92
|
+
const metadataFilePath = (0, path_1.join)(replayDir, metadata.filePath);
|
|
87
93
|
return [
|
|
88
94
|
() => (0, download_file_1.downloadFile)(data.image.signedUrl, imageFilePath),
|
|
89
95
|
async () => {
|
|
90
|
-
await (0, download_file_1.downloadAndExtractFile)(
|
|
96
|
+
await (0, download_file_1.downloadAndExtractFile)(metadata.signedUrl, metadataFilePath, (0, path_1.join)(replayDir, (0, path_1.dirname)(metadata.filePath)));
|
|
91
97
|
},
|
|
92
98
|
];
|
|
93
99
|
});
|
|
94
|
-
const
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
100
|
+
const snapshottedAssetsPromises = downloadScope === "everything"
|
|
101
|
+
? [
|
|
102
|
+
async () => {
|
|
103
|
+
if (!snapshottedAssets) {
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
const snapshottedAssetsDir = (0, path_1.join)(replayDir, "snapshotted-assets");
|
|
107
|
+
await (0, promises_1.mkdir)(snapshottedAssetsDir, {
|
|
108
|
+
recursive: true,
|
|
109
|
+
});
|
|
110
|
+
await (0, download_file_1.downloadAndExtractFile)(snapshottedAssets.signedUrl, (0, path_1.join)(replayDir, snapshottedAssets.filePath), snapshottedAssetsDir);
|
|
111
|
+
},
|
|
112
|
+
]
|
|
113
|
+
: [];
|
|
104
114
|
const limited = (0, p_limit_1.default)(MAX_DOWNLOAD_CONCURRENCY);
|
|
105
|
-
await Promise.all([...filePromises, ...screenshotPromises,
|
|
115
|
+
await Promise.all([...filePromises, ...screenshotPromises, ...snapshottedAssetsPromises].map((p) => limited(p)));
|
|
106
116
|
};
|
|
107
117
|
const getReplayDir = (replayId) => (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "replays", replayId);
|
|
108
118
|
exports.getReplayDir = getReplayDir;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"replays.js","sourceRoot":"","sources":["../../src/scripts/replays.ts"],"names":[],"mappings":";;;;;;AAAA,0CAAwC;AACxC,+BAAqC;AACrC,qDAIkC;AAClC,qDAGkC;AAElC,8DAAkC;AAClC,wDAA2B;AAC3B,sDAA6B;AAC7B,mEAGyC;AACzC,yEAI4C;AAE5C,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAE7B,MAAM,gBAAgB,GAAG,KAAK,EACnC,MAAqB,EACrB,QAAgB,EACe,EAAE;IACjC,MAAM,MAAM,GAAG,kBAAG,CAAC,SAAS,CAAC,+BAAsB,CAAC,CAAC;IAErD,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,IAAA,oBAAY,EAAC,QAAQ,CAAC,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAqB,EAAC;QACzC,QAAQ,EAAE,UAAU;QACpB,eAAe,EAAE,QAAQ;QACzB,YAAY,EAAE,GAAG,EAAE,CAAC,IAAA,kBAAS,EAAC,MAAM,EAAE,QAAQ,CAAC;KAChD,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,CAAC,KAAK,CACV,6CAA6C,QAAQ,8BAA8B,CACpF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAClC,CAAC,CAAC;AAtBW,QAAA,gBAAgB,oBAsB3B;
|
|
1
|
+
{"version":3,"file":"replays.js","sourceRoot":"","sources":["../../src/scripts/replays.ts"],"names":[],"mappings":";;;;;;AAAA,0CAAwC;AACxC,+BAAqC;AACrC,qDAIkC;AAClC,qDAGkC;AAElC,8DAAkC;AAClC,wDAA2B;AAC3B,sDAA6B;AAC7B,mEAGyC;AACzC,yEAI4C;AAE5C,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAE7B,MAAM,gBAAgB,GAAG,KAAK,EACnC,MAAqB,EACrB,QAAgB,EACe,EAAE;IACjC,MAAM,MAAM,GAAG,kBAAG,CAAC,SAAS,CAAC,+BAAsB,CAAC,CAAC;IAErD,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,IAAA,oBAAY,EAAC,QAAQ,CAAC,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAqB,EAAC;QACzC,QAAQ,EAAE,UAAU;QACpB,eAAe,EAAE,QAAQ;QACzB,YAAY,EAAE,GAAG,EAAE,CAAC,IAAA,kBAAS,EAAC,MAAM,EAAE,QAAQ,CAAC;KAChD,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,CAAC,KAAK,CACV,6CAA6C,QAAQ,8BAA8B,CACpF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAClC,CAAC,CAAC;AAtBW,QAAA,gBAAgB,oBAsB3B;AAIK,MAAM,uBAAuB,GAAG,KAAK,EAC1C,MAAqB,EACrB,QAAgB,EAChB,gBAA+B,YAAY,EACZ,EAAE;IACjC,MAAM,MAAM,GAAG,kBAAG,CAAC,SAAS,CAAC,+BAAsB,CAAC,CAAC;IAErD,MAAM,SAAS,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,IAAA,gBAAK,EAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,MAAM,IAAA,+CAA4B,EAAC,SAAS,CAAC,CAAC;IAElE,IAAI;QACF,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAEpD,gEAAgE;QAChE,iDAAiD;QACjD,IAAI,MAAM,IAAA,6BAAU,EAAC,UAAU,CAAC,EAAE;YAChC,MAAM,CAAC,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;YAClE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;SAChC;QAED,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAS,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YACzC,MAAM,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;SAC5D;aAAM,IAAI,MAAM,CAAC,OAAO,KAAK,IAAI,EAAE;YAClC,MAAM,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;SACzE;aAAM;YACL,MAAM,IAAI,KAAK,CACb,kCAAkC,MAAM,CAAC,OAAO,kCAAkC,CACnF,CAAC;SACH;QAED,MAAM,CAAC,KAAK,CAAC,+BAA+B,SAAS,EAAE,CAAC,CAAC;QACzD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;KAChC;YAAS;QACR,MAAM,WAAW,EAAE,CAAC;KACrB;AACH,CAAC,CAAC;AAtCW,QAAA,uBAAuB,2BAsClC;AAEF,MAAM,uBAAuB,GAAG,KAAK,EACnC,MAAqB,EACrB,QAAgB,EAChB,SAAiB,EACjB,EAAE;IACF,MAAM,iBAAiB,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;IAE7D,MAAM,eAAe,GAAG,MAAM,IAAA,6BAAoB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrE,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;KACH;IAED,MAAM,IAAA,4BAAY,EAAC,eAAe,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAElE,MAAM,IAAA,qBAAO,EAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IACrD,MAAM,IAAA,aAAE,EAAC,iBAAiB,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,KAAK,EACjC,MAAqB,EACrB,QAAgB,EAChB,SAAiB,EACjB,aAA4B,EAC5B,EAAE;IACF,MAAM,YAAY,GAAG,MAAM,IAAA,gCAAuB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;KACH;IAED,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAC;IAEjE,MAAM,IAAA,gBAAK,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjE,MAAM,YAAY,GAChB,aAAa,KAAK,YAAY;QAC5B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;YAC5C,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC3C,OAAO,GAAG,EAAE,CACV,IAAA,sCAAsB,EAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;IAET,MAAM,kBAAkB,GAAuC,MAAM,CAAC,MAAM,CAC1E,WAAW,CACZ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjB,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,IAAI,EAAE;YAC9B,OAAO,CAAC,GAAG,EAAE,CAAC,IAAA,4BAAY,EAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;SAClE;QAED,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5D,OAAO;YACL,GAAG,EAAE,CAAC,IAAA,4BAAY,EAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC;YACvD,KAAK,IAAI,EAAE;gBACT,MAAM,IAAA,sCAAsB,EAC1B,QAAQ,CAAC,SAAS,EAClB,gBAAgB,EAChB,IAAA,WAAI,EAAC,SAAS,EAAE,IAAA,cAAO,EAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAC5C,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,yBAAyB,GAC7B,aAAa,KAAK,YAAY;QAC5B,CAAC,CAAC;YACE,KAAK,IAAI,EAAE;gBACT,IAAI,CAAC,iBAAiB,EAAE;oBACtB,OAAO;iBACR;gBAED,MAAM,oBAAoB,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;gBACnE,MAAM,IAAA,gBAAK,EAAC,oBAAoB,EAAE;oBAChC,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;gBACH,MAAM,IAAA,sCAAsB,EAC1B,iBAAiB,CAAC,SAAS,EAC3B,IAAA,WAAI,EAAC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAC3C,oBAAoB,CACrB,CAAC;YACJ,CAAC;SACF;QACH,CAAC,CAAC,EAAE,CAAC;IAET,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,wBAAwB,CAAC,CAAC;IACjD,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,YAAY,EAAE,GAAG,kBAAkB,EAAE,GAAG,yBAAyB,CAAC,CAAC,GAAG,CACxE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAClB,CACF,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,EAAE,CAC/C,IAAA,WAAI,EAAC,IAAA,kCAAyB,GAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAD5C,QAAA,YAAY,gBACgC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwaysmeticulous/downloading-helpers",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.91.0",
|
|
4
4
|
"description": "Helper utilities for downloading files & scripts required to execute replays",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@alwaysmeticulous/api": "^2.89.0",
|
|
23
|
-
"@alwaysmeticulous/client": "^2.
|
|
23
|
+
"@alwaysmeticulous/client": "^2.90.0",
|
|
24
24
|
"@alwaysmeticulous/common": "^2.89.0",
|
|
25
25
|
"axios": "^1.2.6",
|
|
26
26
|
"axios-retry": "^3.5.0",
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"bugs": {
|
|
52
52
|
"url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "13af6921a2d104ff85aa9c04889d83604f84e813"
|
|
55
55
|
}
|