projen 0.67.27 → 0.67.28

package/.jsii

@@ -1115,7 +1115,7 @@
         },
         "locationInModule": {
           "filename": "src/docker-compose/docker-compose.ts",
-          "line": 129
+          "line": 155
         },
         "parameters": [
           {
@@ -1136,7 +1136,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose.ts",
-        "line": 48
+        "line": 53
       },
       "methods": [
         {
@@ -1146,7 +1146,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 84
+            "line": 89
           },
           "name": "bindVolume",
           "parameters": [
@@ -1184,7 +1184,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 108
+            "line": 113
           },
           "name": "namedVolume",
           "parameters": [
@@ -1224,6 +1224,45 @@
           },
           "static": true
         },
+        {
+          "docs": {
+            "remarks": "If you use this\nnamed network in several services, the network will be shared. In this\ncase, the network configuration of the first-provided options are used.",
+            "stability": "experimental",
+            "summary": "Create a named network and mount it to the target path."
+          },
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose.ts",
+            "line": 139
+          },
+          "name": "network",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Name of the network."
+              },
+              "name": "networkName",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "docs": {
+                "summary": "network configuration."
+              },
+              "name": "options",
+              "optional": true,
+              "type": {
+                "fqn": "projen.DockerComposeNetworkConfig"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.IDockerComposeNetworkBinding"
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -1231,7 +1270,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 64
+            "line": 69
           },
           "name": "portMapping",
           "parameters": [
@@ -1278,7 +1317,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 52
+            "line": 57
           },
           "name": "serviceName",
           "parameters": [
@@ -1303,7 +1342,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 157
+            "line": 183
           },
           "name": "addService",
           "parameters": [
@@ -1347,7 +1386,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose.ts",
-        "line": 181
+        "line": 207
       },
       "name": "DockerComposeBuild",
       "properties": [
@@ -1360,7 +1399,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 185
+            "line": 211
           },
           "name": "context",
           "type": {
@@ -1377,7 +1416,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 197
+            "line": 223
           },
           "name": "args",
           "optional": true,
@@ -1400,7 +1439,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 191
+            "line": 217
           },
           "name": "dockerfile",
           "optional": true,
@@ -1411,6 +1450,305 @@
       ],
       "symbolId": "src/docker-compose/docker-compose:DockerComposeBuild"
     },
