{
  "author": {
    "email": "timothy.l.jones@gmail.com",
    "name": "Timothy Jones",
    "roles": [
      "author"
    ],
    "url": "https://github.com/TimothyJones"
  },
  "bundled": {
    "@contract-case/case-core": "0.15.6",
    "@contract-case/case-entities-internal": "0.15.6",
    "read-pkg-up": "^7.0.1"
  },
  "description": "Exported interface layer for ContractCase. Don't depend on it directly unless you're writing a wrapper for a new language",
  "homepage": "https://case.contract-testing.io/docs/reference/matchers",
  "jsiiVersion": "5.3.11 (build a5f9673)",
  "license": "BSD-3-Clause",
  "metadata": {
    "jsii": {
      "pacmak": {
        "hasDefaultInterfaces": true
      }
    }
  },
  "name": "@contract-case/case-boundary",
  "readme": {
    "markdown": "# @contract-case/case-boundary\n\n[![Build and test](https://github.com/case-contract-testing/contract-case-boundary/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/case-contract-testing/contract-case-boundary/actions/workflows/build-and-test.yml)\n[![Known Vulnerabilities](https://snyk.io/test/github/case-contract-testing/contract-case-boundary/badge.svg?targetFile=package.json)](https://snyk.io/test/github/case-contract-testing/contract-case-boundary?targetFile=package.json)\n[![npm](https://img.shields.io/npm/v/@contract-case/case-boundary.svg?label=case-boundary%3A%20npm)](https://www.npmjs.com/package/@contract-case/case-boundary)\n![Maven Central](https://img.shields.io/maven-central/v/io.contract-testing.contractcase/case_boundary?label=case_boundary%3A%20maven)\n\nThis is the [JSii](https://aws.github.io/jsii/user-guides/lib-author/toolchain/jsii/) layer that is part of the exported interface for ContractCase.\n\nHowever, because of [a bug preventing servers from running](https://github.com/aws/jsii/issues/4133), communication with wrapper libraries is provided by @contract-case/case-connector instead.\n\n* If you're looking looking to use ContractCase for testing, use one of the DSL packages - [start here](https://case.contract-testing.io/docs/intro).\n* If you're writing a wrapper for ContractCase in a new language, use [@contract-case/case-connector](https://www.npmjs.com/package/@contract-case/case-connector).\n* Use this package directly ONLY if you are writing a VERY custom wrapper for ContractCase. Feel free to open an issue to discuss your use case.\n\n# Why isn't this in the monorepo?\n\nCase-Boundary is extracted from the monorepo because of [an npm bug](https://github.com/npm/cli/issues/3466) that causes JSii to be [unable to include bundled packages in a monorepo](https://github.com/aws/jsii/issues/4132).\n\n\n"
  },
  "repository": {
    "type": "git",
    "url": "git+ssh://git@github.com/case-contract-testing/case.git"
  },
  "schema": "jsii/0.10.0",
  "targets": {
    "java": {
      "maven": {
        "artifactId": "case_boundary",
        "groupId": "io.contract-testing.contractcase"
      },
      "package": "io.contract_testing.contractcase.case_boundary"
    },
    "js": {
      "npm": "@contract-case/case-boundary"
    }
  },
  "types": {
    "@contract-case/case-boundary.BoundaryContractDefiner": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "A BoundaryContractDefiner allows defining contracts."
      },
      "fqn": "@contract-case/case-boundary.BoundaryContractDefiner",
      "initializer": {
        "docs": {
          "custom": {
            "public": "Construct a BoundaryContractDefiner to allow defining contracts."
          }
        },
        "locationInModule": {
          "filename": "src/BoundaryContractDefiner.ts",
          "line": 86
        },
        "parameters": [
          {
            "docs": {
              "summary": "- A ContractCaseBoundaryConfig object for the configuration."
            },
            "name": "config",
            "type": {
              "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig"
            }
          },
          {
            "docs": {
              "summary": "- An ILogPrinter to enable printing logs."
            },
            "name": "logPrinter",
            "type": {
              "fqn": "@contract-case/case-boundary.ILogPrinter"
            }
          },
          {
            "docs": {
              "summary": "- An IResultPrinter to enable printing results."
            },
            "name": "resultPrinter",
            "type": {
              "fqn": "@contract-case/case-boundary.IResultPrinter"
            }
          },
          {
            "docs": {
              "summary": "- The names version(s) of the package(s) calling this, where each entry in the array contains a name and version, with the first entry in the array being the furthest package up the call stack."
            },
            "name": "parentVersions",
            "type": {
              "collection": {
                "elementtype": {
                  "primitive": "string"
                },
                "kind": "array"
              }
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/BoundaryContractDefiner.ts",
        "line": 64
      },
      "methods": [
        {
          "async": true,
          "locationInModule": {
            "filename": "src/BoundaryContractDefiner.ts",
            "line": 190
          },
          "name": "endRecord",
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "async": true,
          "locationInModule": {
            "filename": "src/BoundaryContractDefiner.ts",
            "line": 128
          },
          "name": "runExample",
          "parameters": [
            {
              "name": "definition",
              "type": {
                "fqn": "@contract-case/case-boundary.BoundaryMockDefinition"
              }
            },
            {
              "name": "runConfig",
              "type": {
                "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "async": true,
          "locationInModule": {
            "filename": "src/BoundaryContractDefiner.ts",
            "line": 151
          },
          "name": "runRejectingExample",
          "parameters": [
            {
              "name": "definition",
              "type": {
                "fqn": "@contract-case/case-boundary.BoundaryMockDefinition"
              }
            },
            {
              "name": "runConfig",
              "type": {
                "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "locationInModule": {
            "filename": "src/BoundaryContractDefiner.ts",
            "line": 173
          },
          "name": "stripMatchers",
          "parameters": [
            {
              "name": "matcherOrData",
              "type": {
                "primitive": "any"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "BoundaryContractDefiner",
      "symbolId": "src/BoundaryContractDefiner:BoundaryContractDefiner"
    },
    "@contract-case/case-boundary.BoundaryContractVerifier": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "A BoundaryContractDefiner allows verifying contracts."
      },
      "fqn": "@contract-case/case-boundary.BoundaryContractVerifier",
      "initializer": {
        "docs": {
          "summary": "Construct a BoundaryContractVerifier to allow verifying pre-written contracts."
        },
        "locationInModule": {
          "filename": "src/BoundaryContractVerifier.ts",
          "line": 77
        },
        "parameters": [
          {
            "docs": {
              "summary": "- A ContractCaseBoundaryConfig object for the configuration."
            },
            "name": "config",
            "type": {
              "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig"
            }
          },
          {
            "name": "callback",
            "type": {
              "fqn": "@contract-case/case-boundary.IRunTestCallback"
            }
          },
          {
            "docs": {
              "summary": "- An ILogPrinter to enable printing logs."
            },
            "name": "logPrinter",
            "type": {
              "fqn": "@contract-case/case-boundary.ILogPrinter"
            }
          },
          {
            "docs": {
              "summary": "- An IResultPrinter to enable printing results."
            },
            "name": "resultPrinter",
            "type": {
              "fqn": "@contract-case/case-boundary.IResultPrinter"
            }
          },
          {
            "docs": {
              "summary": "- The names version(s) of the package(s) calling this, where each entry in the array contains a name and version, with the first entry in the array being the furthest package up the call stack."
            },
            "name": "parentVersions",
            "type": {
              "collection": {
                "elementtype": {
                  "primitive": "string"
                },
                "kind": "array"
              }
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/BoundaryContractVerifier.ts",
        "line": 53
      },
      "methods": [
        {
          "docs": {
            "returns": "either a `BoundaryFailure`, or a `BoundarySuccessWithAny` which contains an array of:\n```\nCaseContractDescription {\nconsumerName: string;\nproviderName: string;\n}\n```",
            "summary": "Returns a description of all of the contracts that can be found by the configuration."
          },
          "locationInModule": {
            "filename": "src/BoundaryContractVerifier.ts",
            "line": 117
          },
          "name": "availableContractDescriptions",
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "docs": {
            "remarks": "If you want to filter the contract(s), use the configOverrides to specify a Consumer or Provider name.",
            "returns": "`BoundarySuccess` if verification was successful, otherwise a `BoundaryFailure`",
            "summary": "Run the verification of the contract(s) that can be found using the configuration provided."
          },
          "locationInModule": {
            "filename": "src/BoundaryContractVerifier.ts",
            "line": 142
          },
          "name": "runVerification",
          "parameters": [
            {
              "docs": {
                "summary": "- A `ContractCaseBoundaryConfig` that defines any config options to override (after the ones provided in the constructor are applied)."
              },
              "name": "configOverrides",
              "type": {
                "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "BoundaryContractVerifier",
      "symbolId": "src/BoundaryContractVerifier:BoundaryContractVerifier"
    },
    "@contract-case/case-boundary.BoundaryCrashMessage": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Contains constants for the crash messages."
      },
      "fqn": "@contract-case/case-boundary.BoundaryCrashMessage",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/BoundaryCrashMessage.ts",
        "line": 6
      },
      "name": "BoundaryCrashMessage",
      "properties": [
        {
          "const": true,
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/BoundaryCrashMessage.ts",
            "line": 18
          },
          "name": "CRASH_MESSAGE_END",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/BoundaryCrashMessage.ts",
            "line": 7
          },
          "name": "CRASH_MESSAGE_START",
          "static": true,
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/BoundaryCrashMessage:BoundaryCrashMessage"
    },
    "@contract-case/case-boundary.BoundaryFailure": {
      "assembly": "@contract-case/case-boundary",
      "base": "@contract-case/case-boundary.BoundaryResult",
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "Use `BoundaryFailureKindConstants` to determine what type of failure it is.",
        "summary": "This indicates a failure."
      },
      "fqn": "@contract-case/case-boundary.BoundaryFailure",
      "initializer": {
        "locationInModule": {
          "filename": "src/boundary/Result/BoundaryFailure.ts",
          "line": 18
        },
        "parameters": [
          {
            "name": "kind",
            "type": {
              "primitive": "string"
            }
          },
          {
            "name": "message",
            "type": {
              "primitive": "string"
            }
          },
          {
            "name": "location",
            "type": {
              "primitive": "string"
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundaryFailure.ts",
        "line": 9
      },
      "name": "BoundaryFailure",
      "properties": [
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailure.ts",
            "line": 12
          },
          "name": "kind",
          "type": {
            "primitive": "string"
          }
        },
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailure.ts",
            "line": 16
          },
          "name": "location",
          "type": {
            "primitive": "string"
          }
        },
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailure.ts",
            "line": 14
          },
          "name": "message",
          "type": {
            "primitive": "string"
          }
        },
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailure.ts",
            "line": 10
          },
          "name": "resultType",
          "overrides": "@contract-case/case-boundary.BoundaryResult",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundaryFailure:BoundaryFailure"
    },
    "@contract-case/case-boundary.BoundaryFailureKindConstants": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Constants to use for determining what kind of failure you have."
      },
      "fqn": "@contract-case/case-boundary.BoundaryFailureKindConstants",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
        "line": 15
      },
      "name": "BoundaryFailureKindConstants",
      "properties": [
        {
          "const": true,
          "docs": {
            "summary": "An error while contacting a contract broker."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 45
          },
          "name": "CASE_BROKER_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "The user has configured ContractCase incorrectly."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 24
          },
          "name": "CASE_CONFIGURATION_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "remarks": "Almost certainly a bug.",
            "summary": "Something went wrong in ContractCase internals."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 19
          },
          "name": "CASE_CORE_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "The test's expectations were not met."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 29
          },
          "name": "CASE_FAILED_ASSERTION_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "The user-provided trigger failed when it was not expected to do so."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 34
          },
          "name": "CASE_TRIGGER_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "The user-provided verification function (testResponse or testErrorResponse) failed."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryFailureKindConstants.ts",
            "line": 39
          },
          "name": "CASE_VERIFY_RETURN_ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundaryFailureKindConstants:BoundaryFailureKindConstants"
    },
    "@contract-case/case-boundary.BoundaryMockDefinition": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "This interface describes a Mock Definition, when viewing through jsii."
      },
      "fqn": "@contract-case/case-boundary.BoundaryMockDefinition",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/types.jsii-boundary.ts",
        "line": 25
      },
      "name": "BoundaryMockDefinition",
      "properties": [
        {
          "abstract": true,
          "immutable": true,
          "locationInModule": {
            "filename": "src/types.jsii-boundary.ts",
            "line": 27
          },
          "name": "definition",
          "type": {
            "primitive": "any"
          }
        },
        {
          "abstract": true,
          "immutable": true,
          "locationInModule": {
            "filename": "src/types.jsii-boundary.ts",
            "line": 26
          },
          "name": "states",
          "type": {
            "collection": {
              "elementtype": {
                "primitive": "any"
              },
              "kind": "array"
            }
          }
        }
      ],
      "symbolId": "src/types.jsii-boundary:BoundaryMockDefinition"
    },
    "@contract-case/case-boundary.BoundaryResult": {
      "abstract": true,
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "Use one of `BoundarySuccess`,\n`BoundaryFailure`, or one of the specialised `BoundarySuccessWith*` return\ntypes as appropriate. See the documentation for the method you're implementing for more information.",
        "summary": "Supertype for all methods that return results."
      },
      "fqn": "@contract-case/case-boundary.BoundaryResult",
      "initializer": {
        "locationInModule": {
          "filename": "src/boundary/Result/BoundaryResult.ts",
          "line": 26
        },
        "parameters": [
          {
            "name": "result",
            "type": {
              "primitive": "string"
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundaryResult.ts",
        "line": 21
      },
      "name": "BoundaryResult",
      "properties": [
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryResult.ts",
            "line": 24
          },
          "name": "resultType",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundaryResult:BoundaryResult"
    },
    "@contract-case/case-boundary.BoundaryResultTypeConstants": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Use these constants to determine what type of result a BoundaryResult is."
      },
      "fqn": "@contract-case/case-boundary.BoundaryResultTypeConstants",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundaryResultTypeConstants.ts",
        "line": 26
      },
      "name": "BoundaryResultTypeConstants",
      "properties": [
        {
          "const": true,
          "docs": {
            "summary": "This is a failure."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryResultTypeConstants.ts",
            "line": 39
          },
          "name": "RESULT_FAILURE",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "This is a success type with no payload."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryResultTypeConstants.ts",
            "line": 28
          },
          "name": "RESULT_SUCCESS",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "This is a success type with an arbitrary object payload."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryResultTypeConstants.ts",
            "line": 35
          },
          "name": "RESULT_SUCCESS_HAS_ANY_PAYLOAD",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "This is a success type with a map payload."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundaryResultTypeConstants.ts",
            "line": 31
          },
          "name": "RESULT_SUCCESS_HAS_MAP_PAYLOAD",
          "static": true,
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundaryResultTypeConstants:BoundaryResultTypeConstants"
    },
    "@contract-case/case-boundary.BoundaryStateHandler": {
      "abstract": true,
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "An interface for a state handler that only has setup."
      },
      "fqn": "@contract-case/case-boundary.BoundaryStateHandler",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/StateHandler.ts",
        "line": 9
      },
      "methods": [
        {
          "async": true,
          "docs": {
            "remarks": "If the user provided no setup function, this should be a function that does nothing and returns a `BoundarySuccess`",
            "returns": "Either a `BoundaryFailure` with\n`kind=BoundaryFailureKindConstants.CASE_CONFIGURATION_ERROR` or a\n`BoundarySuccess` when there's no variables returned, or a\n`BoundarySuccessWithMap` when there are variables returned",
            "summary": "Call the user's state setup function."
          },
          "locationInModule": {
            "filename": "src/boundary/StateHandler.ts",
            "line": 20
          },
          "name": "setup",
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "async": true,
          "docs": {
            "remarks": "If the user provided no teardown function, this should be a function that does nothing and returns a `BoundarySuccess`",
            "returns": "Either a `BoundaryFailure` with `kind=BoundaryFailureKindConstants.CASE_CONFIGURATION_ERROR` or a `BoundarySuccess`",
            "summary": "Call the user's state teardown function."
          },
          "locationInModule": {
            "filename": "src/boundary/StateHandler.ts",
            "line": 33
          },
          "name": "teardown",
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "BoundaryStateHandler",
      "symbolId": "src/boundary/StateHandler:BoundaryStateHandler"
    },
    "@contract-case/case-boundary.BoundarySuccess": {
      "assembly": "@contract-case/case-boundary",
      "base": "@contract-case/case-boundary.BoundaryResult",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "This indicates that the result was successful."
      },
      "fqn": "@contract-case/case-boundary.BoundarySuccess",
      "initializer": {
        "locationInModule": {
          "filename": "src/boundary/Result/BoundarySuccess.ts",
          "line": 12
        }
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundarySuccess.ts",
        "line": 9
      },
      "name": "BoundarySuccess",
      "properties": [
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundarySuccess.ts",
            "line": 10
          },
          "name": "resultType",
          "overrides": "@contract-case/case-boundary.BoundaryResult",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundarySuccess:BoundarySuccess"
    },
    "@contract-case/case-boundary.BoundarySuccessWithAny": {
      "assembly": "@contract-case/case-boundary",
      "base": "@contract-case/case-boundary.BoundaryResult",
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "The calling method usually expects only one type of payload",
        "summary": "This indicates a success with any arbitrary payload."
      },
      "fqn": "@contract-case/case-boundary.BoundarySuccessWithAny",
      "initializer": {
        "locationInModule": {
          "filename": "src/boundary/Result/BoundarySuccessWithAny.ts",
          "line": 16
        },
        "parameters": [
          {
            "name": "payload",
            "type": {
              "primitive": "any"
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundarySuccessWithAny.ts",
        "line": 11
      },
      "name": "BoundarySuccessWithAny",
      "properties": [
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundarySuccessWithAny.ts",
            "line": 14
          },
          "name": "payload",
          "type": {
            "primitive": "any"
          }
        },
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundarySuccessWithAny.ts",
            "line": 12
          },
          "name": "resultType",
          "overrides": "@contract-case/case-boundary.BoundaryResult",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundarySuccessWithAny:BoundarySuccessWithAny"
    },
    "@contract-case/case-boundary.BoundarySuccessWithMap": {
      "assembly": "@contract-case/case-boundary",
      "base": "@contract-case/case-boundary.BoundaryResult",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "This indicates a success returning a map of strings to arbitrary payloads."
      },
      "fqn": "@contract-case/case-boundary.BoundarySuccessWithMap",
      "initializer": {
        "locationInModule": {
          "filename": "src/boundary/Result/BoundarySuccessWithMap.ts",
          "line": 14
        },
        "parameters": [
          {
            "name": "payload",
            "type": {
              "collection": {
                "elementtype": {
                  "primitive": "any"
                },
                "kind": "map"
              }
            }
          }
        ]
      },
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/Result/BoundarySuccessWithMap.ts",
        "line": 9
      },
      "name": "BoundarySuccessWithMap",
      "properties": [
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundarySuccessWithMap.ts",
            "line": 12
          },
          "name": "payload",
          "type": {
            "collection": {
              "elementtype": {
                "primitive": "any"
              },
              "kind": "map"
            }
          }
        },
        {
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/Result/BoundarySuccessWithMap.ts",
            "line": 10
          },
          "name": "resultType",
          "overrides": "@contract-case/case-boundary.BoundaryResult",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/Result/BoundarySuccessWithMap:BoundarySuccessWithMap"
    },
    "@contract-case/case-boundary.ConfigLogLevelConstants": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Convenience class to hold the values for LogLevel so that DSL layers don't need to know the actual value."
      },
      "fqn": "@contract-case/case-boundary.ConfigLogLevelConstants",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/ConfigLogLevelConstants.ts",
        "line": 6
      },
      "name": "ConfigLogLevelConstants",
      "properties": [
        {
          "const": true,
          "docs": {
            "summary": "Log information to help users find out what is happening during their tests (and warnings, and errors)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 25
          },
          "name": "DEBUG",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Log detailed debugging information for ContractCase maintainers (and debug, warn and errors)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 35
          },
          "name": "DEEP_MAINTAINER_DEBUG",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Log when something has gone wrong during the execution of the test framework."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 15
          },
          "name": "ERROR",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Log debugging information for ContractCase maintainers (and debug, warn and errors)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 30
          },
          "name": "MAINTAINER_DEBUG",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Print no logs (note, results may still be printed - see `printResults`)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 10
          },
          "name": "NONE",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Log when it seems likely that there is a misconfiguration, or an error."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigLogLevelConstants.ts",
            "line": 20
          },
          "name": "WARN",
          "static": true,
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/ConfigLogLevelConstants:ConfigLogLevelConstants"
    },
    "@contract-case/case-boundary.ConfigPublishConstants": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Convenience class to hold the values for the publish setting so that clients don't need to know the strings."
      },
      "fqn": "@contract-case/case-boundary.ConfigPublishConstants",
      "initializer": {},
      "kind": "class",
      "locationInModule": {
        "filename": "src/boundary/ConfigPublishConstants.ts",
        "line": 6
      },
      "name": "ConfigPublishConstants",
      "properties": [
        {
          "const": true,
          "docs": {
            "summary": "Always publish contracts and verification results."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigPublishConstants.ts",
            "line": 20
          },
          "name": "ALWAYS",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Never publish contracts or verification results."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigPublishConstants.ts",
            "line": 15
          },
          "name": "NEVER",
          "static": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "const": true,
          "docs": {
            "summary": "Only publish contracts and verification results when in in CI according to https://github.com/watson/ci-info#supported-ci-tools."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ConfigPublishConstants.ts",
            "line": 10
          },
          "name": "ONLY_IN_CI",
          "static": true,
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/ConfigPublishConstants:ConfigPublishConstants"
    },
    "@contract-case/case-boundary.ContractCaseBoundaryConfig": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "See the [configuration documentation](https://case.contract-testing.io/docs/reference/configuring) for more details.",
        "summary": "Configure a ContractCase run."
      },
      "fqn": "@contract-case/case-boundary.ContractCaseBoundaryConfig",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/config.types.ts",
        "line": 25
      },
      "name": "ContractCaseBoundaryConfig",
      "properties": [
        {
          "abstract": true,
          "docs": {
            "deprecated": "This will be moved to a config property that allows configuration for arbitrary mocks",
            "stability": "deprecated",
            "summary": "The base URL for your real server, if you are testing an http server."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 142
          },
          "name": "baseUrlUnderTest",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The base URL for the contract broker."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 108
          },
          "name": "brokerBaseUrl",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "If this is specified along with brokerCiAccessToken, the basic auth is ignored.",
            "summary": "The basic authentication username and password to access the contract broker."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 115
          },
          "name": "brokerBasicAuth",
          "optional": true,
          "type": {
            "fqn": "@contract-case/case-boundary.UserNamePassword"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "If this is specified along with brokerBasicAuth, the basic auth is ignored.",
            "summary": "The access token to use for the contract broker. Must have CI scope."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 103
          },
          "name": "brokerCiAccessToken",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The name of the consumer for this contract."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 34
          },
          "name": "consumerName",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "If you provide this, ContractCase\nwill generate the filename for you (unless `contractFilename` is specified,\nin which case this setting is ignored)",
            "summary": "The directory where the contract will be written."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 55
          },
          "name": "contractDir",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "If you\nprovide this, `contractDir` is ignored",
            "summary": "The filename where the contract will be written."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 61
          },
          "name": "contractFilename",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "`\"none\"` - Print no logs (note, results may still be printed - see `printResults`)\n\n`\"error\"` - Something has gone wrong during the execution of the test framework\n\n`\"warn\"` - It seems likely that there is a misconfiguration\n\n`\"debug\"` - Information to help users find out what is happening during their tests\n\n`\"maintainerDebug\" | \"deepMaintainerDebug\"` - debugging information for ContractCase maintainers",
            "summary": "logLevel - one of:."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 49
          },
          "name": "logLevel",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "Whether results should be printed on standard out."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 74
          },
          "name": "printResults",
          "optional": true,
          "type": {
            "primitive": "boolean"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The name of the provider for this contract."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 29
          },
          "name": "providerName",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "`\"ONLY_IN_CI\"` - only when in in CI according to https://github.com/watson/ci-info#supported-ci-tools\n`\"NEVER\"` or `false` - never publish\n`\"ALWAYS\"` or `true` - always publish (not recommended)\n\nDefault: `\"ONLY_IN_CI\"`",
            "summary": "Whether to publish contracts or verification results to the broker."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 96
          },
          "name": "publish",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "State setup and teardown handlers for any states this test requires (see [writing state handlers](https://case.contract-testing.io/docs/reference/state-handlers/)) for more details."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 122
          },
          "name": "stateHandlers",
          "optional": true,
          "type": {
            "collection": {
              "elementtype": {
                "fqn": "@contract-case/case-boundary.BoundaryStateHandler"
              },
              "kind": "map"
            }
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "This is an internal\nimplementation detail, and authors of DSL layers shouldn't expose it to\nclients.",
            "summary": "Unique ID for this segment of the test run - it must be unique within a run, but need not be unique between test runs."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 69
          },
          "name": "testRunId",
          "optional": true,
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Note that any configuration errors will still fail the suite regardless of\nthis setting. This includes exceptions thrown during trigger functions, but\ndoes not include exceptions thrown by testResponse functions.\n\nDefault: `true` in contract definition, `false` in contract verification",
            "summary": "Whether or not the test should throw an error if the matching fails."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 85
          },
          "name": "throwOnFail",
          "optional": true,
          "type": {
            "primitive": "boolean"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "Call the native trigger and test function (if any) for this interaction pair."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 135
          },
          "name": "triggerAndTest",
          "optional": true,
          "type": {
            "fqn": "@contract-case/case-boundary.ITriggerFunction"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Most useful during verification, but also valid during definition\n\nKeyed by `${requestName}::${responseName}`",
            "summary": "A Map of native trigger and test functions (if any) for several interaction pairs."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 130
          },
          "name": "triggerAndTests",
          "optional": true,
          "type": {
            "collection": {
              "elementtype": {
                "fqn": "@contract-case/case-boundary.ITriggerFunction"
              },
              "kind": "map"
            }
          }
        }
      ],
      "symbolId": "src/boundary/config.types:ContractCaseBoundaryConfig"
    },
    "@contract-case/case-boundary.ICombinedPrinter": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "A convenience interface that combines result printing and log printing."
      },
      "fqn": "@contract-case/case-boundary.ICombinedPrinter",
      "interfaces": [
        "@contract-case/case-boundary.IResultPrinter",
        "@contract-case/case-boundary.ILogPrinter"
      ],
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 162
      },
      "name": "ICombinedPrinter",
      "symbolId": "src/boundary/ILogPrinter:ICombinedPrinter"
    },
    "@contract-case/case-boundary.IInvokeCoreTest": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Interface to tell ContractCase to run the test indicated in a call to an IRunTestCallback."
      },
      "fqn": "@contract-case/case-boundary.IInvokeCoreTest",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/IRunTestCallback.ts",
        "line": 9
      },
      "methods": [
        {
          "abstract": true,
          "async": true,
          "docs": {
            "remarks": "Note that during verification, a failed verification doesn't return an error\nResult, but failed configuration or core bugs will. This is the intended default\nbehaviour - as a failed verification doesn't necessarily indicate a problem\nin the code that is being verified.",
            "returns": "a promise that indicates the result of verifying this test (BoundaryResult)",
            "summary": "Call this to tell the ContractCase core to actually invoke the test."
          },
          "locationInModule": {
            "filename": "src/boundary/IRunTestCallback.ts",
            "line": 20
          },
          "name": "verify",
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "IInvokeCoreTest",
      "symbolId": "src/boundary/IRunTestCallback:IInvokeCoreTest"
    },
    "@contract-case/case-boundary.ILogPrinter": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "Most platforms will want to print to standard out, but some\nmight need to log to a file or otherwise collate the logs.",
        "summary": "Implement this interface to give ContractCase a way to print logs in your target language."
      },
      "fqn": "@contract-case/case-boundary.ILogPrinter",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 124
      },
      "methods": [
        {
          "abstract": true,
          "async": true,
          "docs": {
            "remarks": "You do not need\nto filter calls to this interface, it will only be called when it is\nappropriate to print.",
            "returns": "A `BoundaryResult` type indicating whether there were errors\nduring printing. Either a BoundarySuccess for no errors, or BoundaryFailure\n(with error details) in the event of a failure.",
            "summary": "Called by ContractCase to ask the DSL to print a log line."
          },
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 147
          },
          "name": "log",
          "parameters": [
            {
              "docs": {
                "summary": "- A `LogLevel` string, either `error`, `warn`, `debug`, `maintainerDebug` or `deepMaintainerDebug` Use this to programmatically decide any colour formatting.. (although `none` is a possible log level, this function will never be called with `none`)."
              },
              "name": "level",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "remarks": "No extra\nformatting is necessary",
                "summary": "- The timestamp generated by ContractCase, ready for printing."
              },
              "name": "timestamp",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "summary": "- The version string for the current ContractCase stack (at low log levels, this is just the core version)."
              },
              "name": "version",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "remarks": "Do not rely on this value programmatically, use the `level` parameter instead.",
                "summary": "- A rendered version of the LogLevel."
              },
              "name": "typeString",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "summary": "- A string that represents the location that this log came from."
              },
              "name": "location",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "summary": "- The main message of this log line."
              },
              "name": "message",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "summary": "- Any additional output to print on extra lines (you may want to indent this when printing)."
              },
              "name": "additional",
              "type": {
                "primitive": "string"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "ILogPrinter",
      "symbolId": "src/boundary/ILogPrinter:ILogPrinter"
    },
    "@contract-case/case-boundary.IResultPrinter": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Interface for printing results."
      },
      "fqn": "@contract-case/case-boundary.IResultPrinter",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 96
      },
      "methods": [
        {
          "abstract": true,
          "async": true,
          "docs": {
            "summary": "Called by ContractCase to ask the DSL to print an individual match error line."
          },
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 100
          },
          "name": "printMatchError",
          "parameters": [
            {
              "name": "MatchErrorDescription",
              "type": {
                "fqn": "@contract-case/case-boundary.PrintableMatchError"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "abstract": true,
          "async": true,
          "docs": {
            "summary": "Called by ContractCase to ask the DSL to print an error during testing that doesn't have an expected / actual value."
          },
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 107
          },
          "name": "printMessageError",
          "parameters": [
            {
              "name": "messageErrorDetails",
              "type": {
                "fqn": "@contract-case/case-boundary.PrintableMessageError"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        },
        {
          "abstract": true,
          "async": true,
          "docs": {
            "summary": "Called by ContractCase to ask the DSL to print a test title or main execution details (eg for contract downloading)."
          },
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 114
          },
          "name": "printTestTitle",
          "parameters": [
            {
              "name": "titleDetails",
              "type": {
                "fqn": "@contract-case/case-boundary.PrintableTestTitle"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "IResultPrinter",
      "symbolId": "src/boundary/ILogPrinter:IResultPrinter"
    },
    "@contract-case/case-boundary.IRunTestCallback": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "remarks": "If your test runner\nsupports programmatically running different tests, then use this interface to\ntell a BoundaryContractVerifier how to call back to your DSL with a test name",
        "summary": "This interface allows the DSL layer to invoke the test."
      },
      "fqn": "@contract-case/case-boundary.IRunTestCallback",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/IRunTestCallback.ts",
        "line": 30
      },
      "methods": [
        {
          "abstract": true,
          "async": true,
          "docs": {
            "remarks": "In an implementation, you\nshould tell your test runner that it is running a test, and what the name\nof the test is.",
            "returns": "a promise that indicates the result of calling the invoker (BoundaryResult)",
            "summary": "Called once for each test in a Verification run."
          },
          "locationInModule": {
            "filename": "src/boundary/IRunTestCallback.ts",
            "line": 41
          },
          "name": "runTest",
          "parameters": [
            {
              "docs": {
                "summary": "- The name of this test."
              },
              "name": "testName",
              "type": {
                "primitive": "string"
              }
            },
            {
              "docs": {
                "summary": "- an IInvokeCoreTest to tell the ContractCase core that you'd like it to run the test."
              },
              "name": "invoker",
              "type": {
                "fqn": "@contract-case/case-boundary.IInvokeCoreTest"
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "IRunTestCallback",
      "symbolId": "src/boundary/IRunTestCallback:IRunTestCallback"
    },
    "@contract-case/case-boundary.ITriggerFunction": {
      "assembly": "@contract-case/case-boundary",
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Interface called by ContractCase to invoke user's test code."
      },
      "fqn": "@contract-case/case-boundary.ITriggerFunction",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ITriggerFunction.ts",
        "line": 8
      },
      "methods": [
        {
          "abstract": true,
          "async": true,
          "docs": {
            "returns": "BoundarySuccess when successful; BoundaryFailure with\nkind=BoundaryFailureKindConstants.CASE_TRIGGER_ERROR if the trigger fails;\nBoundaryFailure with\nkind=BoundaryFailureKindConstants.CASE_VERIFY_RETURN_ERROR if the\nverification function fails.",
            "summary": "Trigger the user's test code and test the response from it."
          },
          "locationInModule": {
            "filename": "src/boundary/ITriggerFunction.ts",
            "line": 18
          },
          "name": "trigger",
          "parameters": [
            {
              "name": "config",
              "type": {
                "collection": {
                  "elementtype": {
                    "primitive": "any"
                  },
                  "kind": "map"
                }
              }
            }
          ],
          "returns": {
            "type": {
              "fqn": "@contract-case/case-boundary.BoundaryResult"
            }
          }
        }
      ],
      "name": "ITriggerFunction",
      "symbolId": "src/boundary/ITriggerFunction:ITriggerFunction"
    },
    "@contract-case/case-boundary.PrintableMatchError": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Data class to hold data to print a message error during matching."
      },
      "fqn": "@contract-case/case-boundary.PrintableMatchError",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 8
      },
      "name": "PrintableMatchError",
      "properties": [
        {
          "abstract": true,
          "docs": {
            "summary": "A string representation of the actual data received (may contain newlines)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 36
          },
          "name": "actual",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The machine-readable type for the cause of this error, for printing after the error message to make it easy to search for."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 28
          },
          "name": "errorTypeTag",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "A string representation of the expected data (may contain newlines)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 32
          },
          "name": "expected",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Could be any string.",
            "summary": "The red highlighted blob, eg \"MATCHING ERROR\" or \"TRIGGER FUNCTION ERROR\"."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 12
          },
          "name": "kind",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The location the error happened, for printing at the top of the error message."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 20
          },
          "name": "location",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "This might have more information than the `location` above.",
            "summary": "The tag line for the location the error happened, for printing after the error message."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 24
          },
          "name": "locationTag",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Could be any string.",
            "summary": "A summary of the error."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 16
          },
          "name": "message",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/ILogPrinter:PrintableMatchError"
    },
    "@contract-case/case-boundary.PrintableMessageError": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Data class to hold data to print a message error."
      },
      "fqn": "@contract-case/case-boundary.PrintableMessageError",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 44
      },
      "name": "PrintableMessageError",
      "properties": [
        {
          "abstract": true,
          "docs": {
            "summary": "The machine-readable type for the cause of this error, for printing after the error message to make it easy to search for."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 64
          },
          "name": "errorTypeTag",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Could be any string.",
            "summary": "The red highlighted blob, eg \"MATCHING ERROR\" or \"TRIGGER FUNCTION ERROR\"."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 48
          },
          "name": "kind",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The location the error happened, for printing at the top of the error message."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 56
          },
          "name": "location",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "This might have more information than the `location` above.",
            "summary": "The tag line for the location the error happened, for printing after the error message."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 60
          },
          "name": "locationTag",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "remarks": "Could be any string.",
            "summary": "A summary of the error."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 52
          },
          "name": "message",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/ILogPrinter:PrintableMessageError"
    },
    "@contract-case/case-boundary.PrintableTestTitle": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Data class to hold data for a test title print line."
      },
      "fqn": "@contract-case/case-boundary.PrintableTestTitle",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/ILogPrinter.ts",
        "line": 72
      },
      "name": "PrintableTestTitle",
      "properties": [
        {
          "abstract": true,
          "docs": {
            "summary": "Any additional text to print after the title (may include newlines)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 88
          },
          "name": "additionalText",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "An icon for the start of the line (usually a single character emoji, but could be any string)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 80
          },
          "name": "icon",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "Either 'success' to indicate success, or 'failure' to indicate failure."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 76
          },
          "name": "kind",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The title to print (will not include newlines)."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/ILogPrinter.ts",
            "line": 84
          },
          "name": "title",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/ILogPrinter:PrintableTestTitle"
    },
    "@contract-case/case-boundary.UserNamePassword": {
      "assembly": "@contract-case/case-boundary",
      "datatype": true,
      "docs": {
        "custom": {
          "public": "true"
        },
        "summary": "Describes a username and password."
      },
      "fqn": "@contract-case/case-boundary.UserNamePassword",
      "kind": "interface",
      "locationInModule": {
        "filename": "src/boundary/config.types.ts",
        "line": 9
      },
      "name": "UserNamePassword",
      "properties": [
        {
          "abstract": true,
          "docs": {
            "summary": "The password for basic auth."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 17
          },
          "name": "password",
          "type": {
            "primitive": "string"
          }
        },
        {
          "abstract": true,
          "docs": {
            "summary": "The username for basic auth."
          },
          "immutable": true,
          "locationInModule": {
            "filename": "src/boundary/config.types.ts",
            "line": 13
          },
          "name": "username",
          "type": {
            "primitive": "string"
          }
        }
      ],
      "symbolId": "src/boundary/config.types:UserNamePassword"
    }
  },
  "version": "0.11.0",
  "fingerprint": "6zAsMdUz9O+ElfN0TgW7v2A1nvr//M4787ml9lT3qe8="
}