{"id":16570191,"url":"https://github.com/retorquere/zotero-sync","last_synced_at":"2025-03-21T11:33:45.479Z","repository":{"id":47490745,"uuid":"358541617","full_name":"retorquere/zotero-sync","owner":"retorquere","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-03T15:15:35.000Z","size":230,"stargazers_count":33,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-12T21:17:30.774Z","etag":null,"topics":["sync","zotero","zotero-sync"],"latest_commit_sha":null,"homepage":"https://retorque.re/zotero-sync/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/retorquere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-16T09:12:44.000Z","updated_at":"2024-09-11T12:16:07.000Z","dependencies_parsed_at":"2022-09-07T14:11:34.793Z","dependency_job_id":null,"html_url":"https://github.com/retorquere/zotero-sync","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retorquere%2Fzotero-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retorquere%2Fzotero-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retorquere%2Fzotero-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retorquere%2Fzotero-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/retorquere","download_url":"https://codeload.github.com/retorquere/zotero-sync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221815082,"owners_count":16885113,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sync","zotero","zotero-sync"],"created_at":"2024-10-11T21:17:57.897Z","updated_at":"2025-03-21T11:33:45.460Z","avatar_url":"https://github.com/retorquere.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zotero one-way sync\n\n* Get a Zotero API key [here](https://www.zotero.org/settings/keys/new) -- the key only needs read only access to what you want to have synced\n\n\n```\nimport { Sync } from '@retorquere/zotero-sync'\nimport { Store } from '@retorquere/zotero-sync/json-store'\n\n(async () =\u003e {\n  const zotero = new Sync\n\n  // will emit the following so you can track progress:\n  // emit(Sync.event.library, \u003clibrary object\u003e, n, total number of libraries). Called at the start of a library sync. Library name is empty for the main library, if there's a name, it's a group library\n  // emit(Sync.event.error, err)\n  // emit(Sync.event.item, \u003citem object\u003e, n, total number of items within library). Called when an item is added/updated\n  // emit(Sync.event.collection, \u003ccollection object\u003e, n, number of collections within library). Called when a collection is added/updated\n\n  for (const event of [ Sync.event.library, Sync.event.collection, Sync.event.item, Sync.event.error ]) {\n    zotero.on(event, (e =\u003e function() { console.log(e, [...arguments]) })(event))\n  }\n  await zotero.login(process.env.ZOTERO_API_KEY)\n  await zotero.sync(await (new Store).load('data'))\n})().catch(err =\u003e {\n  console.log(err)\n  process.exit(1)\n})\n```\n\nor\n\n```\nconst Sync = require('@retorquere/zotero-sync').Sync\nconst Store = require('@retorquere/zotero-sync/json-store').Store\n\n(async () =\u003e {\n  const zotero = new Sync;\n  for (const event of [Sync.event.library, Sync.event.collection, Sync.event.item, Sync.event.error]) {\n    zotero.on(event, (e =\u003e function () { console.log(e, [...arguments]); })(event));\n  }\n  await zotero.login(process.env.ZOTERO_API_KEY);\n  await zotero.sync(await (new Store).load('data'));\n})().catch(err =\u003e {\n    console.log(err);\n    process.exit(1);\n});\n```\n\nor (untested) local access\n\n```\nconst Sync = require('@retorquere/zotero-sync').Sync\nconst Store = require('@retorquere/zotero-sync/json-store').Store\n\n(async () =\u003e {\n  const zotero = new Sync;\n  for (const event of [Sync.event.library, Sync.event.collection, Sync.event.item, Sync.event.error]) {\n    zotero.on(event, (e =\u003e function () { console.log(e, [...arguments]); })(event));\n  }\n  zotero.local()\n  await zotero.sync(await (new Store).load('data'));\n})().catch(err =\u003e {\n    console.log(err);\n    process.exit(1);\n});\n```\n\nmake your own store by implementing\n\n```\ninterface Library {\n  version: number\n  name: string\n  save: (name: string, version: number) =\u003e Promise\u003cvoid\u003e\n  remove_collections: (keys: string[]) =\u003e Promise\u003cvoid\u003e\n  add_collection: (collection: Collection) =\u003e Promise\u003cvoid\u003e\n  add: (item: Item.Any) =\u003e Promise\u003cvoid\u003e\n  remove: (keys: string[]) =\u003e Promise\u003cvoid\u003e\n}\n\ninterface Store {\n  libraries: string[] // user_or_group_prefix\n  remove: (user_or_group_prefix: string) =\u003e Promise\u003cvoid\u003e\n  get: (user_or_group_prefix: string) =\u003e Promise\u003cLibrary\u003e // must return a library -- create one if it doesn't exist yet\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretorquere%2Fzotero-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fretorquere%2Fzotero-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretorquere%2Fzotero-sync/lists"}