projen 0.61.14 → 0.61.15

package/.jsii

@@ -15,6 +15,7 @@
     "case": "^1.6.3",
     "chalk": "^4.1.2",
     "conventional-changelog-config-spec": "^2.1.0",
+    "fast-json-patch": "^3.1.1",
     "fs-extra": "^9.1.0",
     "glob": "^7",
     "ini": "^2.0.0",
@@ -61,49 +62,49 @@
     "projen.awscdk": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 47
+        "line": 48
       },
       "symbolId": "src/awscdk/index:"
     },
     "projen.build": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 51
+        "line": 52
       },
       "symbolId": "src/build/index:"
     },
     "projen.cdk": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 50
+        "line": 51
       },
       "symbolId": "src/cdk/index:"
     },
     "projen.cdk8s": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 48
+        "line": 49
       },
       "symbolId": "src/cdk8s/index:"
     },
     "projen.cdktf": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 49
+        "line": 50
       },
       "symbolId": "src/cdktf/index:"
     },
     "projen.circleci": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 40
+        "line": 41
       },
       "symbolId": "src/circleci/index:"
     },
     "projen.github": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 38
+        "line": 39
       },
       "symbolId": "src/github/index:"
     },
@@ -117,56 +118,56 @@
     "projen.gitlab": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 39
+        "line": 40
       },
       "symbolId": "src/gitlab/index:"
     },
     "projen.java": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 42
+        "line": 43
       },
       "symbolId": "src/java/index:"
     },
     "projen.javascript": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 45
+        "line": 46
       },
       "symbolId": "src/javascript/index:"
     },
     "projen.python": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 43
+        "line": 44
       },
       "symbolId": "src/python/index:"
     },
     "projen.release": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 46
+        "line": 47
       },
       "symbolId": "src/release/index:"
     },
     "projen.typescript": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 44
+        "line": 45
       },
       "symbolId": "src/typescript/index:"
     },
     "projen.vscode": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 41
+        "line": 42
       },
       "symbolId": "src/vscode/index:"
     },
     "projen.web": {
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 37
+        "line": 38
       },
       "symbolId": "src/web/index:"
     }
@@ -4289,6 +4290,256 @@
       ],
       "symbolId": "src/json:JsonFileOptions"
     },
