@beauraines/toggl-cli 0.10.10 → 0.10.12

package/.env.foo

@@ -0,0 +1,3 @@
+TOGGL_API_TOKEN=1d0ef68975e582dae8d132190821e3a5
+TOGGL_DEFAULT_WORKSPACE_ID=403916
+TOGGL_TIMEZONE=America/Los_Angeles

package/.github/dependabot.yml

@@ -9,3 +9,8 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+      day: "friday"
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+      include: scope

package/.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [16.x,18.x]
 
     steps:
       - uses: actions/checkout@v3

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.12](https://github.com/beauraines/toggl-cli/compare/v0.10.11...v0.10.12) (2023-03-23)
+
+### [0.10.11](https://github.com/beauraines/toggl-cli/compare/v0.10.10...v0.10.11) (2023-03-19)
+
+
+### Features
+
+* improvements to the ls command ([#52](https://github.com/beauraines/toggl-cli/issues/52)) ([5c9effc](https://github.com/beauraines/toggl-cli/commit/5c9effc10f2c85435441d1cb3bdbb1e821df88b3))
+
 ### [0.10.10](https://github.com/beauraines/toggl-cli/compare/v0.10.9...v0.10.10) (2023-03-16)
 
 

package/cmds/continue.mjs

@@ -24,12 +24,13 @@ export const handler = async function (argv) {
     }
   ) // Gets time entries for last 14 days, up to 1000 entries
 
-  timeEntries.sort((a, b) => dayjs(a.start).toDate() - dayjs(b.start).toDate())
+  // Sort to guarantee its most recent to oldest)
+  timeEntries.sort((a, b) => dayjs(b.start).toDate() - dayjs(a.start).toDate())
 
   let matchingTimeEntry
   switch (argv.description) {
     case undefined:
-      matchingTimeEntry = timeEntries.slice(-1)[0]
+      matchingTimeEntry = timeEntries[0]
       break
     default:
       { const searchName = argv.description.toLowerCase()

package/cmds/ls.mjs

@@ -1,19 +1,32 @@
 import Client from '../client.js'
 import { convertUtcTime, formatDuration } from '../utils.js'
 import dayjs from 'dayjs'
+import debugClient from 'debug'
+import Table from 'cli-table3'
 
-export const command = 'ls'
-export const desc = 'Lists time entries'
+const debug = debugClient('toggl-cli-ls')
 
-export const builder = {
+export const command = 'ls [searchStrings...]'
+export const desc = 'Lists recent time entries. Defaults to the last 14 days.'
 
+export const builder = {
+  d: { alias: ['days'], describe: 'The number of days to return.', type: 'number', demandOption: false, default: 14 }
 }
 
 export const handler = async function (argv) {
+  debug(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 days = argv.days
+  let timeEntries = await client.timeEntries.list({
+    start_date: dayjs().subtract(days, 'days').startOf('day').toISOString(),
+    end_date: dayjs().toISOString()
+  })
+  timeEntries.sort((a, b) => (a.start > b.start) ? 1 : -1)
+  if (argv.searchStrings) {
+    const searchString = argv.searchStrings.join(' ')
+    debug(searchString)
+    timeEntries = timeEntries.filter(x => x.description.includes(searchString))
+  }
   const report = []
   timeEntries.forEach(element => {
     report.push(
@@ -26,5 +39,12 @@ export const handler = async function (argv) {
     )
   })
 
-  console.table(report, ['description', 'start', 'stop', 'duration'])
+  const table = new Table({
+    head: ['description', 'start', 'stop', 'duration']
+  })
+  for (const entry of report) {
+    table.push([entry.description, entry.start, entry.stop, entry.duration])
+  }
+  console.log(table.toString())
+  // console.table(report, ['description', 'start', 'stop', 'duration'])
 }

package/cmds/ls.test.js

@@ -1,6 +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
-})
+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/database.js

@@ -0,0 +1,70 @@
+const homedir = require('os').homedir();
+const sqlite = require('sqlite');
+const sqlite3 = require('sqlite3');
+const {fileExists} = require('./helpers');
+
+/**
+ * Opens the BurnDownStatus SQLite3 Database
+ * @param file file name of the SQLite3 DB. If not provided, defaults to ${homedir}/BurnDownStatus.db
+ * @returns SQLite database connection
+ */
+async function getDBConnection(file) {
+    file = file ? file : `${homedir}/BurnDownStatus.db`;
+    if (!await fileExists(file)){
+        console.error(`${file} not found`);
+        process.exit(1);
+    }
+    const db = await sqlite.open({
+        filename: `${homedir}/BurnDownStatus.db`,
+        driver: sqlite3.Database
+    });
+    return db;
+}
+
+/**
+ * 
+ * @param {Object} data The burndown data to be inserted into the Burndown database
+ * 
+ * @returns {Object} The result of the database running the provided query
+ */
+async function writeToDb(data) {
+    // TODO should take db, query and values as parameters
+    let db = await getDBConnection();
+    let query = `insert into qa_burndown (date, qa_review_count, qa_validated_count) values (?,?,?) on conflict do update set qa_review_count = excluded.qa_review_count, qa_validated_count = excluded.qa_validated_count`;
+
+    let values = [data.date, data.qa_review_count, data.qa_validated_count];
+    let result = await db.run(query, values);
+    await db.close();
+    return result;
+
+}
+
+
+async function insert(database,table,data) {
+    let db = await getDBConnection(database);
+
+    let fields = Object.keys(data[0]).toString();
+    let fieldsCount = Object.keys(data[0]).length;
+    let valueSubstitution = Array(fieldsCount).fill('?').toString();
+
+    //TODO figure out how to build upsert
+    // on conflict do update set qa_review_count = excluded.qa_review_count, qa_validated_count = excluded.qa_validated_count`;
+    let query = `insert into ${table}  (${fields}) values (${valueSubstitution});`
+    let result = []
+    data.forEach(async (row) => {
+        // TODO add try/catch for SQL error errno and code
+        // TODO switch to db.exec() for more meaningful response
+        let response = await db.run(query,Object.values(row));
+        result.push(response);
+    });
+    await db.close();
+    // TODO clean up result
+    return result;
+}
+
+
+module.exports = {
+    getDBConnection,
+    writeToDb,
+    insert
+}

package/helpers.js

@@ -0,0 +1,72 @@
+const fs = require('fs');
+
+/**
+ * Converts a string to Title Case, using whitespace as the delimiter
+ * @param {String} str String to convert
+ * @returns The string converted to title case
+ */
+function toTitleCase(str) {
+    return str.replace(
+      /\w\S*/g,
+      function(txt) {
+        return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase();
+      }
+    );
+}
+
+/**
+ * Removes newline characters \r and/or \n from a string
+ * @param {string} string to remove newlines from
+ * @returns string
+ */
+function stripNewLines(string) {
+  return string.replace(/\r|\n/g, '');
+}
+
+/**
+ * Checks to see if the specified file exists
+ * @param {string} filePath fully qualified path and filename 
+ * @returns Boolean
+ */
+async function fileExists(filePath) {
+    return fs.existsSync(filePath);
+}
+
+/**
+ * Asynchronously reads the entire file contents and returns it.
+ * @param {string} filePath fully qualified path and filename
+ * @returns any
+ */
+async function readFile(filePath) {
+  return fs.readFileSync(filePath,{ encoding: 'utf8', flag: 'r' });
+}
+
+/**
+ * Groups an array by specified properties and sums other specified properties
+ * 
+ * https://stackoverflow.com/questions/46794232/group-objects-by-multiple-properties-in-array-then-sum-up-their-values
+ * 
+ * @param {Array} arr Array of Objects to aggregate
+ * @param {Array} groupKeys keys to group by
+ * @param {Array} sumKeys keys of properties to sum by
+ * @returns Array of Objects
+ */
+ function groupAndSum(arr, groupKeys, sumKeys){
+  return Object.values(
+    arr.reduce((acc,curr)=>{
+      const group = groupKeys.map(k => curr[k]).join('-');
+      acc[group] = acc[group] || Object.fromEntries(
+         groupKeys.map(k => [k, curr[k]]).concat(sumKeys.map(k => [k, 0])));
+      sumKeys.forEach(k => acc[group][k] += curr[k]);
+      return acc;
+    }, {})
+  );
+}
+
+module.exports = {
+    groupAndSum,
+    toTitleCase,
+    fileExists,
+    stripNewLines,
+    readFile
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/toggl-cli",
-  "version": "0.10.10",
+  "version": "0.10.12",
   "description": "",
   "main": "cli.js",
   "bin": {

package/toggl.credentials

@@ -0,0 +1,5 @@
+{
+    "token": "1d0ef68975e582dae8d132190821e3a5",
+    "defaultWorkspaceId": "403916",
+    "timezone": "America/Los_Angeles"
+}