Database

.gitignore

@@ -162,7 +162,136 @@ cython_debug/
 /data
 
 # javascript
-node_modules
-.cache*
 gen
 xpi
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

TODO.md

@@ -1,19 +1,27 @@
 # DB Schema
 
 - graph
-  - source
-  - type
-  - target
-  - data_source
-  - id
+  - id INTEGER PRIMARY KEY AUTOINCREMENT
+  - source TEXT
+  - type TEXT
+  - target TEXT
+  - data_source TEXT
+
 - items
-  - itemID
-  - updated_datetime
+  - itemID INTEGER PRIMARY KEY
+  - updated_datetime DATETIME
+
 - authors
-  - creatorID
-  - ORCID
-  - name
-- author-item link table
+  - creatorID INTEGER PRIMARY KEY
+  - ORCID TEXT
+  - name TEXT
+
+- author_item_link
+  - creatorID INTEGER
+  - itemID INTEGER
+  - FOREIGN KEY(creatorID) REFERENCES authors(creatorID)
+  - FOREIGN KEY(itemID) REFERENCES items(itemID)
+  - PRIMARY KEY (creatorID, itemID)
 
 # TODOs
 

docs/plugin/dev.md

@@ -2,12 +2,21 @@
 
 Following: https://www.zotero.org/support/dev/client_coding/plugin_development
 
-- set the location of the plugin in the `reference-network@example.com` file to `{repo}/build/`
+- set the location of the plugin in the `weaver@example.com` file to `{repo}/build/`
 - (do the rest of the stuff in the above guide)
 - watch and rebuild the plugin with `npm run start`
 - you have to restart zotero between each change i think
 
+To run zotero with the plugin in debug mode, run the following command:
+
+```sh
+./zotero -purgecaches -zoteroDebugText
+```
 
 Weird things:
