npmpackage.info

Gathering detailed insights and metrics for @pact-foundation/pact-core

@pact-foundation/pact-core

Core binaries for pact-js, a Contract Testing Framework. NOTE: If you are looking to do Pact contract testing in node, you almost certainly want pact-js, not pact-node.

15.2.1

150

MIT

TypeScript

9,569,198 4.1

Installations

npm install @pact-foundation/pact-core

Pull Requests

Open

0

Total

348

Closed

86

Merged

262

Issues

Open

3

Total

170

Closed

167

Releases

Release v15.2.1

v15.2.1

Published on 06 Sept 2024

Release v15.2.0

v15.2.0

Published on 06 Sept 2024

Release v15.1.1

v15.1.1

Published on 19 Jul 2024

Release v15.1.0

v15.1.0

Published on 20 Jun 2024

Release v15.0.0

v15.0.0

Published on 17 Jun 2024

Release v14.3.8

v14.3.8

Published on 17 Jun 2024

View all 96 releases

Developer

pact-foundation

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=16

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.8.2 Statistics

150 Stars

1,431 Commits

79 Forks

8 Watching

4 Branches

42 Contributors

Updated on 22 Nov 2024

Languages

TypeScript (44.28%)

C++ (40.27%)

Shell (8.42%)

C (4.33%)

Python (2.55%)

JavaScript (0.08%)

Ruby (0.08%)

Total Downloads

Cumulative downloads

Total Downloads

9,569,198

Last day

-4.5%

24,503

Compared to previous day

Last week

-1.2%

125,273

Compared to previous week

Last month

-2.3%

540,666

Compared to previous month

Last year

71.1%

5,729,546

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

check-types node-gyp-build pino pino-pretty underscore

Dev Dependencies

Versions

:information_source: Usage notice
This is a core library, designed for use in the bowels of another package. Unless you are wanting to develop tools for the pact ecosystem, you almost certainly want to install `@pact-foundation/pact` instead

Pact-JS Core

A wrapper for the Pact Reference Core Library.

Pact-JS Core

Installation

npm install @pact-foundation/pact-core --save-dev

Do Not Track

In order to get better statistics as to who is using Pact, we have an anonymous tracking event that triggers when Pact installs for the first time. To respect your privacy, anyone can turn it off by simply adding a 'do not track' flag within their package.json file:

1{
2 "name": "some-project",
3 ...
4 "config": {
5  "pact_do_not_track": true
6 },
7 ...
8}

Which Library/Package should I use?

TL;DR - you almost always want Pact JS.

Purpose	Library	Comments
Synchronous / HTTP APIs	Pact JS
Asynchronous APIs	Pact JS
Node.js	Pact JS
Browser testing	Pact Web	You probably still want Pact JS. See Using Pact in non-Node environments *
Isomorphic testing	Pact Web	You probably still want Pact JS. See Using Pact in non-Node environments *
Publishing to Pact Broker	Pact CLI

* The "I need to run it in the browser" question comes up occasionally. The question is this - for your JS code to be able to make a call to another API, is this dependent on browser-specific code? In most cases, people use tools like React/Angular which have libraries that work on the server and client side, in which case, these tests don't need to run in a browser and could instead be executed in a Node.js environment.

Documentation

Set Log Level

1var pact = require("@pact-foundation/pact-core");
2pact.logLevel("debug");

Provider Verification

Read more about Verify Pacts.

1var pact = require('@pact-foundation/pact-core');
2
3pact.verifyPacts({
4 ...
5});

Options:

Parameter	Required?	Type	Description
`providerBaseUrl`	true	string	Running API provider host endpoint.
`pactBrokerUrl`	false	string	Base URL of the Pact Broker from which to retrieve the pacts. Required if `pactUrls` not given.
`provider`	false	string	Name of the provider if fetching from a Broker
`consumerVersionSelectors`	false	ConsumerVersionSelector\|array	Use Selectors to is a way we specify which pacticipants and versions we want to use when configuring verifications.
`consumerVersionTags`	false	string\|array	Retrieve the latest pacts with given tag(s)
`providerVersionTags`	false	string\|array	Tag(s) to apply to the provider application
`includeWipPactsSince`	false	string	Includes pact marked as WIP since this date. String in the format %Y-%m-%d or %Y-%m-%dT%H:%M:%S.000%:z
`pactUrls`	false	array	Array of local pact file paths or HTTP-based URLs. Required if not using a Pact Broker.
`providerStatesSetupUrl`	false	string	URL to send PUT requests to setup a given provider state
`pactBrokerUsername`	false	string	Username for Pact Broker basic authentication
`pactBrokerPassword`	false	string	Password for Pact Broker basic authentication
`pactBrokerToken`	false	string	Bearer token for Pact Broker authentication
`publishVerificationResult`	false	boolean	Publish verification result to Broker (NOTE: you should only enable this during CI builds)
`providerVersion`	false	string	Provider version, required to publish verification result to Broker. Optional otherwise.
`enablePending`	false	boolean	Enable the pending pacts feature.
`timeout`	false	number	The duration in ms we should wait to confirm verification process was successful. Defaults to 30000.
`logLevel`	false	LogLevel (string)	Log level. One of "TRACE", "DEBUG", "ERROR", "WARN", "INFO", can be set by LOG_LEVEL env var

The consumer version selector looks like this:

ConsumerVersionSelector {
  tag?: string;
  latest?: boolean;
  consumer?: string;
  deployedOrReleased?: boolean;
  deployed?: boolean; 
  released?: boolean; 
  environment?: string;
  fallbackTag?: string;
  branch?: string;
  mainBranch?: boolean;
  matchingBranch?: boolean;
}

See the Pact Broker documentation on selectors for more information.

Contributing

To develop this project, simply install the dependencies with npm install --ignore-scripts, and run npm run watch to for continual development, linting and testing when a source file changes.

Testing

Running npm test will execute the tests that has the *.spec.js pattern.

Questions?

Please search for potential answers or post question on our official Pact StackOverflow.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:93: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:164: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:169: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:172: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:186: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:209: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-test.yml:214: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/build-and-test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-ffi.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/pact-foundation/pact-js-core/update-ffi.yml/master?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 3 out of 3 npmCommand dependencies pinned

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.1

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More