@percy/cli-build 1.31.1-beta.1 → 1.31.1-beta.2

package/README.md

@@ -7,6 +7,10 @@ Commands for interacting with Percy builds
 * [`percy build:finalize`](#percy-buildfinalize)
 * [`percy build:wait`](#percy-buildwait)
 * [`percy build:id`](#percy-buildid)
+* [`percy build:approve`](#percy-buildapprove)
+* [`percy build:unapprove`](#percy-buildunapprove)
+* [`percy build:reject`](#percy-buildreject)
+* [`percy build:delete`](#percy-builddelete)
 
 ### `percy build:finalize`
 
@@ -17,10 +21,11 @@ Usage:
   $ percy build:finalize [options]
 
 Global options:
-  -v, --verbose  Log everything
-  -q, --quiet    Log errors only
-  -s, --silent   Log nothing
-  -h, --help     Display command help
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
 ```
 
 ### `percy build:wait`
@@ -38,12 +43,14 @@ Options:
   -t, --timeout <ms>     Timeout before exiting without updates, defaults to 10 minutes
   -i, --interval <ms>    Interval at which to poll for updates, defaults to 10 second
   -f, --fail-on-changes  Exit with an error when diffs are found
-  --pass-if-approved     Doesn't Exit with an error if the build is approved, requires '--fail-on-changes'
+  --pass-if-approved     Doesn't exit with an error if the build is approved, regardless of if
+                         diffs are found.
 
 Global options:
   -v, --verbose          Log everything
   -q, --quiet            Log errors only
   -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
   -h, --help             Display command help
 
 Examples:
@@ -60,12 +67,129 @@ Usage:
   $ percy build:id [options]
 
 Percy options:
-  -P, --port [number]  Local CLI server port (default: 5338)
+  -P, --port [number]    Local CLI server port (default: 5338)
+
+Global options:
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
+```
+
+### `percy build:approve`
+
+Approve Percy builds
+
+```
+Usage:
+  $ percy build:approve [options] <build-id>
+
+Arguments:
+  build-id               Build ID to approve
+
+Options:
+  --username <string>    Username for authentication (can also be set via BROWSERSTACK_USERNAME env
+                         var)
+  --access-key <string>  Access key for authentication (can also be set via BROWSERSTACK_ACCESS_KEY
+                         env var)
+
+Global options:
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
+
+Examples:
+  $ percy build:approve <build-id>
+  $ percy build:approve <build-id> --username username --access-key **key**
+```
+
+### `percy build:unapprove`
+
+Unapprove Percy builds
+
+```
+Usage:
+  $ percy build:unapprove [options] <build-id>
+
+Arguments:
+  build-id               Build ID to approve
+
+Options:
+  --username <string>    Username for authentication (can also be set via BROWSERSTACK_USERNAME env
+                         var)
+  --access-key <string>  Access key for authentication (can also be set via BROWSERSTACK_ACCESS_KEY
+                         env var)
+
+Global options:
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
+
+Examples:
+  $ percy build:unapprove <build-id>
+  $ percy build:unapprove <build-id> --username username --access-key **key**
+```
+
+### `percy build:reject`
+
+Reject Percy builds
+
+```
+Usage:
+  $ percy build:reject [options] <build-id>
+
+Arguments:
+  build-id               Build ID to approve
+
+Options:
+  --username <string>    Username for authentication (can also be set via BROWSERSTACK_USERNAME env
+                         var)
+  --access-key <string>  Access key for authentication (can also be set via BROWSERSTACK_ACCESS_KEY
+                         env var)
+
+Global options:
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
+
+Examples:
+  $ percy build:reject <build-id>
+  $ percy build:reject <build-id> --username username --access-key **key**
+```
+
+### `percy build:delete`
+
+Delete Percy builds
+
+```
+Usage:
+  $ percy build:delete [options] <build-id>
+
+Arguments:
+  build-id               Build ID to approve
+
+Options:
+  --username <string>    Username for authentication (can also be set via BROWSERSTACK_USERNAME env
+                         var)
+  --access-key <string>  Access key for authentication (can also be set via BROWSERSTACK_ACCESS_KEY
+                         env var)
 
 Global options:
-  -v, --verbose        Log everything
-  -q, --quiet          Log errors only
-  -s, --silent         Log nothing
-  -h, --help           Display command help
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -l, --labels <string>  Associates labels to the build (ex: --labels=dev,prod )
+  -h, --help             Display command help
+
+Examples:
+  $ percy build:delete <build-id>
+  $ percy build:delete <build-id> --username username --access-key **key**
 ```
 <!-- commandsstop -->

package/dist/approve.js

@@ -0,0 +1,49 @@
+import command from '@percy/cli-command';
+import { fetchCredentials, reviewCommandConfig } from './utils.js';
+
+/**
+ * Approve command definition for Percy builds
+ * Allows users to approve builds using build ID and authentication credentials
+ */
+export const approve = command('approve', {
+  description: 'Approve Percy builds',
+  ...reviewCommandConfig
+}, async ({
+  flags,
+  args,
+  percy,
+  log,
+  exit
+}) => {
+  // Early return if Percy is disabled
+  if (!percy) {
+    exit(0, 'Percy is disabled');
+  }
+
+  // Validate and get authentication credentials
+  const {
+    username,
+    accessKey
+  } = fetchCredentials(flags);
+  if (!username || !accessKey) {
+    exit(1, 'Username and access key are required to approve builds.');
+  }
+  log.info(`Approving build ${args.buildId}...`);
+  try {
+    // Call the Percy API to approve the build
+    const buildApprovalResponse = await percy.client.approveBuild(args.buildId, username, accessKey);
+    const approvedBy = buildApprovalResponse.data.attributes['action-performed-by'] || {
+      user_email: 'unknown@example.com',
+      user_name: username
+    };
+    log.info(`Build ${args.buildId} approved successfully!`);
+    log.info(`Approved by: ${approvedBy.user_name} (${approvedBy.user_email})`);
+  } catch (error) {
+    log.error(`Failed to approve build ${args.buildId}`);
+    log.error(error);
+
+    // Provide user-friendly error message
+    exit(1, 'Failed to approve the build');
+  }
+});
+export default approve;

package/dist/build.js

@@ -2,8 +2,12 @@ import command from '@percy/cli-command';
 import finalize from './finalize.js';
 import wait from './wait.js';
 import id from './id.js';
+import approve from './approve.js';
+import reject from './reject.js';
+import unapprove from './unapprove.js';
+import deleteBuild from './delete.js';
 export const build = command('build', {
   description: 'Finalize and wait on Percy builds',
-  commands: [finalize, wait, id]
+  commands: [finalize, wait, id, approve, unapprove, reject, deleteBuild]
 });
 export default build;

package/dist/delete.js

@@ -0,0 +1,49 @@
+import command from '@percy/cli-command';
+import { fetchCredentials, reviewCommandConfig } from './utils.js';
+
+/**
+ * Delete command definition for Percy builds
+ * Allows users to delete builds using build ID and authentication credentials
+ */
+export const deleteBuild = command('delete', {
+  description: 'Delete Percy builds',
+  ...reviewCommandConfig
+}, async ({
+  flags,
+  args,
+  percy,
+  log,
+  exit
+}) => {
+  // Early return if Percy is disabled
+  if (!percy) {
+    exit(0, 'Percy is disabled');
+  }
+
+  // Validate and get authentication credentials
+  const {
+    username,
+    accessKey
+  } = fetchCredentials(flags);
+  if (!username || !accessKey) {
+    exit(1, 'Username and access key are required to delete builds.');
+  }
+  log.info(`Deleting build ${args.buildId}...`);
+  try {
+    // Call the Percy API to delete the build
+    const buildDeletionResponse = await percy.client.deleteBuild(args.buildId, username, accessKey);
+    const deletedBy = buildDeletionResponse['action-performed-by'] || {
+      user_email: 'unknown@example.com',
+      user_name: username
+    };
+    log.info(`Build ${args.buildId} deleted successfully!`);
+    log.info(`Deleted by: ${deletedBy.user_name} (${deletedBy.user_email})`);
+  } catch (error) {
+    log.error(`Failed to delete build ${args.buildId}`);
+    log.error(error);
+
+    // Provide user-friendly error message
+    exit(1, 'Failed to delete the build');
+  }
+});
+export default deleteBuild;

package/dist/index.js

@@ -1,4 +1,8 @@
 export { default, build } from './build.js';
 export { finalize } from './finalize.js';
 export { wait } from './wait.js';
-export { id } from './id.js';
+export { id } from './id.js';
+export { approve } from './approve.js';
+export { reject } from './reject.js';
+export { unapprove } from './unapprove.js';
+export { deleteBuild } from './delete.js';

package/dist/reject.js

@@ -0,0 +1,49 @@
+import command from '@percy/cli-command';
+import { fetchCredentials, reviewCommandConfig } from './utils.js';
+
+/**
+ * Reject command definition for Percy builds
+ * Allows users to reject builds using build ID and authentication credentials
+ */
+export const reject = command('reject', {
+  description: 'Reject Percy builds',
+  ...reviewCommandConfig
+}, async ({
+  flags,
+  args,
+  percy,
+  log,
+  exit
+}) => {
+  // Early return if Percy is disabled
+  if (!percy) {
+    exit(0, 'Percy is disabled');
+  }
+
+  // Validate and get authentication credentials
+  const {
+    username,
+    accessKey
+  } = fetchCredentials(flags);
+  if (!username || !accessKey) {
+    exit(1, 'Username and access key are required to reject builds.');
+  }
+  log.info(`Rejecting build ${args.buildId}...`);
+  try {
+    // Call the Percy API to reject the build
+    const buildRejectionResponse = await percy.client.rejectBuild(args.buildId, username, accessKey);
+    const rejectedBy = buildRejectionResponse.data.attributes['action-performed-by'] || {
+      user_email: 'unknown@example.com',
+      user_name: username
+    };
+    log.info(`Build ${args.buildId} rejected successfully!`);
+    log.info(`Rejected by: ${rejectedBy.user_name} (${rejectedBy.user_email})`);
+  } catch (error) {
+    log.error(`Failed to reject build ${args.buildId}`);
+    log.error(error);
+
+    // Provide user-friendly error message
+    exit(1, 'Failed to reject the build');
+  }
+});
+export default reject;

package/dist/unapprove.js

@@ -0,0 +1,49 @@
+import command from '@percy/cli-command';
+import { fetchCredentials, reviewCommandConfig } from './utils.js';
+
+/**
+ * Unapprove command definition for Percy builds
+ * Allows users to unapprove builds using build ID and authentication credentials
+ */
+export const unapprove = command('unapprove', {
+  description: 'Unapprove Percy builds',
+  ...reviewCommandConfig
+}, async ({
+  flags,
+  args,
+  percy,
+  log,
+  exit
+}) => {
+  // Early return if Percy is disabled
+  if (!percy) {
+    exit(0, 'Percy is disabled');
+  }
+
+  // Validate and get authentication credentials
+  const {
+    username,
+    accessKey
+  } = fetchCredentials(flags);
+  if (!username || !accessKey) {
+    exit(1, 'Username and access key are required to unapprove builds.');
+  }
+  log.info(`Unapproving build ${args.buildId}...`);
+  try {
+    // Call the Percy API to unapprove the build
+    const buildUnapprovalResponse = await percy.client.unapproveBuild(args.buildId, username, accessKey);
+    const unapprovedBy = buildUnapprovalResponse.data.attributes['action-performed-by'] || {
+      user_email: 'unknown@example.com',
+      user_name: username
+    };
+    log.info(`Build ${args.buildId} unapproved successfully!`);
+    log.info(`Unapproved by: ${unapprovedBy.user_name} (${unapprovedBy.user_email})`);
+  } catch (error) {
+    log.error(`Failed to unapprove build ${args.buildId}`);
+    log.error(error);
+
+    // Provide user-friendly error message
+    exit(1, 'Failed to unapprove the build');
+  }
+});
+export default unapprove;

package/dist/utils.js

@@ -0,0 +1,45 @@
+/**
+ * Constants for environment variable names and error messages
+ */
+const ENV_VARS = {
+  BROWSERSTACK_USERNAME: 'BROWSERSTACK_USERNAME',
+  BROWSERSTACK_ACCESS_KEY: 'BROWSERSTACK_ACCESS_KEY'
+};
+
+/**
+ * Validates that required authentication credentials are present
+ * @param {Object} flags - Command flags object
+ * @returns {Object} Validated credentials object
+ */
+export function fetchCredentials(flags) {
+  // Use flags if provided, otherwise fallback to environment variables
+  const username = flags.username || process.env[ENV_VARS.BROWSERSTACK_USERNAME];
+  const accessKey = flags.accessKey || process.env[ENV_VARS.BROWSERSTACK_ACCESS_KEY];
+  return {
+    username,
+    accessKey
+  };
+}
+
+/** * Configuration for review commands (approve, reject, unapprove)
+ * Contains common arguments and flags used across these commands
+ */
+export const reviewCommandConfig = {
+  args: [{
+    name: 'build-id',
+    description: 'Build ID to approve',
+    type: 'id',
+    required: true
+  }],
+  flags: [{
+    name: 'username',
+    description: 'Username for authentication (can also be set via BROWSERSTACK_USERNAME env var)',
+    type: 'string'
+  }, {
+    name: 'access-key',
+    description: 'Access key for authentication (can also be set via BROWSERSTACK_ACCESS_KEY env var)',
+    type: 'string'
+  }],
+  examples: ['$0 <build-id>', '$0 <build-id> --username username --access-key **key**'],
+  percy: true
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-build",
-  "version": "1.31.1-beta.1",
+  "version": "1.31.1-beta.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -19,7 +19,10 @@
   ],
   "main": "./dist/index.js",
   "type": "module",
-  "exports": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./utils": "./dist/utils.js"
+  },
   "scripts": {
     "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
@@ -33,7 +36,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.31.1-beta.1"
+    "@percy/cli-command": "1.31.1-beta.2"
   },
-  "gitHead": "5c43f9b5d1088332cf5644e06df162c33f64df5b"
+  "gitHead": "809b770761a7a5ad0044e462218452e920a4d1f0"
 }