gitsheets 0.22.4 → 1.0.3

package/package.json

@@ -1,52 +1,58 @@
 {
   "name": "gitsheets",
-  "version": "0.22.4",
-  "description": "A toolkit for using a git repository to store low-volume, high-touch, human-scale data",
-  "main": "lib/GitSheets.js",
-  "scripts": {
-    "test": "jest"
+  "version": "1.0.3",
+  "description": "A git-backed document store for low-volume, high-touch, human-scale data",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
   },
   "bin": {
-    "git-sheet": "./bin/cli.js"
+    "gitsheets": "./bin/gitsheets",
+    "git-sheet": "./bin/gitsheets"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/JarvusInnovations/gitsheets.git"
+    "url": "git+https://github.com/JarvusInnovations/gitsheets.git"
   },
-  "author": "timwis <tim@timwis.com>",
-  "license": "Apache-2.0",
+  "homepage": "https://github.com/JarvusInnovations/gitsheets#readme",
   "bugs": {
     "url": "https://github.com/JarvusInnovations/gitsheets/issues"
   },
-  "homepage": "https://github.com/JarvusInnovations/gitsheets#readme",
+  "license": "Apache-2.0",
+  "author": "Jarvus Innovations",
   "dependencies": {
     "@iarna/toml": "^2.2.5",
-    "csv-parser": "^2.3.5",
-    "deepmerge": "^4.2.2",
-    "fast-csv": "^4.3.6",
-    "fast-json-patch": "^3.1.1",
-    "get-stream": "^5.2.0",
-    "hologit": "^0.41.8",
-    "http-assert": "^1.4.1",
-    "koa": "^2.13.1",
-    "koa-bodyparser": "^4.3.0",
-    "koa-router": "^7.4.0",
-    "maxstache": "^1.0.7",
-    "mz": "^2.7.0",
-    "rfc6902": "^5.0.1",
-    "sort-keys": "^4.2.0",
-    "streaming-json-stringify": "^3.1.0",
-    "tmp": "^0.2.1",
-    "to-readable-stream": "^2.1.0",
-    "winston": "^3.3.3",
-    "yargs": "^17.5.1"
+    "ajv": "^8.20.0",
+    "ajv-formats": "^3.0.1",
+    "hologit": "^0.49.1",
+    "sort-keys": "^6.0.0",
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
-    "common-tags": "^1.8.0",
-    "del": "^5.1.0",
-    "into-stream": "^5.1.1",
-    "jest": "^26.6.3",
-    "make-dir": "^3.1.0",
-    "supertest": "^4.0.2"
+    "@types/node": "^25.8.0",
+    "@types/yargs": "^17.0.35",
+    "tmp": "^0.2.5",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.6"
   }
 }

package/bin/cli.js

@@ -1,61 +0,0 @@
-#!/usr/bin/env node
-
-
-// setup logger
-const logger = require('winston');
-const loggerConsole = new logger.transports.Console({
-  level: process.env.DEBUG ? 'debug' : 'info',
-  format: logger.format.combine(
-    logger.format.colorize(),
-    logger.format.prettyPrint(),
-    logger.format.splat(),
-    logger.format.simple(),
-  ),
-
-  // all logger output to STDERR
-  stderrLevels: Object.keys(require('winston/lib/winston/config').cli.levels),
-});
-logger.add(loggerConsole);
-
-module.exports = { logger };
-
-
-// route command line
-require('yargs')
-  .version(require('../package.json').version)
-  .option('d', {
-    alias: 'debug',
-    type: 'boolean',
-    default: false,
-    global: true,
-  })
-  .option('q', {
-    alias: 'quiet',
-    type: 'boolean',
-    default: false,
-    global: true,
-  })
-  .check(function (argv) {
-    if (argv.debug) {
-      loggerConsole.level = 'debug';
-    } else if (argv.quiet) {
-      loggerConsole.level = 'error';
-    }
-
-    return true;
-  })
-  .commandDir('../commands', { exclude: /\.test\.js$/ })
-  .demandCommand()
-  .showHelpOnFail(false, 'Specify --help for available options')
-  .fail((msg, err) => {
-    logger.error(msg || err.message);
-
-    if (err) {
-      logger.debug(err.stack);
-    }
-
-    process.exit(1);
-  })
-  .strict()
-  .help()
-  .argv;

package/commands/edit.js

