@shortlink-org/portolan 0.1.0 → 0.2.0

package/portolan.json

@@ -95,23 +95,20 @@
   "plugins": [
     {
       "name": "project",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-project"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "commands",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-commands"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "go-domain",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-go"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
@@ -158,152 +155,134 @@
     },
     {
       "name": "openapi",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-openapi"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "wsdl",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-wsdl"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "http-clients",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-http-clients"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "redis",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-redis"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "river",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-river"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "watermill",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-watermill"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "go-nats",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-go-nats"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "asyncapi",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-asyncapi"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "graphql",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-graphql"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "sql",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-sql"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "markdown",
       "wasm": {
-        "url": "file://plugins/gen-markdown.wasm"
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "mermaid",
       "wasm": {
-        "url": "file://plugins/gen-mermaid.wasm"
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "backstage",
       "wasm": {
-        "url": "file://plugins/gen-backstage.wasm"
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "otel",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/verify-otel"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "codeowners",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/verify-codeowners"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "adr",
-      "process": {
-        "command": "go",
-        "args": [
-          "run",
-          "./plugins/extract-adr"
-        ]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "glossary",
-      "process": {
-        "command": "go",
-        "args": [
-          "run",
-          "./plugins/extract-glossary"
-        ]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "flows",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-flows"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "bsr",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/fetch-bsr"]
-      }
+      "host": "fetch-bsr"
     },
     {
       "name": "git",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/fetch-git"]
+      "host": "fetch-git"
+    },
+    {
+      "name": "csr",
+      "host": "fetch-csr"
+    },
+    {
+      "name": "csr-schemas",
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     },
     {
       "name": "proto",
-      "process": {
-        "command": "go",
-        "args": ["run", "./plugins/extract-proto"]
+      "wasm": {
+        "url": "file://plugins/portolan-go.wasm"
       }
     }
   ],

package/schema/portolan.schema.json

@@ -88,6 +88,8 @@
               "flows",
               "bsr",
               "git",
+              "csr",
+              "csr-schemas",
               "proto"
             ],
             "description": "A plugin declared above, one that belongs in this phase."
@@ -562,6 +564,44 @@
               }
             }
           },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "csr"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.csr"
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "required": [
+                "plugin"
+              ],
+              "properties": {
+                "plugin": {
+                  "const": "csr-schemas"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "options": {
+                  "$ref": "#/$defs/options.csr-schemas"
+                }
+              }
+            }
+          },
           {
             "if": {
               "required": [
@@ -895,6 +935,11 @@
           "required": [
             "process"
           ]
+        },
+        {
+          "required": [
+            "host"
+          ]
         }
       ],
       "properties": {
@@ -902,6 +947,14 @@
           "type": "string",
           "description": "What the steps below call this plugin. It need not be the plugin's own name."
         },
+        "host": {
+          "enum": [
+            "fetch-git",
+            "fetch-bsr",
+            "fetch-csr"
+          ],
+          "description": "A plugin the host runs inside its own process, because it needs a socket or a git binary (portolan.0008). Only the ones shipped with Portolan can be named."
+        },
         "wasm": {
           "type": "object",
           "additionalProperties": false,
@@ -2407,6 +2460,10 @@
             }
           }
         },
+        "registry": {
+          "type": "string",
+          "description": "Overrides the registry in every module name, for a self-hosted BSR: a host, or a URL when it is not https."
+        },
         "cache": {
           "type": "string",
           "description": "Where the last run's files were written, repo-relative: the same path as the step's out. An offline run replays what is there and checks it against the lock beside it."
@@ -2469,6 +2526,129 @@
         }
       }
     },
