entcore 4.6.0-dev.1 → 4.6.0-dev.202210281154

package/build.sh

@@ -1,70 +0,0 @@
-#!/bin/bash
-
-if [ ! -e node_modules ]
-then
-  mkdir node_modules
-fi
-
-if [ -z ${USER_UID:+x} ]
-then
-  export USER_UID=1000
-  export GROUP_GID=1000
-fi
-
-# options
-SPRINGBOARD="recette"
-for i in "$@"
-do
-case $i in
-    -s=*|--springboard=*)
-    SPRINGBOARD="${i#*=}"
-    shift
-    ;;
-    *)
-    ;;
-esac
-done
-
-build () {
-  local extras=$1
-  docker-compose run --rm -u "$USER_UID:$GROUP_GID" node sh -c "node_modules/gulp/bin/gulp.js build ${extras}"
-}
-
-install () {
-  docker-compose run --rm -u "$USER_UID:$GROUP_GID" node sh -c "npm install"
-}
-
-watch () {
-  docker-compose run --rm -u "$USER_UID:$GROUP_GID" node sh -c "node_modules/gulp/bin/gulp.js watch --springboard=/home/node/$SPRINGBOARD"
-}
-
-publish () {
-  LOCAL_BRANCH=`echo $GIT_BRANCH | sed -e "s|origin/||g"`
-  docker-compose run --rm -u "$USER_UID:$GROUP_GID" node sh -c "npm publish --tag $LOCAL_BRANCH"
-}
-
-for param in "$@"
-do
-  case $param in
-    deps)
-      install
-      ;;
-    build)
-      build
-      ;;
-    install)
-      install && build "--springboard=/home/node/${SPRINGBOARD}"
-      ;;
-    watch)
-      watch
-      ;;
-    publish)
-      publish
-      ;;
-    *)
-      echo "Invalid argument : $param"
-  esac
-  if [ ! $? -eq 0 ]; then
-    exit 1
-  fi
-done

package/docker-compose.yml

@@ -1,16 +0,0 @@
-gradle:
-  image: gradle:4.5-alpine
-  working_dir: /home/gradle/project
-  volumes:
-    - ./:/home/gradle/project
-    - ~/.m2:/home/gradle/.m2
-    - ~/.gradle:/home/gradle/.gradle
-
-node:
-  image: opendigitaleducation/node:10-alpine
-  working_dir: /home/node/app
-  volumes:
-    - ./:/home/node/app
-    - ~/.npm:/.npm
-    - ../paris:/home/node/paris
-    - ../recette:/home/node/recette # TODO : rendre générique pour appliquer à tous les springboards

package/karma-base.conf.json

@@ -1,49 +0,0 @@
-{
-  "basePath": "",
-  "files": [
-    "node_modules/jquery/dist/jquery.js",
-    "node_modules/mathjax/MathJax.js",
-    "node_modules/angular/angular.js",
-    "node_modules/angular-mocks/angular-mocks.js",
-    "node_modules/angular-route/angular-route.js",
-    "node_modules/angular-sanitize/angular-sanitize.js",
-    "src/ts/lib.ts",
-    "src/ts/ng-start.ts",
-    "src/ts/modelDefinitions.ts",
-    "src/ts/http.ts",
-    "src/ts/idiom.ts",
-    "src/ts/calendar.ts",
-    "src/ts/ui.ts",
-    "src/ts/me.ts",
-    "src/ts/skin.ts",
-    "src/ts/globals.ts",
-    "src/ts/notify.ts",
-    "src/ts/workspace/*.ts",
-    "src/ts/edumedia/*.ts",
-    "src/ts/behaviours.ts",
-    "src/ts/rights.ts",
-    "src/ts/toasts.ts",
-    "src/ts/entcore.ts",
-    "src/ts/sniplets.ts",
-    "src/ts/template.ts",
-    "src/ts/widget.ts",
-    "src/ts/libs/**/*.ts",
-    "src/ts/editor.ts",
-    "src/ts/editor.spec.ts",
-    "src/ts/editor/**/*.ts",
-    "src/ts/library/*.ts",
-    "src/ts/directives/userRole.ts",
-    "src/ts/directives/userRole.spec.ts"
-  ],
-  "preprocessors": {
-    "src/**/*.ts": ["karma-typescript"]
-  },
-
-  "reporters": ["progress", "karma-typescript"],
-  "singleRun": false,
-  "frameworks": ["jasmine", "karma-typescript"],
-  "browsers": ["Chrome", "Firefox"],
-  "karmaTypescriptConfig": {
-    "tsconfig": "./tsconfig.spec.json"
-  }
-}

