@percy/core 1.10.3 → 1.11.0

package/dist/api.js

@@ -2,9 +2,15 @@ import fs from 'fs';
 import path from 'path';
 import { createRequire } from 'module';
 import logger from '@percy/logger';
+import { normalize } from '@percy/config/utils';
 import { getPackageJSON, Server } from './utils.js'; // need require.resolve until import.meta.resolve can be transpiled
 
-export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom'); // Create a Percy CLI API server instance
+export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom'); // Returns a URL encoded string of nested query params
+
+function encodeURLSearchParams(subj, prefix) {
+  return typeof subj === 'object' ? Object.entries(subj).map(([key, value]) => encodeURLSearchParams(value, prefix ? `${prefix}[${key}]` : key)).join('&') : `${prefix}=${encodeURIComponent(subj)}`;
+} // Create a Percy CLI API server instance
+
 
 export function createPercyServer(percy, port) {
   let pkg = getPackageJSON(import.meta.url);
@@ -71,7 +77,7 @@ export function createPercyServer(percy, port) {
     });
   }) // get or set config options
   .route(['get', 'post'], '/percy/config', async (req, res) => res.json(200, {
-    config: req.body ? await percy.setConfig(req.body) : percy.config,
+    config: req.body ? percy.set(req.body) : percy.config,
     success: true
   })) // responds once idle (may take a long time)
   .route('get', '/percy/idle', async (req, res) => res.json(200, {
@@ -85,14 +91,46 @@ export function createPercyServer(percy, port) {
     let content = await fs.promises.readFile(PERCY_DOM, 'utf-8');
     let wrapper = '(window.PercyAgent = class { snapshot(n, o) { return PercyDOM.serialize(o); } });';
     return res.send(200, 'applicaton/javascript', content.concat(wrapper));
-  }) // post one or more snapshots
+  }) // post one or more snapshots, optionally async
   .route('post', '/percy/snapshot', async (req, res) => {
     let snapshot = percy.snapshot(req.body);
     if (!req.url.searchParams.has('async')) await snapshot;
     return res.json(200, {
       success: true
     });
-  }) // stops percy at the end of the current event loop
+  }) // post one or more comparisons, optionally waiting
+  .route('post', '/percy/comparison', async (req, res) => {
+    let upload = percy.upload(req.body);
+    if (req.url.searchParams.has('await')) await upload; // generate and include one or more redirect links to comparisons
+
+    let link = ({
+      name,
+      tag
+    }) => {
+      var _percy$build;
+
+      return [percy.client.apiUrl, '/comparisons/redirect?', encodeURLSearchParams(normalize({
+        buildId: (_percy$build = percy.build) === null || _percy$build === void 0 ? void 0 : _percy$build.id,
+        snapshot: {
+          name
+        },
+        tag
+      }, {
+        snake: true
+      }))].join('');
+    };
+
+    return res.json(200, Object.assign({
+      success: true
+    }, req.body ? Array.isArray(req.body) ? {
+      links: req.body.map(link)
+    } : {
+      link: link(req.body)
+    } : {}));
+  }) // flushes one or more snapshots from the internal queue
+  .route('post', '/percy/flush', async (req, res) => res.json(200, {
+    success: await percy.flush(req.body).then(() => true)
+  })) // stops percy at the end of the current event loop
   .route('/percy/stop', (req, res) => {
     setImmediate(() => percy.stop());
     return res.json(200, {

package/dist/config.js

@@ -1,5 +1,14 @@
 // Common config options used in Percy commands
 export const configSchema = {
+  percy: {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      deferUploads: {
+        type: 'boolean'
+      }
+    }
+  },
   snapshot: {
     type: 'object',
     additionalProperties: false,
@@ -10,7 +19,7 @@ export const configSchema = {
         items: {
           type: 'integer',
           maximum: 2000,
-          minimum: 10
+          minimum: 120
         }
       },
       minHeight: {
@@ -28,9 +37,6 @@ export const configSchema = {
       },
       scope: {
         type: 'string'
-      },
-      devicePixelRatio: {
-        type: 'integer'
       }
     }
   },
@@ -129,6 +135,9 @@ export const configSchema = {
       userAgent: {
         type: 'string'
       },
+      devicePixelRatio: {
+        type: 'integer'
+      },
       concurrency: {
         type: 'integer',
         minimum: 1
@@ -180,9 +189,6 @@ export const snapshotSchema = {
         enableJavaScript: {
           $ref: '/config/snapshot#/properties/enableJavaScript'
         },
-        devicePixelRatio: {
-          $ref: '/config/snapshot#/properties/devicePixelRatio'
-        },
         discovery: {
           type: 'object',
           additionalProperties: false,
@@ -204,6 +210,9 @@ export const snapshotSchema = {
             },
             userAgent: {
               $ref: '/config/discovery#/properties/userAgent'
+            },
+            devicePixelRatio: {
+              $ref: '/config/discovery#/properties/devicePixelRatio'
             }
           }
         }
@@ -388,6 +397,9 @@ export const snapshotSchema = {
         },
         domSnapshot: {
           type: 'string'
+        },
+        width: {
+          $ref: '/config/snapshot#/properties/widths/items'
         }
       },
       errors: {
@@ -470,9 +482,87 @@ export const snapshotSchema = {
       }
     }
   }
+}; // Comparison upload options
+
+export const comparisonSchema = {
+  type: 'object',
+  $id: '/comparison',
+  required: ['name', 'tag'],
+  additionalProperties: false,
+  properties: {
+    name: {
+      type: 'string'
+    },
+    externalDebugUrl: {
+      type: 'string'
+    },
+    tag: {
+      type: 'object',
+      additionalProperties: false,
+      required: ['name'],
+      properties: {
+        name: {
+          type: 'string'
+        },
+        osName: {
+          type: 'string'
+        },
+        osVersion: {
+          type: 'string'
+        },
+        width: {
+          type: 'integer',
+          maximum: 2000,
+          minimum: 120
+        },
+        height: {
+          type: 'integer',
+          minimum: 10
+        },
+        orientation: {
+          type: 'string',
+          enum: ['portrait', 'landscape']
+        }
+      }
+    },
+    tiles: {
+      type: 'array',
+      items: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          filepath: {
+            type: 'string'
+          },
+          content: {
+            type: 'string'
+          },
+          statusBarHeight: {
+            type: 'integer',
+            minimum: 0
+          },
+          navBarHeight: {
+            type: 'integer',
+            minimum: 0
+          },
+          headerHeight: {
+            type: 'integer',
+            minimum: 0
+          },
+          footerHeight: {
+            type: 'integer',
+            minimum: 0
+          },
+          fullscreen: {
+            type: 'boolean'
+          }
+        }
+      }
+    }
+  }
 }; // Grouped schemas for easier registration
 
-export const schemas = [configSchema, snapshotSchema]; // Config migrate function
+export const schemas = [configSchema, snapshotSchema, comparisonSchema]; // Config migrate function
 
 export function configMigration(config, util) {
   /* eslint-disable curly */
@@ -485,41 +575,21 @@ export function configMigration(config, util) {
     util.map('agent.assetDiscovery.pagePoolSizeMax', 'discovery.concurrency');
     util.del('agent');
   } else {
-    let notice = {
+    util.deprecate('snapshot.devicePixelRatio', {
+      map: 'discovery.devicePixelRatio',
       type: 'config',
-      until: '1.0.0'
-    }; // snapshot discovery options have moved
-
-    util.deprecate('snapshot.authorization', {
-      map: 'discovery.authorization',
-      ...notice
-    });
-    util.deprecate('snapshot.requestHeaders', {
-      map: 'discovery.requestHeaders',
-      ...notice
+      until: '2.0.0'
     });
   }
 } // Snapshot option migrate function
 
 export function snapshotMigration(config, util, root = '') {
-  let notice = {
+  // discovery options have moved
+  util.deprecate(`${root}.devicePixelRatio`, {
+    map: `${root}.discovery.devicePixelRatio`,
     type: 'snapshot',
-    until: '1.0.0',
+    until: '2.0.0',
     warn: true
-  }; // discovery options have moved
-
-  util.deprecate(`${root}.authorization`, {
-    map: `${root}.discovery.authorization`,
-    ...notice
-  });
-  util.deprecate(`${root}.requestHeaders`, {
-    map: `${root}.discovery.requestHeaders`,
-    ...notice
-  }); // snapshots option was renamed
-
-  util.deprecate(`${root}.snapshots`, {
-    map: `${root}.additionalSnapshots`,
-    ...notice
   });
 } // Snapshot list options migrate function
 
@@ -531,18 +601,8 @@ export function snapshotListMigration(config, util) {
         snapshotMigration(config, util, `snapshots[${i}]`);
       }
     }
-  } // overrides option was renamed
-
+  } // migrate options
 
-  let notice = {
-    type: 'snapshot',
-    until: '1.0.0',
-    warn: true
-  };
-  util.deprecate('overrides', {
-    map: 'options',
-    ...notice
-  }); // migrate options
 
   if (Array.isArray(config.options)) {
     for (let i in config.options) {