ngx-rendering-service-lib 0.0.66980 → 0.0.66981

package/package.json

@@ -1,10 +1,6 @@
 {
   "name": "ngx-rendering-service-lib",
-  "version": "0.0.66980",
-  "scripts": {
-    "publish": "npm run build && cd dist && npm publish",
-    "build": "ng build && ng run rendering-service-lib:build-pdf-web-component"
-  },
+  "version": "0.0.66981",
   "private": false,
   "dependencies": {
     "tslib": "^2.3.0"
@@ -26,19 +22,16 @@
     "ngx-edu-sharing-ui": "~10.0.28",
     "ngx-extended-pdf-viewer": "^23.2.0"
   },
-  "devDependencies": {
-    "@angular-devkit/build-angular": ">=19.0.0",
-    "@angular/cli": ">=19.0.0",
-    "@angular/compiler-cli": ">=19.0.0",
-    "@types/jasmine": "~5.1.0",
-    "jasmine-core": "~5.1.0",
-    "karma": "~6.4.0",
-    "karma-chrome-launcher": "~3.2.0",
-    "karma-coverage": "~2.2.0",
-    "karma-jasmine": "~5.1.0",
-    "karma-jasmine-html-reporter": "~2.1.0",
-    "@angular/youtube-player": "^18.0.3",
-    "ng-packagr": ">=19.0.0",
-    "typescript": ">=5.5.0"
-  }
-}
+  "module": "fesm2022/ngx-rendering-service-lib.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/ngx-rendering-service-lib.mjs"
+    }
+  },
+  "sideEffects": false
+}

package/.eslintrc.json

@@ -1,21 +0,0 @@
-{
-  "extends": "../../.eslintrc.json",
-  "ignorePatterns": [
-    "dist/**",
-    "src/environments/**"
-  ],
-  "overrides": [
-    {
-      "files": [
-        "src/**/*.ts"
-      ],
-      "parserOptions": {
-        "project": [
-          "projects/rendering-service-lib/tsconfig.lib.json",
-          "projects/rendering-service-lib/tsconfig.spec.json"
-        ],
-        "createDefaultProgram": true
-      }
-    }
-  ]
-}

package/dist/assets/edu-service-worker.js

