@niledatabase/server 4.0.0-alpha.10 → 4.0.0-alpha.12

package/README.md

@@ -1,39 +1,83 @@
-# @niledatabase/server
+<p align="center">
+  <img width="1434" alt="Screen Shot 2024-09-18 at 9 20 04 AM" src="https://github.com/user-attachments/assets/20585883-5cdc-4f15-93d3-dc150e87bc11">
+</p>
 
-Consolidates the API and DB for working with Nile.
+---
 
-## Usage
+# Nile's Server-Side SDK
 
-### With configuration object
+This package (`@niledatabase/server`) is part of [Nile's Javascript SDK](https://github.com/niledatabase/nile-js/tree/main).
 
-```ts
-import Nile from '@niledatabase/server';
+Nile's server-side Javascript package provides:
 
-const nile = await Nile({
-  user: 'username',
-  password: 'password',
-});
+- 🔐 Methods for working with Nile's user and tenant APIs
+- 🔑 Generated routes for authentication
+- 🔍 SQL query execution with tenant and user context management
 
-await nile.api.createTenant({ name: 'name' });
+**Nile is a Postgres platform that decouples storage from compute, virtualizes tenants, and supports vertical and horizontal scaling globally to ship B2B applications fast while being safe with limitless scale.** All B2B applications are multi-tenant. A tenant/customer is primarily a company, an organization, or a workspace in your product that contains a group of users. A B2B application provides services to multiple tenants. Tenant is the basic building block of all B2B applications.
 
-await nile.db.query('select * from todo');
+## Usage
+
+### Installation
+
+```ts
+npm install @niledatabase/server 
 ```
 
-### With env vars
+### Initialize SDK with env vars
+
+The recommended way to initialize Nile SDK is with `.env` file. You can copy the environment variables from [Nile console](https://console.thenile.dev). It should look similar to this:
 
 ```bash
 NILEDB_USER=username
 NILEDB_PASSWORD=password
+NILEDB_API_URL=https://us-west-2.api.thenile.dev/v2/databases/DBID
+NILEDB_POSTGRES_URL=postgres://us-west-2.db.thenile.dev:5432/dbname
 ```
 
 ```ts
 import Nile from '@niledatabase/server';
 
 const nile = await Nile();
+```
+
+### Initialize SDK with configuration object
 
-await nile.api.createTenant({ name: 'name' });
+```ts
+import Nile from '@niledatabase/server';
+
+const nile = await Nile({
+  user: 'username',
+  password: 'password',
+  debug: true
+});
+```
 
-await nile.db.query('select * from todo');
+### Call Nile APIs
+
+```typescript
+const tenant = await nile.api.tenants.createTenant(tenantName);
+if (tenant instanceof Response) {
+  const err = await tenant.text()
+  console.log("ERROR creating tenant: ", tenant, err);
+  return { message: "Error creating tenant" };
+}
+nile.tenant_id = tenant.id // set context
+// Get tenant name doesn't need any input parameters 
+// because it uses the tenant ID and user token from the context
+const checkTenant = await tenantNile.api.tenants.getTenant();
+```
+
+### Query the database
+
+```typescript
+  nile.tenant_id = tenant.id // set context
+
+  const todos = await nile.db
+    .query("select * from todos order by title")
+    .catch((e: Error) => {
+      console.error(e);
+    }); // no need for where clause if you previously set Nile context
 ```
 
 ## Initialization
@@ -59,3 +103,9 @@ Configuration passed to `Server` takes precedence over `.env` vars.
 | api.cookieKey | `string`     |                 | Key for API cookie. Default is `token`.                                  |
 | api.token     | `string`     | NILEDB_TOKEN    | Token for API authentication. Mostly for debugging.                      |
 | debug         | `boolean`    |                 | Flag for enabling debug logging.                                         |
+
+## Learn more
+
+- You can learn more about Nile and the SDK in [https://thenile.dev/docs]
+- You can find detailed code examples in [our main repo](https://github.com/niledatabase/niledatabase)
+- Nile SDK interacts with APIs in Nile Auth service. You can learn more about it in the [repository](https://github.com/niledatabase/nile-auth) and the [docs](https://thenile.dev/docs/auth)

package/dist/index.d.mts

@@ -145,6 +145,13 @@ type Tenant = {
     name: string;
 };
 
+type Provider = {
+    id: string;
+    name: string;
+    type: string;
+    signinUrl: string;
+    callbackUr: string;
+};
 type JWT = {
     email: string;
     sub: string;
@@ -212,6 +219,16 @@ declare class Auth extends Config {
     handleHeaders(init?: RequestInit): RequestInit | undefined;
     get sessionUrl(): string;
     getSession: (req: NileRequest<void> | Headers, init?: RequestInit) => Promise<JWT | ActiveSession | Response | undefined>;
+    get getCsrfUrl(): string;
+    getCsrf(req: NileRequest<void> | Headers, init?: RequestInit): Promise<JSON | Response>;
+    get listProvidersUrl(): string;
+    listProviders: (req: NileRequest<void> | Headers, init?: RequestInit) => Promise<Response | {
+        [key: string]: Provider;
+    }>;
+    get signOutUrl(): string;
+    signOut: (req: NileRequest<void | {
+        callbackUrl?: string;
+    }> | Headers, init?: RequestInit) => Promise<Response | JSON>;
 }
 
 declare class Tenants extends Config {

package/dist/index.d.ts

@@ -145,6 +145,13 @@ type Tenant = {
     name: string;
 };
 
+type Provider = {
+    id: string;
+    name: string;
+    type: string;
+    signinUrl: string;
+    callbackUr: string;
+};
 type JWT = {
     email: string;
     sub: string;
@@ -212,6 +219,16 @@ declare class Auth extends Config {
     handleHeaders(init?: RequestInit): RequestInit | undefined;
     get sessionUrl(): string;
     getSession: (req: NileRequest<void> | Headers, init?: RequestInit) => Promise<JWT | ActiveSession | Response | undefined>;
+    get getCsrfUrl(): string;
+    getCsrf(req: NileRequest<void> | Headers, init?: RequestInit): Promise<JSON | Response>;
+    get listProvidersUrl(): string;
+    listProviders: (req: NileRequest<void> | Headers, init?: RequestInit) => Promise<Response | {
+        [key: string]: Provider;
+    }>;
+    get signOutUrl(): string;
+    signOut: (req: NileRequest<void | {
+        callbackUrl?: string;
+    }> | Headers, init?: RequestInit) => Promise<Response | JSON>;
 }
 
 declare class Tenants extends Config {

package/dist/index.js

@@ -1077,7 +1077,8 @@ async function _fetch(config, path, opts) {
     const errorHandler = typeof response?.clone === "function" ? response.clone() : null;
     let msg = "";
     try {
-      res = await response?.json();
+      res = await response?.json().catch(() => {
+      });
     } catch (e) {
       if (errorHandler) {
         msg = await errorHandler.text();
@@ -1110,7 +1111,8 @@ async function _fetch(config, path, opts) {
     error(
       `[fetch][response][status: ${errorHandler?.status}] UNHANDLED ERROR`,
       {
-        res
+        response,
+        message: await response.text()
       }
     );
     return new ResponseError(null, {
@@ -1773,7 +1775,7 @@ var appRoutes = (prefix = "/api") => ({
   TENANT_USER: `${prefix}/tenants/{tenantId}/users/{userId}`,
   TENANT_USERS: `${prefix}/tenants/{tenantId}/users`,
   SIGNUP: `${prefix}/signup`,
-  LOG: `${prefix}/auth/_log`
+  LOG: `${prefix}/_log`
 });
 
 // src/utils/Requester/index.ts
@@ -1783,9 +1785,9 @@ var Requester = class extends Config {
   }
   async rawRequest(method, url, init, body) {
     const _init = {
-      ...init,
       body,
-      method
+      method,
+      ...init
     };
     const res = await _fetch(this, url, _init);
     if (res instanceof ResponseError) {
@@ -1986,6 +1988,8 @@ var Auth = class extends Config {
   }
   handleHeaders(init) {
     if (this.headers) {
+      const cburl = getCallbackUrl2(this.headers);
+      this.headers.set(X_NILE_ORIGIN, new URL(cburl).origin);
       if (init) {
         init.headers = new Headers({ ...this.headers, ...init?.headers });
         return init;
@@ -2010,7 +2014,57 @@ var Auth = class extends Config {
     }
     return session;
   };
+  get getCsrfUrl() {
+    return "/auth/csrf";
+  }
+  async getCsrf(req, init) {
+    const _requester = new Requester(this);
+    const _init = this.handleHeaders(init);
+    return await _requester.get(req, this.getCsrfUrl, _init);
+  }
+  get listProvidersUrl() {
+    return "/auth/providers";
+  }
+  listProviders = async (req, init) => {
+    const _requester = new Requester(this);
+    const _init = this.handleHeaders(init);
+    return await _requester.get(req, this.listProvidersUrl, _init);
+  };
+  get signOutUrl() {
+    return "/auth/signout";
+  }
+  signOut = async (req, init) => {
+    const _requester = new Requester(this);
+    const _init = this.handleHeaders(init);
+    const csrf = await this.getCsrf(req);
+    const callbackUrl = req && "callbackUrl" in req ? String(req.callbackUrl) : "/";
+    if (csrf instanceof Request) {
+      return csrf;
+    }
+    const csrfToken = "csrfToken" in csrf ? String(csrf.csrfToken) : "";
+    if (!csrfToken) {
+      return new Response("Request blocked", { status: 400 });
+    }
+    return await _requester.post(req, this.signOutUrl, {
+      method: "post",
+      body: JSON.stringify({
+        csrfToken,
+        callbackUrl,
+        json: String(true)
+      }),
+      ..._init
+    });
+  };
 };
+function getCallbackUrl2(headers) {
+  if (headers) {
+    const cookieHeader = headers.get("cookie") || "";
+    const cookies = Object.fromEntries(
+      cookieHeader.split("; ").map((cookie) => cookie.split("=").map(decodeURIComponent))
+    );
+    return cookies["__Secure-nile.callback-url"] || cookies["nile.callback-url"];
+  }
+}
 
 // src/tenants/index.ts
 var Tenants = class extends Config {