Unverified Commit bb1a2534 authored by Gabriel's avatar Gabriel Committed by GitHub
Browse files

More annotations fixes (#1054) 



* first pass

* 1

* first pass

* 1

* Go annotations

* Update server/runtime_go_nakama.go

Co-authored-by: default avatarSimon Esposito <simon@heroiclabs.com>

* Update runtime_lua_nakama.go

Update runtime_javascript_nakama.go

---------

Co-authored-by: default avatarSimon Esposito <simon@heroiclabs.com>
parent 35e41801

internal/satori/satori.go

+4 −4
Original line number Diff line number Diff line
@@ -173,7 +173,7 @@ func (s *SatoriClient) Authenticate(ctx context.Context, id string) error { 
// @summary Get identity properties.

// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param id(type=string) The identifier of the identity.

// @return properties(type=*runtime.Properties) The identity properties.

// @return properties(*runtime.Properties) The identity properties.

// @return error(error) An optional error value if an error occurred.

func (s *SatoriClient) PropertiesGet(ctx context.Context, id string) (*runtime.Properties, error) {

	if s.invalidConfig {
@@ -328,7 +328,7 @@ func (s *SatoriClient) EventsPublish(ctx context.Context, id string, events []*r 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param id(type=string) The identifier of the identity.

// @param names(type=[]string, optional=true, default=[]) Optional list of experiment names to filter.

// @return experiments(type=*runtime.ExperimentList) The experiment list.

// @return experiments(*runtime.ExperimentList) The experiment list.

// @return error(error) An optional error value if an error occurred.

func (s *SatoriClient) ExperimentsList(ctx context.Context, id string, names ...string) (*runtime.ExperimentList, error) {

	if s.invalidConfig {
@@ -384,7 +384,7 @@ func (s *SatoriClient) ExperimentsList(ctx context.Context, id string, names ... 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param id(type=string) The identifier of the identity.

// @param names(type=[]string, optional=true, default=[]) Optional list of flag names to filter.

// @return flags(type=*runtime.FlagList) The flag list.

// @return flags(*runtime.FlagList) The flag list.

// @return error(error) An optional error value if an error occurred.

func (s *SatoriClient) FlagsList(ctx context.Context, id string, names ...string) (*runtime.FlagList, error) {

	if s.invalidConfig {
@@ -440,7 +440,7 @@ func (s *SatoriClient) FlagsList(ctx context.Context, id string, names ...string 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param id(type=string) The identifier of the identity.

// @param names(type=[]string, optional=true, default=[]) Optional list of live event names to filter.

// @return liveEvents(type=*runtime.LiveEventsList) The live event list.

// @return liveEvents(*runtime.LiveEventsList) The live event list.

// @return error(error) An optional error value if an error occurred.

func (s *SatoriClient) LiveEventsList(ctx context.Context, id string, names ...string) (*runtime.LiveEventList, error) {

	if s.invalidConfig {

server/runtime_go_nakama.go

+125 −125

File changed.

Preview size limit exceeded, changes collapsed.

server/runtime_javascript_nakama.go

+29 −29
Original line number Diff line number Diff line
@@ -296,7 +296,7 @@ func (n *runtimeJavascriptNakamaModule) mappings(r *goja.Runtime) map[string]fun 
// @group utils

// @summary Convert binary data to string.

// @param data(type=ArrayBuffer) The binary data to be converted.

// @return result(type=string) The resulting string.

// @return result(string) The resulting string.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) binaryToString(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -320,7 +320,7 @@ func (n *runtimeJavascriptNakamaModule) binaryToString(r *goja.Runtime) func(goj 
// @group utils

// @summary Convert string data to binary.

// @param str(type=string) The string to be converted.

// @return result(type=ArrayBuffer) The resulting binary data.

// @return result(ArrayBuffer) The resulting binary data.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) stringToBinary(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -1783,7 +1783,7 @@ func (n *runtimeJavascriptNakamaModule) accountGetId(r *goja.Runtime) func(goja. 
// @group accounts

// @summary Fetch information for multiple accounts by user IDs.

// @param userIds(type=[]string) Array of user IDs to fetch information for. Must be valid UUID.

// @return account(nkruntime.Accounts) Array of accounts.

// @return account(nkruntime.Account[]) Array of accounts.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) accountsGetId(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -2768,7 +2768,7 @@ func (n *runtimeJavascriptNakamaModule) streamUserList(r *goja.Runtime) func(goj 
}



// @group streams

// @summary Retreive a stream presence and metadata by user ID.

// @summary Retrieve a stream presence and metadata by user ID.

// @param userId(type=string) The user ID to fetch information for.

// @param sessionId(type=string) The current session ID for the user.

// @param stream(type=nkruntime.Stream) A stream object.
@@ -3136,7 +3136,7 @@ func (n *runtimeJavascriptNakamaModule) streamClose(r *goja.Runtime) func(goja.F 
// @summary Send data to presences on a stream.

// @param stream(type=nkruntime.Stream) A stream object.

// @param data(type=string) The data to send.

// @param presences(type=nkruntime.Presence, optional=true) Array of presences to receive the sent data. If not set, will be sent to all presences.

// @param presences(type=nkruntime.Presence[], optional=true, default=all) Array of presences to receive the sent data.

// @param reliable(type=bool, optional=true, default=true) Whether the sender has been validated prior.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) streamSend(r *goja.Runtime) func(goja.FunctionCall) goja.Value {
@@ -3236,7 +3236,7 @@ func (n *runtimeJavascriptNakamaModule) streamSend(r *goja.Runtime) func(goja.Fu 
// @summary Send a message to presences on a stream.

// @param stream(type=nkruntime.Stream) A stream object.

// @param msg(type=&rtapi.Envelope{}) The message to send.

// @param presences(type=nkruntime.Presence[]) Array of presences to receive the sent data. If not set, will be sent to all presences.

// @param presences(type=nkruntime.Presence[], optional=true, default=all) Array of presences to receive the sent data.

// @param reliable(type=bool, optional=true, default=true) Whether the sender has been validated prior.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) streamSendRaw(r *goja.Runtime) func(goja.FunctionCall) goja.Value {
@@ -3363,8 +3363,8 @@ func (n *runtimeJavascriptNakamaModule) sessionDisconnect(r *goja.Runtime) func( 
// @group sessions

// @summary Log out a user from their current session.

// @param userId(type=string) The ID of the user to be logged out.

// @param token(type=string) The current session authentication token.

// @param refreshToken(type=string) The current session refresh token.

// @param token(type=string, optional=true) The current session authentication token. If the current auth and refresh tokens are not provided, all user sessions will be logged out.

// @param refreshToken(type=string, optional=true) The current session refresh token. If the current auth and refresh tokens are not provided, all user sessions will be logged out.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) sessionLogout(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -3476,7 +3476,7 @@ func (n *runtimeJavascriptNakamaModule) matchGet(r *goja.Runtime) func(goja.Func 
// @summary List currently running realtime multiplayer matches and optionally filter them by authoritative mode, label, and current participant count.

// @param limit(type=number, optional=true, default=1) The maximum number of matches to list.

// @param authoritative(type=bool, optional=true, default=false) Set true to only return authoritative matches, false to only return relayed matches.

// @param label(type=string, optional=true) A label to filter authoritative matches by. Default "" meaning any label matches.

// @param label(type=string, optional=true, default="") A label to filter authoritative matches by. Default "" meaning any label matches.

// @param minSize(type=number, optional=true) Inclusive lower limit of current match participants.

// @param maxSize(type=number, optional=true) Inclusive upper limit of current match participants.

// @param query(type=string, optional=true) Additional query parameters to shortlist matches.
@@ -3959,7 +3959,7 @@ func (n *runtimeJavascriptNakamaModule) walletUpdate(r *goja.Runtime) func(goja. 
// @summary Update one or more user wallets with individual changesets. This function will also insert a new wallet ledger item into each user's wallet history that tracks their update.

// @param updates(type=nkruntime.WalletUpdate[]) The set of user wallet update operations to apply.

// @param updateLedger(type=bool, optional=true, default=false) Whether to record this update in the ledger.

// @return updateWallets(nkruntime.WallateUpdateResult) A list of wallet update results.

// @return updateWallets(nkruntime.WalletUpdateResult[]) A list of wallet update results.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) walletsUpdate(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -4239,7 +4239,7 @@ func (n *runtimeJavascriptNakamaModule) storageList(r *goja.Runtime) func(goja.F 
// @group storage

// @summary Fetch one or more records by their bucket/collection/keyname and optional user.

// @param objectIds(type=nkruntime.StorageReadRequest[]) An array of object identifiers to be fetched.

// @return objects(nkruntime.StorageObject[]) A list of matches matching the parameters criteria.

// @return objects(nkruntime.StorageObject[]) A list of storage records matching the parameters criteria.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) storageRead(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -4345,7 +4345,7 @@ func (n *runtimeJavascriptNakamaModule) storageRead(r *goja.Runtime) func(goja.F 
// @group storage

// @summary Write one or more objects by their collection/keyname and optional user.

// @param objectIds(type=nkruntime.StorageWriteRequest[]) An array of object identifiers to be written.

// @return acks(nkruntime.StorageWriteAcks) A list of acks with the version of the written objects.

// @return acks(nkruntime.StorageWriteAck[]) A list of acks with the version of the written objects.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) storageWrite(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -4572,12 +4572,12 @@ func (n *runtimeJavascriptNakamaModule) storageDelete(r *goja.Runtime) func(goja 


// @group users

// @summary Update account, storage, and wallet information simultaneously.

// @param accountUpdates(type=nkruntime.AccountUpdate) Array of account information to be updated.

// @param accountUpdates(type=nkruntime.AccountUpdate[]) Array of account information to be updated.

// @param storageWrites(type=nkruntime.StorageWriteRequest[]) Array of storage objects to be updated.

// @param walletUpdates(type=nkruntime.WalletUpdate[]) Array of wallet updates to be made.

// @param updateLedger(type=bool, optional=true, default=false) Whether to record this wallet update in the ledger.

// @return storageWriteAcks(nkruntime.StorageWriteAck) A list of acks with the version of the written objects.

// @return walletUpdateAcks(nkruntime.WalletUpdateResult) A list of wallet updates results.

// @return storageWriteAcks(nkruntime.StorageWriteAck[]) A list of acks with the version of the written objects.

// @return walletUpdateAcks(nkruntime.WalletUpdateResult[]) A list of wallet updates results.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) multiUpdate(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -4899,7 +4899,7 @@ func (n *runtimeJavascriptNakamaModule) multiUpdate(r *goja.Runtime) func(goja.F 
// @group leaderboards

// @summary Setup a new dynamic leaderboard with the specified ID and various configuration settings. The leaderboard will be created if it doesn't already exist, otherwise its configuration will not be updated.

// @param leaderboardID(type=string) The unique identifier for the new leaderboard. This is used by clients to submit scores.

// @param authoritative(type=bool, default=false) Mark the leaderboard as authoritative which ensures updates can only be made via the Go runtime. No client can submit a score directly.

// @param authoritative(type=bool, optional=true, default=false) Mark the leaderboard as authoritative which ensures updates can only be made via the Go runtime. No client can submit a score directly.

// @param sortOrder(type=string, optional=true, default="desc") The sort order for records in the leaderboard. Possible values are "asc" or "desc".

// @param operator(type=string, optional=true, default="best") The operator that determines how scores behave when submitted. Possible values are "best", "set", or "incr".

// @param resetSchedule(type=string, optional=true) The cron format used to define the reset schedule for the leaderboard. This controls when a leaderboard is reset and can be used to power daily/weekly/monthly leaderboards.
@@ -5006,7 +5006,7 @@ func (n *runtimeJavascriptNakamaModule) leaderboardDelete(r *goja.Runtime) func( 
// @summary Find leaderboards which have been created on the server. Leaderboards can be filtered with categories.

// @param limit(type=number, optional=true, default=10) Return only the required number of leaderboards denoted by this limit value.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return leaderboardList(nkruntime.LeaderboardList) A list of leaderboard results and possibly a cursor. If cursor is empty/null there are no further results.

// @return leaderboardList(nkruntime.LeaderboardList[]) A list of leaderboard results and possibly a cursor. If cursor is empty/null there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) leaderboardList(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -5067,8 +5067,8 @@ func (n *runtimeJavascriptNakamaModule) leaderboardList(r *goja.Runtime) func(go 
// @param limit(type=number) The maximum number of records to return (Max 10,000).

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @param overrideExpiry(type=int, optional=true) Records with expiry in the past are not returned unless within this defined limit. Must be equal or greater than 0.

// @return records(nkruntime.LeaderboardRecord) A page of leaderboard records.

// @return ownerRecords(nkruntime.LeaderboardRecord) A list of owner leaderboard records (empty if the owners input parameter is not set).

// @return records(nkruntime.LeaderboardRecord[]) A page of leaderboard records.

// @return ownerRecords(nkruntime.LeaderboardRecord[]) A list of owner leaderboard records (empty if the owners input parameter is not set).

// @return nextCursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any). Will be set to "" or null when fetching last available page.

// @return prevCursor(string) An optional previous page cursor that can be used to retrieve the previous page of records (if any).

// @return error(error) An optional error value if an error occurred.
@@ -5232,7 +5232,7 @@ func (n *runtimeJavascriptNakamaModule) leaderboardRecordDelete(r *goja.Runtime) 
// @group leaderboards

// @summary Fetch one or more leaderboards by ID.

// @param ids(type=string[]) The table array of leaderboard ids.

// @return leaderboards(nkruntime.Leaderboard) The leaderboard records according to ID.

// @return leaderboards(nkruntime.Leaderboard[]) The leaderboard records according to ID.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) leaderboardsGetId(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -5601,7 +5601,7 @@ func (n *runtimeJavascriptNakamaModule) subscriptionValidateApple(r *goja.Runtim 
// @param userId(type=string) The user ID of the owner of the receipt.

// @param receipt(type=string) JSON encoded Google receipt.

// @param persist(type=bool, optional=true, default=true) Persist the subscription.

// @return validation(nkruntime.ValidatePurchaseResponse) The resulting successfully validated subscriptions.

// @return validation(nkruntime.ValidateSubscriptionResponse) The resulting successfully validated subscriptions.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) subscriptionValidateGoogle(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -5690,7 +5690,7 @@ func (n *runtimeJavascriptNakamaModule) subscriptionGetByProductId(r *goja.Runti 
// @param userId(type=string, optional=true) Filter by user ID. Can be an empty string to list subscriptions for all users.

// @param limit(type=number, optional=true, default=100) Limit number of records retrieved.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return listPurchases(nkruntime.ValidatedPurchaseList) A page of stored validated subscriptions and possibly a cursor. If cursor is empty/null there are no further results.

// @return listSubscriptions(nkruntime.SubscriptionList) A page of stored validated subscriptions and possibly a cursor. If cursor is empty/null there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) subscriptionsList(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -6270,8 +6270,8 @@ func (n *runtimeJavascriptNakamaModule) tournamentList(r *goja.Runtime) func(goj 
// @param owner(type=string) The owner of this score submission. Mandatory field.

// @param username(type=string, optional=true) The owner username of this score submission, if it's a user.

// @param score(type=number, optional=true, default=0) The score to submit.

// @return subscore(type=number, optional=true, default=0) A secondary subscore parameter for the submission.

// @return metadata(object) The metadata you want associated to this submission. Some good examples are weather conditions for a racing game.

// @param subscore(type=number, optional=true, default=0) A secondary subscore parameter for the submission.

// @param metadata(type=object) The metadata you want associated to this submission. Some good examples are weather conditions for a racing game.

// @return result(nkruntime.LeaderboardRecord) The newly created leaderboard record.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) tournamentRecordWrite(r *goja.Runtime) func(goja.FunctionCall) goja.Value {
@@ -8147,7 +8147,7 @@ func (n *runtimeJavascriptNakamaModule) satoriConstructor(r *goja.Runtime) (*goj 


// @group satori

// @summary Get the Satori client.

// @return satori(type=nkruntime.Satori) The satori client.

// @return satori(*nkruntime.Satori) The satori client.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) getSatori(r *goja.Object) func(goja.FunctionCall) goja.Value {

	return func(goja.FunctionCall) goja.Value {
@@ -8174,7 +8174,7 @@ func (n *runtimeJavascriptNakamaModule) satoriAuthenticate(r *goja.Runtime) func 
// @group satori

// @summary Get identity properties.

// @param id(type=string) The identifier of the identity.

// @return properties(type=nkruntime.Properties) The identity properties.

// @return properties(*nkruntime.Properties) The identity properties.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) satoriPropertiesGet(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -8311,7 +8311,7 @@ func (n *runtimeJavascriptNakamaModule) satoriPublishEvents(r *goja.Runtime) fun 
// @summary List experiments.

// @param id(type=string) The identifier of the identity.

// @param names(type=string[], optional=true, default=[]) Optional list of experiment names to filter.

// @return experiments(type=nkruntime.Experiment[]) The experiment list.

// @return experiments(*nkruntime.Experiment[]) The experiment list.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) satoriExperimentsList(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -8358,7 +8358,7 @@ func (n *runtimeJavascriptNakamaModule) satoriExperimentsList(r *goja.Runtime) f 
// @summary List flags.

// @param id(type=string) The identifier of the identity.

// @param names(type=string[], optional=true, default=[]) Optional list of flag names to filter.

// @return flags(type=nkruntime.Flag[]) The flag list.

// @return flags(*nkruntime.Flag[]) The flag list.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) satoriFlagsList(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {
@@ -8406,7 +8406,7 @@ func (n *runtimeJavascriptNakamaModule) satoriFlagsList(r *goja.Runtime) func(go 
// @summary List live events.

// @param id(type=string) The identifier of the identity.

// @param names(type=string[], optional=true, default=[]) Optional list of live event names to filter.

// @return liveEvents(type=nkruntime.LiveEvent[]) The live event list.

// @return liveEvents(*nkruntime.LiveEvent[]) The live event list.

// @return error(error) An optional error value if an error occurred.

func (n *runtimeJavascriptNakamaModule) satoriLiveEventsList(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {

server/runtime_lua_nakama.go

+1 −1
Original line number Diff line number Diff line
@@ -5562,7 +5562,7 @@ func (n *RuntimeLuaNakamaModule) storageList(l *lua.LState) int { 
// @group storage

// @summary Fetch one or more records by their bucket/collection/keyname and optional user.

// @param objectIds(type=table) A table of object identifiers to be fetched.

// @return objects(table) A list of matches matching the parameters criteria.

// @return objects(table) A list of storage objects matching the parameters criteria.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeLuaNakamaModule) storageRead(l *lua.LState) int {

	keysTable := l.CheckTable(1)