+    "options.csr": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registry",
+        "subjects",
+        "cache"
+      ],
+      "properties": {
+        "registry": {
+          "type": "string",
+          "description": "Base URL of the schema registry. The credential for it is never written here: it comes from the environment, so this file stays committable.",
+          "examples": [
+            "http://localhost:8081",
+            "https://psrc-00000.eu-central-1.aws.confluent.cloud"
+          ]
+        },
+        "subjects": {
+          "type": "array",
+          "minItems": 1,
+          "description": "The subjects to fetch, each pinned to a version. A subject a fetched schema references is fetched too, pinned by the reference itself, and needs no entry here.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "subject"
+            ],
+            "properties": {
+              "subject": {
+                "type": "string",
+                "description": "The registry's own name for the registration: \"<topic>-value\" under TopicNameStrategy, the record's full name under RecordNameStrategy.",
+                "examples": [
+                  "shop.oms.order-value",
+                  "shop.oms.OrderPlaced"
+                ]
+              },
+              "version": {
+                "type": "integer",
+                "minimum": 1,
+                "description": "The version to fetch. A registered version is immutable, so a pinned fetch is byte-reproducible, which is what lets an offline run replay it from the tree. Left out, `latest` is resolved online and warned about, and refused offline."
+              }
+            }
+          }
+        },
+        "cache": {
+          "type": "string",
+          "description": "Where the last run's files were written, repo-relative: the same path as the step's out. An offline run replays what is there and checks it against the lock beside it.",
+          "examples": [
+            "examples/shop/oms/vendor/schemas"
+          ]
+        }
+      }
+    },
+    "options.csr-schemas": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "context": {
+          "type": "string",
+          "description": "Slug of the bounded context that owns the service these schemas belong to. Defaults to the name of the input directory.",
+          "examples": [
+            "shop"
+          ]
+        },
+        "service": {
+          "type": "string",
+          "description": "Slug of the service that registers them. Defaults to the name of the input directory.",
+          "examples": [
+            "oms"
+          ]
+        },
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Directories fetch-csr vendored into, relative to the input root. Left out, the whole root is walked for locks.",
+          "examples": [
+            [
+              "vendor/schemas"
+            ]
+          ]
+        },
+        "strategy": {
+          "enum": [
+            "topic",
+            "record",
+            "topic-record"
+          ],
+          "default": "topic",
+          "description": "How a subject name relates to a topic and a record - the producer's SubjectNameStrategy. Nothing in the registry's answer says which one was used, so it is told here. `topic` reads \"<topic>-value\" and \"<topic>-key\"; `record` reads the whole subject as the record's full name and yields no topic; `topic-record` reads \"<topic>-<record full name>\"."
+        },
+        "direction": {
+          "enum": [
+            "send",
+            "receive"
+          ],
+          "default": "send",
+          "description": "Which way these channels travel, from this service's side. A registry records no producer and no consumer, so this cannot be read and has to be told."
+        },
+        "subjects": {
+          "type": "object",
+          "additionalProperties": {
+            "enum": [
+              "send",
+              "receive"
+            ]
+          },
+          "description": "Direction per subject, for a service that both publishes and listens. Overrides `direction`.",
+          "examples": [
+            {
+              "shop.oms.order-value": "send",
+              "payments.ledger.payment-value": "receive"
+            }
+          ]
+        },
+        "out": {
+          "type": "string",
+          "description": "Name of the fragment file, inside the step's output directory.",
+          "default": "schemas.json"
+        }
+      }
+    },
     "options.proto": {
       "type": "object",
       "additionalProperties": false,

package/scripts/builtin-plugins.mjs

@@ -25,6 +25,16 @@ export function builtinPluginNames() {
   return new Set(shippedDefinitions().keys());
 }
 
+/**
+ * The definition as portolan.json declares it - `wasm`, or the `process`
+ * with the real command - rather than the adapter `builtinPlugin` runs it
+ * through. What `init` and `doctor` read to know which toolchain a plugin
+ * asks for.
+ */
+export function builtinDefinition(name) {
+  return shippedDefinitions().get(name) ?? null;
+}
+
 /** Return a runnable built-in definition, or null when the package has none. */
 export function builtinPlugin(name) {
   const declared = shippedDefinitions().get(name);
@@ -38,6 +48,10 @@ export function builtinPlugin(name) {
     return { ...declared, builtin: true, wasm: { ...declared.wasm, url } };
   }
 
+  // A plugin the host runs in its own process (portolan.0008): one that
+  // needs a socket or a git binary, which the host holds and no module gets.
+  if (declared.host) return { ...declared, builtin: true };
+
   return {
     name,
     builtin: true,