@niledatabase/server 2.4.2-alpha.4 → 3.0.0-alpha.0

package/dist/Server.d.ts

@@ -1,14 +1,27 @@
 import { Pool } from 'pg';
 import { ServerConfig } from './types';
 import { Config } from './utils/Config';
-import Auth from './auth';
 import Users from './users';
 import Tenants from './tenants';
-type Api = {
-    auth: Auth;
+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>;
+}
 export declare class Server {
     config: Config;
     api: Api;

package/dist/api/handlers/DELETE.d.ts

@@ -0,0 +1,3 @@
+import { Routes } from '../types';
+import { Config } from '../../utils/Config';
+export default function DELETER(configRoutes: Routes, config: Config): (req: Request) => Promise<void | Response>;

package/dist/api/handlers/GET.d.ts

@@ -0,0 +1,3 @@
+import { Routes } from '../types';
+import { Config } from '../../utils/Config';
+export default function GETTER(configRoutes: Routes, config: Config): (req: Request) => Promise<void | Response>;

package/dist/api/handlers/POST.d.ts

@@ -0,0 +1,3 @@
+import { Routes } from '../types';
+import { Config } from '../../utils/Config';
+export default function POSTER(configRoutes: Routes, config: Config): (req: Request) => Promise<void | Response>;

package/dist/api/handlers/PUT.d.ts

@@ -0,0 +1,3 @@
+import { Routes } from '../types';
+import { Config } from '../../utils/Config';
+export default function PUTER(configRoutes: Routes, config: Config): (req: Request) => Promise<void | Response>;

package/dist/api/handlers/index.d.ts

@@ -0,0 +1,8 @@
+import { Config } from '../../utils/Config';
+import { Routes } from '../types';
+export default function Handlers(configRoutes: Routes, config: Config): {
+    GET: (req: Request) => Promise<void | Response>;
+    POST: (req: Request) => Promise<void | Response>;
+    DELETE: (req: Request) => Promise<void | Response>;
+    PUT: (req: Request) => Promise<void | Response>;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+export { default as handleSignIn, matches as matchSignIn } from './signin';
+export { default as handleSession, matches as matchSession } from './session';
+export { default as handleProviders, matches as matchProviders, } from './providers';
+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';

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

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

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

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

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

@@ -0,0 +1,33 @@
+/**
+ * @swagger
+ * /api/auth/signin:
+ *   get:
+ *     tags:
+ *     - authentication
+ *     summary: lists users in the tenant
+ *     description: Returns information about the users within the tenant
+ *       provided
+ *     operationId: signin
+ *     parameters:
+ *       - name: tenantId
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: string
+ *     responses:
+ *       "200":
+ *         description: A list of users
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/User'
+ *       "404":
+ *         description: Not found
+ *         content: {}
+ *       "401":
+ *         description: Unauthorized
+ *         content: {}
+ */
+import { Routes } from '../../types';
+export default function route(request: Request): Promise<void | Response>;
+export declare function matches(configRoutes: Routes, request: Request): boolean;

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

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

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

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

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

@@ -0,0 +1,32 @@
+import { ActiveSession } from '../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants:
+ *   get:
+ *     tags:
+ *       - tenants
+ *     summary: list tenants by user
+ *     description: Creates a user in the database
+ *     operationId: listTenants
+ *     responses:
+ *       "200":
+ *         description: a list of tenants
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                $ref: "#/components/schemas/Tenant"
+ *       "400":
+ *         description: API/Database failures
+ *         content:
+ *           text/plain:
+ *             schema:
+ *               type: string
+ *       "401":
+ *         description: Unauthorized
+ *         content: {}
+ */
+export declare function GET(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,45 @@
+import { ActiveSession } from '../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants:
+ *   post:
+ *    tags:
+ *    - tenants
+ *    summary: Create a tenant
+ *    description: Creates a new tenant in a database.
+ *    operationId: createTenant
+ *    requestBody:
+ *      description: A wrapper for the tenant name.
+ *      content:
+ *        application/json:
+ *          schema:
+ *            $ref: '#/components/schemas/CreateTenantRequest'
+ *          examples:
+ *            Create Tenant Request:
+ *              summary: Creates a named tenant
+ *              description: Create Tenant Request
+ *              value:
+ *                name: My Sandbox
+ *    responses:
+ *      "201":
+ *        description: Tenant created
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/Tenant'
+ *      "401":
+ *        description: Unauthorized
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ *      "404":
+ *        description: Database not found
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ */
+export declare function POST(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,34 @@
+import { ActiveSession } from '../../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}:
+ *   delete:
+ *    tags:
+ *    - tenants
+ *    summary: Deletes a tenant.
+ *    operationId: deleteTenant
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ *    responses:
+ *      "204":
+ *        description: Tenant deleted
+ *      "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 DELETE(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,35 @@
+import { ActiveSession } from '../../../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}/users:
+ *  get:
+ *    tags:
+ *    - users
+ *    summary: List tenant users
+ *    description: Lists users that are associated with the specified tenant.
+ *    operationId: listTenantUsers
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ *    responses:
+ *      "200":
+ *        description: Users found
+ *        content:
+ *          application/json:
+ *            schema:
+ *              type: array
+ *              items:
+ *                $ref: '#/components/schemas/User'
+ *      "401":
+ *        description: Unauthorized
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/APIError'
+ */
+export declare function GET(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,44 @@
+import { ActiveSession } from '../../../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}/users:
+ *   post:
+ *    tags:
+ *    - users
+ *    summary: Create a user in a tenant
+ *    description: Creates a new user and associates that user with the specified
+ *      tenant.
+ *    operationId: createTenantUser
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      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.
+ *      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
+ *    responses:
+ *      "201":
+ *        description: User created
+ *        content:
+ *          application/json:
+ *            schema:
+ *              $ref: '#/components/schemas/User'
+ */
+export declare function POST(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,30 @@
+import { ActiveSession } from '../../../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}/users:
+ *   put:
+ *    tags:
+ *    - tenants
+ *    summary: associates an existing user with the tenant
+ *    operationId: linkUser
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      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.
+ *      content:
+ *        application/json:
+ *          schema:
+ *            $ref: '#/components/schemas/AssociateUserRequest'
+ *    responses:
+ *      "201":
+ *        description: add user to tenant
+ */
+export declare function PUT(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,30 @@
+import { ActiveSession } from '../../../../../utils/auth';
+/**
+ * @swagger
+ * /api/tenants/{tenantId}/users/{userId}:
+ *   delete:
+ *    tags:
+ *    - tenants
+ *    summary: removes a user from a tenant
+ *    description: removes an associated user from a specified
+ *      tenant.
+ *    operationId: unlinkUser
+ *    parameters:
+ *    - name: tenantId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ *    - name: userId
+ *      in: path
+ *      required: true
+ *      schema:
+ *        type: string
+ 
+ *    responses:
+ *      "204":
+ *        description: User removed
+ */
+export declare function DELETE(session: ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

package/dist/api/routes/tenants/[tenantId]/users/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<void | Response>;
+export declare function matches(configRoutes: Routes, request: Request): boolean;

package/dist/api/routes/tenants/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<void | Response>;
+export declare function matches(configRoutes: Routes, request: Request): boolean;

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

@@ -0,0 +1,34 @@
+/**
+ * @swagger
+ * /api/users:
+ *   get:
+ *     tags:
+ *     - users
+ *     summary: lists users in the tenant
+ *     description: Returns information about the users within the tenant
+ *       provided. You can also pass the a `niledb-tenantId` in the header or in a cookie.
+ *     operationId: listUsers
+ *     parameters:
+ *       - name: tenantId
+ *         in: query
+ *         schema:
+ *           type: string
+ *     responses:
+ *       "200":
+ *         description: A list of users
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                $ref: '#/components/schemas/TenantUser'
+ *       "404":
+ *         description: Not found
+ *         content: {}
+ *       "401":
+ *         description: Unauthorized
+ *         content: {}
+ */
+export declare function GET(init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,66 @@
+import { ActiveSession } from '../../utils/auth';
+/**
+ * @swagger
+ * /api/users:
+ *   post:
+ *     tags:
+ *       - users
+ *     summary: Creates a user
+ *     description: Creates a user in the database
+ *     operationId: createUser
+ *     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 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(session: void | ActiveSession, init: RequestInit & {
+    request: Request;
+}, log?: (...args: string[]) => void): Promise<void | Response>;

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

@@ -0,0 +1,40 @@
+import { ActiveSession } from '../../../utils/auth';
+/**
+ * @swagger
+ * /api/users/{userid}:
+ *   put:
+ *     tags:
+ *     - users
+ *     summary: update a user
+ *     description: updates a user within the tenant
+ *     operationId: updateUser
+ *     parameters:
+ *       - name: userid
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: string
+ *     requestBody:
+ *       description: |-
+ *         Update a user
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/UpdateUserRequest'
+ *     responses:
+ *       "200":
+ *         description: An updated user
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/User'
+ *       "404":
+ *         description: Not found
+ *         content: {}
+ *       "401":
+ *         description: Unauthorized
+ *         content: {}
+ */
+export declare function PUT(session: void | ActiveSession, init: RequestInit & {
+    request: Request;
+}, log: (...args: string[]) => void): Promise<void | Response>;

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

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