@tulip-systems/core 0.8.2 → 0.9.0

package/src/modules/commands/components/render-command.tsx

@@ -1,19 +1,60 @@
-import { Fragment } from "react/jsx-runtime";
+"use client";
+
+import type { ReactNode } from "react";
+import type z from "zod";
 import { Allowed } from "@/modules/auth/components/allowed.client";
-import type { CommandDef } from "../lib/definitions";
+import { type CommandContextLifecycle, CommandContextProvider } from "../hooks/use-command.client";
+import type { CommandDef, CommandUI } from "../lib/builder";
+
+type RenderCommandProps<TSchema extends z.ZodTypeAny, TMeta> = {
+  command: CommandDef<TSchema, TMeta>;
+  data: z.input<TSchema>;
+  meta?: TMeta;
+  fallback?: ReactNode;
+  ui: CommandUI;
+} & CommandContextLifecycle;
+
+/**
+ * Command renderer.
+ *
+ * It validates input data through the command schema, applies optional visibility/disabled rules,
+ * exposes command status via context, and then renders the command content.
+ */
+export function RenderCommand<TSchema extends z.ZodTypeAny, TMeta>(
+  props: RenderCommandProps<TSchema, TMeta>,
+) {
+  const parsedData = props.command.schema.safeParse(props.data);
+  if (!parsedData.success) return <>{props.fallback}</>;
+  const data = parsedData.data;
+
+  const meta = (props.meta ?? {}) as TMeta;
 
-type RenderCommandProps<TData, TMeta> = {
-  command: CommandDef<TData, TMeta>;
-  render: (command: CommandDef<TData, TMeta>) => React.ReactNode;
-};
+  const visibleResult = props.command.visibleWhen?.({ data, meta });
+  const disabledResult = props.command.disabledWhen?.({ data, meta });
 
-export function RenderCommand<TData, TMeta>({ command, render }: RenderCommandProps<TData, TMeta>) {
-  const children = <Fragment key={command.name}>{render(command)}</Fragment>;
+  const isVisible = Array.isArray(visibleResult) ? visibleResult.every(Boolean) : (visibleResult ?? true);
+  if (!isVisible) return <>{props.fallback}</>;
+
+  const isDisabled = Array.isArray(disabledResult)
+    ? disabledResult.every(Boolean)
+    : (disabledResult ?? false);
+
+  const children = (
+    <CommandContextProvider
+      ui={props.ui}
+      disabled={isDisabled}
+      onSuccess={props.onSuccess}
+      onError={props.onError}
+      onSettled={props.onSettled}
+    >
+      {props.command.render({ data, meta, ui: props.ui })}
+    </CommandContextProvider>
+  );
 
-  if (!command.permission) return children;
+  if (!props.command.permission) return children;
 
   return (
-    <Allowed key={command.name} permission={command.permission}>
+    <Allowed permission={props.command.permission} fallback={props.fallback}>
       {children}
     </Allowed>
   );

package/src/modules/commands/components/utils/archive-command.client.tsx

@@ -0,0 +1,54 @@
+"use client";
+
+import type { DefaultError, MutationOptions } from "@tanstack/react-query";
+import { Icons } from "@/components/common/icons";
+import { CommandClick } from "../primitives/click-command.client";
+import { CommandLabel } from "../primitives/command-trigger.client";
+
+export type ArchiveCommandProps<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = { ids: string[] },
+  TOnMutateResult = unknown,
+> = {
+  variables: TVariables;
+  mutation: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
+};
+
+export function ArchiveCommand<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = { ids: string[] },
+  TOnMutateResult = unknown,
+>({ variables, mutation }: ArchiveCommandProps<TData, TError, TVariables, TOnMutateResult>) {
+  return (
+    <CommandClick
+      variables={variables}
+      mutation={mutation}
+      className="text-destructive"
+      label="Archiveren"
+    >
+      <Icons.archive className="w-4 text-destructive" />
+      <CommandLabel />
+    </CommandClick>
+  );
+}
+
+export function RestoreCommand<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = { ids: string[] },
+  TOnMutateResult = unknown,
+>({ variables, mutation }: ArchiveCommandProps<TData, TError, TVariables, TOnMutateResult>) {
+  return (
+    <CommandClick
+      className="flex gap-2"
+      variables={variables}
+      mutation={mutation}
+      label="Terugzetten"
+    >
+      <Icons.restore className="w-4" />
+      <CommandLabel />
+    </CommandClick>
+  );
+}

package/src/modules/commands/components/utils/delete-command.client.tsx

@@ -0,0 +1,70 @@
+"use client";
+
+import type { DefaultError, MutationOptions } from "@tanstack/react-query";
+import { Icons } from "@/components/common/icons";
+import {
+  CommandAlertDialog,
+  CommandAlertDialogAction,
+  CommandAlertDialogCancel,
+  CommandAlertDialogContent,
+  CommandAlertDialogDescription,
+  CommandAlertDialogFooter,
+  CommandAlertDialogHeader,
+  CommandAlertDialogTitle,
+  CommandAlertDialogTrigger,
+} from "../primitives/alert-dialog-command.client";
+import { CommandLabel } from "../primitives/command-trigger.client";
+
+export type DeleteCommandProps<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TOnMutateResult = unknown,
+> = {
+  variables: TVariables;
+  mutation: MutationOptions<TData, TError, TVariables, TOnMutateResult>;
+};
+
+export function DeleteCommand<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TOnMutateResult = unknown,
+>({ variables, mutation }: DeleteCommandProps<TData, TError, TVariables, TOnMutateResult>) {
+  return (
+    <CommandAlertDialog>
+      <CommandAlertDialogTrigger className="text-destructive" label="Verwijderen">
+        <Icons.trash className="w-4 text-destructive" />
+        <CommandLabel />
+      </CommandAlertDialogTrigger>
+
+      <CommandAlertDialogContent>
+        <CommandAlertDialogHeader>
+          <CommandAlertDialogTitle>
+            Weet je zeker dat je dit wilt verwijderen?
+          </CommandAlertDialogTitle>
+
+          <CommandAlertDialogDescription>
+            Dit kan niet ongedaan gemaakt worden en alle gegevens zullen verloren gaan.
+          </CommandAlertDialogDescription>
+        </CommandAlertDialogHeader>
+
+        <CommandAlertDialogFooter>
+          <CommandAlertDialogCancel>Annuleren</CommandAlertDialogCancel>
+          <CommandAlertDialogAction mutation={mutation} variables={variables}>
+            Verwijderen
+          </CommandAlertDialogAction>
+        </CommandAlertDialogFooter>
+      </CommandAlertDialogContent>
+    </CommandAlertDialog>
+  );
+}
+
+export function SingleDeleteCommand<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = { id: string },
+  TOnMutateResult = unknown,
+>({ variables, mutation }: DeleteCommandProps<TData, TError, TVariables, TOnMutateResult>) {
+  return <DeleteCommand variables={variables} mutation={mutation} />;
+}

package/src/modules/commands/entry.client.ts

@@ -1,31 +1,23 @@
 /**
  * Components
  */
-export * from "./components/alert-dialog-command.client";
-export * from "./components/click-command.client";
-export * from "./components/command-trigger.client";
-export * from "./components/dialog-command.client";
-export * from "./components/dropdown-command.client";
-export * from "./components/empty-command.client";
-export * from "./components/form-dialog-command.client";
+export * from "./components/menus/context-menu.client";
+export * from "./components/menus/dropdown-menu.client";
+export * from "./components/menus/floating-menu.client";
+export * from "./components/menus/inline-menu.client";
+export * from "./components/menus/responsive-menu.client";
+export * from "./components/primitives/alert-dialog-command.client";
+export * from "./components/primitives/click-command.client";
+export * from "./components/primitives/command-trigger.client";
+export * from "./components/primitives/dialog-command.client";
+export * from "./components/primitives/dropdown-command.client";
+export * from "./components/primitives/empty-command.client";
+export * from "./components/primitives/form-dialog-command.client";
+export * from "./components/utils/archive-command.client";
+export * from "./components/utils/delete-command.client";
 
 /**
  * Hooks
  */
+export * from "./hooks/use-command.client";
 export * from "./hooks/use-command-mutation.client";
-
-/**
- * Menus
- */
-export * from "./menus/context-menu.client";
-export * from "./menus/dropdown-menu.client";
-export * from "./menus/floating-menu.client";
-export * from "./menus/inline-menu.client";
-export * from "./menus/responsive-menu.client";
-
-/**
- * Utils
- */
-export * from "./utils/archive-command.client";
-export * from "./utils/delete-command.client";
-export * from "./utils/send-mail-command.client";

package/src/modules/commands/entry.ts

@@ -1,2 +1,5 @@
-export * from "./lib/definitions";
-export * from "./lib/factory";
+/**
+ * Lib
+ */
+export * from "./lib/builder";
+export * from "./lib/registery";

package/src/modules/commands/hooks/use-command-mutation.client.ts

@@ -0,0 +1,48 @@
+"use client";
+
+import type { DefaultError, MutationFunction, MutationOptions } from "@tanstack/react-query";
+import { useRouter } from "next/navigation";
+import { useAction } from "@/lib/hooks/use-action";
+import { useCommand } from "./use-command.client";
+
+export type CommandMutationMeta = {
+  router: ReturnType<typeof useRouter>;
+};
+
+export function useCommandMutation<
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = void,
+  TOnMutateResult = unknown,
+>(options?: MutationOptions<TData, TError, TVariables, TOnMutateResult>) {
+  const router = useRouter();
+  const commandContext = useCommand();
+
+  return useAction({
+    ...options,
+    mutationFn: options?.mutationFn as MutationFunction<TData, TVariables>,
+    onMutate: async (...params) => {
+      const result = options?.onMutate?.(...params);
+      commandContext.setStatus("pending");
+      return (await result) as TOnMutateResult;
+    },
+    onSuccess: async (...params) => {
+      const result = options?.onSuccess?.(...params);
+      commandContext.setStatus("success");
+      return await result;
+    },
+    onError: async (...params) => {
+      const result = options?.onError?.(...params);
+      commandContext.setStatus("error");
+      return await result;
+    },
+    onSettled: async (...params) => {
+      const result = options?.onSettled?.(...params);
+      commandContext.setStatus("idle");
+      return await result;
+    },
+    meta: {
+      router,
+    } satisfies CommandMutationMeta,
+  });
+}

package/src/modules/commands/hooks/use-command.client.tsx

@@ -0,0 +1,78 @@
+"use client";
+
+import {
+  createContext,
+  type Dispatch,
+  type PropsWithChildren,
+  type SetStateAction,
+  useContext,
+  useEffect,
+  useRef,
+  useState,
+} from "react";
+import type { CommandStatus, CommandUI } from "../lib/builder";
+
+type CommandContextValue = {
+  ui: CommandUI;
+  status: CommandStatus;
+  disabled: boolean;
+  setStatus: Dispatch<SetStateAction<CommandStatus>>;
+};
+
+const CommandContext = createContext<CommandContextValue | null>(null);
+
+export function useCommand() {
+  const context = useContext(CommandContext);
+  if (!context) {
+    throw new Error("useCommand must be used within CommandContextProvider");
+  }
+
+  return context;
+}
+
+export type CommandContextLifecycle = {
+  onSuccess?: () => Promise<void> | void;
+  onError?: () => Promise<void> | void;
+  onSettled?: () => Promise<void> | void;
+};
+
+type CommandContextProviderProps = PropsWithChildren<
+  CommandContextLifecycle & {
+    ui: CommandUI;
+    disabled?: boolean;
+  }
+>;
+
+export function CommandContextProvider({
+  children,
+  ui,
+  disabled = false,
+  onSuccess,
+  onError,
+  onSettled,
+}: CommandContextProviderProps) {
+  const [status, setStatus] = useState<CommandStatus>("idle");
+  const previousStatusRef = useRef<CommandStatus>("idle");
+
+  useEffect(() => {
+    if (status === previousStatusRef.current) return;
+
+    if (status === "success") {
+      void onSuccess?.();
+      void onSettled?.();
+    }
+
+    if (status === "error") {
+      void onError?.();
+      void onSettled?.();
+    }
+
+    previousStatusRef.current = status;
+  }, [status, onSuccess, onError, onSettled]);
+
+  return (
+    <CommandContext.Provider value={{ ui, status, disabled, setStatus }}>
+      {children}
+    </CommandContext.Provider>
+  );
+}

package/src/modules/commands/lib/builder.ts

@@ -0,0 +1,91 @@
+import type { z } from "zod";
+import type { Permission } from "@/modules/auth/lib/permissions";
+
+export type CommandUI = "dropdown" | "context" | "table" | "inline" | "custom";
+
+export type CommandStatus = "idle" | "pending" | "success" | "error";
+
+export type CommandCondition<TSchema extends z.ZodTypeAny, TMeta> = (params: {
+  data: z.output<TSchema>;
+  meta: TMeta;
+}) => boolean | boolean[];
+
+export type CommandRender<TSchema extends z.ZodTypeAny, TMeta> = (params: {
+  data: z.output<TSchema>;
+  meta: TMeta;
+  ui: CommandUI;
+}) => React.ReactNode;
+
+/**
+ * Final command definition (without name).
+ * Name is derived from the object key in `defineCommands`.
+ */
+export type CommandDef<TSchema extends z.ZodTypeAny = z.ZodTypeAny, TMeta = object> = {
+  permission?: Permission;
+  schema: TSchema;
+  visibleWhen?: CommandCondition<TSchema, TMeta>;
+  disabledWhen?: CommandCondition<TSchema, TMeta>;
+  render: CommandRender<TSchema, TMeta>;
+};
+
+type ReadyCommandBuilder<TSchema extends z.ZodTypeAny, TMeta> = {
+  permission(permission: Permission): ReadyCommandBuilder<TSchema, TMeta>;
+  visibleWhen(condition: CommandCondition<TSchema, TMeta>): ReadyCommandBuilder<TSchema, TMeta>;
+  disabledWhen(condition: CommandCondition<TSchema, TMeta>): ReadyCommandBuilder<TSchema, TMeta>;
+  render(render: CommandRender<TSchema, TMeta>): CommandDef<TSchema, TMeta>;
+};
+
+type InitialCommandBuilder<TMeta> = {
+  input<TNextSchema extends z.ZodTypeAny>(schema: TNextSchema): ReadyCommandBuilder<TNextSchema, TMeta>;
+};
+
+type StartState<TMeta> = {
+  permission?: Permission;
+  meta?: TMeta;
+};
+
+type ReadyState<TSchema extends z.ZodTypeAny, TMeta> = {
+  permission?: Permission;
+  schema: TSchema;
+  visibleWhen?: CommandCondition<TSchema, TMeta>;
+  disabledWhen?: CommandCondition<TSchema, TMeta>;
+};
+
+function createInitialBuilder<TMeta>(state: StartState<TMeta>): InitialCommandBuilder<TMeta> {
+  return {
+    input<TNextSchema extends z.ZodTypeAny>(schema: TNextSchema) {
+      return createReadyBuilder<TNextSchema, TMeta>({ permission: state.permission, schema });
+    },
+  };
+}
+
+function createReadyBuilder<TSchema extends z.ZodTypeAny, TMeta>(
+  state: ReadyState<TSchema, TMeta>,
+): ReadyCommandBuilder<TSchema, TMeta> {
+  return {
+    permission(permission: Permission) {
+      return createReadyBuilder<TSchema, TMeta>({ ...state, permission });
+    },
+    visibleWhen(condition: CommandCondition<TSchema, TMeta>) {
+      return createReadyBuilder<TSchema, TMeta>({ ...state, visibleWhen: condition });
+    },
+    disabledWhen(condition: CommandCondition<TSchema, TMeta>) {
+      return createReadyBuilder<TSchema, TMeta>({ ...state, disabledWhen: condition });
+    },
+    render(render: CommandRender<TSchema, TMeta>) {
+      return {
+        permission: state.permission,
+        schema: state.schema,
+        visibleWhen: state.visibleWhen,
+        disabledWhen: state.disabledWhen,
+        render,
+      };
+    },
+  };
+}
+
+export function createCommandBuilder<TMeta = object>(): InitialCommandBuilder<TMeta> {
+  return createInitialBuilder<TMeta>({});
+}
+
+export const commandBuilder = createCommandBuilder();

package/src/modules/commands/lib/registery.ts

@@ -0,0 +1,116 @@
+import type z from "zod";
+import type { CommandDef } from "./builder";
+
+/**
+ * Command map type defining the shape of command definitions.
+ */
+export type CommandMap = Record<string, CommandDef<z.ZodTypeAny, any>>;
+
+type CommandKey<TCommands extends CommandMap> = Extract<keyof TCommands, string>;
+type CommandFlags<TCommands extends CommandMap> = Partial<Record<CommandKey<TCommands>, boolean>>;
+type CommandInput<TCommands extends CommandMap> =
+  | readonly CommandKey<TCommands>[]
+  | CommandFlags<TCommands>;
+
+type TruthyKeys<T> = {
+  [K in keyof T]-?: T[K] extends true ? K : never;
+}[keyof T];
+
+type PickedCommands<
+  TCommands extends CommandMap,
+  TInput extends CommandInput<TCommands>,
+> = TInput extends readonly CommandKey<TCommands>[]
+  ? Pick<TCommands, TInput[number]>
+  : TInput extends CommandFlags<TCommands>
+      ? Pick<TCommands, Extract<TruthyKeys<TInput>, keyof TCommands>>
+      : never;
+
+type OmittedCommands<
+  TCommands extends CommandMap,
+  TInput extends CommandInput<TCommands>,
+> = TInput extends readonly CommandKey<TCommands>[]
+  ? Omit<TCommands, TInput[number]>
+  : TInput extends CommandFlags<TCommands>
+      ? Omit<TCommands, Extract<TruthyKeys<TInput>, keyof TCommands>>
+      : never;
+
+type ExtendedCommands<TBase extends CommandMap, TExtension extends CommandMap> = Omit<
+  TBase,
+  keyof TExtension
+> &
+  TExtension;
+
+/**
+ * Command registry type with utility methods for picking, omitting, and converting to array.
+ * This allows for flexible manipulation of command sets while maintaining type safety.
+ */
+type CommandRegistry<TCommands extends CommandMap> = {
+  commands: TCommands;
+  extend<const TExtension extends CommandMap>(
+    extension: TExtension,
+  ): CommandRegistry<ExtendedCommands<TCommands, TExtension>>;
+  pick<const TInput extends CommandInput<TCommands>>(
+    input: TInput,
+  ): CommandRegistry<PickedCommands<TCommands, TInput>>;
+  omit<const TInput extends CommandInput<TCommands>>(
+    input: TInput,
+  ): CommandRegistry<OmittedCommands<TCommands, TInput>>;
+  toArray(): Array<CommandDef<z.ZodTypeAny, any>>;
+};
+
+function toKeys<TCommands extends CommandMap>(
+  input: CommandInput<TCommands>,
+): Array<CommandKey<TCommands>> {
+  if (Array.isArray(input)) return [...input];
+
+  return (Object.entries(input) as Array<[CommandKey<TCommands>, boolean | undefined]>)
+    .filter(([, enabled]) => enabled === true)
+    .map(([key]) => key);
+}
+
+/**
+ * Internal function to create a command registry from a given command map.
+ */
+function createRegistry<TCommands extends CommandMap>(
+  commands: TCommands,
+): CommandRegistry<TCommands> {
+  return {
+    commands,
+    extend<const TExtension extends CommandMap>(extension: TExtension) {
+      const next = { ...commands, ...extension } as ExtendedCommands<TCommands, TExtension>;
+      return createRegistry(next);
+    },
+    pick<const TInput extends CommandInput<TCommands>>(input: TInput) {
+      const keys = toKeys<TCommands>(input);
+      const next = Object.fromEntries(
+        keys.flatMap((key) => (key in commands ? [[key, commands[key]]] : [])),
+      ) as PickedCommands<TCommands, TInput>;
+
+      return createRegistry(next);
+    },
+    omit<const TInput extends CommandInput<TCommands>>(input: TInput) {
+      const keys = toKeys<TCommands>(input);
+      const blacklist = new Set(keys);
+      const next = Object.fromEntries(
+        Object.entries(commands).filter(([key]) => !blacklist.has(key as CommandKey<TCommands>)),
+      ) as OmittedCommands<TCommands, TInput>;
+
+      return createRegistry(next);
+    },
+    toArray() {
+      return Object.values(commands) as Array<CommandDef<z.ZodTypeAny, any>>;
+    },
+  };
+}
+
+/**
+ * Public function to define commands. It takes a command map and returns a command registry with utility methods.
+ * This is the main entry point for users to create their command sets.
+ * @param commands - A map of command definitions keyed by command name.
+ * @returns A command registry with the defined commands and utility methods.
+ */
+export function defineCommands<TCommands extends CommandMap>(
+  commands: TCommands,
+): CommandRegistry<TCommands> {
+  return createRegistry(commands);
+}

package/src/modules/data-tables/components/filters/combobox.client.tsx

@@ -1,7 +1,7 @@
 "use client";
 
-import { Check, type LucideIcon, PlusCircle } from "lucide-react";
-import { type ParserBuilder, useQueryState } from "nuqs";
+import { ListFilter, type LucideIcon } from "lucide-react";
+import { type SingleParserBuilder, useQueryState } from "nuqs";
 import { startTransition, useOptimistic } from "react";
 import { Badge } from "@/components/ui/badge";
 import { Button } from "@/components/ui/button";
@@ -11,6 +11,7 @@ import {
   CommandGroup,
   CommandInput,
   CommandItem,
+  CommandItemCheck,
   CommandList,
   CommandSeparator,
 } from "@/components/ui/command.client";
@@ -28,7 +29,7 @@ export type TableFilterComboboxOption = {
 
 export type TableFilterComboboxProps<TValue extends string = string> = {
   title?: string;
-  filter: { name: string; parser: ParserBuilder<TValue[] | null> };
+  filter: { name: string; parser: SingleParserBuilder<TValue[] | null> };
   options: TableFilterComboboxOption[];
 };
 
@@ -47,11 +48,11 @@ export function TableFilterCombobox<TValue extends string>({
     <Popover>
       <PopoverTrigger asChild>
         <Button type="button" variant="outline" size="sm" className="h-8 border-dashed">
-          <PlusCircle className="h-4 w-4" />
+          <ListFilter className="mr-1 h-4 w-4" />
           {title}
           {selectedValues?.size > 0 && (
             <>
-              <Separator orientation="vertical" className="mx-2 h-4" />
+              <Separator orientation="vertical" className="mx-2 h-full" />
               <Badge variant="secondary" className="rounded-sm px-1 font-normal lg:hidden">
                 {selectedValues.size}
               </Badge>
@@ -90,6 +91,8 @@ export function TableFilterCombobox<TValue extends string>({
                 return (
                   <CommandItem
                     key={option.value}
+                    value={option.value}
+                    data-checked={selectedValues.has(option.value)}
                     onSelect={() =>
                       startTransition(() => {
                         const newSelectedValues = new Set(selectedValues);
@@ -105,14 +108,7 @@ export function TableFilterCombobox<TValue extends string>({
                       })
                     }
                   >
-                    <div
-                      data-active={selectedValues.has(option.value)}
-                      className={cn(
-                        "mr-2 flex h-4 w-4 items-center justify-center rounded-sm border border-primary opacity-50 data-[active=true]:bg-primary data-[active=true]:text-primary-foreground data-[active=true]:opacity-100 [&>svg]:invisible data-[active=true]:[&>svg]:visible data-[active=true]:[&>svg]:text-primary-foreground",
-                      )}
-                    >
-                      <Check className="h-4 w-4 text-foreground" />
-                    </div>
+                    <CommandItemCheck />
 
                     <div className="flex flex-1 items-center gap-2">
                       {Icon && <Icon className={cn("size-4", option.className)} />}