update nbn domain for refactored diffo

matt-beanland · matt-beanland · commit 4e59dc0c3fc8 · 2026-04-18T16:13:07.000+09:30
diff --git a/lib/access/services/characteristic_values/aggregate_interface.ex b/lib/access/services/characteristic_values/aggregate_interface.ex
@@ -13,6 +13,12 @@ defmodule DiffoExample.Access.AggregateInterface do
   jason do
     pick [:name, :physical_interface, :physical_layer, :link_layer, :svlan_id, :vpi]
     compact(true)
+
+    rename physical_interface: "physicalInterface",
+           physical_layer: "physicalLayer",
+           link_layer: "linkLayer",
+           svlan_id: "svlanId",
+           vpi: "VPI"
   end
 
   outstanding do
diff --git a/lib/access/services/characteristic_values/circuit.ex b/lib/access/services/characteristic_values/circuit.ex
@@ -15,6 +15,7 @@ defmodule DiffoExample.Access.Circuit do
   jason do
     pick [:circuit_id, :cvlan_id, :vci, :encapsulation, :bandwidth_profile]
     compact(true)
+    rename circuit_id: "circuitId", vci: "VCI", bandwidth_profile: "bandwidthProfile"
   end
 
   outstanding do
@@ -41,8 +42,7 @@ defmodule DiffoExample.Access.Circuit do
       constraints: [one_of: [:PPPoA, :PPPoE, :IPoE]],
       description: "the circuit encapsulation"
 
-    field :bandwidth_profile, BandwidthProfile,
-      description: "the circuit bandwidth profile"
+    field :bandwidth_profile, BandwidthProfile, description: "the circuit bandwidth profile"
   end
 
   defimpl String.Chars do
diff --git a/lib/access/services/characteristic_values/constraints.ex b/lib/access/services/characteristic_values/constraints.ex
@@ -13,6 +13,7 @@ defmodule DiffoExample.Access.Constraints do
   jason do
     pick [:max_latency, :min_profile]
     compact(true)
+    rename max_latency: "maxLatency", min_profile: "minProfile"
   end
 
   outstanding do
diff --git a/lib/nbn/resources/avc.ex b/lib/nbn/resources/avc.ex
@@ -112,7 +112,7 @@ defmodule DiffoExample.Nbn.Avc do
   def mine_related(changeset, _context) when is_struct(changeset, Ash.Changeset) do
     reverse_relationships = Ash.Changeset.get_attribute(changeset, :reverse_relationships)
 
-    cvlan = {:cvlan, hd(hd(reverse_relationships).characteristics).value}
+    cvlan = {:cvlan, Diffo.Unwrap.unwrap(hd(hd(reverse_relationships).characteristics).value)}
 
     Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, avc: [cvlan])
   end
diff --git a/lib/nbn/resources/characteristic_values/avc_value.ex b/lib/nbn/resources/characteristic_values/avc_value.ex
@@ -22,7 +22,9 @@ defmodule DiffoExample.Nbn.AvcValue do
   end
 
   typed_struct do
-    field :cvlan, :string, description: "the cvlan of the AVC, assigned by the related CVC"
+    field :cvlan, :integer,
+      constraints: [min: 0, max: 4000],
+      description: "the cvlan of the AVC, assigned by the related CVC"
 
     field :bandwidth_profile, BandwidthProfile, description: "the bandwidth profile of the AVC"
   end
diff --git a/lib/nbn/resources/characteristic_values/cvc_value.ex b/lib/nbn/resources/characteristic_values/cvc_value.ex
@@ -20,9 +20,13 @@ defmodule DiffoExample.Nbn.CvcValue do
   end
 
   typed_struct do
-    field :svlan, :string, description: "the svlan of the CVC, assigned by the related NNI Group"
+    field :svlan, :integer,
+      constraints: [min: 0, max: 4000],
+      description: "the svlan of the CVC, assigned by the related NNI Group"
 
