eoas 3.0.5 → 3.1.0

package/README.md

@@ -1,15 +1,15 @@
-# EOAS (Expo Open Application Services)
+# EOAS
 
-EOAS ((Expo Open Application Services) is a powerful helper package designed to simplify the setup and update publication process for the [expo-open-ota](https://github.com/mercuretechnologies/expo-open-ota) project.
+EOAS is a powerful helper package designed to simplify the setup and update publication process for the [xprem](https://github.com/mercuretechnologies/xprem) project.
 
 ## Quick Start
 
 To get started with EOAS, check out the official documentation:
-[EOAS Official Documentation](https://mercure-technologies.gitbook.io/expo-open-ota/eoas/overview)
+[EOAS Official Documentation](https://mercure-technologies.gitbook.io/xprem/eoas/overview)
 
 ## Learn More
-For detailed information and to explore the core functionalities of expo-open-ota, visit the main repository:
-[expo-open-ota on GitHub](https://github.com/mercuretechnologies/expo-open-ota)
+For detailed information and to explore the core functionalities of xprem, visit the main repository:
+[xprem on GitHub](https://github.com/mercuretechnologies/xprem)
 
 ---
 

package/bin/dev.js

@@ -1,4 +1,7 @@
 #!/usr/bin/env node
+// Silence DEP0040 (punycode) emitted by node-fetch@2 -> whatwg-url@5 on Node 21+.
+process.noDeprecation = true;
+
 // eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
 (async () => {
   const oclif = await import('@oclif/core');

package/bin/run.js

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+// Silence DEP0040 (punycode) emitted by node-fetch@2 -> whatwg-url@5 on Node 21+.
+process.noDeprecation = true;
+
 // eslint-disable-next-line unicorn/prefer-top-level-await
 (async () => {
   const oclif = await import('@oclif/core')

package/dist/commands/generate-certs.js

@@ -8,6 +8,9 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const log_1 = tslib_1.__importDefault(require("../lib/log"));
 const prompts_1 = require("../lib/prompts");
 const utils_1 = require("../lib/utils");
+// Owner read/write only: the private key signs every update served by the OTA
+// server.
+const PRIVATE_KEY_MODE = 0o600;
 class GenerateCerts extends core_1.Command {
     static args = {};
     static description = 'Generate private & public certificates for code signing';
@@ -46,6 +49,20 @@ class GenerateCerts extends core_1.Command {
                 }
             },
         });
+        const keyOutput = path_1.default.resolve(process.cwd(), keyOutputDir);
+        const privateKeyPath = path_1.default.join(keyOutput, 'private-key.pem');
+        if ((0, fs_extra_1.existsSync)(privateKeyPath)) {
+            const overwrite = await (0, prompts_1.confirmAsync)({
+                message: `${privateKeyPath} already exists. Overwrite it? Updates signed with the current key will no longer be accepted by apps embedding the matching certificate.`,
+                name: 'overwritePrivateKey',
+                type: 'confirm',
+                initial: false,
+            });
+            if (!overwrite) {
+                log_1.default.warn('Aborted: no certificate or key was written.');
+                return;
+            }
+        }
         const { certificateCommonName } = await (0, prompts_1.promptAsync)({
             message: 'Please enter your Organization name',
             name: 'certificateCommonName',
@@ -66,7 +83,6 @@ class GenerateCerts extends core_1.Command {
         });
         const validityDurationYears = Math.floor(Number(certificateValidityDurationYears));
         const certificateOutput = path_1.default.resolve(process.cwd(), certificateOutputDir);
-        const keyOutput = path_1.default.resolve(process.cwd(), keyOutputDir);
         const validityNotBefore = new Date();
         const validityNotAfter = new Date();
         validityNotAfter.setFullYear(validityNotAfter.getFullYear() + validityDurationYears);
@@ -82,9 +98,13 @@ class GenerateCerts extends core_1.Command {
         // Before the key touches the disk, so there is no window where it exists
         // uncovered by the ignore rule.
         (0, utils_1.ensurePrivateKeyIgnored)(process.cwd());
+        // Removed first: writeFile only applies the mode when it creates the file,
+        // so overwriting an existing key would keep its (possibly world readable)
+        // permissions.
+        await (0, fs_extra_1.remove)(privateKeyPath);
         await Promise.all([
             (0, fs_extra_1.writeFile)(path_1.default.join(keyOutput, 'public-key.pem'), keyPairPEM.publicKeyPEM),
-            (0, fs_extra_1.writeFile)(path_1.default.join(keyOutput, 'private-key.pem'), keyPairPEM.privateKeyPEM),
+            (0, fs_extra_1.writeFile)(privateKeyPath, keyPairPEM.privateKeyPEM, { mode: PRIVATE_KEY_MODE }),
             (0, fs_extra_1.writeFile)(path_1.default.join(certificateOutput, 'certificate.pem'), certificatePEM),
         ]);
         log_1.default.succeed(`Generated public and private keys output in ${keyOutputDir}. Please follow the documentation to securely store them and do not commit them to your repository.`);

package/dist/commands/init.js

@@ -12,7 +12,7 @@ const prompts_1 = require("../lib/prompts");
 const utils_1 = require("../lib/utils");
 class Init extends core_1.Command {
     static args = {};
-    static description = 'Configure your existing expo project with Expo Open OTA';
+    static description = 'Configure your existing expo project with xprem';
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {};
     async run() {
@@ -31,7 +31,7 @@ class Init extends core_1.Command {
             ?.projectId;
         const { appId } = await (0, prompts_1.promptAsync)({
             message: 'Enter the project id for this project (sent as the expo-app-id header).\n' +
-                '  See https://mercure-technologies.gitbook.io/expo-open-ota/stateless-mode/getting-started for details.',
+                '  See https://mercure-technologies.gitbook.io/xprem/stateless-mode/getting-started for details.',
             name: 'appId',
             type: 'text',
             initial: detectedAppId,

package/dist/commands/publish.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const eas_build_job_1 = require("@expo/eas-build-job");
 const spawn_async_1 = tslib_1.__importDefault(require("@expo/spawn-async"));
 const core_1 = require("@oclif/core");
+const crypto_1 = require("crypto");
 const form_data_1 = tslib_1.__importDefault(require("form-data"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const mime_1 = tslib_1.__importDefault(require("mime"));
@@ -243,6 +244,9 @@ class Publish extends core_1.Command {
             process.exit(1);
         }
         let uploadUrls = [];
+        // One group id for the whole run: every platform update of this publish
+        // shares it, so control plane servers list them as a single publish.
+        const publishGroupId = (0, crypto_1.randomUUID)();
         try {
             uploadUrls = await Promise.all(runtimeVersions.map(async ({ runtimeVersion, platform }) => {
                 if (!runtimeVersion) {
@@ -260,50 +264,56 @@ class Publish extends core_1.Command {
                         commitHash,
                         message: resolvedMessage,
                         rolloutPercentage,
+                        publishGroup: publishGroupId,
                         branch,
                     })),
                     runtimeVersion,
                     platform,
                 };
             }));
-            const allItems = uploadUrls.flatMap(({ uploadRequests }) => uploadRequests);
-            await Promise.all(allItems.map(async (itm) => {
+            // Every path and URL the server handed back is checked here, before a
+            // single file is opened. A server that forges a filePath would otherwise
+            // make the CLI read arbitrary files off this machine and PUT them wherever
+            // it likes. Validated per response: each platform gets its own upload URLs
+            // for the same files.
+            const resolvedUploads = (await Promise.all(uploadUrls.map(({ uploadRequests }) => (0, assets_1.resolveUploadRequests)({
+                uploadRequests,
+                exportDir: path_1.default.join(projectDir, outputDir),
+                manifest: files,
+            })))).flat();
+            await Promise.all(resolvedUploads.map(async ({ item: itm, absolutePath, manifestEntry }) => {
                 const isLocalBucketFileUpload = itm.requestUploadUrl.startsWith(`${serverUrl}/${appId}/uploadLocalFile`);
-                const formData = new form_data_1.default();
-                let file;
-                try {
-                    file = fs_extra_1.default.createReadStream(path_1.default.join(projectDir, outputDir, itm.filePath));
-                }
-                catch {
-                    throw new Error(`Failed to read file ${itm.filePath}`);
-                }
-                formData.append(itm.fileName, file);
                 if (isLocalBucketFileUpload) {
-                    const response = await (0, fetch_1.fetchWithRetries)(itm.requestUploadUrl, {
-                        method: 'PUT',
-                        headers: {
-                            ...formData.getHeaders(),
-                            ...(0, auth_1.getAuthHeaders)(credentials),
-                        },
-                        body: formData,
-                    });
-                    if (!response.ok) {
-                        log_1.default.error('Failed to upload file', await response.text());
-                        throw new Error('Failed to upload file');
+                    const formData = new form_data_1.default();
+                    const file = fs_extra_1.default.createReadStream(absolutePath);
+                    formData.append(itm.fileName, file);
+                    try {
+                        const response = await (0, fetch_1.fetchWithRetries)(itm.requestUploadUrl, {
+                            method: 'PUT',
+                            headers: {
+                                ...formData.getHeaders(),
+                                ...(0, auth_1.getAuthHeaders)(credentials),
+                            },
+                            body: formData,
+                            // The URL was validated as a string; following a redirect would
+                            // send these bytes to an origin nothing ever checked.
+                            redirect: 'error',
+                        });
+                        if (!response.ok) {
+                            log_1.default.error('Failed to upload file', await response.text());
+                            throw new Error('Failed to upload file');
+                        }
+                    }
+                    finally {
+                        file.close();
                     }
-                    file.close();
                     return;
                 }
-                const findFile = files.find(f => f.path === itm.filePath || f.name === itm.fileName);
-                if (!findFile) {
-                    log_1.default.error(`File ${itm.filePath} not found`);
-                    throw new Error(`File ${itm.filePath} not found`);
-                }
-                let contentType = mime_1.default.getType(findFile.ext);
+                let contentType = mime_1.default.getType(manifestEntry.ext);
                 if (!contentType) {
                     contentType = 'application/octet-stream';
                 }
-                const buffer = await fs_extra_1.default.readFile(path_1.default.join(projectDir, outputDir, itm.filePath));
+                const buffer = await fs_extra_1.default.readFile(absolutePath);
                 const response = await (0, fetch_1.fetchWithRetries)(itm.requestUploadUrl, {
                     method: 'PUT',
                     headers: {
@@ -312,12 +322,17 @@ class Publish extends core_1.Command {
                         ...(itm.headers ?? {}),
                     },
                     body: buffer,
+                    // Only the URL string was validated. node-fetch follows up to 20
+                    // redirects by default with no protocol or host check, so a server
+                    // handing back a valid https URL that 302s to http://internal-host
+                    // would exfiltrate the bundle in cleartext to an origin of its
+                    // choosing. Nothing legitimate redirects an upload PUT.
+                    redirect: 'error',
                 });
                 if (!response.ok) {
                     log_1.default.error('❌ File upload failed', await response.text());
                     process.exit(1);
                 }
-                file.close();
             }));
             uploadFilesSpinner.succeed('✅ Files uploaded successfully');
         }
@@ -385,6 +400,15 @@ class Publish extends core_1.Command {
         if (hasSuccess) {
             log_1.default.withInfo(`🌿 Branch: \`${branch}\``);
             log_1.default.withInfo(`⏳ Deployed at: \`${new Date().toUTCString()}\`\n`);
+            const groupAcknowledged = uploadUrls.every(u => u.publishGroup === publishGroupId);
+            if (groupAcknowledged) {
+                log_1.default.withInfo(`📦 Publish group: \`${publishGroupId}\``);
+            }
+            else if (uploadUrls.length > 1) {
+                // Only worth a note when several platforms were published: a single
+                // update has nothing to group anyway.
+                log_1.default.withInfo('ℹ️ Platform updates were published without grouping (publish groups require a server in control plane mode).');
+            }
             log_1.default.withInfo('🔥 Your users will receive the latest update automatically!');
         }
     }

package/dist/commands/republish.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const ora_1 = tslib_1.__importDefault(require("ora"));
 const auth_1 = require("../lib/auth");
 const expoConfig_1 = require("../lib/expoConfig");
 const fetch_1 = require("../lib/fetch");
 const log_1 = tslib_1.__importDefault(require("../lib/log"));
+const ora_1 = require("../lib/ora");
 const package_1 = require("../lib/package");
 const prompts_1 = require("../lib/prompts");
+const serverUpdates_1 = require("../lib/serverUpdates");
 const vcs_1 = require("../lib/vcs");
 class Publish extends core_1.Command {
     static args = {};
@@ -50,7 +51,6 @@ class Publish extends core_1.Command {
         }
         const vcsClient = (0, vcs_1.resolveVcsClient)(true);
         await vcsClient.ensureRepoExistsAsync();
-        // const commitHash = await vcsClient.getCommitHashAsync();
         const projectDir = process.cwd();
         const hasExpo = (0, package_1.isExpoInstalled)(projectDir);
         if (!hasExpo) {
@@ -75,24 +75,19 @@ class Publish extends core_1.Command {
             log_1.default.error('Invalid URL', e);
             process.exit(1);
         }
-        const runtimeVersionsEndpoint = `${baseUrl}/api/apps/${appId}/branch/${branch}/runtimeVersions`;
-        const response = await (0, fetch_1.fetchWithRetries)(runtimeVersionsEndpoint, {
-            headers: {
-                ...(0, auth_1.getAuthHeaders)(credentials),
-                'use-cli-auth': 'true',
-            },
-        });
-        if (!response.ok) {
-            log_1.default.error(`Failed to fetch runtime versions: ${await response.text()}`);
+        let runtimeVersions;
+        try {
+            runtimeVersions = await (0, serverUpdates_1.fetchRuntimeVersions)({ baseUrl, appId, branch, credentials });
+        }
+        catch (e) {
+            log_1.default.error(e instanceof Error ? e.message : e);
             process.exit(1);
         }
-        const runtimeVersions = (await response.json());
         const filteredRuntimeVersions = runtimeVersions.filter(runtimeVersion => runtimeVersion.numberOfUpdates > 1);
         if (filteredRuntimeVersions.length === 0) {
             log_1.default.error('No runtime versions found');
             process.exit(1);
         }
-        // Ask the user to select a runtime version
         const selectedRuntimeVersion = await (0, prompts_1.promptAsync)({
             type: 'select',
             name: 'runtimeVersion',
@@ -103,21 +98,86 @@ class Publish extends core_1.Command {
             })),
         });
         log_1.default.log(`Selected runtime version: ${selectedRuntimeVersion.runtimeVersion}`);
-        const updatesEndpoint = `${baseUrl}/api/apps/${appId}/branch/${branch}/runtimeVersion/${selectedRuntimeVersion.runtimeVersion}/updates`;
-        const updatesResponse = await (0, fetch_1.fetchWithRetries)(updatesEndpoint, {
-            headers: {
-                ...(0, auth_1.getAuthHeaders)(credentials),
-                'use-cli-auth': 'true',
-            },
-        });
-        if (!updatesResponse.ok) {
-            log_1.default.error(`Failed to fetch updates: ${await updatesResponse.text()}`);
+        let allUpdates;
+        try {
+            allUpdates = await (0, serverUpdates_1.fetchUpdates)({
+                baseUrl,
+                appId,
+                branch,
+                runtimeVersion: selectedRuntimeVersion.runtimeVersion,
+                credentials,
+            });
+        }
+        catch (e) {
+            log_1.default.error(e instanceof Error ? e.message : e);
             process.exit(1);
         }
-        const updates = (await updatesResponse.json()).filter(u => {
-            return (u.updateUUID !== 'Rollback to embedded' && (platform === 'all' || u.platform === platform));
-        });
+        // Rollback markers have no files to republish.
+        const updates = allUpdates.filter(u => u.updateUUID !== 'Rollback to embedded');
         if (updates.length === 0) {
+            log_1.default.error(`No republishable updates found for runtime version ${selectedRuntimeVersion.runtimeVersion}.`);
+            process.exit(1);
+        }
+        const { groups } = (0, serverUpdates_1.groupPublishedUpdates)(updates);
+        // Offer the group mode only when there is something to group and the user
+        // did not already narrow the run to one platform.
+        let mode = 'single';
+        if (platform === 'all' && groups.length > 0) {
+            const selectedMode = await (0, prompts_1.promptAsync)({
+                type: 'select',
+                name: 'mode',
+                message: 'What do you want to republish?',
+                choices: [
+                    {
+                        title: 'A full publish (all its platforms together)',
+                        description: 'Only for servers in control plane mode',
+                        value: 'group',
+                    },
+                    {
+                        title: 'A single platform update',
+                        description: 'Pick one iOS or Android update',
+                        value: 'single',
+                    },
+                ],
+            });
+            mode = selectedMode.mode;
+        }
+        if (mode === 'group') {
+            const selectedGroup = await (0, prompts_1.promptAsync)({
+                type: 'select',
+                name: 'group',
+                message: 'Select a publish to republish',
+                choices: groups.map(group => ({
+                    ...(0, serverUpdates_1.describePublishGroup)(group),
+                    value: group,
+                })),
+            });
+            const group = selectedGroup.group;
+            const republishUrl = new URL(`${baseUrl}/${appId}/republish/${branch}`);
+            republishUrl.searchParams.set('runtimeVersion', selectedRuntimeVersion.runtimeVersion);
+            republishUrl.searchParams.set('publishGroup', group.publishGroup);
+            const republishSpinner = (0, ora_1.ora)(`🔄 Republishing ${group.platforms.join(' + ')} updates...`).start();
+            const response = await (0, fetch_1.fetchWithRetries)(republishUrl.toString(), {
+                method: 'POST',
+                headers: {
+                    ...(0, auth_1.getAuthHeaders)(credentials),
+                    'use-cli-auth': 'true',
+                    'Content-Type': 'application/json',
+                },
+            });
+            if (!response.ok) {
+                republishSpinner.fail('❌ Republish failed');
+                log_1.default.error(`Failed to republish publish group: ${await response.text()}`);
+                process.exit(1);
+            }
+            const result = (await response.json());
+            republishSpinner.succeed(result.publishGroup
+                ? `✅ Republished ${group.platforms.join(' + ')} as publish group ${result.publishGroup}`
+                : `✅ Republished ${group.platforms.join(' + ')}`);
+            return;
+        }
+        const platformUpdates = updates.filter(u => platform === 'all' || u.platform === platform);
+        if (platformUpdates.length === 0) {
             log_1.default.error(`No republishable updates found for runtime version ${selectedRuntimeVersion.runtimeVersion} on platform ${platform}.`);
             process.exit(1);
         }
@@ -125,7 +185,7 @@ class Publish extends core_1.Command {
             type: 'select',
             name: 'update',
             message: 'Select an update to republish',
-            choices: updates.map(update => ({
+            choices: platformUpdates.map(update => ({
                 title: update.updateUUID,
                 value: update,
                 description: `Created at: ${update.createdAt}, Platform: ${update.platform}, Commit hash: ${update.commitHash}`,
@@ -137,7 +197,7 @@ class Publish extends core_1.Command {
         republishUrl.searchParams.set('runtimeVersion', selectedRuntimeVersion.runtimeVersion);
         republishUrl.searchParams.set('updateId', selectedUpdated.update.updateId);
         republishUrl.searchParams.set('commitHash', selectedUpdated.update.commitHash);
-        const republishSpinner = (0, ora_1.default)('🔄 Republishing update...').start();
+        const republishSpinner = (0, ora_1.ora)('🔄 Republishing update...').start();
         const republishResponse = await (0, fetch_1.fetchWithRetries)(republishUrl.toString(), {
             method: 'POST',
             headers: {

package/dist/commands/server/init.d.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+import { type Deployment } from '../../lib/serverConfig/choices';
+/** A master key found in the file the wizard is about to replace. `unreadable`
+ * distinguishes "the file has no key" from "the file could not be parsed". */
+type ExistingMasterKey = {
+    key?: string;
+    unreadable: boolean;
+};
+export declare function readExistingMasterKey(deployment: Deployment): Promise<ExistingMasterKey>;
+export default class ServerInit extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}
+export {};