Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

18.8 KB
Raw Blame
// Code generated by protoc-gen-connect-go. DO NOT EDIT.
//
// Source: api/instance_service.proto

package apiconnect

import (
	connect "connectrpc.com/connect"
	context "context"
	errors "errors"
	api "github.com/usememos/memos/proto/gen/api"
	emptypb "google.golang.org/protobuf/types/known/emptypb"
	http "net/http"
	strings "strings"
)

// This is a compile-time assertion to ensure that this generated file and the connect package are
// compatible. If you get a compiler error that this constant is not defined, this code was
// generated with a version of connect newer than the one compiled into your binary. You can fix the
// problem by either regenerating this code with an older version of connect or updating the connect
// version compiled into your binary.
const _ = connect.IsAtLeastVersion1_13_0

const (
	// InstanceServiceName is the fully-qualified name of the InstanceService service.
	InstanceServiceName = "memos.api.InstanceService"
)

// These constants are the fully-qualified names of the RPCs defined in this package. They're
// exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
//
// Note that these are different from the fully-qualified method names used by
// google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to
// reflection-formatted method names, remove the leading slash and convert the remaining slash to a
// period.
const (
	// InstanceServiceGetInstanceProfileProcedure is the fully-qualified name of the InstanceService's
	// GetInstanceProfile RPC.
	InstanceServiceGetInstanceProfileProcedure = "/memos.api.InstanceService/GetInstanceProfile"
	// InstanceServiceGetInstanceSettingProcedure is the fully-qualified name of the InstanceService's
	// GetInstanceSetting RPC.
	InstanceServiceGetInstanceSettingProcedure = "/memos.api.InstanceService/GetInstanceSetting"
	// InstanceServiceBatchGetInstanceSettingsProcedure is the fully-qualified name of the
	// InstanceService's BatchGetInstanceSettings RPC.
	InstanceServiceBatchGetInstanceSettingsProcedure = "/memos.api.InstanceService/BatchGetInstanceSettings"
	// InstanceServiceUpdateInstanceSettingProcedure is the fully-qualified name of the
	// InstanceService's UpdateInstanceSetting RPC.
	InstanceServiceUpdateInstanceSettingProcedure = "/memos.api.InstanceService/UpdateInstanceSetting"
	// InstanceServiceTestInstanceEmailSettingProcedure is the fully-qualified name of the
	// InstanceService's TestInstanceEmailSetting RPC.
	InstanceServiceTestInstanceEmailSettingProcedure = "/memos.api.InstanceService/TestInstanceEmailSetting"
	// InstanceServiceGetInstanceStatsProcedure is the fully-qualified name of the InstanceService's
	// GetInstanceStats RPC.
	InstanceServiceGetInstanceStatsProcedure = "/memos.api.InstanceService/GetInstanceStats"
	// InstanceServiceGetConfigurationStatusProcedure is the fully-qualified name of the
	// InstanceService's GetConfigurationStatus RPC.
	InstanceServiceGetConfigurationStatusProcedure = "/memos.api.InstanceService/GetConfigurationStatus"
)

