@wasp.sh/wasp-cli-darwin-x64-unknown 0.25.0 → 0.26.0

package/data/Generator/templates/sdk/wasp/client/auth/ui.ts

@@ -7,7 +7,7 @@ export { ForgotPasswordForm } from '../../auth/forms/ForgotPassword'
 export { VerifyEmailForm } from '../../auth/forms/VerifyEmail'
 export { ResetPasswordForm } from '../../auth/forms/ResetPassword'
 {=/ isEmailAuthEnabled =}
-export type { CustomizationOptions } from '../../auth/forms/types'
+export type { CustomizationOptions } from '@wasp.sh/lib-sdk-core/browser'
 {=# isSlackAuthEnabled =}
 export { SignInButton as SlackSignInButton } from '../../auth/helpers/Slack'
 {=/ isSlackAuthEnabled =}
@@ -32,4 +32,4 @@ export {
   FormTextarea,
   FormItemGroup,
   FormLabel,
-} from '../../auth/forms/internal/Form'
+} from '@wasp.sh/lib-sdk-core/browser'

package/data/Generator/templates/sdk/wasp/client/auth/username.ts

@@ -1,2 +1,2 @@
-export { login, signup } from '../../auth/username'
-
+export { login } from '../../auth/username/actions/login'
+export { signup } from '../../auth/username/actions/signup'

package/data/Generator/templates/sdk/wasp/client/config.ts

@@ -1,14 +1,9 @@
 {{={= =}=}}
-import { stripTrailingSlash } from '../universal/url.js'
+import { stripTrailingSlash, type ClientConfig } from '@wasp.sh/lib-sdk-core'
 import { env } from './env.js'
 
 const apiUrl = stripTrailingSlash(env["{= serverUrlEnvVarName =}"])
 
