@retorquere/bibtex-parser 10.0.1 → 11.0.0

package/dist/types/jabref.d.ts

@@ -0,0 +1,58 @@
+/**
+ * A JabRef group.
+ */
+export interface Group {
+    /**
+     * the group name
+     */
+    name: string;
+    /**
+     * The citation keys which are specified to belong to this group, after intersection calculation has been applied
+     */
+    entries: string[];
+    /**
+     * Sub-groups under this group
+     */
+    groups: Group[];
+}
+export interface JabRefMetadata {
+    /**
+     * The root groups. You can find the nested groups in their `groups` property
+     */
+    root: Group[];
+    /**
+     * JabRef since 3.8 has changed their groups format. Entries have a `groups` field which has the names of the groups they belong to -- this name does not have to be unique in the groups hierarchy so if you
+     * have multiple groups with the same name, it's not well-defined where the entries should end up. This property gives you the for each group name the first time the group showed up in the hierarchy. Note that
+     * keys from the entries themselves have *not* yet been added to the [[Group]]s. You need to combine this yourself as you're parsing the entries.
+     */
+    groups: {
+        [key: string]: Group;
+    };
+    /**
+     * The base path for file paths
+     */
+    fileDirectory?: string;
+    /**
+     * The JabRef metadata format version
+     */
+    groupsversion?: number;
+    /**
+     * The JabRef metadata database type
+     */
+    databaseType?: string;
+}
+/**
+ * Import the JabRef groups from the `@string` comments in which they were stored. You would typically pass the comments parsed by [[bibtex.parse]] in here.
+ *
+ * JabRef knows several group types, and this parser parses most, but not all of them:
+ *
+ * * independent group: the keys listed in the group are the entries that are considered to belong to it
+ * * intersection: the keys listed in the group are considered to belong to the group if they're also in the parent group
+ * * union: the keys listed in the group are considered to belong to the group, and also the keys that are in the parent group
+ * * query: not supported by this parser
+ */
+export declare function parse(comments: string[]): {
+    comments: string[];
+    jabref: JabRefMetadata;
+};
+//# sourceMappingURL=jabref.d.ts.map

package/dist/types/jabref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jabref.d.ts","sourceRoot":"","sources":["../../jabref.ts"],"names":[],"mappings":"AAuBA;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,EAAE,CAAA;IAEb;;;;OAIG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,CAAA;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,CAqFxF"}

package/dist/types/merge.d.ts

@@ -0,0 +1,2 @@
+export declare function merge<T>(options: T, defaults: T): T;
+//# sourceMappingURL=merge.d.ts.map

package/dist/types/merge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.d.ts","sourceRoot":"","sources":["../../merge.ts"],"names":[],"mappings":"AAEA,wBAAgB,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,CAEnD"}

package/dist/types/prepositions.d.ts

@@ -0,0 +1,3 @@
+declare const _default: string[];
+export default _default;
+//# sourceMappingURL=prepositions.d.ts.map

package/dist/types/prepositions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepositions.d.ts","sourceRoot":"","sources":["../../prepositions.ts"],"names":[],"mappings":";AAAA,wBAuFC"}

package/dist/types/sentence-case.d.ts

@@ -0,0 +1,9 @@
+export type Options = {
+    preserveQuoted?: boolean;
+    subSentenceCapitalization?: boolean;
+    markup?: RegExp;
+    nocase?: RegExp;
+    guess?: boolean;
+};
+export declare function toSentenceCase(title: string, options?: Options): string;
+//# sourceMappingURL=sentence-case.d.ts.map

package/dist/types/sentence-case.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentence-case.d.ts","sourceRoot":"","sources":["../../sentence-case.ts"],"names":[],"mappings":"AAyDA,MAAM,MAAM,OAAO,GAAG;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,OAAY,GAAG,MAAM,CAiE3E"}

package/dist/types/tokenizer.d.ts

@@ -0,0 +1,13 @@
+export type Token = {
+    type: 'word' | 'domain' | 'whitespace';
+    subtype: '' | 'preposition' | 'acronym' | 'whitespace' | 'word' | 'domain';
+    text: string;
+    start: number;
+    end: number;
+    shape: string;
+    sentenceStart: boolean;
+    subSentenceStart: boolean;
+    hyphenated?: Token[];
+};
+export declare function tokenize(title: string, markup?: RegExp): Token[];
+//# sourceMappingURL=tokenizer.d.ts.map

