adminforth/adminforth/index.ts at main · davgit/adminforth · GitHub

Repository navigation

History

596 lines (520 loc) · 21 KB

Raw

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

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

import AdminForthAuth from './auth.js';

import MongoConnector from './dataConnectors/mongo.js';

import PostgresConnector from './dataConnectors/postgres.js';

import SQLiteConnector from './dataConnectors/sqlite.js';

import CodeInjector from './modules/codeInjector.js';

import ExpressServer from './servers/express.js';

// import FastifyServer from './servers/fastify.js';

import { ADMINFORTH_VERSION, listify, suggestIfTypo, RateLimiter, getClientIp } from './modules/utils.js';

import {

type AdminForthConfig,

type IAdminForth,

type IConfigValidator,

type AdminForthResourceColumn,

IOperationalResource,

IHttpServer,

AdminForthResource,

IAdminForthDataSourceConnectorBase,

IWebSocketBroker,

HttpExtra,

BeforeCreateSaveFunction,

AdminForthInputConfig,

} from './types/Back.js';

import {

AdminForthFilterOperators,

AdminForthDataTypes,

AdminUser,

} from './types/Common.js';

import AdminForthPlugin from './basePlugin.js';

import ConfigValidator from './modules/configValidator.js';

import AdminForthRestAPI, { interpretResource } from './modules/restApi.js';

import ClickhouseConnector from './dataConnectors/clickhouse.js';

import OperationalResource from './modules/operationalResource.js';

import SocketBroker from './modules/socketBroker.js';

// exports

export * from './types/Back.js';

export * from './types/Common.js';

export * from './types/Adapters.js';

export { interpretResource };

export { AdminForthPlugin };

export { suggestIfTypo, RateLimiter, getClientIp };

