@okendo/shopify-hydrogen 1.3.0 → 2.0.0

package/dist/esnext/components/OkendoReviewsWidget.server.js

@@ -1,61 +0,0 @@
-import React from 'react';
-import { useShopQuery, gql } from '@shopify/hydrogen';
-import { OkendoWidgetClient } from '../client-components/OkendoWidget.client';
-import { widgetMetafieldError } from '../shared/errorUtils';
-import { getOkendoProductId } from '../shared/productUtils';
-import { useOkendoRequestContext } from '../shared/server/requestUtils';
-import { logger } from '../shared/logger';
-export const OkendoReviewsWidget = (props) => {
-    const { setupFailed } = useOkendoRequestContext();
-    if (setupFailed) {
-        return null;
-    }
-    return React.createElement(OkendoReviewsWidgetContent, { ...props });
-};
-const OkendoReviewsWidgetContent = ({ productId }) => {
-    const productQuery = productId
-        ? `
-            product(id: $productId) {
-                reviewsWidgetSnippet: metafield(namespace: "okendo", key: "ReviewsWidgetSnippet") {
-                    value
-                }
-            }
-        `
-        : '';
-    const query = gql `
-        query metafields${productId ? '($productId: ID!)' : ''} {
-            ${productQuery}
-            shop {
-                widgetPreRenderBodyStyleTags: metafield(namespace: "okendo", key: "WidgetPreRenderBodyStyleTags") {
-                    value
-                }
-            }
-        }
-    `;
-    const { data: { product, shop } } = useShopQuery({
-        query,
-        preload: true,
-        variables: {
-            productId
-        }
-    });
-    if (productId && !product?.reviewsWidgetSnippet?.value) {
-        logger.warn(widgetMetafieldError('OkendoReviewsWidget', 'ReviewsWidgetSnippet'));
-    }
-    if (!shop?.widgetPreRenderBodyStyleTags?.value) {
-        logger.warn(widgetMetafieldError('OkendoReviewsWidget', 'WidgetPreRenderBodyStyleTags'));
-    }
-    const dataAttributes = {
-        'data-oke-widget': ''
-    };
-    if (productId) {
-        const okendoProductId = getOkendoProductId(productId);
-        if (okendoProductId) {
-            dataAttributes['data-oke-reviews-product-id'] = okendoProductId;
-        }
-    }
-    return (React.createElement(React.Fragment, null,
-        React.createElement("div", { dangerouslySetInnerHTML: { __html: shop?.widgetPreRenderBodyStyleTags?.value ?? '' } }),
-        React.createElement(OkendoWidgetClient, { dataAttributes: dataAttributes, metafieldContent: product?.reviewsWidgetSnippet?.value ?? '' })));
-};
-export default OkendoReviewsWidget;

package/dist/esnext/components/OkendoStarRating.server.d.ts

@@ -1,4 +0,0 @@
-import { FC } from 'react';
-import type { OkendoStarRatingProps } from '../models/starRating';
-export declare const OkendoStarRating: FC<OkendoStarRatingProps>;
-export default OkendoStarRating;

package/dist/esnext/components/OkendoStarRating.server.js

@@ -1,46 +0,0 @@
-import React from 'react';
-import { useShopQuery, gql } from '@shopify/hydrogen';
-import { OkendoWidgetClient } from '../client-components/OkendoWidget.client';
-import { widgetConfigurationError, widgetMetafieldError } from '../shared/errorUtils';
-import { getOkendoProductId } from '../shared/productUtils';
-import { useOkendoRequestContext } from '../shared/server/requestUtils';
-import { logger } from '../shared/logger';
-export const OkendoStarRating = (props) => {
-    const { setupFailed } = useOkendoRequestContext();
-    if (setupFailed) {
-        return null;
-    }
-    const okendoProductId = getOkendoProductId(props.productId);
-    if (!okendoProductId) {
-        logger.error(widgetConfigurationError('OkendoStarRating', 'productId was not provided'));
-        return null;
-    }
-    return React.createElement(OkendoStarRatingContent, { ...props, okendoProductId: okendoProductId });
-};
-const OkendoStarRatingContent = ({ productId, okendoProductId }) => {
-    const query = gql `
-        query metafields($productId: ID!) {
-            product(id: $productId) {
-                starRatingSnippet: metafield(namespace: "okendo", key: "StarRatingSnippet") {
-                    value
-                }
-            }
-        }
-    `;
-    const { data: { product: { starRatingSnippet } } } = useShopQuery({
-        query,
-        preload: true,
-        variables: {
-            productId
-        }
-    });
-    if (!starRatingSnippet?.value) {
-        logger.warn(widgetMetafieldError('OkendoStarRating', 'StarRatingSnippet'));
-    }
-    const dataAttributes = {
-        'data-oke-star-rating': '',
-        'data-oke-reviews-product-id': okendoProductId
-    };
-    return (React.createElement(OkendoWidgetClient, { dataAttributes: dataAttributes, metafieldContent: starRatingSnippet?.value }));
-};
-export default OkendoStarRating;

