`ecosystem.procedures`

List all procedures across the ecosystem

CLI

Package: @procedures/lib · README
Path: ["ecosystem","procedures"]
CLI: mark ecosystem procedures
As data: {"$proc":["ecosystem","procedures"],"input":{}}

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/lib"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["ecosystem","procedures"], {});
console.log(JSON.stringify(result));

From the command line

$ mark ecosystem procedures

As data, in a program

{ "$proc": ["ecosystem", "procedures"], "input": {} }

Input

Field	Type	Required	Default	Description
`rootPath`	`string`	no		Workspace root (defaults to the pnpm workspace that contains client-lib)
`namespace`	`string`	no		Filter by namespace prefix
`includeMetadata`	`boolean`	no	`false`	Include full metadata

Output

Field	Type	Required	Description
`procedures`	`object[]`	yes	Every procedure of the workspace packages
`byPackage`	`object[]`	yes	The procedures of each package
`byNamespace`	`object`	yes	The procedures of each namespace
`summary`	`object`	yes	The counts

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "rootPath": {
        "description": "Workspace root (defaults to the pnpm workspace that contains client-lib)",
        "type": "string"
      },
      "namespace": {
        "description": "Filter by namespace prefix",
        "type": "string"
      },
      "includeMetadata": {
        "default": false,
        "description": "Include full metadata",
        "type": "boolean"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "procedures": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "path": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The procedure path"
            },
            "key": {
              "type": "string",
              "description": "The dotted key of the path"
            },
            "package": {
              "type": "string",
              "description": "The package that registers the procedure"
            },
            "packagePath": {
              "type": "string",
              "description": "The folder of the package"
            },
            "description": {
              "description": "The description of the procedure",
              "type": "string"
            },
            "tags": {
              "description": "The tags of the procedure",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "path",
            "key",
            "package",
            "packagePath"
          ],
          "additionalProperties": {}
        },
        "description": "Every procedure of the workspace packages"
      },
      "byPackage": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The package name"
            },
            "path": {
              "type": "string",
              "description": "The package folder"
            },
            "procedures": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "The procedure path"
                  },
                  "key": {
                    "type": "string",
                    "description": "The dotted key of the path"
                  },
                  "package": {
                    "type": "string",
                    "description": "The package that registers the procedure"
                  },
                  "packagePath": {
                    "type": "string",
                    "description": "The folder of the package"
                  },
                  "description": {
                    "description": "The description of the procedure",
                    "type": "string"
                  },
                  "tags": {
                    "description": "The tags of the procedure",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "path",
                  "key",
                  "package",
                  "packagePath"
                ],
                "additionalProperties": {}
              },
              "description": "The procedures of the package"
            },
            "success": {
              "type": "boolean",
              "description": "False when the package did not load"
            },
            "error": {
              "description": "Why the package did not load",
              "type": "string"
            }
          },
          "required": [
            "name",
            "path",
            "procedures",
            "success"
          ],
          "additionalProperties": {}
        },
        "description": "The procedures of each package"
      },
      "byNamespace": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "The procedure path"
              },
              "key": {
                "type": "string",
                "description": "The dotted key of the path"
              },
              "package": {
                "type": "string",
                "description": "The package that registers the procedure"
              },
              "packagePath": {
                "type": "string",
                "description": "The folder of the package"
              },
              "description": {
                "description": "The description of the procedure",
                "type": "string"
              },
              "tags": {
                "description": "The tags of the procedure",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "path",
              "key",
              "package",
              "packagePath"
            ],
            "additionalProperties": {}
          }
        },
        "description": "The procedures of each namespace"
      },
      "summary": {
        "type": "object",
        "properties": {
          "totalPackages": {
            "type": "number",
            "description": "The number of packages that were examined"
          },
          "packagesWithProcedures": {
            "type": "number",
            "description": "The number of packages that have procedures"
          },
          "totalProcedures": {
            "type": "number",
            "description": "The number of procedures"
          },
          "namespaces": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The namespaces (first path segments)"
          }
        },
        "required": [
          "totalPackages",
          "packagesWithProcedures",
          "totalProcedures",
          "namespaces"
        ],
        "additionalProperties": {},
        "description": "The counts"
      }
    },
    "required": [
      "procedures",
      "byPackage",
      "byNamespace",
      "summary"
    ],
    "additionalProperties": {}
  }
}