@@ -1,199 +0,0 @@
-const SESSION_HEADER_NAME = "Authentication-Info"
-const RENDER_DATA_PATH = "public/renderdata"
-const JOB_INFO_PATH = "public/job"
-const H5P_PATH = "public/h5p"
-const ASSET_PATH = "public/asset"
-const TRACKING_PATH = "public/tracking"
-const DB_NAME = "Edu-Sharing-Rendering"
-const DB_STORE = "SessionIds"
-/** @type {IDBDatabase} */
-let eduServiceWorkerDb
-
-self.addEventListener('install', async function (event) {
-  // Skip the 'waiting' lifecycle phase, to go directly from 'installed' to 'activated', even if
-  // there are still previous incarnations of this service worker registration active.
-  console.info('install')
-  event.waitUntil(self.skipWaiting())
-});
-
-self.addEventListener('activate', async function (event) {
-  console.info('activate')
-  clients.claim()
-});
-
-self.addEventListener('controllerchange', () => {
-  console.info('New service worker activated. Please reload the page.');
-});
-
-self.addEventListener('message', (event) => {
-  if (event.data && event.data.type === 'SKIP_WAITING') {
-    self.skipWaiting()
-  }
-});
-
-self.addEventListener('fetch', (event) => {
-  const request = event.request
-  const url = request.url
-  if (url.includes(RENDER_DATA_PATH)) {
-    event.respondWith(handleRenderDataRequest(request))
-  } else if (url.includes(JOB_INFO_PATH) || url.includes(H5P_PATH) || url.includes(ASSET_PATH) || url.includes(TRACKING_PATH)) {
-    event.respondWith(handleSessionRequest(request))
-  } else {
-    event.respondWith(handleStandardRequest(request))
-  }
-});
-
-/**
- * Function handleSessionRequest
- *
- * @param {Request} request
- * @returns {Promise<Response>}
- */
-const handleSessionRequest = async (request) => {
-  await getDb().catch(error => {
-    console.error(error)
-    return handleStandardRequest(request)
-  })
-  const sessionId = await retrieveSessionIdFromDb()
-  if (sessionId === "") {
-    return handleStandardRequest(request)
-  }
-  const modifiedHeaders = new Headers(request.headers)
-  modifiedHeaders.set(SESSION_HEADER_NAME, sessionId)
-  const modifiedRequest = new Request(request, {
-    method: request.method,
-    mode: 'cors',
-    credentials: 'include',
-    headers: modifiedHeaders,
-    body: request.method !== 'GET' && request.method !== 'HEAD' ? await request.clone().blob() : undefined,
-  });
-  return await fetch(modifiedRequest)
-}
-
-/**
- * Function handleRenderDataRequest
- *
- * @param {Request} request
- * @returns {Promise<Response>}
- */
-const handleRenderDataRequest = async (request) => {
-  await getDb().catch(error => {
-    console.error(error)
-    return handleStandardRequest(request)
-  })
-  const existingSessionId = await retrieveSessionIdFromDb()
-  const modifiedHeaders = new Headers(request.headers)
-  if (existingSessionId !== "") {
-    modifiedHeaders.set(SESSION_HEADER_NAME, existingSessionId)
-  }
-  const modifiedRequest = new Request(request, {
-    mode: 'cors', credentials: 'include', headers: modifiedHeaders,
-  });
-  const response = await fetch(modifiedRequest)
-  const newSessionId = response.headers.get(SESSION_HEADER_NAME)
-  if (newSessionId !== null && newSessionId !== "" && newSessionId !== existingSessionId) {
-    await storeSessionIdToDb(newSessionId)
-  }
-  return response
-}
-
-/**
- * Function handleStandardRequest
- *
- * @param {Request} request
- * @returns {Promise<Response>}
- */
-const handleStandardRequest = async (request) => {
-  return await fetch(request)
-}
-
-/**
- * Function getDb
- *
- * @returns {Promise<String>}
- */
-const getDb = () => {
-  return new Promise((resolve, reject) => {
-    if (eduServiceWorkerDb !== undefined) {
-      resolve("success")
-    }
-    if (!indexedDB) {
-      reject(new Error("IndexedDB is not supported by current browser. Header auth with Edu-Sharing Rendering Service is not available"))
-    }
-    const request = indexedDB.open(DB_NAME, 1)
-    request.error = (event) => {
-      console.error(event)
-      reject(new Error("Error opening indexedDB"))
-    }
-    request.onupgradeneeded = () => {
-      const newDb = request.result
-      newDb.createObjectStore(DB_STORE, {keyPath: "id"})
-    }
-    request.onsuccess = () => {
-      eduServiceWorkerDb = request.result
-      resolve("success")
-    }
-  })
-}
-
-/**
- * Function storeSessionIdToDb
- *
- * @param {string} sessionId
- */
-const storeSessionIdToDb = (sessionId) => {
-  return new Promise((resolve, reject) => {
-    const transaction = eduServiceWorkerDb.transaction(DB_STORE, "readwrite")
-    const store = transaction.objectStore(DB_STORE)
-    store.put({id: 1, sessionId: sessionId})
-    transaction.oncomplete = () => {
-      resolve("Indexed DB transaction completed")
-    }
-    transaction.onerror = (event) => {
-      console.error("DB transaction failed. Cannot store session id.")
-      console.error(event)
-      reject(new Error("Transaction failed"))
-    }
-    transaction.onabort = (ev) => {
-      console.error("DB transaction aborted. Cannot store session id.")
-      console.error(ev)
-      reject(new Error("Transaction aborted"))
-    }
-  })
-}
-
-/**
- * Function retrieveSessionIdFromDb
- *
- * Gets the stored session id from the database. Returns a promise resolving to the result on success
- * and to an empty string on failure
- *
- * @return {Promise<String>}
- */
-const retrieveSessionIdFromDb = () => {
-  return new Promise((resolve, reject) => {
-    let result = ""
-    const transaction = eduServiceWorkerDb.transaction(DB_STORE, "readonly")
-    const store = transaction.objectStore(DB_STORE)
-    const idQuery = store.get(1)
-    idQuery.onsuccess = () => {
-      result = idQuery.result !== undefined ? idQuery.result.sessionId : ""
-    }
-    idQuery.onerror = () => {
-      console.error("Query by id failed")
-    }
-    transaction.oncomplete = () => {
-      resolve(result)
-    }
-    transaction.onerror = (event) => {
-      console.error("DB transaction failed. Cannot retrieve session id.")
-      console.error(event)
-      reject(new Error("Transaction failed"))
-    }
-    transaction.onabort = (ev) => {
-      console.error("DB transaction aborted. Cannot retrieve session id.")
-      console.error(ev)
-      reject(new Error("Transaction aborted"))
-    }
-  })
-}

package/ng-package.json

