@nick22985/wakatime-api

v1.0.2

Published

a year ago

A typescript npm packages to interact with the wakatime api

Downloads

0High
0Medium
0Low

nick22985

wakatime api client NodeJs TypeScript

📝 Table of Contents

🧐 About

This project is using TypeScript to interact with the wakatime API

🏁 Getting Started

Prerequisites

What things you need to install the software and how to install them.

NodeJs

Installing

npm i @nick22985/wakatime-api

🎈 Usage

API

Create a api instance

import { WakaTimeApi, RANGE, SLICE_BY, SUMMARY_RANGE } from "@nick22985/wakatime-api";

const client = new wakatime.WakatimeApi("Api-key");

const wakatime = require("@nick22985/wakatime-api");

const client = new wakatime.WakatimeApi("Api-key");

Custom Base URL

import { WakaTimeApi, RANGE, SLICE_BY, SUMMARY_RANGE } from "@nick22985/wakatime-api";

const client = new WakatimeApi("Api-key", "Custom-base-URL");

getUser

@desc Gets a users stats.
@scope email
@param userId users wakatime id
@returns A single user.
@example getUser("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUser = await client.getUser("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

getMe

@desc Gets your stats
@returns Current users waka time data.
@example await getMe();

let getMe = await wakaClient.getMe();

getUserAgents

@desc List of plugins which have sent data for a user.
@scope read_logged_time
@param userId users wakatime id
@returns Gets a users agents.
@example await getUserAgents("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserAgents = await wakaClient.getUserAgents("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

getMyAgents

@desc List of plugins which have sent data for this user.
@returns Gets current users agents.
@example await getMyAgents();

let getMyAgents = await wakaClient.getMyAgents();

getUserSummaries

@desc A user's coding activity for the given time range as an array of summaries segmented by day.
@scope read_logged_time
@param userId users wakatime id
@param start start date in ISO FORMAT
@param end end date in ISO FORMAT
@param project optional: project name
@param branches optional: branch name
@param timeout optional: timeout in seconds
@param writes_only optional: only return write data
@param timezone optional: timezone
@param range optional: RANGE enum value
@returns Summary data for a user.
@example await getUserSummaries("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "2019-01-01", "2020-01-31");

let getUserSummaries = await wakaClient.getUserSummaries("<Wakatime ID>", "2019-01-01", "2020-01-31");

getMySummaries

@desc A your coding activity for the given time range as an array of summaries segmented by day.
@param start start date in ISO FORMAT
@param end end date in ISO FORMAT
@param project optional: project name
@param branches optional: branch name
@param timeout optional: timeout in seconds
@param writes_only optional: only return write data
@param timezone optional: timezone
@param range optional: RANGE enum value
@returns Summary data for current user.
@example await getUserSummaries("2019-01-01", "2020-01-31");

let getMySummaries = await wakaClient.getMySummaries("2019-01-01", "2020-01-31");

getStatsAggregated

@desc Aggregate stats of all WakaTime users over the given time range.
@param range optional: RANGE enum value (LAST_7_DAYS, LAST_30_DAYS, LAST_6_MONTHS, LAST_YEAR)
@returns Stats data for current user.
@example await getStatsAggregated(SUMMARY_RANGE.LAST_7_DAYS);

let getStatsAggregated = await wakaClient.getStatsAggregated(SUMMARY_RANGE.LAST_7_DAYS);

getStats

@desc A user's coding activity for the given time range.
@scope read_stats
@param userId users wakatime id
@param range RANGE enum value (LAST_7_DAYS, LAST_30_DAYS, LAST_6_MONTHS, LAST_YEAR)
@param timeout optional: timeout in seconds
@param writes_only optional: only return write data
@param project optional: project name
@returns Stats data for a user.
@example await getStats("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", RANGE.LAST_7_DAYS);

let getStats = await wakaClient.getStats("<Wakatime ID>", wakatime.RANGE.LAST_7_DAYS);

getMyStats

@desc A user's coding activity for the given time range.
@scope read_stats
@param range RANGE enum value (LAST_7_DAYS, LAST_30_DAYS, LAST_6_MONTHS, LAST_YEAR)
@param timeout optional: timeout in seconds
@param writes_only optional: only return write data
@param project optional: project name
@returns Stats data for a user.
@example await getStats("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", RANGE.LAST_7_DAYS);

let getMyStats = await wakaClient.getMyStats(wakatime.RANGE.LAST_7_DAYS);

getUserProjects

@desc List of WakaTime projects for a user.
@scope read_logged_time
@param userId users wakatime id
@param query optional: Filter project names by a search term.
@returns Gets a users projects.
@example await getUserProjects("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserProjects = await wakaClient.getUserProjects("<Wakatime ID>");

getMyProjects

@desc List of WakaTime projects for a user.
@scope read_logged_time
@param query optional: Filter project names by a search term.
@returns Gets a users projects.
@example await getUserProjects("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserProjects = await wakaClient.getMyProjects("<Wakatime ID>");

getPrivateLeaderboardsLeaders

@desc List of users in this private leaderboard ranked by coding activity in descending order.
@scope read_private_leaderboards
@param userId users wakatime id
@param board board name
@param language optional: language name
@param country_code optional: country code
@param page optional: page number
@returns Gets a users Leaderboards.
@example await getUserLeaderboard("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "wakatime");

let getPrivateLeaderboardsLeaders = await wakaClient.getPrivateLeaderboardsLeaders("<Wakatime ID>", "cee8a02b-147f-4881-9b43-5d193fb77d32");

getMyPrivateLeaderboardsLeaders

@desc List of users in this private leaderboard ranked by coding activity in descending order.
@param board board name
@param language optional: language name
@param country_code optional: country code
@param page optional: page number
@returns Gets a users Leaderboards.
@example await getUserLeaderboard("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "wakatime");

let getMyPrivateLeaderboardsLeaders = await wakaClient.getMyPrivateLeaderboardsLeaders("cee8a02b-147f-4881-9b43-5d193fb77d32");

getPrivateLeaderboards

@desc List of users in your private leaderboard ranked by coding activity in descending order.
@param board board name
@param language optional: language name
@param country_code optional: country code
@param page optional: page number
@returns Gets current users Leaderboards.
@example await getPrivateLeaderboards("wakatime");

let getPrivateLeaderboards = await wakaClient.getPrivateLeaderboards("<Wakatime ID>");

getMyPrivateLeaderboards

@desc List of users in your private leaderboard ranked by coding activity in descending order.
@param board board name
@param language optional: language name
@param country_code optional: country code
@param page optional: page number
@returns Gets current users Leaderboards.
@example await getMyPrivateLeaderboardsLeaders("wakatime");

let getMyPrivateLeaderboards = await wakaClient.getMyPrivateLeaderboards("<Wakatime ID>");

getUsersOrgs

@desc List a user’s organizations.
@scope read_orgs
@param userId users wakatime id
@returns Gets a users Orgs.
@example await getUserOrgs("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUsersOrgs = await wakaClient.getUsersOrgs("<Wakatime ID>");

getMyOrgs

@desc List a user’s organizations.
@returns Gets current users Orgs.
@example await getMyOrgs();

let getMyOrgs = await wakaClient.getMyOrgs();

getUsersOrgDashboard

@desc List a user’s organizations.
@scope read_orgs
@param userId users wakatime id
@param org org UUID
@returns Gets a users Org Dashboards.
@example await getUsersOrgDashboard("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "wakatime");

let getUsersOrgDashboard = await wakaClient.getUsersOrgDashboard("<Wakatime ID>", "<Wakatime Org UUID>");

getMyOrgsDashboard

@desc List the organization’s dashboards.
@param org org UUID
@returns Gets current users Org Dashboards.
@example await getMyOrgsDashboard("wakatime");

let getMyOrgsDashboard = await wakaClient.getMyOrgsDashboard("<Wakatime Org UUID>");

getOrgDashboardMembers

@desc List an organization’s members.
@scope read_orgs
@param userId users wakatime id
@param org org UUID
@param dashboard dashboard name
@returns Gets a users Org Dashboard.

let getOrgDashboardMembers = await wakaClient.getOrgDashboardMembers("<Wakatime ID>", "<Wakatime Org UUID>", "<Wakatime Org Dashboard>");

getMyOrgDashboardMembers

@desc List your organization’s members.
@param org org UUID
@param dashboard dashboard UUID
@returns Gets current users Org Projects.
@example await getMyOrgDashboardMembers("wakatime", "wakatime");

let getMyOrgDashboardMembers = await wakaClient.getMyOrgDashboardMembers("<Wakatime Org UUID>", "<Wakatime Org Dashboard>");

orgDashboardMemberSummaries

@desc An organization dashboard member’s coding activity for the given time range as an array of summaries segmented by day.
@scope read_orgs
@param userId users wakatime id
@param org org UUID
@param dashboard dashboard UUID
@param member member name
@param start start date
@param end end date
@param project optional: project name
@param branches optional: branch name
@param range optional: RANGE enum value (LAST_7_DAYS, LAST_30_DAYS, LAST_6_MONTHS, LAST_YEAR)
@returns Gets a users Org Dashboard Summaries.
@example await orgDashboardMemberSummaries("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "wakatime", "wakatime", "nick22985", "2019-01-01", "2020-01-31");

let orgDashboardMemberSummaries = await wakaClient.orgDashboardMemberSummaries(
	"<Wakatime ID>",
	"<Wakatime Org UUID>",
	"<Wakatime Org Dashboard>",
	"nick22985",
	"2021-15-12",
	"2021-19-12"
);

orgDashboardMemberDurations

@desc A dashboard member's coding activity for the given day as an array of durations.
@scope read_orgs
@param userId users wakatime id
@param org org UUID
@param dashboard dashboard UUID
@param member member name
@param date date
@param project optional: project name
@param branches optional: branch name
@returns Gets a users Org Dashboard Member Durations.
@example await orgDashboardMemberDurations("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "wakatime", "wakatime", "nick22985", "2019-01-01");

let orgDashboardMemberDurations = await wakaClient.orgDashboardMemberDurations(
	"<Wakatime ID>",
	"<Wakatime Org UUID>",
	"<Wakatime Org Dashboard>",
	"<Wakatime ID>",
	"2021-15-12"
);

getMyOrgDashboardMemberDurations

@desc A dashboard member's coding activity for the given day as an array of durations.
@param org org UUID
@param dashboard dashboard UUID
@param member member name
@param date date
@param project optional: project name
@param branches optional: branch name
@returns Gets current users Org Projects.
@example await getMyOrgDashboardMemberDurations("wakatime", "wakatime", "nick22985", "2019-01-01");

let getMyOrgDashboardMemberDurations = await wakaClient.getMyOrgDashboardMemberDurations(
	"<Wakatime Org UUID>",
	"<Wakatime Org Dashboard>",
	"<Wakatime ID>",
	"2021-15-12"
);

getMeta

@desc A dashboard member's coding activity for the given day as an array of durations.
@returns Gets information about WakaTime.
@example await getWakaTimeInfo();

let getMeta = await wakaClient.getMeta();

getUserMachineNames

@desc List of machines for this user.
@scope read_logged_time
@param userId users wakatime id
@returns Gets a users Machine names.
@example await getMachines("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserMachineNames = await wakaClient.getUserMachineNames("<Wakatime ID>");

getMyMachineNames

@desc List of machines for this user.
@returns Gets current users Machine names.
@example await getMyMachineNames();

let getMyMachineNames = await wakaClient.getMyMachineNames("<Wakatime ID>");

getLeaders

@desc List of users ranked by coding activity in descending order.
@param language language name
@param is_hireable optional: true or false
@param country_code optional: country code
@param page optional: page number
@returns Gets a list of Leaders.
@example await getLeaders("python");

let getLeaders = await wakaClient.getLeaders("JavaScript");

getUserHeartbeats

@desc A user's heartbeats sent from plugins for the given day as an array.
@scope read_logged_time
@param userId users wakatime id
@param date date
@returns get a users Heartbeats.
@example await getUserHeartbeats("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "2019-01-01");

let getUserHeartbeats = await wakaClient.getUserHeartbeats("<Wakatime ID>", "2021-28-12");

getMyHeartbeats

@desc A user's heartbeats sent from plugins for the given day as an array.
@param date date
@returns get current users Heartbeats.
@example await getMyHeartbeats("2019-01-01");

let getMyHeartbeats = await wakaClient.getMyHeartbeats("2021-28-12");

getUserGoals

@desc List a user’s goals.
@scope read_logged_time
@param userId users wakatime id
@returns get a users Heartbeats.
@example await getUserGoals("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserGoals = await wakaClient.getUserGoals("<Wakatime ID>");

getMyGoals

@desc List a user’s goals.
@returns get current users Heartbeats.
@example await getMyGoals();

let getMyGoals = await wakaClient.getMyGoals();

getUserExternalDurations

@desc A user's external durations for the given day.
@scope read_logged_time
@param userId users wakatime id
@param date date
@param project optional: project name
@param branches optional: branch name
@param timezone optional: timezone
@returns gets a users external durations on a given day
@example await getUserExternalDurations("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "2019-01-01");

let getUserExternalDurations = await wakaClient.getUserExternalDurations("<Wakatime ID>", "2021-28-12");

getMyExternalDurations

@desc A user's external durations for the given day.
@param date date
@param project optional: project name
@param branches optional: branch name
@param timezone optional: timezone
@returns gets a users external durations on a given day

let getMyExternalDurations = await wakaClient.getMyExternalDurations("2021-28-12");

getEditors

@desc List of WakaTime IDE plugins, latest plugin versions, and their color used on WakaTime charts.
@param unreleased Show unreleased editor plugins
@returns List of WakaTime IDE plugins versions
@example await getEditors();

let getEditors = await wakaClient.getEditors();

getUserDurations

@desc A user's coding activity for the given day as an array of durations
@scope read_logged_time
@param userId users wakatime id
@param date date
@param project optional: project name
@param branches optional: branch name
@param timeout optional: timeout
@param writes_only optional: true or false
@param timezone optional: timezone
@param slice_by optional: DEFAULT Entity enum: entity, language, dependencies, os, editor, category or machine
@returns Gets a users durations.
@example await getUserDurations("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "2019-01-01");

let getUserDurations = await wakaClient.getUserDurations("<Wakatime ID>", "2021-28-12");

getMyDurations

@desc Your coding activity for the given day as an array of durations
@scope read_logged_time
@param date date
@param project optional: project name
@param branches optional: branch name
@param timeout optional: timeout
@param writes_only optional: true or false
@param timezone optional: timezone
@param slice_by optional: DEFAULT Entity enum: entity, language, dependencies, os, editor, category or machine
@returns Gets a users durations.
@example await getUserDurations("2019-01-01");

let getMyDurations = await wakaClient.getMyDurations("2021-28-12");

getUserDataDump

@desc List data exports for the user.
@scope read_logged_time
@param userId users wakatime id
@returns List of data exports for the user
@example await getUserDataDump("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserDataDump = await wakaClient.getUserDataDump("<Wakatime ID>");

getMyDataDump

@desc List data exports for the user.
@returns List of data exports for the user
@example await getMyDataDump();

let getMyDataDump = await wakaClient.getMyDataDump("<Wakatime ID>");

getUserCommits

@desc List of commits for a WakaTime project showing the time spent coding in each commit.
@scope read_logged_time
@param userId users wakatime id
@param project project name
@param author optional: author name
@param branch optional: branch name
@param page optional: page number
@returns List of commits for the user
@example await getUserCommits("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserCommits = await wakaClient.getUserCommits("<Wakatime ID>");

getMyCommits

@desc List of commits for a WakaTime project showing the time spent coding in each commit.
@param project optional: project name
@param author optional: author name
@param branch optional: branch name
@param page optional: page number
@returns List of commits for the current user
@example await getMyCommits();

let getMyCommits = await wakaClient.getMyCommits();

getUserCommit

@desc A single commit from a WakaTime project showing the time spent coding on the commit.
@scope read_logged_time
@param userId users wakatime id
@param project project name
@param hash commit hash
@param branch optional: branch name
@returns List a user commits for a given commit hash
@example await getUserCommit("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e", "my-project", "1234567890");

let getUserCommit = await wakaClient.getUserCommit("<Wakatime ID>", "Dev-Stats", "736ed941e069e2c910b86266243965ea745a8050");

getMyCommit

@desc A single commit from a WakaTime project showing the time spent coding on the commit.
@param project optional: project name
@param hash optional: commit hash
@param branch optional: branch name
@returns List the current user commits for a given commit hash
@example await getMyCommit("my-project", "1234567890");

let getMyCommit = await wakaClient.getMyCommit("Dev-Stats", "736ed941e069e2c910b86266243965ea745a8050");

getUserAllTimeSinceToday

@desc The total time logged since account created, available even for Free accounts.
@scope read_stats
@param userId users wakatime id
@param project optional: project name
@returns The total time logged since account created. Even for free accounts
@example await getUserAllTimeSinceToday("1f89b85e-54a8-4f75-86a2-f9b7d47ba30e");

let getUserAllTimeSinceToday = await wakaClient.getUserAllTimeSinceToday("<Wakatime ID>");

getMyAllTimeSinceToday

@desc The total time logged since account created, available even for Free accounts.
@scope read_stats
@param userId users wakatime id
@param project optional: project name
@returns The total time logged since account created. Even for free accounts
@example await getMyAllTimeSinceToday();

let getMyAllTimeSinceToday = await wakaClient.getMyAllTimeSinceToday("<Wakatime ID>");

⛏️ Built Using

NodeJs

✍️ Authors

@nick22985