@iblai/data-layer 1.9.5 → 1.9.7

package/dist/src/features/studio-authoring/constants.d.ts

@@ -0,0 +1,39 @@
+import { SERVICES } from '../utils';
+export declare const STUDIO_AUTHORING_ENDPOINTS: {
+    CREATE_COURSE: {
+        path: (contentType: string) => string;
+        service: SERVICES;
+    };
+    DELETE_COURSE: {
+        path: () => string;
+        service: SERVICES;
+    };
+    COURSE_SETTINGS: {
+        path: (contentType: string) => string;
+        service: SERVICES;
+    };
+    CREATE_XBLOCK: {
+        path: () => string;
+        service: SERVICES;
+    };
+    UPDATE_XBLOCK: {
+        path: (locator: string) => string;
+        service: SERVICES;
+    };
+    SCORM_SUBMIT: {
+        path: (locator: string) => string;
+        service: SERVICES;
+    };
+    UPLOAD_ASSET: {
+        path: (courseKey: string) => string;
+        service: SERVICES;
+    };
+    ADVANCED_SETTINGS: {
+        path: (courseKey: string) => string;
+        service: SERVICES;
+    };
+    VIDEO_UPLOAD: {
+        path: (courseKey: string) => string;
+        service: SERVICES;
+    };
+};

package/dist/src/features/studio-authoring/types.d.ts

@@ -0,0 +1,65 @@
+/** Payload for creating a course (or library) shell in Studio. */
+export interface StudioCourseCreateRequest {
+    org: string;
+    display_name: string;
+    [key: string]: unknown;
+}
+/** Response from `POST /api/ibl/manage/{contentType}/`. */
+export interface StudioCourseCreateResponse {
+    course_key?: string;
+    library_key?: string;
+    url?: string;
+    [key: string]: unknown;
+}
+/** Full course-settings payload for `POST /api/ibl/v1/{contentType}_settings/`. */
+export interface StudioCourseSettingsRequest {
+    org: string;
+    course_key: string;
+    [key: string]: unknown;
+}
+/** Payload for creating an xblock node via `POST /xblock/`. */
+export interface StudioXblockCreateRequest {
+    parent_locator: string;
+    category: string;
+    display_name?: string;
+    [key: string]: unknown;
+}
+/** Response for xblock create/update calls. */
+export interface StudioXblockResponse {
+    locator?: string;
+    id?: string;
+    courseKey?: string;
+    [key: string]: unknown;
+}
+/** Asset object returned by the Studio assets upload endpoint. */
+export interface StudioCourseAsset {
+    display_name?: string;
+    url?: string;
+    id?: string;
+    portable_url?: string;
+    content_type?: string;
+    [key: string]: unknown;
+}
+/** Response from `POST /assets/{courseKey}/`. */
+export interface StudioAssetUploadResponse {
+    asset?: StudioCourseAsset;
+    msg?: string;
+    [key: string]: unknown;
+}
+/** Response from `POST /api/v1/ibl/course/{courseKey}/s3-upload`. */
+export interface StudioVideoUploadResponse {
+    file_url?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+/**
+ * Shape of Studio advanced settings: each key maps to `{ value: ... }`.
+ * Used both as request and response of `POST /settings/advanced/{courseKey}`.
+ */
+export interface StudioAdvancedSettings {
+    advanced_modules?: {
+        value?: string[];
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}