@metapages/metapage 1.8.25 → 1.8.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -12
- package/dist/index.js +859 -841
- package/dist/index.js.map +1 -1
- package/dist/metapage/Constants.d.ts.map +1 -1
- package/dist/metapage/Metaframe.d.ts +8 -8
- package/dist/metapage/Metaframe.d.ts.map +1 -1
- package/dist/metapage/Metapage.d.ts +5 -5
- package/dist/metapage/Metapage.d.ts.map +1 -1
- package/dist/metapage/MetapageIFrameRpcClient.d.ts +8 -8
- package/dist/metapage/MetapageIFrameRpcClient.d.ts.map +1 -1
- package/dist/metapage/MetapageTools.d.ts +4 -4
- package/dist/metapage/MetapageTools.d.ts.map +1 -1
- package/dist/metapage/Shared.d.ts +4 -4
- package/dist/metapage/core.d.ts +2 -1
- package/dist/metapage/core.d.ts.map +1 -1
- package/dist/metapage/data.d.ts.map +1 -1
- package/dist/metapage/errors/MissingMetaframeJson.d.ts.map +1 -1
- package/dist/metapage/errors/RootMetapageError.d.ts.map +1 -1
- package/dist/metapage/jsonrpc.d.ts +4 -4
- package/dist/metapage/jsonrpc.d.ts.map +1 -1
- package/dist/metapage/metapageRenderer.d.ts +16 -2
- package/dist/metapage/metapageRenderer.d.ts.map +1 -1
- package/dist/metapage/v0_1_0/all.d.ts +1 -1
- package/dist/metapage/v0_1_0/all.d.ts.map +1 -1
- package/dist/metapage/v0_2/all.d.ts +1 -1
- package/dist/metapage/v0_2/all.d.ts.map +1 -1
- package/dist/metapage/v0_3/JsonRpcMethods.d.ts +3 -3
- package/dist/metapage/v0_3/JsonRpcMethods.d.ts.map +1 -1
- package/dist/metapage/v0_3/all.d.ts +2 -2
- package/dist/metapage/v0_3/all.d.ts.map +1 -1
- package/dist/metapage/v0_4/metaframe.d.ts +3 -3
- package/dist/metapage/v0_4/metaframe.d.ts.map +1 -1
- package/dist/metapage/v0_4/metapage.d.ts +3 -3
- package/dist/metapage/v0_4/metapage.d.ts.map +1 -1
- package/dist/metapage/v1/metaframe.d.ts +3 -3
- package/dist/metapage/v1/metapage.d.ts +3 -3
- package/dist/metapage/v2/metaframe.d.ts +3 -3
- package/dist/metapage/v2/metapage.d.ts +3 -3
- package/dist/metapage/versions.d.ts.map +1 -1
- package/package.json +2 -1
- package/src/metapage/Constants.ts +5 -6
- package/src/metapage/Metaframe.ts +54 -62
- package/src/metapage/Metapage.ts +41 -41
- package/src/metapage/MetapageIFrameRpcClient.ts +20 -20
- package/src/metapage/MetapageTools.ts +15 -18
- package/src/metapage/README.md +5 -5
- package/src/metapage/Shared.ts +5 -5
- package/src/metapage/conversions-metaframe.ts +35 -35
- package/src/metapage/conversions-metapage.ts +25 -25
- package/src/metapage/core.ts +2 -1
- package/src/metapage/data.ts +38 -48
- package/src/metapage/errors/MissingMetaframeJson.ts +11 -12
- package/src/metapage/errors/RootMetapageError.ts +11 -12
- package/src/metapage/jsonrpc.ts +6 -12
- package/src/metapage/metapageRenderer.ts +110 -66
- package/src/metapage/metapageRendererExample.ts +1 -1
- package/src/metapage/util.ts +6 -6
- package/src/metapage/v0_1_0/all.ts +6 -6
- package/src/metapage/v0_2/all.ts +15 -13
- package/src/metapage/v0_3/JsonRpcMethods.ts +6 -10
- package/src/metapage/v0_3/all.ts +7 -10
- package/src/metapage/v0_4/README.md +1 -0
- package/src/metapage/v0_4/index.ts +0 -1
- package/src/metapage/v0_4/metaframe.ts +3 -6
- package/src/metapage/v0_4/metapage.ts +3 -6
- package/src/metapage/v1/index.ts +0 -1
- package/src/metapage/v1/metaframe.ts +3 -4
- package/src/metapage/v1/metapage.ts +3 -3
- package/src/metapage/v2/index.ts +0 -1
- package/src/metapage/v2/metaframe.ts +3 -4
- package/src/metapage/v2/metapage.ts +3 -3
- package/src/metapage/versions.ts +11 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { VersionsMetaframe as Versions } from
|
|
1
|
+
import { VersionsMetaframe as Versions } from "../versions.js";
|
|
2
2
|
|
|
3
3
|
export type MetaframePipeId = string;
|
|
4
4
|
export type MetaframeId = string;
|
|
@@ -37,7 +37,7 @@ export interface MetapageDefinitionV01 {
|
|
|
37
37
|
id?: MetapageId;
|
|
38
38
|
version: Versions; // Best to require this even if annoying to users.
|
|
39
39
|
iframes: {
|
|
40
|
-
[key: string]: MetaframeInstanceV01
|
|
40
|
+
[key: string]: MetaframeInstanceV01;
|
|
41
41
|
};
|
|
42
42
|
options?: any;
|
|
43
43
|
pipes?: Pipe[];
|
|
@@ -63,12 +63,12 @@ export interface DataBlob {
|
|
|
63
63
|
export enum DataEncoding {
|
|
64
64
|
utf8 = "utf8",
|
|
65
65
|
base64 = "base64",
|
|
66
|
-
json = "json"
|
|
66
|
+
json = "json",
|
|
67
67
|
}
|
|
68
68
|
|
|
69
69
|
export enum DataSource {
|
|
70
70
|
SourceUrl = "url",
|
|
71
|
-
SourceInline = "inline" //Default
|
|
71
|
+
SourceInline = "inline", //Default
|
|
72
72
|
}
|
|
73
73
|
|
|
74
74
|
export interface MetaframeInstanceAnonymous {
|
|
@@ -107,13 +107,13 @@ export interface MetapageMetadata {
|
|
|
107
107
|
}
|
|
108
108
|
|
|
109
109
|
export enum MetapageVersionLayoutType {
|
|
110
|
-
gridlayout = "gridlayout"
|
|
110
|
+
gridlayout = "gridlayout",
|
|
111
111
|
}
|
|
112
112
|
|
|
113
113
|
export type MetapageMetadataLayout = {
|
|
114
114
|
version?: string;
|
|
115
115
|
layouts?: {
|
|
116
|
-
[key in MetapageVersionLayoutType]: MetapageVersionLayoutGrid
|
|
116
|
+
[key in MetapageVersionLayoutType]: MetapageVersionLayoutGrid;
|
|
117
117
|
};
|
|
118
118
|
};
|
|
119
119
|
|
package/src/metapage/v0_2/all.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { type VersionsMetapage
|
|
1
|
+
import { type VersionsMetapage, type VersionsMetaframe } from "../versions.js";
|
|
2
2
|
|
|
3
3
|
export type MetaframePipeId = string;
|
|
4
4
|
export type MetaframeId = string;
|
|
5
5
|
export type MetapageId = string;
|
|
6
6
|
|
|
7
7
|
export type MetaframeInputMap = {
|
|
8
|
-
[key: string]: any
|
|
8
|
+
[key: string]: any;
|
|
9
9
|
}; // key: MetaframePipeId
|
|
10
10
|
|
|
11
11
|
export type MetaframePipeDefinition = {
|
|
@@ -13,34 +13,34 @@ export type MetaframePipeDefinition = {
|
|
|
13
13
|
};
|
|
14
14
|
|
|
15
15
|
export interface MetapageDefinitionV02 {
|
|
16
|
-
|
|
16
|
+
id?: MetapageId;
|
|
17
17
|
// Best to require this even if annoying to users. It's like the docker-compose.yml version. Human velocity changes (slow but steady)
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
18
|
+
version: VersionsMetapage;
|
|
19
|
+
metaframes: { [key: string]: MetaframeInstanceV02 };
|
|
20
|
+
// The plugin URLs point to the path containing a MetaframeInstance JSON
|
|
21
|
+
// It's an array because it needs to be sorted, but currently don't allow duplicate plugin URLs
|
|
22
|
+
meta?: MetapageMetadata;
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
export interface MetaframeDefinitionV02 {
|
|
26
26
|
version: VersionsMetaframe;
|
|
27
27
|
inputs?: {
|
|
28
|
-
[key: string]: MetaframePipeDefinition
|
|
28
|
+
[key: string]: MetaframePipeDefinition;
|
|
29
29
|
}; // <MetaframePipeId, MetaframePipeDefinition>
|
|
30
30
|
outputs?: {
|
|
31
|
-
[key: string]: MetaframePipeDefinition
|
|
31
|
+
[key: string]: MetaframePipeDefinition;
|
|
32
32
|
}; // <MetaframePipeId, MetaframePipeDefinition>
|
|
33
33
|
metadata: MetaframeMetadataV02;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
export type MetapageMetadata = {
|
|
37
37
|
name?: string;
|
|
38
|
-
description?:string;
|
|
38
|
+
description?: string;
|
|
39
39
|
// the idea is there *could* be different ways of displaying the metapage, so we store the preferred ways here
|
|
40
40
|
// you cannot really bake in which one is the "default" since that is not under our control nor should we care
|
|
41
41
|
// but we can have preferences
|
|
42
42
|
layouts?: {
|
|
43
|
-
[key in string]: any
|
|
43
|
+
[key in string]: any;
|
|
44
44
|
};
|
|
45
45
|
// layout?: MetapageMetadataLayout;
|
|
46
46
|
};
|
|
@@ -93,4 +93,6 @@ export type MetaframeMetadataV02 = {
|
|
|
93
93
|
iconUrl?: string;
|
|
94
94
|
};
|
|
95
95
|
|
|
96
|
-
export interface MetapageInstanceInputs {
|
|
96
|
+
export interface MetapageInstanceInputs {
|
|
97
|
+
[key: string]: MetaframeInputMap;
|
|
98
|
+
}
|
|
@@ -1,10 +1,6 @@
|
|
|
1
|
-
import { JsonRpcRequest } from
|
|
2
|
-
import { VersionsMetapage as Versions } from
|
|
3
|
-
import {
|
|
4
|
-
MetaframeId,
|
|
5
|
-
MetaframeInputMap,
|
|
6
|
-
MetapageId,
|
|
7
|
-
} from './all.js';
|
|
1
|
+
import { JsonRpcRequest } from "../jsonrpc2.js";
|
|
2
|
+
import { VersionsMetapage as Versions } from "../versions.js";
|
|
3
|
+
import { MetaframeId, MetaframeInputMap, MetapageId } from "./all.js";
|
|
8
4
|
|
|
9
5
|
export enum JsonRpcMethodsFromChild {
|
|
10
6
|
InputsUpdate = "InputsUpdate",
|
|
@@ -20,14 +16,14 @@ export enum JsonRpcMethodsFromChild {
|
|
|
20
16
|
export enum JsonRpcMethodsFromParent {
|
|
21
17
|
InputsUpdate = "InputsUpdate",
|
|
22
18
|
MessageAck = "MessageAck",
|
|
23
|
-
SetupIframeServerResponse = "SetupIframeServerResponse"
|
|
19
|
+
SetupIframeServerResponse = "SetupIframeServerResponse",
|
|
24
20
|
}
|
|
25
21
|
|
|
26
22
|
export interface SetupIframeServerResponseData {
|
|
27
23
|
iframeId: MetaframeId;
|
|
28
24
|
parentId: MetapageId;
|
|
29
25
|
state: {
|
|
30
|
-
inputs: MetaframeInputMap
|
|
26
|
+
inputs: MetaframeInputMap;
|
|
31
27
|
};
|
|
32
28
|
// Allow newer metaframes to handle older metapage versions
|
|
33
29
|
version: Versions;
|
|
@@ -50,7 +46,7 @@ export interface ClientMessageRecievedAck<T> {
|
|
|
50
46
|
|
|
51
47
|
// Plugin API definitions
|
|
52
48
|
export enum ApiPayloadPluginRequestMethod {
|
|
53
|
-
State = "metapage/state"
|
|
49
|
+
State = "metapage/state",
|
|
54
50
|
}
|
|
55
51
|
|
|
56
52
|
export interface ApiPayloadPluginRequest {
|
package/src/metapage/v0_3/all.ts
CHANGED
|
@@ -1,19 +1,16 @@
|
|
|
1
|
-
import {
|
|
2
|
-
MetapageDefinitionV02,
|
|
3
|
-
MetapageId,
|
|
4
|
-
} from '../v0_2/all.js';
|
|
1
|
+
import { MetapageDefinitionV02, MetapageId } from "../v0_2/all.js";
|
|
5
2
|
|
|
6
3
|
export type Url = string;
|
|
7
4
|
|
|
8
5
|
export interface MetapageOptions {
|
|
9
|
-
|
|
10
|
-
|
|
6
|
+
id?: MetapageId;
|
|
7
|
+
color?: string;
|
|
11
8
|
}
|
|
12
9
|
|
|
13
10
|
export interface MetapageDefinitionV03 extends MetapageDefinitionV02 {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
// The plugin URLs point to the path containing a MetaframeInstance JSON
|
|
12
|
+
// It's an array because it needs to be sorted, but currently don't allow duplicate plugin URLs
|
|
13
|
+
plugins?: Url[];
|
|
17
14
|
}
|
|
18
15
|
|
|
19
16
|
export type {
|
|
@@ -30,4 +27,4 @@ export type {
|
|
|
30
27
|
MetapageMetadata as MetapageMetadataV03,
|
|
31
28
|
PipeInput,
|
|
32
29
|
PipeUpdateBlob,
|
|
33
|
-
} from
|
|
30
|
+
} from "../v0_2/all";
|
|
@@ -1,9 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
} from '../core.js';
|
|
5
|
-
import { VersionsMetaframe } from '../versions.js';
|
|
6
|
-
import { MetapageDefinitionV3 } from './metapage.js';
|
|
1
|
+
import { MetaframeId, MetaframePipeId } from "../core.js";
|
|
2
|
+
import { VersionsMetaframe } from "../versions.js";
|
|
3
|
+
import { MetapageDefinitionV3 } from "./metapage.js";
|
|
7
4
|
|
|
8
5
|
export interface PipeInput {
|
|
9
6
|
metaframe: MetaframeId;
|
|
@@ -1,9 +1,6 @@
|
|
|
1
|
-
import { VersionsMetapage } from
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
Url,
|
|
5
|
-
} from '../core.js';
|
|
6
|
-
import { MetaframeInstance } from './metaframe.js';
|
|
1
|
+
import { VersionsMetapage } from "../versions.js";
|
|
2
|
+
import { MetapageId, Url } from "../core.js";
|
|
3
|
+
import { MetaframeInstance } from "./metaframe.js";
|
|
7
4
|
|
|
8
5
|
export interface MetapageOptions {
|
|
9
6
|
id?: MetapageId;
|
package/src/metapage/v1/index.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { VersionsMetaframe } from
|
|
2
|
-
import { MetapageDefinitionV1 } from
|
|
3
|
-
import { MetaframePipeDefinition } from
|
|
1
|
+
import { VersionsMetaframe } from "../versions.js";
|
|
2
|
+
import { MetapageDefinitionV1 } from "./metapage.js";
|
|
3
|
+
import { MetaframePipeDefinition } from "../v0_4/index.js";
|
|
4
4
|
|
|
5
5
|
export type MetaframeEditTypeMetaframeV1 = {
|
|
6
6
|
url: string;
|
|
@@ -91,4 +91,3 @@ export interface MetaframeOperationsV1 {
|
|
|
91
91
|
edit?: MetaframeOperationTypeV1;
|
|
92
92
|
view?: MetaframeOperationTypeV1;
|
|
93
93
|
}
|
|
94
|
-
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { VersionsMetapage } from
|
|
2
|
-
import { MetapageId } from
|
|
3
|
-
import { MetaframeInstance } from
|
|
1
|
+
import { VersionsMetapage } from "../versions.js";
|
|
2
|
+
import { MetapageId } from "../core.js";
|
|
3
|
+
import { MetaframeInstance } from "../v0_4/index.js";
|
|
4
4
|
|
|
5
5
|
export interface MetapageOptionsV1 {
|
|
6
6
|
id?: MetapageId;
|
package/src/metapage/v2/index.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { VersionsMetaframe } from
|
|
2
|
-
import { MetaframePipeDefinition } from
|
|
3
|
-
import { MetaframeOperationsV1 } from
|
|
1
|
+
import { VersionsMetaframe } from "../versions.js";
|
|
2
|
+
import { MetaframePipeDefinition } from "../v0_4/index.js";
|
|
3
|
+
import { MetaframeOperationsV1 } from "../v1/metaframe.js";
|
|
4
4
|
|
|
5
5
|
export type MetaframeMetadataV2 = {
|
|
6
6
|
name?: string;
|
|
@@ -30,4 +30,3 @@ export interface MetaframeDefinitionV2 {
|
|
|
30
30
|
// whitelist allowed hash parameters.
|
|
31
31
|
hashParams?: string[];
|
|
32
32
|
}
|
|
33
|
-
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { VersionsMetapage } from
|
|
2
|
-
import { MetapageId } from
|
|
3
|
-
import { MetaframeInstance } from
|
|
1
|
+
import { VersionsMetapage } from "../versions.js";
|
|
2
|
+
import { MetapageId } from "../core.js";
|
|
3
|
+
import { MetaframeInstance } from "../v0_4/index.js";
|
|
4
4
|
|
|
5
5
|
export type MetapageMetadataV2 = Partial<{
|
|
6
6
|
name: string;
|
package/src/metapage/versions.ts
CHANGED
|
@@ -1,13 +1,20 @@
|
|
|
1
1
|
// There used to be a single version, but there's no reason to upgrade both versions
|
|
2
2
|
// simultaneously. Same versions are an ideal, but forcing it is also bad
|
|
3
3
|
|
|
4
|
-
export const MetaframeVersionsAll = [
|
|
4
|
+
export const MetaframeVersionsAll = [
|
|
5
|
+
"0.3",
|
|
6
|
+
"0.4",
|
|
7
|
+
"0.5",
|
|
8
|
+
"0.6",
|
|
9
|
+
"1",
|
|
10
|
+
"2",
|
|
11
|
+
] as const;
|
|
5
12
|
// Create the type from the array
|
|
6
13
|
export type VersionsMetaframe = (typeof MetaframeVersionsAll)[number];
|
|
7
14
|
|
|
8
|
-
export const MetapageVersionsAll
|
|
15
|
+
export const MetapageVersionsAll = ["0.2", "0.3", "1", "2"] as const;
|
|
9
16
|
// Create the type from the array
|
|
10
17
|
export type VersionsMetapage = (typeof MetapageVersionsAll)[number];
|
|
11
18
|
|
|
12
|
-
export const MetaframeVersionCurrent
|
|
13
|
-
export const MetapageVersionCurrent
|
|
19
|
+
export const MetaframeVersionCurrent: VersionsMetaframe = "2";
|
|
20
|
+
export const MetapageVersionCurrent: VersionsMetapage = "2";
|