-    field :bandwidth, :integer, description: "total CVC bandwidth in Mbps"
+    field :bandwidth, :integer,
+      constraints: [min: 0, max: 10000],
+      description: "total CVC bandwidth in Mbps"
   end
 
   defimpl String.Chars do
diff --git a/lib/nbn/resources/characteristic_values/nni_value.ex b/lib/nbn/resources/characteristic_values/nni_value.ex
@@ -13,6 +13,7 @@ defmodule DiffoExample.Nbn.NniValue do
   jason do
     pick [:port_id, :capacity, :technology]
     compact(true)
+    rename port_id: "portId"
   end
 
   outstanding do
diff --git a/lib/nbn/resources/characteristic_values/ntd_value.ex b/lib/nbn/resources/characteristic_values/ntd_value.ex
@@ -26,7 +26,9 @@ defmodule DiffoExample.Nbn.NtdValue do
 
     field :serial_number, :string, description: "the NTD serial number"
 
-    field :technology, Technology, description: "the access technology type", default: Technology.default
+    field :technology, Technology,
+      description: "the access technology type",
+      default: Technology.default()
   end
 
   defimpl String.Chars do
diff --git a/lib/nbn/resources/characteristic_values/pri_value.ex b/lib/nbn/resources/characteristic_values/pri_value.ex
@@ -17,6 +17,7 @@ defmodule DiffoExample.Nbn.PriValue do
   jason do
     pick [:avcid, :uniid, :technology, :bandwidth_profile, :speeds]
     compact(true)
+    rename avcid: "AVCID", uniid: "UNIID", bandwidth_profile: "bandwidthProfile"
   end
 
   outstanding do
diff --git a/lib/nbn/resources/cvc.ex b/lib/nbn/resources/cvc.ex
@@ -127,7 +127,7 @@ defmodule DiffoExample.Nbn.Cvc do
   def mine_related(changeset, _context) when is_struct(changeset, Ash.Changeset) do
     reverse_relationships = Ash.Changeset.get_attribute(changeset, :reverse_relationships)
 
-    svlan = {:svlan, hd(hd(reverse_relationships).characteristics).value}
+    svlan = {:svlan, Diffo.Unwrap.unwrap(hd(hd(reverse_relationships).characteristics).value)}
 
     Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, cvc: [svlan])
   end
diff --git a/lib/nbn/resources/nbn_ethernet.ex b/lib/nbn/resources/nbn_ethernet.ex
@@ -119,22 +119,39 @@ defmodule DiffoExample.Nbn.NbnEthernet do
       Enum.reduce(forward_relationships, [], fn forward_relationship, acc ->
         {:ok, related} = Diffo.Provider.get_instance_by_id(forward_relationship.target_id)
         related_name = {alias_to_id(forward_relationship.alias), related.name}
+
         case forward_relationship.alias do
           :uni ->
             # extract technology from uni characteristic
-            [{:technology, Util.extract(related.characteristics, :uni, :technology)} | [ related_name | acc]]
+            [
+              {:technology, Util.extract(related.characteristics, :uni, :technology)}
+              | [related_name | acc]
+            ]
+
           :avc ->
             # extract bandwidth_profile from avc characteristic
-            [{:bandwidth_profile, Util.extract(related.characteristics, :avc, :bandwidth_profile)} | [ related_name | acc]]
+            [
+              {:bandwidth_profile,
+               Util.extract(related.characteristics, :avc, :bandwidth_profile)}
+              | [related_name | acc]
+            ]
+
           _ ->
-           [ related_name | acc]
+            [related_name | acc]
         end
       end)
 
     # calculate the speeds from the extracted technology and bandwidth_profile
-    speeds = {:speeds, Util.speeds(Keyword.get(pri_updates, :bandwidth_profile), Keyword.get(pri_updates, :technology))}
-
-    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, pri: [speeds | pri_updates])
+    speeds =
+      {:speeds,
+       Util.speeds(
+         Keyword.get(pri_updates, :bandwidth_profile),
+         Keyword.get(pri_updates, :technology)
+       )}
+
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates,
+      pri: [speeds | pri_updates]
+    )
   end
 
   defp alias_to_id(alias) when is_atom(alias) do
