Function createEntity

apps/hash-api/src/graph/knowledge/primitive/entity.ts:104–161

(
  ...args: Parameters<CreateEntityFunction<Properties>>
)

 * Create an entity.
 */
export const createEntity = async <
  Properties extends TypeIdsAndPropertiesForEntity,
>(
  ...args: Parameters<CreateEntityFunction<Properties>>
): ReturnType<CreateEntityFunction<Properties>> => {
  const [context, authentication, params] = args;
  const { outgoingLinks, ...createParams } = params;

  const { graphApi, provenance } = context;
  const { actorId } = authentication;

  let properties = params.properties;

  for (const beforeCreateHook of beforeCreateEntityHooks) {
    if (createParams.entityTypeIds.includes(beforeCreateHook.entityTypeId)) {
      const { properties: hookReturnedProperties } =
        await beforeCreateHook.callback({
          context,
          properties,
          authentication,
        });

      properties = hookReturnedProperties;
    }
  }

  const entity = await HashEntity.create<Properties>(
    graphApi,
    { actorId },
    {
      ...createParams,
      properties,
      provenance,
    },
  );

  for (const createOutgoingLinkParams of outgoingLinks ?? []) {
    await createLinkEntity(context, authentication, {
      ...createOutgoingLinkParams,
      linkData: {
        ...createOutgoingLinkParams.linkData,
        leftEntityId: entity.metadata.recordId.entityId,
      },
    });
  }

  for (const afterCreateHook of afterCreateEntityHooks) {
    if (entity.metadata.entityTypeIds.includes(afterCreateHook.entityTypeId)) {
      void afterCreateHook.callback({
        context,
        entity,
        authentication,
      });
    }
  }

  return entity;
};