construct-hub 0.2.4 → 0.2.8

package/.jsii

@@ -1814,7 +1814,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\n## :question: Getting Started\n\n> :warning: Disclaimer\n>\n> The [public instance of ConstructHub](https://constructs.dev) is currently in\n> *Developer Preview*.\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\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#### 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\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### :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 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```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## :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\n## :cop: Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\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\n## :question: Getting Started\n\n> :warning: Disclaimer\n>\n> The [public instance of ConstructHub](https://constructs.dev) is currently in\n> *Developer Preview*.\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\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#### 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\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### :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```ts\nnew ConstructHub(this, \"ConstructHub\", {\n  ...myProps,\n  packageTags: [{\n    label: 'Official',\n    color: '#00FF00',\n    condition: TagCondition.field('name').eq('construct-hub'),\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.\n\nCombinations of conditions are also supported:\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```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```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## :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\n## :cop: Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\n\n## :balance_scale: License\n\nThis project is licensed under the Apache-2.0 License.\n"
   },
   "repository": {
     "type": "git",
@@ -1945,7 +1945,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 107
+        "line": 113
       },
       "name": "CodeArtifactDomainProps",
       "properties": [
@@ -1958,7 +1958,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 111
+            "line": 117
           },
           "name": "name",
           "type": {
@@ -1974,7 +1974,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 117
+            "line": 123
           },
           "name": "upstreams",
           "optional": true,
@@ -2003,7 +2003,7 @@
         },
         "locationInModule": {
           "filename": "src/construct-hub.ts",
-          "line": 126
+          "line": 132
         },
         "parameters": [
           {
@@ -2033,7 +2033,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 123
+        "line": 129
       },
       "name": "ConstructHub",
       "properties": [
@@ -2045,7 +2045,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 242
+            "line": 258
           },
           "name": "grantPrincipal",
           "overrides": "@aws-cdk/aws-iam.IGrantable",
@@ -2060,7 +2060,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 246
+            "line": 262
           },
           "name": "ingestionQueue",
           "type": {
@@ -2080,7 +2080,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 28
+        "line": 29
       },
       "name": "ConstructHubProps",
       "properties": [
@@ -2093,7 +2093,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 37
+            "line": 38
           },
           "name": "alarmActions",
           "optional": true,
@@ -2111,7 +2111,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 85
+            "line": 86
           },
           "name": "allowedLicenses",
           "optional": true,
@@ -2133,7 +2133,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 64
+            "line": 65
           },
           "name": "backendDashboardName",
           "optional": true,
@@ -2152,7 +2152,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 96
+            "line": 97
           },
           "name": "codeArtifactDomain",
           "optional": true,
@@ -2170,7 +2170,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 71
+            "line": 72
           },
           "name": "denyList",
           "optional": true,
@@ -2192,7 +2192,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 32
+            "line": 33
           },
           "name": "domain",
           "optional": true,
@@ -2211,7 +2211,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 51
+            "line": 52
           },
           "name": "isolateSensitiveTasks",
           "optional": true,
@@ -2231,7 +2231,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 58
+            "line": 59
           },
           "name": "logRetention",
           "optional": true,
@@ -2248,7 +2248,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 101
+            "line": 102
           },
           "name": "packageLinks",
           "optional": true,
@@ -2271,7 +2271,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 78
+            "line": 79
           },
           "name": "packageSources",
           "optional": true,
@@ -2283,6 +2283,28 @@
               "kind": "array"
             }
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Configuration for custom package tags."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/construct-hub.ts",
+            "line": 107
+          },
+          "name": "packageTags",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "construct-hub.PackageTag"
+              },
+              "kind": "array"
+            }
+          }
         }
       ]
     },
@@ -2726,7 +2748,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 16
+        "line": 17
       },
       "name": "PackageLinkConfig",
       "properties": [
@@ -2739,7 +2761,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 26
+            "line": 27
           },
           "name": "configKey",
           "type": {
@@ -2755,7 +2777,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 20
+            "line": 21
           },
           "name": "linkLabel",
           "type": {
@@ -2772,7 +2794,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 40
+            "line": 41
           },
           "name": "allowedDomains",
           "optional": true,
@@ -2795,7 +2817,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 33
+            "line": 34
           },
           "name": "linkText",
           "optional": true,
@@ -3007,6 +3029,138 @@
         }
       ]
     },