diff --git a/lib/nbn/resources/types/bandwidth_profile.ex b/lib/nbn/resources/types/bandwidth_profile.ex
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
 defmodule DiffoExample.Nbn.BandwidthProfile do
   @moduledoc """
   Diffo - TMF Service and Resource Management with a difference
@@ -9,15 +12,29 @@ defmodule DiffoExample.Nbn.BandwidthProfile do
 
   use Ash.Type.NewType,
     subtype_of: :atom,
-    constraints: [one_of:  bandwidth_profiles()]
+    constraints: [one_of: bandwidth_profiles()]
 
   def default do
     :home_fast
   end
 
   def bandwidth_profiles do
-    [:D12_U1, :D25_U5, :D25_U10, :D50_U20, :D100_U40, :D250_U100, :D500_U200, :D1000_U400,
-      :wireless_plus, :wireless_fast, :wireless_superfast,
-      :home_fast, :home_superfast, :home_ultrafast, :home_hyperfast]
+    [
+      :D12_U1,
+      :D25_U5,
+      :D25_U10,
+      :D50_U20,
+      :D100_U40,
+      :D250_U100,
+      :D500_U200,
+      :D1000_U400,
+      :wireless_plus,
+      :wireless_fast,
+      :wireless_superfast,
+      :home_fast,
+      :home_superfast,
+      :home_ultrafast,
+      :home_hyperfast
+    ]
   end
 end
diff --git a/lib/nbn/resources/types/speeds.ex b/lib/nbn/resources/types/speeds.ex
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
 defmodule DiffoExample.Nbn.Speeds do
   @moduledoc """
   Diffo - TMF Service and Resource Management with a difference
@@ -10,39 +13,55 @@ defmodule DiffoExample.Nbn.Speeds do
   use Ash.Type.NewType,
     subtype_of: :tuple,
     constraints: [
-        fields: [downstream: [type: :integer], upstream: [type: :integer]]
+      fields: [downstream: [type: :integer], upstream: [type: :integer]]
     ]
 
   def speeds do
     [
-      {12, 1}, {25, 5}, {25, 10}, {50, 20}, {100, 40}, {250, 100}, {500, 200}, {1000, 400},
+      {12, 1},
+      {25, 5},
+      {25, 10},
+      {50, 20},
+      {100, 40},
+      {250, 100},
+      {500, 200},
+      {1000, 400},
       # :home_fast
       {500, 50},
       # :home_superfast
       {750, 50},
       # :home_ultrafast
       {1000, 100},
       # :home_hyperfast
-      {2000, 100}, {2000, 200},
+      {2000, 100},
+      {2000, 200},
       # :wireless_plus, :wireless_fast, :wireless_superfast
-      {100, 20}, {250, 20}, {400, 40}
+      {100, 20},
+      {250, 20},
+      {400, 40}
     ]
   end
 
   @impl true
+  def cast_input(nil, _constraints), do: {:ok, nil}
+
   def cast_input(value, _constraints) when is_tuple(value) do
-     if value in speeds() do
+    if value in speeds() do
       {:ok, value}
-     else
-       {:error, "invalid downstream and upstream speed combination"}
-     end
+    else
+      {:error, "invalid downstream and upstream speed combination"}
+    end
   end
 
   def cast_input({_value, _constraints}), do: {:error, "value must be a tuple"}
 
   defimpl Jason.Encoder do
     def encode(speeds, _opts) do
-      Jason.OrderedObject.new(downstream: speeds.downstream, upstream: speeds.upstream, units: "Mbps")
+      Jason.OrderedObject.new(
+        downstream: speeds.downstream,
+        upstream: speeds.upstream,
+        units: "Mbps"
+      )
       |> Jason.encode!()
     end
   end
