@uniformdev/canvas-next 19.100.0 → 19.106.1-alpha.3

package/dist/route/index.d.mts

@@ -6,6 +6,7 @@ import { ParsedUrlQuery } from 'querystring';
 import { RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, RouteClient, RouteGetParameters, RootComponentInstance } from '@uniformdev/canvas';
 import { ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
 import { RedirectClient } from '@uniformdev/redirect';
+import { GetStaticPropsContext as GetStaticPropsContext$1, GetServerSidePropsContext as GetServerSidePropsContext$1 } from 'next/types';
 import '@uniformdev/canvas-react';
 
 type HandleRouteCompositionFunction<TContext, TResult> = (composition: RouteGetResponseEdgehancedComposition, context: TContext, defaultHandler: (composition: RouteGetResponseEdgehancedComposition) => Promise<TResult | null> | TResult | null, duration: number) => Promise<TResult | null> | TResult | null;
@@ -98,6 +99,17 @@ declare const withUniformGetStaticProps: <TProps extends {
     param?: string | undefined;
 }) | undefined) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
+/**
+ * Prepends correct locale to the path before sending it to Uniform Route API.
+ *
+ * Recommended default callback for `options.modifyPath` in `withUniformGetStaticProps` and `withUniformGetServerSideProps`.
+ * Should be used together with Next.js Internationalization Routing.
+ *
+ * @see https://nextjs.org/docs/pages/building-your-application/routing/internationalization
+ * @see https://docs.uniform.app/docs/guides/composition/localization#enable-localization-on-your-frontend-application
+ */
+declare const prependLocale: (path: string, { locale, defaultLocale, locales }: GetStaticPropsContext$1 | GetServerSidePropsContext$1) => string;
+
 /**
  * Default implementation of getServerSideProps with routes
  * To configure custom behavior, use:
@@ -406,4 +418,4 @@ declare const getStaticPaths: () => Promise<{
     fallback: boolean;
 }>;
 
-export { type HandleRouteCompositionFunction, type HandleRouteNotFoundFunction, type HandleRouteRedirectFunction, type RouteHandlerOptions, getServerSideProps, getStaticPaths, getStaticProps, withUniformGetServerSideProps, withUniformGetStaticPaths, withUniformGetStaticProps };
+export { type HandleRouteCompositionFunction, type HandleRouteNotFoundFunction, type HandleRouteRedirectFunction, type RouteHandlerOptions, getServerSideProps, getStaticPaths, getStaticProps, prependLocale, withUniformGetServerSideProps, withUniformGetStaticPaths, withUniformGetStaticProps };

package/dist/route/index.d.ts

@@ -6,6 +6,7 @@ import { ParsedUrlQuery } from 'querystring';
 import { RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, RouteClient, RouteGetParameters, RootComponentInstance } from '@uniformdev/canvas';
 import { ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
 import { RedirectClient } from '@uniformdev/redirect';
+import { GetStaticPropsContext as GetStaticPropsContext$1, GetServerSidePropsContext as GetServerSidePropsContext$1 } from 'next/types';
 import '@uniformdev/canvas-react';
 
 type HandleRouteCompositionFunction<TContext, TResult> = (composition: RouteGetResponseEdgehancedComposition, context: TContext, defaultHandler: (composition: RouteGetResponseEdgehancedComposition) => Promise<TResult | null> | TResult | null, duration: number) => Promise<TResult | null> | TResult | null;
@@ -98,6 +99,17 @@ declare const withUniformGetStaticProps: <TProps extends {
     param?: string | undefined;
 }) | undefined) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
+/**
+ * Prepends correct locale to the path before sending it to Uniform Route API.
+ *
+ * Recommended default callback for `options.modifyPath` in `withUniformGetStaticProps` and `withUniformGetServerSideProps`.
+ * Should be used together with Next.js Internationalization Routing.
+ *
+ * @see https://nextjs.org/docs/pages/building-your-application/routing/internationalization
+ * @see https://docs.uniform.app/docs/guides/composition/localization#enable-localization-on-your-frontend-application
+ */
+declare const prependLocale: (path: string, { locale, defaultLocale, locales }: GetStaticPropsContext$1 | GetServerSidePropsContext$1) => string;
+
 /**
  * Default implementation of getServerSideProps with routes
  * To configure custom behavior, use:
@@ -406,4 +418,4 @@ declare const getStaticPaths: () => Promise<{
     fallback: boolean;
 }>;
 
-export { type HandleRouteCompositionFunction, type HandleRouteNotFoundFunction, type HandleRouteRedirectFunction, type RouteHandlerOptions, getServerSideProps, getStaticPaths, getStaticProps, withUniformGetServerSideProps, withUniformGetStaticPaths, withUniformGetStaticProps };
+export { type HandleRouteCompositionFunction, type HandleRouteNotFoundFunction, type HandleRouteRedirectFunction, type RouteHandlerOptions, getServerSideProps, getStaticPaths, getStaticProps, prependLocale, withUniformGetServerSideProps, withUniformGetStaticPaths, withUniformGetStaticProps };

package/dist/route/index.js

@@ -23,6 +23,7 @@ __export(route_exports, {
   getServerSideProps: () => getServerSideProps,
   getStaticPaths: () => getStaticPaths,
   getStaticProps: () => getStaticProps,
+  prependLocale: () => prependLocale,
   withUniformGetServerSideProps: () => withUniformGetServerSideProps,
   withUniformGetStaticPaths: () => withUniformGetStaticPaths,
   withUniformGetStaticProps: () => withUniformGetStaticProps
@@ -474,6 +475,14 @@ var withUniformGetStaticProps = (options) => {
   return routeFetcher;
 };
 
+// src/route/localePathModifier.ts
+var prependLocale = (path, { locale, defaultLocale, locales }) => {
+  if (!(locales == null ? void 0 : locales.length))
+    return path;
+  const slug = path === "/" ? "" : path;
+  return decodeURI(`/${locale || defaultLocale}${slug}`);
+};
+
 // src/route/index.ts
 var getServerSideProps = withUniformGetServerSideProps();
 var getStaticProps = withUniformGetStaticProps();
@@ -483,6 +492,7 @@ var getStaticPaths = withUniformGetStaticPaths();
   getServerSideProps,
   getStaticPaths,
   getStaticProps,
+  prependLocale,
   withUniformGetServerSideProps,
   withUniformGetStaticPaths,
   withUniformGetStaticProps

package/dist/route/index.mjs

@@ -342,6 +342,14 @@ var withUniformGetStaticProps = (options) => {
   return routeFetcher;
 };
 
+// src/route/localePathModifier.ts
+var prependLocale = (path, { locale, defaultLocale, locales }) => {
+  if (!(locales == null ? void 0 : locales.length))
+    return path;
+  const slug = path === "/" ? "" : path;
+  return decodeURI(`/${locale || defaultLocale}${slug}`);
+};
+
 // src/route/index.ts
 var getServerSideProps = withUniformGetServerSideProps();
 var getStaticProps = withUniformGetStaticProps();
@@ -350,6 +358,7 @@ export {
   getServerSideProps,
   getStaticPaths,
   getStaticProps,
+  prependLocale,
   withUniformGetServerSideProps,
   withUniformGetStaticPaths,
   withUniformGetStaticProps

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next",
-  "version": "19.100.0",
+  "version": "19.106.1-alpha.3+47677ea6f",
   "description": "Next.js SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -67,11 +67,11 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.100.0",
-    "@uniformdev/canvas-react": "19.100.0",
-    "@uniformdev/project-map": "19.100.0",
-    "@uniformdev/redirect": "19.100.0",
-    "@uniformdev/richtext": "19.100.0",
+    "@uniformdev/canvas": "19.106.1-alpha.3+47677ea6f",
+    "@uniformdev/canvas-react": "19.106.1-alpha.3+47677ea6f",
+    "@uniformdev/project-map": "19.106.1-alpha.3+47677ea6f",
+    "@uniformdev/redirect": "19.106.1-alpha.3+47677ea6f",
+    "@uniformdev/richtext": "19.106.1-alpha.3+47677ea6f",
     "colorette": "2.0.20"
   },
   "peerDependencies": {
@@ -91,5 +91,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3a7c70c06a71b4ecc211ab15eb3bb185480ccf36"
+  "gitHead": "47677ea6fd6eb707bb30eb20dc67e42573e0516d"
 }