@beauraines/toggl-cli 0.10.5

package/cmds/today.mjs

@@ -0,0 +1,83 @@
+import Client from '../client.js'
+import dayjs from 'dayjs'
+import {getWorkspace,getProjects, formatDuration,formatDurationAsTime} from '../utils.js'
+import dur from 'dayjs/plugin/duration.js'
+import relativeTime from 'dayjs/plugin/relativeTime.js'
+dayjs.extend(relativeTime)
+dayjs.extend(dur)
+
+export const command = 'today'
+export const desc = 'Reports today\'s activities by project'
+export const builder = {}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const workspace = await getWorkspace()
+  const projects = await getProjects(workspace.id)
+  const params = { 
+    start_date: dayjs().startOf('day').toISOString(),
+    end_date: dayjs().toISOString()
+  }
+
+  const timeEntries = await client.timeEntries.list(params)
+
+  let todaysProjects = []
+  timeEntries.map(e => {
+    todaysProjects.push(e.pid)
+  })
+  todaysProjects = [...new Set(todaysProjects)]
+
+  const report = []
+  todaysProjects.map(p => {
+    let total = 0
+    timeEntries.filter(x => x.pid == p).map(e => {
+      if (e.duration >= 0) {
+        total += e.duration // UNLESS e.duration is less than zero - meaning currently running
+      } else {
+        const startTime = dayjs.unix(e.duration * -1)
+        const duration = dayjs().diff(startTime, 's')
+        total += duration
+      }
+    })
+    const project = projects.find(x => x.id == p)
+    report.push({
+      project,
+      project_name: project?.name,
+      seconds: total,
+      duration_formatted: formatDuration(total * 1000),
+      duration: formatDurationAsTime(total * 1000)
+    })
+  })
+
+  // Compute total row
+  const totalRow = {
+    project_name: 'Total'
+  }
+  totalRow.seconds = report.reduce((total, project) => {
+    return total + project.seconds
+  }, 0)
+  totalRow.duration_formatted = formatDuration(totalRow.seconds * 1000)
+  totalRow.duration = formatDurationAsTime(totalRow.seconds * 1000)
+  report.push(totalRow)
+
+  // TODO make format a CLI option
+  const format = 'table' // csv | json | table defaults to table
+  displayDailyReport(report, format)
+}
+
+// TODO should this be moved to a formatter file?
+function displayDailyReport (report, format) {
+  switch (format) {
+    case 'csv':
+      // TODO maybe use jsontocsv
+      console.log(JSON.stringify(report))
+      break
+    case 'json':
+      console.log(JSON.stringify(report))
+      break
+    case 'table':
+    default:
+      console.table(report, ['project_name', 'duration_formatted'])
+      break
+  }
+}

package/cmds/web.mjs

@@ -0,0 +1,23 @@
+import open from 'open'
+
+export const command = 'web'
+export const desc = 'Opens toggl track website with default browser, defaults to the timer page'
+export const builder = {
+  t: { alias: ['timer'], describe: 'opens the timer page ', requiresArg: false },
+  r: { alias: ['reports'], describe: 'opens the reports page ', requiresArg: false  },
+
+}
+
+export const handler = async function (argv) {
+  let baseUrl = 'https://track.toggl.com'
+  let pageUrl
+  if ( argv.timer) {
+    pageUrl = 'timer' 
+  } else if ( argv.reports) {
+    pageUrl = 'reports' 
+  } else {
+    pageUrl = 'timer'
+  }
+  console.log(`Opening ${baseUrl}/${pageUrl}`)
+  open(`${baseUrl}/${pageUrl}`)
+}

package/cmds/weekly.mjs

