Removed the model overload from createMachine

[mattpocock]

No description provided.

[changeset-bot]

🦋 Changeset detected

Latest commit: 51c0b6c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
xstate	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[mattpocock]

@Andarist will this work as intended?

[mattpocock]

Also, there are now only two overloads left in this file. They look very similar in signature - can we condense them into... only... ONE OVERLOAD...?

[mattpocock]

export function createMachine<
  TContext,
  TEvent extends EventObject = AnyEventObject,
  TTypestate extends Typestate<TContext> = { value: any; context: TContext }
>(
  // Ensure that only the first overload matches models, and prevent
  // accidental inference of the model as the `TContext` (which leads to cryptic errors)
  config: TContext extends Model<any, any, any, any>
    ? 'Passing typeof model to the first generic of createMachine is no longer supported - use model.createMachine instead'
    : MachineConfig<TContext, any, TEvent>,
  options?: Partial<MachineOptions<TContext, TEvent>>
): StateMachine<TContext, any, TEvent, TTypestate>;
export function createMachine<
  TContext,
  TEvent extends EventObject = AnyEventObject,
  TTypestate extends Typestate<TContext> = { value: any; context: TContext }
>(
  config: MachineConfig<TContext, any, TEvent>,
  options?: Partial<MachineOptions<TContext, TEvent>>
): StateMachine<TContext, any, TEvent, TTypestate> {
  return new StateNode<TContext, any, TEvent, TTypestate>(
    config,
    options
  ) as StateMachine<TContext, any, TEvent, TTypestate>;
}

[Andarist]

Note that createMachine has only a single overload here now - the second thing is like a private declaration. If possible you could still consolidate both though

[mattpocock]

Gotcha - it's not possible to consolidate both and still keep the pretty error message.

[Andarist]

This was already being implemented in https://github.com/statelyai/xstate/pull/2518/files#diff-00f777398251992f42d7061fc6a79e0c6e7c8aebfd257cb1d8c04129c84e0273R51 and accepted back then so I think it's an OK change.

[Andarist]

@mattpocock this test should be removed now:

xstate/packages/core/test/model.test.ts

Lines 470 to 483 in b0799ac

	it('should not compile if missing context with plain createMachine(...)', () => {
	const toggleModel = createModel({ count: 0 });
	// @ts-expect-error
	createMachine<typeof toggleModel>({
	id: 'machine',
	initial: 'inactive',
	// missing context:
	// context: toggleModel.initialContext,
	states: {
	inactive: {}
	}
	});
	});

[mattpocock]

@Andarist good spot, removed