@xitkov/core 2.4.9

package/README.md

@@ -0,0 +1,256 @@
+# Xitkov
+
+TypeScript backend meta-framework on Express. Convention-over-configuration REST APIs, dual database dialect (MongoDB + Postgres), microservice HTTP clients, hooks, auth, cache, queue, sockets — one dependency.
+
+## Install
+
+```bash
+npm install xitkov
+```
+
+## Quickstart
+
+Project layout:
+
+```
+src/
+├─ index.ts
+├─ services/
+│  └─ users/
+│     ├─ service.ts     # extends XitkovService
+│     ├─ model.ts       # mongoose or sequelize model
+│     ├─ validator.ts   # optional Joi schemas
+│     └─ hooks.ts       # optional per-method hooks
+└─ micro-services/
+   └─ billing.ts        # optional external service client
+```
+
+`src/index.ts`:
+
+```ts
+import express from 'express';
+import { Xitkov } from 'xitkov';
+
+const app = express();
+
+Xitkov.create({
+  app,
+  database: { dialect: 'mongodb', instance: mongooseConnection },
+  auth: { required: true, baseURL: 'https://auth.example.com' },
+  caching: { redisUrl: 'redis://localhost:6379', keyPrefix: 'app:' },
+  socket: { enable: true, socketCorsOrigin: '*' },
+});
+```
+
+`src/services/users/service.ts`:
+
+```ts
+import { XitkovService } from 'xitkov';
+import Model from './model';
+
+export default class UserService extends XitkovService<User> {
+  constructor() {
+    super({ Model, dialect: 'mongodb' });
+  }
+}
+```
+
+Boots with REST routes:
+
+| Method | Path | Handler |
+|--------|------|---------|
+| GET    | `/users`     | `find`   |
+| GET    | `/users/:id` | `get`    |
+| POST   | `/users`     | `create` |
+| PATCH  | `/users/:id` | `patch`  |
+| PUT    | `/users/:id` | `update` |
+| DELETE | `/users/:id` | `remove` |
+
+## Core APIs
+
+### `Xitkov`
+
+Bootstrapper. Registers services, wires cache/socket/logger, listens on `PORT`.
+
+```ts
+new Xitkov(config)              // fire-and-forget, use `xitkov.ready`
+await Xitkov.create(config)     // async factory, resolves after boot
+```
+
+**`Config`**
+
+| Field | Type | Purpose |
+|-------|------|---------|
+| `app` | `Application` | Existing Express app |
+| `database.dialect` | `'mongodb' \| 'postgres'` | Backing store |
+| `database.instance` | `any` | Sequelize instance (postgres) |
+| `auth.required` | `boolean` | Enforce JWT verify on every route |
+| `auth.baseURL` | `string` | Verify endpoint (POST `/verify`) |
+| `caching.redisUrl` | `string` | Redis URL for `Cache` |
+| `caching.keyPrefix` | `string` | Key namespace |
+| `socket.enable` | `boolean` | Boot socket.io |
+| `socket.redis` | `{ url?, redisOptions? }` | Redis pub/sub adapter |
+| `socket.socketCorsOrigin` | `string` | Socket CORS |
+| `logger.express` | `LoggerOptions` | express-winston passthrough |
+| `express.limit` | `string` | Body-parser limit (default `50mb`) |
+
+### `XitkovService<T>`
+
+Base class every service extends. Wraps dialect-specific implementation.
+
+Methods: `find`, `get`, `create`, `patch`, `update`, `remove` — plus underscored bypass variants `_find` … `_remove` (skip hooks + validators when called internally).
+
+Instance flags:
+- `pagination?: boolean` — postgres `findAndCountAll`
+- `filtering?: boolean` — toggle `addQuerySupport` translation (default on)
+- `auth?: boolean` — set `false` to disable auth on this service
+
+### `MicroService`
+
+Typed Axios client with the same CRUD shape. Auto-created for every entry in `/micro-services`.
+
+```ts
+export default class BillingService {
+  name = 'billing'
+  baseURL = process.env.BILLING_URL!
+  services = ['invoices', 'customers']
+}
+
+// then anywhere:
+const invoice = await MicroServices.get('billing', 'invoices').get('inv_1');
+```
+
+Per-call options:
+
+```ts
+await MicroServices.get('billing', 'invoices').get(id, undefined, {
+  axiosConfig: { timeout: 5000 },
+  exception: { handle: true, defaultValue: null },
+});
+```
+
+### Hooks
+
+Drop `hooks.ts` next to a service; export default class with method arrays:
+
+```ts
+import { setBusinessId, loggedIn } from 'xitkov';
+
+export default class UserHooks {
+  all = [loggedIn]
+  find = [setBusinessId]
+  create = [setBusinessId]
+}
+```
+
+Built-in hooks: `disallow`, `externalDisallow`, `loggedIn`, `setBusinessId`, `addQuerySupport`.
+
+### Errors
+
+All extend `Error`. Throw them; framework maps to HTTP:
+
+```ts
+import { BadRequest, NotFound, Unauthorized } from 'xitkov';
+
+throw new NotFound('User not found');
+```
+
+Classes: `BadRequest` (400), `NoContent` (204), `Unauthorized` (401), `PaymentRequired` (402), `Forbidden` (403), `NotFound` (404), `InternalServer` (500).
+
+### Cache
+
+Redis wrapper (ioredis).
+
+```ts
+import { Cache } from 'xitkov';
+
+await Cache.set('key', value, 300);   // TTL in seconds
+const value = await Cache.get('key');
+await Cache.delete('key');
+```
+
+### Queue
+
+Bull wrapper with env-scoped names (`name_dev`, `name_staging`, bare in prod).
+
+```ts
+import { Queue } from 'xitkov';
+
+const emails = new Queue<{ to: string }>('emails', process.env.REDIS_URL!);
+await emails.add({ to: 'a@b.com' });
+emails.consume(async job => sendEmail(job.data));
+```
+
+### Socket
+
+Socket.io helper. Redis adapter attached when `socket.redis` provided.
+
+```ts
+import { Socket } from 'xitkov';
+
+Socket.emit('event', payload);
+Socket.client(socket => {
+  socket.on('ping', () => socket.emit('pong'));
+});
+```
+
+### Logger
+
+Winston-backed static class. Local dev logs to console; prod to structured JSON.
+
+```ts
+import { Logger } from 'xitkov';
+
+Logger.info('boot', { port });
+Logger.error('failed', err);
+```
+
+### Events
+
+```ts
+import { XitkovEvents, EVENTS } from 'xitkov';
+
+XitkovEvents.on(EVENTS.SERVICES_REGISTERED, () => {});
+XitkovEvents.on(EVENTS.SERVER_STARTED, port => {});
+```
+
+### Query operators (postgres)
+
+`addQuerySupport` translates `$op` shorthand → Sequelize `Op`:
+
+```
+GET /users?age[$gte]=18&status[$in]=["active","pending"]
+```
+
+Reserved: `$limit`, `$offset` for pagination.
+
+## Environment variables
+
+| Var | Default | Purpose |
+|-----|---------|---------|
+| `PORT` | `3000` | HTTP listen port |
+| `NODE_ENV` | — | Set `local` to disable Winston, use console |
+| `ENVIRONMENT` | `dev` | Bull queue name suffix (`prod` → bare) |
+| `INTERNAL_TOKEN` | `internal_token` | Shared secret for microservice-to-microservice calls (bypasses auth) |
+
+## Type augmentation
+
+Register your services for typed access:
+
+```ts
+declare module 'xitkov' {
+  interface ServiceTypes {
+    users: UserService
+  }
+  interface MicroServiceNames {
+    billing: {
+      invoices: MicroService
+      customers: MicroService
+    }
+  }
+}
+```
+
+## License
+
+MIT