@@ -0,0 +1,98 @@
+import Client from '../client.js'
+import { getWorkspace, formatDuration, getProjectById } from '../utils.js'
+import dayjs from 'dayjs'
+import dur from 'dayjs/plugin/duration.js'
+import relativeTime from 'dayjs/plugin/relativeTime.js'
+dayjs.extend(relativeTime)
+dayjs.extend(dur)
+
+export const command = 'week'
+// FIXME descriptions
+export const desc = 'Weekly project summary by day'
+export const builder = {}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const workspace = await getWorkspace()
+
+  const params = { } // Leave this for future options, like rounding
+  const weeklyReport = await client.reports.weekly(workspace.id, params)
+
+  const reportData = []
+  const totals = [0, 0, 0, 0, 0, 0, 0] // ? Is there a better way to do this?
+  for (const project of weeklyReport) {
+    const currentProject = await getProjectById(workspace.id, project.project_id)
+    const row = {
+      projectName: currentProject.name,
+      Total: 0
+    }
+
+    for (let i = 0; i < project.seconds.length; i++) {
+      const element = project.seconds[i]
+      const date = dayjs().startOf('week').add(i, 'days').format('ddd MM-DD')
+      const duration = element || 0
+      row[date] = formatDuration(duration * 1000)
+      totals[i] += duration // for use with a daily total row
+      row.Total += duration // accumulate the projects weekly totoal
+    }
+    reportData.push(row)
+  }
+
+  const totalRow = {
+    projectName: 'Total',
+    Total: 0
+  }
+
+  for (let i = 0; i < totals.length; i++) {
+    const seconds = totals[i]
+    const date = dayjs().startOf('week').add(i, 'days').format('ddd MM-DD')
+    totalRow[date] = formatDuration(seconds * 1000)
+    totalRow.Total += seconds // accumulate the projects weekly totoal
+  }
+  reportData.push(totalRow)
+
+  for (const project of reportData) {
+    project.Total = formatDuration(project.Total * 1000)
+  }
+  console.table(reportData)
+}
+
+// TODO figure out what to do with these
+function displayReportJson (data) {
+  const json = []
+  data.map(project => {
+    const startOfWeek = dayjs().startOf('week')
+    project.totals.slice(0, 7).map((total, i) => {
+      const duration = dayjs.duration(total, 'milliseconds').format('H[h] m[m]')
+      const day = startOfWeek.add(i, 'days').format('YYYY-MM-DD')
+      // i == 7 ? console.info(`\tTotal : ${duration}`) : console.info(`\t ${day} - ${duration}`);
+      // TODO revise this format - maybe nested
+      const entry = {
+        project: project.title.project,
+        date: day,
+        duration,
+        total
+      }
+      json.push(entry)
+    })
+  })
+  console.log(JSON.stringify(json))
+  console.table(json)
+}
+
+// TODO figure out what do to with these
+function displayReportText (data) {
+  data.map(project => {
+    console.info(project.title.project)
+    const startOfWeek = dayjs().startOf('week')
+    project.totals.map((total, i) => {
+      // TODO see https://runkit.com/6022b36c23da0600130851a0/6022b36c7614ed001ad11853 for formatting options
+      const dur = dayjs.duration(total, 'milliseconds')
+      const hours = (dur.days() * 24) + dur.hours()
+      const duration = `${hours}h ${dur.minutes()}m `
+      // let duration = `${hours}h ${dur.minutes()}m ${dur.seconds()}s`
+      const day = startOfWeek.add(i, 'days').format('ddd MMM D')
+      i == 7 ? console.info(`\tTotal : ${duration}`) : console.info(`\t ${day} - ${duration}`)
+    })
+  })
+}

package/cmds/workspace.mjs

@@ -0,0 +1,10 @@
+import { workspaces } from './workspaces/index.mjs'
+
+export const command = 'workspace <command>'
+export const desc = 'Manage workspaces'
+
+export const builder = function (yargs) {
+  return yargs.command(workspaces)
+}
+
+export const handler = function (argv) {}

package/cmds/workspaces/add.mjs

@@ -0,0 +1,7 @@
+export const command = 'add'
+export const desc = 'Creates a new workspace.'
+export const builder = {}
+
+export const handler = async function (argv) {
+  console.info(`${argv.$0} ${argv._.join(' ')} - this command is not yet supported.`)
+}

package/cmds/workspaces/index.mjs

@@ -0,0 +1,3 @@
+import * as add from './add.mjs'
+import * as list from './list.mjs'
+export const workspaces = [add, list]

package/cmds/workspaces/list.mjs

@@ -0,0 +1,14 @@
+import Client from '../../client.js'
+
+export const command = 'list'
+export const desc = 'Lists workspaces'
+
+export const builder = {
+
+}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const workspaces = await client.workspaces.list()
+  console.log(workspaces)
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@beauraines/toggl-cli",
+  "version": "0.10.5",
+  "description": "",
+  "main": "cli.js",
+  "bin": {
+    "toggl": "./cli.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint . ./**/*.js ./**/*.js",
+    "lint:fix": "eslint . ./**/*.js ./**/*.mjs --fix",
+    "release": "standard-version",
+    "should-release": "should-release"
+  },
+  "type": "module",
+  "keywords": [
+    "toggl",
+    "cli",
+    "time",
+    "tracking"
+  ],
+  "author": "Beau Raines <beau.raines@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beauraines/toggl-cli-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/beauraines/toggl-cli-node/issues"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "dayjs": "^1.11.6",
+    "dotenv": "^16.0.3",
+    "open": "^8.4.0",
+    "toggl-client": "^3.1.1",
+    "yargs": "^17.6.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.34.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "jest": "^29.4.3",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0"
+  }
+}

package/standalone/currentTimeEntry.js