diff --git a/lib/nbn/resources/types/technology.ex b/lib/nbn/resources/types/technology.ex
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
+#
+# SPDX-License-Identifier: MIT
 defmodule DiffoExample.Nbn.Technology do
   @moduledoc """
   Diffo - TMF Service and Resource Management with a difference
diff --git a/lib/nbn/resources/uni.ex b/lib/nbn/resources/uni.ex
@@ -115,10 +115,12 @@ defmodule DiffoExample.Nbn.Uni do
 
     ntd_relationship = hd(reverse_relationships)
 
-    port = {:port, hd(ntd_relationship.characteristics).value}
+    port = {:port, Diffo.Unwrap.unwrap(hd(ntd_relationship.characteristics).value)}
     {:ok, ntd} = Diffo.Provider.get_instance_by_id(ntd_relationship.source_id)
     technology = {:technology, Util.extract(ntd.characteristics, :ntd, :technology)}
 
-    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, uni: [port, technology])
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates,
+      uni: [port, technology]
+    )
   end
 end
diff --git a/lib/nbn/util.ex b/lib/nbn/util.ex
@@ -41,27 +41,21 @@ defmodule DiffoExample.Nbn.Util do
   end
 
   @doc """
-  Extracts a field value from a named item in a list
+  Extracts a field value from a named item value map in a list, each value map is unwrapped with Diffo.Unwrap protocol
 
   ## Examples
     iex> DiffoExample.Nbn.Util.extract([%{name: :avc, value: %{cvlan: 1}}], :avc, :cvlan)
     1
   """
   def extract(items, name, field) when is_list(items) and is_atom(name) and is_atom(field) do
-    Enum.reduce_while(items, nil, fn item, acc ->
-      if name == item.name do
-        if item.value != nil do
-          {:halt, Map.get(item.value, field)}
-        else
-          {:halt, nil}
-        end
-      else
-        {:cont, acc}
-      end
-    end)
+    case Enum.find(items, &(&1.name == name)) do
+      nil -> nil
+      %{value: nil} -> nil
+      %{value: value} -> value |> Diffo.Unwrap.unwrap() |> Map.get(field)
+    end
   end
 
-  @doc"""
+  @doc """
   Returns a tuple of maximum downstream and upstream speeds in Mbps
   given the bandwidth_profile and technology, or :error
 
@@ -111,10 +105,13 @@ defmodule DiffoExample.Nbn.Util do
     case bandwidth_profile do
       :wireless_plus ->
         {100, 20}
+
       :wireless_fast ->
         {250, 20}
+
       :wireless_superfast ->
         {400, 40}
+
       _ ->
         :error
     end
@@ -124,14 +121,19 @@ defmodule DiffoExample.Nbn.Util do
     case bandwidth_profile do
       :home_fast ->
         {500, 50}
+
       :home_superfast ->
         {750, 50}
+
       :home_ultrafast ->
         {1000, 100}
+
       :home_hyperfast ->
         {2000, 100}
+
       :U100_D40 ->
         {100, 40}
+
       _ ->
         :error
     end
@@ -141,20 +143,28 @@ defmodule DiffoExample.Nbn.Util do
     case bandwidth_profile do
       :home_fast ->
         {500, 50}
+
       :home_superfast ->
         {750, 50}
+
       :home_ultrafast ->
         {1000, 100}
+
       :home_hyperfast ->
         {2000, 200}
+
       :D100_U40 ->
         {100, 40}
+
       :D250_U100 ->
         {250, 100}
+
       :D500_200 ->
         {500, 200}
+
       :D1000_400 ->
         {1000, 400}
+
       _ ->
         :error
     end
diff --git a/mix.lock b/mix.lock
@@ -1,5 +1,5 @@
 %{
-  "ash": {:hex, :ash, "3.24.2", "38beca133e0dcab07e3c8a7c26e573287ada26e8ba8d4c90ac692b52b34b0309", [:mix], [{:crux, ">= 0.1.2 and < 1.0.0-0", [hex: :crux, repo: "hexpm", optional: false]}, {:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.7", [hex: :ecto, repo: "hexpm", optional: false]}, {:ets, "~> 0.8", [hex: :ets, repo: "hexpm", optional: false]}, {:igniter, ">= 0.6.29 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: false]}, {:picosat_elixir, "~> 0.2", [hex: :picosat_elixir, repo: "hexpm", optional: true]}, {:plug, ">= 0.0.0", [hex: :plug, repo: "hexpm", optional: true]}, {:reactor, "~> 1.0", [hex: :reactor, repo: "hexpm", optional: false]}, {:simple_sat, ">= 0.1.1 and < 1.0.0-0", [hex: :simple_sat, repo: "hexpm", optional: true]}, {:spark, ">= 2.6.0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, "~> 0.3", [hex: :splode, repo: "hexpm", optional: false]}, {:stream_data, "~> 1.0", [hex: :stream_data, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.1", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "3fd2a99504c1f58290efc3382501369ee9070098784925bdd7df9dbea8611d32"},
+  "ash": {:hex, :ash, "3.24.3", "f7280a43c5e64f769a450f3dd59ace6dcd73edcdd0de7599815b1b31f59292fb", [:mix], [{:crux, ">= 0.1.2 and < 1.0.0-0", [hex: :crux, repo: "hexpm", optional: false]}, {:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.7", [hex: :ecto, repo: "hexpm", optional: false]}, {:ets, "~> 0.8", [hex: :ets, repo: "hexpm", optional: false]}, {:igniter, ">= 0.6.29 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: false]}, {:picosat_elixir, "~> 0.2", [hex: :picosat_elixir, repo: "hexpm", optional: true]}, {:plug, ">= 0.0.0", [hex: :plug, repo: "hexpm", optional: true]}, {:reactor, "~> 1.0", [hex: :reactor, repo: "hexpm", optional: false]}, {:simple_sat, ">= 0.1.1 and < 1.0.0-0", [hex: :simple_sat, repo: "hexpm", optional: true]}, {:spark, ">= 2.6.0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, "~> 0.3", [hex: :splode, repo: "hexpm", optional: false]}, {:stream_data, "~> 1.0", [hex: :stream_data, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.1", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c1022f8c549632137cbc8956f07bb4981405297f5abe7a752b4dffac175c3381"},
   "ash_jason": {:hex, :ash_jason, "3.1.0", "84a88dfe5e25a20d55cf2d2664885cd086fa45871e8777aedc3ad96a282e2a6f", [:mix], [{:ash, ">= 3.6.2 and < 4.0.0-0", [hex: :ash, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:spark, ">= 2.1.21 and < 3.0.0", [hex: :spark, repo: "hexpm", optional: false]}], "hexpm", "71e6bbc421fb2cf7079f8804814145cca458116c839fc798f9606b806e07eb2b"},
   "ash_neo4j": {:git, "https://github.com/diffo-dev/ash_neo4j.git", "044d9d123af30719a9f1f377e2c24b5cc8e21ea8", [branch: "dev"]},
   "ash_outstanding": {:hex, :ash_outstanding, "0.2.4", "c72b91f1b8e4859fb033eddf66d0ba36cfd8af0c2a9748c7ef9e6ccfdb5d093d", [:mix], [{:ash, ">= 3.6.2 and < 4.0.0-0", [hex: :ash, repo: "hexpm", optional: false]}, {:outstanding, "~> 0.2.4", [hex: :outstanding, repo: "hexpm", optional: false]}], "hexpm", "64ba8f582ce69c9050352c75f0895db186c7a56f35039dab34c8e1ab7516f9ce"},
diff --git a/test/access/characteristic_value_test.exs b/test/access/characteristic_value_test.exs
diff --git a/test/access/dsl_access_test.exs b/test/access/dsl_access_test.exs
diff --git a/test/nbn/nbn_ethernet_test.exs b/test/nbn/nbn_ethernet_test.exs
diff --git a/test/support/characteristics.ex b/test/support/characteristics.ex
diff --git a/test/test_helper.exs b/test/test_helper.exs
