@beauraines/toggl-cli 0.10.5

package/.eslintrc.json

@@ -0,0 +1,16 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": "standard",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.10.5](https://github.com/beauraines/toggl-cli-node/compare/v0.10.4...v0.10.5) (2023-03-04)
+
+
+### Bug Fixes
+
+* makes weekly report work in v9 API ([#42](https://github.com/beauraines/toggl-cli-node/issues/42)) ([5de62c8](https://github.com/beauraines/toggl-cli-node/commit/5de62c833bb05840efadd3065ca60ce4c1bb6d1b))
+
+### [0.10.4](https://github.com/beauraines/toggl-cli-node/compare/v0.10.3...v0.10.4) (2023-03-02)
+
+
+### Bug Fixes
+
+* Cannot edit time entries ([ec6611a](https://github.com/beauraines/toggl-cli-node/commit/ec6611aee147ff0355af664ee7bf05aa6b2c4f38)), closes [#40](https://github.com/beauraines/toggl-cli-node/issues/40)
+
+### [0.10.3](https://github.com/beauraines/toggl-cli-node/compare/v0.10.2...v0.10.3) (2023-03-02)
+
+
+### Bug Fixes
+
+* converts project id, workspace id to number ([8cefe8c](https://github.com/beauraines/toggl-cli-node/commit/8cefe8cce9d8aa7651171e3a35d69ee9ba278950)), closes [#38](https://github.com/beauraines/toggl-cli-node/issues/38)
+
+### 0.10.2 (2023-02-28)
+
+
+### Features
+
+* adds Me command ([#1](https://github.com/beauraines/toggl-cli-node/issues/1)) ([6e656e8](https://github.com/beauraines/toggl-cli-node/commit/6e656e8468f181f43f27880372d18ae67e7e677f))
+
+### 0.10.1 (2023-02-28)
+
+
+### Features
+
+* adds Me command ([#1](https://github.com/beauraines/toggl-cli-node/issues/1)) ([6e656e8](https://github.com/beauraines/toggl-cli-node/commit/6e656e8468f181f43f27880372d18ae67e7e677f))

package/README.md

@@ -0,0 +1,85 @@
+# toggl-cli-node
+
+**UPDATED TO USE Toggl v9 API**
+
+A command line interface for [toggl](https://toggl.com) written in node, based on the python [TogglCli](https://github.com/AuHau/toggl-cli) project. Attempting to use similar syntax.
+
+This was made possible because [saintedlama](https://github.com/saintedlama) had already built a node API for toggl.
+
+## Configuration
+
+1. Configure your environment, with environment variables or a `.env` file in the project root. Eventually, these will be read from a config file as an alternative
+1. `TOGGL_API_TOKEN` (required)
+2. `TOGGL_DEFAULT_WORKSPACE_ID` (required)
+3. `TOGGL_DEFAULT_PROJECT_ID` (optional)
+4. `TOGGL_TIMEZONE=America/Los_Angeles` (defaults to `America/New_York`)
+## Dependencies
+
+1. toggl-client - Used from [saintedlama/toggl-client](https://github.com/saintedlama/toggl-client) repository as the latest code hasn't been released to npm
+3. dotenv
+4. yargs
+
+
+
+## Features
+
+| Feature                              | Available | Comments                                                    |
+| ------------------------------------ | --------- | ----------------------------------------------------------- |
+| Start time entry                     | ✅         |                                                             |
+| Start time entry with description    | ✅         |                                                             |
+| Start time entry with project        | ✅         |                                                             |
+| stop time entry                      | ✅         |                                                             |
+| Continue named time entry            | ✅         |                                                             |
+| Report today by project              | ✅         |                                                             |
+| Report this week by project by day   | ✅         |                                                             |
+| Edit time entry                      | ✅         |                                                             |
+| Use config from file                 |           |                                                             |
+| Save config to file                  |           |                                                             |
+| Refactor: Display and format modules |           |                                                             |
+| Client: reset PAT                    |           |                                                             |
+| Client: other user feature?          |           |                                                             |
+| Client: specify client name          |           |                                                             |
+| Colorize output                      |           |                                                             |
+| Better table output                  |           |                                                             |
+| List recent time entries             | ✅         |                                                             |
+| Command line completion              | ✅         | [#6](https://github.com/beauraines/toggl-cli-node/issues/6) |
+
+## Development Road Map
+
+Priority order... I think.
+
+1. ~today - improve the output~
+2. ~weekly - improve the output format~
+3. ~now - format the display time entry output~
+4. ~toggl continue~
+5. ~duration to display helper function?~
+6. read configuration (token, default workspace) from files (client and utils)
+7. now - update running description, project, start time
+8. now - update start time with overlap detection and adjust prior time entry
+9. project list - format the output, group by client
+10. Add ability to lookup project by name not just id
+11. start - add project name to output, add time started
+12. toggl workspace add - this command is not yet supported.
+13. toggl workspace list - improve output 
+14. colorized output
+15. config - some way to save /me information to a file
+    1.  default workspace?
+    2.  API key?
+    3.  display formats?
+16. toggl project add - this command is not yet supported.
+
+
+
+## Planned Limitations
+
+There are several features that I do not use from Toggl, so including them is a priority for me. I'm not opposed to them being in there and would welcome collaboration to include them.
+
+1. tags
+2. multiple workspaces
+3. billable
+
+## How to Contribute
+
+I need to clean up and refactor the code and establish a few more helper and utility functions, but I'm open to contributions!
+
+

package/cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { commands } from './cmds/index.mjs'
+
+yargs(hideBin(process.argv))
+  .scriptName('toggl')
+  .command(commands)
+  .completion('completion', 'Outputs bash/zsh-completion shortcuts for commands and options to add to .bashrc or .bash_profile')
+  .demandCommand()
+  .help()
+  .parse()

package/client.js

@@ -0,0 +1,29 @@
+import dotenv from 'dotenv'
+import togglClient from 'toggl-client'
+dotenv.config()
+
+export default function () {
+  if (!process.env.TOGGL_API_TOKEN) {
+    console.log('TOGGL_API_TOKEN environment variable is not set.')
+    console.log('For development, it can be set in the .env file in the project root')
+  }
+
+  // TODO Try to read rc file
+
+  // FIXME apiToken is not needed
+  const apiToken = process.env.TOGGL_API_TOKEN
+  const client = togglClient()
+  // const client = togglClient({ apiToken });
+  // ? Why doesn't a try/catch block work?
+  // try {
+  //     const client = togglClient({ apiToken });
+  // } catch (error) {
+  //    console.error(error);
+  // }
+  if (!client) {
+    console.error('There was a problem')
+    process.exit(1)
+  }
+
+  return client
+}

package/cmds/continue.mjs

@@ -0,0 +1,55 @@
+import Client from '../client.js'
+import { createTimeEntry, getProjectById } from '../utils.js'
+import dayjs from 'dayjs'
+
+export const command = 'continue [description]'
+
+export const desc = 'Continues an existing time entry. If description is included it will search for the most' +
+    'recent entry including that description. If no description is provided, the most recent entry will be restarted.'
+
+export const builder = {
+  description: {
+    describe: 'The time entry to continue',
+    type: 'string'
+  }
+  //   -s, --start DATETIME  Sets a start time.
+}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const timeEntries = await client.timeEntries.list(
+    {
+      start_date: dayjs().subtract(14, 'days').toISOString(),
+      end_date: dayjs().toISOString()
+    }
+  ) // Gets time entries for last 14 days, up to 1000 entries
+
+  timeEntries.sort((a, b) => dayjs(a.start).toDate() - dayjs(b.start).toDate())
+
+  let matchingTimeEntry
+  switch (argv.description) {
+    case undefined:
+      matchingTimeEntry = timeEntries.slice(-1)[0]
+      break
+    default:
+      { const searchName = argv.description.toLowerCase()
+        matchingTimeEntry = timeEntries.find(x => x.description.toLowerCase().includes(searchName)) }
+      break
+  }
+
+  const params = {
+    projectId: matchingTimeEntry?.pid,
+    workspaceId: matchingTimeEntry?.wid,
+    description: matchingTimeEntry?.description || 'no description',
+    billable: matchingTimeEntry?.billable,
+    dur: matchingTimeEntry?.dur
+  }
+
+  if (matchingTimeEntry) {
+    const timeEntry = await createTimeEntry(params)
+    const project = await getProjectById(timeEntry.wid, timeEntry.pid)
+    console.info(`Continued ${timeEntry?.description} for project ${project?.name}`)
+  } else {
+    console.info('No matching time entry found!')
+  }
+}

package/cmds/currentTimeEntry.mjs

@@ -0,0 +1,16 @@
+import Client from '../client.js'
+import { displayTimeEntry } from '../utils.js'
+
+export const command = 'now'
+export const desc = 'Displays the current running time entry'
+export const builder = {}
+
+export const handler = async function (argv) {
+  const client = new Client()
+  const currentTimeEntry = await client.timeEntries.current()
+  if (currentTimeEntry) {
+    await displayTimeEntry(currentTimeEntry)
+  } else {
+    console.log('There is no time entry running!')
+  }
+}

package/cmds/edit.mjs

@@ -0,0 +1,84 @@
+import Client from '../client.js'
+import { defaultWorkspaceId, getProjectByName, getProjectById, appName, displayTimeEntry } from '../utils.js'
+import dayjs from 'dayjs'
+import utc from 'dayjs/plugin/utc.js'
+import timezone from 'dayjs/plugin/timezone.js'
+import yargs from 'yargs'
+dayjs.extend(utc)
+dayjs.extend(timezone)
+
+export const command = 'edit'
+// FIXME editing not working
+export const desc = 'SOMETHING IS NOT RIGHT Edits the current running time entry'
+
+export const builder = {
+  d: { alias: ['description'], describe: 'Time entry name', type: 'string:' },
+  p: { alias: ['projectId', 'project'], describe: 'The case insensitive project name or project id.', type: 'string', demandOption: false },
+  s: { alias: ['start', 'startTime'], describe: 'The case insensitive project name or project id.', type: 'string', demandOption: false },
+  e: { alias: ['end', 'endTime'], describe: 'The case insensitive project name or project id.', type: 'string', demandOption: false }
+}
+
+export const handler = async function (argv) {
+  if (!(argv.d || argv.p || argv.s || argv.e)) {
+    console.error('At least one option must be provided, description, project, start or end')
+    yargs().help()
+    yargs().exit(1, new Error('At least one option must be provided, description, project, start or end'))
+  }
+  const client = new Client()
+  const currentTimeEntry = await client.timeEntries.current()
+
+  const params = {}
+
+  params.workspace_id = +defaultWorkspaceId
+  let project
+  if (argv.projectId) {
+    if (isNaN(argv.projectId)) {
+      project = await getProjectByName(params.workspace_id, argv.projectId)
+    } else {
+      project = await getProjectById(params.workspace_id, argv.projectId)
+    }
+  }
+
+  let startTime, endTime
+  if (dayjs(argv.startTime).isValid()) {
+    startTime = argv.startTime
+  } else {
+    // Parse the time and set it based upon the current time
+    startTime = parseTime(argv.startTime)
+  }
+
+  if (dayjs(argv.endTime).isValid()) {
+    endTime = argv.endTime
+  } else {
+    // Parse the time and set it based upon the current time
+    endTime = parseTime(argv.endTime)
+  }
+
+  params.created_with = appName
+  params.at = dayjs().toISOString()
+  project ? params.project_id = +project.id : undefined
+  startTime ? params.start = startTime.toISOString() : undefined
+  endTime ? params.stop = endTime.toISOString() : undefined
+  endTime ? params.duration = endTime.diff(startTime, 'seconds') : undefined
+  argv.description ? params.description = argv.description : undefined
+  const timeEntry = await client.timeEntries.update(currentTimeEntry.id, params)
+  await displayTimeEntry(timeEntry)
+}
+
+/**
+ * Parses a timelike string into a dayjs object of the current date and that time
+ * @param {string} timeString timelike string e.g. 4:50PM '12:00 AM' etc.
+ * @returns {object} dayjs object
+ */
+function parseTime (timeString) {
+  let h, m
+  // Assumes time in format 4:50 PM
+  const time = timeString.split(':', 2)
+  h = time[0]
+  m = time[1].match(/[0-9]+/)[0]
+  if (timeString.match(/PM/i) && h <= 12) {
+    // + in front of string converts to a number, cool!
+    h = +h + 12
+  }
+  return dayjs().hour(h).minute(m).second(0)
+}

package/cmds/index.mjs

@@ -0,0 +1,26 @@
+import * as ls from './ls.mjs'
+import * as me from './me.mjs'
+import * as continueEntry from './continue.mjs'
+import * as current from './currentTimeEntry.mjs'
+import * as workspace from './workspace.mjs'
+import * as projects from './projects.mjs'
+import * as edit from './edit.mjs'
+import * as web from './web.mjs'
+import * as startTimeEntry from './startTimeEntry.mjs'
+import * as stopTimeEntry from './stopTimeEntry.mjs'
+import * as today from './today.mjs'
+import * as weekly from './weekly.mjs'
+export const commands = [
+  continueEntry,
+  current,
+  edit,
+  ls,
+  me,
+  projects,
+  startTimeEntry,
+  stopTimeEntry,
+  today,
+  web,
+  weekly,
+  workspace
+]

package/cmds/ls.mjs

@@ -0,0 +1,30 @@
+import Client from '../client.js'
+import { convertUtcTime, formatDuration } from '../utils.js'
+import dayjs from 'dayjs'
+
+export const command = 'ls'
+export const desc = 'Lists time entries'
+
+export const builder = {
+
+}
+
+export const handler = async function (argv) {
+  const client = Client()
+  // TODO update these dates
+  const timeEntries = await client.timeEntries.list({start_date:dayjs().subtract(14,'days').toISOString(),end_date:dayjs().toISOString()});
+
+  const report = []
+  timeEntries.forEach(element => {
+    report.push(
+      {
+        description: element.description,
+        start: convertUtcTime(element.start),
+        stop: convertUtcTime(element.stop),
+        duration: formatDuration(element.duration * 1000)
+      }
+    )
+  })
+
+  console.table(report, ['description', 'start', 'stop', 'duration'])
+}

package/cmds/ls.test.js

@@ -0,0 +1,6 @@
+describe('ls command',() => {
+    it.todo('should get tasks for the last 14 days')
+    // get time entries
+    // sort them
+    // check that the earliest is within 14 days
+})

package/cmds/me.mjs

@@ -0,0 +1,44 @@
+import dayjs from 'dayjs'
+import Client from '../client.js'
+
+export const command = 'me'
+export const desc = 'Displays the current user'
+export const builder = {}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const currentUser = await client.user.current()
+  // console.log(currentUser);
+
+  console.log(`Default workspace: ${currentUser.default_workspace_id}`)
+  console.log(`API Token: ${currentUser.api_token}`)
+  console.log(`Fullname: ${currentUser.fullname}`)
+  console.log(`Timezone: ${currentUser.timezone}`)
+  // TODO These look like they come from the `/preferences` endpoint
+  // console.log(`Date format: ${currentUser.date_format}`);
+  // console.log(`jquery date format: ${currentUser.jquery_date_format}`);
+  // console.log(`jquery_timeofday_format: ${currentUser.jquery_timeofday_format}`);
+
+  const weekStart = dayjs().day(currentUser.beginning_of_week).format('dddd')
+  console.log(`beginning_of_week: ${weekStart}`)
+
+  // Api token:
+  // Beginning of week: Sunday
+  // Date format: MM/DD/YYYY
+  // Default workspace: beau.raines's workspace (#403916)
+  // Fullname: Beau Raines
+  // Image url: https://assets.track.toggl.com/avatars/913dfa76c01d730711eb00a1c3e6d57c.jpg
+  // Language: en_US
+  // Send timer notifications: True
+  // Timeofday format: 12-hour
+  // Timezone: America/Los_Angeles
+  // Workspace: beau.raines's workspace (#403916)
+
+  const workspaces = (await client.workspaces.list()).map(w => w.name).join(', ')
+  console.log('')
+  console.log(`Workspaces: ${workspaces}`)
+  // FIXME since is no longer in the response
+  const since = dayjs.unix(currentUser.since)
+  console.log('')
+  console.log(`Toggl user since ${since}`)
+}

package/cmds/projects/add.mjs

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

package/cmds/projects/index.mjs

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

package/cmds/projects/list.mjs

@@ -0,0 +1,25 @@
+import Client from '../../client.js'
+
+export const command = 'list'
+export const desc = 'Lists active projects from the current workspace'
+
+export const builder = {
+
+}
+
+export const handler = async function (argv) {
+  const client = Client()
+  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) })
+
+}

package/cmds/projects.mjs

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

package/cmds/startTimeEntry.mjs

@@ -0,0 +1,38 @@
+import { defaultWorkspaceId,getProjectByName, createTimeEntry, getProjectById, defaultProjectId } from '../utils.js'
+
+export const command = 'start'
+export const desc = 'Starts a time entry'
+
+export const builder = {
+  description: {
+    describe: 'Time entry name',
+    type: 'string:'
+  },
+  p: { alias: ['projectId', 'project'], describe: 'The case insensitive project name or project id.', type: 'string', demandOption: false },
+  // TODO default to default workspace
+  w: { alias: ['workspaceId', 'workspace'], describe: 'The case insensitive workspace name or workspace id.', type: 'number', demandOption: false }
+}
+
+export const handler = async function (argv) {
+  // console.info(`${argv.$0} ${argv._.join(' ')} - this command is not yet supported.`);
+  // console.debug(argv);
+  // TODO validate options
+  // TODO check that description was provided or provide a default
+  const params = {}
+  params.description = argv.description || argv._.slice(1).join(' ') || 'no description'
+  // TODO lookup workspace
+  params.workspaceId = defaultWorkspaceId
+  let project
+  if (argv.projectId) {
+    if (isNaN(argv.projectId)) {
+      project = await getProjectByName(params.workspaceId, argv.projectId)
+    } else {
+      project = await getProjectById(params.workspaceId, argv.projectId)
+    }
+  }
+
+  params.projectId = project?.id || defaultProjectId || null
+  // TODO check for invalid projectId or catch the error when creating fails
+  const timeEntry = await createTimeEntry(params)
+  console.info(`Started ${timeEntry?.description} ${project?.name ? `for project ${project.name}` : 'without a project'}`)
+}

package/cmds/stopTimeEntry.mjs

@@ -0,0 +1,18 @@
+import Client from '../client.js'
+import dayjs from 'dayjs'
+
+export const command = 'stop'
+export const desc = 'Stops the current running time entry'
+export const builder = {}
+
+export const handler = async function (argv) {
+  const client = Client()
+  const currentTimeEntry = await client.timeEntries.current()
+  if (currentTimeEntry) {
+    const stopped = await client.timeEntries.stop(currentTimeEntry)
+    const duration = dayjs.duration(stopped.duration * 1000).format('H[h] m[m]')
+    console.log(`Stopped ${stopped.description} after ${duration}`)
+  } else {
+    console.log('There is no time entry running!')
+  }
+}