class AdminForth implements IAdminForth {

static Types = AdminForthDataTypes;

static Utils = {

generatePasswordHash: async (password) => {

return await AdminForthAuth.generatePasswordHash(password);

applyRegexValidation(value, validation) {

if (validation?.length) {

const validationArray = validation;

for (let i = 0; i < validationArray.length; i++) {

if (validationArray[i].regExp) {

let flags = '';

if (validationArray[i].caseSensitive) {

flags += 'i';

}

if (validationArray[i].multiline) {

flags += 'm';

}

if (validationArray[i].global) {

flags += 'g';

}

const regExp = new RegExp(validationArray[i].regExp, flags);

if (value === undefined || value === null) {

value = '';

}

let valueS = `${value}`;

if (!regExp.test(valueS)) {

return validationArray[i].message;

}

PASSWORD_VALIDATORS: {

UP_LOW_NUM_SPECIAL: {

regExp: '^(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*\$\$\\-_=\\+\\[\\]\\{\\}\\|;:\',\\.<>\\/\\?]).+$',

message: 'Password must include at least one uppercase letter, one lowercase letter, one number, and one special character'

UP_LOW_NUM: {

regExp: '^(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9]).+$',

message: 'Password must include at least one uppercase letter, one lowercase letter, and one number'

EMAIL_VALIDATOR: {

regExp: '^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,}$',

message: 'Email is not valid, must be in format example@test.com',

}

config: AdminForthConfig;

express: ExpressServer;

// fastify: FastifyServer;

auth: AdminForthAuth;

codeInjector: CodeInjector;

connectors: {

[dataSourceId: string]: IAdminForthDataSourceConnectorBase,

};

connectorClasses: any;

runningHotReload: boolean;

activatedPlugins: Array<AdminForthPlugin>;

configValidator: IConfigValidator;

restApi: AdminForthRestAPI;

websocket: IWebSocketBroker;

operationalResources: {

[resourceId: string]: IOperationalResource,

}

statuses: {

dbDiscover: 'running' | 'done',

}

constructor(config: AdminForthInputConfig) {

this.codeInjector = new CodeInjector(this);

this.configValidator = new ConfigValidator(this, config);

this.restApi = new AdminForthRestAPI(this);

this.websocket = new SocketBroker(this);

this.activatedPlugins = [];

this.configValidator.validateConfig();

this.activatePlugins();

this.express = new ExpressServer(this);

// this.fastify = new FastifyServer(this);

this.auth = new AdminForthAuth(this);

this.connectors = {};

this.statuses = {

dbDiscover: 'running',

};

console.log(`${this.formatAdminForth()} v${ADMINFORTH_VERSION} starting up`)

}

formatAdminForth() {

const NO_FORMAT='\x1b[0m'

const F_BOLD="\x1b[1m"

const C_AQUA="\x1b[38;5;14m"

const C_GREY70="\x1b[38;5;249m"

const C_GREY15="\x1b[48;5;235m"

return `${F_BOLD}${C_GREY70}${C_GREY15} 🚀 Admin${C_AQUA}Forth ${NO_FORMAT}`

}

async tr(this, msg: string, category: string = 'default', lang: string = 'en', params: any): Promise<string> {

// stub function to make a translation

if (params) {

for (const key in params) {

msg = msg.replace(new RegExp(`{${key}}`, 'g'), params[key]);

}

return msg;

}

activatePlugins() {

process.env.HEAVY_DEBUG && console.log('🔌🔌🔌 Activating plugins');

const allPluginInstances = [];

for (let resource of this.config.resources) {

for (let pluginInstance of resource.plugins || []) {

allPluginInstances.push({pi: pluginInstance, resource});

}

allPluginInstances.sort(({pi: a}, {pi: b}) => a.activationOrder - b.activationOrder);

allPluginInstances.forEach(

({pi: pluginInstance, resource}) => {

pluginInstance.modifyResourceConfig(this, resource);

const plugin = this.activatedPlugins.find((p) => p.pluginInstanceId === pluginInstance.pluginInstanceId);

if (plugin) {

process.env.HEAVY_DEBUG && console.log(`Current plugin pluginInstance.pluginInstanceId ${pluginInstance.pluginInstanceId}`);

throw new Error(`Attempt to activate Plugin ${pluginInstance.constructor.name} second time for same resource, but plugin does not support it.

To support multiple plugin instance pre one resource, plugin should return unique string values for each installation from instanceUniqueRepresentation`);

}

this.activatedPlugins.push(pluginInstance);

}

);

}

getPluginsByClassName<T>(className: string): T[] {

const plugins = this.activatedPlugins.filter((plugin) => plugin.className === className);

return plugins as T[];

}

getPluginByClassName<T>(className: string): T {

const plugins = this.getPluginsByClassName(className);

if (plugins.length > 1) {

throw new Error(`Multiple plugins with className ${className} found. Use getPluginsByClassName instead`);

}

if (plugins.length === 0) {

const similar = suggestIfTypo(this.activatedPlugins.map((p) => p.className), className);

throw new Error(`Plugin with className ${className} not found. ${similar ? `Did you mean ${similar}?` : ''}`);

}

return plugins[0] as T;

}

validateFieldGroups(fieldGroups: {

groupName: string;

columns: string[];

}[], fieldTypes: {

[key: string]: AdminForthResourceColumn;

}): void {

if (!fieldGroups) return;

const allColumns = Object.keys(fieldTypes);

fieldGroups.forEach((group) => {

group.columns.forEach((col) => {

if (!allColumns.includes(col)) {

const similar = suggestIfTypo(allColumns, col);

throw new Error(

`Group '${group.groupName}' has an unknown column '${col}'. ${

similar ? `Did you mean '${similar}'?` : ''

);

}

});

}

async discoverDatabases() {

this.statuses.dbDiscover = 'running';

this.connectorClasses = {

'sqlite': SQLiteConnector,

'postgres': PostgresConnector,

'postgresql': PostgresConnector,

'mongodb': MongoConnector,

'clickhouse': ClickhouseConnector,

};

if (!this.config.databaseConnectors) {

this.config.databaseConnectors = {...this.connectorClasses};

}

this.config.dataSources.forEach((ds) => {

const dbType = ds.url.split(':')[0];

if (!this.config.databaseConnectors[dbType]) {

throw new Error(`Database type '${dbType}' is not supported, consider using one of ${Object.keys(this.connectorClasses).join(', ')} or create your own data-source connector`);

}

this.connectors[ds.id] = new this.config.databaseConnectors[dbType]({url: ds.url});

});

await Promise.all(this.config.resources.map(async (res) => {

if (!this.connectors[res.dataSource]) {

const similar = suggestIfTypo(Object.keys(this.connectors), res.dataSource);

throw new Error(`Resource '${res.table}' refers to unknown dataSource '${res.dataSource}' ${similar

? `. Did you mean '${similar}'?` : 'Available dataSources: '+Object.keys(this.connectors).join(', ')}`

);

}

let fieldTypes = null;

try {

fieldTypes = await this.connectors[res.dataSource].discoverFields(res);

} catch (e) {

console.error(`Error discovering fields for resource '${res.table}' (In resource '${res.resourceId}')`, e);

}

if (fieldTypes !== null && !Object.keys(fieldTypes).length) {

throw new Error(`Table '${res.table}' (In resource '${res.resourceId}') has no fields or does not exist`);

}

if (fieldTypes === null) {

console.error(`⛔ DataSource ${res.dataSource} was not able to perform field discovery. It will not work properly`);

return;

}

if (!res.columns) {

res.columns = Object.keys(fieldTypes).map((name) => ({ name }));

}

res.columns.forEach((col, i) => {

if (!fieldTypes[col.name] && !col.virtual) {

const similar = suggestIfTypo(Object.keys(fieldTypes), col.name);

throw new Error(`Resource '${res.table}' has no column '${col.name}'. ${similar ? `Did you mean '${similar}'?` : ''}`);

}

// first find discovered values, but allow override

res.columns[i] = { ...fieldTypes[col.name], ...col };

});

this.validateFieldGroups(res.options.fieldGroups, fieldTypes);

this.validateFieldGroups(res.options.showFieldGroups, fieldTypes);

this.validateFieldGroups(res.options.createFieldGroups, fieldTypes);

this.validateFieldGroups(res.options.editFieldGroups, fieldTypes);

// check if primaryKey column is present

if (!res.columns.some((col) => col.primaryKey)) {

throw new Error(`Resource '${res.table}' has no column defined or auto-discovered. Please set 'primaryKey: true' in a columns which has unique value for each record and index`);

}

}));

this.statuses.dbDiscover = 'done';

for (const res of this.config.resources) {

this.configValidator.postProcessAfterDiscover(res);

}

this.operationalResources = {};

this.config.resources.forEach((resource) => {

this.operationalResources[resource.resourceId] = new OperationalResource(this.connectors[resource.dataSource], resource);

});

// console.log('⚙️⚙️⚙️ Database discovery done', JSON.stringify(this.config.resources, null, 2));

}

async bundleNow({ hotReload=false }) {

await this.codeInjector.bundleNow({ hotReload });

}

async getUserByPk(pk: string) {

// if database discovery is not done, throw

if (this.statuses.dbDiscover !== 'done') {

if (this.statuses.dbDiscover === 'running') {

throw new Error('Database discovery is running. You can\'t use data API while database discovery is not finished.\n'+

'Consider moving your code to a place where it will be executed after database discovery is already done (after await admin.discoverDatabases())');

}

throw new Error('Database discovery is not yet started. You can\'t use data API before database discovery is done. \n'+

'Call admin.discoverDatabases() first and await it before using data API');

}

const resource = this.config.resources.find((res) => res.resourceId === this.config.auth.usersResourceId);

if (!resource) {

const similar = suggestIfTypo(this.config.resources.map((res) => res.resourceId), this.config.auth.usersResourceId);

throw new Error(`No resource with ${this.config.auth.usersResourceId} found. ${similar ?

`Did you mean '${similar}' in config.auth.usersResourceId?` : 'Please set correct resource in config.auth.usersResourceId'}`

);

}

const users = await this.connectors[resource.dataSource].getData({

resource,

filters: [

{ field: resource.columns.find((col) => col.primaryKey).name, operator: AdminForthFilterOperators.EQ, value: pk },

limit: 1,

offset: 0,

sort: [],

});

return users.data[0] || null;

}

async createResourceRecord(

{ resource, record, adminUser, extra }:

{ resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }

): Promise<{ error?: string, createdRecord?: any }> {

// check if record with validation is valid

for (const column of resource.columns.filter((col) => col.name in record && col.validation)) {

const error = AdminForth.Utils.applyRegexValidation(record[column.name], column.validation);

if (error) {

return { error };

}

// check if record with minValue or maxValue is within limits

for (const column of resource.columns.filter((col) => col.name in record

&& ['integer', 'decimal', 'float'].includes(col.type)

&& (col.minValue !== undefined || col.maxValue !== undefined))) {

if (column.minValue !== undefined && record[column.name] < column.minValue) {

return { error: `Value in "${column.name}" must be greater than ${column.minValue}` };

}

if (column.maxValue !== undefined && record[column.name] > column.maxValue) {

return { error: `Value in "${column.name}" must be less than ${column.maxValue}` };

}

// execute hook if needed

for (const hook of listify(resource.hooks?.create?.beforeSave)) {

console.log('🪲 Hook beforeSave', hook);

const resp = await hook({

resource,

record,

adminUser,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

// remove virtual columns from record

for (const column of resource.columns.filter((col) => col.virtual)) {

if (record[column.name]) {

delete record[column.name];

}

const connector = this.connectors[resource.dataSource];

process.env.HEAVY_DEBUG && console.log('🪲🆕 creating record createResourceRecord', record);

const { error, createdRecord } = await connector.createRecord({ resource, record, adminUser });

if ( error ) {

return { error };

}

const primaryKey = record[resource.columns.find((col) => col.primaryKey).name];

// execute hook if needed

for (const hook of listify(resource.hooks?.create?.afterSave)) {

process.env.HEAVY_DEBUG && console.log('🪲 Hook afterSave', hook);

const resp = await hook({

recordId: primaryKey,

resource,

record: createdRecord,

adminUser,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

return { error, createdRecord };

}

/**

* record is partial record with only changed fields

async updateResourceRecord(

{ resource, recordId, record, oldRecord, adminUser, extra }:

{ resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }

): Promise<{ error?: string }> {

// check if record with validation is valid

for (const column of resource.columns.filter((col) => col.name in record && col.validation)) {

const error = AdminForth.Utils.applyRegexValidation(record[column.name], column.validation);

if (error) {

return { error };

}

// check if record with minValue or maxValue is within limits

for (const column of resource.columns.filter((col) => col.name in record

&& ['integer', 'decimal', 'float'].includes(col.type)

&& (col.minValue !== undefined || col.maxValue !== undefined))) {

if (column.minValue !== undefined && record[column.name] < column.minValue) {

return { error: `Value in "${column.name}" must be greater than ${column.minValue}` };

}

if (column.maxValue !== undefined && record[column.name] > column.maxValue) {

return { error: `Value in "${column.name}" must be less than ${column.maxValue}` };

}

// remove editReadonly columns from record

for (const column of resource.columns.filter((col) => col.editReadonly)) {

if (column.name in record)

delete record[column.name];

}

// execute hook if needed

for (const hook of listify(resource.hooks?.edit?.beforeSave)) {

const resp = await hook({

recordId,

resource,

record,

updates: record,

oldRecord,

adminUser,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

const newValues = {};

const connector = this.connectors[resource.dataSource];

for (const recordField in record) {

if (record[recordField] !== oldRecord[recordField]) {

// leave only changed fields to reduce data transfer/modifications in db

const column = resource.columns.find((col) => col.name === recordField);

if (!column || !column.virtual) {

// exclude virtual columns

newValues[recordField] = record[recordField];

}

if (Object.keys(newValues).length > 0) {

await connector.updateRecord({ resource, recordId, newValues });

}

// execute hook if needed

for (const hook of listify(resource.hooks?.edit?.afterSave)) {

const resp = await hook({

resource,

record,

updates: record,

adminUser,

oldRecord,

recordId,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

return { error: null };

}

async deleteResourceRecord(

{ resource, recordId, adminUser, record, extra }:

{ resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, extra?: HttpExtra }

): Promise<{ error?: string }> {

// execute hook if needed

for (const hook of listify(resource.hooks?.delete?.beforeSave)) {

const resp = await hook({

resource,

record,

adminUser,

recordId,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

const connector = this.connectors[resource.dataSource];

await connector.deleteRecord({ resource, recordId});

// execute hook if needed

for (const hook of listify(resource.hooks?.delete?.afterSave)) {

const resp = await hook({

resource,

record,

adminUser,

recordId,

adminforth: this,

extra,

});

if (!resp || (!resp.ok && !resp.error)) {

throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);

}

if (resp.error) {

return { error: resp.error };

}

return { error: null };

}

resource(resourceId: string): IOperationalResource {

if (this.statuses.dbDiscover !== 'done') {

if (this.statuses.dbDiscover === 'running') {

throw new Error('Database discovery is running. You can\'t use data API while database discovery is not finished.\n'+

'Consider moving your code to a place where it will be executed after database discovery is already done (after await admin.discoverDatabases())');

} else {

throw new Error('Database discovery is not yet started. You can\'t use data API before database discovery is done. \n'+

'Call admin.discoverDatabases() first and await it before using data API');

}

if (!this.operationalResources[resourceId]) {

const closeName = suggestIfTypo(Object.keys(this.operationalResources), resourceId);

throw new Error(`Resource with id '${resourceId}' not found${closeName ? `. Did you mean '${closeName}'?` : ''}`);

}

return this.operationalResources[resourceId];

}

setupEndpoints(server: IHttpServer) {

this.restApi.registerEndpoints(server);

}

export default AdminForth;

adminforth/adminforth/index.ts at main · davgit/adminforth · GitHub

Repository navigation

Expand file tree

Breadcrumbs

index.ts

Latest commit

History

Breadcrumbs

index.ts

File metadata and controls