Additional types

[zirkelc]

I created some additional helper types and I'd like to hear if you're interested in adding them to the library.

ElectroDB Playground

The GetEntityItem and DeleteEntityItem types are additions for the already existing Create and Update types:

type GetEntityItem<E extends Entity<any, any, any, any>> = E extends Entity<infer A, infer F, infer C, infer S>
  ? AllTableIndexCompositeAttributes<A, F, C, S>
  : never;

async function getTask(key: GetEntityItem<typeof tasks>) {
  const { data } = await tasks.get(key).go();

  return data;
}

type DeleteEntityItem<E extends Entity<any, any, any, any>> = E extends Entity<
  infer A,
  infer F,
  infer C,
  infer S
>
  ? AllTableIndexCompositeAttributes<A, F, C, S>
  : never;

async function deleteTask(key: DeleteEntityItem<typeof tasks>) {
  await tasks.delete(key).go();
}

The QueryIndex type extracts the allowed keys of the different query operations:

type QueryIndex<E extends Entity<any, any, any, any>, I extends keyof E['schema']['indexes']> = E extends Entity<
  infer A,
  infer F,
  infer C,
  infer S
>
  ? Queries<A, F, C, S>[I] extends (arg: infer P) => any
    ? P
    : never
  : never;

async function listTasksByProject(key: QueryIndex<typeof tasks, 'projects'>) {
  const { data } = await tasks.query.projects(key).go();

  return data;
}

async function listTasksByBacklog(key: QueryIndex<typeof tasks, 'backlog'>) {
  const { data } = await tasks.query.backlog(key).go();

  return data;
}

async function listTasksByAssigned(key: QueryIndex<typeof tasks, 'assigned'>) {
  const { data } = await tasks.query.assigned(key).go();

  return data;
}

Furthermore, I noticed the update(...).set(...).go() operation always returns a partial result, even though the actual result can be overridden by providing go({ response: 'all_new' }). I have created the following type that should return a complete result for all_new and all_old, a partial result for updated_new and updated_old, and null for none. The response type default is missing, because I didn't know what the default type is.

type UpdateRecordGoResponse<T, Options extends UpdateQueryOptions> = 
  Options extends { response: 'all_new' }
  ? T
  : Options extends { response: 'all_old' }
  ? T
  : Options extends { response: 'updated_new' }
  ? Partial<T>
  : Options extends { response: 'updated_old' }
  ? Partial<T>
  : Options extends { response: 'none' }
  ? null
  : Partial<T>;

export type UpdateRecordGo<ResponseType> = <T = ResponseType, Options extends UpdateQueryOptions = UpdateQueryOptions>(
  options?: Options,
) => Promise<{ data: UpdateRecordGoResponse<T, Options> }>;

async function updateTask(key: GetEntityItem<typeof tasks>, input: UpdateEntityItem<typeof tasks>) {
  const { data } = await entity.update(key).set(input).go({ response: 'all_new' });

  return data; 
}

If you think it makes sense to add one of these types, I could submit a PR.