[Feature] Extend Shared Types (#1911)

Author: ajanikow

CHANGELOG.md

@@ -22,6 +22,7 @@
 - (Feature) (Platform) OpenID Logout Endpoints
 - (Maintenance) Grade Doc Field
 - (Feature) (Platform) Improve Platform Components names
+- (Feature) Extend Shared Types
 
 ## [1.2.48](https://github.com/arangodb/kube-arangodb/tree/1.2.48) (2025-05-08)
 - (Maintenance) Extend Documentation

pkg/apis/shared/v1/any.go

@@ -0,0 +1,69 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package v1
+
+import (
+	"encoding/json"
+
+	"github.com/arangodb/kube-arangodb/pkg/util"
+	"github.com/arangodb/kube-arangodb/pkg/util/errors"
+)
+
+var _ json.Marshaler = &Any{}
+var _ json.Unmarshaler = &Any{}
+
+type Any []byte
+
+func NewAny[T any](in T) (Any, error) {
+	return json.Marshal(in)
+}
+
+func FromAny[T any](in Any) (T, error) {
+	var z T
+	if err := json.Unmarshal(in, &z); err != nil {
+		return z, err
+	}
+
+	return z, nil
+}
+
+func (d Any) MarshalJSON() ([]byte, error) {
+	ret := make([]byte, len(d))
+	copy(ret, d)
+	return ret, nil
+}
+
+func (d Any) SHA256() string {
+	return util.SHA256(d)
+}
+
+func (d *Any) UnmarshalJSON(bytes []byte) error {
+	if d == nil {
+		return errors.Errorf("nil object provided")
+	}
+
+	ret := make([]byte, len(bytes))
+	copy(ret, bytes)
+
+	*d = ret
+
+	return nil
+}

pkg/apis/shared/v1/any_test.go

@@ -0,0 +1,56 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package v1
+
+import (
+	"encoding/json"
+	"reflect"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func testAnyRepresentation[IN any](t *testing.T, v IN) {
+	t.Run(reflect.TypeFor[IN]().String(), func(t *testing.T) {
+		d, err := NewAny[IN](v)
+		require.NoError(t, err)
+
+		z, err := json.Marshal(d)
+		require.NoError(t, err)
+
+		t.Logf("%s", string(z))
+
+		var d2 Any
+
+		require.NoError(t, json.Unmarshal(z, &d2))
+
+		require.EqualValues(t, d, d2)
+	})
+}
+
+func Test_Any_Representation(t *testing.T) {
+	testAnyRepresentation(t, "some_Test_Any")
+	testAnyRepresentation(t, []string{"A", "B"})
+	testAnyRepresentation(t, 53)
+	testAnyRepresentation(t, Object{
+		Name: "X",
+	})
+}

pkg/apis/shared/v1/data.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -31,6 +31,20 @@ import (
 var _ json.Marshaler = &Data{}
 var _ json.Unmarshaler = &Data{}
 
+func NewData[T any](in T) (Data, error) {
+	return json.Marshal(in)
+}
+
+func FromData[T any](in Data) (T, error) {
+	var z T
+	if err := json.Unmarshal(in, &z); err != nil {
+		return z, err
+	}
+
+	return z, nil
+}
+
+// Data keeps the representation of the object in the base64 encoded string
 type Data []byte
 
 func (d Data) MarshalJSON() ([]byte, error) {

pkg/apis/shared/v1/data_test.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,6 +21,8 @@
 package v1
 
 import (
+	"encoding/json"
+	"reflect"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -35,3 +37,30 @@ func Test_Data(t *testing.T) {
 	require.NoError(t, err)
 	require.EqualValues(t, d, z)
 }
+
+func testDataRepresentation[IN any](t *testing.T, v IN) {
+	t.Run(reflect.TypeFor[IN]().String(), func(t *testing.T) {
+		d, err := NewData[IN](v)
+		require.NoError(t, err)
+
+		z, err := json.Marshal(d)
+		require.NoError(t, err)
+
+		t.Logf("%s", string(z))
+
+		var d2 Data
+
+		require.NoError(t, json.Unmarshal(z, &d2))
+
+		require.EqualValues(t, d, d2)
+	})
+}
+
+func Test_Data_Representation(t *testing.T) {
+	testDataRepresentation(t, "some_Test_data")
+	testDataRepresentation(t, []string{"A", "B"})
+	testDataRepresentation(t, 53)
+	testDataRepresentation(t, Object{
+		Name: "X",
+	})
+}