GeezerVison is showing github.com — forms-angular/src/server/index.d.ts at main · forms-angular/forms-angular

Expand file tree

index.d.ts

Copy path

More file actions

Latest commit

History

138 lines (118 loc) · 5.01 KB

index.d.ts

Copy path

File metadata and controls

138 lines (118 loc) · 5.01 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

import { Error, FilterQuery, Model, Types } from "mongoose";

import {Express} from "express";

declare module fngServer {

export interface ISearchResult {

id: any,

text: string,

url?: string,

additional?: string,

resource?: string,

resourceText: string,

resourceTab?: string,

weighting: number,

}

interface IInternalSearchResult extends ISearchResult {

// for use in internal find - handles search result ordering etc.

searchImportance? : number;

addHits?: number;

matched: number[];

exact?: boolean; // a single field exactly equals the (single-word) search string

resourceCollection: string;

// the next two are only set where the resource options includes disambiguation instructions and multiple search results with the same text value are found...:

disambiguationId?: any; // this will identify the record (from another resource) that will be used to disambiguate them

disambiguationResource?: string ;// ...and this will identify that resource

}

export interface IIdIsList {

params: string;

}

export interface Path {

}

export interface Paths {

[pathName: string]: Path;

}

export type ISearchResultFormatter = () => Promise<ISearchResult>;

export type Dependency = {

resource: Resource;

keys: string[];

}

export type DependencyList = Dependency[];

export type ForeignKeys = { resourceName: string, key: string, id: Types.ObjectId};

export type ForeignKeyList = ForeignKeys[];

export interface ResourceOptions {

suppressDeprecatedMessage?: boolean;

onRemove?: (doc, req, cb) => void;

handleRemove?: 'allow' | 'cascade'; // default behaviour is to prevent deletion if record is used as a foreign key

searchImportance?: boolean | number,

searchExactBonus?: boolean, // false stops an exact match ranking this resource's results above those of more important resources

onSave?: (doc, req, cb) => void,

onSaveError?: (err:Error, req: Express.Request, res: Express.Response) => void,

findFunc?: (req: Express.Request, cb: (err:Error, criteria?: FilterQuery<any>) => void) => void,

getOrgCriteria?: (userOrganisation: string) => Promise<any>

idIsList?: IIdIsList,

searchResultFormat?: ISearchResultFormatter,

searchOrder?: any,

doNotCacheSchema?: boolean, // useful if bespoke fields can be added at runtime, for instance

listOrder?: any,

onAccess?: (req, cb) => void,

searchFunc?: SearchFunc;

synonyms? : {name: string, filter?: any}[], // name must be lower case

resourceName?: string, // allows a resource to have diference modelName specified

// when performing a search, two results from this resource with the same value for .text will be disambiguated by

// appending the description of the record from disambiguation.resource whose id matches result[disambiguation.field]

disambiguation?: {

field: string;

resource: string;

}

// below here are autogenerated

listFields?: ListField[]; // added after preprocess

dependents?: DependencyList; // can be added by generateDependencyList

hide? : string[]; // added after preprocess

searchFields? : string[]; // added after preprocess

paths?: Paths;

}

type SearchFunc = (resource: Resource,

req: Express.Request,

aggregationParam: any,

findParam: any,

sortOrder: any,

limit: number | null,

skip: number | null,

callback: (err: Error, docs?: any[]) => void

) => void;

interface ResourceExport {

model?: Model<any>; // TODO TS Get rid of the ? here

options?: ResourceOptions;

}

interface Resource extends ResourceExport {

resourceName: string;

resourceNameLower: string;

preprocessed?: {[formName: string] : any};

}

interface ListParams {

ref: Boolean; // The object is this a lookup?

}

interface ListField {

field: string;

params?: ListParams;

}

interface IFngPlugin {

plugin: (fng: any, processArgs: (options: FngOptions, array: any[]) => any[], options: any) => Partial<IFngPlugin>;

options: any;

dependencyChecks? : { [resourceName: string] : DependencyList; };

}

interface IPluginMap {

[key: string]: IFngPlugin;

}

interface FngOptions {

urlPrefix?: string,

plugins?: IPluginMap,

authentication?: (() => void)[];

modelFilter? : (p1: any, req: Request, resources: Resource[]) => Resource[]

}

type AmbiguousRecordStore<t> = { [resource: string]: t[] };

interface DisambiguatableLookupItem {

id: string;

text: string;

disambiguationId?: string;

}