construct-hub 0.3.194 → 0.3.195

package/.jsii

@@ -1864,7 +1864,7 @@
   },
   "name": "construct-hub",
   "readme": {
-    "markdown": "# Construct Hub\n\nThis project maintains a [AWS Cloud Development Kit][aws-cdk] construct library\nthat can be used to deploy instances of the Construct Hub in any AWS Account.\n\nThis software backs the public instance of the\n[ConstructHub](https://constructs.dev), and can be used to deploy a self-hosted\ninstance with personalized configuration.\n\n[aws-cdk]: https://github.com/aws/aws-cdk\n\n## :question: Getting Started\n\n> :warning: Disclaimer\n>\n> The [public instance of ConstructHub](https://constructs.dev) is Generally Available.\n>\n> Self-hosted ConstructHub instances are however in active development and\n> should be considered *experimental*. Breaking changes to the public API of\n> this package are expected to be released without prior notice, and the\n> infrastructure and operational posture of ConstructHub instances may also\n> significantly change.\n>\n> You are welcome to deploy self-hosted instances of ConstructHub for evaluation\n> purposes, and we welcome any feedback (good or bad) from your experience in\n> doing so.\n\n### Quick Start\n\nOnce you have installed the `construct-hub` library in your project, the\nsimplest way to get started is to create an instance of the `ConstructHub`\nconstruct:\n\n```ts\nimport { App, Stack } from '@aws-cdk/core';\nimport { ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nnew ConstructHub(stack, 'ConstructHub');\n```\n\n### Personalization\n\n#### Using a custom domain name\n\nIn order to use a custom domain for your ConstructHub instance instead of the\ndefault CloudFront domain name, specify the `domain` property with the following\nelements:\n\nAttribute                     | Description\n------------------------------|---------------------------------------------------------------------\n`zone`                        | A Route53 Hosted Zone, where DNS records will be added.\n`cert`                        | An Amazon Certificate Manager certificate, which must be in the `us-east-1` region.\n`monitorCertificateExpiration`| Set to `false` if you do not want an alarm to be created when the certificate is close to expiry.\n\nYour self-hosted ConstructHub instance will be served from the root of the\nprovided `zone`, so the certificate must match this name.\n\n#### Alternate package sources\n\nBy default, ConstructHub has a single package source configured: the public\n`npmjs.com` registry. Self-hosted instances typically should list packages from\nalternate sources, either in addition to packages from `npmjs.com`, or instead\nof those.\n\nThe `packageSources` property can be used to replace the default set of package\nsources configured on the instance. ConstructHub provides `IPackageSource`\nimplementations for the public `npmjs.com` registry as well as for private\nCodeArtifact repositories:\n\n```ts\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\nimport { App, Stack } from '@aws-cdk/core';\nimport { sources, ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nconst registry = new codeartifact.CfnRegistry(stack, 'Registry', {\n  // ....\n});\nnew ConstructHub(stack, 'ConstructHub', {\n  packageSources: [\n    new sources.NpmJs(), // Remove if you do NOT want npmjs.com packages\n    new sources.CodeArtifact({ registry }),\n  ],\n});\n```\n\nYou may also implement a custom `IPackageSource` if you want to index packages\nfrom alternate locations. In this case, the component you provide will be\nresponsible for sending notifications to an SQS Queue about newly discovered\npackages. You may refer to the [sources.NpmJs] and [sources.CodeArtifact]\nimplementations as a reference for hos this can be done.\n\nBy default, download counts of NPM packages will be fetched periodically from\nNPM's public API by a Lambda. Since this is not desirable if you are using a\nprivate package registry, this is automatically disabled if you specify your own\nvalue for `packageSources`. (But this can be re-enabled through the\n`fetchPackageStats` property if needed).\n\n[sources.NpmJs]: src/package-sources/npmjs.ts\n[sources.CodeArtifact]: src/package-sources/code-artifact.ts\n\n#### Package deny list\n\nCertain packages may be undesirable to show in your self-hosted ConstructHub\ninstance. In order to prevent a package from ever being listed in construct hub,\nthe `denyList` property can be configured with a set of `DenyListRule` objects\nthat specify which package or package versions should never be lested:\n\n```ts\nimport { App, Stack } from '@aws-cdk/core';\nimport { ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nnew ConstructHub(stack, 'ConstructHub', {\n  denyList: [\n    // Denying _all_ versions of the \"sneaky-hackery\" package\n    { packageName: 'sneaky-hackery', reason: 'Mines bitcoins wherever it gets installed' },\n    // Denying _a specific_ version of the \"bad-release\" package\n    { packageName: 'bad-release', version: '1.2.3', reason: 'CVE-####-#####' },\n  ],\n});\n```\n\n#### Redirecting from additional domains\n\nYou can add additional domains that will be redirected to your primary Construct\nHub domain:\n\n```ts\nimport * as r53 from '@aws-cdk/aws-route53';\n\nconst myDomainZone = r53.HostedZone.fromHostedZoneAttributes(this, 'MyDomainZone', {\n  hostedZoneId: 'AZ1234',\n  zoneName: 'my.domain.com',\n});\n\nnew ConstructHub(this, 'ConstructHub', {\n  additionalDomains: [ { hostedZone: myDomainZone } ]\n});\n```\n\nThis will set up full domain redirect using Amazon S3 and Amazon CloudFront. All\nrequests will be redirected to your primary Construct Hub domain.\n\n#### Decrease deployment footprint\n\nBy default, ConstructHub executes the documentation rendering process in the\ncontext of isolated subnets. This is a defense-in-depth mechanism to mitigate\nthe risks associated with downloading aribtrary (un-trusted) *npm packages* and\ntheir dependency closures.\n\nThis layer of security implies the creation of a number of resources that can\nincrease the operating cost of your self-hosted instance: several VPC endpoints\nare created, an internal CodeArtifact repository needs to be provisioned, etc...\n\nWhile we generally recommend leaving these features enabled, if your self-hosted\nConstructHub instance only indexes *trusted* packages (as could be the case for\nan instance that does not list packages from the public `npmjs.com` registry),\nyou may set the `isolateLambdas` setting to `false`.\n\n## :gear: Operating a self-hosted instance\n\n1. [Application Overview](./docs/application-overview.md) provides a high-level\n   description of the components that make a ConstructHub instance. This is a\n   great starting point for people who consider operating a self-hosted instance\n   of ConstructHub; and for new operators on-boarding the platform.\n\n1. [Operator Runbook](./docs/operator-runbook.md) is a series of diagnostics and\n   troubleshooting guides indended for operators to have a quick and easy way to\n   navigate a ConstructHub instance when they are reacting to an alarm or bug\n   report.\n\n### :baby_chick: Deployment Canaries\n\nConstruct Hub provides several built-in validation mechanisms to make sure the\ndeployment of your instance is continuously operating as expected.\n\nThese mechanisms come in the form of canary testers that are part of the\nConstructHub deployment stack. Each canary runs periodically and performs a\ndifferent check, triggering a different CloudWatch alarm in case it detects a\nfailure.\n\nWe recommend that you use staged deployments, and block promotions to the\nproduction stage in case any preivous stage triggers an alarm within a specific\ntimeframe.\n\n#### Discovery Canary\n\nWhen configuring an `NpmJs` package source, a package discovery canary can be\nenabled using the `enableCanary` property (and optionally configured using the\n`canaryPackage` and `canarySla` properties). This feature is activated by\ndefault and monitors availability of releases of the `construct-hub-probe` npm\npackage in the ConstructHub instance.\n\nProbe packages, such as `construct-hub-probe` are published frequently (e.g:\nevery 3 hours or more frequently), and can be used to ensure the ConstructHub\ninstance correctly discovers, indexes and represents those packages.\n\nIf a different package or SLA should be used, you can configure the `NpmJs`\npackage source manually like so:\n\n```ts\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\nimport { App, Stack } from '@aws-cdk/core';\nimport { sources, ConstructHub } from 'construct-hub';\n\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\nnew ConstructHub(stack, 'ConstructHub', {\n  // ...\n  packageSources: [\n    // ...\n    new sources.NpmJs({\n      enableCanary: true, // This is the default\n      canaryPackage: '@acme/my-constructhub-probe',\n      canarySla: Duration.minutes(30),\n    }),\n    // ...\n  ],\n  // ...\n});\n```\n\nIn case the new package isn't fully available in the predefined SLA, a\n**high severity** CloudWatch alarm will trigger, which will in turn trigger\nthe configured action for low severity alarms.\n\n> See [Monitoring & Alarms](./docs/application-overview.md#monitoring--alarming)\n\nThe operator runbook contains [instructions](./docs/operator-runbook.md) on how\nto diagnose and mitigate the root cause of the failure.\n\n### :nail_care: Customizing the frontend\n\nThere are a number of customizations available in order to make your private\nconstruct hub better tailored to your organization.\n\n#### Package Tags\n\nConfiguring package tags allows you to compute additional labels to be applied\nto packages. These can be used to indicate to users which packages are owned by\ntrusted organizations, or any other arbitrary conditions, and can be referenced\nwhile searching.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    id: 'official',\n    condition: TagCondition.field('name').eq('construct-hub'),\n    keyword: {\n      label: 'Official',\n      color: '#00FF00',\n    },\n    highlight: {\n      label: 'Vended by AWS',\n      color: '#00FF00',\n    }\n  }]\n});\n```\n\nThe above example will result in packages with the `name` of `construct-hub` to\nreceive the `Official` tag, which is colored green and displayed amongst the\nlist of keywords. Additionally the `highlight` key shows this as a highlighted\nitem on the package's card.\n\nThe `searchFilter` key can also be used to show tags as search filters grouped\ntogether.\n\n```ts\nconst authorsGroup = new PackageTagGroup(\"authors\", {\n  label: \"Authors\",\n  tooltip: \"Information about the authors filter\",\n  filterType: FilterType.checkbox(),\n});\n\nconst isAws = TagCondition.field('name').eq('construct-hub');\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    id: 'AWS',\n    condition: isAws,\n    searchFilter: {\n      group: authorsGroup,\n      display: 'AWS',\n    },\n  }, {\n    id: 'Community',\n    condition: TagCondition.not(isAws),\n    searchFilter: {\n      group: authorsGroup,\n      display: 'AWS',\n    },\n  }]\n});\n```\n\nThe above will show a list of `Authors` filters on the search results page\nwith a checkbox for each `AWS` and `Community` packages, allowing users to\nfilter results by the presence of these tags.\n\nCombinations of conditions are also supported:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    label: 'Official',\n    color: '#00FF00',\n    condition: TagCondition.or(\n      TagCondition.field('name').eq('construct-hub'),\n      TagCondition.field('name').eq('construct-hub-webapp'),\n    ),\n  }]\n});\n\n// or more succintly if you have a long list\ncondition: TagCondition.or(\n  ...['construct-hub', 'construct-hub-webapp', '...',]\n    .map(name => TagCondition.field('name').eq(name))\n),\n```\n\nYou can assert against any value within package json including nested ones.\n\n```ts\nTagCondition.field('constructHub', 'nested', 'key').eq('value');\n\n// checks\npackageJson?.constructHub?.nested?.key === value;\n```\n\n#### Package Links\n\nConfiguring package links allows you to replace the `Repository`, `License`,\nand `Registry` links on the package details page with whatever you choose.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageLinks: [{\n    linkLabel: 'Service Level Agreement',\n    configKey: 'SLA',\n  }, {\n    linkLabel: 'Contact',\n    configKey: 'Contact',\n    linkText: 'Email Me!',\n    allowedDomains: ['me.com'],\n  }]\n});\n```\n\nThis would allow publishers to add the following to their package.json:\n\n```json\n\"constructHub\": {\n  \"packageLinks\": {\n    \"SLA\": \"https://support.mypackage.com\",\n    \"Contact\": \"me.com/contact\"\n  }\n}\n```\n\nThen the links on the corresponding package page would show these items as\nconfigured.\n\n#### Home Page\n\nThe home page is divided into sections, each with a header and list of packages.\nCurrently, for a given section you can display either the most recently updated\npackages, or a curated list of packages.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  featuredPackages: {\n    sections: [\n      {\n        name: \"Recently updated\",\n        showLastUpdated: 4\n      },\n      {\n        name: \"From the AWS CDK\",\n        showPackages: [\n          {\n            name: \"@aws-cdk/core\"\n          },\n          {\n            name: \"@aws-cdk/aws-s3\",\n            comment: \"One of the most popular AWS CDK libraries!\"\n          },\n          {\n            name: \"@aws-cdk/aws-lambda\"\n          },\n          {\n            name: \"@aws-cdk/pipelines\"\n            comment: \"The pipelines L3 construct library abstracts away many of the details of managing software deployment within AWS.\"\n          }\n        ]\n      }\n    ]\n  }\n});\n```\n\n#### Browse Categories\n\nThe Construct Hub home page includes a section that displays a set of buttons\nthat represent browsing categories (e.g. \"Databases\", \"Monitoring\",\n\"Serverless\", etc).\n\nYou can use the `categories` option to configure these categories. Each category\nis defined by a `title` and a `url`, which will be the link associated with the\nbutton.\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  categories: [\n    { title: 'Databases', url: '?keywords=databases' },\n    { title: 'Monitoring', url: '?q=monitoring' },\n    { title: 'Partners', url: '?tags=aws-partner' }\n  ]\n});\n```\n\n#### Feature Flags\n\nFeature flags for the web app can be used to enable or disable experimental\nfeatures. These can be customized through the `featureFlags` property - for\nmore information about the available flags, check the documentation for\n<https://github.com/cdklabs/construct-hub-webapp/>.\n\n## :raised_hand: Contributing\n\nIf you are looking to contribute to this project, but don't know where to start,\nhave a look at our [contributing guide](CONTRIBUTING.md)!\n\n## :cop: Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\n## :balance_scale: License\n\nThis project is licensed under the Apache-2.0 License.\n"
+    "markdown": "# Construct Hub\n\nThis project maintains a [AWS Cloud Development Kit][aws-cdk] construct library\nthat can be used to deploy instances of the Construct Hub in any AWS Account.\n\nThis software backs the public instance of the\n[ConstructHub](https://constructs.dev), and can be used to deploy a self-hosted\ninstance with personalized configuration.\n\n[aws-cdk]: https://github.com/aws/aws-cdk\n\n## :question: Getting Started\n\n> :warning: Disclaimer\n>\n> The [public instance of ConstructHub](https://constructs.dev) is Generally Available.\n>\n> Self-hosted ConstructHub instances are however in active development and\n> should be considered *experimental*. Breaking changes to the public API of\n> this package are expected to be released without prior notice, and the\n> infrastructure and operational posture of ConstructHub instances may also\n> significantly change.\n>\n> You are welcome to deploy self-hosted instances of ConstructHub for evaluation\n> purposes, and we welcome any feedback (good or bad) from your experience in\n> doing so.\n\n### Quick Start\n\nOnce you have installed the `construct-hub` library in your project, the\nsimplest way to get started is to create an instance of the `ConstructHub`\nconstruct:\n\n```ts\nimport { App, Stack } from '@aws-cdk/core';\nimport { ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nnew ConstructHub(stack, 'ConstructHub');\n```\n\n### Personalization\n\n#### Using a custom domain name\n\nIn order to use a custom domain for your ConstructHub instance instead of the\ndefault CloudFront domain name, specify the `domain` property with the following\nelements:\n\nAttribute                     | Description\n------------------------------|---------------------------------------------------------------------\n`zone`                        | A Route53 Hosted Zone, where DNS records will be added.\n`cert`                        | An Amazon Certificate Manager certificate, which must be in the `us-east-1` region.\n`monitorCertificateExpiration`| Set to `false` if you do not want an alarm to be created when the certificate is close to expiry.\n\nYour self-hosted ConstructHub instance will be served from the root of the\nprovided `zone`, so the certificate must match this name.\n\n#### Alternate package sources\n\nBy default, ConstructHub has a single package source configured: the public\n`npmjs.com` registry. Self-hosted instances typically should list packages from\nalternate sources, either in addition to packages from `npmjs.com`, or instead\nof those.\n\nThe `packageSources` property can be used to replace the default set of package\nsources configured on the instance. ConstructHub provides `IPackageSource`\nimplementations for the public `npmjs.com` registry as well as for private\nCodeArtifact repositories:\n\n```ts\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\nimport { App, Stack } from '@aws-cdk/core';\nimport { sources, ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nconst registry = new codeartifact.CfnRegistry(stack, 'Registry', {\n  // ....\n});\nnew ConstructHub(stack, 'ConstructHub', {\n  packageSources: [\n    new sources.NpmJs(), // Remove if you do NOT want npmjs.com packages\n    new sources.CodeArtifact({ registry }),\n  ],\n});\n```\n\nYou may also implement a custom `IPackageSource` if you want to index packages\nfrom alternate locations. In this case, the component you provide will be\nresponsible for sending notifications to an SQS Queue about newly discovered\npackages. You may refer to the [sources.NpmJs] and [sources.CodeArtifact]\nimplementations as a reference for hos this can be done.\n\nBy default, download counts of NPM packages will be fetched periodically from\nNPM's public API by a Lambda. Since this is not desirable if you are using a\nprivate package registry, this is automatically disabled if you specify your own\nvalue for `packageSources`. (But this can be re-enabled through the\n`fetchPackageStats` property if needed).\n\n[sources.NpmJs]: src/package-sources/npmjs.ts\n[sources.CodeArtifact]: src/package-sources/code-artifact.ts\n\n#### Package deny list\n\nCertain packages may be undesirable to show in your self-hosted ConstructHub\ninstance. In order to prevent a package from ever being listed in construct hub,\nthe `denyList` property can be configured with a set of `DenyListRule` objects\nthat specify which package or package versions should never be lested:\n\n```ts\nimport { App, Stack } from '@aws-cdk/core';\nimport { ConstructHub } from 'construct-hub';\n\n// The usual... you might have used `cdk init app` instead!\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\n// Now to business!\nnew ConstructHub(stack, 'ConstructHub', {\n  denyList: [\n    // Denying _all_ versions of the \"sneaky-hackery\" package\n    { packageName: 'sneaky-hackery', reason: 'Mines bitcoins wherever it gets installed' },\n    // Denying _a specific_ version of the \"bad-release\" package\n    { packageName: 'bad-release', version: '1.2.3', reason: 'CVE-####-#####' },\n  ],\n});\n```\n\n#### Redirecting from additional domains\n\nYou can add additional domains that will be redirected to your primary Construct\nHub domain:\n\n```ts\nimport * as r53 from '@aws-cdk/aws-route53';\n\nconst myDomainZone = r53.HostedZone.fromHostedZoneAttributes(this, 'MyDomainZone', {\n  hostedZoneId: 'AZ1234',\n  zoneName: 'my.domain.com',\n});\n\nnew ConstructHub(this, 'ConstructHub', {\n  additionalDomains: [ { hostedZone: myDomainZone } ]\n});\n```\n\nThis will set up full domain redirect using Amazon S3 and Amazon CloudFront. All\nrequests will be redirected to your primary Construct Hub domain.\n\n#### Decrease deployment footprint\n\nBy default, ConstructHub executes the documentation rendering process in the\ncontext of isolated subnets. This is a defense-in-depth mechanism to mitigate\nthe risks associated with downloading aribtrary (un-trusted) *npm packages* and\ntheir dependency closures.\n\nThis layer of security implies the creation of a number of resources that can\nincrease the operating cost of your self-hosted instance: several VPC endpoints\nare created, an internal CodeArtifact repository needs to be provisioned, etc...\n\nWhile we generally recommend leaving these features enabled, if your self-hosted\nConstructHub instance only indexes *trusted* packages (as could be the case for\nan instance that does not list packages from the public `npmjs.com` registry),\nyou may set the `isolateLambdas` setting to `false`.\n\n## :gear: Operating a self-hosted instance\n\n1. [Application Overview](./docs/application-overview.md) provides a high-level\n   description of the components that make a ConstructHub instance. This is a\n   great starting point for people who consider operating a self-hosted instance\n   of ConstructHub; and for new operators on-boarding the platform.\n\n1. [Operator Runbook](./docs/operator-runbook.md) is a series of diagnostics and\n   troubleshooting guides indended for operators to have a quick and easy way to\n   navigate a ConstructHub instance when they are reacting to an alarm or bug\n   report.\n\n### :baby_chick: Deployment Canaries\n\nConstruct Hub provides several built-in validation mechanisms to make sure the\ndeployment of your instance is continuously operating as expected.\n\nThese mechanisms come in the form of canary testers that are part of the\nConstructHub deployment stack. Each canary runs periodically and performs a\ndifferent check, triggering a different CloudWatch alarm in case it detects a\nfailure.\n\nWe recommend that you use staged deployments, and block promotions to the\nproduction stage in case any preivous stage triggers an alarm within a specific\ntimeframe.\n\n#### Discovery Canary\n\nWhen configuring an `NpmJs` package source, a package discovery canary can be\nenabled using the `enableCanary` property (and optionally configured using the\n`canaryPackage` and `canarySla` properties). This feature is activated by\ndefault and monitors availability of releases of the `construct-hub-probe` npm\npackage in the ConstructHub instance.\n\nProbe packages, such as `construct-hub-probe` are published frequently (e.g:\nevery 3 hours or more frequently), and can be used to ensure the ConstructHub\ninstance correctly discovers, indexes and represents those packages.\n\nIf a different package or SLA should be used, you can configure the `NpmJs`\npackage source manually like so:\n\n```ts\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\nimport { App, Stack } from '@aws-cdk/core';\nimport { sources, ConstructHub } from 'construct-hub';\n\nconst app = new App();\nconst stack = new Stack(app, 'StackName', { /* ... */ });\n\nnew ConstructHub(stack, 'ConstructHub', {\n  // ...\n  packageSources: [\n    // ...\n    new sources.NpmJs({\n      enableCanary: true, // This is the default\n      canaryPackage: '@acme/my-constructhub-probe',\n      canarySla: Duration.minutes(30),\n    }),\n    // ...\n  ],\n  // ...\n});\n```\n\nIn case the new package isn't fully available in the predefined SLA, a\n**high severity** CloudWatch alarm will trigger, which will in turn trigger\nthe configured action for low severity alarms.\n\n> See [Monitoring & Alarms](./docs/application-overview.md#monitoring--alarming)\n\nThe operator runbook contains [instructions](./docs/operator-runbook.md) on how\nto diagnose and mitigate the root cause of the failure.\n\n### :nail_care: Customizing the frontend\n\nThere are a number of customizations available in order to make your private\nconstruct hub better tailored to your organization.\n\n#### Package Tags\n\nConfiguring package tags allows you to compute additional labels to be applied\nto packages. These can be used to indicate to users which packages are owned by\ntrusted organizations, or any other arbitrary conditions, and can be referenced\nwhile searching.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    id: 'official',\n    condition: TagCondition.field('name').eq('construct-hub'),\n    keyword: {\n      label: 'Official',\n      color: '#00FF00',\n    },\n    highlight: {\n      label: 'Vended by AWS',\n      color: '#00FF00',\n    }\n  }]\n});\n```\n\nThe above example will result in packages with the `name` of `construct-hub` to\nreceive the `Official` tag, which is colored green and displayed amongst the\nlist of keywords. Additionally the `highlight` key shows this as a highlighted\nitem on the package's card.\n\nThe `searchFilter` key can also be used to show tags as search filters grouped\ntogether.\n\n```ts\nconst authorsGroup = new PackageTagGroup(\"authors\", {\n  label: \"Authors\",\n  tooltip: \"Information about the authors filter\",\n  filterType: FilterType.checkbox(),\n});\n\nconst isAws = TagCondition.field('name').eq('construct-hub');\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    id: 'AWS',\n    condition: isAws,\n    searchFilter: {\n      group: authorsGroup,\n      display: 'AWS',\n    },\n  }, {\n    id: 'Community',\n    condition: TagCondition.not(isAws),\n    searchFilter: {\n      group: authorsGroup,\n      display: 'AWS',\n    },\n  }]\n});\n```\n\nThe above will show a list of `Authors` filters on the search results page\nwith a checkbox for each `AWS` and `Community` packages, allowing users to\nfilter results by the presence of these tags.\n\nCombinations of conditions are also supported:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    label: 'Official',\n    color: '#00FF00',\n    condition: TagCondition.or(\n      TagCondition.field('name').eq('construct-hub'),\n      TagCondition.field('name').eq('construct-hub-webapp'),\n    ),\n  }]\n});\n\n// or more succintly if you have a long list\ncondition: TagCondition.or(\n  ...['construct-hub', 'construct-hub-webapp', '...',]\n    .map(name => TagCondition.field('name').eq(name))\n),\n```\n\nYou can assert against any value within package json including nested ones.\n\n```ts\nTagCondition.field('constructHub', 'nested', 'key').eq('value');\n\n// checks\npackageJson?.constructHub?.nested?.key === value;\n```\n\nYou can also assert that a string occurs at least a certain number of times\nwithin the package's README.\n\n```ts\nTagCondition.readme().includes('ECS');\nTagCondition.readme().includes('fargate', { atLeast: 3, caseSensitive: false });\n```\n\n#### Package Links\n\nConfiguring package links allows you to replace the `Repository`, `License`,\nand `Registry` links on the package details page with whatever you choose.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageLinks: [{\n    linkLabel: 'Service Level Agreement',\n    configKey: 'SLA',\n  }, {\n    linkLabel: 'Contact',\n    configKey: 'Contact',\n    linkText: 'Email Me!',\n    allowedDomains: ['me.com'],\n  }]\n});\n```\n\nThis would allow publishers to add the following to their package.json:\n\n```json\n\"constructHub\": {\n  \"packageLinks\": {\n    \"SLA\": \"https://support.mypackage.com\",\n    \"Contact\": \"me.com/contact\"\n  }\n}\n```\n\nThen the links on the corresponding package page would show these items as\nconfigured.\n\n#### Home Page\n\nThe home page is divided into sections, each with a header and list of packages.\nCurrently, for a given section you can display either the most recently updated\npackages, or a curated list of packages.\n\nFor example:\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  featuredPackages: {\n    sections: [\n      {\n        name: \"Recently updated\",\n        showLastUpdated: 4\n      },\n      {\n        name: \"From the AWS CDK\",\n        showPackages: [\n          {\n            name: \"@aws-cdk/core\"\n          },\n          {\n            name: \"@aws-cdk/aws-s3\",\n            comment: \"One of the most popular AWS CDK libraries!\"\n          },\n          {\n            name: \"@aws-cdk/aws-lambda\"\n          },\n          {\n            name: \"@aws-cdk/pipelines\"\n            comment: \"The pipelines L3 construct library abstracts away many of the details of managing software deployment within AWS.\"\n          }\n        ]\n      }\n    ]\n  }\n});\n```\n\n#### Browse Categories\n\nThe Construct Hub home page includes a section that displays a set of buttons\nthat represent browsing categories (e.g. \"Databases\", \"Monitoring\",\n\"Serverless\", etc).\n\nYou can use the `categories` option to configure these categories. Each category\nis defined by a `title` and a `url`, which will be the link associated with the\nbutton.\n\n```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  categories: [\n    { title: 'Databases', url: '?keywords=databases' },\n    { title: 'Monitoring', url: '?q=monitoring' },\n    { title: 'Partners', url: '?tags=aws-partner' }\n  ]\n});\n```\n\n#### Feature Flags\n\nFeature flags for the web app can be used to enable or disable experimental\nfeatures. These can be customized through the `featureFlags` property - for\nmore information about the available flags, check the documentation for\n<https://github.com/cdklabs/construct-hub-webapp/>.\n\n## :raised_hand: Contributing\n\nIf you are looking to contribute to this project, but don't know where to start,\nhave a look at our [contributing guide](CONTRIBUTING.md)!\n\n## :cop: Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\n## :balance_scale: License\n\nThis project is licensed under the Apache-2.0 License.\n"
   },
   "repository": {
     "type": "git",
@@ -4060,7 +4060,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/package-tag/index.ts",
-        "line": 93
+        "line": 100
       },
       "name": "PackageTagConfig",
       "properties": [
@@ -4072,7 +4072,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 94
+            "line": 101
           },
           "name": "condition",
           "type": {
@@ -13349,7 +13349,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/package-tag/index.ts",
-        "line": 100
+        "line": 107
       },
       "methods": [
         {
@@ -13359,7 +13359,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 105
+            "line": 112
           },
           "name": "and",
           "parameters": [
@@ -13386,7 +13386,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 130
+            "line": 137
           },
           "name": "field",
           "parameters": [
@@ -13414,7 +13414,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 120
+            "line": 127
           },
           "name": "not",
           "parameters": [
@@ -13441,7 +13441,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 113
+            "line": 120
           },
           "name": "or",
           "parameters": [
@@ -13461,6 +13461,23 @@
           "static": true,
           "variadic": true
         },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create a condition with logic targeting the README of the package."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 144
+          },
+          "name": "readme",
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagConditionReadme"
+            }
+          },
+          "static": true
+        },
         {
           "abstract": true,
           "docs": {
@@ -13468,7 +13485,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 134
+            "line": 148
           },
           "name": "bind",
           "returns": {
@@ -13492,7 +13509,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/package-tag/index.ts",
-        "line": 82
+        "line": 87
       },
       "name": "TagConditionConfig",
       "properties": [
@@ -13504,7 +13521,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 83
+            "line": 88
           },
           "name": "type",
           "type": {
@@ -13519,7 +13536,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 86
+            "line": 93
           },
           "name": "children",
           "optional": true,
@@ -13540,7 +13557,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 84
+            "line": 90
           },
           "name": "key",
           "optional": true,
