@faable/auth-sdk 1.1.0 → 1.1.2

package/README.md

@@ -11,8 +11,54 @@
   </a>
 </p>
 
+Programmatically perform FaableAuth administrative tasks though our REST API.
+
+> ⚠️ Use server side only. Otherwise administrative credentials may be exposed in client side.
+
 ## Install
 
 ```bash
  npm install @faable/auth-sdk
 ```
+
+## Config
+
+```js
+import { FaableAuthApi } from "@faable/auth-sdk";
+import { createClientCredentials } from "@faable/sdk-base";
+
+const auth = createClientCredentials();
+
+const api = FaableAuthApi.create({
+  auth,
+  team: "<faable_team_id>",
+});
+```
+
+## Usage
+
+Get user:
+
+```js
+const user = await api.getUser("<user_id>");
+```
+
+Update user:
+
+```js
+const updated_user = await api.updateUser("<user_id>", {
+  phone: "+34XXXXXXXXX",
+});
+```
+
+List users:
+
+```js
+// Returns first page of latest 30 users
+const users = await api.listUsers().first();
+```
+
+```js
+// Query users with email=demo@example.com
+const users = await api.listUsers({ email: "demo@example.com" }).first();
+```

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from "./FaableAuthApi.js";
+export * from "./types/types.js";

package/dist/index.js

@@ -1 +1,2 @@
 export * from "./FaableAuthApi.js";
+export * from "./types/types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/auth-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "author": "Marc Pomar <marc@faable.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",