package/dist/types/tokenizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenizer.d.ts","sourceRoot":"","sources":["../../tokenizer.ts"],"names":[],"mappings":"AA+FA,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAA;IACtC,OAAO,EAAE,EAAE,GAAG,aAAa,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,OAAO,CAAA;IACtB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,CAAC,EAAE,KAAK,EAAE,CAAA;CACrB,CAAA;AAkBD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,CA6EhE"}

package/dist/types/verbatim.d.ts

@@ -0,0 +1,66 @@
+export type Entry = {
+    input: string;
+    type: string;
+    key: string;
+    fields: Record<string, string>;
+};
+export interface ParseError {
+    error: string;
+    input?: string;
+}
+export interface ParserOptions {
+    /**
+     * stop parsing after `max_entries` entries have been found. Useful for quick detection if a text file is in fact a bibtex file
+     */
+    max_entries?: number;
+    /**
+     * preload these strings
+     */
+    strings?: string | Record<string, string>;
+}
+export declare class Library {
+    parsing: string | null;
+    entries: Entry[];
+    strings: Record<string, string>;
+    comments: string[];
+    errors: ParseError[];
+    preambles: string[];
+    private default_strings;
+    private pos;
+    private linebreaks;
+    private input;
+    private max_entries;
+    constructor(input: string, options?: ParserOptions);
+    parse(): void;
+    parseAsync(): Promise<void>;
+    private isWhitespace;
+    private match;
+    private tryMatch;
+    private skipWhitespace;
+    private value_braces;
+    private value_quotes;
+    private single_value;
+    location(): string;
+    error(err: ParseError): void;
+    private value;
+    private key;
+    private key_equals_value;
+    private entry;
+    private directive;
+    private string;
+    private preamble;
+    private comment;
+    private hasMore;
+    private bibtex;
+    private bibtexAsync;
+    private matchGuard;
+    private parseNext;
+}
+/**
+ * Parses a bibtex source in verbatim mode. Good for detection of bibtex and for later LaTeX-reparsing.
+ */
+export declare function parse(input: string, options?: ParserOptions): Library;
+export declare const promises: {
+    parse(input: string, options?: ParserOptions): Promise<Library>;
+};
+//# sourceMappingURL=verbatim.d.ts.map

package/dist/types/verbatim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verbatim.d.ts","sourceRoot":"","sources":["../../verbatim.ts"],"names":[],"mappings":"AAsBA,MAAM,MAAM,KAAK,GAAG;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC1C;AAED,qBAAa,OAAO;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB,OAAO,EAAE,KAAK,EAAE,CAAK;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAK;IACpC,QAAQ,EAAE,MAAM,EAAE,CAAK;IACvB,MAAM,EAAE,UAAU,EAAE,CAAK;IACzB,SAAS,EAAE,MAAM,EAAE,CAAK;IAE/B,OAAO,CAAC,eAAe,CA4CtB;IAED,OAAO,CAAC,GAAG,CAAI;IACf,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,KAAK,CAAQ;IAErB,OAAO,CAAC,WAAW,CAAQ;gBAEf,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB;IAqB/C,KAAK,IAAI,IAAI;IAKP,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxC,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,KAAK;IAUb,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,YAAY;IAwCpB,OAAO,CAAC,YAAY;IAmCpB,OAAO,CAAC,YAAY;IAuBpB,QAAQ,IAAI,MAAM;IAKlB,KAAK,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAK5B,OAAO,CAAC,KAAK;IAUb,OAAO,CAAC,GAAG;IAgBX,OAAO,CAAC,gBAAgB;IAwBxB,OAAO,CAAC,KAAK;IAkCb,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,OAAO;IAaf,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,MAAM;YAMA,WAAW;IAQzB,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,SAAS;CAoDlB;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAIzE;AAED,eAAO,MAAM,QAAQ;iBACA,MAAM,YAAW,aAAa,GAAQ,OAAO,CAAC,OAAO,CAAC;CAK1E,CAAA"}

package/dist/types/yield.d.ts

@@ -0,0 +1,2 @@
+export declare function playnice(): Promise<void>;
+//# sourceMappingURL=yield.d.ts.map

package/dist/types/yield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yield.d.ts","sourceRoot":"","sources":["../../yield.ts"],"names":[],"mappings":"AAAA,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAE9C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "10.0.1",
+  "version": "11.0.0",
   "description": "BibTeX parser",
   "type": "module",
   "main": "./dist/cjs/index.js",