Rename functionId to generateFunctionId for clarity and consistency across packages. Adjust associated logic and type definitions.

Only the internal implementation converts to url safe. If a consumer wants to use their own generator, the responsibility of generating safe urls is on them

Author: zenios

packages/directive-functions-plugin/src/compilers.ts

@@ -23,7 +23,9 @@ export type SupportedFunctionPath =
   | babel.NodePath<babel.types.FunctionExpression>
   | babel.NodePath<babel.types.ArrowFunctionExpression>
 
-export type FunctionIdFn = (opts: { currentId: string }) => string | undefined
+export type GenerateFunctionIdFn = (opts: {
+  currentId: string
+}) => string | undefined
 
 export type ReplacerFn = (opts: {
   fn: string
@@ -41,7 +43,7 @@ export type CompileDirectivesOpts = ParseAstOptions & {
   getRuntimeCode?: (opts: {
     directiveFnsById: Record<string, DirectiveFn>
   }) => string
-  functionId?: FunctionIdFn
+  generateFunctionId?: GenerateFunctionIdFn
   replacer: ReplacerFn
   // devSplitImporter: string
   filename: string
@@ -202,14 +204,6 @@ function findNearestVariableName(
   return nameParts.length > 0 ? nameParts.join('_') : 'anonymous'
 }
 
-function makeFunctionIdUrlSafe(location: string): string {
-  return location
-    .replace(/[^a-zA-Z0-9-_]/g, '_') // Replace unsafe chars with underscore
-    .replace(/_{2,}/g, '_') // Collapse multiple underscores
-    .replace(/^_|_$/g, '') // Trim leading/trailing underscores
-    .replace(/_--/g, '--') // Clean up the joiner
-}
-
 function makeIdentifierSafe(identifier: string): string {
   return identifier
     .replace(/[^a-zA-Z0-9_$]/g, '_') // Replace unsafe chars with underscore
@@ -225,7 +219,7 @@ export function findDirectives(
     directive: string
     directiveLabel: string
     replacer?: ReplacerFn
-    functionId?: FunctionIdFn
+    generateFunctionId?: GenerateFunctionIdFn
     directiveSplitParam: string
     filename: string
     root: string
@@ -478,8 +472,9 @@ export function findDirectives(
     // that we are executing
     const relativeFilename = path.relative(opts.root, baseFilename)
     let functionId = `${relativeFilename}--${functionName}`
-    if (opts.functionId) {
-      functionId = opts.functionId({ currentId: functionId }) ?? functionId
+    if (opts.generateFunctionId) {
+      functionId =
+        opts.generateFunctionId({ currentId: functionId }) ?? functionId
       // Handle cases in which the returned id conflicts with
       // one of the already defined ids
       if (functionId in directiveFnsById) {
@@ -491,7 +486,6 @@ export function findDirectives(
         functionId = deduplicatedId
       }
     }
-    functionId = makeFunctionIdUrlSafe(functionId)
 
     // If a replacer is provided, replace the function with the replacer
     if (opts.replacer) {

packages/directive-functions-plugin/src/index.ts

@@ -5,7 +5,7 @@ import { compileDirectives } from './compilers'
 import type {
   CompileDirectivesOpts,
   DirectiveFn,
-  FunctionIdFn,
+  GenerateFunctionIdFn,
 } from './compilers'
 import type { Plugin } from 'vite'
 
@@ -17,7 +17,7 @@ export type {
   DirectiveFn,
   CompileDirectivesOpts,
   ReplacerFn,
-  FunctionIdFn,
+  GenerateFunctionIdFn,
 } from './compilers'
 
 export type DirectiveFunctionsViteEnvOptions = Pick<
@@ -33,7 +33,7 @@ export type DirectiveFunctionsViteOptions = Pick<
 > &
   DirectiveFunctionsViteEnvOptions & {
     onDirectiveFnsById?: (directiveFnsById: Record<string, DirectiveFn>) => void
-    functionId?: FunctionIdFn
+    generateFunctionId?: GenerateFunctionIdFn
   }
 
 const createDirectiveRx = (directive: string) =>
@@ -67,7 +67,7 @@ export type DirectiveFunctionsVitePluginEnvOptions = Pick<
     server: DirectiveFunctionsViteEnvOptions & { envName?: string }
   }
   onDirectiveFnsById?: (directiveFnsById: Record<string, DirectiveFn>) => void
-  functionId?: FunctionIdFn
+  generateFunctionId?: GenerateFunctionIdFn
 }
 
 export function TanStackDirectiveFunctionsPluginEnv(
@@ -138,7 +138,7 @@ function transformCode({
   directive,
   directiveLabel,
   getRuntimeCode,
-  functionId,
+  generateFunctionId,
   replacer,
   onDirectiveFnsById,
   root,
@@ -163,7 +163,7 @@ function transformCode({
       directive,
       directiveLabel,
       getRuntimeCode,
-      functionId,
+      generateFunctionId,
       replacer,
       code,
       root,

packages/server-functions-plugin/src/index.ts

@@ -6,7 +6,7 @@ import {
 import type { DevEnvironment, Plugin, ViteDevServer } from 'vite'
 import type {
   DirectiveFn,
-  FunctionIdFn,
+  GenerateFunctionIdFn,
   ReplacerFn,
 } from '@tanstack/directive-functions-plugin'
 
@@ -19,7 +19,7 @@ export type ServerFnPluginOpts = {
    * and its modules.
    */
   manifestVirtualImportId: string
-  functionId?: FunctionIdFn
+  generateFunctionId?: GenerateFunctionIdFn
   client: ServerFnPluginEnvOpts
   ssr: ServerFnPluginEnvOpts
   server: ServerFnPluginEnvOpts
@@ -58,8 +58,12 @@ export function createTanStackServerFnPlugin(opts: ServerFnPluginOpts): {
       }
     },
   })
-  const functionId = buildFunctionId((functionIdOpts, next) =>
-    next(Boolean(viteDevServer), opts.functionId?.(functionIdOpts)),
+  const generateFunctionId = buildGenerateFunctionId(
+    (generateFunctionIdOpts, next) =>
+      next(
+        Boolean(viteDevServer),
+        opts.generateFunctionId?.(generateFunctionIdOpts),
+      ),
   )
 
   const directive = 'use server'
@@ -74,7 +78,7 @@ export function createTanStackServerFnPlugin(opts: ServerFnPluginOpts): {
         directive,
         directiveLabel,
         getRuntimeCode: opts.client.getRuntimeCode,
-        functionId,
+        generateFunctionId,
         replacer: opts.client.replacer,
         onDirectiveFnsById,
       }),
@@ -86,7 +90,7 @@ export function createTanStackServerFnPlugin(opts: ServerFnPluginOpts): {
         directive,
         directiveLabel,
         getRuntimeCode: opts.ssr.getRuntimeCode,
-        functionId,
+        generateFunctionId,
         replacer: opts.ssr.replacer,
         onDirectiveFnsById,
       }),
@@ -136,7 +140,7 @@ export function createTanStackServerFnPlugin(opts: ServerFnPluginOpts): {
         directive,
         directiveLabel,
         getRuntimeCode: opts.server.getRuntimeCode,
-        functionId,
+        generateFunctionId,
         replacer: opts.server.replacer,
         onDirectiveFnsById,
       }),
@@ -182,8 +186,12 @@ export function TanStackServerFnPluginEnv(
     },
   })
 
-  const functionId = buildFunctionId((functionIdOpts, next) =>
-    next(Boolean(serverDevEnv), opts.functionId?.(functionIdOpts)),
+  const generateFunctionId = buildGenerateFunctionId(
+    (generateFunctionIdOpts, next) =>
+      next(
+        Boolean(serverDevEnv),
+        opts.generateFunctionId?.(generateFunctionIdOpts),
+      ),
   )
 
   const directive = 'use server'
@@ -196,7 +204,7 @@ export function TanStackServerFnPluginEnv(
       directive,
       directiveLabel,
       onDirectiveFnsById,
-      functionId,
+      generateFunctionId,
       environments: {
         client: {
           envLabel: 'Client',
@@ -260,12 +268,20 @@ function resolveViteId(id: string) {
   return `\0${id}`
 }
 
-function buildFunctionId(
+function makeFunctionIdUrlSafe(location: string): string {
+  return location
+    .replace(/[^a-zA-Z0-9-_]/g, '_') // Replace unsafe chars with underscore
+    .replace(/_{2,}/g, '_') // Collapse multiple underscores
+    .replace(/^_|_$/g, '') // Trim leading/trailing underscores
+    .replace(/_--/g, '--') // Clean up the joiner
+}
+
+function buildGenerateFunctionId(
   delegate: (
-    opts: Parameters<FunctionIdFn>[0],
+    opts: Parameters<GenerateFunctionIdFn>[0],
     next: (dev: boolean, value?: string) => string,
   ) => string,
-): FunctionIdFn {
+): GenerateFunctionIdFn {
   const currentIdToGeneratedId = new Map<string, string>()
   const generatedIds = new Set<string>()
   return (opts) => {
@@ -274,10 +290,10 @@ function buildFunctionId(
     let generatedId = currentIdToGeneratedId.get(opts.currentId)
     if (generatedId === undefined) {
       generatedId = delegate(opts, (dev, newId) => {
-        // If no value provided, then return the currentId on development
+        // If no value provided, then return the url-safe currentId on development
         // and SHA256 using the currentId as seed on production
         if (newId === undefined) {
-          if (dev) newId = opts.currentId
+          if (dev) newId = makeFunctionIdUrlSafe(opts.currentId)
           else
             newId = crypto
               .createHash('sha256')
@@ -286,7 +302,6 @@ function buildFunctionId(
         }
         return newId
       })
-
       // Deduplicate in case the generated id conflicts with an existing id
       if (generatedIds.has(generatedId)) {
         let deduplicatedId

packages/start-plugin-core/src/plugin.ts

@@ -334,7 +334,7 @@ export function TanStackStartVitePluginCore(
       // This is the ID that will be available to look up and import
       // our server function manifest and resolve its module
       manifestVirtualImportId: VIRTUAL_MODULES.serverFnManifest,
-      functionId: startPluginOpts?.serverFns?.functionId,
+      generateFunctionId: startPluginOpts?.serverFns?.generateFunctionId,
       client: {
         getRuntimeCode: () =>
           `import { createClientRpc } from '@tanstack/${corePluginOpts.framework}-start/client-rpc'`,

packages/start-plugin-core/src/schema.ts

@@ -159,7 +159,7 @@ const tanstackStartOptionsSchema = z
     serverFns: z
       .object({
         base: z.string().optional().default('/_serverFn'),
-        functionId: z
+        generateFunctionId: z
           .function()
           .args(
             z.object({