@@ -0,0 +1,12 @@
+import Client from 'toggl-client'
+import { displayTimeEntry } from '../utils.js'
+import dotenv from 'dotenv'
+dotenv.config()
+
+async function main () {
+  const client = new Client()
+  const currentTimeEntry = await client.timeEntries.current()
+  await displayTimeEntry(currentTimeEntry)
+}
+
+main()

package/standalone/getWorkspaces.js

@@ -0,0 +1,11 @@
+import togglClient from 'toggl-client'
+import dotenv from 'dotenv'
+const client = togglClient()
+dotenv.config()
+
+async function main () {
+  const workspaces = await client.workspaces.list()
+  console.log(workspaces)
+}
+
+main()

package/standalone/listProjects.js

@@ -0,0 +1,21 @@
+import togglClient from 'toggl-client'
+import dotenv from 'dotenv'
+const client = togglClient()
+dotenv.config()
+
+async function main () {
+  const workspaces = await client.workspaces.list()
+
+  const workspace = workspaces[0]
+
+  console.info('Workspace: ' + workspace.name)
+  console.info('id: ' + workspace.id)
+
+  const projects = await client.workspaces.projects(workspace.id)
+
+  const activeProjects = projects.filter(x => x.active)
+  console.info(`Found ${activeProjects.length} projects`)
+  activeProjects.map(p => { console.log(p.name + ' ' + p.id) })
+}
+
+main()

package/standalone/startTimeEntry.js

@@ -0,0 +1,47 @@
+import togglClient from 'toggl-client'
+import dayjs from 'dayjs'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { defaultWorkspaceId, defaultProjectId } from '../utils.js'
+import dotenv from 'dotenv'
+dotenv.config()
+
+const client = togglClient()
+
+const options = yargs(hideBin(process.argv))
+  .usage('Usage: $0 -p <project_id> -w <workspace_id> [time entry description]')
+  .option('p', { alias: 'projectId', describe: 'project id', type: 'string', demandOption: false })
+  .option('w', { alias: 'workspaceId', describe: 'workspace id', type: 'number', demandOption: false })
+  .argv
+
+async function main () {
+//   console.debug(JSON.stringify(options))
+  // TODO validate options
+  const description = options._.join(' ')
+  // TODO check that description was provided or provide a default
+  const params = { description }
+  params.workspaceId = options.workspaceId || defaultWorkspaceId
+  params.projectId = options.projectId || defaultProjectId
+  // console.debug(params)
+  const timeEntry = await createTimeEntry(params)
+  console.info(`Started ${timeEntry.description} with project id ${timeEntry.pid}`)
+}
+
+async function createTimeEntry (params) {
+//   const client = Client()
+  const timeEntry = await client.timeEntries.create(
+    {
+      description: params.description,
+      workspace_id: +params.workspaceId,
+      project_id: +params.projectId,
+      start: dayjs().toISOString(),
+      duration: -1 * dayjs().unix(),
+      created_with: 'My app',
+      at: dayjs().toISOString()
+    }
+  )
+  //   console.log(timeEntry)
+  return timeEntry
+}
+
+main()

package/standalone/stopCurrentTimeEntry.js

@@ -0,0 +1,21 @@
+import togglClient from 'toggl-client'
+import dayjs from 'dayjs'
+import duration from 'dayjs/plugin/duration.js'
+import relativeTime from 'dayjs/plugin/relativeTime.js'
+import dotenv from 'dotenv'
+dayjs.extend(relativeTime)
+dayjs.extend(duration)
+dotenv.config()
+
+const client = togglClient()
+
+async function main () {
+  const currentTimeEntry = await client.timeEntries.current()
+  // TODO check if there is actually something to stop
+  const stopped = await client.timeEntries.stop(currentTimeEntry.id)
+
+  const duration = dayjs.duration({ seconds: stopped.duration }).humanize()
+  console.log(`Stopped ${stopped.description} after ${duration}`)
+}
+
+main()

package/standalone/todayReport.js