package/karma-compatibility.conf.js

@@ -1,25 +0,0 @@
-const karmaBaseConf = require('./karma-base.conf');
-const browsers = require('./browsers');
-const customLaunchers = {};
-
-browsers.forEach(browser => customLaunchers[browser.name] = {
-    base: 'BrowserStack',
-    browser: browser.browser,
-    os: browser.os,
-    os_version: browser.os_version,
-    browser_version: browser.browser_version
-});
-
-module.exports = function (config) {
-    const karmaCompatibilityConf = Object.assign({}, karmaBaseConf, {
-        browserStack: {
-            username: process.env.BROWSERSTACK_USERNAME,
-            accessKey: process.env.BROWSERSTACK_ACCESSKEY
-        },
-        customLaunchers,
-        browsers: Object.keys(customLaunchers),
-        singleRun: true
-    });
-
-    config.set(karmaCompatibilityConf)
-};

package/karma.conf.js

@@ -1,5 +0,0 @@
-const karmaBaseConf = require('./karma-base.conf');
-
-module.exports = function (config) {
-    config.set(karmaBaseConf);
-};

package/src/ts/deps.d.ts

@@ -1,52 +0,0 @@
-// angular is loaded globally
-declare let angular;
-
-//webpack stuff
-declare function require(path:string);
-
-declare interface require{
-    ensure(modulesPaths: string[], cb: (modules) => void);
-}
-
-// allow parsing strings as int
-declare function parseInt(data:any, radix?:number);
-
-declare interface Range{
-    intersectsNode(item: HTMLElement): boolean;
-}
-
-declare interface Blob{
-    name: string;
-}
-
-declare interface Document{
-    caretRangeFromPoint(x: number, y: number);
-    caretPositionFromPoint(x: number, y: number);
-}
-
-declare interface Xiti {
-    conf: any;
-    ATInternet: any;
-    ATTag: any;
-    structure: any;
-    run(path?: string): Promise<void>;
-    click(name: string, element: Element): Promise<void>;
-}
-
-declare interface Window{
-    MathJax: any;
-    Prism: any;
-    entcore: any;
-    html_beautify: any;
-    jQuery: any;
-    notLoggedIn: boolean;
-    xiti: Xiti;
-}
-
-declare interface Node{
-    innerHTML: string;
-}
-
-declare interface Object{
-    toJSON(): string | {}
-}

package/src/ts/directives/virtual-folder/README.md