@@ -1,90 +0,0 @@
-exports.command = 'edit <record-path> [resume-path]';
-exports.desc = 'Edit a record, validating and formatting it automatically';
-exports.builder = {
-  'record-path': {
-    type: 'string',
-    describe: 'The path to a record file to edit',
-    demandOption: true,
-  },
-  'resume-path': {
-    type: 'string',
-    describe: 'If set, read initial editor content from this file instead of the target record',
-  },
-  encoding: {
-    type: 'string',
-    default: 'utf8',
-  },
-};
-
-exports.handler = async function edit({ recordPath, resumePath, encoding }) {
-  const fs = require('fs');
-  const { spawn } = require('child_process');
-  const path = require('path');
-  const tmp = require('tmp');
-  const TOML = require('@iarna/toml');
-  const Repository = require('../lib/Repository.js');
-  const Sheet = require('../lib/Sheet.js')
-  const repo = await Repository.getFromEnvironment({ working: true });
-  const git = await repo.getGit();
-
-  // open record
-  let recordToml = fs.readFileSync(resumePath || recordPath, encoding);
-
-  // try to parse and format
-  try {
-    const record = TOML.parse(recordToml);
-    recordToml = Sheet.stringifyRecord(record);
-  } catch (err) {
-    console.warn(`Failed to parse opened record:\n${err}`);
-  }
-
-  // get temp path
-  const { name: tempFilePath } = tmp.fileSync({
-    prefix: path.basename(recordPath, '.toml'),
-    postfix: '.toml',
-    discardDescriptor: true,
-  });
-
-  // populate temp path
-  fs.writeFileSync(tempFilePath, recordToml, encoding);
-
-  // get editor
-  const editor = (await git.var('GIT_EDITOR')) || 'vim';
-
-  // invoke editor
-  try {
-    const editorProcess = spawn('sh', ['-c', `eval ${editor} ${tempFilePath}`], { stdio: 'inherit' });
-    const exitCode = await new Promise(resolve => editorProcess.on('close', resolve));
-
-    if (exitCode !== 0) {
-      console.error(`editor exited with code ${exitCode}, canceling edit`);
-      fs.unlinkSync(tempFilePath);
-      process.exit(exitCode);
-    }
-  } catch (err) {
-    console.error(`Failed to invoke editor: ${err}`);
-  }
-
-  // read and clean up temp file
-  const editedToml = fs.readFileSync(tempFilePath, encoding);
-
-  // parse toml
-  let editedRecord;
-  try {
-    editedRecord = TOML.parse(editedToml);
-  } catch (err) {
-    console.error(`Failed to parse edited record:\n${err}`);
-    console.error(`To resume editing, run: git sheet edit ${recordPath} ${tempFilePath}`);
-    process.exit(1);
-  }
-
-  // delete temp file
-  fs.unlinkSync(tempFilePath);
-
-  // save normalized TOML to input path
-  fs.writeFileSync(recordPath, Sheet.stringifyRecord(editedRecord));
-  process.exit(0);
-};
-
-
-// library

package/commands/normalize.js

@@ -1,81 +0,0 @@
-exports.command = 'normalize [sheet...]';
-exports.desc = 'Normalize the content of any hand-edited records to be consistent';
-exports.builder = {
-  sheet: {
-    describe: 'Name of sheet to upsert into',
-    type: 'array',
-  },
-  root: {
-    describe: 'Root path to .gitsheets in repository (defaults to GITSHEETS_ROOT or /)',
-  },
-  prefix: {
-    describe: 'Path to prefix after root to all sheet paths (defaults to GITSHEETS_PREFIX or none)',
-  },
-};
-
-exports.handler = async function query({
-  sheet: selectedSheets,
-  root,
-  prefix,
-}) {
-  const logger = require('../lib/logger.js');
-  const Repository = require('../lib/Repository.js')
-  const path = require('path');
-  const fs = require('mz/fs');
-
-  const { GITSHEETS_ROOT, GITSHEETS_PREFIX } = process.env;
-
-  // apply dynamic defaults
-  if (!root) {
-    root = GITSHEETS_ROOT || '/';
-  }
-
-  if (!prefix) {
-    prefix = GITSHEETS_PREFIX || null;
-  }
-
-  // get repo interface
-  const repo = await Repository.getFromEnvironment({ working: true });
-  logger.debug('instantiated repository:', repo);
-
-
-  // get sheets
-  const sheets = await repo.openSheets({ root, dataTree: prefix });
-
-
-  // loop through selected, or all sheets
-  const sheetNames = selectedSheets || Object.keys(sheets);
-
-  for (const sheetName of sheetNames) {
-    const sheet = sheets[sheetName];
-
-    if (!sheet) {
-      throw new Error(`sheet ${sheetName} is not defined`);
-    }
-
-    // loop through all records and re-upsert
-    try {
-      for await (const record of sheet.query()) {
-        const originalPath = record[Symbol.for('gitsheets-path')];
-        logger.info(`rewriting ${path.join(root, prefix||'', sheetName, originalPath)}.toml`);
-        const { path: normalizedPath } = await sheet.upsert(record);
-
-        if (normalizedPath !== originalPath) {
-          logger.warn(`^- moved to ${path.join(root, prefix||'', sheetName, normalizedPath)}.toml`);
-        }
-      }
-    } catch (err) {
-      if (err.constructor.name == 'TomlError') {
-        logger.error(`failed to parse ${path.join(root, prefix||'', err.file)}\n${err.message}`);
-        process.exit(1);
-      }
-
-      throw err;
-    }
-  }
-
-
-  // write changes to workspace
-  const workspace = await repo.getWorkspace();
-  await workspace.writeWorkingChanges();
-};

