@okendo/shopify-hydrogen 2.1.4 → 2.1.6
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/LICENSE.txt +3 -3
- package/README.md +881 -635
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/types/internal/OkendoWidget/OkendoWidget.d.ts +5 -1
- package/dist/cjs/types/internal/usePrevious.d.ts +1 -0
- package/dist/esm/index.js +1 -1
- package/dist/esm/types/internal/OkendoWidget/OkendoWidget.d.ts +5 -1
- package/dist/esm/types/internal/usePrevious.d.ts +1 -0
- package/package.json +47 -47
package/dist/cjs/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";var t=require("react");const e=({dataAttributes:e,metafieldContent:n=""})=>{const r=t.useRef(null),o=()=>{r.current&&window.okeWidgetApi.initWidget(r.current)};return t.useEffect((()=>(window.okeWidgetApi&&r.current?
|
|
1
|
+
"use strict";var t=require("react");const e=({dataAttributes:e,metafieldContent:n=""})=>{const r=t.useRef(null),o=function(e){const n=t.useRef();return t.useEffect((()=>{n.current=e})),n.current}(e),i=()=>{r.current&&window.okeWidgetApi.initWidget(r.current)};return t.useEffect((()=>{if(!o||e["data-oke-widget"]!==o["data-oke-widget"]||e["data-oke-star-rating"]!==o["data-oke-star-rating"]||e["data-oke-reviews-product-id"]!==o["data-oke-reviews-product-id"])return window.okeWidgetApi&&r.current?i():document.addEventListener("oke-script-loaded",i),()=>{document.removeEventListener("oke-script-loaded",i)}}),[e,o]),t.createElement("div",{ref:r,key:JSON.stringify(e),...e,dangerouslySetInnerHTML:n?{__html:n}:void 0})},n=/^[0-9]*$/;function r(t){if(t)return`shopify-${n.test(t)?t:t.split("/").slice(-1)[0]}`}exports.OKENDO_PRODUCT_REVIEWS_FRAGMENT='#graphql\n\tfragment OkendoReviewsSnippet on Product {\n\t\tokendoReviewsSnippet: metafield(\n\t\t\tnamespace: "okendo"\n\t\t\tkey: "ReviewsWidgetSnippet"\n\t\t) {\n\t\t\tvalue\n\t\t}\n\t}\n',exports.OKENDO_PRODUCT_STAR_RATING_FRAGMENT='#graphql\n\tfragment OkendoStarRatingSnippet on Product {\n\t\tokendoStarRatingSnippet: metafield(\n\t\t\tnamespace: "okendo"\n\t\t\tkey: "StarRatingSnippet"\n\t\t) {\n\t\t\tvalue\n\t\t}\n\t}\n',exports.OkendoProvider=({nonce:e="",okendoProviderData:n,productUrlFormatter:r})=>{if(!n)return null;const{reviewsHeaderConfig:o,cssVariables:i,customCss:s,initScriptContents:a,preRenderStyleTags:d,starSymbols:c}=n,l="function"==typeof r?r.toString():"string"==typeof r?r:"(product) =>\n\t\t\t\t\tproduct && product.productHandle\n\t\t\t\t\t\t? \"/products/\" + product.productHandle + \"/\" + (product.variantId ? '?variantId=' + product.variantId : '')\n\t\t\t\t\t\t: undefined",u=(i??"").replace('<style id="oke-css-vars">',"").replace("</style>",""),p=s?s.replace('<style id="oke-reviews-custom-css">',"").replace("</style>",""):"";return t.createElement(t.Fragment,null,t.createElement("script",{nonce:e,id:"oke-reviews-settings",type:"application/json",dangerouslySetInnerHTML:{__html:JSON.stringify(o)}}),t.createElement("style",{nonce:e,id:"oke-css-vars",dangerouslySetInnerHTML:{__html:u}}),p&&t.createElement("style",{nonce:e,id:"oke-reviews-custom-css",dangerouslySetInnerHTML:{__html:p}}),a&&t.createElement("script",{nonce:e,dangerouslySetInnerHTML:{__html:a}}),t.createElement("script",{nonce:e,type:"text/javascript",dangerouslySetInnerHTML:{__html:`window.okeProductUrlFormatter = ${l.toString()}`}}),d&&t.createElement("div",{dangerouslySetInnerHTML:{__html:d}}),c&&t.createElement("div",{dangerouslySetInnerHTML:{__html:c}}))},exports.OkendoReviews=({productId:n,okendoReviewsSnippet:o})=>{const i={"data-oke-widget":"","data-oke-reviews-product-id":r(n)};return t.createElement(e,{dataAttributes:i,metafieldContent:o?.value})},exports.OkendoStarRating=({productId:n,okendoStarRatingSnippet:o})=>{const i={"data-oke-star-rating":"","data-oke-reviews-product-id":r(n)};return t.createElement(e,{dataAttributes:i,metafieldContent:o?.value})},exports.getOkendoProviderData=async({context:t,subscriberId:e,apiDomain:n,cdnDomain:r})=>{const o=`https://${n||"api.okendo.io/v1"}/stores/${e}/widget_plus_settings`,i=await fetch(o);if(!i.ok)return console.error(`Failed to retrieve subscriber settings for subscriber ID '${e}'.`),null;const{reviewsHeaderConfig:s,cssVariables:a,customCss:d,starSymbols:c}=await i.json(),l=await fetch(`https://${r||"cdn-static.okendo.io"}/reviews-widget-plus/js/okendo-reviews.js`);if(!l.ok)return console.error("Failed to retrieve widget initialisation script."),null;const u=await l.text(),{shop:{widgetPreRenderStyleTags:p}}=await t.storefront.query('#graphql\n\t\tquery metafields {\n\t\t\tshop {\n\t\t\t\twidgetPreRenderStyleTags: metafield(\n\t\t\t\t\tnamespace: "okendo"\n\t\t\t\t\tkey: "WidgetPreRenderStyleTags"\n\t\t\t\t) {\n\t\t\t\t\tvalue\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t'),g=p?.value??"";return g||console.warn("Failed to retrieve pre-rendered widget style settings."),{reviewsHeaderConfig:s,cssVariables:a,customCss:d,initScriptContents:u,preRenderStyleTags:g,starSymbols:c}};
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import type { ReviewsWidgetPlus } from "@okendo/reviews-widget-plus/dist-utils/ReviewsWidgetPlus";
|
|
2
2
|
import { type FC } from "react";
|
|
3
3
|
export interface OkendoWidgetProps {
|
|
4
|
-
dataAttributes:
|
|
4
|
+
dataAttributes: {
|
|
5
|
+
"data-oke-widget"?: string;
|
|
6
|
+
"data-oke-star-rating"?: string;
|
|
7
|
+
"data-oke-reviews-product-id": string | undefined;
|
|
8
|
+
};
|
|
5
9
|
metafieldContent?: string;
|
|
6
10
|
}
|
|
7
11
|
declare global {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function usePrevious<T>(newValue: T): T | undefined;
|
package/dist/esm/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import t,{useRef as e,useEffect as n}from"react";const r=async({context:t,subscriberId:e,apiDomain:n,cdnDomain:r})=>{const o=`https://${n||"api.okendo.io/v1"}/stores/${e}/widget_plus_settings`,i=await fetch(o);if(!i.ok)return console.error(`Failed to retrieve subscriber settings for subscriber ID '${e}'.`),null;const{reviewsHeaderConfig:
|
|
1
|
+
import t,{useRef as e,useEffect as n}from"react";const r=async({context:t,subscriberId:e,apiDomain:n,cdnDomain:r})=>{const o=`https://${n||"api.okendo.io/v1"}/stores/${e}/widget_plus_settings`,i=await fetch(o);if(!i.ok)return console.error(`Failed to retrieve subscriber settings for subscriber ID '${e}'.`),null;const{reviewsHeaderConfig:a,cssVariables:s,customCss:d,starSymbols:c}=await i.json(),l=await fetch(`https://${r||"cdn-static.okendo.io"}/reviews-widget-plus/js/okendo-reviews.js`);if(!l.ok)return console.error("Failed to retrieve widget initialisation script."),null;const u=await l.text(),{shop:{widgetPreRenderStyleTags:p}}=await t.storefront.query('#graphql\n\t\tquery metafields {\n\t\t\tshop {\n\t\t\t\twidgetPreRenderStyleTags: metafield(\n\t\t\t\t\tnamespace: "okendo"\n\t\t\t\t\tkey: "WidgetPreRenderStyleTags"\n\t\t\t\t) {\n\t\t\t\t\tvalue\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t'),g=p?.value??"";return g||console.warn("Failed to retrieve pre-rendered widget style settings."),{reviewsHeaderConfig:a,cssVariables:s,customCss:d,initScriptContents:u,preRenderStyleTags:g,starSymbols:c}},o=({nonce:e="",okendoProviderData:n,productUrlFormatter:r})=>{if(!n)return null;const{reviewsHeaderConfig:o,cssVariables:i,customCss:a,initScriptContents:s,preRenderStyleTags:d,starSymbols:c}=n,l="function"==typeof r?r.toString():"string"==typeof r?r:"(product) =>\n\t\t\t\t\tproduct && product.productHandle\n\t\t\t\t\t\t? \"/products/\" + product.productHandle + \"/\" + (product.variantId ? '?variantId=' + product.variantId : '')\n\t\t\t\t\t\t: undefined",u=(i??"").replace('<style id="oke-css-vars">',"").replace("</style>",""),p=a?a.replace('<style id="oke-reviews-custom-css">',"").replace("</style>",""):"";return t.createElement(t.Fragment,null,t.createElement("script",{nonce:e,id:"oke-reviews-settings",type:"application/json",dangerouslySetInnerHTML:{__html:JSON.stringify(o)}}),t.createElement("style",{nonce:e,id:"oke-css-vars",dangerouslySetInnerHTML:{__html:u}}),p&&t.createElement("style",{nonce:e,id:"oke-reviews-custom-css",dangerouslySetInnerHTML:{__html:p}}),s&&t.createElement("script",{nonce:e,dangerouslySetInnerHTML:{__html:s}}),t.createElement("script",{nonce:e,type:"text/javascript",dangerouslySetInnerHTML:{__html:`window.okeProductUrlFormatter = ${l.toString()}`}}),d&&t.createElement("div",{dangerouslySetInnerHTML:{__html:d}}),c&&t.createElement("div",{dangerouslySetInnerHTML:{__html:c}}))};const i=({dataAttributes:r,metafieldContent:o=""})=>{const i=e(null),a=function(t){const r=e();return n((()=>{r.current=t})),r.current}(r),s=()=>{i.current&&window.okeWidgetApi.initWidget(i.current)};return n((()=>{if(!a||r["data-oke-widget"]!==a["data-oke-widget"]||r["data-oke-star-rating"]!==a["data-oke-star-rating"]||r["data-oke-reviews-product-id"]!==a["data-oke-reviews-product-id"])return window.okeWidgetApi&&i.current?s():document.addEventListener("oke-script-loaded",s),()=>{document.removeEventListener("oke-script-loaded",s)}}),[r,a]),t.createElement("div",{ref:i,key:JSON.stringify(r),...r,dangerouslySetInnerHTML:o?{__html:o}:void 0})},a=/^[0-9]*$/;function s(t){if(t)return`shopify-${a.test(t)?t:t.split("/").slice(-1)[0]}`}const d=({productId:e,okendoReviewsSnippet:n})=>{const r={"data-oke-widget":"","data-oke-reviews-product-id":s(e)};return t.createElement(i,{dataAttributes:r,metafieldContent:n?.value})},c=({productId:e,okendoStarRatingSnippet:n})=>{const r={"data-oke-star-rating":"","data-oke-reviews-product-id":s(e)};return t.createElement(i,{dataAttributes:r,metafieldContent:n?.value})},l='#graphql\n\tfragment OkendoStarRatingSnippet on Product {\n\t\tokendoStarRatingSnippet: metafield(\n\t\t\tnamespace: "okendo"\n\t\t\tkey: "StarRatingSnippet"\n\t\t) {\n\t\t\tvalue\n\t\t}\n\t}\n',u='#graphql\n\tfragment OkendoReviewsSnippet on Product {\n\t\tokendoReviewsSnippet: metafield(\n\t\t\tnamespace: "okendo"\n\t\t\tkey: "ReviewsWidgetSnippet"\n\t\t) {\n\t\t\tvalue\n\t\t}\n\t}\n';export{u as OKENDO_PRODUCT_REVIEWS_FRAGMENT,l as OKENDO_PRODUCT_STAR_RATING_FRAGMENT,o as OkendoProvider,d as OkendoReviews,c as OkendoStarRating,r as getOkendoProviderData};
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import type { ReviewsWidgetPlus } from "@okendo/reviews-widget-plus/dist-utils/ReviewsWidgetPlus";
|
|
2
2
|
import { type FC } from "react";
|
|
3
3
|
export interface OkendoWidgetProps {
|
|
4
|
-
dataAttributes:
|
|
4
|
+
dataAttributes: {
|
|
5
|
+
"data-oke-widget"?: string;
|
|
6
|
+
"data-oke-star-rating"?: string;
|
|
7
|
+
"data-oke-reviews-product-id": string | undefined;
|
|
8
|
+
};
|
|
5
9
|
metafieldContent?: string;
|
|
6
10
|
}
|
|
7
11
|
declare global {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function usePrevious<T>(newValue: T): T | undefined;
|
package/package.json
CHANGED
|
@@ -1,47 +1,47 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@okendo/shopify-hydrogen",
|
|
3
|
-
"version": "2.1.
|
|
4
|
-
"description": "Okendo React components for Shopify Hydrogen 2 (Remix)",
|
|
5
|
-
"author": "Okendo",
|
|
6
|
-
"license": "SEE LICENSE IN LICENSE.txt",
|
|
7
|
-
"engines": {
|
|
8
|
-
"node": ">=16.14"
|
|
9
|
-
},
|
|
10
|
-
"main": "dist/cjs/index.js",
|
|
11
|
-
"module": "dist/esm/index.js",
|
|
12
|
-
"files": [
|
|
13
|
-
"dist"
|
|
14
|
-
],
|
|
15
|
-
"types": "dist/index.d.ts",
|
|
16
|
-
"scripts": {
|
|
17
|
-
"build": "npm run eslint -- --max-warnings=0 && rimraf dist && rollup -c",
|
|
18
|
-
"prepack": "npm run build",
|
|
19
|
-
"eslint": "eslint src"
|
|
20
|
-
},
|
|
21
|
-
"devDependencies": {
|
|
22
|
-
"@okendo/reviews-common": "^5.163.1",
|
|
23
|
-
"@okendo/reviews-widget-plus": "^0.68.3",
|
|
24
|
-
"@okendo/tsconfig": "0.0.2",
|
|
25
|
-
"@rollup/plugin-commonjs": "^25.0.7",
|
|
26
|
-
"@rollup/plugin-node-resolve": "^15.2.3",
|
|
27
|
-
"@rollup/plugin-terser": "^0.4.4",
|
|
28
|
-
"@rollup/plugin-typescript": "^11.1.5",
|
|
29
|
-
"@types/react": "^18.2.45",
|
|
30
|
-
"@types/react-dom": "^18.2.18",
|
|
31
|
-
"@typescript-eslint/eslint-plugin": "^6.15.0",
|
|
32
|
-
"@typescript-eslint/parser": "^6.15.0",
|
|
33
|
-
"eslint": "^8.56.0",
|
|
34
|
-
"eslint-plugin-react": "^7.33.2",
|
|
35
|
-
"eslint-plugin-react-hooks": "^4.6.0",
|
|
36
|
-
"rimraf": "^5.0.5",
|
|
37
|
-
"rollup": "^4.9.1",
|
|
38
|
-
"rollup-plugin-dts": "^6.1.0",
|
|
39
|
-
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
40
|
-
"typescript": "^5.3.3"
|
|
41
|
-
},
|
|
42
|
-
"peerDependencies": {
|
|
43
|
-
"@shopify/hydrogen": "*",
|
|
44
|
-
"@shopify/remix-oxygen": "*",
|
|
45
|
-
"react": "^18.2.0"
|
|
46
|
-
}
|
|
47
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@okendo/shopify-hydrogen",
|
|
3
|
+
"version": "2.1.6",
|
|
4
|
+
"description": "Okendo React components for Shopify Hydrogen 2 (Remix)",
|
|
5
|
+
"author": "Okendo",
|
|
6
|
+
"license": "SEE LICENSE IN LICENSE.txt",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": ">=16.14"
|
|
9
|
+
},
|
|
10
|
+
"main": "dist/cjs/index.js",
|
|
11
|
+
"module": "dist/esm/index.js",
|
|
12
|
+
"files": [
|
|
13
|
+
"dist"
|
|
14
|
+
],
|
|
15
|
+
"types": "dist/index.d.ts",
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "npm run eslint -- --max-warnings=0 && rimraf dist && rollup -c",
|
|
18
|
+
"prepack": "npm run build",
|
|
19
|
+
"eslint": "eslint src"
|
|
20
|
+
},
|
|
21
|
+
"devDependencies": {
|
|
22
|
+
"@okendo/reviews-common": "^5.163.1",
|
|
23
|
+
"@okendo/reviews-widget-plus": "^0.68.3",
|
|
24
|
+
"@okendo/tsconfig": "0.0.2",
|
|
25
|
+
"@rollup/plugin-commonjs": "^25.0.7",
|
|
26
|
+
"@rollup/plugin-node-resolve": "^15.2.3",
|
|
27
|
+
"@rollup/plugin-terser": "^0.4.4",
|
|
28
|
+
"@rollup/plugin-typescript": "^11.1.5",
|
|
29
|
+
"@types/react": "^18.2.45",
|
|
30
|
+
"@types/react-dom": "^18.2.18",
|
|
31
|
+
"@typescript-eslint/eslint-plugin": "^6.15.0",
|
|
32
|
+
"@typescript-eslint/parser": "^6.15.0",
|
|
33
|
+
"eslint": "^8.56.0",
|
|
34
|
+
"eslint-plugin-react": "^7.33.2",
|
|
35
|
+
"eslint-plugin-react-hooks": "^4.6.0",
|
|
36
|
+
"rimraf": "^5.0.5",
|
|
37
|
+
"rollup": "^4.9.1",
|
|
38
|
+
"rollup-plugin-dts": "^6.1.0",
|
|
39
|
+
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
40
|
+
"typescript": "^5.3.3"
|
|
41
|
+
},
|
|
42
|
+
"peerDependencies": {
|
|
43
|
+
"@shopify/hydrogen": "*",
|
|
44
|
+
"@shopify/remix-oxygen": "*",
|
|
45
|
+
"react": "^18.2.0"
|
|
46
|
+
}
|
|
47
|
+
}
|