@overmap-ai/core 1.0.60-sdk-refactor.3 → 1.0.60-sdk-refactor.5

package/dist/sdk/base.d.ts

@@ -1,22 +1,11 @@
-import { AuthService, FileService } from "./services";
+import { FileService } from "./services";
 import { ToolkitStore } from "@reduxjs/toolkit/dist/configureStore";
 import { SDKRequest } from "./typings";
 import { BaseState } from "../typings";
 export declare abstract class BaseSDK<TState extends BaseState> {
     readonly store: ToolkitStore<TState>;
     abstract readonly files: FileService<TState, BaseSDK<TState>>;
-    abstract readonly auth: AuthService<TState, BaseSDK<TState>>;
     protected constructor(store: ToolkitStore<TState>);
-    /**
-     * Enqueues an API request to the offline outbox.
-     * @param requestDetails An SDKRequest object containing the details of the request.
-     * @param host The base URL of the API to send the request to.
-     * @protected
-     */
-    enqueueRequest<TResult>(requestDetails: SDKRequest, host: string): Promise<TResult>;
-    /**
-     * Enqueues an API request to the Redux Offline outbox
-     * @protected
-     */
+    enqueueRequest<TResult>(requestDetails: SDKRequest, host: string, serviceName: string): Promise<TResult>;
     private _enqueueRequest;
 }

package/dist/sdk/sdk.d.ts

@@ -1,4 +1,5 @@
-import { BaseSDK, OvermapSDKConstructor } from "./index";
+import { BaseSDK } from "./base";
 import { ToolkitStore } from "@reduxjs/toolkit/dist/configureStore";
 import { BaseState } from "../typings";
+import { OvermapSDKConstructor } from "./typings";
 export declare const initSDK: <TState extends BaseState, TSDK extends BaseSDK<TState>>(store: ToolkitStore<TState>, sdk: OvermapSDKConstructor<TState, TSDK>) => TSDK;

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

@@ -2,18 +2,16 @@ import { AnyAction } from "@reduxjs/toolkit";
 import type { BaseSDK } from "../base";
 import { BaseState } from "../../typings";
 import { SDKRequest } from "../typings";
+import { BaseAuthService } from "./BaseAuthService";
+export declare const CLASS_NAME_TO_SERVICE: Record<string, BaseApiService<BaseState, BaseSDK<BaseState>>>;
 /**
  * Abstract base class for building a service that can enqueue API requests
  */
 export declare abstract class BaseApiService<TStore extends BaseState, TSDK extends BaseSDK<TStore>> {
     protected readonly client: TSDK;
     abstract readonly host: string;
-    constructor(sdk: TSDK);
-    /**
-     * Enqueues an API request to the offline outbox.
-     * @param requestDetails An SDKRequest object containing the details of the request.
-     * @protected
-     */
+    readonly auth: BaseAuthService<TStore, TSDK>;
+    constructor(sdk: TSDK, auth: BaseAuthService<TStore, TSDK>);
     protected enqueueRequest<TResult>(requestDetails: SDKRequest): Promise<TResult>;
     protected dispatch(action: AnyAction): void;
 }

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

@@ -0,0 +1,16 @@
+import { AnyAction } from "@reduxjs/toolkit";
+import { Response, SuperAgentRequest } from "superagent";
+import { BaseState } from "../../typings";
+import type { BaseSDK } from "../base";
+import { SDKRequest } from "../typings";
+export declare abstract class BaseAuthService<TStore extends BaseState, TSDK extends BaseSDK<TStore>> {
+    protected readonly client: TSDK;
+    abstract readonly host: string;
+    constructor(sdk: TSDK);
+    protected enqueueRequest<TResult>(requestDetails: SDKRequest): Promise<TResult>;
+    protected dispatch(action: AnyAction): void;
+    abstract initAuth(username: string, password: string): Promise<void>;
+    abstract prepareAuth(): Promise<void>;
+    abstract getAuthHeader(): string;
+    abstract handleUnauthorized(request: SuperAgentRequest, response: Response): Promise<void>;
+}

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