-- the build step was generating the extension id as `reference-network@gmail.com` because [`zotero-plugin/rdf` just does that for some reason](https://github.com/retorquere/zotero-plugin/blob/ab40ae4ba59d2b6a3fcce3222d415d9b5d72b14b/rdf.ts#L16)
+- the build step was generating the extension id as `weaver@gmail.com` because [`zotero-plugin/rdf` just does that for some reason](https://github.com/retorquere/zotero-plugin/blob/ab40ae4ba59d2b6a3fcce3222d415d9b5d72b14b/rdf.ts#L16)
   so the extension ID has to be updated in both the `package.json` file as well as the actual `manifest.json` file
+
+
+Official API Documentation:
+https://www.zotero.org/support/dev/client_coding/javascript_api

esbuild.js

@@ -1,77 +1,144 @@
-const path = require('path')
-const fs = require('fs')
-const esbuild = require('esbuild')
-const rmrf = require('rimraf')
-rmrf.sync('gen')
-
-require('zotero-plugin/copy-assets')
-require('zotero-plugin/rdf')
-require('zotero-plugin/version')
-
-function js(src) {
-  return src.replace(/[.]ts$/, '.js')
+const path = require("path");
+const fs = require("fs");
+const esbuild = require("esbuild");
+const rmrf = require("rimraf");
+
+// Clear the 'gen' directory synchronously
+rmrf.sync("gen");
+
+// Load Zotero plugin tasks
+require("zotero-plugin/copy-assets");
+require("zotero-plugin/rdf");
+require("zotero-plugin/version");
+
+// Helper function to replace TypeScript file extension with JavaScript
+function replaceExtToJs(src) {
+  return src.replace(/[.]ts$/, ".js");
+}
+
+async function copyFile(source, destination) {
+  await fs.promises.mkdir(path.dirname(destination), { recursive: true });
+  await fs.promises.copyFile(source, destination);
+}
+
+async function copyDirectory(source, destination) {
+  // Ensure the destination directory exists
+  await fs.promises.mkdir(destination, { recursive: true });
+
+  // Read all items in the source directory
+  const items = await fs.promises.readdir(source, { withFileTypes: true });
+
+  // Iterate through each item in the source directory
+  for (const item of items) {
+    const sourcePath = path.join(source, item.name);
+    const destinationPath = path.join(destination, item.name);
+
+    if (item.isDirectory()) {
+      // If it's a directory, recursively copy it
+      await copyDirectory(sourcePath, destinationPath);
+    } else {
+      // If it's a file, copy the file
+      await copyFile(sourcePath, destinationPath);
+    }
+  }
 }
 
+// Bundles the files with the provided configuration
 async function bundle(config) {
+  // Default configuration enhanced with custom settings
   config = {
     bundle: true,
-    format: 'iife',
-    target: ['firefox60'],
+    format: "iife",
+    target: ["firefox60"],
     inject: [],
     treeShaking: true,
     keepNames: true,
     ...config,
-  }
+  };
 
-  let target
-  if (config.outfile) {
-    target = config.outfile
+  let target = determineTarget(config);
+
+  const exportGlobals = config.exportGlobals;
+  delete config.exportGlobals;
+
+  if (exportGlobals) {
+    await handleExportGlobals(config);
   }
-  else if (config.entryPoints.length === 1 && config.outdir) {
-    target = path.join(config.outdir, js(path.basename(config.entryPoints[0])))
+
+  console.log("* bundling", target);
+  await esbuild.build(config);
+
+  if (exportGlobals) {
+    await rewriteGlobals(target, config);
   }
-  else {
-    target = `${config.outdir} [${config.entryPoints.map(js).join(', ')}]`
+}
+
+// Determine the target file or directory for output
+function determineTarget(config) {
+  if (config.outfile) {
+    return config.outfile;
+  } else if (config.entryPoints.length === 1 && config.outdir) {
+    return path.join(
+      config.outdir,
+      replaceExtToJs(path.basename(config.entryPoints[0]))
+    );
+  } else {
+    return `${config.outdir} [${config.entryPoints
+      .map(replaceExtToJs)
+      .join(", ")}]`;
   }
+}
 
-  const exportGlobals = config.exportGlobals
-  delete config.exportGlobals
-  if (exportGlobals) {
-    const esm = await esbuild.build({ ...config, logLevel: 'silent', format: 'esm', metafile: true, write: false })
-    if (Object.values(esm.metafile.outputs).length !== 1) throw new Error('exportGlobals not supported for multiple outputs')
-    for (const output of Object.values(esm.metafile.outputs)) {
-      if (output.entryPoint) {
-        config.globalName = escape(`{ ${output.exports.sort().join(', ')} }`).replace(/%/g, '$')
-        // make these var, not const, so they get hoisted and are available in the global scope.
-      }
+// Handle export of globals when required
+async function handleExportGlobals(config) {
+  const esm = await esbuild.build({
+    ...config,
+    logLevel: "silent",
+    format: "esm",
+    metafile: true,
+    write: false,
+  });
+  if (Object.values(esm.metafile.outputs).length !== 1) {
+    throw new Error("exportGlobals not supported for multiple outputs");
+  }
+  for (const output of Object.values(esm.metafile.outputs)) {
+    if (output.entryPoint) {
+      config.globalName = escape(
+        `{ ${output.exports.sort().join(", ")} }`
+      ).replace(/%/g, "$");
     }
   }
+}
 
-  console.log('* bundling', target)
-  await esbuild.build(config)
-  if (exportGlobals) {
-    await fs.promises.writeFile(
-      target,
-      (await fs.promises.readFile(target, 'utf-8')).replace(config.globalName, unescape(config.globalName.replace(/[$]/g, '%')))
-    )
-  }
+// Rewrite global variable names in the output files
+async function rewriteGlobals(target, config) {
+  const originalContent = await fs.promises.readFile(target, "utf-8");
+  const modifiedContent = originalContent.replace(
+    config.globalName,
+    unescape(config.globalName.replace(/[$]/g, "%"))
+  );
+  await fs.promises.writeFile(target, modifiedContent);
 }
 
+// Main build function
 async function build() {
   await bundle({
     exportGlobals: true,
-    entryPoints: [ 'src/reference_network/bootstrap.ts' ],
-    outdir: 'build',
-    banner: { js: 'var Zotero;\n' },
-  })
+    entryPoints: ["src/bootstrap.ts"],
+    outdir: "build",
+  });
 
   await bundle({
-    entryPoints: [ 'src/reference_network/lib.ts' ],
-    outdir: 'build',
-  })
+    entryPoints: ["src/weaver.ts", "src/prefs/prefs.ts"],
+    outdir: "build",
+  });
+
+  await copyFile("src/prefs/prefs.xhtml", "build/prefs/prefs.xhtml");
+  await copyDirectory("src/locale/", "build/locale/");
 }
 
-build().catch(err => {
-  console.log(err)
-  process.exit(1)
-})
+// Run build and handle any errors
+build().catch((err) => {
+  console.log(err);
+  process.exit(1);
+});