@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.9 → 22.1.0-canary.2

package/types/sharedTypes/module-factory.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="@types/react" />
+import { ComponentType } from 'react';
+import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
+/**
+ * Represents a module (file)
+ */
+export type Module = {
+    /**
+     * Default SXA export
+     */
+    Default?: ComponentType;
+    /**
+     * Default Next.js export
+     */
+    default?: ComponentType;
+    /**
+     * function for component level data fetching in SSR mode
+     */
+    getServerSideProps?: GetServerSideComponentProps;
+    /**
+     * function for component level data fetching in SSG mode
+     */
+    getStaticProps?: GetStaticComponentProps;
+} & {
+    /**
+     * Custom exports
+     */
+    [key: string]: ComponentType;
+};
+/**
+ * Represents a module factory
+ */
+export type ModuleFactory = (componentName: string) => Module | Promise<Module> | null;

package/types/site/index.d.ts

@@ -0,0 +1 @@
+export { SiteResolver, SiteInfo } from '@sitecore-jss/sitecore-jss/site';

package/types/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { getPublicUrl, handleEditorFastRefresh } from './utils';
+export { tryParseEnvValue, isEditorActive, resetEditorChromes, resolveUrl, } from '@sitecore-jss/sitecore-jss/utils';

package/types/{utils.d.ts → utils/utils.d.ts}

@@ -4,6 +4,8 @@
  * This is set to http://localhost:3000 by default.
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
+ * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 export declare const getPublicUrl: () => string;
 /**

package/utils.d.ts

@@ -0,0 +1 @@
+export * from './types/utils/index';

package/utils.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cjs/utils/index');

package/types/sharedTypes/component-module.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
-export type Module = {
-    default: React.Component;
-    getServerSideProps?: GetServerSideComponentProps;
-    getStaticProps?: GetStaticComponentProps;
-};
-/**
- * @returns `undefined` module not found
- * @returns `Module` regular module
- * @returns `Promise<Module>` when module should be lazy loaded
- */
-export type ComponentModule = (componentName: string) => Module | Promise<Module> | undefined;