Mutations

createDomainMutations turns a service into TanStack mutations.

import { createModelKeys } from '@arex95/phalanx';

const userKeys = createModelKeys('admin:user');
// { list: 'admin:user:list', item: 'admin:user:item', selected: …, collection: …, filter: … }

The five are required and always the same shape, so writing them out is five chances to typo a string nothing checks. Namespacing (admin:user) keeps two modules that both expose a list from colliding.

import { createDomainMutations } from '@arex95/phalanx';

export function useUserMutations() {
    // Inside a function: both factories need Vue's injection context.
    return createDomainMutations({
        service: UserService,
        keys: userKeys
    });
}

The examples below assume it has been called from a component's setup:

const userMutations = useUserMutations();

Returns create, update, patch, remove, and one mutation per custom service method.

const { mutate, mutateAsync, isPending, error } = userMutations.update;

mutate({ id: '7', data: { name: 'Ada' } });
await mutateAsync({ id: '7', data: { name: 'Ada' } });

Mutation	Variables
create	Partial<TDTO>
update · patch	{ id, data }
remove	id
custom	the method's own parameter

Invalidation

After a mutation succeeds, keys.list and keys.item are invalidated. Override per method:

createDomainMutations({
    service: UserService,
    keys: userKeys,
    invalidate: {
        create: ['users', 'dashboard-stats'],   // added to the defaults
        patch:  { only: ['user'] }              // replaces them
    }
});

extraInvalidateKeys adds keys to every mutation in the object.

An operation declared with defineAction can carry its own invalidate, which takes precedence over both.

Custom mutations

const { mutate: suspend } = userMutations.suspend;
suspend(userId);

The variables type is inferred from the service method. A method with no parameters produces a mutation taking void.

WARNING

Only single-parameter methods are picked up; the generated signature cannot express more. A method taking two parameters is omitted from the object.

Optimistic updates and callbacks

These are standard TanStack mutations, so the usual options apply at the call site:

const qc = useQueryClient();

userMutations.patch.mutate(
    { id, data },
    {
        onSuccess: () => qc.invalidateQueries({ queryKey: ['audit-log'] }),
        onError: (error) => toast.error(error.message)
    }
);

Errors arrive as typed errors, so error instanceof ValidationError works in onError.

Hydrating results

With a model constructor, mutations resolve to an instance and accept Partial<TDTO> as input:

createDomainMutations({ service: UserService, keys: userKeys, model: User });