References

summary
public	F create()
public	F update()

csl_styles

summary
public	F async add_styles(Cite: , mystyles: ): *

initializations

summary
public	F async initialize_routes(): *

modules/3rdparty/rss

summary
public	F async generate_rss_feed(ctx: Object): Promise<existentialtypeparam>
public	F routes(router: KoaRouter)

modules/auth

summary
public	F FilterSchema(ref: string): Object

modules/entities/crud

summary
public	C ODM Object Data Model Generic class to model an entity in the program (saved into an ElasticSearch DB).
public	F get_sort(sorts: ):
public	F transform_to_aggregation(body: , mapping: ): *
public	F transform_to_search(body: , mapping: ): *
public	F transform_to_sort(body: , mapping: ): *

modules/entities/crud/controllers

summary
public	F count(type: string): Function
public	F del(type: string): Function
public	F get(type: string, exists: boolean): Function
public	F gets(type: string): Function
public	F post(type: string): Function
public	F post_with_action(type: string, action: Function, options: Object): Function
public	F put(type: string): Function
public	F put_with_action(type: string, action: Function, options: Object): Function
public	F search(type: string): Function
public	F async validate(ctx: Object): Promise<existentialtypeparam>

modules/entities/exporter/controllers

summary
public	F async get_author_info(author: Object, publication: Object): Promise<string>
public	F async get_edition_stmt(publication: Object): Promise<string>
public	F async get_monogr(publication: Object): Promise<string>
public	F async get_notes_stmt(publication: Object): Promise<string>
public	F async get_profile_desc(publication: Object): Promise<string>
public	F async get_publication_stmt(publication: Object): Promise<string>
public	F async get_series_stmt(publication: Object): Promise<string>
public	F async get_source_desc(publication: Object): Promise<string>
public	F async get_title_stmt(publication: Object, tag: string): Promise<string>
public	F async transform_publication_to_hal(publication: Object): Promise<string>

modules/entities/mswpublication/controllers

summary
public	F async send_email(publication: Object, options: Object)

modules/entities/role/controllers

summary
public	F async access(ctx: Object)
public	F async authenticate(ctx: Object)

modules/entities/user/controllers

summary
public	F async access(ctx: Object)
public	F async authenticate(ctx: Object)

modules/entities/user/routes

summary
public	F routes(router: KoaRouter)

modules/exceptions

summary
public	F GenericException(name: , error: , status: , path: )

modules/pipeline

summary
public	C Pipeline Completion and validation pipeline

modules/pipeline/completer

summary
public	F async complete(object: Object, completers: Array<any>, info: Object): Promise<Object> Given an object and an array of completers as well as extra information that may be interesting, complete the object iff the object does not exists (null or undefined)

modules/pipeline/completer/complfunctions

summary
public	F denormalization(from_entity: string, from_path: string, entity_path: string, flatten: boolean, translatable: boolean, search_value: string): Function
public	F generic_complete(template: string): Function
public	F initial(name_path: string, use_dash_split: boolean): *
public	F async key_complete(object: Object, path: string, info: Object): *
public	F async secret_complete(object: Object, path: string, info: Object): *

modules/pipeline/formatter

summary
public	F async format(object: , formatters: ): * Formatting field of an object using a array of formatters
private	F async formatting(object: , func: , key: ): Format a given object using func.

modules/pipeline/formatter/formatfunctions

summary
public	F async filter_empty_or_null_objects(result: Array<any>): Promise<Array<any>>
public	F format_string(format: String): Function
public	F generic_formatter(template: string): Function
public	F async oarray_to_array(info: any): Promise<any>
public	F set_default_lang_for_array(flang: string, iflang: string): Function

modules/pipeline/transformer

summary
public	F async apply_transducer(transducer: Object, object: Object, info: Object, final: Object): *
public	F async transform(object: Object, transformers: Array<Object>, info: Object): Promise<Object>

modules/pipeline/transformer/transfunctions

summary
public	F async flatten(path: string, info: Object): Promise<Object>
public	F get_in_list(where: string, is: string, default_strategy: string): Function
public	F identity(flatten: boolean): Function
public	F template_identity(tpl: string, flatten: boolean): Function

modules/pipeline/validator

summary
public	C Validator Validator class

modules/pipeline/validator/valfunctions

