- Tests created with
calibre test create
orTest.create
now expire after 1 year. Once expired, the test will be deleted. You can set a custom expiry date with the--expiresAt
flag. - Adds
--expiresAt
flag tocalibre test create
. You can use this flag to set an expiry date for the test. After the expiry date, the test will be automatically deleted.
- Updates dependencies in response to latest dependabot updates and security patches.
- Removes usage of Calibre deprecated API fields that will be removed January 2025.
- Update package to require node 18.x or higher.
- Update eslint to latest, fix linting issues.
- Fixes markdown output for
calibre site create-pull-request-review
(#671).
- Updates dependencies in response to latest dependabot updates.
- Fixes markdown output for
calibre test create
(#634).
- Updates dependencies in response to latest dependabot updates.
- Adds
--markdown
output flag tocalibre site pull-request-review
command.
- Updates dependencies in response to latest dependabot updates.
- Adds new command:
calibre site create-pull-request-review
to compare a preview deployment for a Site already monitored by Calibre. - Adds new command:
calibre site pull-request-reviews
to list Pull Request Reviews. - Adds new command:
calibre site pull-request-review
to retrieve and display an existing Pull Request Review. - Updates output of
calibre test show
andcalibre test create --waitForTest
to return a new Single Page Test report. - Adds
--webhookUrl
and--webhookSecret
flags tocalibre test create
. You can use these flags to POST the results of a Single Page Test to a desired URL with HMAC secret. - Adds a new
--markdown
flag tocalibre test show
andcalibre test create
. You can use--markdown
to generate a Single Page Test report.
- Updates dependencies in response to latest security patches.
- Swapped dependency
update-notifier
forsimple-update-notifier
, which has better smaller and less risky package supply chain. - Swapped dependency
json2csv
(now deprecated) for same authors new package that is maintained.
- Add Brotli decompression support for report JSON downloads
- Fixed Windows support
- Updates
calibre device-list
command to output additional emulated device details (screen width and height, device type:phone
tablet
ordesktop
and status:current
ordiscontinued
)
- Adds a new command:
calibre team list
to list all Teams depending on API Token in use.
- Updates all command and flag descriptions for clarity and accuracy.
- updates
README.md
to include link to Calibre’s documentation page for all CLI commands
- Ends support for Node 12 (end of life as of
2022-04-30
). - Discontinues packaged binary builds: releases only via npm.
- Adds a new flag for
calibre test create
:--waitForTest
(default:false
).
- Adds a new package export:
cli-commands
(returns all command functions and CLI options). - Adds a new package export:
cli-metadata
(returns all command documentation). - Adds a new package script:
npm run generate-cli-md
(generatesCLI_COMMANDS.md
CLI documentation file). - Now written in ES Modules.
- Adds build step for producing CommonJS entry points.
- Adds built-in throttling to requests made with the API so they don't hit the request limit.
- Turns
ESLint
on for the build process.
- Updates
README.md
to reflect current usage. - Updates all Node.js examples to ES Modules.
- Adds
CLI_COMMANDS.md
that showcases all available commands and subcommands with their options.
- Adds
Site.get
to get a given Site. - Adds
Site.update
to update a given Site.
- Adds missing fields for TestProfile queries (
hasDeviceEmulation
,hasBandwidthEmulation
,isMobile
,position
,cookies
,headers
,blockedThirdParties
). - Adds missing fields Deploy queries (
url
,username
). - Adds missing field for Location queries (
shortName
). - Adds missing fields for MetricBudget queries (
status
,changeThreshold
,metric
). - Adds missing fields for Page queries (
canonical
,position
).
- Fixes
get-snapshot-metrics
CSV output (profile was not being set correctly).
- Fixes
profiles
parameter not being passed forsite metrics
(thanks @jonogillettt).
- Replaces
site get-pulse-metrics
withsite metrics
. - Adds
metric-list
which lists all available metrics, their category, advised ranges and recommendation for tracking. - Ends support for Node 10.x.
- Adds
team
input tocalibre site create
.
- Updates Timeseries API: Return
page
forseries
data.
- Fixes Timeseries API: Filter by Profile.
- Updates dependencies, inclusive of latest security patches.
- Fixes
site create-test-profile
to default JavaScript execution to on. - Fixes
more information
link.
- Fixes reference to
token set
in error message.
- Updates
get-pulse-metrics
description.
- Adds support for formatting
milliunit
measurements.
- Fixes parsing of
to
andfrom
arguments in theget-pulse-metrics
command.
- Allows use of token store for Node.
- Adds
calibre token set
command. - Adds
calibre token remove
command. - Adds ability to get Test Agent settings in
agentSettings
API. - Adds
agentSettings
to create insite
API. - Adds
--schedule
flag tocreate site
with Snapshot schedule. - Adds
--interval
flag tocreate site
with Snapshot schedule interval. - Updates
create site
to have same defaults as web.
- Updates default host to https://api.calibreapp.com.
- Improves error handling when trying to
get-snapshot-metrics
for a snapshot that does not exist. - Supports Node version ≥
10.13.0
(the first version of 10.x that was considered LTS).
- Fixes undefined
ref
when creating a snapshot in API without aref
.
- Adds the ability to set
isPrivate
intest
API. - Adds
--private
flag to create a private test.
- Updates the TimeSeries api to return
uuid
andcanonical
forpages
anduuid
,name
,jsIsDisabled
,adBlockIsEnabled
,hasDeviceEmulation
,hasBandwidthEmulation
andisMobile
fortestProfiles
.
- Set default count in
deploys
API.
- Fixes
destroy
mutation insnapshot
API to passString
to GraphQL API.
- Adds ability to add custom headers in
test
API. - Adds
--headers
flag to create test with custom headers.
- Updated
.npmignore
so that development data isn’t included in the package.
- Adds
integrations
to to API. - Adds
metric-budgets
to to API. - Adds
agent-settings
to to API.
- Changes
calibre site pages
to use paginated query method.
- Updates
api-error
util to get GraphQL errors fromextensions
.
- Fixes test output to only display metric if available.
- Adds
calibre site deploys
command. - Adds
calibre site create-deploy
command. - Adds
calibre site delete-deploy
command. - Adds ability to turn adblocker on in
test
API. - Adds ability to turn adblocker on or off in
test-profile
API. - Adds
--adblocker
flag to create test with adblocker enabled. - Adds
--no-adblocker
and--adblocker
flags for turning adblocking on or off for a test profile. - Changes
--disableJavascript
flag to--no-javascript
to turn JS off for a test profile. - Changes
--enableJavascript
flag to--javascript
to turn JS on for a test profile. - Changes
get-pulse-metrics
to use theTimeSeries
query method. - Changes
calibre site snapshots
to use paginated query method. - Changes
test
API to return tests when they complete, error or timeout. - Changes
calibre site create test
to show the error or timeout failure.
- Updated formatting of Lighthouse scores for Single Page Tests.
- Changed the metrics chart for Single Page Tests to show First Contentful Paint instead of First Meaningful Paint.
- Removes GIF download from
download-snapshot-artifacts
.
- Fixes output of request result (format with
JSON
).
- Fixes Snapshot metrics CSV.
- Removes
--no-deprecation
flag.
- Removed
await-for-of
to continue support for Node 8. - Changed
download-artifact
commands to output relative directory of stored artifacts.
- Adds
calibre test download-artifact <uuid>
command. - Adds
calibre site download-snapshot-artifacts --site=<slug> <id>
command. - Changes
calibre site delete-snapshot
to useid
rather thaniid
. - Changes
calibre site get-pulse-metrics
to default to returning data for all pages. (Previously the--page
flag was required) - Adds
calibre request --query=<graphql query>
command.
- Changes internal queries to use
hasRecentlyCompletedSnapshots
rather thanhasCompletedSnapshots
. - Updates Node API to use
GraphQL.request
. - Adds a mock server and utilities for testing.
- Fixes
--csv
output (#26).
- Adds
calibre site delete-snapshot
command.
- Switches page objects to use
UUID
(rather thanslug
) to reflect other objects.
- Fixes path issue.
- Adds
calibre site create <name> [options]
command. - Adds
calibre site delete
command. - Adds
calibre site create-page
command. - Adds
calibre site update-page
command. - Adds
calibre site delete-page
command. - Adds
calibre site create-test-profile
command. - Adds
calibre site update-test-profile
command. - Adds
calibre site delete-test-profile
command. - Adds
--metrics
flag tocalibre site get-pulse-metrics
command. Specify the metrics you’d like returned.
- Cleans up internal error handling.
- Adds Node.js example for creating a Site using the new
Site.create
method. - Adds Node.js example that demonstrates how to create a Single Page Test from every Calibre testing location.
- The
calibre test create
command now accepts a--cookie-jar
flag. It‘ll use a netscape formattedcookie-jar
for a given test.