-// PUBLIC API
-export type ClientConfig = {
-  apiUrl: string,
-}
-
 // PUBLIC API
 export const config: ClientConfig = {
   apiUrl,

package/data/Generator/templates/sdk/wasp/client/crud/_crud.ts

@@ -1,89 +1,143 @@
 {{={= =}=}}
-import { createAction } from "../operations/actions/core.js";
-import { createQuery } from "../operations/queries/core.js";
-import { makeUseActionFor, makeUseQueryFor } from "./operationsHelpers.js";
+import { createAction } from "../operations/actions/core";
+import { createQuery } from "../operations/queries/core";
+import { makeUseActionFor, makeUseQueryFor, type ActionFor, type QueryFor, type UseActionFor, type UseQueryFor } from "@wasp.sh/lib-sdk-core/browser";
 import type {
-    {=# operations.Get =}
-    GetQueryResolved,
-    {=/ operations.Get =}
-    {=# operations.GetAll =}
-    GetAllQueryResolved,
-    {=/ operations.GetAll =}
-    {=# operations.Create =}
-    CreateActionResolved,
-    {=/ operations.Create =}
-    {=# operations.Update =}
-    UpdateActionResolved,
-    {=/ operations.Update =}
-    {=# operations.Delete =}
-    DeleteActionResolved,
-    {=/ operations.Delete =}
-} from '../../server/crud/{= name =}.js'
+  {=# operations.Get =}
+  RegisteredGetQuery,
+  {=/ operations.Get =}
+  {=# operations.GetAll =}
+  RegisteredGetAllQuery,
+  {=/ operations.GetAll =}
+  {=# operations.Create =}
+  RegisteredCreateAction,
+  {=/ operations.Create =}
+  {=# operations.Update =}
+  RegisteredUpdateAction,
+  {=/ operations.Update =}
+  {=# operations.Delete =}
+  RegisteredDeleteAction,
+  {=/ operations.Delete =}
+} from "../../server/crud/{= name =}";
+
+// PUBLIC API
+export const {= name =}: {= entityUpper =}Crud = createCrud();
+
+// PUBLIC API
+export interface {= entityUpper =}Crud {
+  {=# operations.Get =}
+  get: {= entityUpper =}Get;
+  {=/ operations.Get =}
+  {=# operations.GetAll =}
+  getAll: {= entityUpper =}GetAll;
+  {=/ operations.GetAll =}
+  {=# operations.Create =}
+  create: {= entityUpper =}Create;
+  {=/ operations.Create =}
+  {=# operations.Update =}
+  update: {= entityUpper =}Update;
+  {=/ operations.Update =}
+  {=# operations.Delete =}
+  delete: {= entityUpper =}Delete;
+  {=/ operations.Delete =}
+};
+{=# operations.Get =}
+
+export interface {= entityUpper =}Get {
+  query: QueryFor<RegisteredGetQuery>;
+  useQuery: UseQueryFor<RegisteredGetQuery>;
+}
+{=/ operations.Get =}
+{=# operations.GetAll =}
+
+export interface {= entityUpper =}GetAll {
+  query: QueryFor<RegisteredGetAllQuery>;
+  useQuery: UseQueryFor<RegisteredGetAllQuery>;
+};
+{=/ operations.GetAll =}
+{=# operations.Create =}
 
-function createCrud() {
+export interface {= entityUpper =}Create {
+  action: ActionFor<RegisteredCreateAction>;
+  useAction: UseActionFor<RegisteredCreateAction>;
+};
+{=/ operations.Create =}
+{=# operations.Update =}
+
+export interface {= entityUpper =}Update {
+  action: ActionFor<RegisteredUpdateAction>;
+  useAction: UseActionFor<RegisteredUpdateAction>;
+};
+{=/ operations.Update =}
+{=# operations.Delete =}
+
+export interface {= entityUpper =}Delete {
+  action: ActionFor<RegisteredDeleteAction>;
+  useAction: UseActionFor<RegisteredDeleteAction>;
+};
+{=/ operations.Delete =}
+
+function createCrud(): {= entityUpper =}Crud {
+  {=# operations.Get =}
+  const crudGetQuery = createQuery<RegisteredGetQuery>(
+    '{= fullPath =}',
+    {=& entitiesArray =}
+  )
+  {=/ operations.Get =}
+  {=# operations.GetAll =}
+  const crudGetAllQuery = createQuery<RegisteredGetAllQuery>(
+    '{= fullPath =}',
+    {=& entitiesArray =}
+  )
+  {=/ operations.GetAll =}
+  {=# operations.Create =}
+  const crudCreateAction = createAction<RegisteredCreateAction>(
+    '{= fullPath =}',
+    {=& entitiesArray =}
+  )
+  {=/ operations.Create =}
+  {=# operations.Update =}
+  const crudUpdateAction = createAction<RegisteredUpdateAction>(
+    '{= fullPath =}',
+    {=& entitiesArray =}
+  )
+  {=/ operations.Update =}
+  {=# operations.Delete =}
+  const crudDeleteAction = createAction<RegisteredDeleteAction>(
+    '{= fullPath =}',
+    {=& entitiesArray =}
+  )
+  {=/ operations.Delete =}
+  return {
     {=# operations.Get =}
-    const crudGetQuery = createQuery<GetQueryResolved>(
-        '{= fullPath =}',
-        {=& entitiesArray =}
-    )
+    get: {
+      query: crudGetQuery,
+      useQuery: makeUseQueryFor(crudGetQuery)
+    },
     {=/ operations.Get =}
     {=# operations.GetAll =}
-    const crudGetAllQuery = createQuery<GetAllQueryResolved>(
-        '{= fullPath =}',
-        {=& entitiesArray =}
-    )
+    getAll: {
+      query: crudGetAllQuery,
+      useQuery: makeUseQueryFor(crudGetAllQuery)
+    },
     {=/ operations.GetAll =}
     {=# operations.Create =}
-    const crudCreateAction = createAction<CreateActionResolved>(
-        '{= fullPath =}',
-        {=& entitiesArray =}
-    )
+    create: {
+      action: crudCreateAction,
+      useAction: makeUseActionFor(crudCreateAction)
+    },
     {=/ operations.Create =}
     {=# operations.Update =}
-    const crudUpdateAction = createAction<UpdateActionResolved>(
-        '{= fullPath =}',
-        {=& entitiesArray =}
-    )
+    update: {
+      action: crudUpdateAction,
+      useAction: makeUseActionFor(crudUpdateAction)
+    },
     {=/ operations.Update =}
     {=# operations.Delete =}
-    const crudDeleteAction = createAction<DeleteActionResolved>(
-        '{= fullPath =}',
-        {=& entitiesArray =}
-    )
+    delete: {
+      action: crudDeleteAction,
+      useAction: makeUseActionFor(crudDeleteAction)
+    },
     {=/ operations.Delete =}
-    return {
-        {=# operations.Get =}
-        get: {
-            query: crudGetQuery,
-            useQuery: makeUseQueryFor(crudGetQuery)
-        },
-        {=/ operations.Get =}
-        {=# operations.GetAll =}
-        getAll: {
-            query: crudGetAllQuery,
-            useQuery: makeUseQueryFor(crudGetAllQuery)
-        },
-        {=/ operations.GetAll =}
-        {=# operations.Create =}
-        create: {
-            action: crudCreateAction,
-            useAction: makeUseActionFor(crudCreateAction)
-        },
-        {=/ operations.Create =}
-        {=# operations.Update =}
-        update: {
-            action: crudUpdateAction,
-            useAction: makeUseActionFor(crudUpdateAction)
-        },
-        {=/ operations.Update =}
-        {=# operations.Delete =}
-        delete: {
-            action: crudDeleteAction,
-            useAction: makeUseActionFor(crudDeleteAction)
-        },
-        {=/ operations.Delete =}
-    }
+  }
 }
-
-// PUBLIC API
-export const {= name =} = createCrud();

package/data/Generator/templates/sdk/wasp/client/env/schema.ts

@@ -1,12 +1,18 @@
 {{={= =}=}}
 import * as z from "zod"
-
+import type { FromRegister } from "../../types/register";
 {=# envValidationSchema.isDefined =}
 {=& envValidationSchema.importStatement =}
-const userClientEnvSchema = {= envValidationSchema.importIdentifier =};
+{=/ envValidationSchema.isDefined =}
+
+export type RegisteredClientEnvValidationSchema = FromRegister<"clientEnvValidationSchema", z.ZodObject<{}>>;
+type UserClientEnvSchema = RegisteredClientEnvValidationSchema;
+
+{=# envValidationSchema.isDefined =}
+const userClientEnvSchema: UserClientEnvSchema = {= envValidationSchema.importIdentifier =};
 {=/ envValidationSchema.isDefined =}
 {=^ envValidationSchema.isDefined =}
-const userClientEnvSchema = z.object({});
+const userClientEnvSchema: UserClientEnvSchema = z.object({});
 {=/ envValidationSchema.isDefined =}
 
 const serverUrlSchema =
@@ -20,8 +26,7 @@ const serverUrlSchema =
   )
 
 const waspDevClientEnvSchema = z.object({
-  "{= serverUrlEnvVarName =}": serverUrlSchema
-    .default("{= defaultServerUrl =}"),
+  "{= serverUrlEnvVarName =}": serverUrlSchema,
 });
 
 const waspProdClientEnvSchema = z.object({
@@ -32,8 +37,10 @@ const waspClientEnvSchema = import.meta.env.MODE === "production"
   ? waspProdClientEnvSchema
   : waspDevClientEnvSchema;
 
+export type CompleteClientEnvSchema = z.ZodObject<typeof waspClientEnvSchema["shape"] & UserClientEnvSchema["shape"]>;
+
 // PRIVATE API (sdk, Vite config)
-export const clientEnvSchema = z.object({
+export const clientEnvSchema: CompleteClientEnvSchema = z.object({
   ...userClientEnvSchema.shape,
-  ...waspClientEnvSchema.shape,
+  ...waspClientEnvSchema.shape
 });

package/data/Generator/templates/sdk/wasp/client/env.ts

@@ -1,8 +1,9 @@
-import { ensureEnvSchema } from "../env/validation.js";
-import { clientEnvSchema } from "./env/schema.js";
+import type * as z from "zod";
+import { ensureEnvSchema } from "@wasp.sh/lib-sdk-core";
+import { type CompleteClientEnvSchema, clientEnvSchema } from "./env/schema";
 
 // PUBLIC API
-export const env = ensureEnvSchema(
+export const env: z.infer<CompleteClientEnvSchema> = ensureEnvSchema(
   import.meta.env,
   clientEnvSchema,
 );

package/data/Generator/templates/sdk/wasp/client/index.ts

@@ -1,17 +1,8 @@
 // PUBLIC API
-// NOTE: This is enough to cover Operations and our APIs (src/Wasp/AppSpec/Api.hs).
-export enum HttpMethod {
-	Get = 'GET',
-	Post = 'POST',
-	Put = 'PUT',
-	Delete = 'DELETE',
-}
+export { HttpMethod, type ClientConfig, type Route } from '@wasp.sh/lib-sdk-core'
 
 // PUBLIC API
-export type Route = { method: HttpMethod; path: string }
+export { config } from './config';
 
 // PUBLIC API
-export { config, ClientConfig } from './config.js'
-
-// PUBLIC API
-export { env } from './env.js'
+export { env } from './env';

package/data/Generator/templates/sdk/wasp/client/operations/actions/core.ts

@@ -1,10 +1,15 @@
-import type { _Awaited, _ReturnType } from '../../../universal/types.js'
-import type { OperationRpcFor, GenericBackendOperation } from '../rpc.js'
-import { callOperation, makeOperationRoute } from '../internal/index.js'
 import {
+  type ActionFor,
+  type SpecificOptimisticUpdateDefinition,
   registerActionInProgress,
   registerActionDone,
-} from '../internal/resources.js'
+} from '@wasp.sh/lib-sdk-core/browser'
+import {
+  makeOperationRoute,
+  type OperationRpcFor,
+  type GenericBackendOperation,
+} from '@wasp.sh/lib-sdk-core'
+import { callOperation } from '../internal/index.js'
 
 // PRIVATE API
 export function createAction<BackendAction extends GenericBackendOperation>(
@@ -13,7 +18,10 @@ export function createAction<BackendAction extends GenericBackendOperation>(
 ): ActionFor<BackendAction> {
   const actionRoute = makeOperationRoute(relativeActionRoute)
 
-  async function internalAction(args, specificOptimisticUpdateDefinitions) {
+  async function internalAction<CachedData>(
+    args: unknown,
+    specificOptimisticUpdateDefinitions: SpecificOptimisticUpdateDefinition<CachedData>[]
+  ): Promise<unknown> {
     registerActionInProgress(specificOptimisticUpdateDefinitions)
     try {
       // The `return await` is not redundant here. If we removed the await, the
@@ -34,7 +42,7 @@ export function createAction<BackendAction extends GenericBackendOperation>(
   // While it does technically allow our users to access the interal API, it
   // shouldn't be a problem in practice. Still, if it turns out to be a problem,
   // we can always hide it using a Symbol.
-  const action = (args) => internalAction(args, [])
+  const action = (args: unknown) => internalAction(args, [])
   action.internal = internalAction
 
   // NOTE: I'm not sure why unknown is necessary here,
@@ -43,7 +51,3 @@ export function createAction<BackendAction extends GenericBackendOperation>(
   // https://www.typescriptlang.org/play/?#code/MYewdgzgLgBCBGArGBeGBvGBDAXDA5AGYgj4wC+AUAogHTyoHxYBO+llA9JzIQK5hgUAJbhsAG3EgA7hGxgYAUwBuIccuFgA5jCgBPAA6KY8PrBqKhMACYhFcsCCiVQkWPwVoAFAEpUAPgJiUkoPekZ8ZjYgA
   return action as unknown as ActionFor<BackendAction>
 }
-
-// PRIVATE API
-export type ActionFor<BackendAction extends GenericBackendOperation> =
-  OperationRpcFor<BackendAction>

package/data/Generator/templates/sdk/wasp/client/operations/actions/index.ts

@@ -1,13 +1,16 @@
 {{={= =}=}}
-import { type ActionFor, createAction } from './core'
+import type { ActionFor } from '@wasp.sh/lib-sdk-core/browser'
+import { createAction } from "./core";
+import type {
 {=# actions =}
-{=& operationTypeImportStmt =}
+  {= registeredOperationTypeName =},
 {=/ actions =}
+} from "../../../server/operations/actions/index";
 {=# actions =}
 
 // PUBLIC API
-export const {= operationName =}: ActionFor<{= operationTypeName =}> = createAction<{= operationTypeName =}>(
-  '{= actionRoute =}',
+export const {= operationName =}: ActionFor<{= registeredOperationTypeName =}> = createAction<{= registeredOperationTypeName =}>(
+  "{= actionRoute =}",
   {=& entitiesArray =},
 )
 {=/ actions =}

package/data/Generator/templates/sdk/wasp/client/operations/index.ts

@@ -10,7 +10,7 @@ export {
     useQuery,
     // PUBLIC API
     type OptimisticUpdateDefinition,
-} from './hooks'
+} from '@wasp.sh/lib-sdk-core/browser'
 
 export {
     // PUBLIC API
@@ -19,9 +19,9 @@ export {
     initializeQueryClient,
     // PRIVATE API (framework code)
     queryClientInitialized
-} from './queryClient'
+} from '@wasp.sh/lib-sdk-core/browser'
 
-export {
+export type {
     // PUBLIC API
-    type QueryMetadata,
-} from './rpc'
+    QueryMetadata,
+} from '@wasp.sh/lib-sdk-core'

package/data/Generator/templates/sdk/wasp/client/operations/internal/index.ts

@@ -1,10 +1,8 @@
+import type { OperationRoute } from '@wasp.sh/lib-sdk-core'
 import { api, handleApiError } from '../../../api/index.js'
 import { HttpMethod } from '../../index.js'
 import { serialize, deserialize } from '../../../core/serialization/index.js'
 
-// PRIVATE API
-export type OperationRoute = { method: HttpMethod.Post, path: string }
-
 // PRIVATE API
 export async function callOperation(operationRoute: OperationRoute, args: any) {
   try {
@@ -17,8 +15,3 @@ export async function callOperation(operationRoute: OperationRoute, args: any) {
     throw handleApiError(error)
   }
 }
-
-// PRIVATE API
-export function makeOperationRoute(relativeOperationRoute: string): OperationRoute {
-  return { method: HttpMethod.Post, path: `/${relativeOperationRoute}` }
-}

package/data/Generator/templates/sdk/wasp/client/operations/queries/core.ts

@@ -1,31 +1,18 @@
-import { Route } from '../../index.js'
-import type { _Awaited, _ReturnType } from '../../../universal/types.js'
-import type {
-  GenericBackendOperation,
-  GenericOperationRpc,
-  OperationRpcFor,
-  Query,
-  QueryMetadata,
-} from '../rpc.js'
-import { callOperation, makeOperationRoute } from '../internal/index.js'
 import {
+  makeQueryCacheKey,
+  buildAndRegisterQuery,
+  type QueryFor,
   addResourcesUsedByQuery,
   getActiveOptimisticUpdates,
-} from '../internal/resources'
-
-// PRIVATE API (used in the SDK)
-// todo: find ways to remove this duplication and make the type more precise.
-// Details here: https://github.com/wasp-lang/wasp/issues/2017
-export function makeQueryCacheKey<Input, Output>(
-  query: Query<Input, Output>,
-  payload: Input
-): (string | Input)[] {
-  return payload !== undefined ?
-    [...query.queryCacheKey, payload]
-    : query.queryCacheKey
-}
+} from '@wasp.sh/lib-sdk-core/browser'
+import {
+  makeOperationRoute,
+  type GenericBackendOperation,
+  type OperationRpcFor,
+} from '@wasp.sh/lib-sdk-core'
+import { callOperation } from '../internal/index.js'
 
-// PRIVATE API (unsed in SDK)
+// PRIVATE API (used in SDK)
 export function createQuery<BackendQuery extends GenericBackendOperation>(
   relativeQueryPath: string,
   entitiesUsed: string[]
@@ -33,14 +20,14 @@ export function createQuery<BackendQuery extends GenericBackendOperation>(
   const queryRoute = makeOperationRoute(relativeQueryPath)
   const queryCacheKey = [relativeQueryPath]
 
-  const queryFn = (async (queryArgs) => {
+  const queryFn = (async (queryArgs: Parameters<BackendQuery>[0]) => {
     const serverResult = await callOperation(queryRoute, queryArgs)
     // todo: The full queryCacheKey is constructed in two places, both here and
     // inside the useQuery hook. See
     // https://github.com/wasp-lang/wasp/issues/2017
     const queryCacheKey = makeQueryCacheKey(queryFn as QueryFor<BackendQuery>, queryArgs)
     return getActiveOptimisticUpdates(queryCacheKey).reduce(
-      (result, update) => update(result),
+      (result: unknown, update: (data: unknown) => unknown) => update(result),
       serverResult,
     )
     // This assertion is necessary because, when the Input is void, we want to
@@ -54,38 +41,9 @@ export function createQuery<BackendQuery extends GenericBackendOperation>(
   )
 }
 
-// PRIVATE API (used in SDK)
-export function buildAndRegisterQuery<QF extends GenericOperationRpc>(
-  queryFn: QF,
-  { queryCacheKey, queryRoute, entitiesUsed }:
-    { queryCacheKey: string[], queryRoute: Route, entitiesUsed: string[] }
-): QueryForFunction<QF> {
-  const query = queryFn as QueryForFunction<QF>
-
-  query.queryCacheKey = queryCacheKey
-  query.route = queryRoute
-  addResourcesUsedByQuery(query.queryCacheKey, entitiesUsed)
-
-  return query
-}
-
-// PRIVATE API (but should maybe be public, users define values of this type)
-/**
- * Constructs the client Query object type from the type of the Query's definition
- * on the backend.
- */
-export type QueryFor<BackendQuery extends GenericBackendOperation> =
-  QueryForFunction<QueryFunctionFor<BackendQuery>>
-
 /**
  * Constructs the client Query function type from the type of the Query's
  * definition on the backend.
  */
 type QueryFunctionFor<BackendQuery extends GenericBackendOperation> =
   OperationRpcFor<BackendQuery>
-
-/**
- * Returns the appropriate client Query object type for the provided client
- * Query function type.
- */
-type QueryForFunction<QF extends GenericOperationRpc> = QF & QueryMetadata

package/data/Generator/templates/sdk/wasp/client/operations/queries/index.ts

@@ -1,16 +1,16 @@
 {{={= =}=}}
-import { type QueryFor, createQuery } from './core'
+import type { QueryFor } from '@wasp.sh/lib-sdk-core/browser'
+import { createQuery } from "./core";
+import type {
 {=# queries =}
-{=& operationTypeImportStmt =}
+  {= registeredOperationTypeName =},
 {=/ queries =}
+} from "../../../server/operations/queries/index";
 {=# queries =}
 
 // PUBLIC API
-export const {= operationName =}: QueryFor<{= operationTypeName =}> = createQuery<{= operationTypeName =}>(
-  '{= queryRoute =}',
+export const {= operationName =}: QueryFor<{= registeredOperationTypeName =}> = createQuery<{= registeredOperationTypeName =}>(
+  "{= queryRoute =}",
   {=& entitiesArray =},
 )
 {=/ queries =}
-
-// PRIVATE API (used in SDK)
-export { buildAndRegisterQuery } from './core'

package/data/Generator/templates/sdk/wasp/client/router/Link.tsx

@@ -1,18 +1,18 @@
 import { useMemo } from 'react'
 import { Link as RouterLink } from 'react-router'
-import { interpolatePath } from './linkHelpers'
-import { type Routes } from './index'
+import { interpolatePath, type OptionalRouteOptions } from '@wasp.sh/lib-sdk-core'
+import type { Routes } from './index'
 
 type RouterLinkProps = Parameters<typeof RouterLink>[0]
 
 // PUBLIC API
-export function Link(
-  { to, params, search, hash, ...restOfProps }: Omit<RouterLinkProps, "to">
-  & {
-    search?: Record<string, string>;
-    hash?: string;
-  }
+export type LinkProps = Omit<RouterLinkProps, "to">
+  & OptionalRouteOptions
   & Routes
+
+// PUBLIC API
+export function Link(
+  { to, params, search, hash, ...restOfProps }: LinkProps
 ): React.JSX.Element {
   const toPropWithParams = useMemo(() => {
     return interpolatePath(to, params, search, hash)

package/data/Generator/templates/sdk/wasp/client/router/NavLink.tsx

@@ -1,18 +1,18 @@
 import { useMemo } from 'react'
 import { NavLink as RouterNavLink } from 'react-router'
-import { interpolatePath } from './linkHelpers'
-import { type Routes } from './index'
+import { interpolatePath, type OptionalRouteOptions } from '@wasp.sh/lib-sdk-core'
+import type { Routes } from './index'
 
 type RouterNavLinkProps = Parameters<typeof RouterNavLink>[0]
 
 // PUBLIC API
-export function NavLink(
-  { to, params, search, hash, ...restOfProps }: Omit<RouterNavLinkProps, "to">
-  & {
-    search?: Record<string, string>;
-    hash?: string;
-  }
+export type NavLinkProps = Omit<RouterNavLinkProps, "to">
+  & OptionalRouteOptions
   & Routes
+
+// PUBLIC API
+export function NavLink(
+  { to, params, search, hash, ...restOfProps }: NavLinkProps
 ): React.JSX.Element {
   const toPropWithParams = useMemo(() => {
     return interpolatePath(to, params, search, hash)