package/lib/app.d.ts

@@ -0,0 +1,75 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Server } from 'http';
+import EventEmitter from 'events';
+import { Application } from 'express';
+import { RedisOptions } from 'ioredis';
+import { MicroServiceNames, ServiceTypes, SubMicroServiceNames } from '.';
+import { MicroService } from './services';
+import { LoggerOptions } from 'express-winston';
+export declare const EVENTS: {
+    SERVER_STARTED: string;
+    SERVICES_REGISTERED: string;
+};
+export declare class Services {
+    private static services;
+    static get<T extends keyof ServiceTypes>(service: T): ServiceTypes[T];
+    static set(services: any): void;
+}
+export interface IMicroServices {
+    [microService: string]: {
+        [service: string]: MicroService;
+    };
+}
+export declare class MicroServices {
+    private static services;
+    static get<U extends keyof MicroServiceNames, T extends keyof SubMicroServiceNames>(microServiceName: U, service: T): MicroService;
+    static set(services: IMicroServices): void;
+}
+export declare const XitkovEvents: EventEmitter;
+export type Dialect = 'mongodb' | 'postgres';
+export interface IExpressOptions {
+    limit?: string;
+}
+export interface IAuth {
+    required: boolean;
+    baseURL: string;
+}
+export interface ISocket {
+    enable: boolean;
+    socketCorsOrigin: string;
+    redis?: {
+        url?: string;
+        redisOptions?: RedisOptions;
+    };
+}
+export interface Config {
+    app: Application;
+    database?: {
+        dialect?: Dialect;
+        instance?: any;
+    };
+    auth?: IAuth;
+    socket?: ISocket;
+    logger?: {
+        express?: Partial<LoggerOptions>;
+    };
+    caching?: {
+        redisUrl: string;
+        keyPrefix: string;
+        redisOptions?: RedisOptions;
+    };
+    express?: IExpressOptions;
+}
+export declare class Xitkov {
+    readonly app: Application;
+    readonly server: Server;
+    readonly ready: Promise<void>;
+    constructor(config: Config);
+    static create(config: Config): Promise<Xitkov>;
+    private bootstrap;
+    private init;
+    private initExpress404;
+    private initSocket;
+    private initCache;
+}

