@contember/interface 2.1.0-beta.2 → 2.2.0-alpha.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contember/interface",
   "license": "Apache-2.0",
-  "version": "2.1.0-beta.2",
+  "version": "2.2.0-alpha.1",
   "type": "module",
   "sideEffects": false,
   "main": "./dist/production/index.js",
@@ -29,12 +29,12 @@
     "ae:test": "api-extractor run"
   },
   "dependencies": {
-    "@contember/react-binding": "2.1.0-beta.1",
-    "@contember/react-client": "2.1.0-beta.1",
-    "@contember/react-dataview": "2.1.0-beta.1",
-    "@contember/react-devbar": "2.1.0-beta.1",
-    "@contember/react-identity": "2.1.0-beta.1",
-    "@contember/react-routing": "2.1.0-beta.1",
+    "@contember/react-binding": "2.1.0-beta.2",
+    "@contember/react-client": "2.1.0-beta.2",
+    "@contember/react-dataview": "2.1.0-beta.2",
+    "@contember/react-devbar": "2.1.0-beta.2",
+    "@contember/react-identity": "2.1.0-beta.2",
+    "@contember/react-routing": "2.1.0-beta.2",
     "@radix-ui/react-slot": "^1.2.4"
   },
   "peerDependencies": {

package/src/bootstrap/ApplicationEntrypoint.tsx

@@ -2,7 +2,7 @@ import { Environment, EnvironmentContext, EnvironmentExtensionProvider } from '@
 import { ContemberClient, ContemberClientProps } from '@contember/react-client'
 import { ReactNode } from 'react'
 import { RouteMap, RoutingContextValue, RoutingProvider } from '@contember/react-routing'
-import { DataViewPageNameKeyProvider } from './DataViewPageNameKeyProvider'
+import { DataViewPageNameKeyProvider } from './DataViewPageNameKeyProvider.js'
 import { IdentityEnvironmentProvider, IdentityProvider, projectEnvironmentExtension } from '@contember/react-identity'
 
 export interface ApplicationEntrypointProps extends ContemberClientProps {

package/src/bootstrap/index.ts

@@ -1 +1 @@
-export * from './ApplicationEntrypoint'
+export * from './ApplicationEntrypoint.js'

package/src/components/binding/RedirectOnPersist.tsx

@@ -1,14 +1,27 @@
-import { useEntityPersistSuccess } from '@contember/react-binding'
-import { RequestParameters, useRedirect } from '@contember/react-routing'
-import { RoutingLinkTarget } from '@contember/react-routing'
+import { Component, useEntityPersistSuccess } from '@contember/react-binding'
+import { RequestParameters, RoutingLinkFields, RoutingLinkTarget, useRedirect } from '@contember/react-routing'
 
-export const RedirectOnPersist = ({ to, parameters }: { to: RoutingLinkTarget; parameters?: RequestParameters }) => {
-	const redirect = useRedirect()
-	useEntityPersistSuccess((getEntity, options) => {
-		if (options.successType !== 'justSuccess') {
-			return
-		}
-		redirect(to, parameters)
-	})
-	return null
+export interface RedirectOnPersistProps {
+	to: RoutingLinkTarget
+	parameters?: RequestParameters
 }
+
+/**
+ * Redirects to the given target after a successful persist. Exposes a static
+ * render so the fields referenced by the routing target are registered during
+ * the static analysis pass, just like `Link`.
+ */
+export const RedirectOnPersist = Component<RedirectOnPersistProps>(
+	({ to, parameters }) => {
+		const redirect = useRedirect()
+		useEntityPersistSuccess((getEntity, options) => {
+			if (options.successType !== 'justSuccess') {
+				return
+			}
+			redirect(to, parameters)
+		})
+		return null
+	},
+	props => <RoutingLinkFields to={props.to} />,
+	'RedirectOnPersist',
+)

package/src/components/binding/index.ts

@@ -1,4 +1,4 @@
-export * from './ClearFieldTrigger'
-export * from './DisconnectEntityTrigger'
-export * from './EntityBeforePersist'
-export * from './RedirectOnPersist'
+export * from './ClearFieldTrigger.js'
+export * from './DisconnectEntityTrigger.js'
+export * from './EntityBeforePersist.js'
+export * from './RedirectOnPersist.js'

package/src/components/index.ts

@@ -1 +1 @@
-export * from './binding'
+export * from './binding/index.js'

package/src/hooks/index.ts

@@ -1,2 +1,2 @@
-export * from './useIsApplicationOutdated'
-export * from './useBlockNavigationOnDirtyState'
+export * from './useIsApplicationOutdated.js'
+export * from './useBlockNavigationOnDirtyState.js'

package/src/index.ts

@@ -1,6 +1,6 @@
-export * from './bootstrap'
-export * from './components'
-export * from './hooks'
+export * from './bootstrap/index.js'
+export * from './components/index.js'
+export * from './hooks/index.js'
 export * from '@contember/react-routing'
 export * from '@contember/react-binding'
 export * from '@contember/react-identity'

package/tests/components/RedirectOnPersist.spec.tsx

@@ -0,0 +1,47 @@
+import { Children, isValidElement, ReactNode } from 'react'
+import { describe, expect, it } from 'bun:test'
+import { Environment } from '@contember/react-binding'
+import { RedirectOnPersist } from '../../src/components/binding/RedirectOnPersist.js'
+
+interface StaticRenderProvider {
+	staticRender?: (props: any, environment: Environment) => ReactNode
+}
+
+// Mimics the marker static-analysis pass: descend the rendered tree and
+// recursively invoke the `staticRender` of any nested component that exposes one.
+const collectFieldNames = (node: ReactNode, env: Environment): string[] => {
+	const fields: string[] = []
+	Children.forEach(node, child => {
+		if (!isValidElement(child)) {
+			return
+		}
+		const props = child.props as { field?: string; children?: ReactNode }
+		if (typeof props.field === 'string') {
+			fields.push(props.field)
+		}
+		const staticRender = (child.type as StaticRenderProvider | undefined)?.staticRender
+		if (typeof staticRender === 'function') {
+			fields.push(...collectFieldNames(staticRender(child.props, env), env))
+		}
+		if (props.children !== undefined) {
+			fields.push(...collectFieldNames(props.children, env))
+		}
+	})
+	return fields
+}
+
+describe('RedirectOnPersist static render', () => {
+	it('exposes a static render', () => {
+		expect(typeof (RedirectOnPersist as StaticRenderProvider).staticRender).toBe('function')
+	})
+
+	it('registers fields referenced by a binding routing target', () => {
+		const env = Environment.create()
+		const rendered = (RedirectOnPersist as StaticRenderProvider).staticRender!(
+			{ to: 'myPage(id: $entity.someField)' },
+			env,
+		)
+
+		expect(collectFieldNames(rendered, env)).toEqual(['someField'])
+	})
+})

package/tests/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../../tsconfig.settings.json",
+	"compilerOptions": {
+		"noEmit": true,
+		"emitDeclarationOnly": false
+	},
+	"references": [
+		{ "path": "../src" },
+	],
+}

package/tsconfig.json

@@ -3,5 +3,6 @@
 	"include": [],
 	"references": [
 		{ "path": "./src" },
+		{ "path": "./tests" },
 	],
 }