// InstanceServiceClient is a client for the memos.api.InstanceService service.
type InstanceServiceClient interface {
	// GetInstanceProfile gets the instance profile. Available without authentication, including on a private instance.
	GetInstanceProfile(context.Context, *connect.Request[api.GetInstanceProfileRequest]) (*connect.Response[api.InstanceProfile], error)
	// GetInstanceSetting gets an instance setting. Available without authentication, except STORAGE and NOTIFICATION,
	// which are admin only, and AI, which requires a signed-in user and hides transcription defaults from non-admins.
	GetInstanceSetting(context.Context, *connect.Request[api.GetInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error)
	// BatchGetInstanceSettings gets up to 100 instance settings in request order, with the same access rules as
	// GetInstanceSetting. The call fails if any setting cannot be returned.
	BatchGetInstanceSettings(context.Context, *connect.Request[api.BatchGetInstanceSettingsRequest]) (*connect.Response[api.BatchGetInstanceSettingsResponse], error)
	// UpdateInstanceSetting replaces an instance setting. Admin only. Fields declarative configuration manages cannot be
	// changed. Empty write-only credentials keep the stored values.
	UpdateInstanceSetting(context.Context, *connect.Request[api.UpdateInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error)
	// TestInstanceEmailSetting sends a test email with the provided or stored SMTP settings. Admin only.
	TestInstanceEmailSetting(context.Context, *connect.Request[api.TestInstanceEmailSettingRequest]) (*connect.Response[emptypb.Empty], error)
	// GetInstanceStats gets resource usage statistics for the instance. Admin only. Results are cached for 60 seconds.
	GetInstanceStats(context.Context, *connect.Request[api.GetInstanceStatsRequest]) (*connect.Response[api.InstanceStats], error)
	// GetConfigurationStatus gets what declarative configuration manages: the managed resources and the last apply.
	// Admin only. It carries resource names and field paths, never a configured value.
	GetConfigurationStatus(context.Context, *connect.Request[api.GetConfigurationStatusRequest]) (*connect.Response[api.ConfigurationStatus], error)
}

// NewInstanceServiceClient constructs a client for the memos.api.InstanceService service. By
// default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses,
// and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the
// connect.WithGRPC() or connect.WithGRPCWeb() options.
//
// The URL supplied here should be the base URL for the Connect or gRPC server (for example,
// http://api.acme.com or https://acme.com/grpc).
func NewInstanceServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) InstanceServiceClient {
	baseURL = strings.TrimRight(baseURL, "/")
	instanceServiceMethods := api.File_api_instance_service_proto.Services().ByName("InstanceService").Methods()
	return &instanceServiceClient{
		getInstanceProfile: connect.NewClient[api.GetInstanceProfileRequest, api.InstanceProfile](
			httpClient,
			baseURL+InstanceServiceGetInstanceProfileProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("GetInstanceProfile")),
			connect.WithClientOptions(opts...),
		),
		getInstanceSetting: connect.NewClient[api.GetInstanceSettingRequest, api.InstanceSetting](
			httpClient,
			baseURL+InstanceServiceGetInstanceSettingProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("GetInstanceSetting")),
			connect.WithClientOptions(opts...),
		),
		batchGetInstanceSettings: connect.NewClient[api.BatchGetInstanceSettingsRequest, api.BatchGetInstanceSettingsResponse](
			httpClient,
			baseURL+InstanceServiceBatchGetInstanceSettingsProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("BatchGetInstanceSettings")),
			connect.WithClientOptions(opts...),
		),
		updateInstanceSetting: connect.NewClient[api.UpdateInstanceSettingRequest, api.InstanceSetting](
			httpClient,
			baseURL+InstanceServiceUpdateInstanceSettingProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("UpdateInstanceSetting")),
			connect.WithClientOptions(opts...),
		),
		testInstanceEmailSetting: connect.NewClient[api.TestInstanceEmailSettingRequest, emptypb.Empty](
			httpClient,
			baseURL+InstanceServiceTestInstanceEmailSettingProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("TestInstanceEmailSetting")),
			connect.WithClientOptions(opts...),
		),
		getInstanceStats: connect.NewClient[api.GetInstanceStatsRequest, api.InstanceStats](
			httpClient,
			baseURL+InstanceServiceGetInstanceStatsProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("GetInstanceStats")),
			connect.WithClientOptions(opts...),
		),
		getConfigurationStatus: connect.NewClient[api.GetConfigurationStatusRequest, api.ConfigurationStatus](
			httpClient,
			baseURL+InstanceServiceGetConfigurationStatusProcedure,
			connect.WithSchema(instanceServiceMethods.ByName("GetConfigurationStatus")),
			connect.WithClientOptions(opts...),
		),
	}
}

// instanceServiceClient implements InstanceServiceClient.
type instanceServiceClient struct {
	getInstanceProfile       *connect.Client[api.GetInstanceProfileRequest, api.InstanceProfile]
	getInstanceSetting       *connect.Client[api.GetInstanceSettingRequest, api.InstanceSetting]
	batchGetInstanceSettings *connect.Client[api.BatchGetInstanceSettingsRequest, api.BatchGetInstanceSettingsResponse]
	updateInstanceSetting    *connect.Client[api.UpdateInstanceSettingRequest, api.InstanceSetting]
	testInstanceEmailSetting *connect.Client[api.TestInstanceEmailSettingRequest, emptypb.Empty]
	getInstanceStats         *connect.Client[api.GetInstanceStatsRequest, api.InstanceStats]
	getConfigurationStatus   *connect.Client[api.GetConfigurationStatusRequest, api.ConfigurationStatus]
}

// GetInstanceProfile calls memos.api.InstanceService.GetInstanceProfile.
func (c *instanceServiceClient) GetInstanceProfile(ctx context.Context, req *connect.Request[api.GetInstanceProfileRequest]) (*connect.Response[api.InstanceProfile], error) {
	return c.getInstanceProfile.CallUnary(ctx, req)
}