@@ -1,209 +0,0 @@
-## Virtual Folder
-
-Virtual Folder is an extension of Media-Library component in order to create your own virtual documents 
-if you wish to make it exportable to all apps.
-
-Each Virtual Folder must be implemented by an App using Behaviours.
-
-### 1. Requirement
-
-Must add public configuration to Workspace App :
-<pre>
-## Workspace configuration
-{
-      ...
-      "config": {
-         ...
-         "publicConf": {
-           "folder-service": ["appName", "appName2", ...]
-        }
-      }
-}
-</pre>
-
-Note : `appName` (`or appName2`) must be written correctly in order to load their behaviours (e.g `Behaviours.load(appName)`)
-
-
-## Implementation usage as an App
-
-In your behaviours, you must add a field named `mediaLibraryService` (could be an object/class)
-
-It should be accessible via `Behaviours.applicationsBehaviours[appName].mediaLibraryService`
-
-`mediaLibraryService` must implement `VirtualMediaLibraryScope` as an object or class
-
-
-### 1. Interface 
-
-This is the interface that each app must implement :
-```
-interface IVirtualMediaLibraryScope{
-    folders: Array<Document>;
-
-    documents: Array<Document>;
-
-    openedTree: FolderTreeProps;
-
-    enableInitFolderTree(): boolean;
-
-    initFolderTree(): Promise<void>;
-
-    openFolder(folder: Document): Promise<void>;
-
-    onSelectVirtualDocumentsBefore(documents: Array<any>): Promise<Array<Document>>;
- 
-    clearCopiedDocumentsAfterSelect(documents: Array<Document>): Promise<void>;
-}
-```
-### 2. Interface Description
-
-Each app must implement these scopes in their own behaviours as `mediaLibraryservice` (using `object` or `class` typescript)
-
-
-| Scope                   | Type | Description - Ideal implementation                                                                      
-| ------------------------- | ----- | -----------------------------------------------------------------------------------
-| `folders`           | ` Array<Document>` | An Array of documents that must contain folder type
-| `documents`       | `Array<Document>` | An Array of documents that must contain simply documents type                    
-| `openedTree`       | `FolderTreeProps` | The current opened tree loaded from behaviours (will store your current behaviours media library service)                      
-| `enableInitFolderTree`    | `boolean` | Method that will allow your virtual folder to be displayed as a `tree` service in media-library            
-| `initFolderTree` | `Promise<void>` | Initialize your folder `tree` service (using `folder-tree` directive). this method **requires** `folders` and `documents` members to be populated
-| `openFolder` | `Promise<void>` | open folder children from your `tree` service.  this method **requires** `folders` and `documents` members to be populated                      
-| `onSelectVirtualDocumentsBefore` | `Promise<Array<Document>>` | This method will execute the behaviour's action before its executes the media library scope `selectDocuments()`.            
-| `clearCopiedDocumentsAfterSelect` | `Promise<void>` | Allows clear copied documents (if you decided in your method `onSelectVirtualDocumentsBefore()`)                  
-
-### 3. Interface Implementation example
-
-```
-Behaviours.register(appName, {
-    right {
-        ...
-    }
-    mediaLibraryService: new MediaLibraryService(), // mediaLibraryService
-    ...
-})
-```
-
-Creation object :
-```
-export const mediaLibraryService: IVirtualMediaLibraryScope = {
-   // implements all methods
-};
-```
-or class : 
-```
-export class MediaLibraryService implements VirtualMediaLibraryScope {
-   // implements all methods
-};
-```
-
-### 4. Example implementation for each method
-
-Say we are implementing `MediaLibraryService` from a specific module that needs to display its own tree to the media library
-
-```typescript
-export class MediaLibraryService implements IVirtualMediaLibraryScope {
-    openedTree: any;
-    folders: Array<Document>;
-    documents: Array<Document>;
-
-    constructor() {
-        this.folders = [];
-        this.documents = [];
-    }
-
-    enableInitFolderTree(): boolean {
-        return true // or anything, you make your own condition to determine whether it should be displayed in your virtual folder tree
-    }
-
-    async initFolderTree(): Promise<void> {
-        // apicall() or method() from your own that will fetch data and use for assigning your folders and this documents
-        // (e.g): 
-        let documents: any = apiCall();
-
-        // populate folder content to media library behaviours
-        this.folders = documents.filter(filterFoldersOnly());
-        
-        // populate file content to media library behaviours
-        this.documents = documents.filter(filterDocumentsOnly()); // See below the example of field Document object must have 
-    }
-
-    async openFolder(folder: models.Element): Promise<void> {
-        // apicall() or method() from your own that will fetch data and use for assigning your folders and this documents
-        // you can add extra business logic, it will depend what you seek for
-        // (e.g): 
-        let documents: any = anotherCall();
-
-        // populate folder content to media library behaviours
-        this.folders = documents.filter(filterFoldersOnly());
-
-        // populate file content to media library behaviours
-        this.documents = documents.filter(filterDocumentsOnly()); // See below the example of field Document object must have 
-    }
-
-    async onSelectVirtualDocumentsBefore(documents: Array<any>): Promise<Array<Document>> {
-        // apicall() or method() from your own that will do any action you like
-        // IMPORTANT this must return {Promise<Array<Document>>} containing a "real" document since this will be used for media library ng model
-        
-        let resDocuments = await anotherCall(documents); // could be calling your own API/method to duplicate or choose different documents
-        return resDocuments;
-        
-    }
-
-    async clearCopiedDocumentsAfterSelect(documents: Array<Document>): Promise<void> {
-        if (documents && documents.length)
-            service.deleteAll(documents); // SUGGESTED method that will clear any documents
-        // note: service.deleteAll comes from workspaceService
-    }
-
-}
-```
-
-As for the `Document` model, these fields should be available :
-```
-{
-    name: {string}
-    comments: {string},
-    metadata: {
-        'content-type': {string},
-        role: {string},
-        extension: {string},
-        filename: {string},
-        size: {number}
-    }, // metadata as the workspace object
-    owner: {string},
-    ownerName: {string}
-}
-```
-Example fictive data of a document
-```
-{
-   "_id": {string} (e.g "id"),
-   "name": {string} (e.g "name"),
-   "title": {string} (e.g "title"),
-   "created": {string} (e.g "2022-06-02T12:06:00.000Z"),
-   "children": {Array<this} file/folder content (recommanded to avoid TypeError)
-   "documents": {Array<this>} file content 
-   "folders": {Array<this>} folder content // not mandatory if you decide to lazy load your current folder
-   "eParent": {string},
-   "eType": {string}, "file" | "folder"
-   "metadata":{
-      "name": {string} (e.g "insert title"),
-      "filename": {string}, (e.g "insert title.png"),
-      "content-type": {string} (e.g "image/png"),
-      "charset": {string} (e.g "UTF-8"),
-      "size": {number} (e.g 77287),
-      "extension": {string} (e.g "png"),
-      "role": {string}, (e.g "img")
-   },
-   "version": {number} (e.g 50),
-   "link": {string} (e.g "/workspace/document/id"),
-   "icon":" {string} (e.g "/workspace/document/id"),
-   "owner":{
-      "userId": {string} (e.g "user id"),
-      "displayName": {string} (e.g "display name")
-   },
-   "shared":[]
-}
-```
-
-

