@weaverse/hydrogen 2.5.0 → 2.6.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Paul Phan
+Copyright (c) 2022 Weaverse
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.js

@@ -257,7 +257,10 @@ var import_hydrogen = require("@shopify/hydrogen");
 
 // package.json
 var package_default = {
-  version: "2.5.0",
+  name: "@weaverse/hydrogen",
+  author: "Weaverse Team",
+  description: "Components, hooks, and utilities for building Shopify Hydrogen websites with Weaverse",
+  version: "2.6.0",
   license: "MIT",
   main: "dist/index.js",
   typings: "dist/index.d.ts",
@@ -265,6 +268,10 @@ var package_default = {
   publishConfig: {
     access: "public"
   },
+  repository: {
+    url: "git+https://github.com/Weaverse/weaverse.git",
+    directory: "packages/hydrogen"
+  },
   files: [
     "dist/*"
   ],
@@ -289,10 +296,8 @@ var package_default = {
     semi: false,
     singleQuote: true
   },
-  name: "@weaverse/hydrogen",
-  author: "Weaverse Team",
   dependencies: {
-    "@weaverse/react": "2.5.0",
+    "@weaverse/react": "2.6.0",
     "react-error-boundary": "^4.0.11"
   },
   devDependencies: {

package/dist/index.mjs

@@ -223,7 +223,10 @@ import { createWithCache } from "@shopify/hydrogen";
 
 // package.json
 var package_default = {
-  version: "2.5.0",
+  name: "@weaverse/hydrogen",
+  author: "Weaverse Team",
+  description: "Components, hooks, and utilities for building Shopify Hydrogen websites with Weaverse",
+  version: "2.6.0",
   license: "MIT",
   main: "dist/index.js",
   typings: "dist/index.d.ts",
@@ -231,6 +234,10 @@ var package_default = {
   publishConfig: {
     access: "public"
   },
+  repository: {
+    url: "git+https://github.com/Weaverse/weaverse.git",
+    directory: "packages/hydrogen"
+  },
   files: [
     "dist/*"
   ],
@@ -255,10 +262,8 @@ var package_default = {
     semi: false,
     singleQuote: true
   },
-  name: "@weaverse/hydrogen",
-  author: "Weaverse Team",
   dependencies: {
-    "@weaverse/react": "2.5.0",
+    "@weaverse/react": "2.6.0",
     "react-error-boundary": "^4.0.11"
   },
   devDependencies: {

package/package.json

@@ -1,43 +1,48 @@
 {
-  "version": "2.5.0",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "module": "dist/index.mjs",
-  "publishConfig": {
-    "access": "public"
+  "name" : "@weaverse/hydrogen",
+  "author" : "Weaverse Team",
+  "description" : "Components, hooks, and utilities for building Shopify Hydrogen websites with Weaverse",
+  "version" : "2.6.0",
+  "license" : "MIT",
+  "main" : "dist/index.js",
+  "typings" : "dist/index.d.ts",
+  "module" : "dist/index.mjs",
+  "publishConfig" : {
+    "access" : "public"
   },
-  "files": [
+  "repository" : {
+    "url" : "git+https://github.com/Weaverse/weaverse.git",
+    "directory" : "packages/hydrogen"
+  },
+  "files" : [
     "dist/*"
   ],
-  "engines": {
-    "node": ">=16"
+  "engines" : {
+    "node" : ">=16"
   },
-  "scripts": {
-    "start": "npm run dev",
-    "dev": "tsup src/index.ts --format esm,cjs --dts --outDir dist --watch --external @remix-run/react,@shopify/hydrogen",
-    "build": "tsup src/index.ts --format esm,cjs --dts --outDir dist --external @remix-run/react,@shopify/hydrogen",
-    "clean": "rimraf dist",
-    "prepublish": "npm run build"
+  "scripts" : {
+    "start" : "npm run dev",
+    "dev" : "tsup src/index.ts --format esm,cjs --dts --outDir dist --watch --external @remix-run/react,@shopify/hydrogen",
+    "build" : "tsup src/index.ts --format esm,cjs --dts --outDir dist --external @remix-run/react,@shopify/hydrogen",
+    "clean" : "rimraf dist",
+    "prepublish" : "npm run build"
   },
-  "peerDependencies": {
-    "react": ">=18",
-    "react-dom": ">=18",
-    "@remix-run/react": "^2.1.0",
-    "@shopify/hydrogen": "^2023.10.2"
+  "peerDependencies" : {
+    "react" : ">=18",
+    "react-dom" : ">=18",
+    "@remix-run/react" : "^2.1.0",
+    "@shopify/hydrogen" : "^2023.10.2"
   },
-  "prettier": {
-    "printWidth": 80,
-    "semi": false,
-    "singleQuote": true
+  "prettier" : {
+    "printWidth" : 80,
+    "semi" : false,
+    "singleQuote" : true
   },
-  "name": "@weaverse/hydrogen",
-  "author": "Weaverse Team",
-  "dependencies": {
-    "@weaverse/react": "2.5.0",
-    "react-error-boundary": "^4.0.11"
+  "dependencies" : {
+    "@weaverse/react" : "2.6.0",
+    "react-error-boundary" : "^4.0.11"
   },
-  "devDependencies": {
-    "@shopify/remix-oxygen": "^2.0.1"
+  "devDependencies" : {
+    "@shopify/remix-oxygen" : "^2.0.1"
   }
 }

package/readme.md

@@ -0,0 +1,173 @@
+# @weaverse/hydrogen
+
+## Overview
+
+`@weaverse/hydrogen` is a crucial package within the Weaverse ecosystem, designed to facilitate the integration of
+Shopify Hydrogen and Remix projects with the Weaverse CMS. It leverages `@weaverse/react` for rendering content and
+provides a client for easy setup and data fetching from Weaverse CMS.
+
+## Key Features
+
+- **Weaverse Client Integration**: Enables seamless integration with Weaverse CMS, allowing for efficient data fetching
+  and rendering in Hydrogen/Remix projects.
+- **Dynamic Data Fetching**: Fetch and render page data and global theme settings server-side, ensuring dynamic and
+  consistent content delivery.
+- **Component Registration and Rendering**: Register React components with Weaverse and render them using
+  the `WeaverseHydrogenRoot` component.
+- **Flexible Schema Definition**: Define behavior and interactivity of components within Weaverse Studio through
+  the `HydrogenComponentSchema`.
+- **Customizable Input Settings**: Specify configurations for merchant-customizable component settings in Weaverse
+  Studio.
+
+## Installation
+
+```bash
+npm install @weaverse/hydrogen
+```
+
+## Setup and Usage
+
+### Weaverse Client Setup
+
+Initialize the Weaverse Client to establish a connection between your Hydrogen project and Weaverse CMS:
+
+```typescript
+// <root>/server.ts
+
+import {createWeaverseClient} from '~/weaverse/create-weaverse.server';
+
+const handleRequest = createRequestHandler({
+  // ...
+  getLoadContext: () => ({
+    // Injecting the Weaverse client into the loader context.
+    weaverse: createWeaverseClient({
+      storefront,
+      request,
+      env,
+      cache,
+      waitUntil,
+    }),
+    // ... more app context properties
+  }),
+});
+
+```
+
+### Data Fetching and Rendering
+
+Use the Weaverse Client to fetch data such as page content and global theme settings:
+
+```typescript
+// <root>/app/routes/($locale)._index.tsx
+
+import { json } from '@shopify/remix-oxygen';
+import { type RouteLoaderArgs } from '@weaverse/hydrogen';
+
+export async function loader({context}: RouteLoaderArgs) {
+  let {weaverse} = context;
+
+  return json({
+    // The key prop for a Weaverse page must always be `weaverseData`
+    weaverseData: await weaverse.loadPage(),
+    // Additional page data...
+  });
+}
+
+```
+
+Implement the `WeaverseHydrogenRoot` component to render the fetched content:
+
+```jsx
+// <root>/app/weaverse/index.tsx
+
+import {WeaverseHydrogenRoot} from '@weaverse/hydrogen';
+import {GenericError} from '~/components/GenericError';
+import {components} from './components';
+
+export function WeaverseContent() {
+  return (
+    <WeaverseHydrogenRoot
+      components={components}
+      errorComponent={GenericError}
+    />
+  );
+}
+
+
+// <root>/app/routes/($locale)._index.tsx
+
+import { WeaverseContent } from '~/weaverse';
+
+export default function Homepage() {
+  return <WeaverseContent />;
+}
+
+```
+
+### Defining Component Schema
+
+Define your component's schema to control its behavior and interactivity within Weaverse Studio:
+
+```typescript
+import type { HydrogenComponentSchema } from '@weaverse/hydrogen';
+
+export let schema: HydrogenComponentSchema = {
+  title: 'Product Card',
+  type: 'product-card',
+  inspector: [
+    {
+      group: 'Settings',
+      inputs: [] // Defining input settings
+    }
+  ],
+  childTypes: ['image', 'product-title', 'price'],
+  presets: {
+    type: 'product-card',
+    children: [
+      { type: 'image' },
+      { type: 'product-title' },
+      { type: 'price' },
+    ],
+  },
+  limit: 3,
+  enabledOn: {
+    pages: ['INDEX', 'PRODUCT', 'ALL_PRODUCTS'],
+    groups: ['body'],
+  },
+  toolbar: ['general-settings', ['duplicate', 'delete']],
+};
+
+```
+
+### Customizing Input Settings
+
+Customize input settings for merchant-adjustable component configurations in Weaverse Studio:
+
+```typescript
+{
+  type: "select",
+  label: "Image aspect ratio",
+  name: "imageAspectRatio",
+  configs: {
+    options: [
+      { value: "auto", label: "Adapt to image" },
+      { value: "1/1", label: "1/1" },
+      { value: "3/4", label: "3/4" },
+      { value: "4/3", label: "4/3" },
+    ]
+  },
+  defaultValue: "auto"
+}
+
+```
+
+## Contributing
+
+Contributions to the `@weaverse/hydrogen` package are highly appreciated. Please refer to our contributing guidelines
+for more details on how to contribute effectively.
+
+## License
+
+This package is created by The Weaverse Team ([https://weaverse.io](https://weaverse.io)) and is licensed under the MIT
+License.
+