/** * @author fenris */ declare type int = number; /** * @author fenris */ declare type float = number; /** * @author fenris */ declare type type_date = { year: int; month: int; day: int; }; /** * @author fenris */ declare type type_time = { hour: int; minute: int; second: int; }; /** * @author fenris */ declare type type_datetimeobject = { date: type_date; time: type_time; }; declare var process: any; declare var require: any; declare class Buffer { constructor(x: string, modifier?: string); toString(modifier?: string): string; } declare namespace lib_plankton.base { /** * @author fenris */ function environment(): string; } /** * @author fenris */ declare type type_pseudopointer = { value: type_value; }; /** * @author fenris */ declare function pseudopointer_null(): type_pseudopointer; /** * @author fenris */ declare function pseudopointer_make(value: type_value): type_pseudopointer; /** * @author fenris */ declare function pseudopointer_isset(pseudopointer: type_pseudopointer): boolean; /** * @author fenris */ declare function pseudopointer_read(pseudopointer: type_pseudopointer): type_value; /** * @author fenris */ declare function pseudopointer_write(pseudopointer: type_pseudopointer, value: type_value): void; /** * @author fenris */ declare var instance_verbosity: int; /** * @desc the ability to check for equality with another element of the same domain * @author fenris */ interface interface_collatable { /** * @author fenris */ _collate(value: type_value): boolean; } /** * @author fenris */ declare function instance_collate(value1: (type_value & { _collate?: ((value: type_value) => boolean); }), value2: type_value): boolean; /** * @desc the ability to compare with another element of the same domain for determining if the first is "smaller than or equal to" the latter * @author fenris */ interface interface_comparable { /** * @author fenris */ _compare(value: type_value): boolean; } /** * @author fenris */ declare function instance_compare(value1: (type_value & { _compare: ((value: type_value) => boolean); }), value2: type_value): boolean; /** * @desc the ability to create an exact copy * @author fenris */ interface interface_cloneable { /** * @author fenris */ _clone(): type_value; } /** * @author fenris */ declare function instance_clone(value: (type_value & { _clone?: (() => type_value); })): type_value; /** * @author fenris */ interface interface_hashable { /** * @author fenris */ _hash(): string; } /** * @desc the ability to generate a string out of the element, which identifies it to a high degree * @author fenris */ declare function instance_hash(value: (type_value & { _hash?: (() => string); })): string; /** * @author fenris */ interface interface_showable { /** * @author fenris */ _show(): string; } /** * @desc the ability to map the element to a textual representation (most likely not injective) * @author fenris */ declare function instance_show(value: (type_value & { _show?: (() => string); })): string; /** * @author frac */ interface interface_decorator { /** * @author frac */ core: type_core; } /** * @author frac */ declare class class_observer { /** * @author frac */ protected counter: int; /** * @author frac */ protected actions: { [id: string]: (information: Object) => void; }; /** * @author frac */ protected buffer: Array; /** * @author frac */ constructor(); /** * @author frac */ empty(): boolean; /** * @author frac */ flush(): void; /** * @author frac */ set(id: string, action: (information: Object) => void): void; /** * @author frac */ del(id: string): void; /** * @author frac */ add(action: (information: Object) => void): void; /** * @author frac */ notify(information?: Object, delayed?: boolean): void; /** * @author frac */ rollout(): void; } /** * @author frac */ /** * @author frac */ /** * @author frac */ declare class class_error extends Error { /** * @author frac */ protected suberrors: Array; /** * @author frac */ protected mess: string; /** * @author frac */ constructor(message: string, suberrors?: Array); /** * @override * @author frac */ toString(): string; } declare namespace lib_plankton.base { /** * returns the current UNIX timestamp * * @author fenris */ function get_current_timestamp(rounded?: boolean): float; /** */ function object_merge(core: Record, mantle: Record): Record; } declare namespace lib_plankton.email { /** */ function send(smtp_credentials: { host: string; port: int; username: string; password: string; }, sender: string, receivers: Array, subject: string, content: string): Promise; } declare namespace lib_plankton.log { /** */ enum enum_level { debug = 0, info = 1, notice = 2, warning = 3, error = 4 } /** */ function level_order(level1: enum_level, level2: enum_level): boolean; /** */ function level_show(level: enum_level): string; /** */ type type_entry = { level: enum_level; incident: string; details: Record; }; } /** * @deprecated * @todo remove */ declare namespace lib_plankton.log { function level_push(level: int): void; function level_pop(): void; function indent_push(indent: int): void; function indent_pop(): void; function indent_inc(): void; function indent_dec(): void; /** * @author fenris */ function write({ "message": message, "type": type, "prefix": prefix, "level": level, "indent": indent, }: { message?: string; type?: string; prefix?: string; level?: int; indent?: int; }): void; } declare namespace lib_plankton.log { /** */ abstract class class_channel { /** */ abstract add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** * output for writing log entries to stdout */ class class_channel_stdout extends class_channel { /** */ add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** */ class class_channel_file extends class_channel { /** * the path of the log file */ private path; /** */ private human_readable; /** * [constructor] */ constructor(path: string, human_readable: boolean); /** */ add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** */ class class_channel_email extends class_channel { /** */ private smtp_credentials; /** */ private sender; /** */ private receivers; /** * [constructor] */ constructor(smtp_credentials: { host: string; port: int; username: string; password: string; }, sender: string, receivers: Array); /** */ add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** * output for desktop notifications via "libnotify" */ class class_channel_notify extends class_channel { /** */ add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** * decorator for filtering out log entries below a certain level threshold */ class class_channel_minlevel extends class_channel { /** */ private core; /** */ private threshold; /** */ constructor(core: class_channel, threshold: enum_level); /** */ add(entry: type_entry): void; } } declare namespace lib_plankton.log { /** */ function channel_make(description: { kind: string; data?: { [key: string]: any; }; }): class_channel; /** */ type type_configuration = Array; /** */ function conf_default(): type_configuration; } declare namespace lib_plankton.log { /** * pushes a new configuration on the stack and activates it */ function conf_push(channels: type_configuration): void; /** * pops the current active configuration from the stack */ function conf_pop(): void; /** * consumes a log entry, i.e. sends it to the currently active outputs */ function add(entry: type_entry): void; /** */ function debug(incident: string, details?: Record): void; /** */ function info(incident: string, details?: Record): void; /** */ function notice(incident: string, details?: Record): void; /** */ function warning(incident: string, details?: Record): void; /** */ function error(incident: string, details?: Record): void; } declare namespace lib_plankton.code { /** * @author fenris */ interface interface_code { /** * @author fenris */ encode(x: type_from): type_to; /** * @author fenris */ decode(x: type_to): type_from; } } declare namespace lib_plankton.code { /** * @author fenris */ type type_code = { /** * @author fenris */ encode: (x: type_from) => type_to; /** * @author fenris */ decode: (x: type_to) => type_from; }; } declare namespace lib_plankton.code { /** * @author fenris */ function inverse_encode(decode: (to: type_to) => type_from, to: type_to): type_from; /** * @author fenris */ function inverse_decode(encode: (from: type_from) => type_to, from: type_from): type_to; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_inverse implements interface_code { /** * @author fenris */ protected subject: interface_code; /** * @author fenris */ constructor(subject: interface_code); /** * @implementation * @author fenris */ encode(to: type_to): type_from; /** * @implementation * @author fenris */ decode(from: type_from): type_to; } } declare namespace lib_plankton.code { /** * @author fenris */ function pair_encode(encode_first: (from: type_from) => type_between, encode_second: (between: type_between) => type_to, from: type_from): type_to; /** * @author fenris */ function pair_decode(decode_first: (between: type_between) => type_from, decode_second: (to: type_to) => type_between, to: type_to): type_from; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_pair implements interface_code { /** * @author fenris */ protected first: interface_code; /** * @author fenris */ protected second: interface_code; /** * @author fenris */ constructor(first: interface_code, second: interface_code); /** * @implementation * @author fenris */ encode(from: type_from): type_to; /** * @implementation * @author fenris */ decode(to: type_to): type_from; } } declare namespace lib_plankton.code { /** * @author fenris */ function chain_encode(encode_links: Array<(from: any) => any>, from: any): any; /** * @author fenris */ function chain_decode(decode_links: Array<(to: any) => any>, to: any): any; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_chain implements interface_code { /** * @author fenris */ protected links: Array>; /** * @author fenris */ constructor(links: Array>); /** * @implementation * @author fenris */ encode(from: any): any; /** * @implementation * @author fenris */ decode(to: any): any; } } declare namespace lib_plankton.code { /** * @author Christian Fraß */ type type_flatten_from = Array<{ [name: string]: any; }>; /** * @author Christian Fraß */ type type_flatten_to = { keys: Array; data: Array>; }; /** * @author Christian Fraß */ function flatten_encode(from: type_flatten_from, keys?: Array): type_flatten_to; /** * @author Christian Fraß */ function flatten_decode(to: type_flatten_to): type_flatten_from; } declare namespace lib_plankton.code { /** * @author fenris */ class class_code_flatten implements interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: type_flatten_from): type_flatten_to; /** * @implementation * @author fenris */ decode(x: type_flatten_to): type_flatten_from; } } declare namespace lib_plankton.http { /** * @author fenris */ enum enum_method { options = "options", head = "head", get = "get", delete = "delete", post = "post", put = "put", patch = "patch" } /** * @author fenris */ type type_request = { scheme: ("http" | "https"); host: (null | string); path: string; version: string; method: enum_method; query: (null | string); headers: Record; body: (null | Buffer); }; /** * @author fenris */ type type_response = { version: (null | string); status_code: int; headers: Record; body: Buffer; }; } declare namespace lib_plankton.http { /** * @author fenris */ function encode_method(method: enum_method): string; /** * @author fenris */ function encode_request(request: type_request): string; /** * @author fenris */ function decode_request(request_raw: string): type_request; /** * @author fenris */ function encode_response(response: type_response): string; /** * @author fenris */ function decode_response(response_raw: string): type_response; /** * executes an HTTP request * * @todo define type_signal */ function call(request: type_request, options?: { timeout?: (null | float); follow_redirects?: boolean; implementation?: ("fetch" | "http_module"); }): Promise; } declare namespace lib_plankton.http { /** * @author fenris */ class class_http_request implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: type_request): string; /** * @implementation * @author fenris */ decode(x: string): type_request; } /** * @author fenris */ class class_http_response implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: type_response): string; /** * @implementation * @author fenris */ decode(x: string): type_response; } } declare namespace lib_plankton.server { /** * @author fenris */ type type_metadata = { ip_address: string; }; /** * @author fenris */ type type_subject = { host: string; port: int; threshold: (null | float); handle: ((input: Buffer, metadata?: type_metadata) => Promise); serverobj: any; }; /** * @author fenris */ function make(handle: ((input: string, metadata?: type_metadata) => Promise), options?: { host?: string; port?: int; threshold?: (null | float); }): type_subject; /** * @author fenris * @deprecated */ function make_old(port: int, handle: ((input: string, metadata?: type_metadata) => Promise)): type_subject; /** * @author fenris * @see https://nodejs.org/api/net.html#serverlistenport-host-backlog-callback */ function start(subject: type_subject): Promise; /** * @author fenris */ function kill(subject: type_subject): void; } declare namespace lib_plankton.server { /** * @author fenris */ class class_server { /** * @author fenris */ protected subject: type_subject; /** * @author fenris */ constructor(handle: ((input: Buffer, metadata?: type_metadata) => Promise), options?: { host?: string; port?: int; }); /** * @author fenris */ start(): Promise; /** * @author fenris */ kill(): void; } } declare var lib_server: typeof lib_plankton.server; declare namespace lib_plankton.object { /** * @author fenris */ function fetch(object: Object, fieldname: string, fallback?: type_value, escalation?: int): type_value; /** * @author fenris */ function map(object_from: { [key: string]: type_from; }, transformator: (value_from: type_from, key?: string) => type_to): { [key: string]: type_to; }; /** * @desc gibt ein Objekt mit bestimmten Einträgen des Eingabe-Objekts zurück * @author fenris */ function filter(object_from: { [key: string]: type_value; }, predicate: (value_from: type_value, key?: string) => boolean): { [key: string]: type_value; }; /** * @desc wandelt ein Array mit Einträgen der Form {key,value} in ein entsprechendes Objekt um * @author fenris */ function from_array(array: Array<{ key: string; value: type_value; }>): { [key: string]: type_value; }; /** * @desc wandelt ein Objekt in ein entsprechendes Array mit Einträgen der Form {key,value} um * @author fenris */ function to_array(object: { [key: string]: type_value; }): Array<{ key: string; value: type_value; }>; /** * @desc gibt eine Liste von Schlüsseln eines Objekts zurück * @author fenris */ function keys(object: { [key: string]: any; }): Array; /** * @desc gibt eine Liste von Werten eines Objekts zurück * @author fenris */ function values(object: { [key: string]: type_value; }): Array; /** * @desc liest ein Baum-artiges Objekt an einer bestimmten Stelle aus * @author fenris */ function path_read(object: Object, path: string, fallback?: type_value, escalation?: int): type_value; /** * @desc schreibt einen Wert an eine bestimmte Stelle in einem Baum-artigen Objekt * @author fenris */ function path_write(object: Object, path: string, value: type_value, construct?: boolean): void; /** * @desc prüft ob ein Objekt einem bestimmten Muster entspricht * @param {Object} object das zu prüfende Objekt * @param {Object} pattern das einzuhaltende Muster * @param {Function} connlate eine Funktion zum Feststellen der Gleichheit von Einzelwerten * @author fenris */ function matches(object: Object, pattern: Object, collate?: typeof instance_collate): boolean; /** * @desc erzeugt eine Projektion eines Baum-artigen Objekts in ein Listen-artiges Objekt * @param {string} [separator] welches Zeichen als Trenner zwischen zwei Pfad-Schritten verwendet werden soll * @author fenris */ function flatten(value: any, separator?: string, key_for_element?: (index: int) => string): Object; /** * @author fenris */ function clash(x: { [key: string]: any; }, y: { [key: string]: any; }, { "overwrite": overwrite, "hooks": { "existing": hook_existing, }, }?: { overwrite?: boolean; hooks?: { existing?: (key?: string, value_old?: any, value_new?: any) => void; }; }): { [key: string]: any; }; /** * @author fenris */ function patch(core: Object, mantle: Object, deep?: boolean, path?: string): void; /** * @author fenris */ function patched(core: Object, mantle: Object, deep?: boolean): Object; /** * @author fenris */ function attached(object: Object, key: string, value: any): Object; /** * @author fenris */ function copy(object: Object): Object; } declare module lib_plankton.pod { /** * @author fenris */ type type_pod = { kind: ("empty" | "filled"); value?: type_value; }; /** * @author fenris */ function make_empty(): type_pod; /** * @author fenris */ function make_filled(value: type_value): type_pod; /** * whether the pod is filled * * @author fenris */ function is_filled(pod: type_pod): boolean; /** * return the value, stored in the pod-wrapper * * @author fenris */ function cull(pod: type_pod): type_value; /** * to pass on a empty-pod or to use a filled-pod * * @author fenris */ function propagate(pod: type_pod, function_: ((value: type_value) => type_value_)): type_pod; /** * @author fenris */ function distinguish(pod: type_pod, function_empty: (() => type_result), function_filled: ((value: type_value) => type_result)): type_result; /** */ function show(pod: type_pod, options?: { show_value?: ((value: type_value) => string); }): string; } declare module lib_plankton.pod { /** */ class class_pod { private subject; private constructor(); is_empty(): boolean; is_filled(): boolean; cull(): type_value; show(show_value?: any): string; toString(): string; propagate(function_: ((value: type_value) => type_value_)): class_pod; distinguish(function_empty: (() => type_result), function_filled: ((value: type_value) => type_result)): type_result; } } /** * might be completely obsolete */ declare namespace lib_plankton.call { /** * @author fenris */ type type_promise = Promise; /** * @author fenris */ function promise_reject(reason: type_reason): type_promise; /** * @author fenris */ function promise_resolve(result: type_result): type_promise; /** * @author fenris */ function promise_make(executor: (resolve: ((result?: type_result) => void), reject: ((reason?: type_reason) => void)) => void): type_promise; /** * @author fenris */ function promise_then_close(promise: type_promise, resolver: ((result: type_result) => void), rejector: ((reason: type_reason) => void)): void; /** * @author fenris */ function promise_then_append(promise: type_promise, resolver: ((result: type_result) => type_promise), rejector?: ((reason: type_reason) => type_promise)): type_promise; /** * @author fenris */ function promise_all(promises: Array>): type_promise, type_reason>; /** * @author fenris */ function promise_chain(promises: (Array<(input: type_result) => type_promise>), start?: type_result): type_promise; /** * @author fenris */ function promise_condense(promises: Array<() => type_promise>): type_promise, type_reason>; /** * @author fenris */ function promise_group(promises: Record type_promise)>, options?: { serial?: boolean; }): type_promise, type_reason>; /** * @author fenris */ function promise_wrap(promise: type_promise, transformator_result: ((reason: type_result_inner) => type_result_outer), transformator_reason?: ((reason: type_reason) => type_reason)): type_promise; /** * @author fenris */ /** * @author fenris */ /** * @author fenris */ function promise_attach(state: Record, promise: type_promise, name: string): type_promise, type_reason>; /** * @author fenris */ function promise_delay(promise: type_promise, delay: int): type_promise; } declare namespace lib_plankton.call { /** */ class CancellablePromise extends Promise { /** */ private cancelled; /** */ private interval; /** */ private subject; /** */ constructor(executor: ((resolve: any, reject: any) => void)); /** */ private clear; /** */ then(onfulfilled?: ((value: type_result) => (type_next_resolved | PromiseLike)), onrejected?: ((reason: any) => (type_next_rejected | PromiseLike))): Promise; /** */ catch(x: any): Promise; /** */ cancel(): void; } } /** * initializer might be obsolete, since promises are reusable after having been resolved or rejected */ declare namespace lib_plankton.call { /** * @author fenris */ enum enum_initializer_state { initial = 0, waiting = 1, successful = 2, failed = 3 } /** * @author fenris */ type type_initializer = { fetcher: (() => type_promise); state?: enum_initializer_state; queue: Array<{ resolve: ((result?: type_result) => void); reject: ((reason?: type_reason) => void); }>; result?: type_result; reason?: type_reason; }; /** * @author fenris */ function initializer_make(fetcher: (() => type_promise)): type_initializer; /** * @author fenris */ function initializer_reset(subject: type_initializer): void; /** * @author fenris */ function initializer_state(subject: type_initializer): enum_initializer_state; /** * @author fenris */ function initializer_get(subject: type_initializer): type_promise; } declare namespace lib_plankton.call { /** * @author fenris */ type type_deferral = { representation: (input: type_input) => Promise; }; /** * @author fenris * @desc activates the deferral and handles its output according to a given procedure * @param {(value : type_value)=>void} procedure a function which receives the output of the deferral as argument */ function deferral_use(deferral: type_deferral, input: type_input, procedure: (output: type_output) => void): void; /** * @author fenris * @desc creates a deferral-subject (similar to "new Promise", where "convey" reflects "resolve"/"reject") */ function deferral_make(handler: (input: type_input, convey: (output: type_output) => void) => void): type_deferral; /** * @author fenris * @desc wraps a simple function into a deferral (similar to "Promise.resolve"/"Promise.reject") */ function deferral_wrap(function_: (input: type_input) => type_output): type_deferral; /** * @author fenris */ function deferral_id(): type_deferral; /** * @author fenris */ function deferral_const(value: type_value): type_deferral; /** * @author fenris */ function deferral_delay(output: type_output, delay: int): type_deferral; /** * @author fenris * @desc connects two deferrals to form a new one; the output of the first is taken as input for the second * (similar to "Promise.then" when passing a function which returns a new promise) * @param {type_deferral} first a simple deferral * @param {(value1 : type_value1)=>type_deferral} second a function depending from a value returning a deferral */ function deferral_compose_serial(first: type_deferral, second: type_deferral): type_deferral; /** * @author fenris */ function deferral_compose_parallel({ "left": deferral_left, "right": deferral_right, }: { left: type_deferral; right: type_deferral; }): type_deferral; /** * @author fenris * @desc repeatedly applied serial composition */ function deferral_chain(members: Array>): type_deferral; /** * @author fenris */ } declare namespace lib_plankton.call { /** * @author fenris */ class class_deferral { /** * @author fenris */ private subject; /** * @author fenris */ private constructor(); /** * @author fenris */ private static _cram; /** * @author fenris */ private static _tear; /** * @author fenris */ static make(handler: (input: type_input, convey: (value: type_output) => void) => void): class_deferral; /** * @author fenris */ use(input: type_input, procedure: (value: type_output) => void): void; /** * @author fenris */ compose_serial(second: class_deferral): class_deferral; /** * @author fenris */ static chain(members: Array>): class_deferral; /** * @author fenris */ static wrap(function_: (input: type_input) => type_output): class_deferral; /** * @author fenris */ static const_(value: type_value): class_deferral; /** * @author fenris */ static delay(output: type_output, delay: int): class_deferral; } } declare namespace lib_plankton.call { /** * converts the "arguments"-map into an array * * @param {Object} args * @author fenris */ function args2list(args: any): Array; /** * just the empty function; useful for some callbacks etc. * * @author fenris */ function nothing(): void; /** * just the identity; useful for some callbacks etc.; defined as function instead of const for using type parameters * * @author fenris */ function id(x: type_value): type_value; /** * just the identity; useful for some callbacks etc. * * @author fenris */ function const_(x: type_value): ((y: any) => type_value); /** * composes two functions (i.e. returns a function that return the result of the successive execution of both input-functions) * * @param {function} function_f * @param {function} function_g * @author fenris */ function compose(function_f: ((type_x: any) => type_y), function_g: ((type_y: any) => type_z)): ((value: type_x) => type_z); /** * transforms a function with sequential input to a function with leveled input; example: add(2,3) = curryfy(add)(2)(3) * * @param {function} f * @return {function} the currified version of the in put function * @author fenris */ function curryfy(f: Function): Function; /** * @author fenris */ function convey(value: any, functions: Array): any; /** * @author fenris */ function timeout(procedure: (() => void), delay_in_seconds: float): int; /** * Promise version of "setTimeout" * * @author fenris */ function defer(seconds: float, action: (() => type_result)): Promise; /** * a definition for a value being "defined" * * @author neuc */ function is_def(obj: type_value, options?: { null_is_valid?: boolean; }): boolean; /** * returns the value if set and, when a type is specified, if the type is correct, if not return default_value * * @author neuc */ function def_val(value: any, default_value: any, options?: { type?: (null | string); null_is_valid?: boolean; }): any; /** * provides the call for an attribute of a class as a regular function; useful for processing lists of objects * * @param {string} name the name of the attribute * @return {function} * @author fenris */ function attribute(name: string): ((object: type_object) => type_attribute); /** * provides a method of a class as a regular function; useful for processing lists of objects * * @param {string} name the name of the method * @return {function} * @author fenris */ function method(name: string): ((object: type_object) => type_output); /** * @author fenris */ type type_coproduct = { kind: string; data?: any; }; /** * @author fenris */ function distinguish(coproduct: type_coproduct, handlers: Record type_output)>, options?: { fallback?: (null | ((coproduct?: type_coproduct) => type_output)); }): type_output; /** * for rate_limit_check * * @author fenris */ type type_mana_snapshot = { timestamp: float; value: float; }; /** * rate limiting algorithm, based on the idea of mana (magic power) in video games: * - an actor has a fixed mana capacity, i.e. the maximum amount of available power * - an actor has a fixed rate of mana regeneration, i.e. how fast the power is filled up (linear growth) * - an action has a defined mana heft, i.e. how much power is required and deducted in order to execute it * - mana states are represented by snapshots, i.e. the amount of power at a certain point in time * * @author fenris */ function rate_limit_check(setup: { capacity: float; regeneration_rate: float; get_snapshot: (() => Promise<(null | type_mana_snapshot)>); set_snapshot: ((snapshot: type_mana_snapshot) => Promise); update_snapshot: ((timestamp: float, value_increment: float) => Promise); }, heft: float): Promise<{ granted: boolean; seconds: (null | float); }>; } declare var plain_text_to_html: (text: string) => string; /** * @desc makes a valid */ declare var format_sentence: (str: string, rtl?: boolean, caseSense?: boolean) => string; declare var fill_string_template: (template_string: string, object: any, fabric: Function, delimiter: string, default_string: string, sloppy: boolean) => string; declare var make_string_template: (_template: string, _fabrics?: Object) => (object: { [key: string]: string; }) => string; declare var make_eml_header: (object: { [key: string]: string; }) => string; declare var make_eml_body: Object; declare namespace lib_plankton.string { /** * @author neuc,frac */ function empty(str: string): boolean; /** * @desc returns a unique string * @param {string} prefix an optional prefix for the generated string * @return {string} * @author fenris */ function generate(prefix?: string): string; /** * @author fenris */ function join(parts: Array, glue?: string): string; /** * @desc splits a string, but returns an empty list, if the string is empty * @param {string} chain * @param {string} separator * @return {Array} * @author fenris */ function split(chain: string, separator?: string): Array; /** * @author neu3no */ function explode(str: string, needle: string, max: int): Array; /** * @desc concats a given word with itself n times * @param {string} word * @param {int} * @return {string} * @author fenris */ function repeat(word: string, count: int): string; /** * @desc lengthens a string by repeatedly appending or prepending another string * @param {string} word the string to pad * @param {int} length the length, which the result shall have * @param {string} symbol the string, which will be added (multiple times) * @param {boolean} [prepend]; whether to prepend (~true) or append (~false); default: false * @return {string} the padded string * @author fenris */ function pad(word: string, length: int, symbol?: string, mode?: string): string; /** * @desc checks if a given string conttains a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function contains(chain: string, part: string): boolean; /** * @desc checks if a given string starts with a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function startsWith(chain: string, part: string): boolean; /** * @desc checks if a given string ends with a certain substring * @param {string} string * @param {string} part * @return {boolean} * @author fenris */ function endsWith(chain: string, part: string): boolean; /** * @desc count the occourrences of a string in a string * @param string haystack_string the string wich should be examined * @param string needle_string the string which should be counted * @author neuc */ function count_occourrences(haystack_string: string, needle_string: string, check_escape: boolean): int; /** * @author fenris */ function replace(str: string, replacements: Array<{ from: string; to: string; }>, options?: {}): string; /** * @desc replaces occurences of "{{name}}" in a string by the corresponding values of an argument object * @author fenris */ function coin(str: string, args: { [id: string]: string; }, options?: { legacy?: boolean; open?: string; close?: string; }): string; /** * @author fenris * @deprecated use limit */ function cut(str: string, length: int, delimiter?: string): string; /** */ function limit(str: string, options?: { length?: int; indicator?: string; }): string; /** */ function slice(str: string, size: int): Array; } /** * @deprecated */ declare namespace lib_string { const empty: typeof lib_plankton.string.empty; const generate: typeof lib_plankton.string.generate; const split: typeof lib_plankton.string.split; const explode: typeof lib_plankton.string.repeat; const repeat: typeof lib_plankton.string.repeat; const pad: typeof lib_plankton.string.pad; const contains: typeof lib_plankton.string.contains; const startsWith: typeof lib_plankton.string.startsWith; const endsWith: typeof lib_plankton.string.endsWith; const count_occourrences: typeof lib_plankton.string.count_occourrences; const coin: typeof lib_plankton.string.coin; const stance: typeof lib_plankton.string.coin; const cut: typeof lib_plankton.string.cut; } declare namespace lib_plankton.string { /** * an implementation of c sprintf * @param {string} string format string * @param {array} args arguments which should be filled into * @returns {string} */ var sprintf: (input: string, args?: Array, original?: any) => string; /** * an implementation of c printf * @param {string} string format string * @param {array} args arguments which should be filled into * @returns {string} */ function printf(format: any, args: any): void; } declare var sprintf: (input: string, args?: Array, original?: any) => string; declare var printf: typeof lib_plankton.string.printf; declare var eml_log: any; declare var track_exports: any; declare var make_logger: (prefix: any, current_loglevel: any) => (obj: any, lvl: any) => void; declare namespace lib_plankton.shape { /** * @todo */ type type_jsonschema = any; /** * @todo */ type type_oas_schema = any; /** * @author fenris */ type type_inspection = { flaws: Array; sub: Array<{ position: string; inspection: type_inspection; }>; }; /** * @author fenris */ function inspection_create(): type_inspection; /** * @author fenris */ function inspection_add(main: type_inspection, flaw: string): void; /** * @author fenris */ function inspection_extend(main: type_inspection, prefix: string, sub: type_inspection): void; /** */ type type_shape = { kind: string; parameters: Record; }; /** * @author fenris */ type type_logic = { inspect: ((sub_inspect: ((shape: type_shape, value: any) => type_inspection), value: any) => type_inspection); show: ((sub_show: ((shape: type_shape) => string)) => string); to_typescript_type: ((sub_to_typescript_type: ((shape: type_shape) => string)) => string); to_jsonschema: ((sub_to_json_schema: ((shape: type_shape) => type_jsonschema)) => type_jsonschema); to_oas_schema: ((sub_to_oas_schema: ((shape: type_shape) => type_oas_schema)) => type_oas_schema); example: ((sub_example: ((shape: type_shape) => any)) => any); }; /** */ function inspect(shape: type_shape, value: any): type_inspection; /** */ function inspect_flat(shape: type_shape, value: any): Array; /** */ function show(shape: type_shape): string; /** */ function to_typescript_type(shape: type_shape): string; /** */ function to_jsonschema(shape: type_shape): type_jsonschema; /** */ function to_oas_schema(shape: type_shape): type_oas_schema; /** */ function example(shape: type_shape): any; /** */ function register(name: string, construct: ((parameters: type_parameters) => type_subject), logic: ((subject: type_subject) => type_logic)): void; } declare namespace lib_plankton.shape.any { /** */ type type_subject = {}; /** */ export function make(options?: {}): type_subject; export {}; } declare namespace lib_plankton.shape.null_ { /** */ type type_subject = {}; /** */ export function make(options?: {}): type_subject; export {}; } declare namespace lib_plankton.shape.boolean { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | boolean); description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.integer { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; minimum: lib_plankton.pod.type_pod; maximum: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; minimum?: int; maximum?: int; }): type_subject; export {}; } declare namespace lib_plankton.shape.float { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; minimum: lib_plankton.pod.type_pod; maximum: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | float); description?: string; minimum?: float; maximum?: float; }): type_subject; export {}; } declare namespace lib_plankton.shape.string { /** */ type type_subject = { soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; pattern: lib_plankton.pod.type_pod; min_length: lib_plankton.pod.type_pod; max_length: lib_plankton.pod.type_pod; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; pattern?: string; min_length?: int; max_length?: int; }): type_subject; export {}; } declare namespace lib_plankton.shape.email { /** */ type type_subject = { core: type_shape; }; /** */ export function make(options?: { soft?: boolean; defaultvalue?: (null | int); description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.list_ { /** */ type type_subject = { shape_element: type_shape; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(shape_element: type_shape, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.map { /** */ type type_subject = { shape_key: type_shape; shape_value: type_shape; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(shape_key: type_shape, shape_value: type_shape, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.shape.record { /** */ type type_field = { name: string; shape: type_shape; required: boolean; }; /** */ type type_subject = { fields: Array; soft: boolean; defaultvalue: lib_plankton.pod.type_pod; description: lib_plankton.pod.type_pod; }; /** */ export function make(fields_raw: Array<{ name: string; shape: type_shape; required?: boolean; }>, options?: { soft?: boolean; defaultvalue?: any; description?: string; }): type_subject; export {}; } declare namespace lib_plankton.markdown { /** * @author fenris */ function code(content: string): string; /** * @author fenris */ function paragraph(content: string): string; /** * @author fenris */ function sectionhead(level: int, content: string): string; } declare namespace lib_plankton.api { /** */ enum enum_checklevel { none = "none", soft = "soft", hard = "hard" } /** * @author fenris */ type type_action = { name: string; active: ((version: (null | string)) => boolean); execution: ((version: (null | string), environment: any, input: any) => Promise); restriction: ((version: (null | string), environment: any) => Promise); input_shape: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape: ((version: (null | string)) => lib_plankton.shape.type_shape); title: (null | string); description: (null | string); }; /** * @author fenris */ type type_api = { title: string; actions: Record; }; /** */ class class_error_permission_denied extends Error { } } declare namespace lib_plankton.api { /** * @author fenris */ function make(title: string): type_api; /** * @throws Error if a action with the given name has already been registered * @author fenris */ function register(api: type_api, name: string, options?: { active?: ((version: (null | string)) => boolean); execution?: ((version: (null | string), environment: any, input: any) => Promise); restriction?: ((version: (null | string), input: any) => Promise); input_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); title?: (null | string); description?: (null | string); }): void; /** * @throws Error if not found * @author fenris */ function get_action(api: type_api, name: string): type_action; /** * @author fenris */ function call(api: type_api, name: string, options?: { version?: (null | string); input?: any; environment?: Record; checklevel_restriction?: enum_checklevel; checklevel_input?: enum_checklevel; checklevel_output?: enum_checklevel; }): Promise; /** * @author fenris */ function generate_documentation_for_action(api: type_api, name: string, options?: { version?: (null | string); }): string; /** * @author fenris */ function generate_documentation(api: type_api, options?: { version?: (null | string); }): string; } declare namespace lib_plankton.api { /** * @author fenris */ class class_api { /** * @author fenris */ private subject; /** * @author fenris */ private constructor(); /** * @author fenris */ static create(name: string): class_api; /** * @author fenris */ register(name: string, options?: { active?: ((version: (null | string)) => boolean); execution?: ((version: (null | string), environment: any, input: any) => lib_plankton.call.type_promise); restriction?: ((version: (null | string), input: any) => Promise); input_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); output_shape?: ((version: (null | string)) => lib_plankton.shape.type_shape); title?: (null | string); description?: (null | string); }): void; /** * @author fenris */ call(name: string, options?: { version?: (null | string); input?: any; environment?: Record; checklevel_restriction?: enum_checklevel; checklevel_input?: enum_checklevel; checklevel_output?: enum_checklevel; }): lib_plankton.call.type_promise; /** * @author fenris */ generate_documentation_for_action(name: string): string; /** * @author fenris */ generate_documentation(): string; } } declare namespace lib_plankton.rest { /** */ type type_oas_schema = ({} | { nullable: boolean; } | { type: "boolean"; nullable?: boolean; enum?: Array; } | { type: "integer"; nullable?: boolean; enum?: Array; } | { type: "number"; nullable?: boolean; enum?: Array; } | { type: "string"; nullable?: boolean; enum?: Array; } | { type: "array"; nullable?: boolean; items: type_oas_schema; } | { type: "object"; nullable?: boolean; additionalProperties?: (false | type_oas_schema); properties: Record; required: Array; }); /** */ type type_execution = ((stuff: { version: (null | string); headers: Record; path_parameters: Record; query_parameters: Record; input: (null | type_input); }) => Promise<{ status_code: int; data: type_output; }>); /** */ type type_restriction = ((stuff: { version: (null | string); headers: Record; path_parameters: Record; query_parameters: Record; }) => Promise); /** */ type type_operation = { action_name: string; query_parameters: Array<{ name: string; description: (null | string); required: boolean; }>; request_body_mimetype: string; request_body_decode: ((http_request_body: Buffer, http_request_header_content_type: (null | string)) => any); response_body_mimetype: string; response_body_encode: ((output: any) => Buffer); input_schema: ((version: (null | string)) => type_oas_schema); output_schema: ((version: (null | string)) => type_oas_schema); }; /** */ type type_routenode = { operations: Record>; sub_branch: Record; sub_wildcard: (null | { name: string; node: type_routenode; }); }; /** */ type type_rest = { api: lib_plankton.api.type_api; routetree: type_routenode; versioning_method: ("none" | "path" | "header" | "query"); versioning_header_name: (null | string); versioning_query_key: (null | string); header_parameters: Array<{ name: string; description: (null | string); required: boolean; }>; set_access_control_headers: boolean; authentication: ({ kind: "none"; parameters: {}; } | { kind: "key_header"; parameters: { name: string; }; }); }; } declare namespace lib_plankton.rest { /** */ function make(options?: { title?: (null | string); versioning_method?: ("none" | "path" | "header" | "query"); versioning_header_name?: (null | string); versioning_query_key?: (null | string); header_parameters?: Array<{ name: string; description: (null | string); required: boolean; }>; set_access_control_headers?: boolean; authentication?: ({ kind: "none"; parameters: {}; } | { kind: "key_header"; parameters: { name: string; }; }); actions?: Array<{ http_method: lib_plankton.http.enum_method; path: string; options: { active?: ((version: string) => boolean); restriction?: (null | type_restriction); execution?: type_execution; title?: (null | string); description?: (null | string); query_parameters?: Array<{ name: string; description: (null | string); required: boolean; }>; input_schema?: ((version: string) => type_oas_schema); output_schema?: ((version: string) => type_oas_schema); request_body_mimetype?: string; request_body_decode?: ((http_request_body: Buffer, http_request_header_content_type: (null | string)) => any); response_body_mimetype?: string; response_body_encode?: ((output: any) => Buffer); }; }>; }): type_rest; /** */ function register(rest: type_rest, http_method: lib_plankton.http.enum_method, path: string, options: { active?: ((version: string) => boolean); restriction?: (null | type_restriction); execution?: type_execution; title?: (null | string); description?: (null | string); query_parameters?: Array<{ name: string; description: (null | string); required: boolean; }>; input_schema?: ((version: (null | string)) => type_oas_schema); output_schema?: ((version: (null | string)) => type_oas_schema); request_body_mimetype?: string; request_body_decode?: ((http_request_body: Buffer, http_request_header_content_type: (null | string)) => any); response_body_mimetype?: string; response_body_encode?: ((output: any) => Buffer); }): void; /** * @todo check request body mimetype? * @todo check query paramater validity */ function call(rest: type_rest, http_request: lib_plankton.http.type_request, options?: { checklevel_restriction?: lib_plankton.api.enum_checklevel; checklevel_input?: lib_plankton.api.enum_checklevel; checklevel_output?: lib_plankton.api.enum_checklevel; }): Promise; /** * @see https://swagger.io/specification/#openrest-object */ function to_oas(rest: type_rest, options?: { version?: (null | string); servers?: Array; }): any; } declare namespace lib_plankton.file { /** * @author fenris */ function exists(path: string): Promise; /** * @author fenris */ function read(path: string): Promise; /** * @author fenris */ function read_buffer(path: string): Promise; /** * @author fenris */ function read_stdin(): Promise; /** * @author fenris */ function write(path: string, content: string, options?: { encoding?: string; }): Promise; /** * @author fenris */ function write_buffer(path: string, content: Buffer, options?: {}): Promise; /** */ function delete_(path: string): Promise; } declare namespace lib_plankton.sha256 { /** * @author fenris */ function get(value: string, secret?: string): string; } declare namespace lib_plankton.args { /** */ enum enum_environment { cli = "cli", url = "url" } /** */ enum enum_kind { positional = "positional", volatile = "volatile" } /** */ enum enum_type { boolean = "boolean", integer = "int", float = "float", string = "string" } /** */ enum enum_mode { replace = "replace", accumulate = "accumulate" } } declare namespace lib_plankton.args { /** * @author fenris */ class class_argument { /** * @author fenris */ protected name: string; /** * @author fenris */ protected kind: enum_kind; /** * @author fenris */ protected type: enum_type; /** * @author fenris */ protected mode: enum_mode; /** * @author fenris */ protected default_: any; /** * @author fenris */ protected info: string; /** * @author fenris */ protected parameters: Object; /** * @author fenris */ protected hidden: boolean; /** * @author fenris */ constructor({ "name": name, "type": type, "kind": kind, "mode": mode, "default": default_, "info": info, "parameters": parameters, "hidden": hidden, }: { name: string; type?: enum_type; kind?: enum_kind; mode?: enum_mode; default?: any; info?: string; parameters?: Object; hidden?: boolean; }); /** * @author fenris */ static positional({ "name": name, "type": type, "mode": mode, "default": default_, "info": info, "hidden": hidden, "index": index, }: { name: string; type?: enum_type; mode?: enum_mode; default?: any; info?: string; hidden?: boolean; index: int; }): class_argument; /** * @author fenris */ static volatile({ "name": name, "type": type, "mode": mode, "default": default_, "info": info, "hidden": hidden, "indicators_short": indicators_short, "indicators_long": indicators_long, }: { name: string; type?: enum_type; mode?: enum_mode; default?: any; info?: string; hidden?: boolean; indicators_short: Array; indicators_long: Array; }): class_argument; /** * @author fenris */ check(): boolean; /** * @author fenris */ name_get(): string; /** * @author fenris */ kind_get(): enum_kind; /** * @author fenris */ type_get(): enum_type; /** * @author fenris */ mode_get(): enum_mode; /** * @author fenris */ default_get(): any; /** * @author fenris */ parameters_get(): Object; /** * @author fenris */ hidden_get(): boolean; /** * @author fenris */ toString(): string; /** * @author fenris */ indicator_main(): string; /** * @author fenris */ pattern_value(): string; /** * @author fenris */ extract(raw: string): any; /** * @author fenris */ assign(data: Object, target: string, raw: string): void; /** * @author fenris */ make(data: Object, target: string): string; /** * @author fenris */ generate_help(): string; } } declare namespace lib_plankton.args { /** * @author fenris */ var verbosity: int; /** * @author fenris * @todo check validity */ class class_handler { /** * @author fenris */ protected arguments_: { [name: string]: class_argument; }; /** * @author fenris */ constructor(arguments_: { [name: string]: class_argument; }); /** * @author fenris */ filter(kind: enum_kind): { [name: string]: class_argument; }; /** * @author fenris */ read(environment: enum_environment, input: string, data?: { [name: string]: any; }): { [name: string]: any; }; /** * @author fenris * @todo handle if the data object doesn't have the required field or the type is wrong or sth. */ write(environment: enum_environment, data: { [name: string]: any; }): string; /** * @desc manpage-like info-sheet * @author fenris */ generate_help({ "programname": programname, "author": author, "description": description, "executable": executable, }: { programname?: string; author?: string; description?: string; executable?: string; }): string; } } declare namespace lib_plankton.json { /** * @author fenris */ function encode(x: any, formatted?: boolean): string; /** * @author fenris */ function decode(x: string): any; } declare namespace lib_plankton.json { /** * @author fenris */ class class_json implements lib_plankton.code.interface_code { /** * @author fenris */ constructor(); /** * @implementation * @author fenris */ encode(x: any): string; /** * @implementation * @author fenris */ decode(x: string): any; } }