Add support packet metadata (#27465)

server/public/plugin/api.go

@@ -1306,6 +1306,13 @@ type API interface {
 	// @tag User
 	// Minimum server version: 9.8
 	UpdateUserRoles(userID, newRoles string) (*model.User, *model.AppError)
+
+	// GenerateSupportMetadata generates the metadata for a support packet.
+	// pluginMeta should contain the values that plugin wants to insert into a standard support packet metadata.
+	//
+	// @tag Metadata
+	// Minimum server version: 9.10
+	GenerateSupportMetadata(pluginMeta map[string]any) (*model.Metadata, error)
 }
 
 var handshake = plugin.HandshakeConfig{

server/public/plugin/api_timer_layer_generated.go

@@ -1378,3 +1378,10 @@ func (api *apiTimerLayer) UpdateUserRoles(userID, newRoles string) (*model.User,
 	api.recordTime(startTime, "UpdateUserRoles", _returnsB == nil)
 	return _returnsA, _returnsB
 }
+
+func (api *apiTimerLayer) GenerateSupportMetadata(pluginMeta map[string]any) (*model.Metadata, error) {
+	startTime := timePkg.Now()
+	_returnsA, _returnsB := api.apiImpl.GenerateSupportMetadata(pluginMeta)
+	api.recordTime(startTime, "GenerateSupportMetadata", _returnsB == nil)
+	return _returnsA, _returnsB
+}

server/public/plugin/client_rpc_generated.go

@@ -6630,3 +6630,33 @@ func (s *apiRPCServer) UpdateUserRoles(args *Z_UpdateUserRolesArgs, returns *Z_U
 	}
 	return nil
 }
+
+type Z_GenerateSupportMetadataArgs struct {
+	A map[string]any
+}
+
+type Z_GenerateSupportMetadataReturns struct {
+	A *model.Metadata
+	B error
+}
+
+func (g *apiRPCClient) GenerateSupportMetadata(pluginMeta map[string]any) (*model.Metadata, error) {
+	_args := &Z_GenerateSupportMetadataArgs{pluginMeta}
+	_returns := &Z_GenerateSupportMetadataReturns{}
+	if err := g.client.Call("Plugin.GenerateSupportMetadata", _args, _returns); err != nil {
+		log.Printf("RPC call to GenerateSupportMetadata API failed: %s", err.Error())
+	}
+	return _returns.A, _returns.B
+}
+
+func (s *apiRPCServer) GenerateSupportMetadata(args *Z_GenerateSupportMetadataArgs, returns *Z_GenerateSupportMetadataReturns) error {
+	if hook, ok := s.impl.(interface {
+		GenerateSupportMetadata(pluginMeta map[string]any) (*model.Metadata, error)
+	}); ok {
+		returns.A, returns.B = hook.GenerateSupportMetadata(args.A)
+		returns.B = encodableError(returns.B)
+	} else {
+		return encodableError(fmt.Errorf("API GenerateSupportMetadata called but not implemented."))
+	}
+	return nil
+}

server/public/plugin/plugintest/api.go

@@ -891,6 +891,36 @@ func (_m *API) ExtendSessionExpiry(sessionID string, newExpiry int64) *model.App
 	return r0
 }
 
+// GenerateSupportMetadata provides a mock function with given fields: pluginMeta
+func (_m *API) GenerateSupportMetadata(pluginMeta map[string]interface{}) (*model.Metadata, error) {
+	ret := _m.Called(pluginMeta)
+
+	if len(ret) == 0 {
+		panic("no return value specified for GenerateSupportMetadata")
+	}
+
+	var r0 *model.Metadata
+	var r1 error
+	if rf, ok := ret.Get(0).(func(map[string]interface{}) (*model.Metadata, error)); ok {
+		return rf(pluginMeta)
+	}
+	if rf, ok := ret.Get(0).(func(map[string]interface{}) *model.Metadata); ok {
+		r0 = rf(pluginMeta)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).(*model.Metadata)
+		}
+	}
+
+	if rf, ok := ret.Get(1).(func(map[string]interface{}) error); ok {
+		r1 = rf(pluginMeta)
+	} else {
+		r1 = ret.Error(1)
+	}
+
+	return r0, r1
+}
+
 // GetBot provides a mock function with given fields: botUserId, includeDeleted
 func (_m *API) GetBot(botUserId string, includeDeleted bool) (*model.Bot, *model.AppError) {
 	ret := _m.Called(botUserId, includeDeleted)