@uniformdev/context 20.72.4-alpha.6 → 20.73.1-alpha.13

package/dist/api/api.d.mts

@@ -26,6 +26,11 @@ type ClientOptions = {
     signal?: AbortSignal;
 };
 type ExceptProject<T> = Omit<T, 'projectId'>;
+/**
+ * Uniform API 401 message for an invalid or expired bearer token.
+ * Prefer catching {@link BearerTokenNotValidOrExpiredError} when using ApiClient-based SDKs.
+ */
+declare const UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE: "Bearer token not valid or expired";
 declare class ApiClientError extends Error {
     errorMessage: string;
     fetchMethod: string;
@@ -35,6 +40,13 @@ declare class ApiClientError extends Error {
     requestId?: string | undefined;
     constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number | undefined, statusText?: string | undefined, requestId?: string | undefined);
 }
+/**
+ * Thrown when the Uniform API responds with 401 and
+ * {@link UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE}.
+ */
+declare class BearerTokenNotValidOrExpiredError extends ApiClientError {
+    constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number, statusText?: string, requestId?: string);
+}
 
 declare class ApiClient<TOptions extends ClientOptions = ClientOptions> {
     protected options: TOptions;
@@ -1966,4 +1978,4 @@ declare class CachedContextClient extends ContextClient {
     constructor(options: Omit<ClientOptions, 'bypassCache'>);
 }
 
-export { type Aggregate, AggregateClient, type AggregateDeleteParameters, type AggregateGetParameters, type AggregateGetResponse, type AggregatePutParameters, ApiClient, ApiClientError, CachedAggregateClient, CachedContextClient, CachedDimensionClient, CachedEnrichmentClient, CachedManifestClient, CachedQuirkClient, CachedSignalClient, CachedTestClient, type ClientOptions, ContextClient, type ContextDefinitions, type CookieCriteria, type CurrentPageCriteria, DimensionClient, type DimensionDefinition, type DimensionDisplayData, type DimensionGetParameters, type DimensionGetResponse, type EnrichmentCategory, type EnrichmentCategoryWithValues, EnrichmentClient, type EnrichmentDeleteParameters, type EnrichmentGetParameters, type EnrichmentGetResponse, type EnrichmentPutParameters, type EnrichmentValue, type EnrichmentValueDeleteParameters, type EnrichmentValuePutParameters, type EventCriteria, type ExceptProject, type LimitPolicy, ManifestClient, type ManifestGetParameters, type ManifestGetResponse, type PageViewCountCriteria, type QueryStringCriteria, type Quirk, QuirkClient, type QuirkCriteria, type QuirkDeleteParameters, type QuirkGetParameters, type QuirkGetResponse, type QuirkPutParameters, type RootSignalCriteriaGroup, SignalClient, type SignalDeleteParameters, type SignalGetParameters, type SignalGetResponse, type SignalPutParameters, type SignalWithId, type Test, TestClient, type TestDeleteParameters, type TestGetParameters, type TestGetResponse, type TestPutParameters, UncachedAggregateClient, UncachedContextClient, UncachedDimensionClient, UncachedEnrichmentClient, UncachedManifestClient, UncachedQuirkClient, UncachedSignalClient, UncachedTestClient, computeDimensionDefinitionDisplayData, computeDimensionDisplayData, computeDimensionDisplayName, defaultLimitPolicy, handleRateLimits, nullLimitPolicy, rewriteFiltersForApi };
+export { type Aggregate, AggregateClient, type AggregateDeleteParameters, type AggregateGetParameters, type AggregateGetResponse, type AggregatePutParameters, ApiClient, ApiClientError, BearerTokenNotValidOrExpiredError, CachedAggregateClient, CachedContextClient, CachedDimensionClient, CachedEnrichmentClient, CachedManifestClient, CachedQuirkClient, CachedSignalClient, CachedTestClient, type ClientOptions, ContextClient, type ContextDefinitions, type CookieCriteria, type CurrentPageCriteria, DimensionClient, type DimensionDefinition, type DimensionDisplayData, type DimensionGetParameters, type DimensionGetResponse, type EnrichmentCategory, type EnrichmentCategoryWithValues, EnrichmentClient, type EnrichmentDeleteParameters, type EnrichmentGetParameters, type EnrichmentGetResponse, type EnrichmentPutParameters, type EnrichmentValue, type EnrichmentValueDeleteParameters, type EnrichmentValuePutParameters, type EventCriteria, type ExceptProject, type LimitPolicy, ManifestClient, type ManifestGetParameters, type ManifestGetResponse, type PageViewCountCriteria, type QueryStringCriteria, type Quirk, QuirkClient, type QuirkCriteria, type QuirkDeleteParameters, type QuirkGetParameters, type QuirkGetResponse, type QuirkPutParameters, type RootSignalCriteriaGroup, SignalClient, type SignalDeleteParameters, type SignalGetParameters, type SignalGetResponse, type SignalPutParameters, type SignalWithId, type Test, TestClient, type TestDeleteParameters, type TestGetParameters, type TestGetResponse, type TestPutParameters, UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE, UncachedAggregateClient, UncachedContextClient, UncachedDimensionClient, UncachedEnrichmentClient, UncachedManifestClient, UncachedQuirkClient, UncachedSignalClient, UncachedTestClient, computeDimensionDefinitionDisplayData, computeDimensionDisplayData, computeDimensionDisplayName, defaultLimitPolicy, handleRateLimits, nullLimitPolicy, rewriteFiltersForApi };

package/dist/api/api.d.ts

@@ -26,6 +26,11 @@ type ClientOptions = {
     signal?: AbortSignal;
 };
 type ExceptProject<T> = Omit<T, 'projectId'>;
+/**
+ * Uniform API 401 message for an invalid or expired bearer token.
+ * Prefer catching {@link BearerTokenNotValidOrExpiredError} when using ApiClient-based SDKs.
+ */
+declare const UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE: "Bearer token not valid or expired";
 declare class ApiClientError extends Error {
     errorMessage: string;
     fetchMethod: string;
@@ -35,6 +40,13 @@ declare class ApiClientError extends Error {
     requestId?: string | undefined;
     constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number | undefined, statusText?: string | undefined, requestId?: string | undefined);
 }
+/**
+ * Thrown when the Uniform API responds with 401 and
+ * {@link UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE}.
+ */
+declare class BearerTokenNotValidOrExpiredError extends ApiClientError {
+    constructor(errorMessage: string, fetchMethod: string, fetchUri: string, statusCode?: number, statusText?: string, requestId?: string);
+}
 
 declare class ApiClient<TOptions extends ClientOptions = ClientOptions> {
     protected options: TOptions;
@@ -1966,4 +1978,4 @@ declare class CachedContextClient extends ContextClient {
     constructor(options: Omit<ClientOptions, 'bypassCache'>);
 }
 
-export { type Aggregate, AggregateClient, type AggregateDeleteParameters, type AggregateGetParameters, type AggregateGetResponse, type AggregatePutParameters, ApiClient, ApiClientError, CachedAggregateClient, CachedContextClient, CachedDimensionClient, CachedEnrichmentClient, CachedManifestClient, CachedQuirkClient, CachedSignalClient, CachedTestClient, type ClientOptions, ContextClient, type ContextDefinitions, type CookieCriteria, type CurrentPageCriteria, DimensionClient, type DimensionDefinition, type DimensionDisplayData, type DimensionGetParameters, type DimensionGetResponse, type EnrichmentCategory, type EnrichmentCategoryWithValues, EnrichmentClient, type EnrichmentDeleteParameters, type EnrichmentGetParameters, type EnrichmentGetResponse, type EnrichmentPutParameters, type EnrichmentValue, type EnrichmentValueDeleteParameters, type EnrichmentValuePutParameters, type EventCriteria, type ExceptProject, type LimitPolicy, ManifestClient, type ManifestGetParameters, type ManifestGetResponse, type PageViewCountCriteria, type QueryStringCriteria, type Quirk, QuirkClient, type QuirkCriteria, type QuirkDeleteParameters, type QuirkGetParameters, type QuirkGetResponse, type QuirkPutParameters, type RootSignalCriteriaGroup, SignalClient, type SignalDeleteParameters, type SignalGetParameters, type SignalGetResponse, type SignalPutParameters, type SignalWithId, type Test, TestClient, type TestDeleteParameters, type TestGetParameters, type TestGetResponse, type TestPutParameters, UncachedAggregateClient, UncachedContextClient, UncachedDimensionClient, UncachedEnrichmentClient, UncachedManifestClient, UncachedQuirkClient, UncachedSignalClient, UncachedTestClient, computeDimensionDefinitionDisplayData, computeDimensionDisplayData, computeDimensionDisplayName, defaultLimitPolicy, handleRateLimits, nullLimitPolicy, rewriteFiltersForApi };
+export { type Aggregate, AggregateClient, type AggregateDeleteParameters, type AggregateGetParameters, type AggregateGetResponse, type AggregatePutParameters, ApiClient, ApiClientError, BearerTokenNotValidOrExpiredError, CachedAggregateClient, CachedContextClient, CachedDimensionClient, CachedEnrichmentClient, CachedManifestClient, CachedQuirkClient, CachedSignalClient, CachedTestClient, type ClientOptions, ContextClient, type ContextDefinitions, type CookieCriteria, type CurrentPageCriteria, DimensionClient, type DimensionDefinition, type DimensionDisplayData, type DimensionGetParameters, type DimensionGetResponse, type EnrichmentCategory, type EnrichmentCategoryWithValues, EnrichmentClient, type EnrichmentDeleteParameters, type EnrichmentGetParameters, type EnrichmentGetResponse, type EnrichmentPutParameters, type EnrichmentValue, type EnrichmentValueDeleteParameters, type EnrichmentValuePutParameters, type EventCriteria, type ExceptProject, type LimitPolicy, ManifestClient, type ManifestGetParameters, type ManifestGetResponse, type PageViewCountCriteria, type QueryStringCriteria, type Quirk, QuirkClient, type QuirkCriteria, type QuirkDeleteParameters, type QuirkGetParameters, type QuirkGetResponse, type QuirkPutParameters, type RootSignalCriteriaGroup, SignalClient, type SignalDeleteParameters, type SignalGetParameters, type SignalGetResponse, type SignalPutParameters, type SignalWithId, type Test, TestClient, type TestDeleteParameters, type TestGetParameters, type TestGetResponse, type TestPutParameters, UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE, UncachedAggregateClient, UncachedContextClient, UncachedDimensionClient, UncachedEnrichmentClient, UncachedManifestClient, UncachedQuirkClient, UncachedSignalClient, UncachedTestClient, computeDimensionDefinitionDisplayData, computeDimensionDisplayData, computeDimensionDisplayName, defaultLimitPolicy, handleRateLimits, nullLimitPolicy, rewriteFiltersForApi };

package/dist/api/api.js

@@ -41,6 +41,7 @@ __export(api_exports, {
   AggregateClient: () => AggregateClient,
   ApiClient: () => ApiClient,
   ApiClientError: () => ApiClientError,
+  BearerTokenNotValidOrExpiredError: () => BearerTokenNotValidOrExpiredError,
   CachedAggregateClient: () => CachedAggregateClient,
   CachedContextClient: () => CachedContextClient,
   CachedDimensionClient: () => CachedDimensionClient,
@@ -56,6 +57,7 @@ __export(api_exports, {
   QuirkClient: () => QuirkClient,
   SignalClient: () => SignalClient,
   TestClient: () => TestClient,
+  UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE: () => UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE,
   UncachedAggregateClient: () => UncachedAggregateClient,
   UncachedContextClient: () => UncachedContextClient,
   UncachedDimensionClient: () => UncachedDimensionClient,
@@ -78,6 +80,7 @@ module.exports = __toCommonJS(api_exports);
 var import_p_limit = __toESM(require("p-limit"));
 var nullLimitPolicy = async (func) => await func();
 var defaultLimitPolicy = (0, import_p_limit.default)(6);
+var UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE = "Bearer token not valid or expired";
 var ApiClientError = class _ApiClientError extends Error {
   constructor(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId) {
     super(
@@ -93,6 +96,12 @@ var ApiClientError = class _ApiClientError extends Error {
     Object.setPrototypeOf(this, _ApiClientError.prototype);
   }
 };
+var BearerTokenNotValidOrExpiredError = class _BearerTokenNotValidOrExpiredError extends ApiClientError {
+  constructor(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId) {
+    super(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId);
+    Object.setPrototypeOf(this, _BearerTokenNotValidOrExpiredError.prototype);
+  }
+};
 
 // src/api/ApiClient.ts
 var ApiClient = class _ApiClient {
@@ -128,7 +137,7 @@ var ApiClient = class _ApiClient {
   }
   async apiClientWithResponse(fetchUri, options) {
     return this.options.limitPolicy(async () => {
-      var _a;
+      var _a, _b;
       const coreHeaders = this.options.apiKey ? {
         "x-api-key": this.options.apiKey
       } : {
@@ -164,9 +173,19 @@ var ApiClient = class _ApiClient {
         } catch (e) {
           message = `General error`;
         }
+        if (apiResponse.status === 401 && message === UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE) {
+          throw new BearerTokenNotValidOrExpiredError(
+            message,
+            (_a = options == null ? void 0 : options.method) != null ? _a : "GET",
+            fetchUri.toString(),
+            apiResponse.status,
+            apiResponse.statusText,
+            _ApiClient.getRequestId(apiResponse)
+          );
+        }
         throw new ApiClientError(
           message,
-          (_a = options == null ? void 0 : options.method) != null ? _a : "GET",
+          (_b = options == null ? void 0 : options.method) != null ? _b : "GET",
           fetchUri.toString(),
           apiResponse.status,
           apiResponse.statusText,
@@ -637,6 +656,7 @@ var CachedContextClient = class extends ContextClient {
   AggregateClient,
   ApiClient,
   ApiClientError,
+  BearerTokenNotValidOrExpiredError,
   CachedAggregateClient,
   CachedContextClient,
   CachedDimensionClient,
@@ -652,6 +672,7 @@ var CachedContextClient = class extends ContextClient {
   QuirkClient,
   SignalClient,
   TestClient,
+  UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE,
   UncachedAggregateClient,
   UncachedContextClient,
   UncachedDimensionClient,

package/dist/api/api.mjs

@@ -12,6 +12,7 @@ var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot
 import pLimit from "p-limit";
 var nullLimitPolicy = async (func) => await func();
 var defaultLimitPolicy = pLimit(6);
+var UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE = "Bearer token not valid or expired";
 var ApiClientError = class _ApiClientError extends Error {
   constructor(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId) {
     super(
@@ -27,6 +28,12 @@ var ApiClientError = class _ApiClientError extends Error {
     Object.setPrototypeOf(this, _ApiClientError.prototype);
   }
 };
+var BearerTokenNotValidOrExpiredError = class _BearerTokenNotValidOrExpiredError extends ApiClientError {
+  constructor(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId) {
+    super(errorMessage, fetchMethod, fetchUri, statusCode, statusText, requestId);
+    Object.setPrototypeOf(this, _BearerTokenNotValidOrExpiredError.prototype);
+  }
+};
 
 // src/api/ApiClient.ts
 var ApiClient = class _ApiClient {
@@ -62,7 +69,7 @@ var ApiClient = class _ApiClient {
   }
   async apiClientWithResponse(fetchUri, options) {
     return this.options.limitPolicy(async () => {
-      var _a;
+      var _a, _b;
       const coreHeaders = this.options.apiKey ? {
         "x-api-key": this.options.apiKey
       } : {
@@ -98,9 +105,19 @@ var ApiClient = class _ApiClient {
         } catch (e) {
           message = `General error`;
         }
+        if (apiResponse.status === 401 && message === UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE) {
+          throw new BearerTokenNotValidOrExpiredError(
+            message,
+            (_a = options == null ? void 0 : options.method) != null ? _a : "GET",
+            fetchUri.toString(),
+            apiResponse.status,
+            apiResponse.statusText,
+            _ApiClient.getRequestId(apiResponse)
+          );
+        }
         throw new ApiClientError(
           message,
-          (_a = options == null ? void 0 : options.method) != null ? _a : "GET",
+          (_b = options == null ? void 0 : options.method) != null ? _b : "GET",
           fetchUri.toString(),
           apiResponse.status,
           apiResponse.statusText,
@@ -570,6 +587,7 @@ export {
   AggregateClient,
   ApiClient,
   ApiClientError,
+  BearerTokenNotValidOrExpiredError,
   CachedAggregateClient,
   CachedContextClient,
   CachedDimensionClient,
@@ -585,6 +603,7 @@ export {
   QuirkClient,
   SignalClient,
   TestClient,
+  UNIFORM_BEARER_TOKEN_NOT_VALID_OR_EXPIRED_MESSAGE,
   UncachedAggregateClient,
   UncachedContextClient,
   UncachedDimensionClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "20.72.4-alpha.6+93c66ff08a",
+  "version": "20.73.1-alpha.13+1ef8c4abf6",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -70,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "93c66ff08aa52bcdf60dd38e32e6e39f6ddebab6"
+  "gitHead": "1ef8c4abf6483807fd16f7fdb684411f9a303e93"
 }