construct-hub 0.3.191 → 0.3.192

package/.jsii

@@ -1997,7 +1997,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 106
+        "line": 107
       },
       "name": "Category",
       "properties": [
@@ -2010,7 +2010,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 110
+            "line": 111
           },
           "name": "title",
           "type": {
@@ -2028,7 +2028,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 119
+            "line": 120
           },
           "name": "url",
           "type": {
@@ -2049,7 +2049,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 199
+        "line": 200
       },
       "name": "CodeArtifactDomainProps",
       "properties": [
@@ -2062,7 +2062,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 203
+            "line": 204
           },
           "name": "name",
           "type": {
@@ -2078,7 +2078,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 209
+            "line": 210
           },
           "name": "upstreams",
           "optional": true,
@@ -2108,7 +2108,7 @@
         },
         "locationInModule": {
           "filename": "src/construct-hub.ts",
-          "line": 218
+          "line": 219
         },
         "parameters": [
           {
@@ -2138,7 +2138,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 215
+        "line": 216
       },
       "name": "ConstructHub",
       "properties": [
@@ -2150,7 +2150,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 410
+            "line": 411
           },
           "name": "grantPrincipal",
           "overrides": "@aws-cdk/aws-iam.IGrantable",
@@ -2165,7 +2165,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 414
+            "line": 415
           },
           "name": "ingestionQueue",
           "type": {
@@ -2186,7 +2186,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 35
+        "line": 36
       },
       "name": "ConstructHubProps",
       "properties": [
@@ -2200,7 +2200,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 188
+            "line": 189
           },
           "name": "additionalDomains",
           "optional": true,
@@ -2222,7 +2222,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 44
+            "line": 45
           },
           "name": "alarmActions",
           "optional": true,
@@ -2240,7 +2240,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 106
+            "line": 107
           },
           "name": "allowedLicenses",
           "optional": true,
@@ -2262,7 +2262,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 85
+            "line": 86
           },
           "name": "backendDashboardName",
           "optional": true,
@@ -2280,7 +2280,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 159
+            "line": 160
           },
           "name": "categories",
           "optional": true,
@@ -2304,7 +2304,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 117
+            "line": 118
           },
           "name": "codeArtifactDomain",
           "optional": true,
@@ -2322,7 +2322,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 92
+            "line": 93
           },
           "name": "denyList",
           "optional": true,
@@ -2344,7 +2344,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 39
+            "line": 40
           },
           "name": "domain",
           "optional": true,
@@ -2364,7 +2364,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 170
+            "line": 171
           },
           "name": "failoverStorage",
           "optional": true,
@@ -2382,7 +2382,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 138
+            "line": 139
           },
           "name": "featuredPackages",
           "optional": true,
@@ -2399,7 +2399,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 143
+            "line": 144
           },
           "name": "featureFlags",
           "optional": true,
@@ -2417,7 +2417,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 153
+            "line": 154
           },
           "name": "fetchPackageStats",
           "optional": true,
@@ -2436,7 +2436,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 58
+            "line": 59
           },
           "name": "isolateSensitiveTasks",
           "optional": true,
@@ -2456,7 +2456,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 79
+            "line": 80
           },
           "name": "logRetention",
           "optional": true,
@@ -2473,7 +2473,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 122
+            "line": 123
           },
           "name": "packageLinks",
           "optional": true,
@@ -2496,7 +2496,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 99
+            "line": 100
           },
           "name": "packageSources",
           "optional": true,
@@ -2518,7 +2518,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 132
+            "line": 133
           },
           "name": "packageTagGroups",
           "optional": true,
@@ -2540,7 +2540,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 127
+            "line": 128
           },
           "name": "packageTags",
           "optional": true,
@@ -2557,17 +2557,17 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "Defines source code for a preload.js script inserted at the top of the <head /> of the webapp."
+            "summary": "Javascript to run on webapp before app loads."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 193
+            "line": 194
           },
           "name": "preloadScript",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "construct-hub.PreloadFile"
           }
         },
         {
@@ -2582,7 +2582,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 180
+            "line": 181
           },
           "name": "reprocessFrequency",
           "optional": true,
@@ -2601,7 +2601,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 72
+            "line": 73
           },
           "name": "sensitiveTaskIsolation",
           "optional": true,
@@ -2829,7 +2829,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 97
+        "line": 98
       },
       "name": "FeatureFlags",
       "properties": [
@@ -2841,7 +2841,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 98
+            "line": 99
           },
           "name": "homeRedesign",
           "optional": true,
@@ -2857,7 +2857,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 99
+            "line": 100
           },
           "name": "searchRedesign",
           "optional": true,
