-
Notifications
You must be signed in to change notification settings - Fork 13
/
extraField.ts
86 lines (82 loc) · 2.17 KB
/
extraField.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
import { BasicTool } from "../basic.js";
/**
* Get/set extra field APIs.
*/
export class ExtraFieldTool extends BasicTool {
/**
* Get all extra fields
* @param item
*/
getExtraFields(
item: Zotero.Item,
backend: "default" | "custom" = "custom",
): Map<string, string> {
const extraFiledRaw = item.getField("extra") as string;
if (backend === "default") {
return this.getGlobal("Zotero").Utilities.Internal.extractExtraFields(
extraFiledRaw,
).fields as Map<string, string>;
} else {
const map = new Map<string, string>();
const nonStandardFields: string[] = [];
extraFiledRaw.split("\n").forEach((line) => {
const split = line.split(": ");
if (split.length >= 2 && split[0]) {
map.set(split[0], split.slice(1).join(": "));
} else {
nonStandardFields.push(line);
}
});
map.set("__nonStandard__", nonStandardFields.join("\n"));
return map;
}
}
/**
* Get extra field value by key. If it does not exists, return undefined.
* @param item
* @param key
*/
getExtraField(item: Zotero.Item, key: string): string | undefined {
const fields = this.getExtraFields(item);
return fields.get(key);
}
/**
* Replace extra field of an item.
* @param item
* @param fields
*/
async replaceExtraFields(
item: Zotero.Item,
fields: Map<string, string>,
): Promise<void> {
const kvs: string[] = [];
if (fields.has("__nonStandard__")) {
kvs.push(fields.get("__nonStandard__") as string);
fields.delete("__nonStandard__");
}
fields.forEach((v, k) => {
kvs.push(`${k}: ${v}`);
});
item.setField("extra", kvs.join("\n"));
await item.saveTx();
}
/**
* Set an key-value pair to the item's extra field
* @param item
* @param key
* @param value
*/
async setExtraField(
item: Zotero.Item,
key: string,
value: string,
): Promise<void> {
const fields = this.getExtraFields(item);
if (value === "" || typeof value === "undefined") {
fields.delete(key);
} else {
fields.set(key, value);
}
await this.replaceExtraFields(item, fields);
}
}