+    "projen.DockerComposeNetworkConfig": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Network configuration."
+      },
+      "fqn": "projen.DockerComposeNetworkConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/docker-compose/docker-compose-network.ts",
+        "line": 32
+      },
+      "name": "DockerComposeNetworkConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Set to true to indicate that standalone containers can attach to this network, in addition to services."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 67
+          },
+          "name": "attachable",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Set to true to indicate that the network is a bridge network."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 49
+          },
+          "name": "bridge",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- value is not provided",
+            "stability": "experimental",
+            "summary": "Driver to use for the network."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 37
+          },
+          "name": "driver",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- value is not provided",
+            "remarks": "Those options are driver-dependent - consult the driver’s documentation for more information",
+            "stability": "experimental",
+            "summary": "Options for the configured driver."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 43
+          },
+          "name": "driverOpts",
+          "optional": true,
+          "type": {
+            "primitive": "json"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset, indicating that docker-compose creates the network",
+            "stability": "experimental",
+            "summary": "Set to true to indicate that the network is externally created."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 61
+          },
+          "name": "external",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Set to true to indicate that you want to create an externally isolated overlay network."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 79
+          },
+          "name": "internal",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Specify custom IPAM config."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 73
+          },
+          "name": "ipam",
+          "optional": true,
+          "type": {
+            "fqn": "projen.DockerComposeNetworkIpamConfig"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Attach labels to the network."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 85
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset, indicating that docker-compose creates networks as usual",
+            "stability": "experimental",
+            "summary": "Name of the network for when the network name isn't going to work in YAML."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 91
+          },
+          "name": "name",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- unset",
+            "stability": "experimental",
+            "summary": "Set to true to indicate that the network is an overlay network."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 55
+          },
+          "name": "overlay",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/docker-compose/docker-compose-network:DockerComposeNetworkConfig"
+    },
+    "projen.DockerComposeNetworkIpamConfig": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "IPAM configuration."
+      },
+      "fqn": "projen.DockerComposeNetworkIpamConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/docker-compose/docker-compose-network.ts",
+        "line": 15
+      },
+      "name": "DockerComposeNetworkIpamConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- value is not provided",
+            "stability": "experimental",
+            "summary": "A list with zero or more config blocks specifying custom IPAM configuration."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 26
+          },
+          "name": "config",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.DockerComposeNetworkIpamSubnetConfig"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- value is not provided",
+            "stability": "experimental",
+            "summary": "Driver to use for custom IPAM config."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 20
+          },
+          "name": "driver",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/docker-compose/docker-compose-network:DockerComposeNetworkIpamConfig"
+    },
+    "projen.DockerComposeNetworkIpamSubnetConfig": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "IPAM subnet configuration."
+      },
+      "fqn": "projen.DockerComposeNetworkIpamSubnetConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/docker-compose/docker-compose-network.ts",
+        "line": 4
+      },
+      "name": "DockerComposeNetworkIpamSubnetConfig",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- value is not provided",
+            "stability": "experimental",
+            "summary": "Subnet in CIDR format that represents a network segment."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 9
+          },
+          "name": "subnet",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/docker-compose/docker-compose-network:DockerComposeNetworkIpamSubnetConfig"
+    },
     "projen.DockerComposePortMappingOptions": {
       "assembly": "projen",
       "datatype": true,
@@ -1458,7 +1796,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose.ts",
-        "line": 25
+        "line": 30
       },
       "name": "DockerComposeProps",
       "properties": [
@@ -1473,7 +1811,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 31
+            "line": 36
           },
           "name": "nameSuffix",
           "optional": true,
@@ -1491,7 +1829,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 37
+            "line": 42
           },
           "name": "schemaVersion",
           "optional": true,
@@ -1508,7 +1846,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose.ts",
-            "line": 42
+            "line": 47
           },
           "name": "services",
           "optional": true,
@@ -1568,7 +1906,7 @@
         },
         "locationInModule": {
           "filename": "src/docker-compose/docker-compose-service.ts",
-          "line": 62
+          "line": 68
         },
         "parameters": [
           {
@@ -1591,7 +1929,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose-service.ts",
-        "line": 21
+        "line": 22
       },
       "methods": [
         {
@@ -1601,7 +1939,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 114
+            "line": 121
           },
           "name": "addDependsOn",
           "parameters": [
@@ -1620,7 +1958,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 106
+            "line": 113
           },
           "name": "addEnvironment",
           "parameters": [
@@ -1644,6 +1982,25 @@
             }
           ]
         },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Add a network to the service."
+          },
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-service.ts",
+            "line": 137
+          },
+          "name": "addNetwork",
+          "parameters": [
+            {
+              "name": "network",
+              "type": {
+                "fqn": "projen.IDockerComposeNetworkBinding"
+              }
+            }
+          ]
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -1651,7 +2008,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 91
+            "line": 98
           },
           "name": "addPort",
           "parameters": [
@@ -1692,7 +2049,7 @@
           },
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 122
+            "line": 129
           },
           "name": "addVolume",
           "parameters": [
@@ -1715,7 +2072,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 45
+            "line": 46
           },
           "name": "dependsOn",
           "type": {
@@ -1735,7 +2092,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 60
+            "line": 66
           },
           "name": "environment",
           "type": {
@@ -1747,6 +2104,26 @@
             }
           }
         },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Networks mounted in the container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-service.ts",
+            "line": 56
+          },
+          "name": "networks",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.IDockerComposeNetworkBinding"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -1755,7 +2132,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 55
+            "line": 61
           },
           "name": "ports",
           "type": {
@@ -1775,7 +2152,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 25
+            "line": 26
           },
           "name": "serviceName",
           "overrides": "projen.IDockerComposeServiceName",
@@ -1791,7 +2168,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 50
+            "line": 51
           },
           "name": "volumes",
           "type": {
@@ -1811,7 +2188,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 40
+            "line": 41
           },
           "name": "command",
           "optional": true,
