Zotero-types NPM

Zotero Types

This package contains type definitions for Zotero (https://www.zotero.org/) plugin.

npm package: https://www.npmjs.com/package/zotero-types

Usage

Run npm install --save-dev zotero-types.
No need to import the type declaration in your TypeScript code. If your IDE does not recognize the definitions, add the path to typing file in the include of tsconfig.json:
```
// tsconfig.json
{
  "include": ["src", "typing", "node_modules/zotero-types"]
}
```

Example:

// Example 1: get Zotero.Item by id
const item = Zotero.Items.get(1234);

// Example 2: use XUL.Element type with specific properties
const exportFiles = document.querySelector(
  "#menu_export_files"
) as XUL.Menuitem;
exportFiles.disabled = true;

// Example 3: use platform APIs (OS)
const filepath = "/path/to/file";
if (await OS.File.exists(filepath)) {
  let contentRaw = (await OS.File.read(filepath, {
    encoding: "utf-8",
  })) as string;
}

!NOTE
If you are using pnpm as the package manager for your project, you need to additionally do one of the following things:
Add public-hoist-pattern[]=*@types/bluebird* to .npmrc.
Add @types/bulebird to the devDependencies.
See also:
@types are not hoisted by default in pnpm v7: https://github.com/pnpm/pnpm/issues/4920#issuecomment-1225961351
Dependency Hoisting Settings: https://pnpm.io/npmrc#public-hoist-pattern

Contributing

This type definition only contains frequently used typings and is not complete. Please check the source code of Zotero here: https://github.com/zotero/zotero.

The d.ts files of Zotero are set accordingly to their corresponding file in the Zotero repository.

Planning to merge to https://github.com/DefinitelyTyped/DefinitelyTyped/

To release this to the npm package, use npm run release.