@iblai/data-layer 1.34.0 → 1.35.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/data-layer",
-  "version": "1.33.1",
+  "version": "1.34.0",
   "description": "ibl.ai data layer",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",

package/dist/src/config.d.ts

@@ -6,6 +6,14 @@ export default class Config {
     static mentorIframeUrl: string;
     static studioUrl: string;
     static httpErrorHandlers: {};
+    /**
+     * Route `SERVICES.LMS` / `SERVICES.STUDIO` through DM's edX proxy
+     * (`{dmUrl}/v1/lms`, `{dmUrl}/v1/studio`) with the DM token instead of
+     * calling the edX hosts with the edX JWT. Needs DM 4.444.0+ with its proxy
+     * rules synced, so it is off by default and turned on per deployment via
+     * `initializeDataLayer(..., { edxProxy: true })`.
+     */
+    static edxProxyEnabled: boolean;
     /**
      * Optional override for how expired auth tokens are re-minted after a 401.
      * Resolve `true` once fresh tokens are in storage. Left unset, the data

package/dist/src/constants.d.ts

@@ -25,10 +25,26 @@ export declare const TENANT_IDENTIFIERS: {
 };
 export declare enum SERVICES {
     LEGACY_LMS = "LEGACY_LMS",
+    /**
+     * The Open edX LMS. With `Config.edxProxyEnabled` the call goes through DM's
+     * `/v1/lms/{edx_path}` proxy with the DM token (DM mints the edX JWT
+     * server-side); otherwise it goes to the LMS host with the edX JWT. The
+     * proxy admits stock edX paths only: the `/api/ibl/...` family is refused,
+     * and any course or org a path names must belong to the token's platform.
+     */
     LMS = "LMS",
     DM = "DM",
     AXD = "AXD",
-    STUDIO = "STUDIO"
+    /** Open edX Studio (CMS); proxied through `/v1/studio/{edx_path}` like `LMS`. */
+    STUDIO = "STUDIO",
+    /**
+     * The LMS host with the edX JWT, whatever `Config.edxProxyEnabled` says. Only
+     * for calls the proxy cannot serve: the login/token bootstrap and the
+     * `/api/ibl/...` paths DM has no replacement for yet.
+     */
+    LMS_DIRECT = "LMS_DIRECT",
+    /** The Studio host with its session cookie, CSRF token and edX JWT; see `LMS_DIRECT`. */
+    STUDIO_DIRECT = "STUDIO_DIRECT"
 }
 /**
  * Client errors a retry cannot fix.

package/dist/src/features/course-metadata/__tests__/api-slice.test.d.ts

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