package/src/ts/editor/matchers.d.ts

@@ -1,6 +0,0 @@
-declare module jasmine {
-    interface Matchers<T> {
-        toBeEditedAs(expected: Expected<string>, expectationFailOutput?: any): boolean;
-        toBeStyledAs(expected: Expected<string>, expectationFailOutput?: any): boolean;
-    }
-}

package/src/ts/libs/angular/angular.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require('angular');
-require('angular-route');
-require('angular-sanitize');
-exports.angular = window.angular;
-if (!window.entcore) {
-    window.entcore = {};
-}
-window.entcore.angular = exports.angular;
-//# sourceMappingURL=angular.js.map

package/src/ts/libs/angular/angular.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"angular.js","sourceRoot":"","sources":["angular.ts"],"names":[],"mappings":";;AAAA,OAAO,CAAC,SAAS,CAAC,CAAC;AACnB,OAAO,CAAC,eAAe,CAAC,CAAC;AACzB,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEjB,QAAA,OAAO,GAAI,MAAc,CAAC,OAAO,CAAC;AAC7C,EAAE,CAAA,CAAC,CAAE,MAAc,CAAC,OAAO,CAAC,CAAA,CAAC;IACxB,MAAc,CAAC,OAAO,GAAG,EAAE,CAAC;AACjC,CAAC;AACA,MAAc,CAAC,OAAO,CAAC,OAAO,GAAG,eAAO,CAAC"}

