@gleanwork/api-client 0.1.0-beta.9 → 0.3.0

package/FUNCTIONS.md

@@ -26,7 +26,7 @@ import { SDKValidationError } from "@gleanwork/api-client/models/errors/sdkvalid
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, Glean Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,13 +1,68 @@
 # Glean TypeScript API Client
 
-<!-- No Summary [summary] -->
-
 The Glean TypeScript SDK provides convenient access to the Glean REST API in both browser and Node.js environments. It offers full TypeScript types, modern async/await support, and uses the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API under the hood.
 
+## Unified SDK Architecture
+
+This SDK combines both the Client and Indexing API namespaces into a single unified package:
+
+- **Client API**: Used for search, retrieval, and end-user interactions with Glean content
+- **Indexing API**: Used for indexing content, permissions, and other administrative operations
+
+Each namespace has its own authentication requirements and access patterns. While they serve different purposes, having them in a single SDK provides a consistent developer experience across all Glean API interactions.
+
+```typescript
+// Example of accessing Client namespace
+const glean = new Glean({
+  instance: 'instance-name',
+  apiToken: 'client-token'
+});
+
+await glean.client.search.query({ 
+  query: 'search term' 
+});
+
+// Example of accessing Indexing namespace 
+const glean = new Glean({
+  instance: 'instance-name',
+  apiToken: 'indexing-token'
+});
+
+await glean.indexing.documents.index({ 
+  /* document data */ 
+});
+```
+
+Remember that each namespace requires its own authentication token type as described in the [Authentication Methods](#authentication-methods) section.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Glean API: # Introduction
+In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
+
+# Usage guidelines
+This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along
+with a 6-month sunset period for anything that requires developers to adopt the new versions.
+
+# API Clients
+Official API clients for the Glean Indexing API are available in multiple languages:
+
+- [Python](https://github.com/gleanwork/api-client-python)
+- [TypeScript](https://github.com/gleanwork/api-client-typescript)
+- [Go](https://github.com/gleanwork/api-client-go)
+- [Java](https://github.com/gleanwork/api-client-java)
+
+These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
+<!-- End Summary [summary] -->
+
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
 * [Glean TypeScript API Client](#glean-typescript-api-client)
+  * [Unified SDK Architecture](#unified-sdk-architecture)
+* [Usage guidelines](#usage-guidelines)
+* [API Clients](#api-clients)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
@@ -85,7 +140,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -115,7 +170,7 @@ run();
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -147,16 +202,16 @@ run();
 
 This SDK supports the following security scheme globally:
 
-| Name         | Type | Scheme      | Environment Variable |
-| ------------ | ---- | ----------- | -------------------- |
-| `bearerAuth` | http | HTTP Bearer | `GLEAN_BEARER_AUTH`  |
+| Name       | Type | Scheme      | Environment Variable |
+| ---------- | ---- | ----------- | -------------------- |
+| `apiToken` | http | HTTP Bearer | `GLEAN_API_TOKEN`    |
 
-To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `apiToken` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -193,6 +248,35 @@ run();
 ```
 <!-- End Authentication [security] -->
 
+### Authentication Methods
+
+Glean supports different authentication methods depending on which API namespace you're using:
+
+#### Client Namespace
+
+The Client namespace supports two authentication methods:
+
+1. **Manually Provisioned API Tokens**
+   - Can be created by an Admin or a user with the API Token Creator role
+   - Used for server-to-server integrations
+
+2. **OAuth**
+   - Requires OAuth setup to be completed by an Admin
+   - Used for user-based authentication flows
+
+#### Indexing Namespace
+
+The Indexing namespace supports only one authentication method:
+
+1. **Manually Provisioned API Tokens**
+   - Can be created by an Admin or a user with the API Token Creator role
+   - Used for secure document indexing operations
+
+> [!IMPORTANT]
+> Client tokens **will not work** for Indexing operations, and Indexing tokens **will not work** for Client operations. You must use the appropriate token type for the namespace you're accessing.
+
+For more information on obtaining the appropriate token type, please contact your Glean administrator.
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -627,7 +711,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -689,7 +773,7 @@ const glean = new Glean({
     },
     retryConnectionErrors: false,
   },
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -744,11 +828,11 @@ The following errors may be thrown by the SDK:
 ### Example
 
 ```typescript
-import { Glean } from "@gleanwork/api-client";
+import { Glean } from "@gleanwork/api-client";****
 import { GleanDataError, GleanError } from "glean/models/errors";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_BEARER_AUTH"] ?? "",
 });
 
 try {
@@ -794,11 +878,11 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 ### Server Variables
 
-The default server `https://{domain}-be.glean.com` contains variables and is set to `https://domain-be.glean.com` by default. To override default values, the following parameters are available when initializing the SDK client instance:
+The default server `https://{instance}-be.glean.com` contains variables and is set to `https://instance-name-be.glean.com` by default. To override default values, the following parameters are available when initializing the SDK client instance:
 
-| Variable | Parameter        | Default    | Description                                                              |
-| -------- | ---------------- | ---------- | ------------------------------------------------------------------------ |
-| `domain` | `domain: string` | `"domain"` | Email domain (without extension) that determines the deployment backend. |
+| Variable   | Parameter          | Default           | Description                                                                                                  |
+| ---------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------ |
+| `instance` | `instance: string` | `"instance-name"` | The instance name (typically the email domain without the extension) that determines the deployment backend. |
 
 #### Example
 
@@ -806,8 +890,8 @@ The default server `https://{domain}-be.glean.com` contains variables and is set
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  domain: "scared-pearl.biz",
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  instance: "<value>",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -850,8 +934,8 @@ The default server can be overridden globally by passing a URL to the `serverURL
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  serverURL: "https://domain-be.glean.com",
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  serverURL: "https://instance-name-be.glean.com",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {

package/dist/commonjs/__tests__/activity.test.js

@@ -11,7 +11,7 @@ const testclient_js_1 = require("./testclient.js");
     const glean = new index_js_1.Glean({
         serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
         httpClient: testHttpClient,
-        bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
+        apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
     });
     await glean.client.activity.report({
         events: [
@@ -45,7 +45,7 @@ const testclient_js_1 = require("./testclient.js");
     const glean = new index_js_1.Glean({
         serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
         httpClient: testHttpClient,
-        bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
+        apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
     });
     await glean.client.activity.feedback({
         trackingTokens: [

package/dist/commonjs/__tests__/activity.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"activity.test.js","sourceRoot":"","sources":["../../../src/__tests__/activity.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,mCAA8B;AAC9B,0CAAoC;AACpC,mDAAuD;AAEvD,IAAA,aAAI,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACnC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,OAAO;KACxD,CAAC,CAAC;IAEH,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjC,MAAM,EAAE;YACN;gBACE,MAAM,EAAE,iBAAiB;gBACzB,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,sBAAsB;aAC5B;YACD;gBACE,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE;oBACN,KAAK,EAAE,OAAO;iBACf;gBACD,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,oCAAoC;aAC1C;YACD;gBACE,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE;oBACN,QAAQ,EAAE,EAAE;oBACZ,QAAQ,EAAE,8BAA8B;iBACzC;gBACD,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,sBAAsB;aAC5B;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACnC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,OAAO;KACxD,CAAC,CAAC;IAEH,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACnC,cAAc,EAAE;YACd,gBAAgB;SACjB;QACD,KAAK,EAAE,MAAM;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"activity.test.js","sourceRoot":"","sources":["../../../src/__tests__/activity.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,mCAA8B;AAC9B,0CAAoC;AACpC,mDAAuD;AAEvD,IAAA,aAAI,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACnC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjC,MAAM,EAAE;YACN;gBACE,MAAM,EAAE,iBAAiB;gBACzB,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,sBAAsB;aAC5B;YACD;gBACE,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE;oBACN,KAAK,EAAE,OAAO;iBACf;gBACD,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,oCAAoC;aAC1C;YACD;gBACE,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE;oBACN,QAAQ,EAAE,EAAE;oBACZ,QAAQ,EAAE,8BAA8B;iBACzC;gBACD,SAAS,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;gBAC/C,GAAG,EAAE,sBAAsB;aAC5B;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACnC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACnC,cAAc,EAAE;YACd,gBAAgB;SACjB;QACD,KAAK,EAAE,MAAM;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}