@gigadrive/network-config 5.0.0 → 5.1.0

package/src/v4/schema.json

@@ -144,17 +144,22 @@
             "minimum": 1
           },
           "runtime": {
-            "$ref": "#/$defs/runtimes",
-            "description": "The runtime to use for the function."
+            "anyOf": [{ "$ref": "#/$defs/runtimes" }, { "const": "docker" }],
+            "description": "The runtime to use for the function. `docker` builds the matched file as a Dockerfile, with its directory as the build context, and runs the image as the function."
+          },
+          "port": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 65535,
+            "description": "TCP port the image listens on. Only for `runtime: docker`. Defaults to the first exposed port of the image, then 8080."
           },
           "streaming": {
             "type": "boolean",
             "description": "Enable function response streaming. When omitted, Node and Bun runtimes stream by default."
           },
           "schedule": {
-            "type": "string",
-            "description": "An expression to schedule the function to run at specific times.",
-            "pattern": "^(?:rate[(](?:(?:1[ ]+(hour|minute|day))|(?:[0-9]+[ ]+(hours|minutes|days)))[)])|(?:cron[(](?:(?:(?:[0-5]?[0-9])|[*])(?:(?:[-](?:(?:[0-5]?[0-9])|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[0-5]?[0-9])|[*])(?:(?:[-](?:(?:[0-5]?[0-9])|[*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[0-2]?[0-9])|[*])(?:(?:[-](?:(?:[0-2]?[0-9])|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[0-2]?[0-9])|[*])(?:(?:[-](?:(?:[0-2]?[0-9])|[*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:[?][ ]+(?:(?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?(?:[,](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))[#][0-5])|(?:(?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*])(?:(?:[-](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*]))|(?:[/][0-9]+))?(?:[,](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*])(?:(?:[-](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*]))|(?:[/][0-9]+))?)*)))|(?:(?:(?:(?:(?:[1-3]?[0-9])W?)|LW|[L*])(?:(?:[-](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*]))|(?:[/][0-9]+))?(?:[,](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*])(?:(?:[-](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?(?:[,](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?)*)[ ]+[?]))[ ]+(?:(?:(?:[12][0-9]{3})|[*])(?:(?:[-](?:(?:[12][0-9]{3})|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[12][0-9]{3})|[*])(?:(?:[-](?:(?:[12][0-9]{3})|[*]))|(?:[/][0-9]+))?)*)[)])$"
+            "$ref": "#/$defs/schedule",
+            "description": "An expression to schedule the function to run at specific times."
           },
           "symlinks": {
             "type": "object",
@@ -246,6 +251,151 @@
         }
       }
     },
