@theaiplatform/miniapp-sdk 0.0.0 → 0.0.2

package/config-schema.json

@@ -132,18 +132,15 @@
       "type": "string"
     },
     "ContributionTarget": {
-      "additionalProperties": false,
-      "description": "A target-specific expose selected for a contribution.",
-      "properties": {
-        "expose": {
-          "type": "string"
+      "anyOf": [
+        {
+          "$ref": "#/$defs/ModuleContributionTarget"
         },
-        "runtime": {
-          "$ref": "#/$defs/ExecutionRuntime"
+        {
+          "$ref": "#/$defs/HostDeclarativeContributionTarget"
         }
-      },
-      "required": ["expose", "runtime"],
-      "type": "object"
+      ],
+      "description": "A target-specific execution binding selected for a contribution.\n\nExecutable package modules select one immutable Federation expose. Host-\ndeclarative contributions are materialized by TAP and therefore select the\nhost runtime without inventing a module expose."
     },
     "DeclarativeOptions": {
       "additionalProperties": false,
@@ -183,14 +180,7 @@
       "type": "object"
     },
     "ExecutionRuntime": {
-      "enum": [
-        "webview",
-        "quickjs",
-        "worker",
-        "node",
-        "workflow-host",
-        "host-declarative"
-      ],
+      "enum": ["webview", "quickjs", "worker", "node", "workflow-host"],
       "type": "string"
     },
     "FallbackFormat": {
@@ -263,6 +253,22 @@
       ],
       "type": "object"
     },
+    "HostDeclarativeContributionTarget": {
+      "additionalProperties": false,
+      "description": "A contribution whose declarative configuration TAP materializes directly.",
+      "properties": {
+        "runtime": {
+          "$ref": "#/$defs/HostDeclarativeRuntime"
+        }
+      },
+      "required": ["runtime"],
+      "type": "object"
+    },
+    "HostDeclarativeRuntime": {
+      "description": "The only runtime accepted by an expose-free contribution target binding.",
+      "enum": ["host-declarative"],
+      "type": "string"
+    },
     "InstancePolicy": {
       "enum": [
         "per-mount",
@@ -290,20 +296,251 @@
       "enum": ["installation", "realm", "contribution", "mount"],
       "type": "string"
     },
-    "McpOptions": {
+    "McpAppOptions": {
+      "additionalProperties": false,
+      "description": "One sandboxed MCP App bound to exact tool and UI resource contributions.",
+      "properties": {
+        "protocolVersion": {
+          "type": "string"
+        },
+        "resourceContributionId": {
+          "type": "string"
+        },
+        "serverContributionId": {
+          "type": "string"
+        },
+        "toolContributionId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "serverContributionId",
+        "toolContributionId",
+        "resourceContributionId",
+        "protocolVersion"
+      ],
+      "type": "object"
+    },
+    "McpConsumerPolicy": {
+      "additionalProperties": false,
+      "description": "Publisher-declared upper bound on who may consume an MCP server.\n\nBoth lists default empty. Installation policy may select or remove entries,\nbut cannot authorize consumers outside this signed maximum.",
+      "properties": {
+        "contributionIds": {
+          "description": "Exact same-package contribution identities eligible to receive access.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "externalConsumers": {
+          "description": "External platform consumer classes eligible for narrower host grants.",
+          "items": {
+            "$ref": "#/$defs/McpExternalConsumerClass"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "McpExternalConsumerClass": {
+      "description": "Closed external consumer classes a publisher may include in its maximum.",
+      "enum": [
+        "selected-miniapps",
+        "selected-specialists",
+        "chat",
+        "workflows",
+        "platform"
+      ],
+      "type": "string"
+    },
+    "McpHttpCredentialRequirement": {
+      "additionalProperties": false,
+      "description": "One host-held credential injected into a declared Streamable HTTP header.\n\nDescriptors name requirements and destinations only. Credential values are\nresolved from host-owned secret storage after installation consent.",
+      "properties": {
+        "header": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        }
+      },
+      "required": ["id", "header"],
+      "type": "object"
+    },
+    "McpPromptOptions": {
+      "additionalProperties": false,
+      "description": "One MCP prompt promoted from its owning server's live catalog.",
+      "properties": {
+        "promptName": {
+          "type": "string"
+        },
+        "serverContributionId": {
+          "type": "string"
+        }
+      },
+      "required": ["serverContributionId", "promptName"],
+      "type": "object"
+    },
+    "McpResourceOptions": {
+      "additionalProperties": false,
+      "description": "One exact MCP resource promoted from its owning server's live catalog.",
+      "properties": {
+        "mimeType": {
+          "type": ["string", "null"]
+        },
+        "serverContributionId": {
+          "type": "string"
+        },
+        "uri": {
+          "type": "string"
+        }
+      },
+      "required": ["serverContributionId", "uri"],
+      "type": "object"
+    },
+    "McpResourceTemplateOptions": {
       "additionalProperties": false,
+      "description": "One MCP resource template promoted from its owning server's live catalog.",
       "properties": {
+        "mimeType": {
+          "type": ["string", "null"]
+        },
+        "serverContributionId": {
+          "type": "string"
+        },
+        "uriTemplate": {
+          "type": "string"
+        }
+      },
+      "required": ["serverContributionId", "uriTemplate"],
+      "type": "object"
+    },
+    "McpServerImplementation": {
+      "description": "Mutually exclusive ways TAP can activate a declared MCP server.",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "description": "Load the server adapter from the contribution's verified Federation expose.",
+          "properties": {
+            "type": {
+              "const": "package-runtime",
+              "type": "string"
+            }
+          },
+          "required": ["type"],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "description": "Spawn a reviewed local process and communicate over stdio.",
+          "properties": {
+            "args": {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "command": {
+              "type": "string"
+            },
+            "credentialRequirements": {
+              "items": {
+                "$ref": "#/$defs/McpStdioCredentialRequirement"
+              },
+              "type": "array"
+            },
+            "type": {
+              "const": "stdio",
+              "type": "string"
+            }
+          },
+          "required": ["type", "command"],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "description": "Connect to an HTTPS MCP endpoint using Streamable HTTP.",
+          "properties": {
+            "credentialRequirements": {
+              "items": {
+                "$ref": "#/$defs/McpHttpCredentialRequirement"
+              },
+              "type": "array"
+            },
+            "type": {
+              "const": "streamable-http",
+              "type": "string"
+            },
+            "url": {
+              "type": "string"
+            }
+          },
+          "required": ["type", "url"],
+          "type": "object"
+        }
+      ]
+    },
+    "McpServerOptions": {
+      "additionalProperties": false,
+      "description": "One package-declared MCP server and its maximum consumer audience.",
+      "properties": {
+        "consumerPolicy": {
+          "$ref": "#/$defs/McpConsumerPolicy",
+          "default": {}
+        },
+        "implementation": {
+          "$ref": "#/$defs/McpServerImplementation"
+        },
         "protocolVersion": {
           "type": "string"
+        }
+      },
+      "required": ["protocolVersion", "implementation"],
+      "type": "object"
+    },
+    "McpStdioCredentialRequirement": {
+      "additionalProperties": false,
+      "description": "One host-held credential injected into a declared stdio environment slot.\n\nDescriptors name requirements and destinations only. Credential values are\nresolved from host-owned secret storage after installation consent.",
+      "properties": {
+        "environmentVariable": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        }
+      },
+      "required": ["id", "environmentVariable"],
+      "type": "object"
+    },
+    "McpToolOptions": {
+      "additionalProperties": false,
+      "description": "One MCP tool promoted from its owning server's live catalog.",
+      "properties": {
+        "effects": {
+          "items": {
+            "$ref": "#/$defs/RuntimeEffect"
+          },
+          "type": "array"
         },
-        "resourceUri": {
+        "inputSchema": {
           "type": ["string", "null"]
         },
-        "transport": {
+        "outputSchema": {
           "type": ["string", "null"]
+        },
+        "serverContributionId": {
+          "type": "string"
+        },
+        "timeoutMs": {
+          "format": "uint64",
+          "minimum": 0,
+          "type": ["integer", "null"]
+        },
+        "toolName": {
+          "type": "string"
         }
       },
-      "required": ["protocolVersion"],
+      "required": ["serverContributionId", "toolName"],
       "type": "object"
     },
     "MiniAppBundleManifest": {
@@ -347,6 +584,22 @@
       "title": "Tap Miniapp Bundle Manifest",
       "type": "object"
     },
+    "MiniAppCategory": {
+      "description": "Closed Marketplace discovery taxonomy for descriptor-backed miniapps.",
+      "enum": [
+        "productivity",
+        "developer-tools",
+        "creativity",
+        "communication",
+        "data-and-analytics",
+        "business",
+        "education",
+        "media-and-entertainment",
+        "utilities",
+        "other"
+      ],
+      "type": "string"
+    },
     "MiniAppReferencesManifest": {
       "additionalProperties": false,
       "description": "Manifest that references built TAP miniapp manifests.",
@@ -433,6 +686,20 @@
         }
       ]
     },
+    "ModuleContributionTarget": {
+      "additionalProperties": false,
+      "description": "A contribution implemented by one module in the locked Federation graph.",
+      "properties": {
+        "expose": {
+          "type": "string"
+        },
+        "runtime": {
+          "$ref": "#/$defs/ExecutionRuntime"
+        }
+      },
+      "required": ["expose", "runtime"],
+      "type": "object"
+    },
     "PackageCompatibility": {
       "additionalProperties": false,
       "description": "Host and SDK compatibility checked before remote loading.",
@@ -1360,7 +1627,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/ExecutableOptions"
+              "$ref": "#/$defs/WorkflowOptions"
             },
             "publishes": {
               "items": {
@@ -1428,7 +1695,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/ExecutableOptions"
+              "$ref": "#/$defs/WorkflowNodeOptions"
             },
             "publishes": {
               "items": {
@@ -1564,7 +1831,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpServerOptions"
             },
             "publishes": {
               "items": {
@@ -1632,7 +1899,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpToolOptions"
             },
             "publishes": {
               "items": {
@@ -1700,7 +1967,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpPromptOptions"
             },
             "publishes": {
               "items": {
@@ -1768,7 +2035,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpResourceOptions"
             },
             "publishes": {
               "items": {
@@ -1836,7 +2103,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpResourceTemplateOptions"
             },
             "publishes": {
               "items": {
@@ -1904,7 +2171,7 @@
               "default": "mount"
             },
             "options": {
-              "$ref": "#/$defs/McpOptions"
+              "$ref": "#/$defs/McpAppOptions"
             },
             "publishes": {
               "items": {
@@ -2796,6 +3063,15 @@
           },
           "type": "array"
         },
+        "categories": {
+          "description": "Ordered Marketplace discovery categories. Existing private/manual\npackages may omit categories; published listings validate their own\ndiscovery requirements before accepting a release.",
+          "items": {
+            "$ref": "#/$defs/MiniAppCategory"
+          },
+          "maxItems": 3,
+          "type": "array",
+          "uniqueItems": true
+        },
         "description": {
           "type": "string"
         },
@@ -3169,6 +3445,243 @@
       },
       "required": ["placement", "scope"],
       "type": "object"
+    },
+    "WorkflowCancellationPolicy": {
+      "description": "Cancellation behavior supported by package-provided workflows.",
+      "enum": ["host-managed"],
+      "type": "string"
+    },
+    "WorkflowCheckpointPolicy": {
+      "description": "Checkpoint behavior supported by the package-contribution ABI.",
+      "enum": ["none"],
+      "type": "string"
+    },
+    "WorkflowExecutionSemantics": {
+      "additionalProperties": false,
+      "description": "Fixed v1 execution semantics for one immutable package workflow.",
+      "properties": {
+        "cancellation": {
+          "$ref": "#/$defs/WorkflowCancellationPolicy"
+        },
+        "checkpoint": {
+          "$ref": "#/$defs/WorkflowCheckpointPolicy"
+        },
+        "retry": {
+          "$ref": "#/$defs/WorkflowRetryPolicy"
+        },
+        "rollback": {
+          "$ref": "#/$defs/WorkflowRollbackPolicy"
+        },
+        "upgrade": {
+          "$ref": "#/$defs/WorkflowUpgradePolicy"
+        }
+      },
+      "required": [
+        "retry",
+        "cancellation",
+        "checkpoint",
+        "upgrade",
+        "rollback"
+      ],
+      "type": "object"
+    },
+    "WorkflowHostPort": {
+      "description": "Narrow host port a package-provided workflow node may request.",
+      "enum": ["fs", "proc", "http", "clock", "crypto", "store", "source"],
+      "type": "string"
+    },
+    "WorkflowNodeCancellationPolicy": {
+      "description": "Cancellation behavior supported by one package-provided node attempt.",
+      "enum": ["not-supported"],
+      "type": "string"
+    },
+    "WorkflowNodeEffect": {
+      "description": "Side-effect classification for a package-provided workflow node.",
+      "enum": ["pure", "read", "write", "exec"],
+      "type": "string"
+    },
+    "WorkflowNodeExecutionSemantics": {
+      "additionalProperties": false,
+      "description": "Fixed v1 execution semantics for one package-provided workflow node.",
+      "properties": {
+        "cancellation": {
+          "$ref": "#/$defs/WorkflowNodeCancellationPolicy"
+        },
+        "checkpoint": {
+          "$ref": "#/$defs/WorkflowCheckpointPolicy"
+        },
+        "idempotency": {
+          "$ref": "#/$defs/WorkflowNodeIdempotency"
+        },
+        "maxAttempts": {
+          "format": "uint8",
+          "maximum": 1,
+          "minimum": 1,
+          "type": "integer"
+        },
+        "rollback": {
+          "$ref": "#/$defs/WorkflowRollbackPolicy"
+        },
+        "upgrade": {
+          "$ref": "#/$defs/WorkflowUpgradePolicy"
+        }
+      },
+      "required": [
+        "maxAttempts",
+        "idempotency",
+        "cancellation",
+        "checkpoint",
+        "upgrade",
+        "rollback"
+      ],
+      "type": "object"
+    },
+    "WorkflowNodeIdempotency": {
+      "description": "Idempotency claim for the one attempt allowed by the v1 node ABI.",
+      "enum": ["idempotent", "non-idempotent"],
+      "type": "string"
+    },
+    "WorkflowNodeOptions": {
+      "additionalProperties": false,
+      "description": "Exact descriptor options for a canonical `ze-workflows` contributed node.",
+      "properties": {
+        "config": {
+          "$ref": "#/$defs/WorkflowSchemaReference"
+        },
+        "effect": {
+          "$ref": "#/$defs/WorkflowNodeEffect"
+        },
+        "execution": {
+          "$ref": "#/$defs/WorkflowNodeExecutionSemantics"
+        },
+        "exportName": {
+          "type": "string"
+        },
+        "inputs": {
+          "items": {
+            "$ref": "#/$defs/WorkflowPort"
+          },
+          "type": "array"
+        },
+        "nodeKind": {
+          "type": "string"
+        },
+        "outcomes": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "outputs": {
+          "items": {
+            "$ref": "#/$defs/WorkflowPort"
+          },
+          "type": "array"
+        },
+        "requires": {
+          "items": {
+            "$ref": "#/$defs/WorkflowHostPort"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "nodeKind",
+        "exportName",
+        "config",
+        "inputs",
+        "outputs",
+        "outcomes",
+        "effect",
+        "requires",
+        "execution"
+      ],
+      "type": "object"
+    },
+    "WorkflowOptions": {
+      "additionalProperties": false,
+      "description": "Exact descriptor options for a canonical `ze-workflows` workflow.\n\nThe module expose and runtime remain in [`ContributionBase::targets`]; the\npackage host combines that verified target with these inert declarations to\nbuild the release-scoped `ze-workflows` catalog.",
+      "properties": {
+        "exportName": {
+          "type": "string"
+        },
+        "inputs": {
+          "items": {
+            "$ref": "#/$defs/WorkflowPort"
+          },
+          "type": "array"
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/WorkflowExecutionSemantics"
+        },
+        "manifest": {
+          "$ref": "#/$defs/WorkflowSchemaReference"
+        },
+        "outputs": {
+          "items": {
+            "$ref": "#/$defs/WorkflowPort"
+          },
+          "type": "array"
+        },
+        "workflowId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "workflowId",
+        "exportName",
+        "manifest",
+        "inputs",
+        "outputs",
+        "lifecycle"
+      ],
+      "type": "object"
+    },
+    "WorkflowPort": {
+      "additionalProperties": false,
+      "description": "One named, schema-bound workflow input or output port.",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "schema": {
+          "$ref": "#/$defs/WorkflowSchemaReference"
+        }
+      },
+      "required": ["name", "schema", "required"],
+      "type": "object"
+    },
+    "WorkflowRetryPolicy": {
+      "description": "Retry behavior supported by package-provided workflow definitions.",
+      "enum": ["none"],
+      "type": "string"
+    },
+    "WorkflowRollbackPolicy": {
+      "description": "Rollback ownership for package-provided workflows and nodes.",
+      "enum": ["host-managed"],
+      "type": "string"
+    },
+    "WorkflowSchemaReference": {
+      "additionalProperties": false,
+      "description": "Exact schema identity admitted by the canonical `ze-workflows` package ABI.\n\n`id` is the release-relative schema asset path and `integrity` is the SRI of\nthe canonical JSON document. The target's [`PackageAssetLockV1`] separately\nbinds the raw file bytes; the package host verifies both identities before\nit evaluates the workflow-host export.",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "integrity": {
+          "type": "string"
+        }
+      },
+      "required": ["id", "integrity"],
+      "type": "object"
+    },
+    "WorkflowUpgradePolicy": {
+      "description": "Upgrade behavior supported by immutable package workflow definitions.",
+      "enum": ["restart"],
+      "type": "string"
     }
   },
   "$id": "https://tap.local/schemas/manifest.tap.schema.json",