Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@citeproc-rs/wasm

Package Overview
Dependencies
Maintainers
1
Versions
48
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@citeproc-rs/wasm - npm Package Compare versions

Comparing version 0.0.0-canary-7bb4807 to 0.0.0-canary-7e0838c

_cjs/citeproc_rs_wasm_bg.wasm.d.ts
_cjs/snippets/wasm-1883a0b9dcad429e/src/js/include.js
_esm/citeproc_rs_wasm_bg.wasm.d.ts
_esm/snippets/wasm-1883a0b9dcad429e/src/js/include.js
_no_modules/citeproc_rs_wasm_bg.wasm
_no_modules/citeproc_rs_wasm_bg.wasm.d.ts
_no_modules/citeproc_rs_wasm_include.js
_no_modules/citeproc_rs_wasm.d.ts
_no_modules/citeproc_rs_wasm.js
_web/citeproc_rs_wasm_bg.wasm.d.ts
_web/snippets/wasm-1883a0b9dcad429e/src/js/include.js
_zotero/citeproc_rs_wasm_bg.wasm
_zotero/citeproc_rs_wasm_bg.wasm.d.ts
_zotero/citeproc_rs_wasm_include.js
_zotero/citeproc_rs_wasm.d.ts
_zotero/citeproc_rs_wasm.js

344