package/dist/esnext/components/index.d.ts

@@ -1,3 +0,0 @@
-export * from './OkendoProvider.server';
-export * from './OkendoReviewsWidget.server';
-export * from './OkendoStarRating.server';

package/dist/esnext/components/index.js

@@ -1,3 +0,0 @@
-export * from './OkendoProvider.server';
-export * from './OkendoReviewsWidget.server';
-export * from './OkendoStarRating.server';

package/dist/esnext/fragments/index.d.ts

@@ -1 +0,0 @@
-export declare const OKENDO_PRODUCT_STAR_RATING_FRAGMENT: string;

package/dist/esnext/fragments/index.js

@@ -1,11 +0,0 @@
-import { gql } from '@shopify/hydrogen';
-export const OKENDO_PRODUCT_STAR_RATING_FRAGMENT = gql `
-  fragment OkendoStarRatingSnippet on Product {
-    okendoStarRatingSnippet: metafield(
-      namespace: "okendo"
-      key: "StarRatingSnippet"
-    ) {
-      value
-    }
-  }
-`;

package/dist/esnext/framework/index.js

@@ -1 +0,0 @@
-"use strict";

package/dist/esnext/framework/plugins/plugin.d.ts

@@ -1,7 +0,0 @@
-import type { Plugin } from 'vite';
-declare const okendoPlugin: {
-    (): Plugin[];
-    default: any;
-};
-export = okendoPlugin;
-export default okendoPlugin;

package/dist/esnext/framework/plugins/plugin.js

@@ -1,7 +0,0 @@
-import suppressModuleWarning from './suppressModuleWarning';
-const okendoPlugin = () => {
-    return [
-        suppressModuleWarning()
-    ];
-};
-export default okendoPlugin; // For ESM

package/dist/esnext/framework/plugins/suppressModuleWarning.d.ts

@@ -1,3 +0,0 @@
-import { Plugin } from 'vite';
-declare const _default: () => Plugin;
-export default _default;

package/dist/esnext/framework/plugins/suppressModuleWarning.js

@@ -1,18 +0,0 @@
-/* Inspired by Hydrogen 1.0.0 source hydrogen\packages\hydrogen\src\framework\plugins\vite-plugin-hydrogen-suppress-warnings.ts */
-export default () => {
-    return {
-        name: 'okendo:suppress-warnings',
-        configResolved(config) {
-            // TODO: Fix the actual issues that cause these warnings
-            const filterOut = (msg) => msg.startsWith("@okendo/shopify-hydrogen doesn't appear to be written in CJS");
-            for (const method of ['warn', 'warnOnce']) {
-                const original = config.logger[method];
-                config.logger[method] = (msg, ...args) => {
-                    if (filterOut(msg))
-                        return;
-                    return original(msg, ...args);
-                };
-            }
-        },
-    };
-};

package/dist/esnext/index.d.ts

@@ -1,4 +0,0 @@
-export * from './components';
-export * from './fragments';
-export * from './shared/server/requestUtils';
-export * from './shared/sharedTypes';

package/dist/esnext/index.js

@@ -1,4 +0,0 @@
-export * from './components';
-export * from './fragments';
-export * from './shared/server/requestUtils';
-export * from './shared/sharedTypes';

package/dist/esnext/models/starRating.d.ts

@@ -1,12 +0,0 @@
-import type { Metafield } from '@shopify/hydrogen/dist/esnext/storefront-api-types';
-export interface OkendoClientStarRatingProps extends OkendoStarRatingProps {
-    okendoStarRatingSnippet?: Pick<Metafield, 'value'>;
-}
-export interface OkendoStarRatingProps {
-    productId: string;
-}
-export interface OkendoStarRatingMetafields {
-    product: {
-        starRatingSnippet?: Pick<Metafield, 'value'>;
-    };
-}

package/dist/esnext/models/starRating.js

@@ -1 +0,0 @@
-export {};

package/dist/esnext/shared/errorUtils.d.ts

@@ -1,3 +0,0 @@
-export declare function okendoError(message: string): string;
-export declare function widgetConfigurationError(widgetName: string, message: string): string;
-export declare function widgetMetafieldError(widgetName: string, metafieldName: string): string;

package/dist/esnext/shared/errorUtils.js