package/src/ts/libs/underscore/underscore.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = require('underscore');
-if (!window.entcore) {
-    window.entcore = {};
-}
-window.entcore._ = exports._;
-//# sourceMappingURL=underscore.js.map

package/src/ts/libs/underscore/underscore.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"underscore.js","sourceRoot":"","sources":["underscore.ts"],"names":[],"mappings":";;AAAW,QAAA,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,EAAE,CAAA,CAAC,CAAE,MAAc,CAAC,OAAO,CAAC,CAAA,CAAC;IACxB,MAAc,CAAC,OAAO,GAAG,EAAE,CAAC;AACjC,CAAC;AACA,MAAc,CAAC,OAAO,CAAC,CAAC,GAAG,SAAC,CAAC"}

package/tsconfig.spec.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "declaration": false,
-    "moduleResolution": "node",
-    "sourceMap": true,
-    "noImplicitAny": false,
-    "lib": ["es2015", "dom"]
-  }
-}

package/wdio.conf.js

@@ -1,44 +0,0 @@
-const os = require('os');
-const browsers = require('./browsers');
-
-let capabilities = os.type() === 'Darwin'?
-    [{"browserName": "safari"}] : [{"browserName": "chrome"}, {"browserName": "firefox"}];
-
-let services = ['selenium-standalone'];
-let user;
-let key;
-if (process.env.BROWSERSTACK === 'true') {
-    services = ['browserstack'];
-    user = process.env.BROWSERSTACK_USERNAME;
-    key = process.env.BROWSERSTACK_ACCESSKEY;
-    capabilities = browsers
-        .map(browser => Object.assign({}, {browserName: browser.browser.toLowerCase()}, browser));
-}
-
-exports.config = {
-    specs: [
-        './test/specs/**/*.ts'
-    ],
-    capabilities,
-    sync: true,
-    logLevel: 'silent',
-    coloredLogs: true,
-    deprecationWarnings: true,
-    bail: 0,
-    screenshotPath: './errorShots/',
-    baseUrl: process.env.E2E_BASE_URL || 'http://localhost:8090',
-    waitforTimeout: 20000,
-    connectionRetryTimeout: 90000,
-    connectionRetryCount: 3,
-    services,
-    user,
-    key,
-    browserstackLocal: true,
-    framework: 'jasmine',
-    jasmineNodeOpts: {
-        defaultTimeoutInterval: 60000
-    },
-    before: function () {
-        require('ts-node/register');
-    }
-};

package/webpack-dev.config.js

@@ -1,25 +0,0 @@
-var webpack = require('webpack');
-var path = require('path');
-
-module.exports = {
-    context: path.resolve(__dirname, './'),
-    entry: {
-        'ng-app': './src/ts/ng-app'
-    },
-    output: {
-        filename: './bundle/[name].js'
-    },
-    resolve: {
-        modulesDirectories: ['node_modules'],
-        extensions: ['', '.ts', '.js']
-    },
-    devtool: "inline-source-map",
-    module: {
-        loaders: [
-            {
-                test: /\.ts$/,
-                loader: 'awesome-typescript-loader'
-            }
-        ]
-    }
-}

package/webpack.config.js

@@ -1,31 +0,0 @@
-var webpack = require('webpack');
-var path = require('path');
-const UglifyJSPlugin = require('uglifyjs-webpack-plugin');
-
-module.exports = {
-    context: path.resolve(__dirname, './'),
-    entry: {
-        'ng-app': './src/ts/ng-app'
-    },
-    output: {
-        filename: './bundle/[name].js'
-    },
-    resolve: {
-        modulesDirectories: ['node_modules'],
-        extensions: ['', '.ts', '.js']
-    },
-    devtool: "source-map",
-    module: {
-        loaders: [
-            {
-                test: /\.ts$/,
-                loader: 'awesome-typescript-loader'
-            }
-        ]
-    },
-    plugins: [
-        new UglifyJSPlugin({
-            sourceMap: true
-        })
-    ]
-}