+    "compose": {
+      "type": ["string", "null"],
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Project-relative path of a Compose file whose services are imported as containers. Entries in `containers` win over imported services of the same name."
+    },
+    "containers": {
+      "type": ["object", "null"],
+      "description": "Container images to run, keyed by name. A container runs as a function unless `sidecar` is true; routes target it with `destination: container:<name>`. A sidecar runs next to every function instance and answers at `<name>:<port>`.",
+      "maxProperties": 16,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9_-]{0,62}$",
+        "not": {
+          "enum": ["localhost"]
+        }
+      },
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": false,
+        "oneOf": [
+          {
+            "required": ["image"]
+          },
+          {
+            "required": ["build"]
+          }
+        ],
+        "properties": {
+          "image": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512,
+            "pattern": "^[^\\s]+$",
+            "description": "Registry image reference, e.g. `redis:7-alpine` or `ghcr.io/acme/api:1.4`."
+          },
+          "build": {
+            "description": "Build context directory, or the full build settings, for a Dockerfile in the repository.",
+            "oneOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "context": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 1024
+                  },
+                  "dockerfile": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 1024
+                  },
+                  "target": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                  },
+                  "args": {
+                    "type": "object",
+                    "maxProperties": 100,
+                    "additionalProperties": {
+                      "type": "string",
+                      "maxLength": 65536
+                    }
+                  }
+                }
+              }
+            ]
+          },
+          "sidecar": {
+            "type": "boolean",
+            "description": "Run next to every function instance instead of serving routes. Defaults to false."
+          },
+          "port": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 65535,
+            "description": "TCP port the container listens on. Defaults to the first exposed port of the image, then 8080."
+          },
+          "entrypoint": {
+            "$ref": "#/$defs/stringOrStringArray",
+            "description": "Replaces the image ENTRYPOINT. A string is split into words the way Compose splits it."
+          },
+          "command": {
+            "$ref": "#/$defs/stringOrStringArray",
+            "description": "Replaces the image CMD. A string is split into words the way Compose splits it."
+          },
+          "env": {
+            "type": "object",
+            "maxProperties": 100,
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 65536
+            },
+            "description": "Environment variables baked into the container, merged over the image ENV."
+          },
+          "working_dir": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 1024,
+            "pattern": "^/",
+            "description": "Replaces the image WORKDIR. Must be absolute."
+          },
+          "user": {
+            "oneOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 256
+              },
+              {
+                "type": "integer",
+                "minimum": 0
+              }
+            ],
+            "description": "Replaces the image USER: a name, a uid, `name:group` or `uid:gid`. A bare uid may be a number."
+          },
+          "memory": {
+            "type": "integer",
+            "minimum": 128,
+            "maximum": 3009,
+            "description": "Memory in MB. Defaults to 512 for a container function and 256 for a sidecar."
+          },
+          "max_duration": {
+            "type": "number",
+            "minimum": 1,
+            "maximum": 28800,
+            "description": "Maximum lifetime in seconds of one request. Container functions only."
+          },
+          "streaming": {
+            "type": "boolean",
+            "description": "Stream responses. Defaults to true. Container functions only."
+          },
+          "schedule": {
+            "$ref": "#/$defs/schedule",
+            "description": "An expression to run the container function at specific times. Container functions only."
+          }
+        }
+      }
+    },
     "services": {
       "type": "object",
       "description": "Managed services to provision for the deployment environment.",
@@ -396,11 +546,179 @@
               }
             }
           }