+    "construct-hub.PackageTag": {
+      "assembly": "construct-hub",
+      "datatype": true,
+      "docs": {
+        "remarks": "Custom tags are\ndisplayed on the package details page, and can be used for searching.",
+        "stability": "experimental",
+        "summary": "Configuration for applying custom tags to relevant packages."
+      },
+      "fqn": "construct-hub.PackageTag",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 17
+      },
+      "name": "PackageTag",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The description of the logic that dictates whether the package has the tag applied."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 22
+          },
+          "name": "condition",
+          "type": {
+            "fqn": "construct-hub.TagCondition"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The label for the tag being applied."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 5
+          },
+          "name": "label",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The hex value string for the color of the tag when displayed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 10
+          },
+          "name": "color",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ]
+    },
+    "construct-hub.PackageTagConfig": {
+      "assembly": "construct-hub",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Serialized tag declaration to be passed to lambdas via environment variables."
+      },
+      "fqn": "construct-hub.PackageTagConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 39
+      },
+      "name": "PackageTagConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 40
+          },
+          "name": "condition",
+          "type": {
+            "fqn": "construct-hub.TagConditionConfig"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The label for the tag being applied."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 5
+          },
+          "name": "label",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The hex value string for the color of the tag when displayed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 10
+          },
+          "name": "color",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ]
+    },
     "construct-hub.SpdxLicense": {
       "assembly": "construct-hub",
       "docs": {
@@ -11631,6 +11785,345 @@
         }
       ]
     },
+    "construct-hub.TagCondition": {
+      "abstract": true,
+      "assembly": "construct-hub",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Condition for applying a custom tag to a package."
+      },
+      "fqn": "construct-hub.TagCondition",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 46
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create an && condition which applies only when all condition arguments are true."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 51
+          },
+          "name": "and",
+          "parameters": [
+            {
+              "name": "conds",
+              "type": {
+                "fqn": "construct-hub.TagCondition"
+              },
+              "variadic": true
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagCondition"
+            }
+          },
+          "static": true,
+          "variadic": true
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Target a field within the `package.json` to assert against. Nested fields can be accessed by passing multiple keys. `TagCondition.field('key1', 'key2')` will access `packageJson?.key1?.key2`."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 76
+          },
+          "name": "field",
+          "parameters": [
+            {
+              "name": "keys",
+              "type": {
+                "primitive": "string"
+              },
+              "variadic": true
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagConditionField"
+            }
+          },
+          "static": true,
+          "variadic": true
+        },
+        {
+          "docs": {
+            "remarks": "condition which applies if the condition argument is false",
+            "stability": "experimental",
+            "summary": "Create a !"
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 66
+          },
+          "name": "not",
+          "parameters": [
+            {
+              "name": "conds",
+              "type": {
+                "fqn": "construct-hub.TagCondition"
+              },
+              "variadic": true
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagCondition"
+            }
+          },
+          "static": true,
+          "variadic": true
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create an || condition which applies if any of the condition arguments are true."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 59
+          },
+          "name": "or",
+          "parameters": [
+            {
+              "name": "conds",
+              "type": {
+                "fqn": "construct-hub.TagCondition"
+              },
+              "variadic": true
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagCondition"
+            }
+          },
+          "static": true,
+          "variadic": true
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 80
+          },
+          "name": "bind",
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagConditionConfig"
+            }
+          }
+        }
+      ],
+      "name": "TagCondition"
+    },
+    "construct-hub.TagConditionConfig": {
+      "assembly": "construct-hub",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Serialized config for a tag condition."
+      },
+      "fqn": "construct-hub.TagConditionConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 28
+      },
+      "name": "TagConditionConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 29
+          },
+          "name": "type",
+          "type": {
+            "fqn": "construct-hub.TagConditionLogicType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 32
+          },
+          "name": "children",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "construct-hub.TagConditionConfig"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 30
+          },
+          "name": "key",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 31
+          },
+          "name": "value",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ]
+    },
+    "construct-hub.TagConditionField": {
+      "assembly": "construct-hub",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Target a field to use in logic to dictate whether a tag is relevant."
+      },
+      "fqn": "construct-hub.TagConditionField",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/package-tag/index.ts",
+          "line": 133
+        },
+        "parameters": [
+          {
+            "name": "field",
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "array"
+              }
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 132
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Create a === condition which applies if the specified field within the package's package.json is equal to the passed value."
+          },
+          "locationInModule": {
+            "filename": "src/package-tag/index.ts",
+            "line": 139
+          },
+          "name": "eq",
+          "parameters": [
+            {
+              "name": "value",
+              "type": {
+                "primitive": "any"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.TagCondition"
+            }
+          }
+        }
+      ],
+      "name": "TagConditionField"
+    },
+    "construct-hub.TagConditionLogicType": {
+      "assembly": "construct-hub",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Logic operators for performing specific conditional logic."
+      },
+      "fqn": "construct-hub.TagConditionLogicType",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/package-tag/index.ts",
+        "line": 86
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "AND"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "OR"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "NOT"
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "name": "EQUALS"
+        }
+      ],
+      "name": "TagConditionLogicType"
+    },
     "construct-hub.sources.CodeArtifact": {
       "assembly": "construct-hub",
       "docs": {
@@ -12203,6 +12696,6 @@
       ]
     }
   },
-  "version": "0.2.4",
-  "fingerprint": "0PSa5xITsfvJdF1LetBMKO+PP++bGgXU1YCWBXjM6OU="
+  "version": "0.2.8",
+  "fingerprint": "aao0foFih4k7WZzeJREWA35MqMJxPG2Sa3uUHGc0+3U="
 }