@@ -1,4 +1,5 @@
-import { BaseApiService, type BaseSDK } from "../../sdk";
+import { BaseApiService } from "./BaseApiService";
+import type { BaseSDK } from "../base";
 import { EmailVerificationPayload, EmailVerificationReturn, OvermapRootState, VerificationCode } from "../../typings";
 export declare abstract class EmailVerificationService<TState extends OvermapRootState, TSDK extends BaseSDK<TState>> extends BaseApiService<TState, TSDK> {
     getVerificationCode(verificationCode: string): Promise<VerificationCode>;

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

@@ -0,0 +1,45 @@
+import request from "superagent";
+import { BaseState } from "../../typings";
+import type { BaseSDK } from "../base";
+import { TokenPair } from "../typings";
+import { BaseAuthService } from "./BaseAuthService";
+/**
+ * Handles login, logout and renewing tokens
+ */
+export declare abstract class JWTService<TState extends BaseState, TSDK extends BaseSDK<TState>> extends BaseAuthService<TState, TSDK> {
+    protected abstract initTokensUrl: string;
+    protected abstract refreshTokensUrl: string;
+    protected abstract setTokens: (tokens: TokenPair) => void;
+    protected abstract clearTokens: () => void;
+    protected abstract getAccessToken: () => string;
+    protected abstract getRefreshToken: () => string;
+    /**
+     * Takes refresh token and gets a new token pair
+     * @async
+     * @param {string} refreshToken The refresh token used to get new tokens
+     * @returns {Promise<TokenPair>} The new access and refresh tokens
+     */
+    private _getRenewedTokens;
+    /**
+     * Logs the user out
+     */
+    clearAuth(): Promise<void>;
+    /**
+     * Attempts to renew tokens
+     */
+    renewTokens(): Promise<undefined>;
+    /**
+     * Checks whether the tokens will be expiring soon
+     * @returns {boolean}
+     */
+    tokenIsExpiringSoon(): boolean;
+    getAuthHeader(): string;
+    prepareAuth(): Promise<undefined>;
+    handleUnauthorized(request: request.SuperAgentRequest, response: request.Response): Promise<void>;
+    /**
+     * Attempts to log into Hemora using given credentials
+     * @param {string} username
+     * @param {string} password
+     */
+    initAuth(username: string, password: string): Promise<undefined>;
+}

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

@@ -1,4 +1,4 @@
-export * from "./AuthService";
+export * from "./JWTAuthService";
 export * from "./BaseApiService";
 export * from "./CategoryService";
 export * from "./AssetService";

package/dist/sdk/typings.d.ts

@@ -111,4 +111,5 @@ export interface OfflineMetaEffect {
     /** An ISO timestamp of when the request was created. */
     timestamp: string;
     BASE_URL: string;
+    serviceName: string;
 }

package/dist/store/slices/index.d.ts

@@ -34,3 +34,4 @@ export * from "./agentsSlice";
 export * from "./issueCommentSlice";
 export * from "./issueUpdateSlice";
 export * from "./issueAttachmentSlice";
+export * from "./versioningSlice";

package/dist/store/slices/outboxSlice.d.ts

@@ -3,7 +3,7 @@ import type { FullOfflineAction } from "../store";
 import type { RequestDetails } from "../../sdk";
 import { SDKRequest } from "../../sdk";
 import { OvermapRootState } from "../../typings";
-export declare const createOfflineAction: (request: SDKRequest, baseUrl: string) => FullOfflineAction;
+export declare const createOfflineAction: (request: SDKRequest, baseUrl: string, serviceName: string) => FullOfflineAction;
 export interface OutboxState {
     /** A list of requests marked for deletion. Once the offline slice encounters one of these, */
     deletedRequests: string[];
@@ -21,6 +21,7 @@ export declare const outboxSlice: import("@reduxjs/toolkit").Slice<OutboxState,
         reducer: (state: import("immer/dist/internal.js").WritableDraft<OutboxState>, _action: PayloadAction<RequestDetails>) => import("immer/dist/internal.js").WritableDraft<OutboxState>;
         prepare: (payload: SDKRequest & {
             BASE_URL: string;
+            serviceName: string;
         }) => FullOfflineAction;
     };
     markForDeletion(state: import("immer/dist/internal.js").WritableDraft<OutboxState>, action: PayloadAction<string>): void;
@@ -33,6 +34,7 @@ export declare const enqueueRequest: import("@reduxjs/toolkit").ActionCreatorWit
     uuid?: string | undefined;
 } & {
     BASE_URL: string;
+    serviceName: string;
 }], RequestDetails, "outbox/enqueueRequest", never, {
     offline: import("../store").FullOfflineMetadata;
 }>, markForDeletion: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "outbox/markForDeletion">, markAsDeleted: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "outbox/markAsDeleted">, _setLatestRetryTime: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "outbox/_setLatestRetryTime">;

package/dist/store/store.d.ts

@@ -2,9 +2,8 @@
 import { Reducer } from "redux";
 import { Config, OfflineAction, OfflineMetadata } from "@redux-offline/redux-offline/lib/types";
 import request from "superagent";
