@shopify/hydrogen 0.15.0 → 0.17.0

package/dist/esnext/storefront-api-types.js

@@ -170,7 +170,13 @@ export var CollectionSortKeys;
     /** Sort by the `updated_at` value. */
     CollectionSortKeys["UpdatedAt"] = "UPDATED_AT";
 })(CollectionSortKeys || (CollectionSortKeys = {}));
-/** ISO 3166-1 alpha-2 country codes with some differences. */
+/**
+ * The code designating a country, which generally follows ISO 3166-1 alpha-2 guidelines.
+ * If a territory doesn't have a country code value in the `CountryCode` enum, it might be considered a subdivision
+ * of another country. For example, the territories associated with Spain are represented by the country code `ES`,
+ * and the territories associated with the United States of America are represented by the country code `US`.
+ *
+ */
 export var CountryCode;
 (function (CountryCode) {
     /** Ascension Island. */
@@ -1101,7 +1107,13 @@ export var DiscountApplicationTargetType;
     /** The discount applies onto shipping lines. */
     DiscountApplicationTargetType["ShippingLine"] = "SHIPPING_LINE";
 })(DiscountApplicationTargetType || (DiscountApplicationTargetType = {}));
-/** Denotes the type of data this filter group represents. */
+/**
+ * The type of data that the filter group represents.
+ *
+ * For more information, refer to [Filter products in a collection with the Storefront API]
+ * (https://shopify.dev/api/examples/filter-products).
+ *
+ */
 export var FilterType;
 (function (FilterType) {
     /** A boolean value. */

package/dist/esnext/types.d.ts

@@ -4,6 +4,7 @@ import type { Logger } from './utilities/log/log';
 import type { ServerComponentRequest } from './framework/Hydration/ServerComponentRequest.server';
 import type { ServerComponentResponse } from './framework/Hydration/ServerComponentResponse.server';
 import type { Metafield, ProductVariant, Product, MediaImage } from './storefront-api-types';
+import type { SessionStorageAdapter } from './foundation/session/session';
 declare type CommonOptions = {
     App: any;
     routes?: ImportGlobEagerOutput;
@@ -42,6 +43,7 @@ export declare type ServerHandlerConfig = {
     routes?: ImportGlobEagerOutput;
     shopifyConfig: ShopifyConfig;
     serverAnalyticsConnectors?: Array<ServerAnalyticsConnector>;
+    session?: (log: Logger) => SessionStorageAdapter;
 };
 export declare type ClientHandlerConfig = {
     shopifyConfig: ShopifyConfig;

package/dist/esnext/utilities/apiRoutes.d.ts

@@ -1,9 +1,12 @@
 import { ImportGlobEagerOutput, ShopifyConfig } from '../types';
+import type { ServerComponentRequest } from '../framework/Hydration/ServerComponentRequest.server';
 import type { ASTNode } from 'graphql';
+import { SessionApi, SessionStorageAdapter } from '../foundation/session/session';
 declare type RouteParams = Record<string, string>;
 declare type RequestOptions = {
     params: RouteParams;
     queryShop: (args: QueryShopArgs) => Promise<any>;
+    session: SessionApi | null;
 };
 declare type ResourceGetter = (request: Request, requestOptions: RequestOptions) => Promise<Response | Object | String>;
 interface HydrogenApiRoute {
@@ -29,8 +32,6 @@ interface QueryShopArgs {
     query: ASTNode | string;
     /** An object of the variables for the GraphQL query. */
     variables?: Record<string, any>;
-    /** A string corresponding to a valid locale identifier like `en-us` used to make the request. */
-    locale?: string;
 }
-export declare function renderApiRoute(request: Request, route: ApiRouteMatch, shopifyConfig: ShopifyConfig): Promise<Response | Request>;
+export declare function renderApiRoute(request: ServerComponentRequest, route: ApiRouteMatch, shopifyConfig: ShopifyConfig, session?: SessionStorageAdapter): Promise<Response | Request>;
 export {};

package/dist/esnext/utilities/apiRoutes.js

@@ -1,6 +1,8 @@
 import { matchPath } from './matchPath';
 import { getLoggerWithContext, logServerResponse } from '../utilities/log/';
 import { fetchBuilder, graphqlRequestBody } from './fetch';
+import { getStorefrontApiRequestHeaders } from './storefrontApi';
+import { emptySessionImplementation, } from '../foundation/session/session';
 let memoizedRoutes = [];
 let memoizedPages = {};
 export function getApiRoutes(pages, topLevelPath = '*') {
@@ -64,30 +66,49 @@ export function getApiRouteFromURL(url, routes) {
         hasServerComponent: foundRoute.hasServerComponent,
     };
 }
-function queryShopBuilder(shopifyConfig) {
-    return async function queryShop({ query, variables, locale, }) {
-        var _a;
-        const { storeDomain, storefrontApiVersion, storefrontToken, defaultLocale } = shopifyConfig;
+function queryShopBuilder(shopifyConfig, request) {
+    return async function queryShop({ query, variables, }) {
+        const { storeDomain, storefrontApiVersion, storefrontToken } = shopifyConfig;
+        const buyerIp = request.getBuyerIp();
+        const extraHeaders = getStorefrontApiRequestHeaders({
+            buyerIp,
+            storefrontToken,
+        });
         const fetcher = fetchBuilder(`https://${storeDomain}/api/${storefrontApiVersion}/graphql.json`, {
             method: 'POST',
             body: graphqlRequestBody(query, variables),
             headers: {
-                'X-Shopify-Storefront-Access-Token': storefrontToken,
-                'Accept-Language': (_a = locale) !== null && _a !== void 0 ? _a : defaultLocale,
                 'Content-Type': 'application/json',
+                ...extraHeaders,
             },
         });
         return await fetcher();
     };
 }
-export async function renderApiRoute(request, route, shopifyConfig) {
+export async function renderApiRoute(request, route, shopifyConfig, session) {
     var _a;
     let response;
     const log = getLoggerWithContext(request);
+    let cookieToSet = '';
     try {
         response = await route.resource(request, {
             params: route.params,
-            queryShop: queryShopBuilder(shopifyConfig),
+            queryShop: queryShopBuilder(shopifyConfig, request),
+            session: session
+                ? {
+                    async get() {
+                        return session.get(request);
+                    },
+                    async set(key, value) {
+                        const data = await session.get(request);
+                        data[key] = value;
+                        cookieToSet = await session.set(request, data);
+                    },
+                    async destroy() {
+                        cookieToSet = await session.destroy(request);
+                    },
+                }
+                : emptySessionImplementation(log),
         });
         if (!(response instanceof Response || response instanceof Request)) {
             if (typeof response === 'string' || response instanceof String) {
@@ -101,6 +122,12 @@ export async function renderApiRoute(request, route, shopifyConfig) {
                 });
             }
         }
+        if (!response) {
+            response = new Response(null);
+        }
+        if (cookieToSet) {
+            response.headers.set('Set-Cookie', cookieToSet);
+        }
     }
     catch (e) {
         log.error(e);

package/dist/esnext/utilities/flattenConnection/flattenConnection.d.ts

@@ -1,6 +1,6 @@
 import type { GraphQLConnection } from '../../types';
 import type { PartialDeep } from 'type-fest';
 /**
- * The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](/api/storefront/reference/products/product)) into a flat array of nodes.
+ * The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](https://shopify.dev/api/storefront/reference/products/product)) into a flat array of nodes.
  */
 export declare function flattenConnection<T>(connection: PartialDeep<GraphQLConnection<T>>): PartialDeep<T>[];

package/dist/esnext/utilities/flattenConnection/flattenConnection.js

@@ -1,5 +1,5 @@
 /**
- * The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](/api/storefront/reference/products/product)) into a flat array of nodes.
+ * The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](https://shopify.dev/api/storefront/reference/products/product)) into a flat array of nodes.
  */
 export function flattenConnection(connection) {
     return (connection.edges || []).map((edge) => {

package/dist/esnext/utilities/parseMetafieldValue/parseMetafieldValue.d.ts

@@ -1,6 +1,6 @@
 import type { Metafield } from '../../storefront-api-types';
 import type { PartialDeep } from 'type-fest';
 /**
- * The `parseMetafieldValue` function parses a [Metafield](/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](/api/storefront/reference/common-objects/metafield)'s `type`.
+ * The `parseMetafieldValue` function parses a [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `type`.
  */
 export declare function parseMetafieldValue(metafield: PartialDeep<Metafield>): any;

package/dist/esnext/utilities/parseMetafieldValue/parseMetafieldValue.js

@@ -1,5 +1,5 @@
 /**
- * The `parseMetafieldValue` function parses a [Metafield](/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](/api/storefront/reference/common-objects/metafield)'s `type`.
+ * The `parseMetafieldValue` function parses a [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `type`.
  */
 export function parseMetafieldValue(metafield) {
     if (metafield.value == null) {

package/dist/esnext/utilities/storefrontApi.d.ts

@@ -0,0 +1,4 @@
+export declare function getStorefrontApiRequestHeaders({ buyerIp, storefrontToken, }: {
+    buyerIp?: string | null;
+    storefrontToken: string;
+}): Record<string, any>;

package/dist/esnext/utilities/storefrontApi.js

@@ -0,0 +1,21 @@
+import { OXYGEN_SECRET_TOKEN_ENVIRONMENT_VARIABLE, STOREFRONT_API_SECRET_TOKEN_HEADER, STOREFRONT_API_PUBLIC_TOKEN_HEADER, STOREFRONT_API_BUYER_IP_HEADER, } from '../constants';
+export function getStorefrontApiRequestHeaders({ buyerIp, storefrontToken, }) {
+    var _a;
+    const headers = {};
+    const secretToken = typeof Oxygen !== 'undefined'
+        ? (_a = Oxygen === null || Oxygen === void 0 ? void 0 : Oxygen.env) === null || _a === void 0 ? void 0 : _a[OXYGEN_SECRET_TOKEN_ENVIRONMENT_VARIABLE]
+        : null;
+    /**
+     * Only pass one type of storefront token at a time.
+     */
+    if (secretToken) {
+        headers[STOREFRONT_API_SECRET_TOKEN_HEADER] = secretToken;
+    }
+    else {
+        headers[STOREFRONT_API_PUBLIC_TOKEN_HEADER] = storefrontToken;
+    }
+    if (buyerIp) {
+        headers[STOREFRONT_API_BUYER_IP_HEADER] = buyerIp;
+    }
+    return headers;
+}

package/dist/esnext/version.d.ts

@@ -1 +1 @@
-export declare const LIB_VERSION = "0.15.0";
+export declare const LIB_VERSION = "0.17.0";

package/dist/esnext/version.js

@@ -1 +1 @@
-export const LIB_VERSION = '0.15.0';
+export const LIB_VERSION = '0.17.0';

package/dist/node/constants.d.ts

@@ -1,3 +1,7 @@
 export declare const RSC_PATHNAME = "/__rsc";
 export declare const EVENT_PATHNAME = "/__event";
 export declare const EVENT_PATHNAME_REGEX: RegExp;
+export declare const OXYGEN_SECRET_TOKEN_ENVIRONMENT_VARIABLE = "SHOPIFY_STOREFRONT_API_SECRET_TOKEN";
+export declare const STOREFRONT_API_SECRET_TOKEN_HEADER = "Shopify-Storefront-Private-Token";
+export declare const STOREFRONT_API_PUBLIC_TOKEN_HEADER = "X-Shopify-Storefront-Access-Token";
+export declare const STOREFRONT_API_BUYER_IP_HEADER = "Shopify-Storefront-Buyer-IP";

package/dist/node/constants.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVENT_PATHNAME_REGEX = exports.EVENT_PATHNAME = exports.RSC_PATHNAME = void 0;
+exports.STOREFRONT_API_BUYER_IP_HEADER = exports.STOREFRONT_API_PUBLIC_TOKEN_HEADER = exports.STOREFRONT_API_SECRET_TOKEN_HEADER = exports.OXYGEN_SECRET_TOKEN_ENVIRONMENT_VARIABLE = exports.EVENT_PATHNAME_REGEX = exports.EVENT_PATHNAME = exports.RSC_PATHNAME = void 0;
 exports.RSC_PATHNAME = '/__rsc';
 exports.EVENT_PATHNAME = '/__event';
 exports.EVENT_PATHNAME_REGEX = new RegExp(`^${exports.EVENT_PATHNAME}\/`);
+exports.OXYGEN_SECRET_TOKEN_ENVIRONMENT_VARIABLE = 'SHOPIFY_STOREFRONT_API_SECRET_TOKEN';
+exports.STOREFRONT_API_SECRET_TOKEN_HEADER = 'Shopify-Storefront-Private-Token';
+exports.STOREFRONT_API_PUBLIC_TOKEN_HEADER = 'X-Shopify-Storefront-Access-Token';
+exports.STOREFRONT_API_BUYER_IP_HEADER = 'Shopify-Storefront-Buyer-IP';

package/dist/node/entry-server.d.ts

@@ -19,5 +19,5 @@ interface RequestHandlerOptions {
 export interface RequestHandler {
     (request: Request | IncomingMessage, options: RequestHandlerOptions): Promise<Response | undefined>;
 }
-export declare const renderHydrogen: (App: any, { shopifyConfig, routes, serverAnalyticsConnectors }: ServerHandlerConfig) => RequestHandler;
+export declare const renderHydrogen: (App: any, { shopifyConfig, routes, serverAnalyticsConnectors, session, }: ServerHandlerConfig) => RequestHandler;
 export default renderHydrogen;

package/dist/node/entry-server.js

@@ -33,7 +33,7 @@ const ServerComponentResponse_server_1 = require("./framework/Hydration/ServerCo
 const ServerComponentRequest_server_1 = require("./framework/Hydration/ServerComponentRequest.server");
 const ServerRequestProvider_1 = require("./foundation/ServerRequestProvider");
 const apiRoutes_1 = require("./utilities/apiRoutes");
-const ServerStateProvider_1 = require("./foundation/ServerStateProvider");
+const ServerPropsProvider_1 = require("./foundation/ServerPropsProvider");
 const bot_ua_1 = require("./utilities/bot-ua");
 const runtime_1 = require("./framework/runtime");
 const config_1 = require("./framework/config");
@@ -42,17 +42,20 @@ const constants_1 = require("./constants");
 const template_1 = require("./utilities/template");
 const Analytics_server_1 = require("./foundation/Analytics/Analytics.server");
 const ServerAnalyticsRoute_server_1 = require("./foundation/Analytics/ServerAnalyticsRoute.server");
+const session_1 = require("./foundation/session/session");
 const DOCTYPE = '<!DOCTYPE html>';
 const CONTENT_TYPE = 'Content-Type';
 const HTML_CONTENT_TYPE = 'text/html; charset=UTF-8';
-const renderHydrogen = (App, { shopifyConfig, routes, serverAnalyticsConnectors }) => {
+const renderHydrogen = (App, { shopifyConfig, routes, serverAnalyticsConnectors, session, }) => {
     const handleRequest = async function (rawRequest, options) {
         const { indexTemplate, streamableResponse, dev, cache, context, nonce, buyerIpHeader, } = options;
         const request = new ServerComponentRequest_server_1.ServerComponentRequest(rawRequest);
         request.ctx.buyerIpHeader = buyerIpHeader;
         const url = new URL(request.url);
         const log = (0, log_1.getLoggerWithContext)(request);
+        const sessionApi = session ? session(log) : undefined;
         const componentResponse = new ServerComponentResponse_server_1.ServerComponentResponse();
+        request.ctx.session = (0, session_1.getSyncSessionApi)(request, componentResponse, log, sessionApi);
         /**
          * Inject the cache & context into the module loader so we can pull it out for subrequests.
          */
@@ -70,7 +73,7 @@ const renderHydrogen = (App, { shopifyConfig, routes, serverAnalyticsConnectors
             // If it does, only render the API route if the request method is GET
             if (apiRoute &&
                 (!apiRoute.hasServerComponent || request.method !== 'GET')) {
-                const apiResponse = await (0, apiRoutes_1.renderApiRoute)(request, apiRoute, shopifyConfig);
+                const apiResponse = await (0, apiRoutes_1.renderApiRoute)(request, apiRoute, shopifyConfig, sessionApi);
                 return apiResponse instanceof Request
                     ? handleRequest(apiResponse, options)
                     : apiResponse;
@@ -158,7 +161,11 @@ async function render(url, { App, routes, request, componentResponse, log, templ
     headers[CONTENT_TYPE] = HTML_CONTENT_TYPE;
     html = (0, Html_1.applyHtmlHead)(html, request.ctx.head, template);
     if (flight) {
-        html = html.replace('</body>', `${flightContainer({ init: true, nonce, chunk: flight })}</body>`);
+        html = html.replace('</body>', () => `${flightContainer({
+            init: true,
+            nonce,
+            chunk: flight,
+        })}</body>`);
     }
     postRequestTasks('ssr', status, request, componentResponse);
     return new Response(html, {
@@ -437,7 +444,7 @@ function buildAppSSR({ App, state, request, response, log, routes }, htmlOptions
     const RscConsumer = () => rscResponse.readRoot();
     const AppSSR = (react_1.default.createElement(Html_1.Html, { ...htmlOptions },
         react_1.default.createElement(ServerRequestProvider_1.ServerRequestProvider, { request: request, isRSC: false },
-            react_1.default.createElement(ServerStateProvider_1.ServerStateProvider, { serverState: state, setServerState: () => { } },
+            react_1.default.createElement(ServerPropsProvider_1.ServerPropsProvider, { initialServerProps: state, setServerPropsForRsc: () => { } },
                 react_1.default.createElement(PreloadQueries, { request: request },
                     react_1.default.createElement(react_1.Suspense, { fallback: null },
                         react_1.default.createElement(RscConsumer, null)),

package/dist/node/foundation/Analytics/Analytics.server.js

@@ -1,13 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Analytics = void 0;
-const react_1 = __importDefault(require("react"));
+const React = __importStar(require("react"));
 const hook_1 = require("./hook");
 const Analytics_client_1 = require("./Analytics.client");
 const ServerRequestProvider_1 = require("../ServerRequestProvider");
+const AnalyticsErrorBoundary_client_1 = __importDefault(require("../AnalyticsErrorBoundary.client"));
 const DELAY_KEY = 'analytics-delay';
 function Analytics() {
     const cache = (0, ServerRequestProvider_1.useServerRequest)().ctx.cache;
@@ -40,6 +64,7 @@ function Analytics() {
         }
     });
     const analyticsData = (0, hook_1.useServerAnalytics)();
-    return react_1.default.createElement(Analytics_client_1.Analytics, { analyticsDataFromServer: analyticsData });
+    return (React.createElement(AnalyticsErrorBoundary_client_1.default, null,
+        React.createElement(Analytics_client_1.Analytics, { analyticsDataFromServer: analyticsData })));
 }
 exports.Analytics = Analytics;

package/dist/node/foundation/AnalyticsErrorBoundary.client.d.ts

@@ -0,0 +1,4 @@
+import type { ReactNode } from 'react';
+export default function AnalyticsErrorBoundary({ children, }: {
+    children: ReactNode;
+}): JSX.Element;

package/dist/node/foundation/AnalyticsErrorBoundary.client.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const react_error_boundary_1 = require("react-error-boundary");
+function AnalyticsErrorBoundary({ children, }) {
+    // Analytics fail to load, most likely due to an ad blocker
+    return (react_1.default.createElement(react_error_boundary_1.ErrorBoundary, { fallbackRender: () => {
+            return null;
+        } }, children));
+}
+exports.default = AnalyticsErrorBoundary;

package/dist/node/foundation/Router/BrowserRouter.client.js

@@ -27,7 +27,7 @@ exports.useLocation = exports.useRouter = exports.BrowserRouter = exports.Router
 const history_1 = require("history");
 const react_1 = __importStar(require("react"));
 const ssr_interop_1 = require("../ssr-interop");
-const useServerState_1 = require("../useServerState");
+const use_server_props_1 = require("../useServerProps/use-server-props");
 exports.RouterContext = (0, react_1.createContext)({});
 let isFirstLoad = true;
 const positions = {};
@@ -36,12 +36,12 @@ const BrowserRouter = ({ history: pHistory, children, }) => {
         return react_1.default.createElement(react_1.default.Fragment, null, children);
     const history = (0, react_1.useMemo)(() => pHistory || (0, history_1.createBrowserHistory)(), [pHistory]);
     const [location, setLocation] = (0, react_1.useState)(history.location);
-    const { pending, serverState, setServerState } = (0, useServerState_1.useServerState)();
-    useScrollRestoration(location, pending, serverState);
+    const { pending, locationServerProps, setLocationServerProps } = (0, use_server_props_1.useInternalServerProps)();
+    useScrollRestoration(location, pending, locationServerProps);
     (0, react_1.useLayoutEffect)(() => {
         const unlisten = history.listen(({ location: newLocation }) => {
             positions[location.key] = window.scrollY;
-            setServerState({
+            setLocationServerProps({
                 pathname: newLocation.pathname,
                 search: location.search,
             });
@@ -78,7 +78,7 @@ function useBeforeUnload(callback) {
         };
     }, [callback]);
 }
-function useScrollRestoration(location, pending, serverState) {
+function useScrollRestoration(location, pending, serverProps) {
     /**
      * Browsers have an API for scroll restoration. We wait for the page to load first,
      * in case the browser is able to restore scroll position automatically, and then
@@ -106,8 +106,8 @@ function useScrollRestoration(location, pending, serverState) {
          * location pointer and serverState match, and pending is false, to do any scrolling.
          */
         const finishedNavigating = !pending &&
-            location.pathname === serverState.pathname &&
-            location.search === serverState.search;
+            location.pathname === serverProps.pathname &&
+            location.search === serverProps.search;
         if (!finishedNavigating) {
             return;
         }
@@ -126,5 +126,5 @@ function useScrollRestoration(location, pending, serverState) {
         }
         // Scroll to the top of new pages
         window.scrollTo(0, 0);
-    }, [location, pending, serverState]);
+    }, [location, pending, serverProps]);
 }

package/dist/node/foundation/ServerPropsProvider/ServerPropsProvider.d.ts

@@ -0,0 +1,40 @@
+import React, { ReactNode } from 'react';
+declare global {
+    var __DEV__: boolean;
+}
+export interface LocationServerProps {
+    pathname: string;
+    search: string;
+}
+export interface ServerProps {
+    [key: string]: any;
+}
+declare type ServerPropsSetterInput = ((prev: ServerProps) => Partial<ServerProps>) | Partial<ServerProps> | string;
+export interface ServerPropsSetter {
+    (input: ServerPropsSetterInput, propValue?: any): void;
+}
+interface ProposedServerPropsSetter {
+    (input: ServerPropsSetterInput, propValue?: any): LocationServerProps;
+}
+interface BaseServerPropsContextValue {
+    pending: boolean;
+}
+export interface InternalServerPropsContextValue extends BaseServerPropsContextValue {
+    setLocationServerProps: ServerPropsSetter;
+    setServerProps: ServerPropsSetter;
+    serverProps: ServerProps;
+    locationServerProps: LocationServerProps;
+    getProposedLocationServerProps: ProposedServerPropsSetter;
+}
+export interface ServerPropsContextValue extends BaseServerPropsContextValue {
+    serverProps: ServerProps;
+    setServerProps: ServerPropsSetter;
+}
+export declare const ServerPropsContext: React.Context<InternalServerPropsContextValue>;
+interface ServerPropsProviderProps {
+    initialServerProps: LocationServerProps;
+    setServerPropsForRsc: React.Dispatch<React.SetStateAction<LocationServerProps>>;
+    children: ReactNode;
+}
+export declare function ServerPropsProvider({ initialServerProps, setServerPropsForRsc, children, }: ServerPropsProviderProps): JSX.Element;
+export {};

package/dist/node/foundation/ServerPropsProvider/ServerPropsProvider.js

@@ -0,0 +1,101 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerPropsProvider = exports.ServerPropsContext = void 0;
+const react_1 = __importStar(require("react"));
+const PRIVATE_PROPS = ['request', 'response'];
+exports.ServerPropsContext = (0, react_1.createContext)(null);
+function ServerPropsProvider({ initialServerProps, setServerPropsForRsc, children, }) {
+    const [locationServerProps, setLocationServerProps] = (0, react_1.useState)(initialServerProps);
+    const [serverProps, setServerProps] = (0, react_1.useState)({});
+    const [pending, startTransition] = (0, react_1.useTransition)();
+    const setServerPropsCallback = (0, react_1.useCallback)((input, propValue) => {
+        setServerProps((prev) => getNewValue(prev, input, propValue));
+    }, []);
+    const setLocationServerPropsCallback = (0, react_1.useCallback)((input, propValue) => {
+        // Flush the existing user server state when location changes, leaving only the persisted state
+        setServerProps({});
+        setLocationServerProps((prev) => getNewValue(prev, input, propValue));
+    }, []);
+    const getProposedLocationServerPropsCallback = (0, react_1.useCallback)((input, propValue) => {
+        return getNewValue(locationServerProps, input, propValue);
+    }, [locationServerProps]);
+    function getNewValue(prev, input, propValue) {
+        let newValue;
+        if (typeof input === 'function') {
+            newValue = input(prev);
+        }
+        else if (typeof input === 'string') {
+            newValue = { [input]: propValue };
+        }
+        else {
+            newValue = input;
+        }
+        if (__DEV__) {
+            const privateProp = PRIVATE_PROPS.find((prop) => prop in newValue);
+            if (privateProp) {
+                console.warn(`Custom "${privateProp}" property in server state is ignored. Use a different name.`);
+            }
+        }
+        return {
+            ...prev,
+            ...newValue,
+        };
+    }
+    const resolvedServerPropsForRsc = (0, react_1.useMemo)(() => {
+        return {
+            ...serverProps,
+            ...locationServerProps,
+        };
+    }, [serverProps, locationServerProps]);
+    const resolvedServerProps = (0, react_1.useMemo)(() => {
+        return {
+            ...serverProps,
+        };
+    }, [serverProps]);
+    (0, react_1.useEffect)(() => {
+        startTransition(() => {
+            setServerPropsForRsc(resolvedServerPropsForRsc);
+        });
+        return () => { };
+    }, [resolvedServerPropsForRsc]);
+    const value = (0, react_1.useMemo)(() => ({
+        pending,
+        locationServerProps: locationServerProps,
+        serverProps: resolvedServerProps,
+        setServerProps: setServerPropsCallback,
+        setLocationServerProps: setLocationServerPropsCallback,
+        getProposedLocationServerProps: getProposedLocationServerPropsCallback,
+    }), [
+        pending,
+        locationServerProps,
+        resolvedServerProps,
+        setServerPropsCallback,
+        setLocationServerPropsCallback,
+        getProposedLocationServerPropsCallback,
+    ]);
+    return (react_1.default.createElement(exports.ServerPropsContext.Provider, { value: value }, children));
+}
+exports.ServerPropsProvider = ServerPropsProvider;

package/dist/node/foundation/ServerPropsProvider/index.d.ts

@@ -0,0 +1,2 @@
+export { ServerPropsProvider, ServerPropsContext } from './ServerPropsProvider';
+export type { ServerProps, ServerPropsContextValue } from './ServerPropsProvider';

package/dist/node/foundation/ServerPropsProvider/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerPropsContext = exports.ServerPropsProvider = void 0;
+var ServerPropsProvider_1 = require("./ServerPropsProvider");
+Object.defineProperty(exports, "ServerPropsProvider", { enumerable: true, get: function () { return ServerPropsProvider_1.ServerPropsProvider; } });
+Object.defineProperty(exports, "ServerPropsContext", { enumerable: true, get: function () { return ServerPropsProvider_1.ServerPropsContext; } });

package/dist/node/foundation/session/session.d.ts

@@ -0,0 +1,27 @@
+import { Logger } from '../../utilities/log';
+import type { ServerComponentResponse } from '../../framework/Hydration/ServerComponentResponse.server';
+import type { ServerComponentRequest } from '../../framework/Hydration/ServerComponentRequest.server';
+export declare type SessionSyncApi = {
+    get: () => Record<string, string>;
+};
+export declare type SessionApi = {
+    get: () => Promise<Record<string, string>>;
+    set: (key: string, value: string) => Promise<void>;
+    destroy: () => Promise<void>;
+};
+export declare type SessionStorageAdapter = {
+    get: (request: Request) => Promise<Record<string, string>>;
+    set: (request: Request, value: Record<string, string>) => Promise<string>;
+    destroy: (request: Request) => Promise<string>;
+};
+export declare function getSyncSessionApi(request: ServerComponentRequest, componentResponse: ServerComponentResponse, log: Logger, session?: SessionStorageAdapter): {
+    get(): any;
+};
+export declare const emptySessionImplementation: (log: Logger) => {
+    get(): Promise<{}>;
+    set(key: string, value: string): Promise<void>;
+    destroy(): Promise<void>;
+};
+export declare const emptySyncSessionImplementation: (log: Logger) => {
+    get(): {};
+};