@@ -13561,7 +13578,44 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 85
+            "line": 92
+          },
+          "name": "options",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "any"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 89
+          },
+          "name": "source",
+          "optional": true,
+          "type": {
+            "fqn": "construct-hub.TagConditionSource"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 91
           },
           "name": "value",
           "optional": true,
@@ -13585,7 +13639,7 @@
         },
         "locationInModule": {
           "filename": "src/package-tag/index.ts",
-          "line": 189
+          "line": 207
         },
         "parameters": [
           {
@@ -13604,7 +13658,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/package-tag/index.ts",
-        "line": 188
+        "line": 206
       },
       "methods": [
         {
@@ -13614,7 +13668,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 195
+            "line": 213
           },
           "name": "eq",
           "parameters": [
@@ -13638,7 +13692,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 208
+            "line": 227
           },
           "name": "includes",
           "parameters": [
@@ -13647,6 +13701,13 @@
               "type": {
                 "primitive": "any"
               }
+            },
+            {
+              "name": "options",
+              "optional": true,
+              "type": {
+                "fqn": "construct-hub.TagConditionIncludesOptions"
+              }
             }
           ],
           "returns": {
@@ -13662,7 +13723,7 @@
           },
           "locationInModule": {
             "filename": "src/package-tag/index.ts",
-            "line": 221
+            "line": 242
           },
           "name": "startsWith",
           "parameters": [
@@ -13683,6 +13744,61 @@
       "name": "TagConditionField",
       "symbolId": "src/package-tag/index:TagConditionField"
     },
+    "construct-hub.TagConditionIncludesOptions": {
+      "assembly": "construct-hub",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for `includes` operator."
+      },
+      "fqn": "construct-hub.TagConditionIncludesOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 276
+      },
+      "name": "TagConditionIncludesOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "1",
+            "stability": "experimental",
+            "summary": "The value must appear at least this many times."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 281
+          },
+          "name": "atLeast",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "This option\nis ignored if the value we are checking is an array.",
+            "stability": "experimental",
+            "summary": "String matches must match the casing of the original string."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 288
+          },
+          "name": "caseSensitive",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/package-tag/index:TagConditionIncludesOptions"
+    },
     "construct-hub.TagConditionLogicType": {
       "assembly": "construct-hub",
       "docs": {
@@ -13693,7 +13809,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/package-tag/index.ts",
-        "line": 140
+        "line": 154
       },
       "members": [
         {
@@ -13736,6 +13852,91 @@
       "name": "TagConditionLogicType",
       "symbolId": "src/package-tag/index:TagConditionLogicType"
     },
+    "construct-hub.TagConditionReadme": {
+      "assembly": "construct-hub",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Target the README of the package to dictate whether a tag is relevant."
+      },
+      "fqn": "construct-hub.TagConditionReadme",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/package-tag/index.ts",
+          "line": 256
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 255
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create a `readme.includes(value)` condition which applies if the README includes the specified string."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 262
+          },
+          "name": "includes",
+          "parameters": [
+            {
+              "name": "value",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "options",
+              "optional": true,
+              "type": {
+                "fqn": "construct-hub.TagConditionIncludesOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagCondition"
+            }
+          }
+        }
+      ],
+      "name": "TagConditionReadme",
+      "symbolId": "src/package-tag/index:TagConditionReadme"
+    },
+    "construct-hub.TagConditionSource": {
+      "assembly": "construct-hub",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "construct-hub.TagConditionSource",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 79
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "PACKAGE_JSON"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "README"
+        }
+      ],
+      "name": "TagConditionSource",
+      "symbolId": "src/package-tag/index:TagConditionSource"
+    },
     "construct-hub.sources.CodeArtifact": {
       "assembly": "construct-hub",
       "docs": {
@@ -14343,6 +14544,6 @@
       "symbolId": "src/package-sources/npmjs:NpmJsProps"
     }
   },
-  "version": "0.3.194",
-  "fingerprint": "Za55BQn8YFM0USRfSsRxP5ysCUMGTaNwbAL8ghIEEPo="
+  "version": "0.3.195",
+  "fingerprint": "RgDJMCAMgA0nSAsEUTxHMMiSHF69bNRDt0/b2jrtOzo="
 }