@web-widget/vue 0.1.0 → 0.1.1

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.
@@ -3,7 +3,7 @@ import * as vue from 'vue';
3
3
  import { PropType, VNode, App, Component } from 'vue';
4
4
  import { RenderContext, ComponentProps } from '@web-widget/schema/client-helpers';
5
5
  export * from '@web-widget/schema/client-helpers';
6
- import { Loader, WebWidgetContainerProps } from '@web-widget/web-widget';
6
+ import { Loader, WebWidgetContainerOptions } from '@web-widget/web-widget';
7
7
 
8
8
  declare const __ENV__: {
9
9
  server: boolean;
@@ -23,6 +23,10 @@ declare const WebWidget: vue.DefineComponent<{
23
23
  import: {
24
24
  type: PropType<string | undefined>;
25
25
  };
26
+ inactive: {
27
+ type: PropType<boolean | undefined>;
28
+ default: undefined;
29
+ };
26
30
  loader: {
27
31
  type: PropType<Loader>;
28
32
  required: true;
@@ -30,11 +34,14 @@ declare const WebWidget: vue.DefineComponent<{
30
34
  loading: {
31
35
  type: PropType<string | undefined>;
32
36
  };
37
+ meta: {
38
+ type: PropType<_web_widget_schema.Meta | undefined>;
39
+ };
33
40
  name: {
34
41
  type: PropType<string | undefined>;
35
42
  };
36
- recovering: {
37
- type: PropType<boolean | undefined>;
43
+ renderStage: {
44
+ type: PropType<"server" | "client" | undefined>;
38
45
  };
39
46
  renderTarget: {
40
47
  type: PropType<"light" | "shadow" | undefined>;
@@ -57,6 +64,10 @@ declare const WebWidget: vue.DefineComponent<{
57
64
  import: {
58
65
  type: PropType<string | undefined>;
59
66
  };
67
+ inactive: {
68
+ type: PropType<boolean | undefined>;
69
+ default: undefined;
70
+ };
60
71
  loader: {
61
72
  type: PropType<Loader>;
62
73
  required: true;
@@ -64,11 +75,14 @@ declare const WebWidget: vue.DefineComponent<{
64
75
  loading: {
65
76
  type: PropType<string | undefined>;
66
77
  };
78
+ meta: {
79
+ type: PropType<_web_widget_schema.Meta | undefined>;
80
+ };
67
81
  name: {
68
82
  type: PropType<string | undefined>;
69
83
  };
70
- recovering: {
71
- type: PropType<boolean | undefined>;
84
+ renderStage: {
85
+ type: PropType<"server" | "client" | undefined>;
72
86
  };
73
87
  renderTarget: {
74
88
  type: PropType<"light" | "shadow" | undefined>;
@@ -80,38 +94,41 @@ declare const WebWidget: vue.DefineComponent<{
80
94
  [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
81
95
  } | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
82
96
  } | undefined;
97
+ inactive: boolean | undefined;
83
98
  renderTarget: "light" | "shadow" | undefined;
84
99
  }, {}>;
85
100
  interface DefineWebWidgetOptions {
86
- base?: WebWidgetContainerProps["base"];
87
- import?: WebWidgetContainerProps["import"];
88
- loading?: WebWidgetContainerProps["loading"];
89
- name?: WebWidgetContainerProps["name"];
90
- recovering?: WebWidgetContainerProps["recovering"];
91
- renderTarget?: WebWidgetContainerProps["renderTarget"];
101
+ base?: WebWidgetContainerOptions["base"];
102
+ import?: WebWidgetContainerOptions["import"];
103
+ loading?: WebWidgetContainerOptions["loading"];
104
+ name?: WebWidgetContainerOptions["name"];
105
+ renderStage?: WebWidgetContainerOptions["renderStage"];
106
+ renderTarget?: WebWidgetContainerOptions["renderTarget"];
92
107
  }
93
108
  declare function defineWebWidget(loader: Loader, options: DefineWebWidgetOptions): vue.DefineComponent<{
94
- clientOnly: {
95
- type: BooleanConstructor;
96
- default: boolean;
109
+ renderStage: {
110
+ type: PropType<"server" | "client" | undefined>;
111
+ default: "server" | "client" | undefined;
97
112
  };
98
113
  fallback: {
99
- type: ObjectConstructor;
100
- required: false;
114
+ type: PropType<VNode<vue.RendererNode, vue.RendererElement, {
115
+ [key: string]: any;
116
+ }>>;
101
117
  };
102
118
  }, () => VNode<vue.RendererNode, vue.RendererElement, {
103
119
  [key: string]: any;
104
120
  }>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{
105
- clientOnly: {
106
- type: BooleanConstructor;
107
- default: boolean;
121
+ renderStage: {
122
+ type: PropType<"server" | "client" | undefined>;
123
+ default: "server" | "client" | undefined;
108
124
  };
109
125
  fallback: {
110
- type: ObjectConstructor;
111
- required: false;
126
+ type: PropType<VNode<vue.RendererNode, vue.RendererElement, {
127
+ [key: string]: any;
128
+ }>>;
112
129
  };
113
130
  }>>, {
114
- clientOnly: boolean;
131
+ renderStage: "server" | "client" | undefined;
115
132
  }, {}>;
116
133
 
117
134
  interface DefineVueRenderOptions {
@@ -49,6 +49,11 @@ var WebWidget = /* @__PURE__ */ defineComponent({
49
49
  import: {
50
50
  type: String
51
51
  },
52
+ inactive: {
53
+ type: Boolean,
54
+ // NOTE: If the default value is not set, it will be false here.
55
+ default: void 0
56
+ },
52
57
  loader: {
53
58
  type: Function,
54
59
  required: true
@@ -56,11 +61,14 @@ var WebWidget = /* @__PURE__ */ defineComponent({
56
61
  loading: {
57
62
  type: String
58
63
  },
64
+ meta: {
65
+ type: Object
66
+ },
59
67
  name: {
60
68
  type: String
61
69
  },
62
- recovering: {
63
- type: Boolean
70
+ renderStage: {
71
+ type: String
64
72
  },
65
73
  renderTarget: {
66
74
  type: String,
@@ -69,7 +77,7 @@ var WebWidget = /* @__PURE__ */ defineComponent({
69
77
  },
70
78
  async setup(_a, { slots }) {
71
79
  var _b = _a, { loader } = _b, props = __objRest(_b, ["loader"]);
72
- if (props.recovering && !loader) {
80
+ if (!loader) {
73
81
  throw new TypeError(`Missing loader.`);
74
82
  }
75
83
  if (Object.keys(slots).length > 0) {
@@ -95,17 +103,16 @@ function defineWebWidget(loader, options) {
95
103
  return /* @__PURE__ */ defineComponent({
96
104
  name: "WebWidgetSuspense",
97
105
  props: {
98
- clientOnly: {
99
- type: Boolean,
100
- default: !options.recovering
106
+ renderStage: {
107
+ type: String,
108
+ default: options.renderStage
101
109
  },
102
110
  fallback: {
103
- type: Object,
104
- required: false
111
+ type: Object
105
112
  }
106
113
  },
107
114
  setup(_a, { slots }) {
108
- var _b = _a, { clientOnly, fallback } = _b, data = __objRest(_b, ["clientOnly", "fallback"]);
115
+ var _b = _a, { fallback, renderStage } = _b, data = __objRest(_b, ["fallback", "renderStage"]);
109
116
  return () => h(
110
117
  Suspense,
111
118
  {},
@@ -113,9 +120,9 @@ function defineWebWidget(loader, options) {
113
120
  default: h(
114
121
  WebWidget,
115
122
  __spreadProps(__spreadValues({}, options), {
116
- loader,
117
123
  data,
118
- recovering: !clientOnly
124
+ loader,
125
+ renderStage
119
126
  }),
120
127
  slots
121
128
  ),
@@ -3,7 +3,7 @@ import * as vue from 'vue';
3
3
  import { PropType, VNode, App, Component } from 'vue';
4
4
  import { RenderContext, ComponentProps } from '@web-widget/schema/server-helpers';
5
5
  export * from '@web-widget/schema/server-helpers';
6
- import { Loader, WebWidgetContainerProps } from '@web-widget/web-widget';
6
+ import { Loader, WebWidgetContainerOptions } from '@web-widget/web-widget';
7
7
 
8
8
  declare const __ENV__: {
9
9
  server: boolean;
@@ -23,6 +23,10 @@ declare const WebWidget: vue.DefineComponent<{
23
23
  import: {
24
24
  type: PropType<string | undefined>;
25
25
  };
26
+ inactive: {
27
+ type: PropType<boolean | undefined>;
28
+ default: undefined;
29
+ };
26
30
  loader: {
27
31
  type: PropType<Loader>;
28
32
  required: true;
@@ -30,11 +34,14 @@ declare const WebWidget: vue.DefineComponent<{
30
34
  loading: {
31
35
  type: PropType<string | undefined>;
32
36
  };
37
+ meta: {
38
+ type: PropType<_web_widget_schema.Meta | undefined>;
39
+ };
33
40
  name: {
34
41
  type: PropType<string | undefined>;
35
42
  };
36
- recovering: {
37
- type: PropType<boolean | undefined>;
43
+ renderStage: {
44
+ type: PropType<"server" | "client" | undefined>;
38
45
  };
39
46
  renderTarget: {
40
47
  type: PropType<"light" | "shadow" | undefined>;
@@ -57,6 +64,10 @@ declare const WebWidget: vue.DefineComponent<{
57
64
  import: {
58
65
  type: PropType<string | undefined>;
59
66
  };
67
+ inactive: {
68
+ type: PropType<boolean | undefined>;
69
+ default: undefined;
70
+ };
60
71
  loader: {
61
72
  type: PropType<Loader>;
62
73
  required: true;
@@ -64,11 +75,14 @@ declare const WebWidget: vue.DefineComponent<{
64
75
  loading: {
65
76
  type: PropType<string | undefined>;
66
77
  };
78
+ meta: {
79
+ type: PropType<_web_widget_schema.Meta | undefined>;
80
+ };
67
81
  name: {
68
82
  type: PropType<string | undefined>;
69
83
  };
70
- recovering: {
71
- type: PropType<boolean | undefined>;
84
+ renderStage: {
85
+ type: PropType<"server" | "client" | undefined>;
72
86
  };
73
87
  renderTarget: {
74
88
  type: PropType<"light" | "shadow" | undefined>;
@@ -80,38 +94,41 @@ declare const WebWidget: vue.DefineComponent<{
80
94
  [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
81
95
  } | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any)[])[])[])[])[])[])[])[])[])[])[];
82
96
  } | undefined;
97
+ inactive: boolean | undefined;
83
98
  renderTarget: "light" | "shadow" | undefined;
84
99
  }, {}>;
85
100
  interface DefineWebWidgetOptions {
86
- base?: WebWidgetContainerProps["base"];
87
- import?: WebWidgetContainerProps["import"];
88
- loading?: WebWidgetContainerProps["loading"];
89
- name?: WebWidgetContainerProps["name"];
90
- recovering?: WebWidgetContainerProps["recovering"];
91
- renderTarget?: WebWidgetContainerProps["renderTarget"];
101
+ base?: WebWidgetContainerOptions["base"];
102
+ import?: WebWidgetContainerOptions["import"];
103
+ loading?: WebWidgetContainerOptions["loading"];
104
+ name?: WebWidgetContainerOptions["name"];
105
+ renderStage?: WebWidgetContainerOptions["renderStage"];
106
+ renderTarget?: WebWidgetContainerOptions["renderTarget"];
92
107
  }
93
108
  declare function defineWebWidget(loader: Loader, options: DefineWebWidgetOptions): vue.DefineComponent<{
94
- clientOnly: {
95
- type: BooleanConstructor;
96
- default: boolean;
109
+ renderStage: {
110
+ type: PropType<"server" | "client" | undefined>;
111
+ default: "server" | "client" | undefined;
97
112
  };
98
113
  fallback: {
99
- type: ObjectConstructor;
100
- required: false;
114
+ type: PropType<VNode<vue.RendererNode, vue.RendererElement, {
115
+ [key: string]: any;
116
+ }>>;
101
117
  };
102
118
  }, () => VNode<vue.RendererNode, vue.RendererElement, {
103
119
  [key: string]: any;
104
120
  }>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{
105
- clientOnly: {
106
- type: BooleanConstructor;
107
- default: boolean;
121
+ renderStage: {
122
+ type: PropType<"server" | "client" | undefined>;
123
+ default: "server" | "client" | undefined;
108
124
  };
109
125
  fallback: {
110
- type: ObjectConstructor;
111
- required: false;
126
+ type: PropType<VNode<vue.RendererNode, vue.RendererElement, {
127
+ [key: string]: any;
128
+ }>>;
112
129
  };
113
130
  }>>, {
114
- clientOnly: boolean;
131
+ renderStage: "server" | "client" | undefined;
115
132
  }, {}>;
116
133
 
117
134
  interface DefineVueRenderOptions {
@@ -49,6 +49,11 @@ var WebWidget = /* @__PURE__ */ defineComponent({
49
49
  import: {
50
50
  type: String
51
51
  },
52
+ inactive: {
53
+ type: Boolean,
54
+ // NOTE: If the default value is not set, it will be false here.
55
+ default: void 0
56
+ },
52
57
  loader: {
53
58
  type: Function,
54
59
  required: true
@@ -56,11 +61,14 @@ var WebWidget = /* @__PURE__ */ defineComponent({
56
61
  loading: {
57
62
  type: String
58
63
  },
64
+ meta: {
65
+ type: Object
66
+ },
59
67
  name: {
60
68
  type: String
61
69
  },
62
- recovering: {
63
- type: Boolean
70
+ renderStage: {
71
+ type: String
64
72
  },
65
73
  renderTarget: {
66
74
  type: String,
@@ -69,7 +77,7 @@ var WebWidget = /* @__PURE__ */ defineComponent({
69
77
  },
70
78
  async setup(_a, { slots }) {
71
79
  var _b = _a, { loader } = _b, props = __objRest(_b, ["loader"]);
72
- if (props.recovering && !loader) {
80
+ if (!loader) {
73
81
  throw new TypeError(`Missing loader.`);
74
82
  }
75
83
  if (Object.keys(slots).length > 0) {
@@ -95,17 +103,16 @@ function defineWebWidget(loader, options) {
95
103
  return /* @__PURE__ */ defineComponent({
96
104
  name: "WebWidgetSuspense",
97
105
  props: {
98
- clientOnly: {
99
- type: Boolean,
100
- default: !options.recovering
106
+ renderStage: {
107
+ type: String,
108
+ default: options.renderStage
101
109
  },
102
110
  fallback: {
103
- type: Object,
104
- required: false
111
+ type: Object
105
112
  }
106
113
  },
107
114
  setup(_a, { slots }) {
108
- var _b = _a, { clientOnly, fallback } = _b, data = __objRest(_b, ["clientOnly", "fallback"]);
115
+ var _b = _a, { fallback, renderStage } = _b, data = __objRest(_b, ["fallback", "renderStage"]);
109
116
  return () => h(
110
117
  Suspense,
111
118
  {},
@@ -113,9 +120,9 @@ function defineWebWidget(loader, options) {
113
120
  default: h(
114
121
  WebWidget,
115
122
  __spreadProps(__spreadValues({}, options), {
116
- loader,
117
123
  data,
118
- recovering: !clientOnly
124
+ loader,
125
+ renderStage
119
126
  }),
120
127
  slots
121
128
  ),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@web-widget/vue",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -22,8 +22,8 @@
22
22
  "dist"
23
23
  ],
24
24
  "dependencies": {
25
- "@web-widget/schema": "0.0.8",
26
- "@web-widget/web-widget": "1.0.0-alpha.6"
25
+ "@web-widget/schema": "0.0.9",
26
+ "@web-widget/web-widget": "1.0.0-alpha.7"
27
27
  },
28
28
  "peerDependencies": {
29
29
  "vue": ">3.3.3"