@forteplatforms/sdk 1.0.160 → 1.0.164

package/README.md

@@ -10,27 +10,48 @@ npm install @forteplatforms/sdk
 
 ## Authentication
 
-When your code runs inside a Forte-hosted service, `FORTE_API_TOKEN` is set automatically and scoped to the service's project — no configuration needed:
+The SDK supports three auth modes depending on where it runs.
+
+### Inside a Forte-hosted service (no config)
+
+`FORTE_API_TOKEN` is set automatically and scoped to the service's project:
 
 ```typescript
 const client = new ForteClient();
 ```
 
-Outside of Forte (local development, external hosting), pass the token explicitly:
+### Client-side (browser / mobile)
+
+For calls to `client.users.*`, construct with no arguments. The browser sends the `Forte-User-Session-Token` cookie automatically after the user logs in. The SDK sets `credentials: 'include'` so the cookie reaches the API cross-origin.
 
 ```typescript
-const client = new ForteClient({ apiToken: 'your_api_token_here' });
+const client = new ForteClient();
+await client.users.renewSessionToken({ projectId });
 ```
 
-Or set it as an environment variable (Node.js only):
+Do **not** pass `apiToken` from browser code — it's a server-side secret.
 
-```bash
-export FORTE_API_TOKEN=your_api_token_here
+### Server-side BFF calling `client.users.*` (no token, per-call authorization)
+
+In a BFF that proxies user-scoped calls, omit the token and forward each user's session token as the `authorization` parameter on each call:
+
+```typescript
+const client = new ForteClient();
+await client.users.renewSessionToken({
+  projectId,
+  authorization: `Bearer ${userSessionToken}`,
+});
 ```
 
-You can generate an API token from the Forte Platforms dashboard.
+### External server-side calling `client.projects.*` (explicit token)
 
-> **Note:** The TypeScript SDK works in both Node.js and browser/React environments. In browsers, you must pass `apiToken` directly since environment variables are not available.
+```typescript
+const client = new ForteClient({ apiToken: 'your_api_token_here' });
+```
+
+Or set `FORTE_API_TOKEN` in the environment (Node.js only) and call `new ForteClient()`.
+
+You can generate an API token from the Forte Platforms dashboard.
 
 ## Quick Start
 

package/dist/generated/apis/ProjectsServerApi.d.ts

@@ -272,6 +272,11 @@ export interface ListUserPaymentsRequest {
 }
 export interface ListUsersRequest {
     projectId: string;
+    email?: string;
+    phone?: string;
+    fullName?: string;
+    metadataKey?: string;
+    metadataValue?: string;
     minTime?: Date;
     maxTime?: Date;
     nextToken?: string;
@@ -1125,6 +1130,7 @@ export declare const ListUserActionLogsActionTypeType: {
     readonly USER_HARD_DELETED: "USER_HARD_DELETED";
     readonly CONTACT_METHOD_ADDED: "CONTACT_METHOD_ADDED";
     readonly CONTACT_METHOD_REMOVED: "CONTACT_METHOD_REMOVED";
+    readonly CONTACT_METHOD_DISPLACED: "CONTACT_METHOD_DISPLACED";
     readonly CONTACT_METHOD_VERIFICATION_CODE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_SENT";
     readonly CONTACT_METHOD_VERIFICATION_CODE_RE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_RE_SENT";
     readonly CONTACT_METHOD_VERIFIED: "CONTACT_METHOD_VERIFIED";

package/dist/generated/apis/ProjectsServerApi.js

@@ -2818,6 +2818,21 @@ var ProjectsServerApi = /** @class */ (function (_super) {
                     throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listUsers().');
                 }
                 queryParameters = {};
+                if (requestParameters['email'] != null) {
+                    queryParameters['email'] = requestParameters['email'];
+                }
+                if (requestParameters['phone'] != null) {
+                    queryParameters['phone'] = requestParameters['phone'];
+                }
+                if (requestParameters['fullName'] != null) {
+                    queryParameters['fullName'] = requestParameters['fullName'];
+                }
+                if (requestParameters['metadataKey'] != null) {
+                    queryParameters['metadataKey'] = requestParameters['metadataKey'];
+                }
+                if (requestParameters['metadataValue'] != null) {
+                    queryParameters['metadataValue'] = requestParameters['metadataValue'];
+                }
                 if (requestParameters['minTime'] != null) {
                     queryParameters['minTime'] = requestParameters['minTime'].toISOString();
                 }
@@ -4569,6 +4584,7 @@ exports.ListUserActionLogsActionTypeType = {
     USER_HARD_DELETED: 'USER_HARD_DELETED',
     CONTACT_METHOD_ADDED: 'CONTACT_METHOD_ADDED',
     CONTACT_METHOD_REMOVED: 'CONTACT_METHOD_REMOVED',
+    CONTACT_METHOD_DISPLACED: 'CONTACT_METHOD_DISPLACED',
     CONTACT_METHOD_VERIFICATION_CODE_SENT: 'CONTACT_METHOD_VERIFICATION_CODE_SENT',
     CONTACT_METHOD_VERIFICATION_CODE_RE_SENT: 'CONTACT_METHOD_VERIFICATION_CODE_RE_SENT',
     CONTACT_METHOD_VERIFIED: 'CONTACT_METHOD_VERIFIED',

package/dist/generated/models/SearchUsersRequest.d.ts

@@ -9,37 +9,18 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { UserFilter } from './UserFilter';
 /**
  *
  * @export
  * @interface SearchUsersRequest
  */
 export interface SearchUsersRequest {
-    /**
-     *
-     * @type {Array<UserFilter>}
-     * @memberof SearchUsersRequest
-     */
-    filters?: Array<UserFilter>;
-    /**
-     *
-     * @type {Date}
-     * @memberof SearchUsersRequest
-     */
-    minTime?: Date;
-    /**
-     *
-     * @type {Date}
-     * @memberof SearchUsersRequest
-     */
-    maxTime?: Date;
     /**
      *
      * @type {string}
      * @memberof SearchUsersRequest
      */
-    nextToken?: string;
+    q: string;
 }
 /**
  * Check if a given object implements the SearchUsersRequest interface.

package/dist/generated/models/SearchUsersRequest.js

@@ -18,11 +18,12 @@ exports.SearchUsersRequestFromJSON = SearchUsersRequestFromJSON;
 exports.SearchUsersRequestFromJSONTyped = SearchUsersRequestFromJSONTyped;
 exports.SearchUsersRequestToJSON = SearchUsersRequestToJSON;
 exports.SearchUsersRequestToJSONTyped = SearchUsersRequestToJSONTyped;
-var UserFilter_1 = require("./UserFilter");
 /**
  * Check if a given object implements the SearchUsersRequest interface.
  */
 function instanceOfSearchUsersRequest(value) {
+    if (!('q' in value) || value['q'] === undefined)
+        return false;
     return true;
 }
 function SearchUsersRequestFromJSON(json) {
@@ -33,10 +34,7 @@ function SearchUsersRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'filters': json['filters'] == null ? undefined : (json['filters'].map(UserFilter_1.UserFilterFromJSON)),
-        'minTime': json['minTime'] == null ? undefined : (new Date(json['minTime'])),
-        'maxTime': json['maxTime'] == null ? undefined : (new Date(json['maxTime'])),
-        'nextToken': json['nextToken'] == null ? undefined : json['nextToken'],
+        'q': json['q'],
     };
 }
 function SearchUsersRequestToJSON(json) {
@@ -48,9 +46,6 @@ function SearchUsersRequestToJSONTyped(value, ignoreDiscriminator) {
         return value;
     }
     return {
-        'filters': value['filters'] == null ? undefined : (value['filters'].map(UserFilter_1.UserFilterToJSON)),
-        'minTime': value['minTime'] == null ? value['minTime'] : value['minTime'].toISOString(),
-        'maxTime': value['maxTime'] == null ? value['maxTime'] : value['maxTime'].toISOString(),
-        'nextToken': value['nextToken'],
+        'q': value['q'],
     };
 }

package/dist/generated/models/UserActionLogObject.d.ts

@@ -64,6 +64,7 @@ export declare const UserActionLogObjectActionTypeType: {
     readonly USER_HARD_DELETED: "USER_HARD_DELETED";
     readonly CONTACT_METHOD_ADDED: "CONTACT_METHOD_ADDED";
     readonly CONTACT_METHOD_REMOVED: "CONTACT_METHOD_REMOVED";
+    readonly CONTACT_METHOD_DISPLACED: "CONTACT_METHOD_DISPLACED";
     readonly CONTACT_METHOD_VERIFICATION_CODE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_SENT";
     readonly CONTACT_METHOD_VERIFICATION_CODE_RE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_RE_SENT";
     readonly CONTACT_METHOD_VERIFIED: "CONTACT_METHOD_VERIFIED";

package/dist/generated/models/UserActionLogObject.js

@@ -29,6 +29,7 @@ exports.UserActionLogObjectActionTypeType = {
     USER_HARD_DELETED: 'USER_HARD_DELETED',
     CONTACT_METHOD_ADDED: 'CONTACT_METHOD_ADDED',
     CONTACT_METHOD_REMOVED: 'CONTACT_METHOD_REMOVED',
+    CONTACT_METHOD_DISPLACED: 'CONTACT_METHOD_DISPLACED',
     CONTACT_METHOD_VERIFICATION_CODE_SENT: 'CONTACT_METHOD_VERIFICATION_CODE_SENT',
     CONTACT_METHOD_VERIFICATION_CODE_RE_SENT: 'CONTACT_METHOD_VERIFICATION_CODE_RE_SENT',
     CONTACT_METHOD_VERIFIED: 'CONTACT_METHOD_VERIFIED',

package/dist/generated/models/index.d.ts

@@ -89,7 +89,6 @@ export * from './UpdateProjectRequest';
 export * from './UpdateWebAppRequest';
 export * from './UpdateWebAppResponse';
 export * from './UserActionLogObject';
-export * from './UserFilter';
 export * from './UserMetricsResponse';
 export * from './UserObject';
 export * from './WebAppBuildRequestObject';

package/dist/generated/models/index.js

@@ -107,7 +107,6 @@ __exportStar(require("./UpdateProjectRequest"), exports);
 __exportStar(require("./UpdateWebAppRequest"), exports);
 __exportStar(require("./UpdateWebAppResponse"), exports);
 __exportStar(require("./UserActionLogObject"), exports);
-__exportStar(require("./UserFilter"), exports);
 __exportStar(require("./UserMetricsResponse"), exports);
 __exportStar(require("./UserObject"), exports);
 __exportStar(require("./WebAppBuildRequestObject"), exports);

package/dist/index.js

@@ -23,14 +23,20 @@ var ForteClient = /** @class */ (function () {
     function ForteClient(options) {
         if (options === void 0) { options = {}; }
         var _a, _b, _c;
-        // Falls back to FORTE_API_TOKEN env var in Node.js; safe in browsers where process is undefined
+        // Falls back to FORTE_API_TOKEN env var in Node.js; safe in browsers where process is undefined.
+        // No token is OK: in browsers the Forte-User-Session-Token cookie authenticates users.*;
+        // in BFFs the caller passes `authorization` per-call to users.*.
         var token = (_a = options.apiToken) !== null && _a !== void 0 ? _a : (typeof process !== 'undefined' ? (_b = process.env) === null || _b === void 0 ? void 0 : _b.FORTE_API_TOKEN : undefined);
-        if (!token) {
-            throw new Error('API token is required. Pass apiToken in the constructor options, or set the FORTE_API_TOKEN environment variable (Node.js only).');
+        var headers = {};
+        if (token) {
+            headers.Authorization = "Bearer ".concat(token);
         }
         var config = new runtime_1.Configuration({
             basePath: (_c = options.baseUrl) !== null && _c !== void 0 ? _c : 'https://api.forteplatforms.com',
-            headers: { Authorization: "Bearer ".concat(token) },
+            headers: headers,
+            // Always include credentials so browsers send the Forte-User-Session-Token cookie
+            // cross-origin. No-op for Node.js fetch.
+            credentials: 'include',
         });
         this.projects = new ProjectsServerApi_1.ProjectsServerApi(config);
         this.users = new UsersServerApi_1.UsersServerApi(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forteplatforms/sdk",
-  "version": "1.0.160",
+  "version": "1.0.164",
   "description": "Official TypeScript SDK for Forte Platforms",
   "author": "Forte Platforms <support@forteplatforms.com>",
   "repository": {

package/dist/generated/models/UserFilter.d.ts

@@ -1,50 +0,0 @@
-/**
- * OpenAPI definition
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface UserFilter
- */
-export interface UserFilter {
-    /**
-     *
-     * @type {string}
-     * @memberof UserFilter
-     */
-    email?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UserFilter
-     */
-    phone?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UserFilter
-     */
-    metadataKey?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UserFilter
-     */
-    metadataValue?: string;
-}
-/**
- * Check if a given object implements the UserFilter interface.
- */
-export declare function instanceOfUserFilter(value: object): value is UserFilter;
-export declare function UserFilterFromJSON(json: any): UserFilter;
-export declare function UserFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFilter;
-export declare function UserFilterToJSON(json: any): UserFilter;
-export declare function UserFilterToJSONTyped(value?: UserFilter | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/UserFilter.js

@@ -1,55 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * OpenAPI definition
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfUserFilter = instanceOfUserFilter;
-exports.UserFilterFromJSON = UserFilterFromJSON;
-exports.UserFilterFromJSONTyped = UserFilterFromJSONTyped;
-exports.UserFilterToJSON = UserFilterToJSON;
-exports.UserFilterToJSONTyped = UserFilterToJSONTyped;
-/**
- * Check if a given object implements the UserFilter interface.
- */
-function instanceOfUserFilter(value) {
-    return true;
-}
-function UserFilterFromJSON(json) {
-    return UserFilterFromJSONTyped(json, false);
-}
-function UserFilterFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'email': json['email'] == null ? undefined : json['email'],
-        'phone': json['phone'] == null ? undefined : json['phone'],
-        'metadataKey': json['metadataKey'] == null ? undefined : json['metadataKey'],
-        'metadataValue': json['metadataValue'] == null ? undefined : json['metadataValue'],
-    };
-}
-function UserFilterToJSON(json) {
-    return UserFilterToJSONTyped(json, false);
-}
-function UserFilterToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'email': value['email'],
-        'phone': value['phone'],
-        'metadataKey': value['metadataKey'],
-        'metadataValue': value['metadataValue'],
-    };
-}