package/lib/app.js

@@ -0,0 +1,143 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Xitkov = exports.XitkovEvents = exports.MicroServices = exports.Services = exports.EVENTS = void 0;
+const http_1 = require("http");
+const events_1 = __importDefault(require("events"));
+const express_1 = __importDefault(require("express"));
+const socket_io_1 = require("socket.io");
+const redis_adapter_1 = require("@socket.io/redis-adapter");
+const ioredis_1 = __importDefault(require("ioredis"));
+const _1 = require(".");
+const services_1 = require("./services");
+const register_services_1 = require("./services/register-services");
+const libs_1 = require("./libs");
+exports.EVENTS = {
+    SERVER_STARTED: 'SERVER_STARTED',
+    SERVICES_REGISTERED: 'SERVICES_REGISTERED',
+};
+class Services {
+    static get(service) {
+        return this.services[service];
+    }
+    static set(services) {
+        Services.services = services;
+    }
+}
+exports.Services = Services;
+class MicroServices {
+    static get(microServiceName, service) {
+        return this.services[microServiceName][service];
+    }
+    static set(services) {
+        MicroServices.services = services;
+    }
+}
+exports.MicroServices = MicroServices;
+exports.XitkovEvents = new events_1.default();
+class Xitkov {
+    constructor(config) {
+        var _a;
+        const { app, database, express, auth, logger, socket, caching } = config;
+        this.app = app;
+        this.server = new http_1.Server(app);
+        this.init((_a = express === null || express === void 0 ? void 0 : express.limit) !== null && _a !== void 0 ? _a : '50mb', logger === null || logger === void 0 ? void 0 : logger.express);
+        this.initSocket(socket === null || socket === void 0 ? void 0 : socket.enable, socket === null || socket === void 0 ? void 0 : socket.redis, socket === null || socket === void 0 ? void 0 : socket.socketCorsOrigin);
+        this.ready = this.bootstrap(auth, database, caching);
+    }
+    static async create(config) {
+        const instance = new Xitkov(config);
+        await instance.ready;
+        return instance;
+    }
+    async bootstrap(auth, database, caching) {
+        var _a;
+        if (database === null || database === void 0 ? void 0 : database.dialect)
+            services_1.XitkovService.setDefaultDialect(database.dialect);
+        await this.initCache(caching);
+        const [microServices, services] = await Promise.all([
+            (0, services_1.registerMicroServices)(),
+            (0, register_services_1.registerServices)(this.app, auth, database),
+        ]);
+        MicroServices.set(microServices);
+        Services.set(services);
+        exports.XitkovEvents.emit(exports.EVENTS.SERVICES_REGISTERED, true);
+        this.initExpress404();
+        const port = (_a = process.env.PORT) !== null && _a !== void 0 ? _a : 3000;
+        await new Promise(resolve => {
+            this.server.listen(port, () => {
+                exports.XitkovEvents.emit(exports.EVENTS.SERVER_STARTED, port);
+                _1.Logger.info(`Server Started ${port}`);
+                resolve();
+            });
+        });
+    }
+    init(limit = "50mb", loggerOptions) {
+        this.app.use(libs_1.InternalLogs.middleware(loggerOptions));
+        this.app.use(express_1.default.json({ limit }));
+    }
+    initExpress404() {
+        this.app.get('/healthz', (_, res) => {
+            return res.status(200).send({
+                message: "ok",
+                status: 200
+            });
+        });
+        this.app.use((req, res) => {
+            return res.status(404).send({
+                message: "Not found"
+            });
+        });
+    }
+    initSocket(enable, redis, socketCorsOrigin) {
+        var _a;
+        if (enable) {
+            _1.Socket.io = new socket_io_1.Server(this.server, {
+                cors: {
+                    origin: socketCorsOrigin
+                }
+            });
+            if (redis) {
+                let pubClient;
+                if (redis === null || redis === void 0 ? void 0 : redis.url) {
+                    pubClient = new ioredis_1.default(redis === null || redis === void 0 ? void 0 : redis.url);
+                }
+                else {
+                    pubClient = new ioredis_1.default((_a = redis.redisOptions) !== null && _a !== void 0 ? _a : {});
+                }
+                if (pubClient) {
+                    const subClient = pubClient.duplicate();
+                    _1.Socket.io.adapter((0, redis_adapter_1.createAdapter)(pubClient, subClient));
+                    _1.Logger.info("Redis added to socket");
+                }
+            }
+        }
+    }
+    initCache(caching) {
+        if (!caching)
+            return Promise.resolve();
+        const { redisUrl, keyPrefix, redisOptions = {} } = caching;
+        libs_1.Cache.client = new ioredis_1.default(redisUrl, { keyPrefix, ...redisOptions });
+        return new Promise(resolve => {
+            let settled = false;
+            libs_1.Cache.client.once('connect', () => {
+                _1.Logger.info('Successfully connected to Redis Cache');
+                if (!settled) {
+                    settled = true;
+                    resolve();
+                }
+            });
+            libs_1.Cache.client.on('error', (error) => {
+                _1.Logger.error('Unable to connect to Redis Cache', { error });
+                if (!settled) {
+                    settled = true;
+                    resolve();
+                }
+            });
+        });
+    }
+}
+exports.Xitkov = Xitkov;
+//# sourceMappingURL=app.js.map

