embedded-resources.md

Embedded Resources

AshTypescript provides full support for embedded resources with complete type safety. Embedded resources are treated similarly to relationships, allowing you to select nested fields with the same field selection syntax.

Basic Usage

Define an embedded resource attribute in your Ash resource:

# In your resource
attribute :metadata, MyApp.TodoMetadata do
  public? true
end

Use field selection to request embedded resource fields:

// TypeScript usage
const todo = await getTodo({
  fields: [
    "id", "title",
    { metadata: ["category", "priorityScore", "tags", "customFields"] }
  ],
  input: { id: "todo-123" }
});

Type Safety

Embedded resources receive full type inference:

// Generated types include embedded resource fields
type Todo = {
  id: string;
  title: string;
  metadata?: {
    category: string;
    priorityScore: number;
    tags: string[];
    customFields: Record<string, any>;
  } | null;
};

Nested Embedded Resources

Embedded resources can contain other embedded resources:

# MyApp.TodoMetadata embedded resource
defmodule MyApp.TodoMetadata do
  use Ash.Resource, data_layer: :embedded

  attributes do
    attribute :category, :string, public?: true
    attribute :priority_score, :integer, public?: true
    attribute :author_info, MyApp.AuthorInfo, public?: true  # Nested embedded
  end
end

// Select nested embedded resource fields
const todo = await getTodo({
  fields: [
    "id",
    {
      metadata: [
        "category",
        { authorInfo: ["name", "email"] }
      ]
    }
  ],
  input: { id: "todo-123" }
});

Arrays of Embedded Resources

Embedded resources in arrays work the same way:

attribute :comments, {:array, MyApp.Comment}, public?: true

const todo = await getTodo({
  fields: [
    "id",
    { comments: ["text", "createdAt", { author: ["name"] }] }
  ],
  input: { id: "todo-123" }
});

// Result
type Todo = {
  id: string;
  comments: Array<{
    text: string;
    createdAt: string;
    author: { name: string };
  }>;
};

Next Steps

• Union Types - Working with union types
• Field Selection - Understand field selection syntax
• Ash Embedded Resources - Learn about Ash embedded resources in depth