@@ -1,14 +0,0 @@
-{
-  "$schema": "node_modules/ng-packagr/ng-package.schema.json",
-  "lib": {
-    "entryFile": "src/index.ts"
-  },
-  "assets": [
-    "assets/**",
-    {
-      "glob": "**/*",
-      "input": "node_modules/ng2-pdfjs-viewer/pdfjs",
-      "output": "/assets/pdfjs"
-    }
-  ]
-}

package/src/environments/environment.prod.ts

@@ -1,5 +0,0 @@
-export const environment = {
-    production: true,
-    rootUrl: '/',
-    esRootUrl: 'http://repository.127.0.0.1.nip.io:8100/edu-sharing/rest',
-};

package/src/environments/environment.ts

@@ -1,5 +0,0 @@
-export const environment = {
-    production: false,
-    rootUrl: 'http://localhost:8080',
-    esRootUrl: 'http://repository.127.0.0.1.nip.io:8100/edu-sharing/rest',
-};

package/src/gdpr.service.ts

@@ -1,44 +0,0 @@
-import {Injectable} from '@angular/core';
-import {ConfigService, Node} from 'ngx-edu-sharing-api';
-import {GdprConfig} from './lib/dto/GdprConfig';
-
-@Injectable({providedIn: 'root'})
-export class GdprService {
-  constructor(private configService: ConfigService) {}
-
-  async getGdprConfig(node: Node): Promise<GdprConfig | null> {
-    const result = await this.configService.get('gdpr');
-    if (typeof result !== 'object') {
-      return null;
-    }
-    const gdprConfig = result as any;
-    if (!gdprConfig.enabled || ! Array.isArray(gdprConfig.entry)) {
-      return null;
-    }
-    let url = ''
-    if (node.properties) {
-      url = node.properties['ccm:wwwurl']?.[0] || ''
-    }
-    if (! url) {
-      return null
-    }
-    for (const entry of gdprConfig.entry) {
-      if (!(entry.regex && entry.name && entry.ref)) {
-        continue;
-      }
-      try {
-        const regex = new RegExp(entry.regex);
-        if(regex.test(url)) {
-          return {
-            pattern: entry.regex,
-            name: entry.name,
-            ref: entry.ref,
-          }
-        }
-      } catch (e) {
-        console.warn('Invalid regex pattern:', entry.regex, e);
-      }
-    }
-    return null;
-  }
-}

package/src/index.ts

@@ -1,18 +0,0 @@
-/*
- * Public API Surface of edu-sharing-ui
- */
-
-export * from './lib/rendering.module';
-export * from './lib/module/image/image.component';
-export * from './lib/module/video/video.component';
-export * from './lib/module/pdf/pdf.component';
-export * from './lib/module/pdf-iframe/pdf-iframe.component';
-export * from './lib/module/url/url.component';
-export * from './lib/module/eduhtml/eduHtml.component';
-export * from './lib/render.component';
-export * from './lib/generic/revoked/revoked.component';
-export * from './lib/services/abstract/dialogs.service';
-export * from './lib/asset-link.pipe';
-export * from './module-info.service';
-export * from './rendering-service-lib.module';
-export * from './gdpr.service';

package/src/lib/asset-link.pipe.ts

@@ -1,27 +0,0 @@
-import {Injector, Pipe, PipeTransform} from '@angular/core';
-import {RSApiConfiguration} from 'ngx-rendering-service-api';
-
-/**
- * this pipe transforms any reported asset data uri from the rendering to the uri that is currently configured for the backend
- * this is required in case the rendering service is behind a proxy, i.e. in dev mode
- */
-@Pipe({
-    name: 'rsAssetLink',
-    standalone: false
-})
-export class AssetLinkPipe implements PipeTransform {
-  constructor(
-    private injector: Injector,
-  ) {
-  }
-
-  transform(value: string | undefined) {
-    if(value) {
-      const str = value.split('/public');
-      str[0] = this.injector.get(RSApiConfiguration).rootUrl;
-      return str.join('/public');
-    }
-    return value;
-  }
-
-}

package/src/lib/dto/FrontendModuleConfig.ts

@@ -1,24 +0,0 @@
-
-export type FrontendModuleConfig = {
-  module: string,
-  urlModuleConfig: UrlModuleConfig | null
-}
-
-export type UrlModuleConfig = {
-  embedding: UrlEmbeddings,
-  externalId: string
-}
-
-export enum UrlEmbeddings {
-  YOUTUBE,
-  VIMEO,
-  VIDEO,
-  AUDIO,
-  IMAGE,
-  LTI13TOOL,
-  H5P,
-  PREZI,
-  LEARNINGAPPS,
-  LINK,
-  SODIX
-}

