@weaverse/hydrogen 5.0.0 → 5.2.0

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.
Files changed (8) hide show
  1. package/dist/index.d.mts +14 -26
  2. package/dist/index.d.ts +14 -26
  3. package/dist/index.js +287 -222
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +281 -222
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +3 -2
  8. package/readme.md +37 -20
package/dist/index.d.mts CHANGED
@@ -1,8 +1,11 @@
1
1
  import { SelectedOptionInput } from '@shopify/hydrogen/storefront-api-types';
2
- import { EventEmitter, BasicInput as BasicInput$1, ElementData, WeaverseElement, ElementSchema, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
3
- export { InputType, PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
2
+ import { EventEmitter, ElementData, WeaverseElement, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
3
+ export { PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
4
4
  import { createWithCache, I18nBase, HydrogenContext } from '@shopify/hydrogen';
5
5
  import { LoaderFunctionArgs, AppLoadContext } from '@shopify/remix-oxygen';
6
+ import { PageType, InspectorGroup, SchemaType, ComponentPresets } from '@weaverse/schema';
7
+ export * from '@weaverse/schema';
8
+ export { InspectorGroup, PageType } from '@weaverse/schema';
6
9
  import * as React$1 from 'react';
7
10
  import { ForwardRefExoticComponent, ComponentType, JSX } from 'react';
8
11
  import { NavigateFunction } from 'react-router';
@@ -79,9 +82,11 @@ interface HydrogenComponentData extends ElementData {
79
82
  updatedAt?: string;
80
83
  deletedAt?: string;
81
84
  }
82
- interface HydrogenComponentSchema extends ElementSchema {
85
+ interface HydrogenComponentSchema extends SchemaType {
83
86
  childTypes?: string[];
84
- inspector: InspectorGroup[];
87
+ /** @deprecated Use settings instead */
88
+ inspector?: InspectorGroup[];
89
+ settings?: InspectorGroup[];
85
90
  presets?: Omit<HydrogenComponentPresets, 'type'>;
86
91
  limit?: number;
87
92
  enabledOn?: {
@@ -89,20 +94,6 @@ interface HydrogenComponentSchema extends ElementSchema {
89
94
  groups?: ('*' | 'header' | 'footer' | 'body')[];
90
95
  };
91
96
  }
92
- type BasicInput = Omit<BasicInput$1, 'condition'> & {
93
- shouldRevalidate?: boolean;
94
- condition?: string | ((data: ElementData, weaverse: WeaverseHydrogen) => boolean);
95
- };
96
- type HeadingInputType = 'heading';
97
- type HeadingInput = {
98
- type: HeadingInputType;
99
- label: string;
100
- [key: string]: any;
101
- };
102
- interface InspectorGroup {
103
- group: string;
104
- inputs: (BasicInput | HeadingInput)[];
105
- }
106
97
  interface HydrogenComponentProps<L = any> extends WeaverseElement {
107
98
  className?: string;
108
99
  loaderData?: L;
@@ -132,11 +123,7 @@ type WeaverseInternal = {
132
123
  revalidate: () => void;
133
124
  themeSettingsStore: ThemeSettingsStore;
134
125
  };
135
- type HydrogenComponentPresets = {
136
- type: string;
137
- children?: HydrogenComponentPresets[];
138
- [key: string]: any;
139
- };
126
+ type HydrogenComponentPresets = ComponentPresets;
140
127
  interface HydrogenElement {
141
128
  Component: ForwardRefExoticComponent<HydrogenComponentProps> | ((props: HydrogenComponentProps) => React$1.JSX.Element);
142
129
  type: string;
@@ -212,14 +199,15 @@ interface HydrogenThemeSchema {
212
199
  documentationUrl: string;
213
200
  supportUrl: string;
214
201
  };
215
- inspector: InspectorGroup[];
202
+ /** @deprecated Use settings instead */
203
+ inspector?: InspectorGroup[];
204
+ settings?: InspectorGroup[];
216
205
  i18n?: {
217
206
  urlStructure: 'url-path' | 'subdomain' | 'top-level-domain';
218
207
  defaultLocale: WeaverseI18n;
219
208
  shopLocales: WeaverseI18n[];
220
209
  };
221
210
  }
222
- type PageType = 'INDEX' | 'PRODUCT' | 'ALL_PRODUCTS' | 'COLLECTION' | 'COLLECTION_LIST' | 'PAGE' | 'BLOG' | 'ARTICLE' | 'CUSTOM';
223
211
  type FetchProjectRequestBody = {
224
212
  projectId: string;
225
213
  url: string;
@@ -332,4 +320,4 @@ declare const IMAGES_PLACEHOLDERS: {
332
320
  product_18: string;
333
321
  };
334
322
 
335
- export { type AllCacheOptions, type BasicInput, type ComponentLoaderArgs, type FetchProjectPayload, type FetchProjectRequestBody, type HeadingInput, type HeadingInputType, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type InspectorGroup, type PageType, type PublicEnv, type RouteLoaderArgs, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, getSelectedProductOptions, registerComponent, useThemeSettings, withWeaverse };
323
+ export { type AllCacheOptions, type ComponentLoaderArgs, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type PublicEnv, type RouteLoaderArgs, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, getSelectedProductOptions, registerComponent, useThemeSettings, withWeaverse };
package/dist/index.d.ts CHANGED
@@ -1,8 +1,11 @@
1
1
  import { SelectedOptionInput } from '@shopify/hydrogen/storefront-api-types';
2
- import { EventEmitter, BasicInput as BasicInput$1, ElementData, WeaverseElement, ElementSchema, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
3
- export { InputType, PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
2
+ import { EventEmitter, ElementData, WeaverseElement, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
3
+ export { PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
4
4
  import { createWithCache, I18nBase, HydrogenContext } from '@shopify/hydrogen';
5
5
  import { LoaderFunctionArgs, AppLoadContext } from '@shopify/remix-oxygen';
6
+ import { PageType, InspectorGroup, SchemaType, ComponentPresets } from '@weaverse/schema';
7
+ export * from '@weaverse/schema';
8
+ export { InspectorGroup, PageType } from '@weaverse/schema';
6
9
  import * as React$1 from 'react';
7
10
  import { ForwardRefExoticComponent, ComponentType, JSX } from 'react';
8
11
  import { NavigateFunction } from 'react-router';
@@ -79,9 +82,11 @@ interface HydrogenComponentData extends ElementData {
79
82
  updatedAt?: string;
80
83
  deletedAt?: string;
81
84
  }
82
- interface HydrogenComponentSchema extends ElementSchema {
85
+ interface HydrogenComponentSchema extends SchemaType {
83
86
  childTypes?: string[];
84
- inspector: InspectorGroup[];
87
+ /** @deprecated Use settings instead */
88
+ inspector?: InspectorGroup[];
89
+ settings?: InspectorGroup[];
85
90
  presets?: Omit<HydrogenComponentPresets, 'type'>;
86
91
  limit?: number;
87
92
  enabledOn?: {
@@ -89,20 +94,6 @@ interface HydrogenComponentSchema extends ElementSchema {
89
94
  groups?: ('*' | 'header' | 'footer' | 'body')[];
90
95
  };
91
96
  }
92
- type BasicInput = Omit<BasicInput$1, 'condition'> & {
93
- shouldRevalidate?: boolean;
94
- condition?: string | ((data: ElementData, weaverse: WeaverseHydrogen) => boolean);
95
- };
96
- type HeadingInputType = 'heading';
97
- type HeadingInput = {
98
- type: HeadingInputType;
99
- label: string;
100
- [key: string]: any;
101
- };
102
- interface InspectorGroup {
103
- group: string;
104
- inputs: (BasicInput | HeadingInput)[];
105
- }
106
97
  interface HydrogenComponentProps<L = any> extends WeaverseElement {
107
98
  className?: string;
108
99
  loaderData?: L;
@@ -132,11 +123,7 @@ type WeaverseInternal = {
132
123
  revalidate: () => void;
133
124
  themeSettingsStore: ThemeSettingsStore;
134
125
  };
135
- type HydrogenComponentPresets = {
136
- type: string;
137
- children?: HydrogenComponentPresets[];
138
- [key: string]: any;
139
- };
126
+ type HydrogenComponentPresets = ComponentPresets;
140
127
  interface HydrogenElement {
141
128
  Component: ForwardRefExoticComponent<HydrogenComponentProps> | ((props: HydrogenComponentProps) => React$1.JSX.Element);
142
129
  type: string;
@@ -212,14 +199,15 @@ interface HydrogenThemeSchema {
212
199
  documentationUrl: string;
213
200
  supportUrl: string;
214
201
  };
215
- inspector: InspectorGroup[];
202
+ /** @deprecated Use settings instead */
203
+ inspector?: InspectorGroup[];
204
+ settings?: InspectorGroup[];
216
205
  i18n?: {
217
206
  urlStructure: 'url-path' | 'subdomain' | 'top-level-domain';
218
207
  defaultLocale: WeaverseI18n;
219
208
  shopLocales: WeaverseI18n[];
220
209
  };
221
210
  }
222
- type PageType = 'INDEX' | 'PRODUCT' | 'ALL_PRODUCTS' | 'COLLECTION' | 'COLLECTION_LIST' | 'PAGE' | 'BLOG' | 'ARTICLE' | 'CUSTOM';
223
211
  type FetchProjectRequestBody = {
224
212
  projectId: string;
225
213
  url: string;
@@ -332,4 +320,4 @@ declare const IMAGES_PLACEHOLDERS: {
332
320
  product_18: string;
333
321
  };
334
322
 
335
- export { type AllCacheOptions, type BasicInput, type ComponentLoaderArgs, type FetchProjectPayload, type FetchProjectRequestBody, type HeadingInput, type HeadingInputType, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type InspectorGroup, type PageType, type PublicEnv, type RouteLoaderArgs, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, getSelectedProductOptions, registerComponent, useThemeSettings, withWeaverse };
323
+ export { type AllCacheOptions, type ComponentLoaderArgs, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type PublicEnv, type RouteLoaderArgs, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, getSelectedProductOptions, registerComponent, useThemeSettings, withWeaverse };