+        },
+        "queues": {
+          "type": "object",
+          "description": "Queues to provision in the deployment environment, keyed by name. Use null for a pull queue with default settings. Queues you stop declaring are kept, with their messages.",
+          "propertyNames": {
+            "maxLength": 255,
+            "pattern": "^[A-Za-z0-9_][A-Za-z0-9_.~:@+=-]*$"
+          },
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "consumer": {
+                    "type": ["string", "null"],
+                    "pattern": "^/(?!/)\\S*$",
+                    "maxLength": 2048,
+                    "description": "Deployment-relative path that receives each message as a signed POST, for example /api/queues/emails. Omit it for a pull queue that you drain with receive."
+                  },
+                  "visibilityTimeout": {
+                    "$ref": "#/$defs/queueDuration",
+                    "description": "How long a push delivery may run, or how long a received message stays leased. Defaults to 60 seconds, at most 12 hours."
+                  },
+                  "retention": {
+                    "$ref": "#/$defs/queueDuration",
+                    "description": "How long an undelivered message is kept. Defaults to 4 days, at most 14 days."
+                  },
+                  "maxAttempts": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 100,
+                    "description": "Deliveries per message before it moves to the dead-letter list. Defaults to 10."
+                  },
+                  "retryBackoff": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "description": "Exponential backoff between failed deliveries. Defaults to 5 seconds, doubling up to 15 minutes.",
+                    "properties": {
+                      "min": {
+                        "$ref": "#/$defs/queueDuration"
+                      },
+                      "max": {
+                        "$ref": "#/$defs/queueDuration"
+                      }
+                    }
+                  },
+                  "deduplicationWindow": {
+                    "$ref": "#/$defs/queueDuration",
+                    "description": "How long a deduplication key is remembered. Defaults to 24 hours, at most 7 days."
+                  },
+                  "concurrency": {
+                    "type": ["integer", "null"],
+                    "minimum": 1,
+                    "maximum": 1000,
+                    "description": "Most push deliveries in flight at once. Defaults to 100."
+                  },
+                  "rateLimit": {
+                    "oneOf": [
+                      {
+                        "type": "null"
+                      },
+                      {
+                        "type": "object",
+                        "required": ["count"],
+                        "additionalProperties": false,
+                        "properties": {
+                          "count": {
+                            "type": "integer",
+                            "minimum": 1,
+                            "maximum": 1000000
+                          },
+                          "period": {
+                            "$ref": "#/$defs/queueDuration"
+                          }
+                        }
+                      }
+                    ],
+                    "description": "Most deliveries started per period. The period defaults to one second."
+                  },
+                  "deadLetter": {
+                    "type": "boolean",
+                    "description": "Keep messages that run out of attempts so you can inspect and redrive them. Defaults to true."
+                  },
+                  "schedules": {
+                    "type": "object",
+                    "description": "Cron schedules that send a message into this queue, keyed by schedule name.",
+                    "propertyNames": {
+                      "maxLength": 128,
+                      "pattern": "^[A-Za-z0-9_][A-Za-z0-9_.-]*$"
+                    },
+                    "additionalProperties": {
+                      "type": "object",
+                      "required": ["cron"],
+                      "additionalProperties": false,
+                      "properties": {
+                        "cron": {
+                          "type": "string",
+                          "minLength": 1,
+                          "maxLength": 255,
+                          "description": "Five-field cron expression, or a macro such as @hourly or @daily."
+                        },
+                        "timezone": {
+                          "type": "string",
+                          "description": "IANA time zone the expression is evaluated in. Defaults to UTC."
+                        },
+                        "body": {
+                          "description": "Message body. Strings are sent as is; any other value is sent as JSON."
+                        },
+                        "contentType": {
+                          "type": "string",
+                          "description": "Content type of the body. Defaults to text/plain for a string body and application/json otherwise."
+                        },
+                        "headers": {
+                          "type": "object",
+                          "additionalProperties": {
+                            "type": "string"
+                          },
+                          "description": "Headers delivered with every message from this schedule."
+                        },
+                        "enabled": {
+                          "type": "boolean",
+                          "description": "Set to false to keep the schedule without sending. Defaults to true."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            ]
+          }
         }
       }
     }
   },
   "$defs": {
+    "schedule": {
+      "type": "string",
+      "pattern": "^(?:rate[(](?:(?:1[ ]+(hour|minute|day))|(?:[0-9]+[ ]+(hours|minutes|days)))[)])|(?:cron[(](?:(?:(?:[0-5]?[0-9])|[*])(?:(?:[-](?:(?:[0-5]?[0-9])|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[0-5]?[0-9])|[*])(?:(?:[-](?:(?:[0-5]?[0-9])|[*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[0-2]?[0-9])|[*])(?:(?:[-](?:(?:[0-2]?[0-9])|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[0-2]?[0-9])|[*])(?:(?:[-](?:(?:[0-2]?[0-9])|[*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:[?][ ]+(?:(?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?(?:[,](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))[#][0-5])|(?:(?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*])(?:(?:[-](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*]))|(?:[/][0-9]+))?(?:[,](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*])(?:(?:[-](?:(?:(?:[1-7]|(?:SUN|MON|TUE|WED|THU|FRI|SAT))L?)|[L*]))|(?:[/][0-9]+))?)*)))|(?:(?:(?:(?:(?:[1-3]?[0-9])W?)|LW|[L*])(?:(?:[-](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*]))|(?:[/][0-9]+))?(?:[,](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*])(?:(?:[-](?:(?:(?:[1-3]?[0-9])W?)|LW|[L*]))|(?:[/][0-9]+))?)*)[ ]+(?:(?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?(?:[,](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:(?:[-](?:(?:[1]?[0-9])|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)|[*])(?:[/][0-9]+)?)|(?:[/][0-9]+))?)*)[ ]+[?]))[ ]+(?:(?:(?:[12][0-9]{3})|[*])(?:(?:[-](?:(?:[12][0-9]{3})|[*]))|(?:[/][0-9]+))?(?:[,](?:(?:[12][0-9]{3})|[*])(?:(?:[-](?:(?:[12][0-9]{3})|[*]))|(?:[/][0-9]+))?)*)[)])$"
+    },
+    "stringOrStringArray": {
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        },
+        {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "type": "string",
+            "maxLength": 4096
+          }
+        }
+      ]
+    },
+    "queueDuration": {
+      "oneOf": [
+        {
+          "type": "integer",
+          "minimum": 0
+        },
+        {
+          "type": "string",
+          "pattern": "^[0-9]+(\\.[0-9]+)?(s|m|h|d)$"
+        }
+      ],
+      "description": "A duration in seconds, or a string such as 30s, 10m, 1.5h or 4d."
+    },
     "runtimes": {
       "type": "string",
       "enum": ["php-84", "php-83", "php-81", "node-22", "node-20", "node-18", "node-16", "bun-1"]