summary
public	F if_exists(path: string, type: string, error_in_parent: boolean, error: Object): Function
public	F is_conditioned_on(in_path: string, check: Function, out_path: string, is: Function, error: Object): Function
public	F is_unique(path: string, type: string, filters: Array<Object>, error: Object): Function
public	F is_valid_json(path: string, error: Object): Function

modules/utils

summary
public	F async cas_auth(ticket: string, url: string): Promise<Object>
public	F do_standard_checks(user: Object): boolean
public	F async find_through_ldap(uid: string, config: Object): PromiseObject>
public	F async find_user(info: string, field: string): PromiseObject>
public	F async get_cas_info(global_config: Object): PromiseObject>
public	F async login_auth(email: string, password: string): Promise<Object>
public	F async map_ldap_to_pos(ldap_user: Object, config: Object): PromiseObject>
public	F escape_from_bibtex(str: ):
public	F escape_to_bibtex(str: ):
public	F generate_key(login: string): string
public	F generate_secret(): string
public	F async get_config(env: ):
public	F async get_language_values(key: , config: ): *
public	F get_language_values_from_langs(key: , langs: ): *
public	F async get_language_values_from_langs_and_keys(keys: , langs: ): *
public	F retrieve_single_quantity(values: ):
public	F async get_smtp_transport(): *
public	F send_email(options: , transport: ): *
public	F async send_email_through_smtp(options: ):
public	F send_email_with(from: , to: , subject: , msg: , options: , transport: ): *
public	F api_middlewares(type: string, access_type: string, opts: Object): Array<Function> Generate API middlewares
public	F app_middlewares(type: string, opts: Object): Array<Function> Generate App middlewares
public	F del_middlewares(type: string): *
public	F generate_del_routes(router: KoaRouter, prefix: string, type: string, emiddlewares: Array<Function>)
public	F generate_entity_routes(router: KoaRouter, type: string, emiddlewares: Array<Function>)
public	F generate_get_routes(router: KoaRouter, prefix: string, type: string, emiddlewares: Array<Function>)
public	F generate_gets_routes(router: KoaRouter, prefix: string, type: string, emiddlewares: Array<Function>)
public	F generate_post_routes(router: KoaRouter, prefix: string, type: string, emiddlewares: Array<Function>, action: Function, action_options: Object)
public	F generate_put_routes(router: KoaRouter, prefix: string, type: string, emiddlewares: Array<Function>, action: Function, action_options: Object)
public	F get_middlewares(type: string): *
public	F koa_middlewares(opts: Object): Array<Function> Generate default Koa middlewares
public	F post_middlewares(type: string, emid: Array<Function>, model: Object): *
public	F put_middlewares(type: string, emid: Array<Function>, model: Object): *
public	F upload_middlewares(type: string, dest: string, emid: Array<Function>, model: Object): *
public	F is_valid_stream(stream: *): boolean
public	F to_array(stream: ):
public	F to_buffer(stream: ):
public	F async add_single(ctx: *)
public	F async download(ctx: *)
public	F async multi_download(ctx: *)
private	F _return_inner_object(object: Object, copy: boolean): any
private	F _test_inner_object(object: Object, key: string \| number): Array<any>
public	F filter_empty_or_null_objects(array: Array<any>): Array<any>
public	F find_object_with_path(object: Object, path: Array<string>): any
public	F * find_popvalue_with_path(object: Object, path: Array<string>, return_object: boolean, keep_null: boolean): any
public	F find_value_with_path(object: Object, path: Array<string>): any
public	F forge_whitelist_blacklist_query(lists: Object): Object
public	F hasProperty(obj: Object, key: string \| number): boolean
public	F isNil(path: string, object: Object): boolean
public	F make_nested_object_from_path(path: Array<string>, value: any, obj: Object): Object
public	F merge_with_concat(object: Object, sources: ...):
public	F merge_with_replacement(object: Object, sources: ...*): Object
public	F merge_with_superposition(object: Object, sources: ...):
public	F async traverse_and_execute(object: Object, path: Array<string>, f: Function): any
public	F async traverse_recreate_and_execute(object: Object, path: Array<string>, f: Function, keep_last: boolean): any
public	F forge_ok_response(model: , name: , method: ): Forge a standard response when returning HTTP 200 for any request
public	F strip_xhtml_tags(str: ):
public	F to_object(text: ):

Directories