_cjs/citeproc_rs_wasm.d.ts
/* tslint:disable */
/* eslint-disable */
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
export function parseStyleMetadata(style: string): WasmResult<StyleMeta>;
interface InitOptions {
/** A CSL style as an XML string */
style: string,
/** A Fetcher implementation for fetching locales.
*
* If not provided, then no locales can be fetched, and default-locale and localeOverride will
* not be respected; the only locale used will be the bundled en-US. */
fetcher?: Fetcher,
/** The output format for this driver instance */
format: "html" | "rtf" | "plain",
/** A locale to use instead of the style's default-locale.
*
* For dependent styles, use parseStyleMetadata to find out which locale it prefers, and pass
* in the parent style with a localeOverride set to that value.
*/
localeOverride?: string,
/** Disables sorting in the bibliography; items appear in cited order. */
bibliographyNoSort?: bool,
}
/** This interface lets citeproc retrieve locales or modules asynchronously,
according to which ones are needed. */
export interface Lifecycle {
export interface Fetcher {
/** Return locale XML for a particular locale. */

@@ -12,2 +41,4 @@ fetchLocale(lang: string): Promise<string>;

export type DateLiteral = { "literal": string; };

@@ -21,2 +52,4 @@ export type DateRaw = { "raw": string; };

/** Locator type, and a locator string */

@@ -29,24 +62,28 @@ export type Locator = {

export type CiteLocator = Locator | { locator: undefined; locators: Locator[] };
export type CiteLocator = Locator | { locator: undefined; locators: Locator[]; };
export type CiteMode = { mode?: "SuppressAuthor" | "AuthorOnly"; };
export type Cite<Affix = string> = {
export type Cite = {
id: string;
prefix?: Affix;
suffix?: Affix;
suppression?: "InText" | "Rest" | null;
} & Partial<CiteLocator>;
prefix?: string;
suffix?: string;
} & Partial<CiteLocator> & CiteMode;
export type ClusterNumber = {
note: number | [number, number]
} | {
inText: number
};
export type ClusterMode
= { mode: "Composite"; infix?: string; suppressFirst?: number; }
| { mode: "SuppressAuthor"; suppressFirst?: number; }
| { mode: "AuthorOnly"; }
| {};
export type Cluster = {
id: number;
id: string;
cites: Cite[];
};
} & ClusterMode;
export type PreviewCluster {
cites: Cite[];
} & ClusterMode;
export type ClusterPosition = {
id: number;
id: string;
/** Leaving off this field means this cluster is in-text. */

@@ -56,2 +93,4 @@ note?: number;

export type Reference = {

@@ -63,6 +102,8 @@ id: string;

export type CslType = "book" | "article" | "legal_case" | "article-journal";
export type CslType = "book" | "article" | "legal_case" | "article-journal" | string;
export interface BibliographyUpdate {
updatedEntries: { [key: string]: string };
updatedEntries: Map<string, string>;
entryIds?: string[];

@@ -72,26 +113,158 @@ }

export type UpdateSummary<Output = string> = {
clusters: [number, Output][];
clusters: [string, Output][];
bibliography?: BibliographyUpdate;
};
type InvalidCsl = {
severity: "Error" | "Warning";
type IncludeUncited = "None" | "All" | { Specific: string[] };
type BibEntry = {
id: string;
value: string;
};
type BibEntries = BibEntry[];
type FullRender = {
allClusters: Map<string, string>,
bibEntries: BibEntries,
};
type BibliographyMeta = {
maxOffset: number;
entrySpacing: number;
lineSpacing: number;
hangingIndent: boolean;
/** the second-field-align value of the CSL style */
secondFieldAlign: null | "flush" | "margin";
/** Format-specific metadata */
formatMeta: any,
};
type Severity = "Error" | "Warning";
interface InvalidCsl {
severity: Severity;
/** Relevant bytes in the provided XML */
range: {
start: number;
end: number;
start: number,
end: number,
};
message: string;
hint: string;
hint: string | undefined;
};
type ParseError = {
ParseError: string;
type StyleError = {
tag: "Invalid",
content: InvalidCsl[],
} | {
tag: "ParseError",
content: string,
} | {
/** Cannot use a dependent style to format citations, pass the parent style instead. */
tag: "DependentStyle",
content: {
requiredParent: string,
}
};
type Invalid = {
Invalid: InvalidCsl[];
type DriverError = {
tag: "UnknownOutputFormat",
content: string,
} | {
tag: "JsonError",
} | {
tag: "GetFetcherError",
} | {
tag: "NonExistentCluster",
content: string,
} | {
tag: "ReorderingError"
} | {
tag: "ReorderingErrorNumericId"
};
type StyleError = Partial<ParseError & Invalid>;
type IncludeUncited = "None" | "All" | { Specific: string[] };
declare global {
/** Catch-all citeproc-rs Error subclass. */
declare class CiteprocRsError extends Error {
constructor(message: string);
}
declare class CiteprocRsDriverError extends CiteprocRsError {
data: DriverError;
constructor(message: string, data: DriverError);
}
declare class CslStyleError extends CiteprocRsError {
data: StyleError;
constructor(message: string, data: StyleError);
}
}
interface WasmResult<T> {
/** If this is an error, throws the error. */
unwrap(): T;
/** If this is an error, returns it, else throws. */
unwrap_err(): Error;
is_ok(): boolean;
is_err(): boolean;
/** If this is an error, returns the default value. */
unwrap_or(default: T): T;
/** If this is Ok, returns f(ok_val), else returns Err unmodified. */
map<R>(f: (t: T) => R): WasmResult<T>;
/** If this is Ok, returns f(ok_val), else returns the default value. */
map_or<R>(default: R, f: (t: T) => R): R;
}
type CitationFormat = "author-date" | "author" | "numeric" | "label" | "note";
interface LocalizedString {
value: string,
lang?: string,
}
interface ParentLink {
href: string,
lang?: string,
}
interface Link {
href: string,
rel: "self" | "documentation" | "template",
lang?: string,
}
interface Rights {
value: string,
lang?: string,
license?: string,
}
interface StyleInfo {
id: string,
updated: string,
title: LocalizedString,
titleShort?: LocalizedString,
parent?: ParentLink,
links: Link[],
rights?: Rights,
citationFormat?: CitationFormat,
categories: string[],
issn?: string,
eissn?: string,
issnl?: string,
}
interface IndependentMeta {
/** A list of languages for which a locale override was specified.
* Does not include the language-less final override. */
localeOverrides: string[],
hasBibliography: bool,
}
interface StyleMeta {
info: StyleInfo,
features: { [feature: string]: bool },
defaultLocale: string,
/** May be absent on a dependent style */
class?: "in-text" | "note",
cslVersionRequired: string,
/** May be absent on a dependent style */
independentMeta?: IndependentMeta,
};
/**

@@ -105,18 +278,16 @@ */

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style: string, lifecycle: any, format: string): Driver;
static new(options: InitOptions): WasmResult<Driver>;
/**
* Sets the style (which will also cause everything to be recomputed)
* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/
setStyle(style_text: string): any;
setStyle(style_text: string): WasmResult<undefined>;
/**

@@ -126,4 +297,5 @@ * Completely overwrites the references library.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
resetReferences(refs: any[]): void;
resetReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -133,4 +305,5 @@ * Inserts or overwrites references as a batch operation.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
insertReferences(refs: any[]): void;
insertReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -141,4 +314,5 @@ * Inserts or overwrites a reference.

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr: Reference): void;
insertReference(refr: Reference): WasmResult<undefined>;
/**

@@ -148,4 +322,5 @@ * Removes a reference by id. If it is cited, any cites will be dangling. It will also

* @param {string} id
* @returns {WasmResult<undefined>}
*/
removeReference(id: string): void;
removeReference(id: string): WasmResult<undefined>;
/**

@@ -156,4 +331,5 @@ * Sets the references to be included in the bibliography despite not being directly cited.

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited: IncludeUncited): void;
includeUncited(uncited: IncludeUncited): WasmResult<undefined>;
/**

@@ -163,15 +339,22 @@ * Gets a list of locales in use by the references currently loaded.

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/
toFetch(): any;
toFetch(): WasmResult<string[]>;
/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId(): string;
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id: any): void;
insertCluster(cluster: Cluster): WasmResult<undefined>;
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id: number): void;
removeCluster(cluster_id: string): WasmResult<undefined>;
/**

@@ -182,4 +365,5 @@ * Resets all the clusters in the processor to a new list.

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/
initClusters(clusters: any[]): void;
initClusters(clusters: any[]): WasmResult<undefined>;
/**

@@ -190,6 +374,6 @@ * Returns the formatted citation cluster for `cluster_id`.

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id: number): any;
builtCluster(id: string): WasmResult<string>;
/**

@@ -206,37 +390,14 @@ * Previews a formatted citation cluster, in a particular position.

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/
previewCitationCluster(cites: any[], positions: any[], format: string): any;
previewCitationCluster(cites: any[], positions: any[], format: string): WasmResult<string>;
/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/
makeBibliography(): any;
makeBibliography(): WasmResult<BibEntries>;
/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/
bibliographyMeta(): any;
bibliographyMeta(): WasmResult<BibliographyMeta>;
/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings: any[]): void;
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -266,4 +427,5 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/
setClusterOrder(positions: any[]): void;
setClusterOrder(positions: any[]): WasmResult<undefined>;
/**

@@ -277,16 +439,22 @@ * Retrieve any clusters that have been touched since last time `batchedUpdates` was

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/
batchedUpdates(): UpdateSummary;
batchedUpdates(): WasmResult<UpdateSummary>;
/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender(): WasmResult<FullRender>;
/**
* Drains the `batchedUpdates` queue manually.
*/
drain(): void;
/**
* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll(): Promise<any>;
fetchLocales(): Promise<any>;
}

419

_cjs/citeproc_rs_wasm.js
let imports = {};
imports['__wbindgen_placeholder__'] = module.exports;
let wasm;
const { TextDecoder } = require(String.raw`util`);
const { WasmResult, CiteprocRsError, CiteprocRsDriverError, CslStyleError } = require(String.raw`./snippets/wasm-1883a0b9dcad429e/src/js/include.js`);
const { TextEncoder, TextDecoder } = require(String.raw`util`);

@@ -12,32 +13,62 @@ const heap = new Array(32).fill(undefined);

let heap_next = heap.length;
let WASM_VECTOR_LEN = 0;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
let cachegetUint8Memory0 = null;
function getUint8Memory0() {
if (cachegetUint8Memory0 === null || cachegetUint8Memory0.buffer !== wasm.memory.buffer) {
cachegetUint8Memory0 = new Uint8Array(wasm.memory.buffer);
}
return cachegetUint8Memory0;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
let cachedTextEncoder = new TextEncoder('utf-8');
const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
? function (arg, view) {
return cachedTextEncoder.encodeInto(arg, view);
}
: function (arg, view) {
const buf = cachedTextEncoder.encode(arg);
view.set(buf);
return {
read: arg.length,
written: buf.length
};
});
let WASM_VECTOR_LEN = 0;
function passStringToWasm0(arg, malloc, realloc) {
let cachegetNodeBufferMemory0 = null;
function getNodeBufferMemory0() {
if (cachegetNodeBufferMemory0 === null || cachegetNodeBufferMemory0.buffer !== wasm.memory.buffer) {
cachegetNodeBufferMemory0 = Buffer.from(wasm.memory.buffer);
if (realloc === undefined) {
const buf = cachedTextEncoder.encode(arg);
const ptr = malloc(buf.length);
getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
WASM_VECTOR_LEN = buf.length;
return ptr;
}
return cachegetNodeBufferMemory0;
}
function passStringToWasm0(arg, malloc) {
let len = arg.length;
let ptr = malloc(len);
const len = Buffer.byteLength(arg);
const ptr = malloc(len);
getNodeBufferMemory0().write(arg, ptr, len);
WASM_VECTOR_LEN = len;
const mem = getUint8Memory0();
let offset = 0;
for (; offset < len; offset++) {
const code = arg.charCodeAt(offset);
if (code > 0x7F) break;
mem[ptr + offset] = code;
}
if (offset !== len) {
if (offset !== 0) {
arg = arg.slice(offset);
}
ptr = realloc(ptr, len, len = offset + arg.length * 3);
const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
const ret = encodeString(arg, view);
offset += ret.written;
}
WASM_VECTOR_LEN = offset;
return ptr;

@@ -54,11 +85,16 @@ }

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
let heap_next = heap.length;
heap[idx] = obj;
return idx;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
}
let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });

@@ -68,10 +104,2 @@

let cachegetUint8Memory0 = null;
function getUint8Memory0() {
if (cachegetUint8Memory0 === null || cachegetUint8Memory0.buffer !== wasm.memory.buffer) {
cachegetUint8Memory0 = new Uint8Array(wasm.memory.buffer);
}
return cachegetUint8Memory0;
}
function getStringFromWasm0(ptr, len) {

@@ -81,2 +109,11 @@ return cachedTextDecoder.decode(getUint8Memory0().subarray(ptr, ptr + len));

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
heap[idx] = obj;
return idx;
}
function isLikeNone(x) {

@@ -110,6 +147,18 @@ return x === undefined || x === null;

}
function __wbg_adapter_18(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf77188239a1f71cd(arg0, arg1, addHeapObject(arg2));
function __wbg_adapter_24(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h2b1b33880a98c55e(arg0, arg1, addHeapObject(arg2));
}
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
module.exports.parseStyleMetadata = function(style) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.parseStyleMetadata(ptr0, len0);
return takeObject(ret);
};
let cachegetUint32Memory0 = null;

@@ -143,6 +192,9 @@ function getUint32Memory0() {

}
function __wbg_adapter_63(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h19f62226ce422262(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
function __wbg_adapter_81(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h4915090d68cfd6bd(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
}
function getArrayU8FromWasm0(ptr, len) {
return getUint8Memory0().subarray(ptr / 1, ptr / 1 + len);
}
/**

@@ -159,6 +211,11 @@ */

free() {
__destroy_into_raw() {
const ptr = this.ptr;
this.ptr = 0;
return ptr;
}
free() {
const ptr = this.__destroy_into_raw();
wasm.__wbg_driver_free(ptr);

@@ -170,18 +227,12 @@ }

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style, lifecycle, format) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ptr1 = passStringToWasm0(format, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len1 = WASM_VECTOR_LEN;
var ret = wasm.driver_new(ptr0, len0, addHeapObject(lifecycle), ptr1, len1);
return Driver.__wrap(ret);
static new(options) {
var ret = wasm.driver_new(addHeapObject(options));
return takeObject(ret);
}

@@ -191,3 +242,3 @@ /**

* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/

@@ -204,2 +255,3 @@ setStyle(style_text) {

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -209,3 +261,4 @@ resetReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_resetReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_resetReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -216,2 +269,3 @@ /**

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -221,3 +275,4 @@ insertReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_insertReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_insertReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -229,5 +284,7 @@ /**

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr) {
wasm.driver_insertReference(this.ptr, addHeapObject(refr));
var ret = wasm.driver_insertReference(this.ptr, addHeapObject(refr));
return takeObject(ret);
}

@@ -238,2 +295,3 @@ /**

* @param {string} id
* @returns {WasmResult<undefined>}
*/

@@ -243,3 +301,4 @@ removeReference(id) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_removeReference(this.ptr, ptr0, len0);
var ret = wasm.driver_removeReference(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -251,5 +310,7 @@ /**

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited) {
wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
var ret = wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
return takeObject(ret);
}

@@ -260,3 +321,3 @@ /**

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/

@@ -268,14 +329,36 @@ toFetch() {

/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId() {
try {
const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
wasm.driver_randomClusterId(retptr, this.ptr);
var r0 = getInt32Memory0()[retptr / 4 + 0];
var r1 = getInt32Memory0()[retptr / 4 + 1];
return getStringFromWasm0(r0, r1);
} finally {
wasm.__wbindgen_add_to_stack_pointer(16);
wasm.__wbindgen_free(r0, r1);
}
}
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id) {
wasm.driver_insertCluster(this.ptr, addHeapObject(cluster_id));
insertCluster(cluster) {
var ret = wasm.driver_insertCluster(this.ptr, addHeapObject(cluster));
return takeObject(ret);
}
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id) {
wasm.driver_removeCluster(this.ptr, cluster_id);
var ptr0 = passStringToWasm0(cluster_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_removeCluster(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -287,2 +370,3 @@ /**

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/

@@ -292,3 +376,4 @@ initClusters(clusters) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_initClusters(this.ptr, ptr0, len0);
var ret = wasm.driver_initClusters(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -300,7 +385,9 @@ /**

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id) {
var ret = wasm.driver_builtCluster(this.ptr, id);
var ptr0 = passStringToWasm0(id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_builtCluster(this.ptr, ptr0, len0);
return takeObject(ret);

@@ -319,3 +406,3 @@ }

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/

@@ -333,3 +420,3 @@ previewCitationCluster(cites, positions, format) {

/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/

@@ -341,3 +428,3 @@ makeBibliography() {

/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/

@@ -349,29 +436,2 @@ bibliographyMeta() {

/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings) {
var ptr0 = passArrayJsValueToWasm0(mappings, wasm.__wbindgen_malloc);
var len0 = WASM_VECTOR_LEN;
wasm.driver_renumberClusters(this.ptr, ptr0, len0);
}
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -401,2 +461,3 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/

@@ -406,3 +467,4 @@ setClusterOrder(positions) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
var ret = wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -417,3 +479,3 @@ /**

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/

@@ -425,5 +487,14 @@ batchedUpdates() {

/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender() {
var ret = wasm.driver_fullRender(this.ptr);
return takeObject(ret);
}
/**
* Drains the `batchedUpdates` queue manually.
*/
drain() {

@@ -434,7 +505,7 @@ wasm.driver_drain(this.ptr);

* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll() {
var ret = wasm.driver_fetchAll(this.ptr);
fetchLocales() {
var ret = wasm.driver_fetchLocales(this.ptr);
return takeObject(ret);

@@ -445,6 +516,2 @@ }

module.exports.__wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};
module.exports.__wbindgen_json_serialize = function(arg0, arg1) {

@@ -459,10 +526,9 @@ const obj = getObject(arg1);

module.exports.__wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
module.exports.__wbg_fetchLocale_d644d4ae2ca50f81 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).fetchLocale(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
module.exports.__wbg_fetchLocale_8f52b973b0739a6c = function(arg0, arg1, arg2) {
var ret = getObject(arg0).fetchLocale(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
module.exports.__wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};

@@ -494,7 +560,12 @@

module.exports.__wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
module.exports.__wbg_get_1edc26456ed84f9b = function(arg0, arg1) {
var ret = getObject(arg0)[takeObject(arg1)];
return addHeapObject(ret);
};
module.exports.__wbindgen_string_new = function(arg0, arg1) {
var ret = getStringFromWasm0(arg0, arg1);
return addHeapObject(ret);
};
module.exports.__wbindgen_cb_drop = function(arg0) {

@@ -510,2 +581,53 @@ const obj = takeObject(arg0).original;

module.exports.__wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
module.exports.__wbg_driver_new = function(arg0) {
var ret = Driver.__wrap(arg0);
return addHeapObject(ret);
};
module.exports.__wbg_new_f12987d5c30f0ab7 = function(arg0) {
var ret = new CiteprocRsError(takeObject(arg0));
return addHeapObject(ret);
};
module.exports.__wbg_new_c5e56e6577bc2b6a = function(arg0, arg1) {
var ret = new CslStyleError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
module.exports.__wbg_new_6edca5ab9ee61764 = function(arg0) {
var ret = new WasmResult(takeObject(arg0));
return addHeapObject(ret);
};
module.exports.__wbg_new_8d5f3cd64eaaa8b5 = function(arg0, arg1) {
var ret = new CiteprocRsDriverError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
module.exports.__wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
return addHeapObject(ret);
};
module.exports.__wbindgen_is_undefined = function(arg0) {
var ret = getObject(arg0) === undefined;
return ret;
};
module.exports.__wbindgen_is_object = function(arg0) {
const val = getObject(arg0);
var ret = typeof(val) === 'object' && val !== null;
return ret;
};
module.exports.__wbindgen_is_function = function(arg0) {
var ret = typeof(getObject(arg0)) === 'function';
return ret;
};
module.exports.__wbg_new_59cb74e423758ede = function() {

@@ -532,8 +654,3 @@ var ret = new Error();

module.exports.__wbg_new_4896ab6bba55e0d9 = function(arg0, arg1) {
var ret = new Error(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
module.exports.__wbg_call_0dad7db75ec90ae7 = handleError(function(arg0, arg1, arg2) {
module.exports.__wbg_call_f5e0576f61ee7461 = handleError(function(arg0, arg1, arg2) {
var ret = getObject(arg0).call(getObject(arg1), getObject(arg2));

@@ -543,3 +660,3 @@ return addHeapObject(ret);

module.exports.__wbg_new_7039bf8b99f049e1 = function(arg0, arg1) {
module.exports.__wbg_new_3ea8490cd276c848 = function(arg0, arg1) {
try {

@@ -551,3 +668,3 @@ var state0 = {a: arg0, b: arg1};

try {
return __wbg_adapter_63(a, state0.b, arg0, arg1);
return __wbg_adapter_81(a, state0.b, arg0, arg1);
} finally {

@@ -564,3 +681,3 @@ state0.a = a;

module.exports.__wbg_resolve_4df26938859b92e3 = function(arg0) {
module.exports.__wbg_resolve_778af3f90b8e2b59 = function(arg0) {
var ret = Promise.resolve(getObject(arg0));

@@ -570,3 +687,3 @@ return addHeapObject(ret);

module.exports.__wbg_then_ffb6e71f7a6735ad = function(arg0, arg1) {
module.exports.__wbg_then_367b3e718069cfb9 = function(arg0, arg1) {
var ret = getObject(arg0).then(getObject(arg1));

@@ -576,3 +693,3 @@ return addHeapObject(ret);

module.exports.__wbg_then_021fcdc7f0350b58 = function(arg0, arg1, arg2) {
module.exports.__wbg_then_ac66ca61394bfd21 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).then(getObject(arg1), getObject(arg2));

@@ -582,2 +699,40 @@ return addHeapObject(ret);

module.exports.__wbg_self_1c83eb4471d9eb9b = handleError(function() {
var ret = self.self;
return addHeapObject(ret);
});
module.exports.__wbg_static_accessor_MODULE_abf5ae284bffdf45 = function() {
var ret = module;
return addHeapObject(ret);
};
module.exports.__wbg_require_5b2b5b594d809d9f = function(arg0, arg1, arg2) {
var ret = getObject(arg0).require(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
module.exports.__wbg_crypto_c12f14e810edcaa2 = function(arg0) {
var ret = getObject(arg0).crypto;
return addHeapObject(ret);
};
module.exports.__wbg_msCrypto_679be765111ba775 = function(arg0) {
var ret = getObject(arg0).msCrypto;
return addHeapObject(ret);
};
module.exports.__wbg_getRandomValues_05a60bf171bfc2be = function(arg0) {
var ret = getObject(arg0).getRandomValues;
return addHeapObject(ret);
};
module.exports.__wbg_getRandomValues_3ac1b33c90b52596 = function(arg0, arg1, arg2) {
getObject(arg0).getRandomValues(getArrayU8FromWasm0(arg1, arg2));
};
module.exports.__wbg_randomFillSync_6f956029658662ec = function(arg0, arg1, arg2) {
getObject(arg0).randomFillSync(getArrayU8FromWasm0(arg1, arg2));
};
module.exports.__wbindgen_string_get = function(arg0, arg1) {

@@ -596,8 +751,4 @@ const obj = getObject(arg1);

module.exports.__wbindgen_rethrow = function(arg0) {
throw takeObject(arg0);
};
module.exports.__wbindgen_closure_wrapper839 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 197, __wbg_adapter_18);
module.exports.__wbindgen_closure_wrapper949 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 226, __wbg_adapter_24);
return addHeapObject(ret);

@@ -604,0 +755,0 @@ };

351

_esm/citeproc_rs_wasm_bg.js

@@ -0,1 +1,2 @@

import { WasmResult, CiteprocRsError, CiteprocRsDriverError, CslStyleError } from './snippets/wasm-1883a0b9dcad429e/src/js/include.js';
import * as wasm from './citeproc_rs_wasm_bg.wasm';

@@ -9,16 +10,2 @@

let heap_next = heap.length;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
}
let WASM_VECTOR_LEN = 0;

@@ -97,11 +84,16 @@

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
let heap_next = heap.length;
heap[idx] = obj;
return idx;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
}
const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;

@@ -117,2 +109,11 @@

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
heap[idx] = obj;
return idx;
}
function isLikeNone(x) {

@@ -146,6 +147,18 @@ return x === undefined || x === null;

}
function __wbg_adapter_18(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf77188239a1f71cd(arg0, arg1, addHeapObject(arg2));
function __wbg_adapter_24(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h2b1b33880a98c55e(arg0, arg1, addHeapObject(arg2));
}
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
export function parseStyleMetadata(style) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.parseStyleMetadata(ptr0, len0);
return takeObject(ret);
}
let cachegetUint32Memory0 = null;

@@ -179,6 +192,9 @@ function getUint32Memory0() {

}
function __wbg_adapter_63(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h19f62226ce422262(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
function __wbg_adapter_81(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h4915090d68cfd6bd(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
}
function getArrayU8FromWasm0(ptr, len) {
return getUint8Memory0().subarray(ptr / 1, ptr / 1 + len);
}
/**

@@ -195,6 +211,11 @@ */

free() {
__destroy_into_raw() {
const ptr = this.ptr;
this.ptr = 0;
return ptr;
}
free() {
const ptr = this.__destroy_into_raw();
wasm.__wbg_driver_free(ptr);

@@ -206,18 +227,12 @@ }

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style, lifecycle, format) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ptr1 = passStringToWasm0(format, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len1 = WASM_VECTOR_LEN;
var ret = wasm.driver_new(ptr0, len0, addHeapObject(lifecycle), ptr1, len1);
return Driver.__wrap(ret);
static new(options) {
var ret = wasm.driver_new(addHeapObject(options));
return takeObject(ret);
}

@@ -227,3 +242,3 @@ /**

* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/

@@ -240,2 +255,3 @@ setStyle(style_text) {

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -245,3 +261,4 @@ resetReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_resetReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_resetReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -252,2 +269,3 @@ /**

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -257,3 +275,4 @@ insertReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_insertReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_insertReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -265,5 +284,7 @@ /**

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr) {
wasm.driver_insertReference(this.ptr, addHeapObject(refr));
var ret = wasm.driver_insertReference(this.ptr, addHeapObject(refr));
return takeObject(ret);
}

@@ -274,2 +295,3 @@ /**

* @param {string} id
* @returns {WasmResult<undefined>}
*/

@@ -279,3 +301,4 @@ removeReference(id) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_removeReference(this.ptr, ptr0, len0);
var ret = wasm.driver_removeReference(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -287,5 +310,7 @@ /**

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited) {
wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
var ret = wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
return takeObject(ret);
}

@@ -296,3 +321,3 @@ /**

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/

@@ -304,14 +329,36 @@ toFetch() {

/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId() {
try {
const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
wasm.driver_randomClusterId(retptr, this.ptr);
var r0 = getInt32Memory0()[retptr / 4 + 0];
var r1 = getInt32Memory0()[retptr / 4 + 1];
return getStringFromWasm0(r0, r1);
} finally {
wasm.__wbindgen_add_to_stack_pointer(16);
wasm.__wbindgen_free(r0, r1);
}
}
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id) {
wasm.driver_insertCluster(this.ptr, addHeapObject(cluster_id));
insertCluster(cluster) {
var ret = wasm.driver_insertCluster(this.ptr, addHeapObject(cluster));
return takeObject(ret);
}
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id) {
wasm.driver_removeCluster(this.ptr, cluster_id);
var ptr0 = passStringToWasm0(cluster_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_removeCluster(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -323,2 +370,3 @@ /**

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/

@@ -328,3 +376,4 @@ initClusters(clusters) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_initClusters(this.ptr, ptr0, len0);
var ret = wasm.driver_initClusters(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -336,7 +385,9 @@ /**

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id) {
var ret = wasm.driver_builtCluster(this.ptr, id);
var ptr0 = passStringToWasm0(id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_builtCluster(this.ptr, ptr0, len0);
return takeObject(ret);

@@ -355,3 +406,3 @@ }

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/

@@ -369,3 +420,3 @@ previewCitationCluster(cites, positions, format) {

/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/

@@ -377,3 +428,3 @@ makeBibliography() {

/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/

@@ -385,29 +436,2 @@ bibliographyMeta() {

/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings) {
var ptr0 = passArrayJsValueToWasm0(mappings, wasm.__wbindgen_malloc);
var len0 = WASM_VECTOR_LEN;
wasm.driver_renumberClusters(this.ptr, ptr0, len0);
}
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -437,2 +461,3 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/

@@ -442,3 +467,4 @@ setClusterOrder(positions) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
var ret = wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -453,3 +479,3 @@ /**

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/

@@ -461,5 +487,14 @@ batchedUpdates() {

/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender() {
var ret = wasm.driver_fullRender(this.ptr);
return takeObject(ret);
}
/**
* Drains the `batchedUpdates` queue manually.
*/
drain() {

@@ -470,7 +505,7 @@ wasm.driver_drain(this.ptr);

* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll() {
var ret = wasm.driver_fetchAll(this.ptr);
fetchLocales() {
var ret = wasm.driver_fetchLocales(this.ptr);
return takeObject(ret);

@@ -480,6 +515,2 @@ }

export const __wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};
export const __wbindgen_json_serialize = function(arg0, arg1) {

@@ -494,10 +525,9 @@ const obj = getObject(arg1);

export const __wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
export const __wbg_fetchLocale_d644d4ae2ca50f81 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).fetchLocale(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
export const __wbg_fetchLocale_8f52b973b0739a6c = function(arg0, arg1, arg2) {
var ret = getObject(arg0).fetchLocale(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
export const __wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};

@@ -529,7 +559,12 @@

export const __wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
export const __wbg_get_1edc26456ed84f9b = function(arg0, arg1) {
var ret = getObject(arg0)[takeObject(arg1)];
return addHeapObject(ret);
};
export const __wbindgen_string_new = function(arg0, arg1) {
var ret = getStringFromWasm0(arg0, arg1);
return addHeapObject(ret);
};
export const __wbindgen_cb_drop = function(arg0) {

@@ -545,2 +580,53 @@ const obj = takeObject(arg0).original;

export const __wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
export const __wbg_driver_new = function(arg0) {
var ret = Driver.__wrap(arg0);
return addHeapObject(ret);
};
export const __wbg_new_f12987d5c30f0ab7 = function(arg0) {
var ret = new CiteprocRsError(takeObject(arg0));
return addHeapObject(ret);
};
export const __wbg_new_c5e56e6577bc2b6a = function(arg0, arg1) {
var ret = new CslStyleError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
export const __wbg_new_6edca5ab9ee61764 = function(arg0) {
var ret = new WasmResult(takeObject(arg0));
return addHeapObject(ret);
};
export const __wbg_new_8d5f3cd64eaaa8b5 = function(arg0, arg1) {
var ret = new CiteprocRsDriverError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
export const __wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
return addHeapObject(ret);
};
export const __wbindgen_is_undefined = function(arg0) {
var ret = getObject(arg0) === undefined;
return ret;
};
export const __wbindgen_is_object = function(arg0) {
const val = getObject(arg0);
var ret = typeof(val) === 'object' && val !== null;
return ret;
};
export const __wbindgen_is_function = function(arg0) {
var ret = typeof(getObject(arg0)) === 'function';
return ret;
};
export const __wbg_new_59cb74e423758ede = function() {

@@ -567,8 +653,3 @@ var ret = new Error();

export const __wbg_new_4896ab6bba55e0d9 = function(arg0, arg1) {
var ret = new Error(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
export const __wbg_call_0dad7db75ec90ae7 = handleError(function(arg0, arg1, arg2) {
export const __wbg_call_f5e0576f61ee7461 = handleError(function(arg0, arg1, arg2) {
var ret = getObject(arg0).call(getObject(arg1), getObject(arg2));

@@ -578,3 +659,3 @@ return addHeapObject(ret);

export const __wbg_new_7039bf8b99f049e1 = function(arg0, arg1) {
export const __wbg_new_3ea8490cd276c848 = function(arg0, arg1) {
try {

@@ -586,3 +667,3 @@ var state0 = {a: arg0, b: arg1};

try {
return __wbg_adapter_63(a, state0.b, arg0, arg1);
return __wbg_adapter_81(a, state0.b, arg0, arg1);
} finally {

@@ -599,3 +680,3 @@ state0.a = a;

export const __wbg_resolve_4df26938859b92e3 = function(arg0) {
export const __wbg_resolve_778af3f90b8e2b59 = function(arg0) {
var ret = Promise.resolve(getObject(arg0));

@@ -605,3 +686,3 @@ return addHeapObject(ret);

export const __wbg_then_ffb6e71f7a6735ad = function(arg0, arg1) {
export const __wbg_then_367b3e718069cfb9 = function(arg0, arg1) {
var ret = getObject(arg0).then(getObject(arg1));

@@ -611,3 +692,3 @@ return addHeapObject(ret);

export const __wbg_then_021fcdc7f0350b58 = function(arg0, arg1, arg2) {
export const __wbg_then_ac66ca61394bfd21 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).then(getObject(arg1), getObject(arg2));

@@ -617,2 +698,40 @@ return addHeapObject(ret);

export const __wbg_self_1c83eb4471d9eb9b = handleError(function() {
var ret = self.self;
return addHeapObject(ret);
});
export const __wbg_static_accessor_MODULE_abf5ae284bffdf45 = function() {
var ret = module;
return addHeapObject(ret);
};
export const __wbg_require_5b2b5b594d809d9f = function(arg0, arg1, arg2) {
var ret = getObject(arg0).require(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
export const __wbg_crypto_c12f14e810edcaa2 = function(arg0) {
var ret = getObject(arg0).crypto;
return addHeapObject(ret);
};
export const __wbg_msCrypto_679be765111ba775 = function(arg0) {
var ret = getObject(arg0).msCrypto;
return addHeapObject(ret);
};
export const __wbg_getRandomValues_05a60bf171bfc2be = function(arg0) {
var ret = getObject(arg0).getRandomValues;
return addHeapObject(ret);
};
export const __wbg_getRandomValues_3ac1b33c90b52596 = function(arg0, arg1, arg2) {
getObject(arg0).getRandomValues(getArrayU8FromWasm0(arg1, arg2));
};
export const __wbg_randomFillSync_6f956029658662ec = function(arg0, arg1, arg2) {
getObject(arg0).randomFillSync(getArrayU8FromWasm0(arg1, arg2));
};
export const __wbindgen_string_get = function(arg0, arg1) {

@@ -631,10 +750,6 @@ const obj = getObject(arg1);

export const __wbindgen_rethrow = function(arg0) {
throw takeObject(arg0);
};
export const __wbindgen_closure_wrapper839 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 197, __wbg_adapter_18);
export const __wbindgen_closure_wrapper949 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 226, __wbg_adapter_24);
return addHeapObject(ret);
};

344

_esm/citeproc_rs_wasm.d.ts
/* tslint:disable */
/* eslint-disable */
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
export function parseStyleMetadata(style: string): WasmResult<StyleMeta>;
interface InitOptions {
/** A CSL style as an XML string */
style: string,
/** A Fetcher implementation for fetching locales.
*
* If not provided, then no locales can be fetched, and default-locale and localeOverride will
* not be respected; the only locale used will be the bundled en-US. */
fetcher?: Fetcher,
/** The output format for this driver instance */
format: "html" | "rtf" | "plain",
/** A locale to use instead of the style's default-locale.
*
* For dependent styles, use parseStyleMetadata to find out which locale it prefers, and pass
* in the parent style with a localeOverride set to that value.
*/
localeOverride?: string,
/** Disables sorting in the bibliography; items appear in cited order. */
bibliographyNoSort?: bool,
}
/** This interface lets citeproc retrieve locales or modules asynchronously,
according to which ones are needed. */
export interface Lifecycle {
export interface Fetcher {
/** Return locale XML for a particular locale. */

@@ -12,2 +41,4 @@ fetchLocale(lang: string): Promise<string>;

export type DateLiteral = { "literal": string; };

@@ -21,2 +52,4 @@ export type DateRaw = { "raw": string; };

/** Locator type, and a locator string */

@@ -29,24 +62,28 @@ export type Locator = {

export type CiteLocator = Locator | { locator: undefined; locators: Locator[] };
export type CiteLocator = Locator | { locator: undefined; locators: Locator[]; };
export type CiteMode = { mode?: "SuppressAuthor" | "AuthorOnly"; };
export type Cite<Affix = string> = {
export type Cite = {
id: string;
prefix?: Affix;
suffix?: Affix;
suppression?: "InText" | "Rest" | null;
} & Partial<CiteLocator>;
prefix?: string;
suffix?: string;
} & Partial<CiteLocator> & CiteMode;
export type ClusterNumber = {
note: number | [number, number]
} | {
inText: number
};
export type ClusterMode
= { mode: "Composite"; infix?: string; suppressFirst?: number; }
| { mode: "SuppressAuthor"; suppressFirst?: number; }
| { mode: "AuthorOnly"; }
| {};
export type Cluster = {
id: number;
id: string;
cites: Cite[];
};
} & ClusterMode;
export type PreviewCluster {
cites: Cite[];
} & ClusterMode;
export type ClusterPosition = {
id: number;
id: string;
/** Leaving off this field means this cluster is in-text. */

@@ -56,2 +93,4 @@ note?: number;

export type Reference = {

@@ -63,6 +102,8 @@ id: string;

export type CslType = "book" | "article" | "legal_case" | "article-journal";
export type CslType = "book" | "article" | "legal_case" | "article-journal" | string;
export interface BibliographyUpdate {
updatedEntries: { [key: string]: string };
updatedEntries: Map<string, string>;
entryIds?: string[];

@@ -72,26 +113,158 @@ }

export type UpdateSummary<Output = string> = {
clusters: [number, Output][];
clusters: [string, Output][];
bibliography?: BibliographyUpdate;
};
type InvalidCsl = {
severity: "Error" | "Warning";
type IncludeUncited = "None" | "All" | { Specific: string[] };
type BibEntry = {
id: string;
value: string;
};
type BibEntries = BibEntry[];
type FullRender = {
allClusters: Map<string, string>,
bibEntries: BibEntries,
};
type BibliographyMeta = {
maxOffset: number;
entrySpacing: number;
lineSpacing: number;
hangingIndent: boolean;
/** the second-field-align value of the CSL style */
secondFieldAlign: null | "flush" | "margin";
/** Format-specific metadata */
formatMeta: any,
};
type Severity = "Error" | "Warning";
interface InvalidCsl {
severity: Severity;
/** Relevant bytes in the provided XML */
range: {
start: number;
end: number;
start: number,
end: number,
};
message: string;
hint: string;
hint: string | undefined;
};
type ParseError = {
ParseError: string;
type StyleError = {
tag: "Invalid",
content: InvalidCsl[],
} | {
tag: "ParseError",
content: string,
} | {
/** Cannot use a dependent style to format citations, pass the parent style instead. */
tag: "DependentStyle",
content: {
requiredParent: string,
}
};
type Invalid = {
Invalid: InvalidCsl[];
type DriverError = {
tag: "UnknownOutputFormat",
content: string,
} | {
tag: "JsonError",
} | {
tag: "GetFetcherError",
} | {
tag: "NonExistentCluster",
content: string,
} | {
tag: "ReorderingError"
} | {
tag: "ReorderingErrorNumericId"
};
type StyleError = Partial<ParseError & Invalid>;
type IncludeUncited = "None" | "All" | { Specific: string[] };
declare global {
/** Catch-all citeproc-rs Error subclass. */
declare class CiteprocRsError extends Error {
constructor(message: string);
}
declare class CiteprocRsDriverError extends CiteprocRsError {
data: DriverError;
constructor(message: string, data: DriverError);
}
declare class CslStyleError extends CiteprocRsError {
data: StyleError;
constructor(message: string, data: StyleError);
}
}
interface WasmResult<T> {
/** If this is an error, throws the error. */
unwrap(): T;
/** If this is an error, returns it, else throws. */
unwrap_err(): Error;
is_ok(): boolean;
is_err(): boolean;
/** If this is an error, returns the default value. */
unwrap_or(default: T): T;
/** If this is Ok, returns f(ok_val), else returns Err unmodified. */
map<R>(f: (t: T) => R): WasmResult<T>;
/** If this is Ok, returns f(ok_val), else returns the default value. */
map_or<R>(default: R, f: (t: T) => R): R;
}
type CitationFormat = "author-date" | "author" | "numeric" | "label" | "note";
interface LocalizedString {
value: string,
lang?: string,
}
interface ParentLink {
href: string,
lang?: string,
}
interface Link {
href: string,
rel: "self" | "documentation" | "template",
lang?: string,
}
interface Rights {
value: string,
lang?: string,
license?: string,
}
interface StyleInfo {
id: string,
updated: string,
title: LocalizedString,
titleShort?: LocalizedString,
parent?: ParentLink,
links: Link[],
rights?: Rights,
citationFormat?: CitationFormat,
categories: string[],
issn?: string,
eissn?: string,
issnl?: string,
}
interface IndependentMeta {
/** A list of languages for which a locale override was specified.
* Does not include the language-less final override. */
localeOverrides: string[],
hasBibliography: bool,
}
interface StyleMeta {
info: StyleInfo,
features: { [feature: string]: bool },
defaultLocale: string,
/** May be absent on a dependent style */
class?: "in-text" | "note",
cslVersionRequired: string,
/** May be absent on a dependent style */
independentMeta?: IndependentMeta,
};
/**

@@ -105,18 +278,16 @@ */

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style: string, lifecycle: any, format: string): Driver;
static new(options: InitOptions): WasmResult<Driver>;
/**
* Sets the style (which will also cause everything to be recomputed)
* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/
setStyle(style_text: string): any;
setStyle(style_text: string): WasmResult<undefined>;
/**

@@ -126,4 +297,5 @@ * Completely overwrites the references library.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
resetReferences(refs: any[]): void;
resetReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -133,4 +305,5 @@ * Inserts or overwrites references as a batch operation.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
insertReferences(refs: any[]): void;
insertReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -141,4 +314,5 @@ * Inserts or overwrites a reference.

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr: Reference): void;
insertReference(refr: Reference): WasmResult<undefined>;
/**

@@ -148,4 +322,5 @@ * Removes a reference by id. If it is cited, any cites will be dangling. It will also

* @param {string} id
* @returns {WasmResult<undefined>}
*/
removeReference(id: string): void;
removeReference(id: string): WasmResult<undefined>;
/**

@@ -156,4 +331,5 @@ * Sets the references to be included in the bibliography despite not being directly cited.

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited: IncludeUncited): void;
includeUncited(uncited: IncludeUncited): WasmResult<undefined>;
/**

@@ -163,15 +339,22 @@ * Gets a list of locales in use by the references currently loaded.

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/
toFetch(): any;
toFetch(): WasmResult<string[]>;
/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId(): string;
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id: any): void;
insertCluster(cluster: Cluster): WasmResult<undefined>;
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id: number): void;
removeCluster(cluster_id: string): WasmResult<undefined>;
/**

@@ -182,4 +365,5 @@ * Resets all the clusters in the processor to a new list.

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/
initClusters(clusters: any[]): void;
initClusters(clusters: any[]): WasmResult<undefined>;
/**

@@ -190,6 +374,6 @@ * Returns the formatted citation cluster for `cluster_id`.

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id: number): any;
builtCluster(id: string): WasmResult<string>;
/**

@@ -206,37 +390,14 @@ * Previews a formatted citation cluster, in a particular position.

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/
previewCitationCluster(cites: any[], positions: any[], format: string): any;
previewCitationCluster(cites: any[], positions: any[], format: string): WasmResult<string>;
/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/
makeBibliography(): any;
makeBibliography(): WasmResult<BibEntries>;
/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/
bibliographyMeta(): any;
bibliographyMeta(): WasmResult<BibliographyMeta>;
/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings: any[]): void;
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -266,4 +427,5 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/
setClusterOrder(positions: any[]): void;
setClusterOrder(positions: any[]): WasmResult<undefined>;
/**

@@ -277,16 +439,22 @@ * Retrieve any clusters that have been touched since last time `batchedUpdates` was

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/
batchedUpdates(): UpdateSummary;
batchedUpdates(): WasmResult<UpdateSummary>;
/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender(): WasmResult<FullRender>;
/**
* Drains the `batchedUpdates` queue manually.
*/
drain(): void;
/**
* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll(): Promise<any>;
fetchLocales(): Promise<any>;
}

378

_web/citeproc_rs_wasm.d.ts
/* tslint:disable */
/* eslint-disable */
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
export function parseStyleMetadata(style: string): WasmResult<StyleMeta>;
interface InitOptions {
/** A CSL style as an XML string */
style: string,
/** A Fetcher implementation for fetching locales.
*
* If not provided, then no locales can be fetched, and default-locale and localeOverride will
* not be respected; the only locale used will be the bundled en-US. */
fetcher?: Fetcher,
/** The output format for this driver instance */
format: "html" | "rtf" | "plain",
/** A locale to use instead of the style's default-locale.
*
* For dependent styles, use parseStyleMetadata to find out which locale it prefers, and pass
* in the parent style with a localeOverride set to that value.
*/
localeOverride?: string,
/** Disables sorting in the bibliography; items appear in cited order. */
bibliographyNoSort?: bool,
}
/** This interface lets citeproc retrieve locales or modules asynchronously,
according to which ones are needed. */
export interface Lifecycle {
export interface Fetcher {
/** Return locale XML for a particular locale. */

@@ -12,2 +41,4 @@ fetchLocale(lang: string): Promise<string>;

export type DateLiteral = { "literal": string; };

@@ -21,2 +52,4 @@ export type DateRaw = { "raw": string; };

/** Locator type, and a locator string */

@@ -29,24 +62,28 @@ export type Locator = {

export type CiteLocator = Locator | { locator: undefined; locators: Locator[] };
export type CiteLocator = Locator | { locator: undefined; locators: Locator[]; };
export type CiteMode = { mode?: "SuppressAuthor" | "AuthorOnly"; };
export type Cite<Affix = string> = {
export type Cite = {
id: string;
prefix?: Affix;
suffix?: Affix;
suppression?: "InText" | "Rest" | null;
} & Partial<CiteLocator>;
prefix?: string;
suffix?: string;
} & Partial<CiteLocator> & CiteMode;
export type ClusterNumber = {
note: number | [number, number]
} | {
inText: number
};
export type ClusterMode
= { mode: "Composite"; infix?: string; suppressFirst?: number; }
| { mode: "SuppressAuthor"; suppressFirst?: number; }
| { mode: "AuthorOnly"; }
| {};
export type Cluster = {
id: number;
id: string;
cites: Cite[];
};
} & ClusterMode;
export type PreviewCluster {
cites: Cite[];
} & ClusterMode;
export type ClusterPosition = {
id: number;
id: string;
/** Leaving off this field means this cluster is in-text. */

@@ -56,2 +93,4 @@ note?: number;

export type Reference = {

@@ -63,6 +102,8 @@ id: string;

export type CslType = "book" | "article" | "legal_case" | "article-journal";
export type CslType = "book" | "article" | "legal_case" | "article-journal" | string;
export interface BibliographyUpdate {
updatedEntries: { [key: string]: string };
updatedEntries: Map<string, string>;
entryIds?: string[];

@@ -72,26 +113,158 @@ }

export type UpdateSummary<Output = string> = {
clusters: [number, Output][];
clusters: [string, Output][];
bibliography?: BibliographyUpdate;
};
type InvalidCsl = {
severity: "Error" | "Warning";
type IncludeUncited = "None" | "All" | { Specific: string[] };
type BibEntry = {
id: string;
value: string;
};
type BibEntries = BibEntry[];
type FullRender = {
allClusters: Map<string, string>,
bibEntries: BibEntries,
};
type BibliographyMeta = {
maxOffset: number;
entrySpacing: number;
lineSpacing: number;
hangingIndent: boolean;
/** the second-field-align value of the CSL style */
secondFieldAlign: null | "flush" | "margin";
/** Format-specific metadata */
formatMeta: any,
};
type Severity = "Error" | "Warning";
interface InvalidCsl {
severity: Severity;
/** Relevant bytes in the provided XML */
range: {
start: number;
end: number;
start: number,
end: number,
};
message: string;
hint: string;
hint: string | undefined;
};
type ParseError = {
ParseError: string;
type StyleError = {
tag: "Invalid",
content: InvalidCsl[],
} | {
tag: "ParseError",
content: string,
} | {
/** Cannot use a dependent style to format citations, pass the parent style instead. */
tag: "DependentStyle",
content: {
requiredParent: string,
}
};
type Invalid = {
Invalid: InvalidCsl[];
type DriverError = {
tag: "UnknownOutputFormat",
content: string,
} | {
tag: "JsonError",
} | {
tag: "GetFetcherError",
} | {
tag: "NonExistentCluster",
content: string,
} | {
tag: "ReorderingError"
} | {
tag: "ReorderingErrorNumericId"
};
type StyleError = Partial<ParseError & Invalid>;
type IncludeUncited = "None" | "All" | { Specific: string[] };
declare global {
/** Catch-all citeproc-rs Error subclass. */
declare class CiteprocRsError extends Error {
constructor(message: string);
}
declare class CiteprocRsDriverError extends CiteprocRsError {
data: DriverError;
constructor(message: string, data: DriverError);
}
declare class CslStyleError extends CiteprocRsError {
data: StyleError;
constructor(message: string, data: StyleError);
}
}
interface WasmResult<T> {
/** If this is an error, throws the error. */
unwrap(): T;
/** If this is an error, returns it, else throws. */
unwrap_err(): Error;
is_ok(): boolean;
is_err(): boolean;
/** If this is an error, returns the default value. */
unwrap_or(default: T): T;
/** If this is Ok, returns f(ok_val), else returns Err unmodified. */
map<R>(f: (t: T) => R): WasmResult<T>;
/** If this is Ok, returns f(ok_val), else returns the default value. */
map_or<R>(default: R, f: (t: T) => R): R;
}
type CitationFormat = "author-date" | "author" | "numeric" | "label" | "note";
interface LocalizedString {
value: string,
lang?: string,
}
interface ParentLink {
href: string,
lang?: string,
}
interface Link {
href: string,
rel: "self" | "documentation" | "template",
lang?: string,
}
interface Rights {
value: string,
lang?: string,
license?: string,
}
interface StyleInfo {
id: string,
updated: string,
title: LocalizedString,
titleShort?: LocalizedString,
parent?: ParentLink,
links: Link[],
rights?: Rights,
citationFormat?: CitationFormat,
categories: string[],
issn?: string,
eissn?: string,
issnl?: string,
}
interface IndependentMeta {
/** A list of languages for which a locale override was specified.
* Does not include the language-less final override. */
localeOverrides: string[],
hasBibliography: bool,
}
interface StyleMeta {
info: StyleInfo,
features: { [feature: string]: bool },
defaultLocale: string,
/** May be absent on a dependent style */
class?: "in-text" | "note",
cslVersionRequired: string,
/** May be absent on a dependent style */
independentMeta?: IndependentMeta,
};
/**

@@ -105,18 +278,16 @@ */

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style: string, lifecycle: any, format: string): Driver;
static new(options: InitOptions): WasmResult<Driver>;
/**
* Sets the style (which will also cause everything to be recomputed)
* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/
setStyle(style_text: string): any;
setStyle(style_text: string): WasmResult<undefined>;
/**

@@ -126,4 +297,5 @@ * Completely overwrites the references library.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
resetReferences(refs: any[]): void;
resetReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -133,4 +305,5 @@ * Inserts or overwrites references as a batch operation.

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/
insertReferences(refs: any[]): void;
insertReferences(refs: any[]): WasmResult<undefined>;
/**

@@ -141,4 +314,5 @@ * Inserts or overwrites a reference.

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr: Reference): void;
insertReference(refr: Reference): WasmResult<undefined>;
/**

@@ -148,4 +322,5 @@ * Removes a reference by id. If it is cited, any cites will be dangling. It will also

* @param {string} id
* @returns {WasmResult<undefined>}
*/
removeReference(id: string): void;
removeReference(id: string): WasmResult<undefined>;
/**

@@ -156,4 +331,5 @@ * Sets the references to be included in the bibliography despite not being directly cited.

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited: IncludeUncited): void;
includeUncited(uncited: IncludeUncited): WasmResult<undefined>;
/**

@@ -163,15 +339,22 @@ * Gets a list of locales in use by the references currently loaded.

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/
toFetch(): any;
toFetch(): WasmResult<string[]>;
/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId(): string;
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id: any): void;
insertCluster(cluster: Cluster): WasmResult<undefined>;
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id: number): void;
removeCluster(cluster_id: string): WasmResult<undefined>;
/**

@@ -182,4 +365,5 @@ * Resets all the clusters in the processor to a new list.

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/
initClusters(clusters: any[]): void;
initClusters(clusters: any[]): WasmResult<undefined>;
/**

@@ -190,6 +374,6 @@ * Returns the formatted citation cluster for `cluster_id`.

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id: number): any;
builtCluster(id: string): WasmResult<string>;
/**

@@ -206,37 +390,14 @@ * Previews a formatted citation cluster, in a particular position.

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/
previewCitationCluster(cites: any[], positions: any[], format: string): any;
previewCitationCluster(cites: any[], positions: any[], format: string): WasmResult<string>;
/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/
makeBibliography(): any;
makeBibliography(): WasmResult<BibEntries>;
/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/
bibliographyMeta(): any;
bibliographyMeta(): WasmResult<BibliographyMeta>;
/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings: any[]): void;
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -266,4 +427,5 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/
setClusterOrder(positions: any[]): void;
setClusterOrder(positions: any[]): WasmResult<undefined>;
/**

@@ -277,16 +439,22 @@ * Retrieve any clusters that have been touched since last time `batchedUpdates` was

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/
batchedUpdates(): UpdateSummary;
batchedUpdates(): WasmResult<UpdateSummary>;
/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender(): WasmResult<FullRender>;
/**
* Drains the `batchedUpdates` queue manually.
*/
drain(): void;
/**
* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll(): Promise<any>;
fetchLocales(): Promise<any>;
}

@@ -298,30 +466,33 @@

readonly memory: WebAssembly.Memory;
readonly parseStyleMetadata: (a: number, b: number) => number;
readonly __wbg_driver_free: (a: number) => void;
readonly driver_new: (a: number, b: number, c: number, d: number, e: number) => number;
readonly driver_new: (a: number) => number;
readonly driver_setStyle: (a: number, b: number, c: number) => number;
readonly driver_resetReferences: (a: number, b: number, c: number) => void;
readonly driver_insertReferences: (a: number, b: number, c: number) => void;
readonly driver_insertReference: (a: number, b: number) => void;
readonly driver_removeReference: (a: number, b: number, c: number) => void;
readonly driver_includeUncited: (a: number, b: number) => void;
readonly driver_resetReferences: (a: number, b: number, c: number) => number;
readonly driver_insertReferences: (a: number, b: number, c: number) => number;
readonly driver_insertReference: (a: number, b: number) => number;
readonly driver_removeReference: (a: number, b: number, c: number) => number;
readonly driver_includeUncited: (a: number, b: number) => number;
readonly driver_toFetch: (a: number) => number;
readonly driver_insertCluster: (a: number, b: number) => void;
readonly driver_removeCluster: (a: number, b: number) => void;
readonly driver_initClusters: (a: number, b: number, c: number) => void;
readonly driver_builtCluster: (a: number, b: number) => number;
readonly driver_randomClusterId: (a: number, b: number) => void;
readonly driver_insertCluster: (a: number, b: number) => number;
readonly driver_removeCluster: (a: number, b: number, c: number) => number;
readonly driver_initClusters: (a: number, b: number, c: number) => number;
readonly driver_builtCluster: (a: number, b: number, c: number) => number;
readonly driver_previewCitationCluster: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => number;
readonly driver_makeBibliography: (a: number) => number;
readonly driver_bibliographyMeta: (a: number) => number;
readonly driver_renumberClusters: (a: number, b: number, c: number) => void;
readonly driver_setClusterOrder: (a: number, b: number, c: number) => void;
readonly driver_setClusterOrder: (a: number, b: number, c: number) => number;
readonly driver_batchedUpdates: (a: number) => number;
readonly driver_fullRender: (a: number) => number;
readonly driver_drain: (a: number) => void;
readonly driver_fetchAll: (a: number) => number;
readonly driver_fetchLocales: (a: number) => number;
readonly __wbindgen_malloc: (a: number) => number;
readonly __wbindgen_realloc: (a: number, b: number, c: number) => number;
readonly __wbindgen_export_2: WebAssembly.Table;
readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf77188239a1f71cd: (a: number, b: number, c: number) => void;
readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h2b1b33880a98c55e: (a: number, b: number, c: number) => void;
readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
readonly __wbindgen_free: (a: number, b: number) => void;
readonly __wbindgen_exn_store: (a: number) => void;
readonly wasm_bindgen__convert__closures__invoke2_mut__h19f62226ce422262: (a: number, b: number, c: number, d: number) => void;
readonly wasm_bindgen__convert__closures__invoke2_mut__h4915090d68cfd6bd: (a: number, b: number, c: number, d: number) => void;
}

@@ -338,2 +509,1 @@

export default function init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;

335

_web/citeproc_rs_wasm.js

@@ -0,1 +1,2 @@

import { WasmResult, CiteprocRsError, CiteprocRsDriverError, CslStyleError } from './snippets/wasm-1883a0b9dcad429e/src/js/include.js';

@@ -10,16 +11,2 @@ let wasm;

let heap_next = heap.length;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
}
let WASM_VECTOR_LEN = 0;

@@ -96,11 +83,16 @@

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
let heap_next = heap.length;
heap[idx] = obj;
return idx;
function dropObject(idx) {
if (idx < 36) return;
heap[idx] = heap_next;
heap_next = idx;
}
function takeObject(idx) {
const ret = getObject(idx);
dropObject(idx);
return ret;
}
let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });

@@ -114,2 +106,11 @@

function addHeapObject(obj) {
if (heap_next === heap.length) heap.push(heap.length + 1);
const idx = heap_next;
heap_next = heap[idx];
heap[idx] = obj;
return idx;
}
function isLikeNone(x) {

@@ -143,6 +144,18 @@ return x === undefined || x === null;

}
function __wbg_adapter_18(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf77188239a1f71cd(arg0, arg1, addHeapObject(arg2));
function __wbg_adapter_24(arg0, arg1, arg2) {
wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h2b1b33880a98c55e(arg0, arg1, addHeapObject(arg2));
}
/**
* Parses a CSL style, either independent or dependent, and returns its metadata.
* @param {string} style
* @returns {WasmResult<StyleMeta>}
*/
export function parseStyleMetadata(style) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.parseStyleMetadata(ptr0, len0);
return takeObject(ret);
}
let cachegetUint32Memory0 = null;

@@ -176,6 +189,9 @@ function getUint32Memory0() {

}
function __wbg_adapter_63(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h19f62226ce422262(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
function __wbg_adapter_81(arg0, arg1, arg2, arg3) {
wasm.wasm_bindgen__convert__closures__invoke2_mut__h4915090d68cfd6bd(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
}
function getArrayU8FromWasm0(ptr, len) {
return getUint8Memory0().subarray(ptr / 1, ptr / 1 + len);
}
/**

@@ -192,6 +208,11 @@ */

free() {
__destroy_into_raw() {
const ptr = this.ptr;
this.ptr = 0;
return ptr;
}
free() {
const ptr = this.__destroy_into_raw();
wasm.__wbg_driver_free(ptr);

@@ -203,18 +224,12 @@ }

* * `style` is a CSL style as a string. Independent styles only.
* * `lifecycle` must implement the `Lifecycle` interface
* * `fetcher` must implement the `Fetcher` interface
* * `format` is one of { "html", "rtf" }
*
* Throws an error if it cannot parse the style you gave it.
* @param {string} style
* @param {any} lifecycle
* @param {string} format
* @returns {Driver}
* @param {InitOptions} options
* @returns {WasmResult<Driver>}
*/
static new(style, lifecycle, format) {
var ptr0 = passStringToWasm0(style, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ptr1 = passStringToWasm0(format, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len1 = WASM_VECTOR_LEN;
var ret = wasm.driver_new(ptr0, len0, addHeapObject(lifecycle), ptr1, len1);
return Driver.__wrap(ret);
static new(options) {
var ret = wasm.driver_new(addHeapObject(options));
return takeObject(ret);
}

@@ -224,3 +239,3 @@ /**

* @param {string} style_text
* @returns {any}
* @returns {WasmResult<undefined>}
*/

@@ -237,2 +252,3 @@ setStyle(style_text) {

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -242,3 +258,4 @@ resetReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_resetReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_resetReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -249,2 +266,3 @@ /**

* @param {any[]} refs
* @returns {WasmResult<undefined>}
*/

@@ -254,3 +272,4 @@ insertReferences(refs) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_insertReferences(this.ptr, ptr0, len0);
var ret = wasm.driver_insertReferences(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -262,5 +281,7 @@ /**

* @param {Reference} refr
* @returns {WasmResult<undefined>}
*/
insertReference(refr) {
wasm.driver_insertReference(this.ptr, addHeapObject(refr));
var ret = wasm.driver_insertReference(this.ptr, addHeapObject(refr));
return takeObject(ret);
}

@@ -271,2 +292,3 @@ /**

* @param {string} id
* @returns {WasmResult<undefined>}
*/

@@ -276,3 +298,4 @@ removeReference(id) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_removeReference(this.ptr, ptr0, len0);
var ret = wasm.driver_removeReference(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -284,5 +307,7 @@ /**

* @param {IncludeUncited} uncited
* @returns {WasmResult<undefined>}
*/
includeUncited(uncited) {
wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
var ret = wasm.driver_includeUncited(this.ptr, addHeapObject(uncited));
return takeObject(ret);
}

@@ -293,3 +318,3 @@ /**

* Note that Driver comes pre-loaded with the `en-US` locale.
* @returns {any}
* @returns {WasmResult<string[]>}
*/

@@ -301,14 +326,36 @@ toFetch() {

/**
* Returns a random cluster id, with an extra guarantee that it isn't already in use.
* @returns {string}
*/
randomClusterId() {
try {
const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
wasm.driver_randomClusterId(retptr, this.ptr);
var r0 = getInt32Memory0()[retptr / 4 + 0];
var r1 = getInt32Memory0()[retptr / 4 + 1];
return getStringFromWasm0(r0, r1);
} finally {
wasm.__wbindgen_add_to_stack_pointer(16);
wasm.__wbindgen_free(r0, r1);
}
}
/**
* Inserts or replaces a cluster with a matching `id`.
* @param {any} cluster_id
* @param {Cluster} cluster
* @returns {WasmResult<undefined>}
*/
insertCluster(cluster_id) {
wasm.driver_insertCluster(this.ptr, addHeapObject(cluster_id));
insertCluster(cluster) {
var ret = wasm.driver_insertCluster(this.ptr, addHeapObject(cluster));
return takeObject(ret);
}
/**
* Removes a cluster with a matching `id`
* @param {number} cluster_id
* @param {string} cluster_id
* @returns {WasmResult<undefined>}
*/
removeCluster(cluster_id) {
wasm.driver_removeCluster(this.ptr, cluster_id);
var ptr0 = passStringToWasm0(cluster_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_removeCluster(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -320,2 +367,3 @@ /**

* @param {any[]} clusters
* @returns {WasmResult<undefined>}
*/

@@ -325,3 +373,4 @@ initClusters(clusters) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_initClusters(this.ptr, ptr0, len0);
var ret = wasm.driver_initClusters(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -333,7 +382,9 @@ /**

* still useful for initialization.
* @param {number} id
* @returns {any}
* @param {string} id
* @returns {WasmResult<string>}
*/
builtCluster(id) {
var ret = wasm.driver_builtCluster(this.ptr, id);
var ptr0 = passStringToWasm0(id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
var len0 = WASM_VECTOR_LEN;
var ret = wasm.driver_builtCluster(this.ptr, ptr0, len0);
return takeObject(ret);

@@ -352,3 +403,3 @@ }

* @param {string} format
* @returns {any}
* @returns {WasmResult<string>}
*/

@@ -366,3 +417,3 @@ previewCitationCluster(cites, positions, format) {

/**
* @returns {any}
* @returns {WasmResult<BibEntries>}
*/

@@ -374,3 +425,3 @@ makeBibliography() {

/**
* @returns {any}
* @returns {WasmResult<BibliographyMeta>}
*/

@@ -382,29 +433,2 @@ bibliographyMeta() {

/**
* Replaces cluster numberings in one go.
*
* * `mappings` is an `Array<[ ClusterId, ClusterNumber ]>` where `ClusterNumber`
* is, e.g. `{ note: 1 }`, `{ note: [3, 1] }` or `{ inText: 5 }` in the same way a
* Cluster must contain one of those three numberings.
*
* Not every ClusterId must appear in the array, just the ones you wish to renumber.
*
* The library consumer is responsible for ensuring that clusters are well-ordered. Clusters
* are sorted for determining cite positions (ibid, subsequent, etc). If a footnote is
* deleted, you will likely need to shift all cluster numbers after it back by one.
*
* The second note numbering, `{note: [3, 1]}`, is for having multiple clusters in a single
* footnote. This is possible in many editors. The second number acts as a second sorting
* key.
*
* The third note numbering, `{ inText: 5 }`, is for ordering in-text references that appear
* within the body of a document. These will be sorted but won't cause
* `first-reference-note-number` to become available.
* @param {any[]} mappings
*/
renumberClusters(mappings) {
var ptr0 = passArrayJsValueToWasm0(mappings, wasm.__wbindgen_malloc);
var len0 = WASM_VECTOR_LEN;
wasm.driver_renumberClusters(this.ptr, ptr0, len0);
}
/**
* Specifies which clusters are actually considered to be in the document, and sets their

@@ -434,2 +458,3 @@ * order. You may insert as many clusters as you like, but the ones provided here are the only

* @param {any[]} positions
* @returns {WasmResult<undefined>}
*/

@@ -439,3 +464,4 @@ setClusterOrder(positions) {

var len0 = WASM_VECTOR_LEN;
wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
var ret = wasm.driver_setClusterOrder(this.ptr, ptr0, len0);
return takeObject(ret);
}

@@ -450,3 +476,3 @@ /**

* * returns an `UpdateSummary`
* @returns {UpdateSummary}
* @returns {WasmResult<UpdateSummary>}
*/

@@ -458,5 +484,14 @@ batchedUpdates() {

/**
* Drains the `batchedUpdates` queue manually. Use it to avoid serializing an unneeded
* `UpdateSummary`.
* Returns all the clusters and bibliography entries in the document.
* Also drains the queue, just like batchedUpdates().
* Use this to rehydrate a document or run non-interactively.
* @returns {WasmResult<FullRender>}
*/
fullRender() {
var ret = wasm.driver_fullRender(this.ptr);
return takeObject(ret);
}
/**
* Drains the `batchedUpdates` queue manually.
*/
drain() {

@@ -467,7 +502,7 @@ wasm.driver_drain(this.ptr);

* Asynchronously fetches all the locales that may be required, and saves them into the
* engine. Uses your provided `Lifecycle.fetchLocale` function.
* engine. Uses your provided `Fetcher.fetchLocale` function.
* @returns {Promise<any>}
*/
fetchAll() {
var ret = wasm.driver_fetchAll(this.ptr);
fetchLocales() {
var ret = wasm.driver_fetchLocales(this.ptr);
return takeObject(ret);

@@ -479,3 +514,2 @@ }

if (typeof Response === 'function' && module instanceof Response) {
if (typeof WebAssembly.instantiateStreaming === 'function') {

@@ -499,3 +533,2 @@ try {

} else {
const instance = await WebAssembly.instantiate(module, imports);

@@ -514,9 +547,6 @@

if (typeof input === 'undefined') {
input = import.meta.url.replace(/\.js$/, '_bg.wasm');
input = new URL('citeproc_rs_wasm_bg.wasm', import.meta.url);
}
const imports = {};
imports.wbg = {};
imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};
imports.wbg.__wbindgen_json_serialize = function(arg0, arg1) {

@@ -530,10 +560,9 @@ const obj = getObject(arg1);

};
imports.wbg.__wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
return addHeapObject(ret);
};
imports.wbg.__wbg_fetchLocale_8f52b973b0739a6c = function(arg0, arg1, arg2) {
imports.wbg.__wbg_fetchLocale_d644d4ae2ca50f81 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).fetchLocale(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
takeObject(arg0);
};
imports.wbg.__wbg_error_e549f7fed6d655aa = function(arg0) {

@@ -557,6 +586,10 @@ console.error(takeObject(arg0));

};
imports.wbg.__wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
imports.wbg.__wbg_get_1edc26456ed84f9b = function(arg0, arg1) {
var ret = getObject(arg0)[takeObject(arg1)];
return addHeapObject(ret);
};
imports.wbg.__wbindgen_string_new = function(arg0, arg1) {
var ret = getStringFromWasm0(arg0, arg1);
return addHeapObject(ret);
};
imports.wbg.__wbindgen_cb_drop = function(arg0) {

@@ -571,2 +604,43 @@ const obj = takeObject(arg0).original;

};
imports.wbg.__wbindgen_json_parse = function(arg0, arg1) {
var ret = JSON.parse(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
imports.wbg.__wbg_driver_new = function(arg0) {
var ret = Driver.__wrap(arg0);
return addHeapObject(ret);
};
imports.wbg.__wbg_new_f12987d5c30f0ab7 = function(arg0) {
var ret = new CiteprocRsError(takeObject(arg0));
return addHeapObject(ret);
};
imports.wbg.__wbg_new_c5e56e6577bc2b6a = function(arg0, arg1) {
var ret = new CslStyleError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
imports.wbg.__wbg_new_6edca5ab9ee61764 = function(arg0) {
var ret = new WasmResult(takeObject(arg0));
return addHeapObject(ret);
};
imports.wbg.__wbg_new_8d5f3cd64eaaa8b5 = function(arg0, arg1) {
var ret = new CiteprocRsDriverError(takeObject(arg0), takeObject(arg1));
return addHeapObject(ret);
};
imports.wbg.__wbindgen_object_clone_ref = function(arg0) {
var ret = getObject(arg0);
return addHeapObject(ret);
};
imports.wbg.__wbindgen_is_undefined = function(arg0) {
var ret = getObject(arg0) === undefined;
return ret;
};
imports.wbg.__wbindgen_is_object = function(arg0) {
const val = getObject(arg0);
var ret = typeof(val) === 'object' && val !== null;
return ret;
};
imports.wbg.__wbindgen_is_function = function(arg0) {
var ret = typeof(getObject(arg0)) === 'function';
return ret;
};
imports.wbg.__wbg_new_59cb74e423758ede = function() {

@@ -590,11 +664,7 @@ var ret = new Error();

};
imports.wbg.__wbg_new_4896ab6bba55e0d9 = function(arg0, arg1) {
var ret = new Error(getStringFromWasm0(arg0, arg1));
return addHeapObject(ret);
};
imports.wbg.__wbg_call_0dad7db75ec90ae7 = handleError(function(arg0, arg1, arg2) {
imports.wbg.__wbg_call_f5e0576f61ee7461 = handleError(function(arg0, arg1, arg2) {
var ret = getObject(arg0).call(getObject(arg1), getObject(arg2));
return addHeapObject(ret);
});
imports.wbg.__wbg_new_7039bf8b99f049e1 = function(arg0, arg1) {
imports.wbg.__wbg_new_3ea8490cd276c848 = function(arg0, arg1) {
try {

@@ -606,3 +676,3 @@ var state0 = {a: arg0, b: arg1};

try {
return __wbg_adapter_63(a, state0.b, arg0, arg1);
return __wbg_adapter_81(a, state0.b, arg0, arg1);
} finally {

@@ -618,14 +688,44 @@ state0.a = a;

};
imports.wbg.__wbg_resolve_4df26938859b92e3 = function(arg0) {
imports.wbg.__wbg_resolve_778af3f90b8e2b59 = function(arg0) {
var ret = Promise.resolve(getObject(arg0));
return addHeapObject(ret);
};
imports.wbg.__wbg_then_ffb6e71f7a6735ad = function(arg0, arg1) {
imports.wbg.__wbg_then_367b3e718069cfb9 = function(arg0, arg1) {
var ret = getObject(arg0).then(getObject(arg1));
return addHeapObject(ret);
};
imports.wbg.__wbg_then_021fcdc7f0350b58 = function(arg0, arg1, arg2) {
imports.wbg.__wbg_then_ac66ca61394bfd21 = function(arg0, arg1, arg2) {
var ret = getObject(arg0).then(getObject(arg1), getObject(arg2));
return addHeapObject(ret);
};
imports.wbg.__wbg_self_1c83eb4471d9eb9b = handleError(function() {
var ret = self.self;
return addHeapObject(ret);
});
imports.wbg.__wbg_static_accessor_MODULE_abf5ae284bffdf45 = function() {
var ret = module;
return addHeapObject(ret);
};
imports.wbg.__wbg_require_5b2b5b594d809d9f = function(arg0, arg1, arg2) {
var ret = getObject(arg0).require(getStringFromWasm0(arg1, arg2));
return addHeapObject(ret);
};
imports.wbg.__wbg_crypto_c12f14e810edcaa2 = function(arg0) {
var ret = getObject(arg0).crypto;
return addHeapObject(ret);
};
imports.wbg.__wbg_msCrypto_679be765111ba775 = function(arg0) {
var ret = getObject(arg0).msCrypto;
return addHeapObject(ret);
};
imports.wbg.__wbg_getRandomValues_05a60bf171bfc2be = function(arg0) {
var ret = getObject(arg0).getRandomValues;
return addHeapObject(ret);
};
imports.wbg.__wbg_getRandomValues_3ac1b33c90b52596 = function(arg0, arg1, arg2) {
getObject(arg0).getRandomValues(getArrayU8FromWasm0(arg1, arg2));
};
imports.wbg.__wbg_randomFillSync_6f956029658662ec = function(arg0, arg1, arg2) {
getObject(arg0).randomFillSync(getArrayU8FromWasm0(arg1, arg2));
};
imports.wbg.__wbindgen_string_get = function(arg0, arg1) {

@@ -642,7 +742,4 @@ const obj = getObject(arg1);

};
imports.wbg.__wbindgen_rethrow = function(arg0) {
throw takeObject(arg0);
};
imports.wbg.__wbindgen_closure_wrapper839 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 197, __wbg_adapter_18);
imports.wbg.__wbindgen_closure_wrapper949 = function(arg0, arg1, arg2) {
var ret = makeMutClosure(arg0, arg1, 226, __wbg_adapter_24);
return addHeapObject(ret);

@@ -655,2 +752,4 @@ };

const { instance, module } = await load(await input, imports);

@@ -657,0 +756,0 @@

4

package.json

@@ -7,3 +7,3 @@ {

"description": "citeproc-rs, compiled to WebAssembly",
"version": "0.0.0-canary-7bb4807",
"version": "0.0.0-canary-7e0838c",
"license": "MPL-2.0",

@@ -18,2 +18,4 @@ "repository": {

"_web/*",
"_no_modules/*",
"_zotero/*",
"README.md"

@@ -20,0 +22,0 @@ ],

638

README.md
# `@citeproc-rs/wasm`
This is a build of `citeproc` that is suitable for use in Node.js, a browser or
a Firefox/Chromium-based application like Zotero. It consists of a WebAssembly
(WASM) binary, and a fairly lightweight JavaScript wrapper for that binary.
This is a front-end to
[`citeproc-rs`](https://github.com/cormacrelf/citeproc-rs), a citation
processor written in Rust and compiled to WebAssembly.
README for newer version of the API forthcoming.
It contains builds appropriate for:
- Node.js
- Browsers, using a bundler like Webpack.js
- Browsers directly importing an ES Module from a webserver
## Installation / Release channels
There are two release channels:
**Stable** is each versioned release. (*At the time of writing, there are no
versioned releases.*) Install with:
```sh
yarn add @citeproc-rs/wasm
```
**Canary** tracks the master branch [on
GitHub](https://github.com/cormacrelf/citeproc-rs). Its version numbers follow
the format `0.0.0-canary-GIT_COMMIT_SHA`, so version ranges in your
`package.json` are not meaningful. But you can install the latest one with:
```sh
yarn add @citeproc-rs/wasm@canary
# alternatively, a specific commit
yarn add @citeproc-rs/wasm@0.0.0-canary-COMMIT_SHA
```
If you use NPM, replace `yarn add` with `npm install`.
### Including in your project
For Node.js, simply import the package as normal. Typescript definitions are
provided, though parts of the API that cannot have auto-generated type
definitions are alluded to in doc comments with an accompanying type you can
import.
```
// Node.js
const { Driver } = require("@citeproc-rs/wasm");
```
##### Microsoft Edge
Note the caveats in around Microsoft Edge's TextEncoder/TextDecoder support in
[the wasm-bindgen
tutorial](https://rustwasm.github.io/docs/wasm-bindgen/examples/hello-world.html).
#### Using Webpack
When loading on the web, for technical reasons and because the compiled
WebAssembly is large, you must load the package asynchronously. Webpack comes
with the ability to import packages asynchronously like so:
```javascript
// Webpack
import("@citeproc-rs/wasm")
.then(go)
.catch(console.error);
function go(wasm) {
const { Driver } = wasm;
// use Driver
}
```
When you do this, your code will trigger a download (and streaming parse) of
the binary, and when that is complete, your `go` function will be called. The
download can of course be cached if your web server is set up correctly, making
the whole process very quick.
You can use the regular-import Driver as a TypeScript type anywhere, just don't
use it to call `.new()`.
##### React
If you're writing a React app, you may wish to use `React.lazy` like so:
```typescript
// App.tsx
import React, { Suspense } from "react";
const AsyncCiteprocEnabledComponent = React.lazy(async () => {
await import("@citeproc-rs/wasm");
return await import("./CiteprocEnabledComponent");
});
const App = () => (
<Suspense
fallback={<div>Loading citation formatting engine...</div>}>
<AsyncCiteprocEnabledComponent />
</Suspense>
);
// CiteprocEnabledComponent
import { Driver } from "@citeproc-rs/wasm";
// ...
```
#### Importing it in a script tag (`web` target)
To directly import it without a bundler in a (modern) web browser with ES
modules support, the procedure is different. You must:
1. Make the `_web` subdirectory of the published NPM package available in a
content directory on your webserver, or use a CDN like [unpkg](unpkg.com).
2. Include a `<script type="module">` tag in your page's `<body>`, like so:
```html
<script type="module">
import init, { Driver } from './path/to/_web/citeproc_rs_wasm.js';
async function run() {
await init();
// use Driver
}
run()
</script>
```
**Careful**: This method does not ensure the package is loaded only once. If
you call init again, it will invalidate any previous Drivers you created.
#### Importing it in a script tag (`no-modules` target)
This is *based on* the [wasm-bindgen guide
entry](https://rustwasm.github.io/docs/wasm-bindgen/examples/without-a-bundler.html?highlight=no-modules#using-the-older---target-no-modules),
noting the caveats. You will, similarly to the `web` target, need to make the
contents of the `_no_modules` subdirectory of the published NPM package
available on a webserver or via a CDN. But it has **ONE ADDITIONAL FILE** to
import via a script tag.
**Careful**: This method does not ensure the package is loaded only once. If
you call init again, it will invalidate any previous Drivers you created.
```
<html>
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type"/>
</head>
<body>
<!-- Include these TWO JS files -->
<script src='path/to/@citeproc-rs/wasm/_no_modules/citeproc_rs_wasm_include.js'></script>
<script src='path/to/@citeproc-rs/wasm/_no_modules/citeproc_rs_wasm.js'></script>
<script>
// Like with the `--target web` output the exports are immediately
// available but they won't work until we initialize the module. Unlike
// `--target web`, however, the globals are all stored on a
// `wasm_bindgen` global. The global itself is the initialization
// function and then the properties of the global are all the exported
// functions.
//
// Note that the name `wasm_bindgen` will at some point be configurable with the
// `--no-modules-global` CLI flag (https://github.com/rustwasm/wasm-pack/issues/729)
const { Driver } = wasm_bindgen;
async function run() {
// Note the _bg.wasm ending
await wasm_bindgen('path/to/@citeproc-rs/wasm/_no_modules/citeproc_rs_wasm_bg.wasm');
// Use Driver
}
run();
</script>
</body>
</html>
```
#### Usage in Zotero
There is a special build for Zotero and the legacy Firefox ESR extensions API,
which wants a CommonJS module format but without the Node.js `fs` APIs, and
`no-modules`' loading mechanisms but without the use of `window` as a global as
it doesn't exist. The files are in the `_zotero` directory of the NPM package.
Usage is essentially the same as no-modules; you'll need all three files:
* `@citeproc-rs/wasm/_zotero/citeproc_rs_wasm_include.js`
* `@citeproc-rs/wasm/_zotero/citeproc_rs_wasm.js`
* `@citeproc-rs/wasm/_zotero/citeproc_rs_wasm_bg.wasm`
Apart from the CommonJS shims, the main difference is that the API will be
loaded onto the `Zotero.CiteprocRs` object, in order for it all to be linked
together.
**Careful**: This method does not ensure the package is loaded only once. If
you call `initWasmModule` again, it will invalidate any previous Drivers you
created.
```javascript
require("citeproc_rs_wasm_include");
const initWasmModule = require("citeproc_rs_wasm");
const wasmBinaryPromise = Zotero.HTTP
.request('GET',
'resource://zotero/citeproc_rs_wasm_bg.wasm',
{ responseType: "arraybuffer" })
.then(xhr => xhr.response);
await initWasmModule(wasmBinaryPromise);
let driver;
try {
driver = Zotero.CiteprocRs.Driver.new({...}).unwrap();
} catch (e) {
if (e instanceof Zotero.CiteprocRs.CslStyleError) {
// ...
}
}
```
## Usage
### Overview
The basic pattern of interactive use is:
1. Create a driver instance with your style
2. Edit the references or the citation clusters as you please
3. **Call `driver.batchedUpdates()`**
4. Apply the updates to your document (e.g. GUI)
5. Go to step 2 when a user makes a change
Step three is the important one. Each time you edit a cluster or a reference,
it is common for only one or two visible modifications to result. Therefore,
the driver only gives you those clusters or bibliography entries that have
changed, or have been caused to change by an edit elsewhere. You can submit any
number of edits between each call.
The API also allows for non-interactive use. See below.
### Error handling
To avoid [this issue][1963], almost every API wraps its return value in a
JavaScript object that contains either a successful result or an error, which
is a JavaScript Error object. This is called `WasmResult`, and it is modelled
on the Rust [`Result` type][rust-result]. If you just want your errors thrown,
simply tack `.unwrap()` onto nearly every API call. If you want to handle them
manually, you can, and this is mainly useful for showing style parse or
validation errors. Some error types have structured data attached to them.
```typescript
let result = Driver.new({ ... });
if (result.is_err()) {
let error = result.unwrap_err();
if (error instanceof CslStyleError) {
console.warn("Could not parse CSL, error:", error);
// You can also
// throw error;
}
} else {
let driver = result.unwrap();
}
// ...
driver.free(); // No unwrap.
```
The error types must unfortunately be global exports, on window/global/self.
In this document, `.unwrap()` used after an example means it returns a
WasmResult.
[1963]: https://github.com/rustwasm/wasm-bindgen/issues/1963
[rust-result]: https://doc.rust-lang.org/stable/std/result/enum.Result.html
### 1. Creating a driver instance
First, create a driver. Note that for now, you must also call `.free()` on the
Driver when you are finished with it to deallocate its memory, but [there is a TC39
proposal](https://rustwasm.github.io/docs/wasm-bindgen/reference/weak-references.html)
in the implementation phase that will make this unnecessary.
A driver needs at least an XML style string, a fetcher (below), and an output
format (one of `"html"`, `"rtf"` or `"plain"`).
```javascript
let fetcher = ...; // see below
let driverResult = Driver.new({
style: "<style version=\"1.0\" class=\"note\" ... > ... </style>",
format: "html", // optional, html is the default
localeOverride: "de-DE", // optional, like setting default-locale on the style
// bibliographyNoSort: true // disables sorting on the bibliography
fetcher,
});
// Throw any errors, get the inner Driver
let driver = driverResult.unwrap();
// Fetch the chain of locale files required to use the specified locale
await driver.fetchLocales();
// ... use the driver ...
driver.free()
```
The library parses and validates the CSL style input. Any validation errors are
reported, with byte offsets to find the CSL fragment responsible, a descriptive
and useful message (in English) and sometimes even a hint for how to fix it.
See [Error Handling](#error-handling) for how to access this.
#### Fetcher
There are hundreds of locales, and the locales you need depend on the style
default, any overrides and any fallback locales defined, so the procedure for
retrieving one is asynchronous to allow for fetching one over HTTP. There's not
much more to it than this:
```javascript
class Fetcher {
async fetchLocale(lang) {
return await fetch("https://some-cdn-with-locales.com/locales-${lang}.xml")
.then(res => res.text());
// or just
// return "<locale> ... </locale>";
// return LOCALES_PRELOADED[lang];
// or if you don't support locales other than the bundled en-US!
// return null;
}
}
let fetcher = new Fetcher();
let driver = Driver.new({ ..., fetcher }).unwrap();
// Make sure you actually fetch them!
await driver.fetchLocales();
```
Unless you don't have `async` syntax, in which case, return a `Promise`
directly, e.g. `return Promise.resolve("<locale> ... </locale>")`.
Declining to provide a locale fetcher in `Driver.new` or forgetting to call
`await driver.fetchLocales()` results in use of the bundled `en-US` locale. You
should also never attempt to use the driver instance while it is fetching locales.
### 2. Edit the references or the citation clusters
#### References
You can insert a reference like so. This is a [CSL-JSON][schema] object.
[schema]: https://github.com/citation-style-language/schema
```javascript
driver.insertReference({ id: "citekey", type: "book", title: "Title" }).unwrap();
driver.insertReferences([ ... many references ... ]).unwrap();
driver.resetReferences([ ... deletes any others ... ]).unwrap();
driver.removeReference("citekey").unwrap();
```
#### Citation Clusters and their Cites
A document consists of a series of clusters, each with a series of cites. Each
cluster has an `id`, which is any old string.
```javascript
// initClusters is like booting up an existing document and getting up to speed
driver.initClusters([
{ id: "one", cites: [ {id: "citekey"} ] },
{ id: "two", cites: [ {id: "citekey", locator: "56", label: "page" } ] },
]).unwrap();
// Update or insert any one of them like so
driver.insertCluster({ id: "one", cites: [ { id: "updated_citekey" } ] }).unwrap();
// (You can use `driver.randomClusterId()` to generate a new one at random.)
let three = driver.randomClusterId();
driver.insertCluster({ id: three, cites: [ { id: "new_cluster_here" } ] }).unwrap();
```
These clusters do not contain position information, so reordering is a separate
procedure. **Without calling setClusterOrder, the driver considers the document
to be empty.**
So, `setClusterOrder` expresses the ordering of the clusters within the
document. Each one in the document should appear in this list. You can skip
note numbers, which means there were non-citing footnotes in between. Omitting
`note` means it's an in-text reference. Note numbers must be monotonic, but you
can have more than one cluster in the same footnote.
```javascript
driver.setClusterOrder([ { id: "one", note: 1 }, { id: "two", note: 4 } ]).unwrap();
```
You will notice that if an interactive user cuts and pastes a paragraph
containing citation clusters, the whole reordering operation can be expressed
in two calls, one after the cut (with some clusters omitted) and one after the
paste (with those same clusters placed somewhere else). No calls to
`insertCluster` need be made.
#### Uncited items
Sometimes a user wishes to include references in the bibliography even though
they are not mentioned in a citation anywhere in the document.
```javascript
driver.includeUncited("None").unwrap(); // Default
driver.includeUncited("All").unwrap();
driver.includeUncited({ Specific: ["citekeyA", "citekeyB"] }).unwrap();
```
The "All" is based on which references your driver knows about. If you have
this set to "All", simply calling `driver.insertReference()` with a new
reference ID will result in an entry being added to the bibliography. Entries
in Specific mode do not have to exist when they are provided here; they can be,
for instance, the citekeys of collection of references in a reference library
which are subsequently provided in full to the driver, at which point they
appear in the bibliography, but not items from elsewhere in the library.
### 3. Call `driver.batchedUpdates()` and apply the diff
This gets you a diff to apply to your document UI. It includes both clusters
that have changed, and bibliography entries that have changed.
```javascript
// Get the diff since last time batchedUpdates, fullRender or drain was called.
let diff = driver.batchedUpdates().unwrap();
// apply cluster changes to the UI.
// ("myDocument" is an imaginary API.)
for (let changedCluster of diff.clusters) {
let [id, html] = changedCluster;
myDocument.updateCluster(id, html);
}
// Null? No change to the bibliography.
if (diff.bibliography != null) {
let bib = diff.bibliography;
// Save the entries that have actually changed
for (let key of Object.keys(bib.updatedEntries)) {
let rendered = bib.updatedEntries[key];
myDocument.updateBibEntry(key, rendered);
}
// entryIds is the full list of entries in the bibliography.
// If a citekey isn't in there, it should be removed.
// It is non-null when it has changed.
if (bib.entryIds != null) {
myDocument.setBibliographyOrder(bib.entryIds);
}
}
```
Note, for some intuition, if you call `batchedUpdates()` again immediately, the
diff will be empty.
### Bibliographies
Beyond the interactive batchedUpdates method, there are two functions for
producing a bibliography statically.
```javascript
// returns BibliographyMeta, with information about how a library consumer should
// lay out the bibliography. There is a similar API in citeproc-js.
let meta = driver.bibliographyMeta().unwrap();
// This is an array of BibEntry
let bibliography = driver.makeBibliography().unwrap();
for (let entry of bibliography) {
console.log(entry.id, entry.value);
}
```
### Preview citation clusters
Sometimes, a user wants to see how a cluster will look while they are editing
it, before confirming the change.
```javascript
let cites = [ { id: "citekey", locator: "45" }, { ... } ];
let positions = [ ... before, { note: 34 }, ... after ];
let preview = driver.previewCitationCluster(cites, positions, "html").unwrap();
```
The format argument is like the format passed to `Driver.new`: one of `"html"`,
`"rtf"` or `"plain"`. The driver will use that instead of its normal output
format.
The positions array is exactly like a call to `setClusterOrder`, except exactly
one of the positions omits the id field. This could either:
- Replace an existing cluster's position, and preview a cluster replacement; or
- Represent the position a cluster is hypothetically inserted.
If you passed only one position, it would be like previewing an operation like
"delete the entire document and replace it with this one cluster". **That would
mean you would never see "ibid" in a preview.** So for maximum utility,
assemble the positions array as you would a call to `setClusterOrder` with
exactly the operation you're previewing applied.
### `AuthorOnly`, `SuppressAuthor` & `Composite`
`@citeproc-rs/wasm` supports these flags on clusters (all 3) and cites (except
`Composite`), in a similar way to `citeproc-js`. See the [`citeproc-js`
documentation on Special Citation
Forms](https://citeproc-js.readthedocs.io/en/latest/running.html#special-citation-forms)
for reference.
```javascript
// only two modes for cites
let citeAO = { id: "jones2006", mode: "AuthorOnly" };
let citeSA = { id: "jones2006", mode: "SuppressAuthor" };
// additional options for clusters
let clusterAO = { id: "one", cites: [...], mode: "AuthorOnly" };
let clusterSA = { id: "one", cites: [...], mode: "SuppressAuthor" };
let clusterSA_First = { id: "one", cites: [...], mode: "SuppressAuthor", suppressFirst: 3 };
let clusterC = { id: "one", cites: [...], mode: "Composite" };
let clusterC_Infix = { id: "one", cites: [...], mode: "Composite", infix: ", whose book" };
let clusterC_Full = { id: "one", cites: [...], mode: "Composite", infix: ", whose books", suppressFirst: 0 };
```
It does support one extra option with `SuppressAuthor` and `Composite` on
clusters: `suppressFirst`, which limits the effect to the first N name groups
(or if cite grouping is disabled, first N names). Setting it to 0 means
unlimited.
#### `<intext>` element with `AuthorOnly` etc.
`citeproc-rs` supports the `<intext>` element described in the `citeproc-js`
docs linked above, but it is not enabled by default. It also supports `<intext
and="symbol">` or `and="text"`, which will swap out the last intext layout
delimiter (`<layout delimiter="; ">`) for either the ampersand or the `and`
term.
If you want to use the `<intext>` element in CSL, you may either:
##### Option 1: Add a feature flag to the style wishing to use it
```xml
<style class="in-text">
<features>
<feature name="custom-intext" />
</features>
...
</style>
```
AFAIK no other processors support this syntax yet.
##### Option 2: Enable the `custom-intext` feature for all styles via `Driver.new`
```javascript
let driver = Driver.new({ ..., cslFeatures: ["custom-intext"] }).unwrap();
// ... driver.free();
```
### Non-Interactive use, or re-hydrating a previously created document
If you are working non-interactively, or re-hydrating a previously created
document for interactive use, you may want to do one pass over all the clusters
in the document, so that each cluster and bibliography entry reflects the
correct value.
```javascript
// Get the clusters from your document (example)
let allNotes = myDocument.footnotes.map(fn => {
return { cluster: getCluster(fn), number: fn.number }
});
// Re-hydrate the entire document based on the reference library and your
// document's clusters
driver.resetReferences(myDocument.allReferences).unwrap();
driver.initClusters(allNotes.map(fn => fn.cluster)).unwrap();
driver.setClusterOrder(allNotes.map(fn => { id: fn.cluster.id, note: fn.number })).unwrap();
// Render every cluster and bibliography item.
// It then drains the update queue, leaving the diff empty for the next edit.
// see the FullRender typescript type
let render = driver.fullRender().unwrap();
// Write out the rendered clusters into the doc
for (let fn of allNotes) {
fn.renderedHtml = render.allClusters[fn.cluster.id];
}
// Write out the bibliography entries as well
let allBibKeys = render.bibEntries.map(entry => entry.id);
for (let bibEntry of render.bibEntries) {
myDocument.bibliographyMap[entry.id] = entry.value;
}
// Update your (example) UI
updateUserInterface(allNotes, myDocument, whatever);
```
### `parseStyleMetadata`
Sometimes you want information about a CSL style without actually booting up a
whole driver. One important use case is a dependent style, which can't be used
with `Driver.new()` because it doesn't have the ability to render citations on
its own, and is essentially just a container for three pieces of information:
- A journal name
- An independent parent style
- A possible default-locale override
`@citeproc-rs/wasm` provides an API for finding out what's in a CSL style file.
```typescript
let result = parseStyleMetadata("<style ...> ... </style>").unwrap();
```
The result could be a `CslStyleError`, but this is less likely than with
Driver.new() as it will not actually attempt to parse and validate all the
parts of a style.
Here's how to use `parseStyleMetadata` to parse and use a dependent style.
```typescript
let dependentStyle = "<style ...> ... </style>";
let meta = parseStyleMetadata(dependentStyle).unwrap();
let isDependent = meta.info.parent != null;
let parentStyleId = isDependent && meta.info.parent.href;
let localeOverride = meta.defaultLocale;
// ...
let parentStyle = await downloadStyleWithId(parentStyleId);
let driver = Driver.new({
style: parentStyle,
localeOverride,
...
}).unwrap();
await driver.fetchLocales();
// Here you might also want to know if the style can render a bibliography or not
let parentMeta = parseStyleMetadata(parentStyle).unwrap();
if (parentMeta.independentMeta.hasBibliography) {
let bib = driver.makeBibliography().unwrap();
// ...
}
// ...
driver.free();
```
_cjs/citeproc_rs_wasm_bg.d.ts
_esm/citeproc_rs_wasm_bg.d.ts
_web/citeproc_rs_wasm_bg.d.ts
_cjs/citeproc_rs_wasm_bg.wasm

Sorry, the diff of this file is not supported yet

_esm/citeproc_rs_wasm_bg.wasm

Sorry, the diff of this file is not supported yet

_web/citeproc_rs_wasm_bg.wasm

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc