initial vibe

Author: matt-beanland

config/config.exs

@@ -37,5 +37,5 @@ config :spark,
   ]
 
 config :diffo, ash_domains: [Diffo.Provider]
-config :diffo_example, ash_domains: [DiffoExample.Access]
+config :diffo_example, ash_domains: [DiffoExample.Access, DiffoExample.Nbn]
 import_config "#{config_env()}.exs"

lib/nbn/nbn.ex

@@ -0,0 +1,82 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  Nbn - example NBN domain
+
+  Models NBN network resources including the Ethernet circuit (NbnEthernet)
+  and its constituent resources: UNI (dedicated), AVC (dedicated), NTD,
+  CVC (aggregates AVCs, terminates at NNI Group), NNI Group, and NNI.
+  """
+  use Ash.Domain,
+    otp_app: :diffo
+
+  alias DiffoExample.Nbn.NbnEthernet
+  alias DiffoExample.Nbn.Uni
+  alias DiffoExample.Nbn.Avc
+  alias DiffoExample.Nbn.Ntd
+  alias DiffoExample.Nbn.Cvc
+  alias DiffoExample.Nbn.NniGroup
+  alias DiffoExample.Nbn.Nni
+
+  domain do
+    description "An example showing how TMF Resources for a fictional NBN domain can be extended from the Provider domain"
+  end
+
+  resources do
+    resource NbnEthernet do
+      define :get_nbn_ethernet_by_id, action: :read, get_by: :id
+      define :build_nbn_ethernet, action: :build
+      define :define_nbn_ethernet, action: :define
+      define :relate_nbn_ethernet, action: :relate
+    end
+
+    resource Uni do
+      define :get_uni_by_id, action: :read, get_by: :id
+      define :build_uni, action: :build
+      define :define_uni, action: :define
+      define :relate_uni, action: :relate
+    end
+
+    resource Avc do
+      define :get_avc_by_id, action: :read, get_by: :id
+      define :build_avc, action: :build
+      define :define_avc, action: :define
+      define :relate_avc, action: :relate
+    end
+
+    resource Ntd do
+      define :get_ntd_by_id, action: :read, get_by: :id
+      define :build_ntd, action: :build
+      define :define_ntd, action: :define
+      define :relate_ntd, action: :relate
+    end
+
+    resource Cvc do
+      define :get_cvc_by_id, action: :read, get_by: :id
+      define :build_cvc, action: :build
+      define :define_cvc, action: :define
+      define :assign_cvlan, action: :assign_cvlan
+      define :relate_cvc, action: :relate
+    end
+
+    resource NniGroup do
+      define :get_nni_group_by_id, action: :read, get_by: :id
+      define :build_nni_group, action: :build
+      define :define_nni_group, action: :define
+      define :assign_svlan, action: :assign_svlan
+      define :relate_nni_group, action: :relate
+    end
+
+    resource Nni do
+      define :get_nni_by_id, action: :read, get_by: :id
+      define :build_nni, action: :build
+      define :define_nni, action: :define
+      define :relate_nni, action: :relate
+    end
+  end
+end

lib/nbn/resources/avc.ex

@@ -0,0 +1,88 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.Avc do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  Avc - Access Virtual Circuit Resource Instance
+
+  An AVC is the virtual circuit dedicated to an NBN Ethernet circuit,
+  carrying traffic between its related UNI and the CVC that aggregates it.
+  """
+
+  alias Diffo.Provider.BaseInstance
+  alias Diffo.Provider.Instance.Relationship
+  alias Diffo.Provider.Instance.Characteristic
+  alias Diffo.Provider.Instance.ActionHelper
+
+  alias DiffoExample.Nbn
+
+  use Ash.Resource,
+    fragments: [BaseInstance],
+    domain: Nbn
+
+  resource do
+    description "An Ash Resource representing an Access Virtual Circuit (AVC)"
+    plural_name :Avcs
+  end
+
+  specification do
+    id "b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e"
+    name "avc"
+    type :resourceSpecification
+    description "An AVC Resource Instance dedicated to an NBN Ethernet circuit"
+    category "Network Resource"
+  end
+
+  characteristics do
+    characteristic :avc, DiffoExample.Nbn.AvcValue
+  end
+
+  actions do
+    create :build do
+      description "creates a new AVC resource instance"
+      accept [:id, :name, :type, :which]
+      argument :specified_by, :uuid, public?: false
+      argument :relationships, {:array, :struct}
+      argument :features, {:array, :uuid}, public?: false
+      argument :characteristics, {:array, :uuid}, public?: false
+      argument :places, {:array, :struct}
+      argument :parties, {:array, :struct}
+
+      change set_attribute(:type, :resource)
+
+      change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
+
+      change after_action(fn changeset, result, _context ->
+               ActionHelper.build_after(changeset, result, Nbn, :get_avc_by_id)
+             end)
+
+      change load [:href]
+      upsert? false
+    end
+
+    update :define do
+      description "defines the AVC"
+      argument :characteristic_value_updates, {:array, :term}
+
+      change after_action(fn changeset, result, _context ->
+               with {:ok, result} <- Characteristic.update_values(result, changeset),
+                    {:ok, result} <- Nbn.get_avc_by_id(result.id),
+                    do: {:ok, result}
+             end)
+    end
+
+    update :relate do
+      description "relates the AVC with other instances"
+      argument :relationships, {:array, :struct}
+
+      change after_action(fn changeset, result, _context ->
+               with {:ok, result} <- Relationship.relate_instance(result, changeset),
+                    {:ok, result} <- Nbn.get_avc_by_id(result.id),
+                    do: {:ok, result}
+             end)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/avc_value.ex

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.AvcValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  AvcValue - AshTyped Struct for AVC Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:cir, :pir]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:cir, :pir]
+  end
+
+  typed_struct do
+    field :cir, :integer, description: "Committed Information Rate in Mbps"
+
+    field :pir, :integer, description: "Peak Information Rate in Mbps"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/cvc_value.ex

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.CvcValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  CvcValue - AshTyped Struct for Connectivity Virtual Circuit Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:cvc_id, :bandwidth]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:cvc_id, :bandwidth]
+  end
+
+  typed_struct do
+    field :cvc_id, :string, description: "the unique CVC identifier"
+
+    field :bandwidth, :integer, description: "total CVC bandwidth in Mbps"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/nbn_ethernet_value.ex

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.NbnEthernetValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  NbnEthernetValue - AshTyped Struct for NBN Ethernet Circuit Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:circuit_id, :speed, :technology]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:circuit_id, :speed]
+  end
+
+  typed_struct do
+    field :circuit_id, :string, description: "the unique NBN circuit identifier"
+
+    field :speed, :integer, description: "the circuit download speed in Mbps"
+
+    field :technology, :atom,
+      description: "the access technology (:FTTP, :FTTN, :HFC, :Fixed_Wireless)"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/nni_group_value.ex

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.NniGroupValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  NniGroupValue - AshTyped Struct for NNI Group Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:name, :location]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:name, :location]
+  end
+
+  typed_struct do
+    field :name, :string, description: "the NNI group name"
+
+    field :location, :string, description: "the Point of Interconnect (PoI) location"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/nni_value.ex

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.NniValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  NniValue - AshTyped Struct for NNI Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:port_id, :capacity, :technology]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:port_id, :capacity]
+  end
+
+  typed_struct do
+    field :port_id, :string, description: "the NNI port identifier"
+
+    field :capacity, :integer, description: "the NNI port capacity in Gbps"
+
+    field :technology, :atom, description: "the NNI technology (:Ethernet, :Fibre)"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end

lib/nbn/resources/characteristic_values/ntd_value.ex

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
+
+defmodule DiffoExample.Nbn.NtdValue do
+  @moduledoc """
+  Diffo - TMF Service and Resource Management with a difference
+
+  NtdValue - AshTyped Struct for NTD Characteristic Value
+  """
+  use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
+
+  jason do
+    pick [:model, :serial_number, :technology]
+    compact(true)
+  end
+
+  outstanding do
+    expect [:model, :serial_number]
+  end
+
+  typed_struct do
+    field :model, :string, description: "the NTD device model"
+
+    field :serial_number, :string, description: "the NTD serial number"
+
+    field :technology, :atom,
+      description: "the access technology (:FTTP, :FTTN, :HFC, :Fixed_Wireless)"
+  end
+
+  defimpl String.Chars do
+    def to_string(struct) do
+      inspect(struct)
+    end
+  end
+end