@@ -0,0 +1,101 @@
+import togglClient from 'toggl-client'
+import dayjs from 'dayjs'
+import duration from 'dayjs/plugin/duration.js'
+import relativeTime from 'dayjs/plugin/relativeTime.js'
+import dotenv from 'dotenv'
+dayjs.extend(relativeTime)
+dayjs.extend(duration)
+dotenv.config()
+
+const client = togglClient()
+
+async function getWorkspace () {
+  const workspaces = await client.workspaces.list()
+  return workspaces[0]
+}
+
+async function main () {
+  const workspace = await getWorkspace()
+  const params = { start_date: dayjs().startOf('day').toISOString() }
+
+  const timeEntries = await client.timeEntries.list(params)
+
+  // [
+  //     {
+  //       id: 2463026053,
+  //       guid: 'dba205a234d78492f3f7510c0c00b790',
+  //       wid: 403916,
+  //       pid: 174558624,
+  //       billable: false,
+  //       start: '2022-04-22T17:38:27+00:00',
+  //       stop: '2022-04-22T18:07:50+00:00',
+  //       duration: 1763,
+  //       description: 'recommendations',
+  //       duronly: false,
+  //       at: '2022-04-22T18:07:51+00:00',
+  //       uid: 530321
+  //     },
+  //     {
+  //       id: 2463068736,
+  //       guid: 'e9a444f99da3a09de1f16d242546e18e',
+  //       wid: 403916,
+  //       pid: 174558624,
+  //       billable: false,
+  //       start: '2022-04-22T18:16:01+00:00',
+  //       stop: '2022-04-22T18:33:44+00:00',
+  //       duration: 1063,
+  //       description: 'profile updates',
+  //       duronly: false,
+  //       at: '2022-04-22T18:33:44+00:00',
+  //       uid: 530321
+  //     }
+  //   ]
+
+  console.log(timeEntries)
+  let projects = []
+  timeEntries.map(e => {
+    console.log(`${e.start} ${e.description}  ${e.duration}`)
+    // find unique projects
+    projects.push(e.pid)
+    // filter for each project
+    // reduce() or _.groupBy() or groupBy()
+    // sum duration
+    // 2022-04-22T18:53:24+00:00 Time tracking - cli  52
+    // 2022-04-22T18:54:15+00:00 Time tracking - cli  225
+    // 2022-04-22T18:58:00+00:00 MCP All Hands  3191
+    // 2022-04-22T19:56:37+00:00 Time tracking - cli  303
+    // 2022-04-22T20:01:39+00:00 Time tracking - cli  -1650657699
+  })
+  projects = [...new Set(projects)]
+
+  const foo = []
+  projects.map(p => {
+    let total = 0
+    timeEntries.filter(x => x.pid == p).map(e => {
+      if (e.duration >= 0) {
+        total += e.duration // UNLESS e.duration is less than zero - meaning currently running
+      } else {
+        const startTime = dayjs.unix(e.duration * -1)
+        console.log(`computed ${startTime}`)
+        console.log(`timeentry.start ${e.start}`)
+        const duration = dayjs().diff(startTime, 's')
+        total += duration
+      }
+    })
+    foo.push({ [p]: total })
+  })
+  console.log(foo)
+
+  console.log(timeEntries[0])
+  console.log(timeEntries[timeEntries.length - 1])
+
+  // ! Not supported in Node
+  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/groupBy
+  // let result = timeEntries.groupBy( ({ pid }) => pid );
+  // console.log(result);
+
+  // displayReportText(weeklyReport.data);
+  // displayReportJson(weeklyReport.data);
+}
+
+main()

package/standalone/weeklyReport.js

@@ -0,0 +1,57 @@
+import togglClient from 'toggl-client'
+import dayjs from 'dayjs'
+import duration from 'dayjs/plugin/duration.js'
+import relativeTime from 'dayjs/plugin/relativeTime.js'
+
+import dotenv from 'dotenv'
+dayjs.extend(relativeTime)
+dayjs.extend(duration)
+
+const client = togglClient()
+dotenv.config()
+async function getWorkspace () {
+  const workspaces = await client.workspaces.list()
+  return workspaces[0]
+}
+
+async function main () {
+  const workspace = await getWorkspace()
+  const params = { since: dayjs().startOf('week').toISOString() }
+  const weeklyReport = await client.reports.weekly(workspace.id, params)
+  displayReportText(weeklyReport.data)
+  // displayReportJson(weeklyReport.data);
+}
+
+main()
+
+function displayReportJson (data) {
+  const json = []
+  data.map(project => {
+    const startOfWeek = dayjs().startOf('week')
+    project.totals.slice(0, 7).map((total, i) => {
+      const duration = dayjs.duration(total, 'milliseconds').format('H[h] m[m]')
+      const day = startOfWeek.add(i, 'days').format('YYYY-MM-DD')
+      // i == 7 ? console.info(`\tTotal : ${duration}`) : console.info(`\t ${day} - ${duration}`);
+      // TODO revise this format - maybe nested
+      const entry = {
+        project: project.title.project,
+        date: day,
+        duration
+      }
+      json.push(entry)
+    })
+  })
+  console.log(JSON.stringify(json))
+}
+
+function displayReportText (data) {
+  data.map(project => {
+    console.info(project.title.project)
+    const startOfWeek = dayjs().startOf('week')
+    project.totals.map((total, i) => {
+      const duration = dayjs.duration(total, 'milliseconds').format('H[h] m[m]')
+      const day = startOfWeek.add(i, 'days').format('ddd MMM D')
+      i == 7 ? console.info(`\tTotal : ${duration}`) : console.info(`\t ${day} - ${duration}`)
+    })
+  })
+}