Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Kino.Hub to Kino.Workspace #434

Merged
merged 1 commit into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 3 additions & 56 deletions lib/kino/hub.ex
Original file line number Diff line number Diff line change
@@ -1,59 +1,6 @@
defmodule Kino.Hub do
@moduledoc """
Functions related to hub integrations and Livebook apps.
"""
@moduledoc false

@type app_info ::
%{type: :single}
| %{:type => :multi, optional(:started_by) => user_info()}
| %{type: :none}

@type user_info :: %{
id: String.t(),
name: String.t() | nil,
email: String.t() | nil,
source: atom(),
payload: map() | nil
}

@doc """
Returns information about the running app.

Note that `:started_by` information is only available for multi-session
apps when the app uses a Livebook Teams workspace.

Unless called from within an app deployment, returns `%{type: :none}`.
"""
@spec app_info() :: app_info()
def app_info() do
case Kino.Bridge.get_app_info() do
{:ok, app_info} ->
app_info

{:request_error, reason} ->
raise "failed to access app info, reason: #{inspect(reason)}"
end
end

@doc """
Returns user information for the given connected client id.

Note that this information is only available when the session uses
Livebook Teams workspace, otherwise `:not_available` error is returned.

If there is no such connected client, `:not_found` error is returned.
"""
@spec user_info(String.t()) :: {:ok, user_info()} | {:error, :not_found | :not_available}
def user_info(client_id) do
case Kino.Bridge.get_user_info(client_id) do
{:ok, user_info} ->
{:ok, user_info}

{:error, reason} ->
{:error, reason}

{:request_error, reason} ->
raise "failed to access user info, reason: #{inspect(reason)}"
end
end
@deprecated "Use Kino.Workspace.app_info/0 instead"
defdelegate app_info(), to: Kino.Workspace
end
59 changes: 59 additions & 0 deletions lib/kino/workspace.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
defmodule Kino.Workspace do
@moduledoc """
Functions related to workspace integrations and Livebook apps.
"""

@type app_info ::
%{type: :single}
| %{:type => :multi, optional(:started_by) => user_info()}
| %{type: :none}

@type user_info :: %{
id: String.t(),
name: String.t() | nil,
email: String.t() | nil,
source: atom(),
payload: map() | nil
}

@doc """
Returns information about the running app.

Note that `:started_by` information is only available for multi-session
apps when the app uses a Livebook Teams workspace.

Unless called from within an app deployment, returns `%{type: :none}`.
"""
@spec app_info() :: app_info()
def app_info() do
case Kino.Bridge.get_app_info() do
{:ok, app_info} ->
app_info

{:request_error, reason} ->
raise "failed to access app info, reason: #{inspect(reason)}"
end
end

@doc """
Returns user information for the given connected client id.

Note that this information is only available when the session uses
Livebook Teams workspace, otherwise `:not_available` error is returned.

If there is no such connected client, `:not_found` error is returned.
"""
@spec user_info(String.t()) :: {:ok, user_info()} | {:error, :not_found | :not_available}
def user_info(client_id) do
case Kino.Bridge.get_user_info(client_id) do
{:ok, user_info} ->
{:ok, user_info}

{:error, reason} ->
{:error, reason}

{:request_error, reason} ->
raise "failed to access user info, reason: #{inspect(reason)}"
end
end
end
Loading