package/src/lib/dto/GdprConfig.ts

@@ -1,6 +0,0 @@
-
-export type GdprConfig = {
-  pattern: string,
-  name: string,
-  ref: string
-}

package/src/lib/dto/ModuleInfo.ts

@@ -1,6 +0,0 @@
-import {UrlEmbeddings} from './FrontendModuleConfig';
-
-export type ModuleInfo = {
-  module: string,
-  urlType: UrlEmbeddings | null
-}

package/src/lib/dto/RenderData.ts

@@ -1,20 +0,0 @@
-import {FrontendModuleConfig} from './FrontendModuleConfig';
-
-export type RenderData = {
-  items?: Array<AssetStateItem>,
-  module: string,
-  frontendModuleConfig?: FrontendModuleConfig,
-  publicErrorMessage?: string
-}
-
-export type AssetStateItem = {
-  link: string
-  progress: number
-  height: number
-  width: number
-  publicErrorMessage?: string
-  status: 'QUEUED' | 'PROCESSING' | 'FINISHED' | 'FAILED'
-  additionalData?: {
-    [key: string]: string
-  }
-}

package/src/lib/generic/revoked/revoked.component.html

@@ -1,24 +0,0 @@
-<div class="revoked">
-  <!--<h1 class="mat-heading-1">{{ node!! | nodeTitle }}</h1>-->
-  <es-info-message mode="warning" class="details-message">{{
-    'RENDERING.REVOKED.DETAILS' + (node?.size === '0' ? '_EMPTY' : '') | translate
-  }}</es-info-message>
-  <div class="details">
-    <div class="date">
-      <label for="revoked-date">{{ 'RENDERING.REVOKED.DATE' | translate }}:</label
-      ><span
-        id="revoked-date"
-        >{{ node?.properties?.['ccm:revoked_date_LONG']?.[0]!! | formatDate:{relative: false, time: false} }}</span
-      >
-    </div>
-    <div class="reason">
-      <label for="revoked-reason">{{ 'RENDERING.REVOKED.REASON' | translate }}:</label
-      ><span id="revoked-reason">{{ node?.properties?.['ccm:revoked_reason']?.join('') }}</span>
-    </div>
-  </div>
-  <div class="actions">
-    <button mat-button color="primary" (click)="reportRevokeFeedback()" *ngIf="dialogsService">
-      <i esIcon="arrow_forward"></i>{{ 'RENDERING.REVOKED.FEEDBACK' | translate }}
-    </button>
-  </div>
-</div>

package/src/lib/generic/revoked/revoked.component.scss

@@ -1,44 +0,0 @@
-@use 'ngx-edu-sharing-ui/assets/scss/variables' as vars;
-
-:host ::ng-deep {
-    .revoked es-info-message {
-        .message-container {
-            white-space: pre-line;
-        }
-    }
-}
-.revoked {
-    max-width: 700px;
-    margin: auto;
-    padding: 30px 20px;
-    > * {
-        text-align: center;
-        justify-content: center;
-        color: vars.$textMain;
-    }
-    .details-message {
-        display: flex;
-        margin-bottom: 30px;
-    }
-    .details {
-        display: flex;
-        flex-direction: column;
-        gap: 10px;
-        label {
-            font-size: vars.$fontSizeSmall;
-            color: vars.$textLight;
-        }
-        .reason {
-            > span {
-                white-space: pre-line;
-            }
-        }
-        > div {
-            display: flex;
-            flex-direction: column;
-        }
-    }
-    .actions {
-        padding-top: 30px;
-    }
-}

package/src/lib/generic/revoked/revoked.component.ts

@@ -1,32 +0,0 @@
-import {Component, Input, Optional} from '@angular/core';
-import { Node } from 'ngx-edu-sharing-api';
-import {DialogsService} from '../../services/abstract/dialogs.service';
-import {EduSharingUiCommonModule, InfoMessageComponent} from 'ngx-edu-sharing-ui';
-import {TranslateModule} from '@ngx-translate/core';
-import {CommonModule} from '@angular/common';
-import {MatButton, MatButtonModule} from '@angular/material/button';
-
-@Component({
-  selector: 'rs-revoked',
-  templateUrl: './revoked.component.html',
-  styleUrls: ['./revoked.component.scss'],
-  standalone: true,
-  imports: [
-    CommonModule,
-    MatButtonModule,
-    InfoMessageComponent,
-    EduSharingUiCommonModule,
-    TranslateModule,
-  ],
-})
-export class RevokedComponent {
-  @Input() node: Node | undefined;
-  constructor(@Optional() public dialogsService: DialogsService) {}
-  reportRevokeFeedback() {
-    void this.dialogsService.openNodeReportDialog({
-      node: this.node!!,
-      mode: 'REVOKE_FEEDBACK',
-      showOptions: false,
-    });
-  }
-}

