@niledatabase/server 3.0.0-alpha.4 → 3.0.0-alpha.40

package/dist/Api.d.ts

@@ -0,0 +1,25 @@
+import { Routes } from './api/types';
+import Auth from './auth';
+import Tenants from './tenants';
+import Users from './users';
+import { Config } from './utils/Config';
+export declare class Api {
+    config: Config;
+    users: Users;
+    auth: Auth;
+    tenants: Tenants;
+    routes: Routes;
+    handlers: {
+        GET: (req: Request) => Promise<void | Response>;
+        POST: (req: Request) => Promise<void | Response>;
+        DELETE: (req: Request) => Promise<void | Response>;
+        PUT: (req: Request) => Promise<void | Response>;
+    };
+    constructor(config: Config);
+    updateConfig(config: Config): void;
+    set headers(headers: Headers);
+    login(payload: {
+        email: string;
+        password: string;
+    }): Promise<void>;
+}

package/dist/Server.d.ts

@@ -1,32 +1,11 @@
 import { Pool } from 'pg';
 import { ServerConfig } from './types';
 import { Config } from './utils/Config';
-import Users from './users';
-import Tenants from './tenants';
-import { Routes } from './api/types';
-declare class Api {
-    config: Config;
-    users: Users;
-    tenants: Tenants;
-    routes: Routes;
-    handlers: {
-        GET: (req: Request) => Promise<void | Response>;
-        POST: (req: Request) => Promise<void | Response>;
-        DELETE: (req: Request) => Promise<void | Response>;
-        PUT: (req: Request) => Promise<void | Response>;
-    };
-    constructor(config: Config);
-    set headers(headers: Headers);
-    login(payload: {
-        email: string;
-        password: string;
-    }): Promise<void>;
-}
+import { Api } from './Api';
 export declare class Server {
     config: Config;
     api: Api;
     private manager;
-    private servers;
     constructor(config?: ServerConfig);
     setConfig(cfg: Config): void;
     init(cfg?: Config): Promise<this>;
@@ -39,9 +18,7 @@ export declare class Server {
     set token(token: string | undefined | null);
     get db(): Pool;
     /**
-     * A utility function if you want to manage different NileDB instances yourself
-     * returns the global Server object, an existing server that's already been configured,
-     * or a new one if the config isn't in the cache
+     * A convenience function that applies a config and ensures whatever was passed is set properly
      */
     getInstance(config: ServerConfig): Server;
 }

package/dist/api/routes/auth/callback.d.ts

@@ -1,3 +1,4 @@
 import { Routes } from '../../types';
-export default function route(request: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(request: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/csrf.d.ts

@@ -1,3 +1,4 @@
 import { Routes } from '../../types';
-export default function route(req: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(req: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/error.d.ts

@@ -1,3 +1,4 @@
 import { Routes } from '../../types';
-export default function route(req: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(req: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/index.d.ts

@@ -5,3 +5,4 @@ export { default as handleCsrf, matches as matchCsrf } from './csrf';
 export { default as handleCallback, matches as matchCallback, } from './callback';
 export { default as handleSignOut, matches as matchSignOut } from './signout';
 export { default as handleError, matches as matchError } from './error';
+export { default as handleVerifyRequest, matches as matchesVerifyRequest, } from './verify-request';

package/dist/api/routes/auth/providers.d.ts

@@ -1,3 +1,4 @@
 import { Routes } from '../../types';
-export default function route(req: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(req: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/signin.d.ts

@@ -29,5 +29,6 @@
  *         content: {}
  */
 import { Routes } from '../../types';
-export default function route(req: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(req: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/signout.d.ts

@@ -1,3 +1,4 @@
 import { Routes } from '../../types';
-export default function route(request: Request): Promise<Response>;
+import { Config } from '../../../utils/Config';
+export default function route(request: Request, config: Config): Promise<Response>;
 export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/auth/verify-request.d.ts

@@ -0,0 +1,4 @@
+import { Routes } from '../../types';
+import { Config } from '../../../utils/Config';
+export default function route(req: Request, config: Config): Promise<Response>;
+export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/signup/POST.d.ts

@@ -0,0 +1,66 @@
+import { Config } from '../../../utils/Config';
+/**
+ * @swagger
+ * /api/signup:
+ *   post:
+ *     tags:
+ *       - users
+ *     summary: signs a user up
+ *     description: signs a user up and logs them in. Expects a email and password combo
+ *     operationId: signUp
+ *     parameters:
+ *       - name: tenantId
+ *         description: A tenant id to add the user to when they are created
+ *         in: query
+ *         schema:
+ *           type: string
+ *       - name: newTenantName
+ *         description: A tenant name to create, then the user to when they are created
+ *         in: query
+ *         schema:
+ *           type: string
+ *     requestBody:
+ *       description: |-
+ *         The email and password combination the user will use to authenticate.
+ *         The `name` is optional; if provided it will be recorded in the `users` table.
+ *         The `newTenant` is optional; if provided, it is used as the name of a new tenant record associated with the newly created user.
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/CreateBasicUserRequest'
+ *           examples:
+ *             Create User Request:
+ *               summary: Creates a user with basic credentials
+ *               description: Create User Request
+ *               value:
+ *                 email: a.user@somedomain.com
+ *                 password: somepassword
+ *                 name: A. User
+ *             Create User Request with Tenant:
+ *               summary: Creates a user and a new tenant for that user
+ *               description: Create User Request with Tenant
+ *               value:
+ *                 email: a.user@somedomain.com
+ *                 password: somepassword
+ *                 name: A. User
+ *                 newTenant: My Sandbox
+ *     responses:
+ *       "201":
+ *         description: User and session created
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: "#/components/schemas/User"
+ *       "400":
+ *         description: API/Database failures
+ *         content:
+ *           text/plain:
+ *             schema:
+ *               type: string
+ *       "401":
+ *         description: Unauthorized
+ *         content: {}
+ */
+export declare function POST(config: Config, init: RequestInit & {
+    request: Request;
+}): Promise<Response>;

package/dist/api/routes/signup/index.d.ts

@@ -0,0 +1,4 @@
+import { Config } from '../../../utils/Config';
+import { Routes } from '../../types';
+export default function route(request: Request, config: Config): Promise<Response>;
+export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/tenants/GET.d.ts

@@ -1,3 +1,4 @@
+import { Config } from '../../../utils/Config';
 import { ActiveSession } from '../../utils/auth';
 /**
  * @swagger
@@ -27,6 +28,6 @@ import { ActiveSession } from '../../utils/auth';
  *         description: Unauthorized
  *         content: {}
  */
-export declare function GET(session: ActiveSession, init: RequestInit & {
+export declare function GET(config: Config, session: ActiveSession, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/POST.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../utils/auth';
+import { Config } from '../../../utils/Config';
 /**
  * @swagger
  * /api/tenants:
@@ -40,6 +40,6 @@ import { ActiveSession } from '../../utils/auth';
  *            schema:
  *              $ref: '#/components/schemas/APIError'
  */
-export declare function POST(session: ActiveSession, init: RequestInit & {
+export declare function POST(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/DELETE.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../../utils/auth';
+import { Config } from '../../../../utils/Config';
 /**
  * @swagger
  * /api/tenants/{tenantId}:
@@ -29,6 +29,6 @@ import { ActiveSession } from '../../../utils/auth';
  *            schema:
  *              $ref: '#/components/schemas/APIError'
  */
-export declare function DELETE(session: ActiveSession, init: RequestInit & {
+export declare function DELETE(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/GET.d.ts

@@ -0,0 +1,37 @@
+import { Config } from '../../../../utils/Config';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}:
+ *   get:
+ *    tags:
+ *    - tenants
+ *    summary: Obtains a specific tenant.
+ *    operationId: getTenant
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ *    responses:
+ *      "200":
+ *        description: the desired tenant
+ *        application/json:
+ *          schema:
+ *            $ref: '#/components/schemas/Tenant'
+ *      "401":
+ *        description: Unauthorized
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ *      "404":
+ *        description: Tenant not found
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ */
+export declare function GET(config: Config, init: RequestInit & {
+    request: Request;
+}, log: (message: string | unknown, meta?: Record<string, unknown>) => void): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/PUT.d.ts

@@ -0,0 +1,38 @@
+import { Config } from '../../../../utils/Config';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}:
+ *   put:
+ *    tags:
+ *    - tenants
+ *    summary: Obtains a specific tenant.
+ *    operationId: updateTenant
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ *    responses:
+ *      "201":
+ *        description: update an existing tenant
+ *        content:
+ *          application/json:
+ *            schema:
+ *               $ref: '#/components/schemas/Tenant'
+ *      "401":
+ *        description: Unauthorized
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ *      "404":
+ *        description: Tenant not found
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ */
+export declare function PUT(config: Config, init: RequestInit & {
+    request: Request;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/users/GET.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../../../utils/auth';
+import { Config } from '../../../../../utils/Config';
 /**
  * @swagger
  * /api/tenants/{tenantId}/users:
@@ -30,6 +30,6 @@ import { ActiveSession } from '../../../../utils/auth';
  *            schema:
  *              $ref: '#/components/schemas/APIError'
  */
-export declare function GET(session: ActiveSession, init: RequestInit & {
+export declare function GET(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/users/POST.d.ts

@@ -1,4 +1,5 @@
 import { ActiveSession } from '../../../../utils/auth';
+import { Config } from '../../../../../utils/Config';
 /**
  * @swagger
  * /api/tenants/{tenantId}/users:
@@ -39,6 +40,6 @@ import { ActiveSession } from '../../../../utils/auth';
  *            schema:
  *              $ref: '#/components/schemas/User'
  */
-export declare function POST(session: ActiveSession, init: RequestInit & {
+export declare function POST(config: Config, session: ActiveSession, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/users/PUT.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../../../utils/auth';
+import { Config } from '../../../../../utils/Config';
 /**
  * @swagger
  * /api/tenants/{tenantId}/users:
@@ -24,6 +24,6 @@ import { ActiveSession } from '../../../../utils/auth';
  *      "201":
  *        description: add user to tenant
  */
-export declare function PUT(session: ActiveSession, init: RequestInit & {
+export declare function PUT(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/tenants/[tenantId]/users/[userId]/DELETE.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../../../../utils/auth';
+import { Config } from '../../../../../../utils/Config';
 /**
  * @swagger
  * /api/tenants/{tenantId}/users/{email}:
@@ -25,6 +25,6 @@ import { ActiveSession } from '../../../../../utils/auth';
  *      "204":
  *        description: User removed
  */
-export declare function DELETE(session: ActiveSession, init: RequestInit & {
+export declare function DELETE(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/users/GET.d.ts

@@ -1,3 +1,4 @@
+import { Config } from '../../../utils/Config';
 /**
  * @swagger
  * /api/users:
@@ -29,6 +30,6 @@
  *         description: Unauthorized
  *         content: {}
  */
-export declare function GET(init: RequestInit & {
+export declare function GET(config: Config, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}, log: (message: string | unknown, meta?: Record<string, unknown>) => void): Promise<Response>;

package/dist/api/routes/users/POST.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSession } from '../../utils/auth';
+import { Config } from '../../../utils/Config';
 /**
  * @swagger
  * /api/users:
@@ -61,6 +61,6 @@ import { ActiveSession } from '../../utils/auth';
  *         description: Unauthorized
  *         content: {}
  */
-export declare function POST(session: void | ActiveSession, init: RequestInit & {
+export declare function POST(config: Config, init: RequestInit & {
     request: Request;
-}, log?: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/routes/users/[userId]/PUT.d.ts

@@ -1,4 +1,5 @@
 import { ActiveSession } from '../../../utils/auth';
+import { Config } from '../../../../utils/Config';
 /**
  * @swagger
  * /api/users/{userid}:
@@ -35,6 +36,6 @@ import { ActiveSession } from '../../../utils/auth';
  *         description: Unauthorized
  *         content: {}
  */
-export declare function PUT(session: void | ActiveSession, init: RequestInit & {
+export declare function PUT(config: Config, session: void | ActiveSession, init: RequestInit & {
     request: Request;
-}, log: (...args: string[]) => void): Promise<Response>;
+}): Promise<Response>;

package/dist/api/types.d.ts

@@ -15,4 +15,5 @@ export type Routes = {
     TENANT_USER: string;
     TENANT_USERS: string;
     SIGNUP: string;
+    VERIFY_REQUEST: string;
 };

package/dist/api/utils/auth.d.ts

@@ -1,4 +1,12 @@
 import { Config } from '../../utils/Config';
+export type JWT = {
+    email: string;
+    sub: string;
+    id: string;
+    iat: number;
+    exp: number;
+    jti: string;
+};
 export type ActiveSession = {
     id: string;
     email: string;

package/dist/api/utils/request.d.ts

@@ -1,4 +1,4 @@
 import { Config } from '../../utils/Config';
 export default function request(url: string, _init: RequestInit & {
     request: Request;
-}, config?: Config): Promise<Response>;
+}, config: Config): Promise<Response>;

package/dist/api/utils/routes/apiRoutes.d.ts

@@ -1,8 +1,12 @@
+import { Config } from '../../../utils/Config';
 type ApiRouteKeys = keyof typeof apiRoutes;
 export type ApiRoutePaths = (typeof apiRoutes)[ApiRouteKeys];
-export declare const apiRoutes: {
+export declare const apiRoutes: (config: Config) => {
     ME: string;
-    USERS: (tenantId?: string) => string;
+    USERS: (qp: {
+        tenantId?: null | string;
+        newTenantName?: null | string;
+    }) => string;
     USER: (userId: string) => string;
     TENANTS: string;
     TENANT: (tenantId: string) => string;

package/dist/api/utils/routes/makeRestUrl.d.ts

@@ -1 +1,2 @@
-export declare function makeRestUrl(path: string, qp?: Record<string, string>): string;
+import { Config } from '../../../utils/Config';
+export declare function makeRestUrl(config: Config, path: string, qp?: Record<string, string | null>): string;

package/dist/api/utils/routes/proxyRoutes.d.ts

@@ -1,4 +1,5 @@
-export declare const proxyRoutes: {
+import { Config } from '../../../utils/Config';
+export declare const proxyRoutes: (config: Config) => {
     SIGNIN: string;
     PROVIDERS: string;
     SESSION: string;
@@ -6,6 +7,7 @@ export declare const proxyRoutes: {
     CALLBACK: string;
     SIGNOUT: string;
     ERROR: string;
+    VERIFY_REQUEST: string;
 };
 type ProxyKeys = keyof typeof proxyRoutes;
 export type ProxyPaths = (typeof proxyRoutes)[ProxyKeys];

package/dist/auth/index.d.ts

@@ -1,8 +1,10 @@
+import { ActiveSession, JWT } from '../api/utils/auth';
 import { Config } from '../utils/Config';
+import { NileRequest } from '../utils/Requester';
 /**
  * a helper function to log in server side.
  */
-export default function serverAuth(config: Config, handlers: {
+export declare function serverLogin(config: Config, handlers: {
     GET: (req: Request) => Promise<void | Response>;
     POST: (req: Request) => Promise<void | Response>;
     DELETE: (req: Request) => Promise<void | Response>;
@@ -11,3 +13,10 @@ export default function serverAuth(config: Config, handlers: {
     email: string;
     password: string;
 }) => Promise<Headers>;
+export default class Auth extends Config {
+    headers?: Headers;
+    constructor(config: Config, headers?: Headers);
+    handleHeaders(init?: RequestInit): RequestInit | undefined;
+    get sessionUrl(): string;
+    session: (req: NileRequest<void> | Headers, init?: RequestInit) => Promise<Response | JWT | ActiveSession>;
+}

package/dist/db/DBManager.d.ts

@@ -4,6 +4,7 @@ import NileDatabase from './NileInstance';
 export default class DBManager {
     connections: Map<string, NileDatabase>;
     cleared: boolean;
+    private poolWatcherFn;
     private makeId;
     constructor(config: ServerConfig);
     poolWatcher: (config: ServerConfig) => (id: undefined | null | string) => void;

package/dist/db/NileInstance.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Pool } from 'pg';
 import { Config } from '../utils/Config';
 declare class NileDatabase {
@@ -10,5 +9,6 @@ declare class NileDatabase {
     timer: NodeJS.Timeout | undefined;
     constructor(config: Config, id: string);
     startTimeout(): void;
+    shutdown(): void;
 }
 export default NileDatabase;

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 export * from './types';
+export * from './users/types';
+export * from './tenants/types';
+export { JWT, ActiveSession } from './api/utils/auth';
 import create from './Server';
 export { default as Nile } from './Server';
 export { Server } from './Server';