+    "projen.JsonPatch": {
+      "assembly": "projen",
+      "docs": {
+        "example": "const output = JsonPatch.apply(input,\n JsonPatch.replace('/world/hi/there', 'goodbye'),\n JsonPatch.add('/world/foo/', 'boom'),\n JsonPatch.remove('/hello'));",
+        "remarks": "Use the the `JsonPatch.apply(doc, ...ops)` function to apply a set of\noperations to a JSON document and return the result.\n\nOperations can be created using the factory methods `JsonPatch.add()`,\n`JsonPatch.remove()`, etc.",
+        "stability": "experimental",
+        "summary": "Utility for applying RFC-6902 JSON-Patch to a document."
+      },
+      "fqn": "projen.JsonPatch",
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/json-patch.ts",
+        "line": 22
+      },
+      "methods": [
+        {
+          "docs": {
+            "example": "JsonPatch.add('/biscuits/1', { \"name\": \"Ginger Nut\" })",
+            "remarks": "In the case of an\narray, the value is inserted before the given index. The - character can be\nused instead of an index to insert at the end of an array.",
+            "stability": "experimental",
+            "summary": "Adds a value to an object or inserts it into an array."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 44
+          },
+          "name": "add",
+          "parameters": [
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "value",
+              "type": {
+                "primitive": "any"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "returns": "The result document",
+            "stability": "experimental",
+            "summary": "Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 29
+          },
+          "name": "apply",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The document to patch."
+              },
+              "name": "document",
+              "type": {
+                "primitive": "any"
+              }
+            },
+            {
+              "docs": {
+                "summary": "The operations to apply."
+              },
+              "name": "ops",
+              "type": {
+                "fqn": "projen.JsonPatch"
+              },
+              "variadic": true
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "any"
+            }
+          },
+          "static": true,
+          "variadic": true
+        },
+        {
+          "docs": {
+            "example": "JsonPatch.copy('/biscuits/0', '/best_biscuit')",
+            "remarks": "Both\nfrom and path are JSON Pointers.",
+            "stability": "experimental",
+            "summary": "Copies a value from one location to another within the JSON document."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 73
+          },
+          "name": "copy",
+          "parameters": [
+            {
+              "name": "from",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "example": "JsonPatch.move('/biscuits', '/cookies')",
+            "remarks": "Both from and path are JSON Pointers.",
+            "stability": "experimental",
+            "summary": "Moves a value from one location to the other."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 82
+          },
+          "name": "move",
+          "parameters": [
+            {
+              "name": "from",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "example": "JsonPatch.remove('/biscuits/0')",
+            "stability": "experimental",
+            "summary": "Removes a value from an object or array."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 54
+          },
+          "name": "remove",
+          "parameters": [
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "example": "JsonPatch.replace('/biscuits/0/name', 'Chocolate Digestive')",
+            "remarks": "Equivalent to a “remove” followed by an “add”.",
+            "stability": "experimental",
+            "summary": "Replaces a value."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 63
+          },
+          "name": "replace",
+          "parameters": [
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "value",
+              "type": {
+                "primitive": "any"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "example": "JsonPatch.test('/best_biscuit/name', 'Choco Leibniz')",
+            "remarks": "If the test fails,\nthen the patch as a whole should not apply.",
+            "stability": "experimental",
+            "summary": "Tests that the specified value is set in the document."
+          },
+          "locationInModule": {
+            "filename": "src/json-patch.ts",
+            "line": 92
+          },
+          "name": "test",
+          "parameters": [
+            {
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "value",
+              "type": {
+                "primitive": "any"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.JsonPatch"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "JsonPatch",
+      "symbolId": "src/json-patch:JsonPatch"
+    },
     "projen.License": {
       "assembly": "projen",
       "base": "projen.FileBase",
@@ -5011,7 +5262,7 @@
         },
         "locationInModule": {
           "filename": "src/object-file.ts",
-          "line": 44
+          "line": 50
         },
         "parameters": [
           {
@@ -5037,7 +5288,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/object-file.ts",
-        "line": 27
+        "line": 28
       },
       "methods": [
         {
@@ -5047,7 +5298,7 @@
           },
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 181
+            "line": 222
           },
           "name": "addDeletionOverride",
           "parameters": [
@@ -5070,7 +5321,7 @@
           },
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 86
+            "line": 93
           },
           "name": "addOverride",
           "parameters": [
@@ -5104,7 +5355,7 @@
           },
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 149
+            "line": 156
           },
           "name": "addToArray",
           "parameters": [
@@ -5132,6 +5383,31 @@
           ],
           "variadic": true
         },
+        {
+          "docs": {
+            "remarks": "For example, with the following object file\n```json\n\"compilerOptions\": {\n   \"exclude\": [\"node_modules\"],\n   \"lib\": [\"es2019\"]\n   ...\n}\n...\n```\n\n```typescript\nproject.tsconfig.file.patch(JsonPatch.add(\"/compilerOptions/exclude/-\", \"coverage\"));\nproject.tsconfig.file.patch(JsonPatch.replace(\"/compilerOptions/lib\", [\"dom\", \"dom.iterable\", \"esnext\"]));\n```\nwould result in the following object file\n```json\n\"compilerOptions\": {\n   \"exclude\": [\"node_modules\", \"coverage\"],\n   \"lib\": [\"dom\", \"dom.iterable\", \"esnext\"]\n   ...\n}\n...\n```",
+            "stability": "experimental",
+            "summary": "Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information."
+          },
+          "locationInModule": {
+            "filename": "src/object-file.ts",
+            "line": 214
+          },
+          "name": "patch",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "- The patch operations to apply."
+              },
+              "name": "patches",
+              "type": {
+                "fqn": "projen.JsonPatch"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -5139,7 +5415,7 @@
           },
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 185
+            "line": 226
           },
           "name": "synthesizeContent",
           "overrides": "projen.FileBase",
@@ -5170,7 +5446,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 42
+            "line": 43
           },
           "name": "omitEmpty",
           "type": {
@@ -5194,7 +5470,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/object-file.ts",
-        "line": 8
+        "line": 9
       },
       "name": "ObjectFileOptions",
       "properties": [
@@ -5209,7 +5485,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 15
+            "line": 16
           },
           "name": "obj",
           "optional": true,
@@ -5227,7 +5503,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/object-file.ts",
-            "line": 21
+            "line": 22
           },
           "name": "omitEmpty",
           "optional": true,
@@ -48957,6 +49233,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.61.14",
-  "fingerprint": "EhrSKh0kx94eNeQlgUZitYQmCXUnx1Ndle7Z6d0LXnw="
+  "version": "0.61.15",
+  "fingerprint": "5y14ikbHdek9YTEDc7wOytRDacO9tp5lNx2XNY2SzN0="
 }

package/docs/api/API.md

