@overmap-ai/core 1.1.0 → 1.1.1-allauth-2.2

package/dist/sdk/errors.d.ts

@@ -3,6 +3,12 @@ export interface APIErrorOptions {
     response?: request.Response;
     innerError?: unknown;
     message?: string;
+    /**
+     * Whether to drop the request rather than retry it. Three-valued on purpose:
+     * `true` discards, `false` insists on a retry even when the status code says otherwise, and leaving it unset lets
+     * `discard()` in store.ts decide from the status code. Do not default it -- collapsing unset into `false` is what
+     * makes "the auth service says retry this" indistinguishable from "nobody expressed an opinion".
+     */
     discard?: boolean;
 }
 export declare const UNKNOWN_ERROR_MESSAGE = "An unknown error occurred";

package/dist/sdk/services/BaseAuthService.d.ts

@@ -9,4 +9,28 @@ export declare abstract class BaseAuthService<TStore extends BaseState, TSDK ext
     abstract prepareAuth(): Promise<void>;
     abstract getAuthHeader(): string;
     abstract handleUnauthorized(request: SuperAgentRequest, response: Response): Promise<void>;
+    /**
+     * Attaches this service's credentials to an outgoing request, and is the only place `performRequest` authenticates.
+     *
+     * A bearer token is a header and nothing else, so the default implementation just sets `Authorization` from
+     * `getAuthHeader()`. A cookie-based scheme has no header to return: it needs `withCredentials()` on the request
+     * itself, which a `getAuthHeader()` return value cannot express. Overriding this is how such a service reaches the
+     * request at all.
+     *
+     * NOTE: The empty-header guard is not just tidiness. Sending `Authorization:` with an empty value still counts as a
+     *  non-simple header, so the browser would preflight every request to carry nothing.
+     * @param request The request about to be sent.
+     * @returns The request, with credentials attached.
+     */
+    applyAuth(request: SuperAgentRequest): SuperAgentRequest;
+    /**
+     * Whether `response` means "you are not authenticated", as opposed to any other failure.
+     *
+     * Only responses this returns true for are routed to `handleUnauthorized`. A bearer token can only ever fail with a
+     * 401, but a session-based service also has to recognise the 403 that Django's CSRF check produces, which is
+     * otherwise indistinguishable from a genuine permission denial.
+     * @param response The failing response.
+     * @returns Whether the request failed because it was not authenticated.
+     */
+    isAuthFailure(response: Response): boolean;
 }

package/dist/sdk/services/BaseAuthService.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/sdk/services/index.d.ts

@@ -12,6 +12,7 @@ export * from './AssetTypeIdentifierValueService';
 export * from './AssetTypeService';
 export * from './AssetTypeStatusService';
 export * from './BaseApiService';
+export * from './BaseAuthService';
 export * from './DocumentAttachmentService';
 export * from './DocumentService';
 export * from './EmailDomainsService';

package/dist/store/discard.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@overmap-ai/core",
-	"version": "1.1.0",
+	"version": "1.1.1-allauth-2.2",
 	"description": "Core functionality for Overmap",
 	"keywords": [
 		"components",