Resolves pointers for GraphQL API batch loading.

Examples

iex> Bonfire.Common.Needles.dataloader(context)
%Dataloader{...}

Checks if an object exists based on the given filters.

Examples

iex> Bonfire.Common.Needles.exists?("some_id")
true

iex> Bonfire.Common.Needles.exists?("non_existent_id")
false

Filters a single pointer from a query result.

Examples

iex> Bonfire.Common.Needles.filter_one("http://url")
[canonical_uri: "http://url"]

Applies filters to a query.

Examples

iex> Bonfire.Common.Needles.filters(query, filters)
%Ecto.Query{...}

Follows one or more pointers and returns the schema struct.

Examples

> Bonfire.Common.Needles.follow!(%Pointer{id: "some_id"})
%SomeRecord{}

> Bonfire.Common.Needles.follow!([%Pointer{id: "some_id"}])
[%SomeRecord{}]

@spec forge!(%{__struct__: atom(), id: binary()}) :: %Needle.Pointer{
  __meta__: term(),
  account: term(),
  accounted: term(),
  activities: term(),
  activity: term(),
  actor: term(),
  boost_count: term(),
  care_closure: term(),
  caretaker: term(),
  category: term(),
  character: term(),
  choices: term(),
  circle: term(),
  controlled: term(),
  created: term(),
  deleted_at: term(),
  direct_replies: term(),
  dummy: term(),
  edge: term(),
  encircle_subjects: term(),
  extra_info: term(),
  feed_publishes: term(),
  files: term(),
  follow_count: term(),
  geolocation: term(),
  id: term(),
  labelled: term(),
  like_count: term(),
  media: term(),
  message: term(),
  named: term(),
  peered: term(),
  pointed: term(),
  post: term(),
  post_content: term(),
  profile: term(),
  ranked: term(),
  replied: term(),
  seen: term(),
  sensitive: term(),
  settings: term(),
  stereotyped: term(),
  table: term(),
  table_id: term(),
  tagged: term(),
  tags: term(),
  tree: term(),
  user: term()
}

Forge a pointer from a pointable object.

Does not hit the database, is safe so long as the provided struct participates in the meta abstraction.

Examples

iex> Bonfire.Common.Needles.forge!(%{__struct__: MySchema, id: "some_id"})
%Pointer{id: "some_id", ...}

@spec forge!(table_id :: integer() | atom(), id :: binary()) :: %Needle.Pointer{
  __meta__: term(),
  account: term(),
  accounted: term(),
  activities: term(),
  activity: term(),
  actor: term(),
  boost_count: term(),
  care_closure: term(),
  caretaker: term(),
  category: term(),
  character: term(),
  choices: term(),
  circle: term(),
  controlled: term(),
  created: term(),
  deleted_at: term(),
  direct_replies: term(),
  dummy: term(),
  edge: term(),
  encircle_subjects: term(),
  extra_info: term(),
  feed_publishes: term(),
  files: term(),
  follow_count: term(),
  geolocation: term(),
  id: term(),
  labelled: term(),
  like_count: term(),
  media: term(),
  message: term(),
  named: term(),
  peered: term(),
  pointed: term(),
  post: term(),
  post_content: term(),
  profile: term(),
  ranked: term(),
  replied: term(),
  seen: term(),
  sensitive: term(),
  settings: term(),
  stereotyped: term(),
  table: term(),
  table_id: term(),
  tagged: term(),
  tags: term(),
  tree: term(),
  user: term()
}

Forges a pointer to a participating meta entity

Does not hit the database, is safe so long as the entry we wish to synthesise a pointer for represents a legitimate entry in the database.

Examples

iex> Bonfire.Common.Needles.forge!(:my_table, "some_id")
%Pointer{id: "some_id", ...}

Retrieves an object by its ID.

Examples

iex> Bonfire.Common.Needles.get("existing_id")
{:ok, %Pointer{id: "existing_id", ...}}

iex> Bonfire.Common.Needles.get("non_existent_id")
{:error, :not_found}

Retrieves an object by its ID. Raises NotFound if the object cannot be found.

Examples

iex> Bonfire.Common.Needles.get!("existing_id")
%Pointer{id: "existing_id", ...}