@@ -15,6 +15,7 @@ Name|Description
 [IgnoreFile](#projen-ignorefile)|*No description*
 [IniFile](#projen-inifile)|Represents an INI file.
 [JsonFile](#projen-jsonfile)|Represents a JSON file.
+[JsonPatch](#projen-jsonpatch)|Utility for applying RFC-6902 JSON-Patch to a document.
 [License](#projen-license)|*No description*
 [Logger](#projen-logger)|Project-level logging utilities.
 [Makefile](#projen-makefile)|Minimal Makefile.
@@ -1347,6 +1348,133 @@ __Returns__:
 
 
 
+## class JsonPatch 🔹 <a id="projen-jsonpatch"></a>
+
+Utility for applying RFC-6902 JSON-Patch to a document.
+
+Use the the `JsonPatch.apply(doc, ...ops)` function to apply a set of
+operations to a JSON document and return the result.
+
+Operations can be created using the factory methods `JsonPatch.add()`,
+`JsonPatch.remove()`, etc.
+
+
+### Methods
+
+
+#### *static* add(path, value)🔹 <a id="projen-jsonpatch-add"></a>
+
+Adds a value to an object or inserts it into an array.
+
+In the case of an
+array, the value is inserted before the given index. The - character can be
+used instead of an index to insert at the end of an array.
+
+```ts
+static add(path: string, value: any): JsonPatch
+```
+
+* **path** (<code>string</code>)  *No description*
+* **value** (<code>any</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+#### *static* apply(document, ...ops)🔹 <a id="projen-jsonpatch-apply"></a>
+
+Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result.
+
+```ts
+static apply(document: any, ...ops: JsonPatch[]): any
+```
+
+* **document** (<code>any</code>)  The document to patch.
+* **ops** (<code>[JsonPatch](#projen-jsonpatch)</code>)  The operations to apply.
+
+__Returns__:
+* <code>any</code>
+
+#### *static* copy(from, path)🔹 <a id="projen-jsonpatch-copy"></a>
+
+Copies a value from one location to another within the JSON document.
+
+Both
+from and path are JSON Pointers.
+
+```ts
+static copy(from: string, path: string): JsonPatch
+```
+
+* **from** (<code>string</code>)  *No description*
+* **path** (<code>string</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+#### *static* move(from, path)🔹 <a id="projen-jsonpatch-move"></a>
+
+Moves a value from one location to the other.
+
+Both from and path are JSON Pointers.
+
+```ts
+static move(from: string, path: string): JsonPatch
+```
+
+* **from** (<code>string</code>)  *No description*
+* **path** (<code>string</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+#### *static* remove(path)🔹 <a id="projen-jsonpatch-remove"></a>
+
+Removes a value from an object or array.
+
+```ts
+static remove(path: string): JsonPatch
+```
+
+* **path** (<code>string</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+#### *static* replace(path, value)🔹 <a id="projen-jsonpatch-replace"></a>
+
+Replaces a value.
+
+Equivalent to a “remove” followed by an “add”.
+
+```ts
+static replace(path: string, value: any): JsonPatch
+```
+
+* **path** (<code>string</code>)  *No description*
+* **value** (<code>any</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+#### *static* test(path, value)🔹 <a id="projen-jsonpatch-test"></a>
+
+Tests that the specified value is set in the document.
+
+If the test fails,
+then the patch as a whole should not apply.
+
+```ts
+static test(path: string, value: any): JsonPatch
+```
+
+* **path** (<code>string</code>)  *No description*
+* **value** (<code>any</code>)  *No description*
+
+__Returns__:
+* <code>[JsonPatch](#projen-jsonpatch)</code>
+
+
+
 ## class License 🔹 <a id="projen-license"></a>
 
 
@@ -1746,6 +1874,43 @@ addToArray(path: string, ...values: any[]): void
 
 
 
+#### patch(...patches)🔹 <a id="projen-objectfile-patch"></a>
+
+Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.
+
+For example, with the following object file
+```json
+"compilerOptions": {
+   "exclude": ["node_modules"],
+   "lib": ["es2019"]
+   ...
+}
+...
+```
+
+```typescript
+project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
+project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));
+```
+would result in the following object file
+```json
+"compilerOptions": {
+   "exclude": ["node_modules", "coverage"],
+   "lib": ["dom", "dom.iterable", "esnext"]
+   ...
+}
+...
+```
+
+```ts
+patch(...patches: JsonPatch[]): void
+```
+
+* **patches** (<code>[JsonPatch](#projen-jsonpatch)</code>)  - The patch operations to apply.
+
+
+
+
 #### protected synthesizeContent(resolver)🔹 <a id="projen-objectfile-synthesizecontent"></a>
 
 Implemented by derived classes and returns the contents of the file to emit.