package/commands/query.js

@@ -1,206 +0,0 @@
-exports.command = 'query <sheet>';
-exports.desc = 'Read records from a sheet';
-exports.builder = {
-  sheet: {
-    describe: 'Name of sheet to upsert into',
-  },
-  root: {
-    describe: 'Root path to .gitsheets in repository (defaults to GITSHEETS_ROOT or /)',
-  },
-  prefix: {
-    describe: 'Path to prefix after root to all sheet paths (defaults to GITSHEETS_PREFIX or none)',
-  },
-  format: {
-    describe: 'Format to serialize output data in (defaults to json)',
-    choices: ['json', 'csv', 'tsv', 'toml'],
-    default: 'json',
-  },
-  headers: {
-    describe: 'Whether to show headers in output formats that have headers (i.e. csv)',
-    type: 'boolean',
-    default: true,
-  },
-  // encoding: {
-  //   describe: 'Encoding to write output with',
-  //   default: 'utf8',
-  // },
-  limit: {
-    describe: 'Truncate results to given count',
-    type: 'number'
-  },
-  'filter': {
-    group: 'Filtering',
-    describe: 'Filter results by one or more field values',
-    type: 'array'
-  },
-  'filter.<field>[=<value>]': {
-    group: 'Filtering',
-    describe: 'Field to filter by'
-  },
-  fields: {
-    group: 'Field selection',
-    describe: 'List of fields to order/limit output columns with',
-    type: 'array'
-  },
-  'fields.<from>=<to>': {
-    group: 'Field selection',
-    describe: 'Field to remap',
-    type: 'array'
-  }
-};
-
-exports.handler = async function query({
-  sheet: sheetName,
-  root,
-  prefix,
-  format,
-  headers,
-  // encoding,
-  limit,
-  filter,
-  fields,
-}) {
-  const logger = require('../lib/logger.js');
-  const Repository = require('../lib/Repository.js')
-  const path = require('path');
-  const fs = require('mz/fs');
-
-  const { GITSHEETS_ROOT, GITSHEETS_PREFIX } = process.env;
-
-  // apply dynamic defaults
-  if (!root) {
-    root = GITSHEETS_ROOT || '/';
-  }
-
-  if (!prefix) {
-    prefix = GITSHEETS_PREFIX || null;
-  }
-
-  // get repo interface
-  const repo = await Repository.getFromEnvironment({ working: true });
-  logger.debug('instantiated repository:', repo);
-
-
-  // get sheet
-  const sheet = await repo.openSheet(sheetName, { root, dataTree: prefix });
-
-  if (!sheet) {
-    throw new Error(`sheet '${sheetName}' not found under ${root}/.gitsheets/`);
-  }
-
-  logger.debug('loaded sheet:', sheet);
-
-
-  // query records
-  let result = sheet.query(filter);
-
-
-  // apply limit
-  if (limit) {
-    result = limitResult(result, limit);
-  }
-
-
-  // apply field shaping
-  if (fields) {
-    result = mapResult(result, fields);
-  }
-
-
-  // output results
-  switch (format) {
-    case 'json': return outputJson(result);
-    case 'csv': return outputCsv(result, { headers });
-    case 'tsv': return outputCsv(result, { headers, delimiter: '\t' });
-    case 'toml': return outputToml(result);
-    default: throw new Error(`Unsupported output format: ${format}`);
-  }
-};
-
-
-// library
-async function* limitResult(result, limit) {
-  let count = 0;
-
-  for await (const record of result) {
-    count++;
-    yield record;
-
-    if (count >= limit) {
-      break;
-    }
-  }
-}
-
-async function* mapResult(result, fields) {
-  if (!Array.isArray(fields)) {
-    const fieldsObject = fields;
-    fields = [];
-    for (const fromKey in fieldsObject) {
-      const fieldMap = {};
-      fieldMap[fromKey] = fieldsObject[fromKey];
-      fields.push(fieldMap);
-    }
-  }
-
-  for await (const record of result) {
-    const output = {};
-
-    for (const field of fields) {
-      if (Array.isArray(field)) {
-        for (const fieldValue of field) {
-          output[fieldValue] = record[fieldValue];
-        }
-      } else if (typeof field == 'object') {
-        for (const from in field) {
-          output[field[from]] = record[from];
-        }
-      } else {
-        output[field] = record[field];
-      }
-    }
-
-    yield output;
-  }
-}
-
-async function outputJson(result) {
-  let firstRecord = true;
-
-  console.log('[');
-
-  for await (const record of result) {
-    if (firstRecord) {
-      console.log(`${JSON.stringify(record)}`);
-      firstRecord = false;
-    } else {
-      console.log(`,${JSON.stringify(record)}`);
-    }
-  }
-
-  console.log(']');
-}
-
-async function outputCsv(result, { headers = true, delimiter = ',' } = {}) {
-  const { Readable } = require('stream');
-  const { format: csvFormat } = require('fast-csv');
-  const csvStream = csvFormat({ headers, delimiter, includeEndRowDelimiter: true });
-
-  csvStream.pipe(process.stdout).on('end', () => process.exit());
-
-  Readable.from(result).pipe(csvStream);
-}
-
-async function outputToml(result) {
-  const TOML = require('@iarna/toml');
-  let firstRecord = true;
-
-  for await (const record of result) {
-    if (firstRecord) {
-      console.log(`${TOML.stringify(record)}`);
-      firstRecord = false;
-    } else {
-      console.log(`\0\n${TOML.stringify(record)}`);
-    }
-  }
-}