-import { type OfflineMetaEffect, OutboxCoordinator, type BaseSDK, RequestDetails } from "../sdk";
-import { AgentsState, AuthState, CategoryState, AssetStageCompletionState, AssetStageState, AssetState, AssetTypeState, DocumentState, EmailDomainState, FileState, FormRevisionState, FormState, FormSubmissionState, IssueState, IssueTypeState, LicenseState, OrganizationAccessState, OrganizationState, OutboxState, ProjectAccessState, ProjectFileState, ProjectState, RehydratedState, SettingState, UserState, WorkspaceState, TeamState, IssueCommentState, IssueUpdateState, AssetAttachmentState, AssetTypeAttachmentState, DocumentAttachmentState, IssueAttachmentState, ProjectAttachmentState, FormSubmissionAttachmentState, FormRevisionAttachmentState } from "./slices";
-import { VersioningState } from "./slices/versioningSlice";
+import { type BaseSDK, type OfflineMetaEffect, OutboxCoordinator, RequestDetails } from "../sdk";
+import { AgentsState, AssetAttachmentState, AssetStageCompletionState, AssetStageState, AssetState, AssetTypeAttachmentState, AssetTypeState, AuthState, CategoryState, DocumentAttachmentState, DocumentState, EmailDomainState, FileState, FormRevisionAttachmentState, FormRevisionState, FormState, FormSubmissionAttachmentState, FormSubmissionState, IssueAttachmentState, IssueCommentState, IssueState, IssueTypeState, IssueUpdateState, LicenseState, OrganizationAccessState, OrganizationState, OutboxState, ProjectAccessState, ProjectAttachmentState, ProjectFileState, ProjectState, RehydratedState, SettingState, TeamState, UserState, VersioningState, WorkspaceState } from "./slices";
 import { BaseState, OvermapRootState } from "../typings";
 export declare const VERSION_REDUCER_KEY = "versioning";
 export declare const overmapReducers: {

package/package.json

@@ -3,7 +3,7 @@
 	"description": "Core functionality for Overmap",
 	"author": "Wôrdn Inc.",
 	"license": "UNLICENSED",
-	"version": "1.0.60-sdk-refactor.3",
+	"version": "1.0.60-sdk-refactor.5",
 	"type": "module",
 	"main": "dist/overmap-core.umd.cjs",
 	"module": "dist/overmap-core.js",

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

@@ -1,54 +0,0 @@
-import { BaseApiService } from "./BaseApiService";
-import { BaseState, RegistrationPayload, RegistrationReturn } from "../../typings";
-import type { BaseSDK } from "../base";
-/**
- * Handles login, logout and renewing tokens
- */
-export declare abstract class AuthService<TState extends BaseState, TSDK extends BaseSDK<TState>> extends BaseApiService<TState, TSDK> {
-    private _getAccessToken;
-    private _getRefreshToken;
-    /**
-     * Takes credentials and gets a token pair
-     * @async
-     * @param credentials The username and password for obtaining a token pair
-     * @param logoutOnFailure Whether to log out if the request fails
-     * @returns An array containing two elements: 1) a Promise for the access and refresh tokens, and 2) the UUID of the
-     * request, so the request can be cancelled if necessary.
-     */
-    private _getTokenPair;
-    /**
-     * Takes refresh token and gets a new token pair
-     * @async
-     * @param {string} refreshToken The refresh token used to get new tokens
-     * @returns {Promise<TokenPair>} The new access and refresh tokens
-     */
-    private _getRenewedTokens;
-    /**
-     * Attempts to log into Hemora using given credentials
-     * @param {string} username
-     * @param {string} password
-     */
-    login(username: string, password: string): Promise<undefined>;
-    /**
-     * Logs the user out
-     */
-    logout(): Promise<void>;
-    /**
-     * Attempts to renew tokens
-     */
-    renewTokens(): Promise<undefined>;
-    /**
-     * Register a new user
-     */
-    register(payload: RegistrationPayload): Promise<RegistrationReturn>;
-    resetPassword(email: string): Promise<undefined>;
-    /**
-     * Checks whether the tokens will be expiring soon
-     * @returns {boolean}
-     */
-    tokenIsExpiringSoon(): boolean;
-    replaceProfilePicture(file: File): Promise<undefined>;
-    addFavouriteProjectId(projectId: number): Promise<undefined>;
-    removeFavouriteProjectId(projectId: number): Promise<undefined>;
-    joinApplication(projectInviteId: string, verification_code: string, username: string, password: string): Promise<undefined>;
-}