package/lib/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":";;;;;;AAAA,+BAA6B;AAC7B,oDAAkC;AAClC,sDAA6C;AAC7C,yCAAgD;AAChD,4DAAyD;AACzD,sDAA8C;AAC9C,wBAAwF;AACxF,yCAAgF;AAChF,oEAA8D;AAC9D,iCAA6C;AAGhC,QAAA,MAAM,GAAG;IACpB,cAAc,EAAE,gBAAgB;IAChC,mBAAmB,EAAE,qBAAqB;CAC3C,CAAA;AACD,MAAa,QAAQ;IAEnB,MAAM,CAAC,GAAG,CAA+B,OAAU;QACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,QAAa;QACtB,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC9B,CAAC;CACF;AARD,4BAQC;AAQD,MAAa,aAAa;IAExB,MAAM,CAAC,GAAG,CAA0E,gBAAmB,EAAE,OAAU;QACjH,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,QAAwB;QACjC,aAAa,CAAC,QAAQ,GAAG,QAAQ,CAAA;IACnC,CAAC;CACF;AARD,sCAQC;AAEY,QAAA,YAAY,GAAG,IAAI,gBAAY,EAAE,CAAA;AAwC9C,MAAa,MAAM;IAKjB,YAAY,MAAc;;QACxB,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;QACxE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,MAAM,GAAG,IAAI,aAAM,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,IAAI,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,MAAM,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,CAAC,CAAA;QACpD,IAAI,CAAC,UAAU,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,CAAC,CAAA;QACxE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACtD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAc;QAChC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAA;QACnC,MAAM,QAAQ,CAAC,KAAK,CAAA;QACpB,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,IAAoB,EAAE,QAA4B,EAAE,OAA0B;;QACpG,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;YAAE,wBAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QACxE,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAC7B,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAClD,IAAA,gCAAqB,GAAE;YACvB,IAAA,oCAAgB,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC;SAC3C,CAAC,CAAA;QACF,aAAa,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;QAChC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACtB,oBAAY,CAAC,IAAI,CAAC,cAAM,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAA;QACnD,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,IAAI,mCAAI,IAAI,CAAA;QACrC,MAAM,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YAChC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;gBAC5B,oBAAY,CAAC,IAAI,CAAC,cAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;gBAC9C,SAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;gBACtC,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,IAAI,CAAC,QAAgB,MAAM,EAAE,aAAsC;QACzE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IACvC,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;YAClC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACxB,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,GAAG;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACxB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,OAAO,EAAE,WAAW;aACrB,CAAC,CAAC;QACL,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,UAAU,CAAC,MAAgB,EAAE,KAAwB,EAAG,gBAAyB;;QACvF,IAAI,MAAM,EAAE;YACV,SAAM,CAAC,EAAE,GAAG,IAAI,kBAAY,CAAC,IAAI,CAAC,MAAM,EAAE;gBACxC,IAAI,EAAE;oBACJ,MAAM,EAAE,gBAAgB;iBACzB;aACF,CAAC,CAAA;YACF,IAAI,KAAK,EAAE;gBACT,IAAI,SAAgB,CAAC;gBACrB,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,EAAE;oBACd,SAAS,GAAG,IAAI,iBAAK,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,CAAC,CAAC;iBACnC;qBAAM;oBACL,SAAS,GAAG,IAAI,iBAAK,CAAC,MAAA,KAAK,CAAC,YAAY,mCAAI,EAAE,CAAC,CAAC;iBACjD;gBACD,IAAI,SAAS,EAAE;oBACb,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;oBACxC,SAAM,CAAC,EAAE,CAAC,OAAO,CAAC,IAAA,6BAAa,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;oBACvD,SAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;iBACrC;aACF;SACF;IACH,CAAC;IACO,SAAS,CAAC,OAA0B;QAC1C,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QACtC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,GAAG,EAAE,EAAE,GAAG,OAAO,CAAA;QAC1D,YAAK,CAAC,MAAM,GAAG,IAAI,iBAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YACjC,IAAI,OAAO,GAAG,KAAK,CAAA;YACnB,YAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;gBAChC,SAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBACrD,IAAI,CAAC,OAAO,EAAE;oBAAE,OAAO,GAAG,IAAI,CAAC;oBAAC,OAAO,EAAE,CAAA;iBAAE;YAC7C,CAAC,CAAC,CAAC;YACH,YAAK,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;gBACtC,SAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC5D,IAAI,CAAC,OAAO,EAAE;oBAAE,OAAO,GAAG,IAAI,CAAC;oBAAC,OAAO,EAAE,CAAA;iBAAE;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAnGD,wBAmGC"}