@@ -1832,7 +2209,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 30
+            "line": 31
           },
           "name": "image",
           "optional": true,
@@ -1848,7 +2225,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 35
+            "line": 36
           },
           "name": "imageBuild",
           "optional": true,
@@ -1870,7 +2247,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose-service.ts",
-        "line": 130
+        "line": 145
       },
       "name": "DockerComposeServiceDescription",
       "properties": [
@@ -1884,7 +2261,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 149
+            "line": 164
           },
           "name": "command",
           "optional": true,
@@ -1907,7 +2284,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 155
+            "line": 170
           },
           "name": "dependsOn",
           "optional": true,
@@ -1930,7 +2307,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 175
+            "line": 196
           },
           "name": "environment",
           "optional": true,
@@ -1954,7 +2331,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 136
+            "line": 151
           },
           "name": "image",
           "optional": true,
@@ -1973,7 +2350,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 143
+            "line": 158
           },
           "name": "imageBuild",
           "optional": true,
@@ -1981,6 +2358,29 @@
             "fqn": "projen.DockerComposeBuild"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "see": "DockerCompose.network() to create & mount a named network",
+            "stability": "experimental",
+            "summary": "Add some networks to the service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-service.ts",
+            "line": 184
+          },
+          "name": "networks",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.IDockerComposeNetworkBinding"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1991,7 +2391,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 169
+            "line": 190
           },
           "name": "ports",
           "optional": true,
@@ -2015,7 +2415,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 163
+            "line": 178
           },
           "name": "volumes",
           "optional": true,
@@ -3589,6 +3989,95 @@
       "name": "IDevEnvironment",
       "symbolId": "src/dev-env:IDevEnvironment"
     },
+    "projen.IDockerComposeNetworkBinding": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Network binding information."
+      },
+      "fqn": "projen.IDockerComposeNetworkBinding",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/docker-compose/docker-compose-network.ts",
+        "line": 97
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "returns": "the service name",
+            "stability": "experimental",
+            "summary": "Binds the requested network to the docker-compose network configuration and provide mounting instructions for synthesis."
+          },
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 104
+          },
+          "name": "bind",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "the network configuration."
+              },
+              "name": "networkConfig",
+              "type": {
+                "fqn": "projen.IDockerComposeNetworkConfig"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "IDockerComposeNetworkBinding",
+      "symbolId": "src/docker-compose/docker-compose-network:IDockerComposeNetworkBinding"
+    },
+    "projen.IDockerComposeNetworkConfig": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Storage for network configuration."
+      },
+      "fqn": "projen.IDockerComposeNetworkConfig",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/docker-compose/docker-compose-network.ts",
+        "line": 110
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Add network configuration to the repository."
+          },
+          "locationInModule": {
+            "filename": "src/docker-compose/docker-compose-network.ts",
+            "line": 116
+          },
+          "name": "addNetworkConfiguration",
+          "parameters": [
+            {
+              "name": "networkName",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "configuration",
+              "type": {
+                "fqn": "projen.DockerComposeNetworkConfig"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "IDockerComposeNetworkConfig",
+      "symbolId": "src/docker-compose/docker-compose-network:IDockerComposeNetworkConfig"
+    },
     "projen.IDockerComposeServiceName": {
       "assembly": "projen",
       "docs": {
@@ -3599,7 +4088,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/docker-compose/docker-compose-service.ts",
-        "line": 11
+        "line": 12
       },
       "name": "IDockerComposeServiceName",
       "properties": [
@@ -3612,7 +4101,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/docker-compose/docker-compose-service.ts",
-            "line": 15
+            "line": 16
           },
           "name": "serviceName",
           "type": {
@@ -51082,6 +51571,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.67.27",
-  "fingerprint": "PnPYpFt4YkrfsU0ocT67LX1eZB6W03Ux3j0tsQ7zD4I="
+  "version": "0.67.28",
+  "fingerprint": "pHX5uZS7FA+ZFuohvDHP48hzuvfU6QePuFijTGmbQ3Q="
 }