package/commands/read.js

@@ -1,64 +0,0 @@
-exports.command = 'read <record-path>';
-exports.desc = 'Read a record, converting to desired format';
-exports.builder = {
-  'record-path': {
-    type: 'string',
-    describe: 'The path to a record file to read',
-    demandOption: true,
-  },
-  encoding: {
-    type: 'string',
-    default: 'utf8',
-  },
-  format: {
-    describe: 'Format to serialize output data in (defaults to json)',
-    choices: ['json', 'csv', 'tsv', 'toml'],
-    default: 'json',
-  },
-  headers: {
-    describe: 'Whether to show headers in output formats that have headers (i.e. csv)',
-    type: 'boolean',
-    default: true,
-  },
-};
-
-exports.handler = async function edit({ recordPath, encoding, format, headers }) {
-  const fs = require('fs');
-  const TOML = require('@iarna/toml');
-
-  // open record
-  const recordToml = fs.readFileSync(recordPath, encoding);
-
-  // parse record
-  const record = TOML.parse(recordToml);
-
-  // output results
-  switch (format) {
-    case 'json': return outputJson(record);
-    case 'csv': return outputCsv(record, { headers });
-    case 'tsv': return outputCsv(record, { headers, delimiter: '\t' });
-    case 'toml': return outputToml(record);
-    default: throw new Error(`Unsupported output format: ${format}`);
-  }
-};
-
-
-// library
-async function outputJson(record) {
-  console.log(`${JSON.stringify(record)}`);
-}
-
-async function outputCsv(record, { headers = true, delimiter = ',' } = {}) {
-  const { format: csvFormat } = require('fast-csv');
-  const csvStream = csvFormat({ headers, delimiter, includeEndRowDelimiter: true });
-
-  csvStream.pipe(process.stdout).on('end', () => process.exit());
-
-  csvStream.write(record);
-  csvStream.end();
-}
-
-async function outputToml(record) {
-  const Sheet = require('../lib/Sheet.js')
-  console.log(`${Sheet.stringifyRecord(record)}`);
-}