package/lib/errors/index.d.ts

@@ -0,0 +1,25 @@
+export declare class XitkovError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+export declare class BadRequest extends XitkovError {
+    constructor(message: string);
+}
+export declare class NoContent extends XitkovError {
+    constructor(message: string);
+}
+export declare class InternalServer extends XitkovError {
+    constructor(message: string);
+}
+export declare class Unauthorized extends XitkovError {
+    constructor(message: string);
+}
+export declare class PaymentRequired extends XitkovError {
+    constructor(message: string);
+}
+export declare class Forbidden extends XitkovError {
+    constructor(message: string);
+}
+export declare class NotFound extends XitkovError {
+    constructor(message: string);
+}

package/lib/errors/index.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFound = exports.Forbidden = exports.PaymentRequired = exports.Unauthorized = exports.InternalServer = exports.NoContent = exports.BadRequest = exports.XitkovError = void 0;
+class XitkovError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.name = new.target.name;
+        this.status = status;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.XitkovError = XitkovError;
+class BadRequest extends XitkovError {
+    constructor(message) { super(message, 400); }
+}
+exports.BadRequest = BadRequest;
+class NoContent extends XitkovError {
+    constructor(message) { super(message, 204); }
+}
+exports.NoContent = NoContent;
+class InternalServer extends XitkovError {
+    constructor(message) { super(message, 500); }
+}
+exports.InternalServer = InternalServer;
+class Unauthorized extends XitkovError {
+    constructor(message) { super(message, 401); }
+}
+exports.Unauthorized = Unauthorized;
+class PaymentRequired extends XitkovError {
+    constructor(message) { super(message, 402); }
+}
+exports.PaymentRequired = PaymentRequired;
+class Forbidden extends XitkovError {
+    constructor(message) { super(message, 403); }
+}
+exports.Forbidden = Forbidden;
+class NotFound extends XitkovError {
+    constructor(message) { super(message, 404); }
+}
+exports.NotFound = NotFound;
+//# sourceMappingURL=index.js.map