@@ -2879,7 +2879,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 50
+        "line": 51
       },
       "name": "FeaturedPackages",
       "properties": [
@@ -2892,7 +2892,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 54
+            "line": 55
           },
           "name": "sections",
           "type": {
@@ -2918,7 +2918,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 82
+        "line": 83
       },
       "name": "FeaturedPackagesDetail",
       "properties": [
@@ -2931,7 +2931,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 86
+            "line": 87
           },
           "name": "name",
           "type": {
@@ -2947,7 +2947,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 91
+            "line": 92
           },
           "name": "comment",
           "optional": true,
@@ -2969,7 +2969,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 60
+        "line": 61
       },
       "name": "FeaturedPackagesSection",
       "properties": [
@@ -2982,7 +2982,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 64
+            "line": 65
           },
           "name": "name",
           "type": {
@@ -2999,7 +2999,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 70
+            "line": 71
           },
           "name": "showLastUpdated",
           "optional": true,
@@ -3017,7 +3017,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 76
+            "line": 77
           },
           "name": "showPackages",
           "optional": true,
@@ -3463,7 +3463,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 529
+        "line": 530
       },
       "members": [
         {
@@ -3620,7 +3620,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/webapp/index.ts",
-        "line": 20
+        "line": 21
       },
       "name": "PackageLinkConfig",
       "properties": [
@@ -3633,7 +3633,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 30
+            "line": 31
           },
           "name": "configKey",
           "type": {
@@ -3649,7 +3649,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 24
+            "line": 25
           },
           "name": "linkLabel",
           "type": {
@@ -3666,7 +3666,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 44
+            "line": 45
           },
           "name": "allowedDomains",
           "optional": true,
@@ -3689,7 +3689,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/webapp/index.ts",
-            "line": 37
+            "line": 38
           },
           "name": "linkText",
           "optional": true,
@@ -4349,6 +4349,106 @@
       ],
       "symbolId": "src/package-tag-group/index:PackageTagGroupProps"
     },
+    "construct-hub.PreloadFile": {
+      "assembly": "construct-hub",
+      "docs": {
+        "remarks": "This can allow operators to add their own client monitors or analytics if they wish",
+        "stability": "experimental",
+        "summary": "Represents a javascript file to load before the webapp."
+      },
+      "fqn": "construct-hub.PreloadFile",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/preload-file/index.ts",
+          "line": 23
+        },
+        "parameters": [
+          {
+            "name": "data",
+            "type": {
+              "primitive": "string"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/preload-file/index.ts",
+        "line": 7
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Creates a PreloadFile instance directly from source code."
+          },
+          "locationInModule": {
+            "filename": "src/preload-file/index.ts",
+            "line": 19
+          },
+          "name": "fromCode",
+          "parameters": [
+            {
+              "name": "code",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.PreloadFile"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Creates a PreloadFile instance from a filepath to load."
+          },
+          "locationInModule": {
+            "filename": "src/preload-file/index.ts",
+            "line": 11
+          },
+          "name": "fromFile",
+          "parameters": [
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "construct-hub.PreloadFile"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/preload-file/index.ts",
+            "line": 25
+          },
+          "name": "bind",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "PreloadFile",
+      "symbolId": "src/preload-file/index:PreloadFile"
+    },
     "construct-hub.S3StorageFactory": {
       "assembly": "construct-hub",
       "base": "@aws-cdk/core.Construct",
@@ -14243,6 +14343,6 @@
       "symbolId": "src/package-sources/npmjs:NpmJsProps"
     }
   },
-  "version": "0.3.191",
-  "fingerprint": "Vj+DJV2Ba0CCqTcCVQcmxXp7UPQAbdSU0tVl4XQMQaM="
+  "version": "0.3.192",
+  "fingerprint": "+l5qfUPFrDEwMN975C+V3k9kSJjKw07k6MwA4G1iBNg="
 }

package/API.md

