Merge pull request #64 from C4IROcean/other/3887_decouple_JS_SDK_from_CDF

Other/3887 decouple js sdk from cdf

Author: nikolai-ri

CHANGELOG.md

@@ -1,4 +1,8 @@
-## 0.2.9 (2022-02-15)
+## 0.3.0 (2022-09-19)
+
+- Remove dependency on CDF JS SDK
+
+## 0.2.9 (2022-09-15)
 
 - Deprecate and remove old and unused casts and marine regions functionalities
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "odp-sdk",
-  "version": "0.2.9",
+  "version": "0.3.0",
   "description": "Ocean Data Platform JavaScript SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,7 +29,6 @@
   "license": "ISC",
   "dependencies": {
     "@azure/msal-browser": "^2.24.0",
-    "@cognite/sdk": "^7.3.4",
     "loglevel": "^1.8.0",
     "eslint-plugin-unicorn": "^43.0.2"
   },

source/ODPClient.ts

@@ -1,61 +1,26 @@
 import { AuthenticationResult, BrowserAuthOptions } from "@azure/msal-browser"
-import { ClientOptions, CogniteClient } from "@cognite/sdk"
 import log from "loglevel"
 import { Auth } from "./auth"
 import Catalog from "./Catalog/Catalog"
-import { IDataLayer, IDataLayerMain, IDataProduct, IDataProductResult, IIdTokenClaims } from "./types"
-
-// This client id only allows for certain auth_redirects, ideally you'll have a client id per app.
-// Contact us if this is your use case.
-const ODP_SDK_CLIENT_ID = "b2a2d339-e785-4213-a773-8b289abd2199" // B2C app reg: ODP SDKs
-
-type RequiredConfig = Pick<ClientOptions, "appId">
-type OptionalConfig = Partial<Omit<ClientOptions, keyof RequiredConfig | "baseUrl">> &
-  Partial<{
-    baseUrl: "https://api.cognitedata.com" | "https://westeurope-1.cognitedata.com"
-    logLevel: log.LogLevelDesc
-  }>
-
-interface IAuthTokens {
-  accessToken: string
-  idToken: string
-  idTokenClaims: IIdTokenClaims
-  authority: string
-  scopes: string[]
+import { IAuthTokens, IDataLayer, IDataLayerMain, IDataProduct, IDataProductResult, IIdTokenClaims } from "./types"
+
+type OdpClientConfig = {
+  logLevel: log.LogLevelDesc
 }
 
 type AuthListenersT = (token?: IAuthTokens) => void
 
-const defaultOptions: { project: string; apiKeyMode: boolean; baseUrl: string } = {
-  project: "odp",
-  apiKeyMode: false,
-  baseUrl: "https://api.cognitedata.com",
-}
-
-export default class ODPClient extends CogniteClient {
+export default class ODPClient {
   private authResult: AuthenticationResult | undefined
   private listeners: AuthListenersT[] = []
 
   private auth: Auth
   private _catalog: Catalog
 
-  public constructor(options: RequiredConfig & OptionalConfig, authConfig: BrowserAuthOptions) {
-    super({
-      ...defaultOptions,
-      getToken: async () => {
-        const token = await this.auth.handleRedirectAuth()
-        if (!token) throw new Error("Could not retrieve token.")
-        if (this.authResult?.uniqueId !== token?.uniqueId) {
-          this.authStateUpdated(token)
-        }
-        return token.accessToken
-      },
-      ...options,
-    })
-
+  public constructor(options: OdpClientConfig, authConfig: BrowserAuthOptions) {
     log.setLevel(options.logLevel ?? log.levels.SILENT)
 
-    this.auth = new Auth(options.baseUrl || defaultOptions.baseUrl, {
+    this.auth = new Auth({
       redirectUri: "http://localhost:3000/", // This should be overwritten!
       knownAuthorities: ["oceandataplatform.b2clogin.com"],
       authority:
@@ -84,6 +49,14 @@ export default class ODPClient extends CogniteClient {
     }
   }
 
+  public async authenticate() {
+    if (!this.authResult) {
+      this.authResult = await this.auth.handleRedirectAuth()
+      return this.authTokens
+    }
+    return this.authTokens
+  }
+
   public unauthorizeUser() {
     return this.auth.logout()
   }

source/auth.ts

@@ -47,12 +47,9 @@ export type AuthResponseT = AuthenticatedResponseT | UnauthenticatedResponseT
  * Auth class
  */
 export class Auth {
-  private audience: string
   private _msalInstance: PublicClientApplication
 
-  public constructor(audience: string, authConfig: BrowserAuthOptions) {
-    this.audience = audience
-
+  public constructor(authConfig: BrowserAuthOptions) {
     this._msalInstance = new PublicClientApplication({
       auth: authConfig,
       cache: {
@@ -117,13 +114,7 @@ export class Auth {
 
     const accessTokenRequest = {
       account,
-      scopes: [
-        "openid",
-        "profile",
-        "email",
-        // "offline_access",
-        `${this.audience}/user_impersonation`,
-      ],
+      scopes: ["openid", "profile", "email"],
     }
 
     const loginWithRedirect = () => {

source/types.ts

@@ -22,6 +22,13 @@ export interface IIdTokenClaims {
   upn: string
   ver: string
 }
+export interface IAuthTokens {
+  accessToken: string
+  idToken: string
+  idTokenClaims: IIdTokenClaims
+  authority: string
+  scopes: string[]
+}
 
 // types used in app-odp
 export enum DataSources {