package/lib/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";;;AAAA,MAAa,WAAY,SAAQ,KAAK;IAEpC,YAAY,OAAe,EAAE,MAAc;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AARD,kCAQC;AAED,MAAa,UAAW,SAAQ,WAAW;IACzC,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,gCAEC;AAED,MAAa,SAAU,SAAQ,WAAW;IACxC,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,8BAEC;AAED,MAAa,cAAe,SAAQ,WAAW;IAC7C,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,wCAEC;AAED,MAAa,YAAa,SAAQ,WAAW;IAC3C,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,oCAEC;AAED,MAAa,eAAgB,SAAQ,WAAW;IAC9C,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,0CAEC;AAED,MAAa,SAAU,SAAQ,WAAW;IACxC,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,8BAEC;AAED,MAAa,QAAS,SAAQ,WAAW;IACvC,YAAY,OAAe,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD;AAFD,4BAEC"}

package/lib/hooks/business.d.ts

@@ -0,0 +1 @@
+export declare function setBusinessId(...params: any[]): void;

package/lib/hooks/business.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setBusinessId = void 0;
+function setBusinessId(...params) {
+    const req = params[params.length - 2];
+    const hookName = params[params.length - 1];
+    const user = req === null || req === void 0 ? void 0 : req.user;
+    const { userBusinessId: businessId } = user !== null && user !== void 0 ? user : {};
+    let idx = 0;
+    if (/^(patch|update|remove|get)$/i.test(hookName)) {
+        idx = 1;
+    }
+    const target = params[idx];
+    if (target == null)
+        return;
+    if (Array.isArray(target)) {
+        target.forEach(item => { if (item && typeof item === 'object')
+            item.businessId = businessId; });
+        return;
+    }
+    if (typeof target === 'object') {
+        target.businessId = businessId;
+    }
+}
+exports.setBusinessId = setBusinessId;
+//# sourceMappingURL=business.js.map

package/lib/hooks/business.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"business.js","sourceRoot":"","sources":["../../src/hooks/business.ts"],"names":[],"mappings":";;;AAIA,SAAgB,aAAa,CAAC,GAAG,MAAa;IAC5C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAU,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC;IAC9B,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;IAClD,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,8BAA8B,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACjD,GAAG,GAAG,CAAC,CAAC;KACT;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO;IAC3B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA,CAAC,CAAC,CAAC,CAAC;QAC/F,OAAO;KACR;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;KAChC;AACH,CAAC;AAlBD,sCAkBC"}

package/lib/hooks/hooks.d.ts

@@ -0,0 +1,4 @@
+export declare const disallow: () => never;
+export declare const externalDisallow: (...params: any[]) => void;
+export declare const loggedIn: (...params: any[]) => any;
+export declare const addQuerySupport: (...params: any[]) => any;