// GetInstanceSetting calls memos.api.InstanceService.GetInstanceSetting.
func (c *instanceServiceClient) GetInstanceSetting(ctx context.Context, req *connect.Request[api.GetInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error) {
	return c.getInstanceSetting.CallUnary(ctx, req)
}

// BatchGetInstanceSettings calls memos.api.InstanceService.BatchGetInstanceSettings.
func (c *instanceServiceClient) BatchGetInstanceSettings(ctx context.Context, req *connect.Request[api.BatchGetInstanceSettingsRequest]) (*connect.Response[api.BatchGetInstanceSettingsResponse], error) {
	return c.batchGetInstanceSettings.CallUnary(ctx, req)
}

// UpdateInstanceSetting calls memos.api.InstanceService.UpdateInstanceSetting.
func (c *instanceServiceClient) UpdateInstanceSetting(ctx context.Context, req *connect.Request[api.UpdateInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error) {
	return c.updateInstanceSetting.CallUnary(ctx, req)
}

// TestInstanceEmailSetting calls memos.api.InstanceService.TestInstanceEmailSetting.
func (c *instanceServiceClient) TestInstanceEmailSetting(ctx context.Context, req *connect.Request[api.TestInstanceEmailSettingRequest]) (*connect.Response[emptypb.Empty], error) {
	return c.testInstanceEmailSetting.CallUnary(ctx, req)
}

// GetInstanceStats calls memos.api.InstanceService.GetInstanceStats.
func (c *instanceServiceClient) GetInstanceStats(ctx context.Context, req *connect.Request[api.GetInstanceStatsRequest]) (*connect.Response[api.InstanceStats], error) {
	return c.getInstanceStats.CallUnary(ctx, req)
}

// GetConfigurationStatus calls memos.api.InstanceService.GetConfigurationStatus.
func (c *instanceServiceClient) GetConfigurationStatus(ctx context.Context, req *connect.Request[api.GetConfigurationStatusRequest]) (*connect.Response[api.ConfigurationStatus], error) {
	return c.getConfigurationStatus.CallUnary(ctx, req)
}

// InstanceServiceHandler is an implementation of the memos.api.InstanceService service.
type InstanceServiceHandler interface {
	// GetInstanceProfile gets the instance profile. Available without authentication, including on a private instance.
	GetInstanceProfile(context.Context, *connect.Request[api.GetInstanceProfileRequest]) (*connect.Response[api.InstanceProfile], error)
	// GetInstanceSetting gets an instance setting. Available without authentication, except STORAGE and NOTIFICATION,
	// which are admin only, and AI, which requires a signed-in user and hides transcription defaults from non-admins.
	GetInstanceSetting(context.Context, *connect.Request[api.GetInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error)
	// BatchGetInstanceSettings gets up to 100 instance settings in request order, with the same access rules as
	// GetInstanceSetting. The call fails if any setting cannot be returned.
	BatchGetInstanceSettings(context.Context, *connect.Request[api.BatchGetInstanceSettingsRequest]) (*connect.Response[api.BatchGetInstanceSettingsResponse], error)
	// UpdateInstanceSetting replaces an instance setting. Admin only. Fields declarative configuration manages cannot be
	// changed. Empty write-only credentials keep the stored values.
	UpdateInstanceSetting(context.Context, *connect.Request[api.UpdateInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error)
	// TestInstanceEmailSetting sends a test email with the provided or stored SMTP settings. Admin only.
	TestInstanceEmailSetting(context.Context, *connect.Request[api.TestInstanceEmailSettingRequest]) (*connect.Response[emptypb.Empty], error)
	// GetInstanceStats gets resource usage statistics for the instance. Admin only. Results are cached for 60 seconds.
	GetInstanceStats(context.Context, *connect.Request[api.GetInstanceStatsRequest]) (*connect.Response[api.InstanceStats], error)
	// GetConfigurationStatus gets what declarative configuration manages: the managed resources and the last apply.
	// Admin only. It carries resource names and field paths, never a configured value.
	GetConfigurationStatus(context.Context, *connect.Request[api.GetConfigurationStatusRequest]) (*connect.Response[api.ConfigurationStatus], error)
}

// NewInstanceServiceHandler builds an HTTP handler from the service implementation. It returns the
// path on which to mount the handler and the handler itself.
//
// By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf
// and JSON codecs. They also support gzip compression.
func NewInstanceServiceHandler(svc InstanceServiceHandler, opts ...connect.HandlerOption) (string, http.Handler) {
	instanceServiceMethods := api.File_api_instance_service_proto.Services().ByName("InstanceService").Methods()
	instanceServiceGetInstanceProfileHandler := connect.NewUnaryHandler(
		InstanceServiceGetInstanceProfileProcedure,
		svc.GetInstanceProfile,
		connect.WithSchema(instanceServiceMethods.ByName("GetInstanceProfile")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceGetInstanceSettingHandler := connect.NewUnaryHandler(
		InstanceServiceGetInstanceSettingProcedure,
		svc.GetInstanceSetting,
		connect.WithSchema(instanceServiceMethods.ByName("GetInstanceSetting")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceBatchGetInstanceSettingsHandler := connect.NewUnaryHandler(
		InstanceServiceBatchGetInstanceSettingsProcedure,
		svc.BatchGetInstanceSettings,
		connect.WithSchema(instanceServiceMethods.ByName("BatchGetInstanceSettings")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceUpdateInstanceSettingHandler := connect.NewUnaryHandler(
		InstanceServiceUpdateInstanceSettingProcedure,
		svc.UpdateInstanceSetting,
		connect.WithSchema(instanceServiceMethods.ByName("UpdateInstanceSetting")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceTestInstanceEmailSettingHandler := connect.NewUnaryHandler(
		InstanceServiceTestInstanceEmailSettingProcedure,
		svc.TestInstanceEmailSetting,
		connect.WithSchema(instanceServiceMethods.ByName("TestInstanceEmailSetting")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceGetInstanceStatsHandler := connect.NewUnaryHandler(
		InstanceServiceGetInstanceStatsProcedure,
		svc.GetInstanceStats,
		connect.WithSchema(instanceServiceMethods.ByName("GetInstanceStats")),
		connect.WithHandlerOptions(opts...),
	)
	instanceServiceGetConfigurationStatusHandler := connect.NewUnaryHandler(
		InstanceServiceGetConfigurationStatusProcedure,
		svc.GetConfigurationStatus,
		connect.WithSchema(instanceServiceMethods.ByName("GetConfigurationStatus")),
		connect.WithHandlerOptions(opts...),
	)
	return "/memos.api.InstanceService/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		switch r.URL.Path {
		case InstanceServiceGetInstanceProfileProcedure:
			instanceServiceGetInstanceProfileHandler.ServeHTTP(w, r)
		case InstanceServiceGetInstanceSettingProcedure:
			instanceServiceGetInstanceSettingHandler.ServeHTTP(w, r)
		case InstanceServiceBatchGetInstanceSettingsProcedure:
			instanceServiceBatchGetInstanceSettingsHandler.ServeHTTP(w, r)
		case InstanceServiceUpdateInstanceSettingProcedure:
			instanceServiceUpdateInstanceSettingHandler.ServeHTTP(w, r)
		case InstanceServiceTestInstanceEmailSettingProcedure:
			instanceServiceTestInstanceEmailSettingHandler.ServeHTTP(w, r)
		case InstanceServiceGetInstanceStatsProcedure:
			instanceServiceGetInstanceStatsHandler.ServeHTTP(w, r)
		case InstanceServiceGetConfigurationStatusProcedure:
			instanceServiceGetConfigurationStatusHandler.ServeHTTP(w, r)
		default:
			http.NotFound(w, r)
		}
	})
}

// UnimplementedInstanceServiceHandler returns CodeUnimplemented from all methods.
type UnimplementedInstanceServiceHandler struct{}

func (UnimplementedInstanceServiceHandler) GetInstanceProfile(context.Context, *connect.Request[api.GetInstanceProfileRequest]) (*connect.Response[api.InstanceProfile], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.GetInstanceProfile is not implemented"))
}

func (UnimplementedInstanceServiceHandler) GetInstanceSetting(context.Context, *connect.Request[api.GetInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.GetInstanceSetting is not implemented"))
}

func (UnimplementedInstanceServiceHandler) BatchGetInstanceSettings(context.Context, *connect.Request[api.BatchGetInstanceSettingsRequest]) (*connect.Response[api.BatchGetInstanceSettingsResponse], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.BatchGetInstanceSettings is not implemented"))
}

func (UnimplementedInstanceServiceHandler) UpdateInstanceSetting(context.Context, *connect.Request[api.UpdateInstanceSettingRequest]) (*connect.Response[api.InstanceSetting], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.UpdateInstanceSetting is not implemented"))
}

func (UnimplementedInstanceServiceHandler) TestInstanceEmailSetting(context.Context, *connect.Request[api.TestInstanceEmailSettingRequest]) (*connect.Response[emptypb.Empty], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.TestInstanceEmailSetting is not implemented"))
}

func (UnimplementedInstanceServiceHandler) GetInstanceStats(context.Context, *connect.Request[api.GetInstanceStatsRequest]) (*connect.Response[api.InstanceStats], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.GetInstanceStats is not implemented"))
}

func (UnimplementedInstanceServiceHandler) GetConfigurationStatus(context.Context, *connect.Request[api.GetConfigurationStatusRequest]) (*connect.Response[api.ConfigurationStatus], error) {
	return nil, connect.NewError(connect.CodeUnimplemented, errors.New("memos.api.InstanceService.GetConfigurationStatus is not implemented"))
}