@@ -359,7 +359,7 @@ const constructHubProps: ConstructHubProps = { ... }
 | [`packageSources`](#constructhubconstructhubpropspropertypackagesources) | [`construct-hub.IPackageSource`](#construct-hub.IPackageSource)[] | The package sources to register with this ConstructHub instance. |
 | [`packageTagGroups`](#constructhubconstructhubpropspropertypackagetaggroups) | [`construct-hub.PackageTagGroup`](#construct-hub.PackageTagGroup)[] | Optional configuration for grouping custom package tags. |
 | [`packageTags`](#constructhubconstructhubpropspropertypackagetags) | [`construct-hub.PackageTag`](#construct-hub.PackageTag)[] | Configuration for custom package tags. |
-| [`preloadScript`](#constructhubconstructhubpropspropertypreloadscript) | `string` | Defines source code for a preload.js script inserted at the top of the <head /> of the webapp. |
+| [`preloadScript`](#constructhubconstructhubpropspropertypreloadscript) | [`construct-hub.PreloadFile`](#construct-hub.PreloadFile) | Javascript to run on webapp before app loads. |
 | [`reprocessFrequency`](#constructhubconstructhubpropspropertyreprocessfrequency) | [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration) | How frequently all packages should get fully reprocessed. |
 | [`sensitiveTaskIsolation`](#constructhubconstructhubpropspropertysensitivetaskisolation) | [`construct-hub.Isolation`](#construct-hub.Isolation) | Whether compute environments for sensitive tasks (which operate on un-trusted complex data, such as the transliterator, which operates with externally-sourced npm package tarballs) should run in network-isolated environments. |
 
@@ -604,12 +604,12 @@ Configuration for custom package tags.
 ##### `preloadScript`<sup>Optional</sup> <a name="construct-hub.ConstructHubProps.property.preloadScript" id="constructhubconstructhubpropspropertypreloadscript"></a>
 
 ```typescript
-public readonly preloadScript: string;
+public readonly preloadScript: PreloadFile;
 ```
 
-- *Type:* `string`
+- *Type:* [`construct-hub.PreloadFile`](#construct-hub.PreloadFile)
 
-Defines source code for a preload.js script inserted at the top of the <head /> of the webapp.
+Javascript to run on webapp before app loads.
 
 ---
 
@@ -2124,6 +2124,85 @@ public readonly tooltip: string;
 ---
 
 
+### PreloadFile <a name="construct-hub.PreloadFile" id="constructhubpreloadfile"></a>
+
+Represents a javascript file to load before the webapp.
+
+This can allow operators to add their own client monitors or analytics if they wish
+
+#### Initializers <a name="construct-hub.PreloadFile.Initializer" id="constructhubpreloadfileinitializer"></a>
+
+```typescript
+import { PreloadFile } from 'construct-hub'
+
+new PreloadFile(data: string)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| [`data`](#constructhubpreloadfileparameterdata)<span title="Required">*</span> | `string` | *No description.* |
+
+---
+
+##### `data`<sup>Required</sup> <a name="construct-hub.PreloadFile.parameter.data" id="constructhubpreloadfileparameterdata"></a>
+
+- *Type:* `string`
+
+---
+
+#### Methods <a name="Methods" id="methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| [`bind`](#constructhubpreloadfilebind) | *No description.* |
+
+---
+
+##### `bind` <a name="construct-hub.PreloadFile.bind" id="constructhubpreloadfilebind"></a>
+
+```typescript
+public bind()
+```
+
+#### Static Functions <a name="Static Functions" id="static-functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| [`fromCode`](#constructhubpreloadfilefromcode) | Creates a PreloadFile instance directly from source code. |
+| [`fromFile`](#constructhubpreloadfilefromfile) | Creates a PreloadFile instance from a filepath to load. |
+
+---
+
+##### `fromCode` <a name="construct-hub.PreloadFile.fromCode" id="constructhubpreloadfilefromcode"></a>
+
+```typescript
+import { PreloadFile } from 'construct-hub'
+
+PreloadFile.fromCode(code: string)
+```
+
+###### `code`<sup>Required</sup> <a name="construct-hub.PreloadFile.parameter.code" id="constructhubpreloadfileparametercode"></a>
+
+- *Type:* `string`
+
+---
+
+##### `fromFile` <a name="construct-hub.PreloadFile.fromFile" id="constructhubpreloadfilefromfile"></a>
+
+```typescript
+import { PreloadFile } from 'construct-hub'
+
+PreloadFile.fromFile(path: string)
+```
+
+###### `path`<sup>Required</sup> <a name="construct-hub.PreloadFile.parameter.path" id="constructhubpreloadfileparameterpath"></a>
+
+- *Type:* `string`
+
+---
+
+
+
 ### SpdxLicense <a name="construct-hub.SpdxLicense" id="constructhubspdxlicense"></a>
 
 Valid SPDX License identifiers.

package/changelog.md

@@ -1,2 +1,2 @@
 
-### [0.3.191](https://github.com/cdklabs/construct-hub/compare/v0.3.190...v0.3.191) (2022-01-08)
+### [0.3.192](https://github.com/cdklabs/construct-hub/compare/v0.3.191...v0.3.192) (2022-01-08)