package/lib/hooks/hooks.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addQuerySupport = exports.loggedIn = exports.externalDisallow = exports.disallow = void 0;
+const sequelize_1 = require("sequelize");
+const errors_1 = require("../errors");
+const logger_1 = require("../logger");
+const disallow = () => {
+    throw new errors_1.NotFound('Not Found');
+};
+exports.disallow = disallow;
+const externalDisallow = (...params) => {
+    var _a;
+    const req = params[params.length - 2];
+    const internalToken = req.headers['internaltoken'];
+    if (internalToken === ((_a = process.env.INTERNAL_TOKEN) !== null && _a !== void 0 ? _a : 'internal_token')) {
+        logger_1.Logger.info('externalDisallow', { internalToken });
+        return;
+    }
+    throw new errors_1.NotFound('Not Found');
+};
+exports.externalDisallow = externalDisallow;
+const loggedIn = (...params) => {
+    const req = params[params.length - 2];
+    const user = req === null || req === void 0 ? void 0 : req.user;
+    if (!user) {
+        throw new errors_1.Unauthorized("Logged in required");
+    }
+    return user;
+};
+exports.loggedIn = loggedIn;
+const addQuerySupport = (...params) => {
+    var _a;
+    const hookName = params[params.length - 1];
+    let queryIndex = 0;
+    if (/^(create|patch|update|remove|get)$/i.test(hookName)) {
+        queryIndex = 1;
+    }
+    const query = (_a = params[queryIndex]) !== null && _a !== void 0 ? _a : {};
+    const queryObj = {};
+    Object.keys(query).forEach(key => {
+        const value = query[key];
+        if (typeof value === 'object') {
+            let [conditionValue] = Object.values(value);
+            const [condition] = Object.keys(value);
+            const sequelizeOp = sequelize_1.Op[condition.replace('$', '')];
+            try {
+                conditionValue = JSON.parse(conditionValue);
+            }
+            catch (err) {
+                //
+            }
+            if (sequelizeOp) {
+                queryObj[key] = {
+                    [sequelizeOp]: conditionValue,
+                };
+            }
+        }
+        else {
+            queryObj[key] = value;
+        }
+    });
+    params[queryIndex] = queryObj;
+    return queryObj;
+};
+exports.addQuerySupport = addQuerySupport;
+//# sourceMappingURL=hooks.js.map

package/lib/hooks/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/hooks/hooks.ts"],"names":[],"mappings":";;;AAAA,yCAA+B;AAC/B,sCAAmD;AACnD,sCAAmC;AAE5B,MAAM,QAAQ,GAAG,GAAG,EAAE;IAC3B,MAAM,IAAI,iBAAQ,CAAC,WAAW,CAAC,CAAA;AACjC,CAAC,CAAA;AAFY,QAAA,QAAQ,YAEpB;AAEM,MAAM,gBAAgB,GAAG,CAAC,GAAG,MAAa,EAAE,EAAE;;IACnD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACrC,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IAClD,IAAI,aAAa,KAAK,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,cAAc,mCAAI,gBAAgB,CAAC,EAAE;QACtE,eAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,aAAa,EAAE,CAAC,CAAA;QAClD,OAAM;KACP;IACD,MAAM,IAAI,iBAAQ,CAAC,WAAW,CAAC,CAAA;AACjC,CAAC,CAAA;AARY,QAAA,gBAAgB,oBAQ5B;AAEM,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAa,EAAE,EAAE;IAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACrC,MAAM,IAAI,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA;IACtB,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,qBAAY,CAAC,oBAAoB,CAAC,CAAA;KAC7C;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAA;AAPY,QAAA,QAAQ,YAOpB;AAEM,MAAM,eAAe,GAAG,CAAC,GAAG,MAAa,EAAE,EAAE;;IAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,IAAI,qCAAqC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACxD,UAAU,GAAG,CAAC,CAAC;KAChB;IAED,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAQ,EAAE,CAAC;IACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,MAAM,WAAW,GAAI,cAAU,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;YAC5D,IAAI;gBACF,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,cAAqB,CAAC,CAAC;aACpD;YAAC,OAAO,GAAG,EAAE;gBACZ,EAAE;aACH;YACD,IAAI,WAAW,EAAE;gBACf,QAAQ,CAAC,GAAG,CAAC,GAAG;oBACd,CAAC,WAAW,CAAC,EAAE,cAAc;iBAC9B,CAAC;aACH;SACF;aAAM;YACL,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SACvB;IACH,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;IAC9B,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAA;AAhCY,QAAA,eAAe,mBAgC3B"}

package/lib/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './hooks';
+export * from './types';
+export * from './business';