@niledatabase/server 3.0.0-alpha.33 → 3.0.0-alpha.35

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;