package/src/lib/module/RenderModule.ts

@@ -1,7 +0,0 @@
-import {RenderDataResponse} from 'ngx-rendering-service-api';
-import {Node} from 'ngx-edu-sharing-api';
-import {RenderData} from '../dto/RenderData';
-export interface RenderModule {
-  data: RenderData | undefined;
-  node: Node | undefined;
-}

package/src/lib/module/audio/audio.component.html

@@ -1,11 +0,0 @@
-<div class="audio-wrapper" *ngIf="activeObject()">
-  <video
-    [poster]="previewUrl"
-    controls
-    (play)="onVideoPlay()"
-  >
-    <source [src]="activeObject()?.link | rsAssetLink" />
-  </video>
-</div>
-
-

package/src/lib/module/audio/audio.component.scss

@@ -1,11 +0,0 @@
-.audio-wrapper {
-  width: 100%;
-  position: relative;
-
-  video {
-    width: 100%;
-    display: block;
-    object-fit: cover;
-    aspect-ratio: 8/3;
-  }
-}

package/src/lib/module/audio/audio.component.spec.ts

@@ -1,23 +0,0 @@
-import { ComponentFixture, TestBed } from '@angular/core/testing';
-
-import { AudioComponent } from './audio.component';
-
-describe('AudioComponent', () => {
-  let component: AudioComponent;
-  let fixture: ComponentFixture<AudioComponent>;
-
-  beforeEach(async () => {
-    await TestBed.configureTestingModule({
-      imports: [AudioComponent]
-    })
-    .compileComponents();
-
-    fixture = TestBed.createComponent(AudioComponent);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should create', () => {
-    expect(component).toBeTruthy();
-  });
-});

package/src/lib/module/audio/audio.component.ts

@@ -1,39 +0,0 @@
-import {AfterViewInit, Component, ElementRef, Input, signal, ViewChild} from '@angular/core';
-import {RenderingModule} from '../../rendering.module';
-import {RenderModule} from '../RenderModule';
-import {Node} from 'ngx-edu-sharing-api';
-import {FormsModule} from '@angular/forms';
-import {RenderData, AssetStateItem} from '../../dto/RenderData';
-import {TrackingService} from '../../../tracking.service';
-
-@Component({
-    selector: 'rs-module-audio',
-    imports: [
-        RenderingModule,
-        FormsModule,
-    ],
-    templateUrl: './audio.component.html',
-    styleUrl: './audio.component.scss'
-})
-export class AudioComponent implements RenderModule, AfterViewInit{
-  @Input() data: RenderData | undefined;
-  @Input() node: Node | undefined;
-  previewUrl: String = ''
-  private hasBeenPlayed: Boolean = false
-  activeObject = signal<AssetStateItem | undefined>(undefined);
-
-  constructor(private trackingService: TrackingService) { }
-
-  ngAfterViewInit(): void {
-    this.previewUrl = this.node?.preview?.url ?? ''
-    const allFinishedItems = this.data?.items?.filter(item => item.link !== '')
-    this.activeObject.set(allFinishedItems?.[0]);
-  }
-
-  onVideoPlay(): void {
-    if (!this.hasBeenPlayed) {
-      this.trackingService.trackPlayed(this.node?.ref.id!!, this.node?.ref.repo!!)
-    }
-    this.hasBeenPlayed = true
-  }
-}

package/src/lib/module/binder/binder.component.html

@@ -1,10 +0,0 @@
-<div class="binder-wrapper">
-  <div class="preview-container" *ngIf="hasPreview()">
-    <mat-spinner [diameter]="50" *ngIf="previewUrl() === ''"></mat-spinner>
-    <iframe class="frame" [src]="previewUrl()" *ngIf="previewUrl() !== ''" ></iframe>
-  </div>
-  <div class="binder-link-container">
-    <mat-spinner [diameter]="50" *ngIf="binderItem()?.link === ''" ></mat-spinner>
-    <a mat-flat-button color="primary" [href]="binderItem()?.link" target="_blank" *ngIf="binderItem()?.link !== ''">Link to object</a>
-  </div>
-</div>