tibi-types/index.d.ts

583 lines
14 KiB
TypeScript
Raw Normal View History

2021-08-16 10:23:45 +02:00
export interface CollectionDocument {
id?: string
insertTime?: Date
updateTime?: Date
[key: string]: any
}
2021-08-19 14:22:42 +02:00
export interface DbReadOptions {
2021-08-16 10:23:45 +02:00
filter?: {
[key: string]: any
}
selector?: {
[key: string]: any
}
projection?: string
offset?: number
limit?: number
sort?: string[]
2022-01-13 18:38:02 +01:00
pipelineMod?: (pipe: { [key: string]: any }[]) => { [key: string]: any }[]
2021-08-16 10:23:45 +02:00
}
2021-08-16 10:48:03 +02:00
interface GetHookGetOnlyData {
2021-08-16 10:23:45 +02:00
/**
* true if only one document was requested via /COLLECTION/ID
*/
one?: boolean
/**
* get list of documents (only valid after stage "read" in "get" hook)
*/
results(): CollectionDocument[]
2021-08-16 10:48:03 +02:00
}
interface GetHookData {
2021-08-16 10:23:45 +02:00
/**
* filter map only valid for "get" hooks
*/
filter?: {
[key: string]: any
}
/**
* selector map only valid for "get" hooks
*/
selector?: {
[key: string]: any
}
/**
* offset only valid for "get" hooks
*/
offset?: number
/**
* limit only valid for "get" hooks
*/
limit?: number
/**
* sort only valid for "get" hooks
*/
sort?: string[] | string
2021-11-11 17:13:29 +01:00
/**
* pipelineMod is a function to modify the mongodb query pipeline
*/
2022-01-13 18:38:02 +01:00
pipelineMod?: (pipe: { [key: string]: any }[]) => { [key: string]: any }[]
2021-08-16 10:23:45 +02:00
}
interface PostHookData {
/**
* post data only valid in "post" and "put" hooks
*/
data?: CollectionDocument
}
2021-08-19 14:22:42 +02:00
interface DbPackage {
2021-08-16 10:23:45 +02:00
/**
* read results from a collection
*
* @param colName collection name
* @param options options map
*/
2022-01-13 18:38:02 +01:00
find(colName: string, options?: DbReadOptions): CollectionDocument[]
2021-08-16 10:23:45 +02:00
/**
* read count of documents for filter from a collection
*
* @param colName collection name
* @param options options map (only filter is valid)
*/
2022-01-13 18:38:02 +01:00
count(colName: string, options?: DbReadOptions): number
2021-08-16 10:23:45 +02:00
/**
* create a document in a collection
*
* @param colName collection name
* @param data data map
*/
2022-01-13 18:38:02 +01:00
create(colName: string, data: CollectionDocument): CollectionDocument
2021-08-16 10:23:45 +02:00
/**
* update a document in a collection
*
* @param colName collection name
* @param id id of entry
* @param data new/changed data
*/
2021-08-19 14:22:42 +02:00
update(
2021-08-16 10:23:45 +02:00
colName: string,
id: string,
data: CollectionDocument
): CollectionDocument
/**
* deletes one document by id from collection
*
* @param colName collection name
* @param id id of entry
*/
2021-08-19 14:22:42 +02:00
delete(colName: string, id: string): { message: "ok" }
2021-08-16 10:23:45 +02:00
/**
* deletes documents by filter from collection
*
* @param colName collection name
* @param options options map, only filter valid
*/
2021-08-19 14:22:42 +02:00
deleteMany(
2021-08-16 10:23:45 +02:00
colName: string,
2021-08-19 14:22:42 +02:00
options?: DbReadOptions
2021-08-16 10:23:45 +02:00
): { message: "ok"; removed: number }
2021-08-19 14:22:42 +02:00
}
2021-08-19 16:00:35 +02:00
interface SmtpPackage {
2021-08-16 10:23:45 +02:00
/**
* send an email
*
* @param options email options map
*/
2021-08-19 16:00:35 +02:00
sendMail(options: {
2021-08-16 10:23:45 +02:00
to: string | string[]
cc?: string | string[]
bcc?: string | string[]
subject?: string
from: string
fromName?: string
replyTo?: string
plain?: string
html?: string
attach?: string | string[]
}): void
2021-08-19 14:22:42 +02:00
}
interface FsPackage {
2022-02-08 18:49:52 +01:00
/**
* get directory path of api config file
*
*/
2022-02-08 18:54:53 +01:00
configDir(): string
2022-02-08 18:49:52 +01:00
2021-08-19 14:22:42 +02:00
/**
* read a file relative to config dir and return its content
*
* @param path relative file path
2022-02-03 17:20:13 +01:00
* @param options optional options
2021-08-19 14:22:42 +02:00
*/
2022-02-03 17:20:13 +01:00
readFile(path: string, options?: {
bytes: boolean // if true return []byte instead of string
2022-02-08 18:49:52 +01:00
}): string | any
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
/**
* stat file or directory
*
* @param path
*/
stat(path: string): {
name: string
size: number
isDir: boolean
modTime: string
}
/**
* list directory entries
*
* @param path
*/
readDir(path: string): {
name: string
size: number
isDir: boolean
modTime: string
}[]
/**
* make directory and all missing sub directories, no error if directory already exists
*
* @param path
*/
mkDir(path: string): void
/**
* remove file or empty directory
*
* @param path
*/
remove(path: string): void
}
2021-08-19 16:00:35 +02:00
interface TplPackage {
2021-08-16 10:23:45 +02:00
/**
* execute a template code and return result
*
* @param code template code
* @param contextData template context map
*/
2021-08-19 15:02:01 +02:00
execute(
2021-08-16 10:23:45 +02:00
code: string,
contextData?: {
[key: string]: any
}
): string
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface HttpPackage {
2021-08-16 10:23:45 +02:00
/**
* http request
*
* @param url url for request
* @param options request options
*/
fetch(
url: string,
options?: {
method?: string
headers?: { [key: string]: string }
body?: string
}
): {
status: number
statusText: string
headers: { [key: string]: string }
trailer: { [key: string]: string }
url: string
body: {
text(): string
json(): any
}
}
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface DebugPackage {
2021-08-16 10:23:45 +02:00
/**
* dumps data to header and server log
*
* @param toDump data to dump
*/
dump(...toDump: any): void
2021-08-19 14:22:42 +02:00
/**
* get Sentry trace id
*/
sentryTraceId(): string
}
interface ResponsePackage {
2021-08-16 10:23:45 +02:00
/**
* set response header
*
* @param name header name
* @param value value
*/
header(name: string, value: any): void
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface UserPackage {
2021-08-16 10:23:45 +02:00
/**
* get JWT authentication
*/
auth(): {
id: string
username: string
role: number
permissions: string[]
}
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface BcryptPackage {
2021-08-16 10:23:45 +02:00
/**
* hash password via bcrypt algo
*
* @param password clear text password
* @param options hashing options
*/
2021-08-19 14:22:42 +02:00
hash(
2021-08-16 10:23:45 +02:00
password: string,
options?: {
cost?: number
}
): string
/**
* check password against hashed password via bcrypt algo
*
* @param password clear text password
* @param hash hashed password
*/
2021-08-19 14:22:42 +02:00
check(password: string, hash: string): boolean
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface JwtPackage {
2021-08-16 10:23:45 +02:00
/**
* create a jwt signed token string
*
* @param claims data object
* @param options options (secret, validityDuration = expiry in X seconds)
*/
2021-08-19 14:32:38 +02:00
create(
2021-08-16 10:23:45 +02:00
claims: {
[key: string]: any
},
options?: {
secret?: string
validityDuration?: number
}
): string
/**
* parse jwt token string
*
* @param token token string
* @param options options (secret)
*/
2021-08-19 14:32:38 +02:00
parse(
2021-08-16 10:23:45 +02:00
token: string,
options?: {
secret?: string
}
): {
error?: string
valid: boolean
method: {
Name: string
Hash: number
}
header: {
alg: string
typ: string
}
claims: {
exp?: number
[key: string]: any
}
}
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
2021-08-19 14:22:42 +02:00
interface CharsetPackage {
2021-08-16 10:23:45 +02:00
/**
* convert iso8859 to utf8
*
* @param iso8859 iso string
*/
iso8859ToUtf8(iso8859: string): string
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:35:56 +02:00
2021-08-19 14:22:42 +02:00
interface ImagePackage {
2021-08-16 10:35:56 +02:00
/**
* convert image from source file to target file with filters
*
* @param sourceFile
* @param targetFile
* @param filters
*/
2021-08-19 14:22:42 +02:00
filter(
2021-08-16 10:35:56 +02:00
sourceFile: string,
targetFile: string,
filters: {
fit?: boolean
fill?: boolean
width?: number
height?: number
brightness?: number
saturation?: number
contrast?: number
gamma?: number
blur?: number
sharpen?: number
invert?: boolean
grayscale?: boolean
quality?: number
}[]
): void
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:35:56 +02:00
2021-08-19 14:22:42 +02:00
interface XmlPackage {
2021-08-16 17:32:34 +02:00
/**
* create xml string
2022-01-13 18:38:02 +01:00
*
2021-08-16 17:32:34 +02:00
* @param data object or array
* @param options options
*/
2021-08-19 14:22:42 +02:00
create(data: any, options?: {}): string
2021-08-16 17:32:34 +02:00
/**
* parse xml string to json
2022-01-13 18:38:02 +01:00
*
2021-08-16 17:32:34 +02:00
* @param xml xml string
* @param options options
*/
2022-01-13 18:38:02 +01:00
parse(xml: string, options?: {}): any
2021-08-19 14:22:42 +02:00
}
2021-08-17 13:26:39 +02:00
2021-08-19 14:22:42 +02:00
interface CookiePackage {
2021-08-17 13:26:39 +02:00
/**
* get cookie from http header
2022-01-13 18:38:02 +01:00
*
2021-08-17 13:26:39 +02:00
* @param name cookie name
*/
2021-08-19 14:22:42 +02:00
get(name: string): string
2021-08-17 13:26:39 +02:00
/**
* set cookie via http header
2022-01-13 18:38:02 +01:00
*
2021-08-17 13:26:39 +02:00
* @param name cookie name
* @param value cookie value
* @param options cookie options
*/
2022-01-13 18:38:02 +01:00
set(
name: string,
value: string,
options?: {
maxAge?: number
path?: string
domain?: string
secure?: boolean
httpOnly?: boolean
}
): void
}
interface PdfPackage {
/**
* generate pdf from html
*
* @param html html string
* @param options options
2022-02-03 17:20:13 +01:00
*
* @returns []byte of pdf data
2022-01-13 18:38:02 +01:00
*/
fromHTML(
html: string,
options?: {
copies?: number // Number of copies to print into the pdf file (default 1)
dpi?: number // Change the dpi explicitly (this has no effect on X11 based systems)
grayscale?: boolean // PDF will be generated in grayscale
imageDpi?: number // When embedding images scale them down to this dpi (default 600)
imageQuality?: number // When jpeg compressing images use this quality (default 94)
lowQuality?: boolean // Generates lower quality pdf/ps. Useful to shrink the result document space
marginBottom?: number // Set the page bottom margin
marginLeft?: number // Set the page left margin (default 10mm)
marginRight?: number // Set the page right margin (default 10mm)
marginTop?: number // Set the page top margin
noCollate?: boolean // Do not collate when printing multiple copies (default collate)
noPdfCompression?: boolean // Do not use lossless compression on pdf objects
orientation?: "Portrait" | "Landscape" // Set orientation to Landscape or Portrait (default Portrait)
pageHeight?: number // Page height
pageSize?: string // Set paper size to: A4, Letter, etc. (default A4)
pageWidth?: number // Page width
title?: string // The title of the generated pdf file (The title of the first document is used if not specified)
// page settings
printMediaType?: boolean // Use print media-type instead of screen
footerCenter?: string // Centered footer text
footerFontName?: string // Set footer font name (default Arial)
footerFontSize?: number // Set footer font size (default 12)
footerLeft?: string // Left aligned footer text
footerLine?: boolean // Display line above the footer
footerRight?: string // Right aligned footer text
footerSpacing?: number // Spacing between footer and content in mm (default 0)
2022-02-04 10:38:35 +01:00
footerHTML?: string // URL to footer html
2022-01-13 18:38:02 +01:00
headerCenter?: string // Centered header text
headerFontName?: string // Set header font name (default Arial)
headerFontSize?: number // Set header font size (default 12)
headerLeft?: string // Left aligned header text
headerLine?: boolean // Display line below the header
headerRight?: string // Right aligned header text
headerSpacing?: number // Spacing between header and content in mm (default 0)
2022-02-04 10:38:35 +01:00
headerHTML?: string // URL to header html
2022-01-13 18:38:02 +01:00
}
): any
2022-02-03 17:20:13 +01:00
/**
* process existing pdf data
*
* @param command pdfcpu command
2022-02-08 16:06:09 +01:00
* @param pdfData []byte of pdf data, multiple []byte as array of pdf's to merge or object with description to create
2022-02-03 17:20:13 +01:00
* @param options options
*
* @returns []byte of new pdf data
*/
cpu(
2022-02-08 16:06:09 +01:00
command: "watermark" | "stamp" | "merge" | "rotate" | "create",
2022-02-05 10:57:29 +01:00
pdfData: any | any[],
options?: {
2022-02-04 11:14:02 +01:00
pages?: (string | number)[]
description?: {
2022-02-08 16:06:09 +01:00
fontname?: string
points?: number
rtl?: boolean
position?: "full" | "tl" | "tc" | "tr" | "l" | "c" | "r" | "bl" | "bc" | "br"
offset?: string
2022-02-08 18:49:52 +01:00
scalefactor?: number | string
2022-02-08 16:06:09 +01:00
aligntext?: "left" | "center" | "right" | "justified"
strokecolor?: string
fillcolor?: string
backgroundcolor?: string
rotation?: number
diagonal?: 1|2
opacity?: number
rendermode?: 0|1|2
margins?: number | string
border?: number | string
url?: string
2022-02-04 10:38:35 +01:00
}
2022-02-05 10:57:29 +01:00
mode?: "text" | "image" | "pdf"
2022-02-04 11:14:02 +01:00
bytes?: any // []byte of watermark image
file?: string // file for pdf watermark
2022-02-08 16:11:43 +01:00
text?: string // text for text watermark
2022-02-08 16:06:09 +01:00
rotation?: number
2022-02-03 17:20:13 +01:00
}
): any
2021-08-16 10:23:45 +02:00
}
2022-01-13 18:38:02 +01:00
export interface HookContext
extends GetHookData,
GetHookGetOnlyData,
PostHookData {
2021-08-19 14:22:42 +02:00
request(): {
method: string
remoteAddr: string
host: string
url: string
path: string
param(p: string): string
query(q: string): string
header(h: string): string
body(): string
/**
* bodyBytes return []byte go slice of post body for later use pe. in iso8859ToUtf8
*/
bodyBytes(): string
}
db: DbPackage
2021-08-19 16:00:35 +02:00
smtp: SmtpPackage
2021-08-19 14:22:42 +02:00
fs: FsPackage
2021-08-19 16:00:35 +02:00
tpl: TplPackage
2021-08-19 14:22:42 +02:00
http: HttpPackage
debug: DebugPackage
2021-08-19 14:30:37 +02:00
response: ResponsePackage
2021-08-19 14:22:42 +02:00
user: UserPackage
bcrypt: BcryptPackage
jwt: JwtPackage
charset: CharsetPackage
image: ImagePackage
xml: XmlPackage
cookie: CookiePackage
2022-01-13 18:38:02 +01:00
pdf: PdfPackage
2021-08-19 14:22:42 +02:00
}
2021-08-16 10:23:45 +02:00
export interface HookException {
status?: number
html?: string
2022-01-13 18:38:02 +01:00
string?: string
bytes?: any
2021-08-16 10:35:56 +02:00
file?: string
2021-08-16 10:23:45 +02:00
[key: string]: any
}
export interface HookResponse extends GetHookData, PostHookData {
data?: CollectionDocument
2021-08-16 10:48:03 +02:00
results?: any
2021-08-16 10:23:45 +02:00
}
declare global {
var context: HookContext
2021-08-16 10:35:56 +02:00
}