construct-hub 0.3.194 → 0.3.195

package/API.md

@@ -1924,6 +1924,8 @@ const tagConditionConfig: TagConditionConfig = { ... }
 | [`type`](#constructhubtagconditionconfigpropertytype)<span title="Required">*</span> | [`construct-hub.TagConditionLogicType`](#construct-hub.TagConditionLogicType) | *No description.* |
 | [`children`](#constructhubtagconditionconfigpropertychildren) | [`construct-hub.TagConditionConfig`](#construct-hub.TagConditionConfig)[] | *No description.* |
 | [`key`](#constructhubtagconditionconfigpropertykey) | `string`[] | *No description.* |
+| [`options`](#constructhubtagconditionconfigpropertyoptions) | {[ key: string ]: `any`} | *No description.* |
+| [`source`](#constructhubtagconditionconfigpropertysource) | [`construct-hub.TagConditionSource`](#construct-hub.TagConditionSource) | *No description.* |
 | [`value`](#constructhubtagconditionconfigpropertyvalue) | `string` | *No description.* |
 
 ---
@@ -1958,6 +1960,26 @@ public readonly key: string[];
 
 ---
 
+##### `options`<sup>Optional</sup> <a name="construct-hub.TagConditionConfig.property.options" id="constructhubtagconditionconfigpropertyoptions"></a>
+
+```typescript
+public readonly options: {[ key: string ]: any};
+```
+
+- *Type:* {[ key: string ]: `any`}
+
+---
+
+##### `source`<sup>Optional</sup> <a name="construct-hub.TagConditionConfig.property.source" id="constructhubtagconditionconfigpropertysource"></a>
+
+```typescript
+public readonly source: TagConditionSource;
+```
+
+- *Type:* [`construct-hub.TagConditionSource`](#construct-hub.TagConditionSource)
+
+---
+
 ##### `value`<sup>Optional</sup> <a name="construct-hub.TagConditionConfig.property.value" id="constructhubtagconditionconfigpropertyvalue"></a>
 
 ```typescript
@@ -1968,6 +1990,55 @@ public readonly value: string;
 
 ---
 
+### TagConditionIncludesOptions <a name="construct-hub.TagConditionIncludesOptions" id="constructhubtagconditionincludesoptions"></a>
+
+Options for `includes` operator.
+
+#### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
+
+```typescript
+import { TagConditionIncludesOptions } from 'construct-hub'
+
+const tagConditionIncludesOptions: TagConditionIncludesOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| [`atLeast`](#constructhubtagconditionincludesoptionspropertyatleast) | `number` | The value must appear at least this many times. |
+| [`caseSensitive`](#constructhubtagconditionincludesoptionspropertycasesensitive) | `boolean` | String matches must match the casing of the original string. |
+
+---
+
+##### `atLeast`<sup>Optional</sup> <a name="construct-hub.TagConditionIncludesOptions.property.atLeast" id="constructhubtagconditionincludesoptionspropertyatleast"></a>
+
+```typescript
+public readonly atLeast: number;
+```
+
+- *Type:* `number`
+- *Default:* 1
+
+The value must appear at least this many times.
+
+---
+
+##### `caseSensitive`<sup>Optional</sup> <a name="construct-hub.TagConditionIncludesOptions.property.caseSensitive" id="constructhubtagconditionincludesoptionspropertycasesensitive"></a>
+
+```typescript
+public readonly caseSensitive: boolean;
+```
+
+- *Type:* `boolean`
+- *Default:* false
+
+String matches must match the casing of the original string.
+
+This option is ignored if the value we are checking is an array.
+
+---
+
 ## Classes <a name="Classes" id="classes"></a>
 
 ### FilterType <a name="construct-hub.FilterType" id="constructhubfiltertype"></a>
@@ -7292,6 +7363,7 @@ public bind()
 | [`field`](#constructhubtagconditionfield) | 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`. |
 | [`not`](#constructhubtagconditionnot) | Create a ! |
 | [`or`](#constructhubtagconditionor) | Create an \|\| condition which applies if any of the condition arguments are true. |
+| [`readme`](#constructhubtagconditionreadme) | Create a condition with logic targeting the README of the package. |
 
 ---
 
@@ -7351,6 +7423,14 @@ TagCondition.or(conds: TagCondition)
 
 ---
 
+##### `readme` <a name="construct-hub.TagCondition.readme" id="constructhubtagconditionreadme"></a>
+
+```typescript
+import { TagCondition } from 'construct-hub'
+
+TagCondition.readme()
+```
+
 
 
 ### TagConditionField <a name="construct-hub.TagConditionField" id="constructhubtagconditionfield"></a>
@@ -7402,7 +7482,7 @@ public eq(value: any)
 ##### `includes` <a name="construct-hub.TagConditionField.includes" id="constructhubtagconditionfieldincludes"></a>
 
 ```typescript
-public includes(value: any)
+public includes(value: any, options?: TagConditionIncludesOptions)
 ```
 
 ###### `value`<sup>Required</sup> <a name="construct-hub.TagConditionField.parameter.value" id="constructhubtagconditionfieldparametervalue"></a>
@@ -7411,6 +7491,12 @@ public includes(value: any)
 
 ---
 
+###### `options`<sup>Optional</sup> <a name="construct-hub.TagConditionField.parameter.options" id="constructhubtagconditionfieldparameteroptions"></a>
+
+- *Type:* [`construct-hub.TagConditionIncludesOptions`](#construct-hub.TagConditionIncludesOptions)
+
+---
+
 ##### `startsWith` <a name="construct-hub.TagConditionField.startsWith" id="constructhubtagconditionfieldstartswith"></a>
 
 ```typescript
@@ -7426,6 +7512,52 @@ public startsWith(value: string)
 
 
 
+### TagConditionReadme <a name="construct-hub.TagConditionReadme" id="constructhubtagconditionreadme"></a>
+
+Target the README of the package to dictate whether a tag is relevant.
+
+#### Initializers <a name="construct-hub.TagConditionReadme.Initializer" id="constructhubtagconditionreadmeinitializer"></a>
+
+```typescript
+import { TagConditionReadme } from 'construct-hub'
+
+new TagConditionReadme()
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+
+---
+
+#### Methods <a name="Methods" id="methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| [`includes`](#constructhubtagconditionreadmeincludes) | Create a `readme.includes(value)` condition which applies if the README includes the specified string. |
+
+---
+
+##### `includes` <a name="construct-hub.TagConditionReadme.includes" id="constructhubtagconditionreadmeincludes"></a>
+
+```typescript
+public includes(value: string, options?: TagConditionIncludesOptions)
+```
+
+###### `value`<sup>Required</sup> <a name="construct-hub.TagConditionReadme.parameter.value" id="constructhubtagconditionreadmeparametervalue"></a>
+
+- *Type:* `string`
+
+---
+
+###### `options`<sup>Optional</sup> <a name="construct-hub.TagConditionReadme.parameter.options" id="constructhubtagconditionreadmeparameteroptions"></a>
+
+- *Type:* [`construct-hub.TagConditionIncludesOptions`](#construct-hub.TagConditionIncludesOptions)
+
+---
+
+
+
+
 ## Protocols <a name="Protocols" id="protocols"></a>
 
 ### IDenyList <a name="construct-hub.IDenyList" id="constructhubidenylist"></a>
@@ -7689,3 +7821,22 @@ Logic operators for performing specific conditional logic.
 
 ---
 
+
+### TagConditionSource <a name="TagConditionSource" id="tagconditionsource"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| [`PACKAGE_JSON`](#constructhubtagconditionsourcepackagejson) | *No description.* |
+| [`README`](#constructhubtagconditionsourcereadme) | *No description.* |
+
+---
+
+#### `PACKAGE_JSON` <a name="construct-hub.TagConditionSource.PACKAGE_JSON" id="constructhubtagconditionsourcepackagejson"></a>
+
+---
+
+
+#### `README` <a name="construct-hub.TagConditionSource.README" id="constructhubtagconditionsourcereadme"></a>
+
+---
+

package/README.md

@@ -347,6 +347,14 @@ TagCondition.field('constructHub', 'nested', 'key').eq('value');
 packageJson?.constructHub?.nested?.key === value;
 ```
 
+You can also assert that a string occurs at least a certain number of times
+within the package's README.
+
+```ts
+TagCondition.readme().includes('ECS');
+TagCondition.readme().includes('fargate', { atLeast: 3, caseSensitive: false });
+```
+
 #### Package Links
 
 Configuring package links allows you to replace the `Repository`, `License`,

package/changelog.md

@@ -1,2 +1,7 @@
 
-### [0.3.194](https://github.com/cdklabs/construct-hub/compare/v0.3.193...v0.3.194) (2022-01-11)
+### [0.3.195](https://github.com/cdklabs/construct-hub/compare/v0.3.194...v0.3.195) (2022-01-12)
+
+
+### Features
+
+* tag condition type for README contents ([#709](https://github.com/cdklabs/construct-hub/issues/709)) ([09837fe](https://github.com/cdklabs/construct-hub/commit/09837fe275f054d60d03ca908083036767c97970)), closes [#625](https://github.com/cdklabs/construct-hub/issues/625)

package/lib/backend/ingestion/ingestion.lambda.bundle/index.js

@@ -81730,33 +81730,66 @@ function integrity(input, tarball, alg = ((_a) => (_a = input.integrity) == null
 }
 
 // src/backend/shared/tags.ts
-function getNestedField(path, pkg) {
-  return path == null ? void 0 : path.reduce((accum, key) => accum ? accum[key] : void 0, pkg);
+function getNestedField(config, artifacts) {
+  switch (config == null ? void 0 : config.source) {
+    case "PACKAGE_JSON" /* PACKAGE_JSON */:
+      const path = config == null ? void 0 : config.key;
+      return path == null ? void 0 : path.reduce((accum, key) => accum ? accum[key] : void 0, artifacts.pkg);
+    case "README" /* README */:
+      return artifacts.readme;
+    default:
+      throw new Error(`Unexpected TagConditionConfig source: "${config.source}"`);
+  }
 }
-var createBoolCombinator = (combine, initial) => (config, pkg) => {
+var createBoolCombinator = (combine, initial) => (config, artifacts) => {
   var _a;
-  return ((_a = config == null ? void 0 : config.children) == null ? void 0 : _a.reduce((accum, cond) => combine(accum, isTagApplicable(cond, pkg)), initial)) ?? true;
+  return ((_a = config == null ? void 0 : config.children) == null ? void 0 : _a.reduce((accum, cond) => combine(accum, isTagApplicable(cond, artifacts)), initial)) ?? true;
 };
-var createFieldComparator = (compare) => (config, pkg) => compare(getNestedField(config == null ? void 0 : config.key, pkg), config == null ? void 0 : config.value);
-var not = (config, pkg) => {
+var createFieldComparator = (compare) => (config, artifacts) => compare(getNestedField(config, artifacts), config == null ? void 0 : config.value, config == null ? void 0 : config.options);
+var not = (config, artifacts) => {
   var _a;
   const cond = (_a = config == null ? void 0 : config.children) == null ? void 0 : _a[0];
   if (!cond) {
     throw new Error("NOT logical operator requires a single condition");
   }
-  return !isTagApplicable(cond, pkg);
+  return !isTagApplicable(cond, artifacts);
+};
+var checkIncludes = (haystack, needle, options = {}) => {
+  const atLeast = options.atLeast ?? 1;
+  const caseSensitive = options.caseSensitive ?? false;
+  if (typeof haystack === "string") {
+    if (typeof needle !== "string") {
+      return false;
+    }
+    if (!caseSensitive) {
+      needle = needle.toLowerCase();
+      haystack = haystack.toLowerCase();
+    }
+    const matches = haystack.match(new RegExp(needle, "g")) ?? [];
+    return matches.length >= atLeast;
+  }
+  if (Array.isArray(haystack)) {
+    let matches = 0;
+    for (const item of haystack) {
+      if (item === needle) {
+        matches += 1;
+      }
+    }
+    return matches >= atLeast;
+  }
+  return false;
 };
-function isTagApplicable(config, pkg) {
+function isTagApplicable(config, artifacts) {
   const fnMap = {
     ["AND" /* AND */]: createBoolCombinator((field, val) => field && val, true),
     ["OR" /* OR */]: createBoolCombinator((field, val) => field || val, false),
     ["EQUALS" /* EQUALS */]: createFieldComparator((field, val) => field === val),
-    ["INCLUDES" /* INCLUDES */]: createFieldComparator((field, val) => field.includes(val)),
+    ["INCLUDES" /* INCLUDES */]: createFieldComparator((field, val) => checkIncludes(field, val, config.options)),
     ["STARTS_WITH" /* STARTS_WITH */]: createFieldComparator((field, val) => field.startsWith(val)),
     ["NOT" /* NOT */]: not
   };
   const fn = fnMap[config.type] ?? (() => false);
-  return fn(config, pkg);
+  return fn(config, artifacts);
 }
 
 // src/backend/shared/tarball.lambda-shared.ts
@@ -81927,13 +81960,15 @@ var handler = (0, import_aws_embedded_metrics.metricScope)((metrics) => async (e
     let packageLicense;
     let packageName;
     let packageVersion;
+    let packageReadme;
     try {
       parsedAssembly = (0, import_spec.validateAssembly)(JSON.parse(dotJsii.toString("utf-8")));
       constructFramework = detectConstructFramework(parsedAssembly);
-      const { license, name, version } = parsedAssembly;
+      const { license, name, version, readme } = parsedAssembly;
       packageLicense = license;
       packageName = name;
       packageVersion = version;
+      packageReadme = (readme == null ? void 0 : readme.markdown) ?? "";
       delete parsedAssembly.types;
       delete parsedAssembly.readme;
       delete parsedAssembly.dependencyClosure;
@@ -81970,7 +82005,7 @@ var handler = (0, import_aws_embedded_metrics.metricScope)((metrics) => async (e
     }, {});
     const packageTags = packageTagsConfig.reduce((accum, tagConfig) => {
       const _a = tagConfig, { condition } = _a, tagData = __objRest(_a, ["condition"]);
-      if (isTagApplicable(condition, packageJsonObj)) {
+      if (isTagApplicable(condition, { pkg: packageJsonObj, readme: packageReadme })) {
         return [...accum, tagData];
       }
       return accum;