@metapages/metapage 1.9.0 → 1.9.2

package/README.md

@@ -137,6 +137,40 @@ A metapage is defined using JSON that specifies which metaframes to load and how
 
 This creates a pipeline: `input` → `processor` → `output`
 
+### Metaframe Definition
+
+See [code](https://github.com/metapages/metapage/blob/73549f9f3e27da7a2aef5a935ec112c5bdb130db/app/libs/src/metapage/v2/metaframe.ts#L40)
+
+This is provided either by:
+
+- `https://<your metaframe>/metaframe.json`
+- `https://<your metaframe>/#?definition=<json encoded hash param>`
+
+The definition describes inputs, outputs, security, and the types of hash parameters (so AI tools can correctly modify)
+
+```typescript
+export interface MetaframeDefinitionV2 {
+  version: VersionsMetaframe;
+  inputs?: {
+    [key: string]: MetaframePipeDefinition;
+  }; // <MetaframePipeId, MetaframePipeDefinition>
+  outputs?: {
+    [key: string]: MetaframePipeDefinition;
+  }; // <MetaframePipeId, MetaframePipeDefinition>
+  metadata: MetaframeMetadataV2;
+  // https://developer.mozilla.org/en-US/docs/Web/HTTP/Feature_Policy/Using_Feature_Policy#the_iframe_allow_attribute
+  // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy#directives
+  allow?: string;
+  // Set or override allowed features for the iframe
+  // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#sandbox
+  sandbox?: string;
+  // Hash parameters configuration.
+  // Accepts both legacy array format (string[]) and new object format (HashParamsObject).
+  // When fetched via helper methods, array format is normalized to object format.
+  hashParams?: HashParamsRaw;
+}
+```
+
 ### Data Pipes
 
 Pipes connect metaframe outputs to other metaframe inputs:

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./metapage/Constants";
+export * from "./metapage/conversions-metapage";
+export * from "./metapage/conversions-metaframe";
+export * from "./metapage/data";
+export * from "./metapage/events";
+export * from "./metapage/jsonrpc";
+export * from "./metapage/jsonrpc2";
+export * from "./metapage/Metaframe";
+export * from "./metapage/Metapage";
+export * from "./metapage/MetapageIFrameRpcClient";
+export * from "./metapage/MetapageTools";
+export * from "./metapage/Shared";
+export * from "./metapage/core";
+export * from "./metapage/v0_4";
+export * from "./metapage/v1";
+export * from "./metapage/v2";
+export * from "./metapage/versions";
+export * from "./metapage/util";
+export * from "./metapage/metapageRenderer";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oCAAoC,CAAC;AACnD,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC"}