iex> Bonfire.Common.Needles.get!("non_existent_id")
** (Needle.NotFound) ...

Filters an object by its binary ID.

Examples

iex> Bonfire.Common.Needles.id_binary(id: "some_id")

Filters an object by its ID.

Examples

iex> Bonfire.Common.Needles.id_filter(query, id: "some_id")

Retrieves a list of objects based on pointers or IDs.

Examples

iex> Bonfire.Common.Needles.list!(["id1", "id2"])
[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]

iex> Bonfire.Common.Needles.list!([%Pointer{id: "id1"}, %Pointer{id: "id2"}])
[%Pointer{id: "id1", ...}, %Pointer{id: "id2", ...}]

Retrieves objects based on type and filters.

Examples

> Bonfire.Common.Needles.list_by_type!(:my_table, [filter: value])
[%Pointer{...}, %Pointer{...}]

Retrieves a list of known IDs

Examples

iex> Bonfire.Common.Needles.list_ids()
["id1", "id2"]

Retrieves many objects based on the provided filters

Examples

> Bonfire.Common.Needles.many([id: "some_id"])
{:ok, [%Pointer{id: "some_id", ...}]}

> Bonfire.Common.Needles.many([id: "non_existing_id"])
{:ok, []}

Retrieves many objects based on the provided filters

iex> Bonfire.Common.Needles.many!([id: "some_id"])
[%Pointer{id: "some_id", ...}]

Turns a thing into a pointer if it is not already or returns nil.

Examples

iex> Bonfire.Common.Needles.maybe_forge(%Pointer{id: "existing_id"})
%Pointer{id: "existing_id"}

iex> Bonfire.Common.Needles.maybe_forge(%{pointer_id: "existing_id"})
%Pointer{id: "existing_id"}

iex> Bonfire.Common.Needles.maybe_forge(%{id: "existing_id"})
nil

Turns a thing into a pointer if it is not already. Errors if it cannot be performed.

iex> Bonfire.Common.Needles.maybe_forge!(%Pointer{id: "existing_id"})
%Pointer{id: "existing_id"}

iex> Bonfire.Common.Needles.maybe_forge!(%{pointer_id: "existing_id"})
%Pointer{id: "existing_id"}

iex> Bonfire.Common.Needles.maybe_forge!(%{id: "non_existing_id"})
** (RuntimeError) ...

Resolves associations or fields based on the given parent and context.

Examples

iex> Bonfire.Common.Needles.maybe_resolve(parent, field, args, context)
{:ok, resolved_data}

Retrieves an object by its ID or pointer.

Examples

iex> Bonfire.Common.Needles.get("some_id")
{:ok, %Pointer{id: "some_id", ...}}

iex> Bonfire.Common.Needles.get([id: "some_id"])
{:ok, %Pointer{id: "existing_id", ...}}

Retrieves a single object based on the provided filters with bang.

iex> Bonfire.Common.Needles.one!("some_id")
%Pointer{id: "some_id", ...}

iex> Bonfire.Common.Needles.one!([id: "some_id"])
%Pointer{id: "some_id", ...}

Preloads associations based on the given preloads option.

Examples

> Bonfire.Common.Needles.pointer_preloads(query, :with_creator)
%Ecto.Query{...}

> Bonfire.Common.Needles.pointer_preloads(query, :tags)
%Ecto.Query{...}

Prepares a query for pointers.

Examples

> Bonfire.Common.Needles.pointer_query(query, opts)
%Ecto.Query{...}

> Bonfire.Common.Needles.pointer_query([id: "some_id"], opts)
%Ecto.Query{...}

@spec preload!(Needle.Pointer.t() | [Needle.Pointer.t()], list()) ::
  Needle.Pointer.t() | [Needle.Pointer.t()]

Follows one or more pointers and adds the pointed records to the pointed attrs.

> Bonfire.Common.Needles.preload!(%Pointer{id: "some_id"})
%Pointer{id: "some_id", pointed: %SomeRecord{}}

> Bonfire.Common.Needles.preload!([%Pointer{id: "some_id"}])
[%Pointer{id: "some_id", pointed: %SomeRecord{}}]

Queries a dataset based on provided filters.

Examples

> Bonfire.Common.Needles.query(filters)
%Ecto.Query{...}