echofi-client
Version:
A TypeScript/Node.js client library for EchoFi services with Level 3 Ultimate API and gRPC-Web clients for music streaming, user management, activity tracking, and authentication.
559 lines • 23.4 kB
JavaScript
;
/**
* Auto-Generated Request Helper Utilities for EchoFi gRPC-Web Client
*
* These utilities provide a simplified way to create protobuf request objects
* from JSON data, reducing the verbosity of the standard setter approach.
*
* Generated automatically from proto files - do not edit manually
* To regenerate: npm run generate-client
*
* Instead of:
* const request = new Messages.Music.Service.ListArtistsRequest();
* request.setOffset(0);
* request.setLimit(20);
*
* You can use:
* const request = Helpers.Music.createListArtistsRequest({ offset: 0, limit: 20 });
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.Helpers = void 0;
// Import message types from generated code
const activityService = __importStar(require("./activity/service_pb"));
const authService = __importStar(require("./auth/service_pb"));
const musicService = __importStar(require("./music/service_pb"));
const statsService = __importStar(require("./stats/service_pb"));
const userService = __importStar(require("./user/service_pb"));
/**
* Helper functions for creating requests from JSON objects
* Automatically generated for all services and request types
*/
exports.Helpers = {
Activity: {
/**
* Create a GetListeningHistoryRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetListeningHistoryRequest({ historyId: 123 });
*/
createGetListeningHistoryRequest(data) {
const request = new activityService.GetListeningHistoryRequest();
if (data.historyId !== undefined)
request.setHistoryId(data.historyId);
return request;
},
/**
* Create a ListListeningHistoryRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListListeningHistoryRequest({ offset: 123, limit: 123 });
*/
createListListeningHistoryRequest(data = {}) {
const request = new activityService.ListListeningHistoryRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.userId !== undefined)
request.setUserId(data.userId);
if (data.trackId !== undefined)
request.setTrackId(data.trackId);
return request;
},
/**
* Create a GetUserFavoriteRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserFavoriteRequest({ favoriteId: 123 });
*/
createGetUserFavoriteRequest(data) {
const request = new activityService.GetUserFavoriteRequest();
if (data.favoriteId !== undefined)
request.setFavoriteId(data.favoriteId);
return request;
},
/**
* Create a ListUserFavoritesRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserFavoritesRequest({ offset: 123, limit: 123 });
*/
createListUserFavoritesRequest(data = {}) {
const request = new activityService.ListUserFavoritesRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.userId !== undefined)
request.setUserId(data.userId);
return request;
},
/**
* Create a GetPlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetPlaylistRequest({ playlistId: 123 });
*/
createGetPlaylistRequest(data) {
const request = new activityService.GetPlaylistRequest();
if (data.playlistId !== undefined)
request.setPlaylistId(data.playlistId);
return request;
},
/**
* Create a ListPlaylistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListPlaylistsRequest({ offset: 123, limit: 123 });
*/
createListPlaylistsRequest(data = {}) {
const request = new activityService.ListPlaylistsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.createdBy !== undefined)
request.setCreatedBy(data.createdBy);
if (data.isPublic !== undefined)
request.setIsPublic(data.isPublic);
return request;
},
/**
* Create a ListPlaylistTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListPlaylistTracksRequest({ playlistId: 123, offset: 123 });
*/
createListPlaylistTracksRequest(data) {
const request = new activityService.ListPlaylistTracksRequest();
if (data.playlistId !== undefined)
request.setPlaylistId(data.playlistId);
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
/**
* Create a GetUserPointRateRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserPointRateRequest({ userId: "value" });
*/
createGetUserPointRateRequest(data) {
const request = new activityService.GetUserPointRateRequest();
if (data.userId !== undefined)
request.setUserId(data.userId);
return request;
},
/**
* Create a ListUserPointRatesRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserPointRatesRequest({ offset: 123, limit: 123 });
*/
createListUserPointRatesRequest(data = {}) {
const request = new activityService.ListUserPointRatesRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
/**
* Create a UpdateUserPointRateRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createUpdateUserPointRateRequest({ userId: "value" });
*/
createUpdateUserPointRateRequest(data) {
const request = new activityService.UpdateUserPointRateRequest();
if (data.userId !== undefined)
request.setUserId(data.userId);
return request;
},
/**
* Create a GetRateParamRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetRateParamRequest({ paramId: 123 });
*/
createGetRateParamRequest(data) {
const request = new activityService.GetRateParamRequest();
if (data.paramId !== undefined)
request.setParamId(data.paramId);
return request;
},
/**
* Create a ListRateParamsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListRateParamsRequest({ offset: 123, limit: 123 });
*/
createListRateParamsRequest(data = {}) {
const request = new activityService.ListRateParamsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.isActive !== undefined)
request.setIsActive(data.isActive);
return request;
},
/**
* Create a GetListeningSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetListeningSessionRequest({ id: "value" });
*/
createGetListeningSessionRequest(data) {
const request = new activityService.GetListeningSessionRequest();
if (data.id !== undefined)
request.setId(data.id);
return request;
},
/**
* Create a ListListeningSessionsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListListeningSessionsRequest({ offset: 123, limit: 123 });
*/
createListListeningSessionsRequest(data = {}) {
const request = new activityService.ListListeningSessionsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.userId !== undefined)
request.setUserId(data.userId);
if (data.status !== undefined)
request.setStatus(data.status);
return request;
},
/**
* Create a GetUserPointsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserPointsRequest({ userId: "value" });
*/
createGetUserPointsRequest(data) {
const request = new activityService.GetUserPointsRequest();
if (data.userId !== undefined)
request.setUserId(data.userId);
return request;
},
/**
* Create a ListUserPointsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserPointsRequest({ offset: 123, limit: 123 });
*/
createListUserPointsRequest(data = {}) {
const request = new activityService.ListUserPointsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.status !== undefined)
request.setStatus(data.status);
return request;
},
/**
* Create a GetUnprocessedListeningRecordsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUnprocessedListeningRecordsRequest({ offset: 123, limit: 123 });
*/
createGetUnprocessedListeningRecordsRequest(data = {}) {
const request = new activityService.GetUnprocessedListeningRecordsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
/**
* Create a GetUnprocessedListeningDurationRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUnprocessedListeningDurationRequest({ });
*/
createGetUnprocessedListeningDurationRequest(data = {}) {
const request = new activityService.GetUnprocessedListeningDurationRequest();
return request;
},
},
Auth: {
/**
* Create a GetSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createGetSessionRequest({ sessionToken: "value" });
*/
createGetSessionRequest(data) {
const request = new authService.GetSessionRequest();
if (data.sessionToken !== undefined)
request.setSessionToken(data.sessionToken);
return request;
},
/**
* Create a CreateSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createCreateSessionRequest({ session: 123 });
*/
createCreateSessionRequest(data) {
const request = new authService.CreateSessionRequest();
if (data.session !== undefined)
request.setSession(data.session);
return request;
},
/**
* Create a DeleteSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createDeleteSessionRequest({ sessionToken: "value" });
*/
createDeleteSessionRequest(data) {
const request = new authService.DeleteSessionRequest();
if (data.sessionToken !== undefined)
request.setSessionToken(data.sessionToken);
return request;
},
},
Music: {
/**
* Create a GetArtistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetArtistRequest({ artistId: 123 });
*/
createGetArtistRequest(data) {
const request = new musicService.GetArtistRequest();
if (data.artistId !== undefined)
request.setArtistId(data.artistId);
return request;
},
/**
* Create a ListArtistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListArtistsRequest({ offset: 123, limit: 123 });
*/
createListArtistsRequest(data = {}) {
const request = new musicService.ListArtistsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
/**
* Create a GetAlbumRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetAlbumRequest({ albumId: 123 });
*/
createGetAlbumRequest(data) {
const request = new musicService.GetAlbumRequest();
if (data.albumId !== undefined)
request.setAlbumId(data.albumId);
return request;
},
/**
* Create a ListAlbumsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListAlbumsRequest({ offset: 123, limit: 123 });
*/
createListAlbumsRequest(data = {}) {
const request = new musicService.ListAlbumsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.artistId !== undefined)
request.setArtistId(data.artistId);
return request;
},
/**
* Create a GetTrackRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetTrackRequest({ trackId: 123 });
*/
createGetTrackRequest(data) {
const request = new musicService.GetTrackRequest();
if (data.trackId !== undefined)
request.setTrackId(data.trackId);
return request;
},
/**
* Create a ListTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListTracksRequest({ offset: 123, limit: 123 });
*/
createListTracksRequest(data = {}) {
const request = new musicService.ListTracksRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.artistId !== undefined)
request.setArtistId(data.artistId);
if (data.albumId !== undefined)
request.setAlbumId(data.albumId);
if (data.genreId !== undefined)
request.setGenreId(data.genreId);
return request;
},
/**
* Create a GetGenreRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetGenreRequest({ genreId: 123 });
*/
createGetGenreRequest(data) {
const request = new musicService.GetGenreRequest();
if (data.genreId !== undefined)
request.setGenreId(data.genreId);
return request;
},
/**
* Create a ListGenresRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListGenresRequest({ offset: 123, limit: 123 });
*/
createListGenresRequest(data = {}) {
const request = new musicService.ListGenresRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
},
Stats: {
/**
* Create a GetUserStatisticsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createGetUserStatisticsRequest({ userId: "value" });
*/
createGetUserStatisticsRequest(data) {
const request = new statsService.GetUserStatisticsRequest();
if (data.userId !== undefined)
request.setUserId(data.userId);
return request;
},
/**
* Create a ListUserStatisticsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createListUserStatisticsRequest({ offset: 123, limit: 123 });
*/
createListUserStatisticsRequest(data = {}) {
const request = new statsService.ListUserStatisticsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
/**
* Create a GetPointBoostRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createGetPointBoostRequest({ boostId: 123 });
*/
createGetPointBoostRequest(data) {
const request = new statsService.GetPointBoostRequest();
if (data.boostId !== undefined)
request.setBoostId(data.boostId);
return request;
},
/**
* Create a ListPointBoostsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createListPointBoostsRequest({ offset: 123, limit: 123 });
*/
createListPointBoostsRequest(data = {}) {
const request = new statsService.ListPointBoostsRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
if (data.userId !== undefined)
request.setUserId(data.userId);
if (data.isActive !== undefined)
request.setIsActive(data.isActive);
return request;
},
},
User: {
/**
* Create a GetUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createGetUserRequest({ id: "value" });
*/
createGetUserRequest(data) {
const request = new userService.GetUserRequest();
if (data.id !== undefined)
request.setId(data.id);
return request;
},
/**
* Create a ListUsersRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createListUsersRequest({ offset: 123, limit: 123 });
*/
createListUsersRequest(data = {}) {
const request = new userService.ListUsersRequest();
if (data.offset !== undefined)
request.setOffset(data.offset);
if (data.limit !== undefined)
request.setLimit(data.limit);
return request;
},
},
};
exports.default = exports.Helpers;
//# sourceMappingURL=helpers.js.map