@capawesome/cli 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.5.0](https://github.com/capawesome-team/cli/compare/v1.4.1...v1.5.0) (2025-02-21)
+
+
+### Features
+
+* **apps:bundles:create:** support code signing for self-hosted bundles ([ebc84ec](https://github.com/capawesome-team/cli/commit/ebc84ecdf3006e9b68491d3082991d0bcf8f9423))
+
+
+### Bug Fixes
+
+* **apps:bundles:create:** provide a url without path to support self-hosted bundles ([1dcf020](https://github.com/capawesome-team/cli/commit/1dcf020ff006445e3ff211ed66a1cec1afdd012d))
+
+## [1.4.1](https://github.com/capawesome-team/cli/compare/v1.4.0...v1.4.1) (2025-02-16)
+
+
+### Bug Fixes
+
+* **bundles:** add retry mechanism for file upload on failure ([86a62da](https://github.com/capawesome-team/cli/commit/86a62daa2ae50d691791714ef6a5812a6e87dc4b))
+
 ## [1.4.0](https://github.com/capawesome-team/cli/compare/v1.3.2...v1.4.0) (2025-01-29)
 
 

package/README.md

@@ -10,6 +10,16 @@ The Capawesome Cloud CLI can be installed globally via npm:
 npm install -g @capawesome/cli
 ```
 
+## Usage
+
+The Capawesome Cloud CLI can be invoked with the `capawesome` command.
+
+```bash
+npx capawesome <command> [options]
+```
+
+You can find a list of available commands in the [Command Reference](https://capawesome.io/cloud/cli/).
+
 ## Help
 
 The Capawesome Cloud CLI ships with command documentation that is accessible with the `--help` flag.
@@ -18,10 +28,35 @@ The Capawesome Cloud CLI ships with command documentation that is accessible wit
 npx capawesome --help
 ```
 
+## Development
+
+Run the following commands to get started with development:
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/capawesome-team/cli.git
+    ```
+
+2. Install dependencies:
+
+    ```bash
+    npm install
+    ```
+
+3. Copy the `.capawesomerc.example` file to `.capawesomerc`
+4. Run your first command:
+
+    ```bash
+    npm start -- --help
+    ```
+
+    **Note:** The `--` is required to pass arguments to the script.
+
 ## Changelog
 
 See [CHANGELOG](./CHANGELOG.md).
 
 ## License
 
-See [LICENSE](./LICENSE.md).
+See [LICENSE](./LICENSE.md).

package/dist/commands/apps/bundles/create.js

@@ -127,6 +127,7 @@ exports.default = (0, citty_1.defineCommand)({
             }
             rolloutPercentage = rolloutAsNumber;
         }
+        // Check that either a path or a url is provided
         if (!path && !url) {
             path = yield (0, prompt_1.prompt)('Enter the path to the app bundle:', {
                 type: 'text',
@@ -136,6 +137,7 @@ exports.default = (0, citty_1.defineCommand)({
                 process.exit(1);
             }
         }
+        // Check that the path is a directory when creating a bundle with an artifact type
         if (artifactType === 'manifest' && path) {
             const pathIsDirectory = (0, file_1.isDirectory)(path);
             if (!pathIsDirectory) {
@@ -143,12 +145,20 @@ exports.default = (0, citty_1.defineCommand)({
                 process.exit(1);
             }
         }
-        // Check if the path exists
-        const pathExists = yield (0, file_1.fileExistsAtPath)(path);
-        if (!pathExists) {
-            consola_1.default.error(`The path does not exist.`);
+        // Check that a URL is not provided when creating a bundle with an artifact type of manifest
+        if (artifactType === 'manifest' && url) {
+            consola_1.default.error('It is not yet possible to provide a URL when creating a bundle with an artifact type of `manifest`.');
             process.exit(1);
         }
+        // Check if the path exists when a path is provided
+        if (path) {
+            const pathExists = yield (0, file_1.fileExistsAtPath)(path);
+            if (!pathExists) {
+                consola_1.default.error(`The path does not exist.`);
+                process.exit(1);
+            }
+        }
+        // Let the user select an app and channel if not provided
         if (!appId) {
             const apps = yield apps_1.default.findAll();
             if (apps.length === 0) {
@@ -180,6 +190,7 @@ exports.default = (0, citty_1.defineCommand)({
                 }
             }
         }
+        // Create the private key buffer
         let privateKeyBuffer;
         if (privateKey) {
             if (privateKey.endsWith('.pem')) {
@@ -201,10 +212,22 @@ exports.default = (0, citty_1.defineCommand)({
         try {
             // Create the app bundle
             consola_1.default.start('Creating bundle...');
+            let checksum;
+            let signature;
+            if (path && url) {
+                const fileBuffer = yield (0, buffer_1.createBufferFromPath)(path);
+                // Generate checksum
+                checksum = yield (0, hash_1.createHash)(fileBuffer);
+                // Sign the bundle
+                if (privateKeyBuffer) {
+                    signature = yield (0, signature_1.createSignature)(privateKeyBuffer, fileBuffer);
+                }
+            }
             const response = yield app_bundles_1.default.create({
                 appId,
                 artifactType,
                 channelName,
+                checksum,
                 customProperties: parseCustomProperties(customProperty),
                 expiresAt: expiresAt,
                 url,
@@ -213,21 +236,28 @@ exports.default = (0, citty_1.defineCommand)({
                 minAndroidAppVersionCode: androidMin,
                 minIosAppVersionCode: iosMin,
                 rolloutPercentage,
+                signature,
             });
             appBundleId = response.id;
             if (path) {
-                let appBundleFileId;
-                // Upload the app bundle files
-                if (artifactType === 'manifest') {
-                    yield uploadFiles({ appId, appBundleId: response.id, path, privateKeyBuffer });
+                if (url) {
+                    // Important: Do NOT upload files if the URL is provided.
+                    // The user wants to self-host the bundle. The path is only needed for code signing.
                 }
                 else {
-                    const result = yield uploadZip({ appId, appBundleId: response.id, path, privateKeyBuffer });
-                    appBundleFileId = result.appBundleFileId;
+                    let appBundleFileId;
+                    // Upload the app bundle files
+                    if (artifactType === 'manifest') {
+                        yield uploadFiles({ appId, appBundleId: response.id, path, privateKeyBuffer });
+                    }
+                    else {
+                        const result = yield uploadZip({ appId, appBundleId: response.id, path, privateKeyBuffer });
+                        appBundleFileId = result.appBundleFileId;
+                    }
+                    // Update the app bundle
+                    consola_1.default.start('Updating bundle...');
+                    yield app_bundles_1.default.update({ appBundleFileId, appId, artifactStatus: 'ready', appBundleId: response.id });
                 }
-                // Update the app bundle
-                consola_1.default.start('Updating bundle...');
-                yield app_bundles_1.default.update({ appBundleFileId, appId, artifactStatus: 'ready', appBundleId: response.id });
             }
             consola_1.default.success('Bundle successfully created.');
             consola_1.default.info(`Bundle ID: ${response.id}`);
@@ -245,23 +275,31 @@ exports.default = (0, citty_1.defineCommand)({
     }),
 });
 const uploadFile = (options) => __awaiter(void 0, void 0, void 0, function* () {
-    // Generate checksum
-    const hash = yield (0, hash_1.createHash)(options.fileBuffer);
-    // Sign the bundle
-    let signature;
-    if (options.privateKeyBuffer) {
-        signature = yield (0, signature_1.createSignature)(options.privateKeyBuffer, options.fileBuffer);
+    try {
+        // Generate checksum
+        const hash = yield (0, hash_1.createHash)(options.fileBuffer);
+        // Sign the bundle
+        let signature;
+        if (options.privateKeyBuffer) {
+            signature = yield (0, signature_1.createSignature)(options.privateKeyBuffer, options.fileBuffer);
+        }
+        // Create the multipart upload
+        return yield app_bundle_files_1.default.create({
+            appId: options.appId,
+            appBundleId: options.appBundleId,
+            checksum: hash,
+            fileBuffer: options.fileBuffer,
+            fileName: options.fileName,
+            href: options.href,
+            signature,
+        });
+    }
+    catch (error) {
+        if (options.retryOnFailure) {
+            return uploadFile(Object.assign(Object.assign({}, options), { retryOnFailure: false }));
+        }
+        throw error;
     }
-    // Create the multipart upload
-    return app_bundle_files_1.default.create({
-        appId: options.appId,
-        appBundleId: options.appBundleId,
-        checksum: hash,
-        fileBuffer: options.fileBuffer,
-        fileName: options.fileName,
-        href: options.href,
-        signature,
-    });
 });
 const uploadFiles = (options) => __awaiter(void 0, void 0, void 0, function* () {
     // Generate the manifest file
@@ -288,6 +326,7 @@ const uploadFiles = (options) => __awaiter(void 0, void 0, void 0, function* ()
             fileName,
             href,
             privateKeyBuffer: options.privateKeyBuffer,
+            retryOnFailure: true,
         });
         yield uploadNextFile();
     });

package/dist/services/update.js

@@ -53,7 +53,7 @@ class UpdateServiceImpl {
                 }
             }
             catch (error) {
-                consola_1.default.error('Failed to check for updates.');
+                consola_1.default.warn('Failed to check for updates.');
             }
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/cli",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "The Capawesome Cloud Command Line Interface (CLI) to manage Live Updates and more.",
   "scripts": {
     "build": "patch-package && rimraf ./dist && tsc",