@@ -1,9 +0,0 @@
-export function okendoError(message) {
-    return `Okendo: ${message}`;
-}
-export function widgetConfigurationError(widgetName, message) {
-    return okendoError(`${widgetName} error: ${message}`);
-}
-export function widgetMetafieldError(widgetName, metafieldName) {
-    return okendoError(`${widgetName} error: Failed to retrieve metafield '${metafieldName}'.`);
-}

package/dist/esnext/shared/logger.d.ts

@@ -1,14 +0,0 @@
-export declare const logger: {
-    log: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    warn: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-    error: {
-        (...data: any[]): void;
-        (message?: any, ...optionalParams: any[]): void;
-    };
-};

package/dist/esnext/shared/logger.js

@@ -1,7 +0,0 @@
-const isProduction = process.env.NODE_ENV === 'production';
-const noop = () => undefined;
-export const logger = {
-    log: isProduction ? noop : console.info,
-    warn: isProduction ? noop : console.warn,
-    error: console.error
-};

package/dist/esnext/shared/productUtils.js

@@ -1,15 +0,0 @@
-const kProductIdRegex = /^[0-9]*$/;
-/**
- * Gets the product ID with Okendo formatting.
- * @param productId The Shopify Product ID e.g. gid://shopify/Product/10079785100.
- * @returns The product ID in Okendo formatting.
- */
-export function getOkendoProductId(productId) {
-    if (!productId) {
-        return;
-    }
-    // Supports Shopify's GraphQL Id syntax e.g. gid://shopify/Product/10079785100
-    return `shopify-${kProductIdRegex.test(productId)
-        ? productId
-        : productId.split('/').slice(-1)[0]}`;
-}

package/dist/esnext/shared/server/requestUtils.d.ts

@@ -1,7 +0,0 @@
-export declare function useOkendoRequestContext(): OkendoRequestContext;
-declare type RequestContextSafeType = string | number | boolean;
-declare type RequestContext = Record<string, RequestContextSafeType>;
-export interface OkendoRequestContext extends RequestContext {
-    setupFailed: boolean;
-}
-export {};

package/dist/esnext/shared/server/requestUtils.js

@@ -1,4 +0,0 @@
-import { useRequestContext } from '@shopify/hydrogen';
-export function useOkendoRequestContext() {
-    return useRequestContext('okendo');
-}

package/dist/esnext/shared/sharedTypes.d.ts

@@ -1,5 +0,0 @@
-import type { Metafield } from '@shopify/hydrogen/dist/esnext/storefront-api-types';
-export declare type SKO = Record<string, unknown>;
-export declare type OkendoProductFragment = {
-    okendoStarRatingSnippet?: Pick<Metafield, 'value'>;
-};

package/dist/esnext/shared/sharedTypes.js

@@ -1 +0,0 @@
-export {};

package/dist/node/framework/index.js

@@ -1 +0,0 @@
-"use strict";

package/dist/node/framework/plugins/plugin.d.ts

@@ -1,4 +0,0 @@
-import type { Plugin } from 'vite';
-declare const okendoPlugin: () => Plugin[];
-export = okendoPlugin;
-export default okendoPlugin;

package/dist/node/framework/plugins/plugin.js

@@ -1,12 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const suppressModuleWarning_1 = __importDefault(require("./suppressModuleWarning"));
-const okendoPlugin = () => {
-    return [
-        (0, suppressModuleWarning_1.default)()
-    ];
-};
-exports.default = okendoPlugin; // For ESM
-module.exports = okendoPlugin;

package/dist/node/framework/plugins/suppressModuleWarning.d.ts

@@ -1,3 +0,0 @@
-import { Plugin } from 'vite';
-declare const _default: () => Plugin;
-export default _default;

package/dist/node/framework/plugins/suppressModuleWarning.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* Inspired by Hydrogen 1.0.0 source hydrogen\packages\hydrogen\src\framework\plugins\vite-plugin-hydrogen-suppress-warnings.ts */
-exports.default = () => {
-    return {
-        name: 'okendo:suppress-warnings',
-        configResolved(config) {
-            // TODO: Fix the actual issues that cause these warnings
-            const filterOut = (msg) => msg.startsWith("@okendo/shopify-hydrogen doesn't appear to be written in CJS");
-            for (const method of ['warn', 'warnOnce']) {
-                const original = config.logger[method];
-                config.logger[method] = (msg, ...args) => {
-                    if (filterOut(msg))
-                        return;
-                    return original(msg, ...args);
-                };
-            }
-        },
-    };
-};

package/plugin.cjs

@@ -1 +0,0 @@
-module.exports = require('./dist/node/framework/plugin');