docs: better docs

Author: sr258

packages/h5p-mongos3/docs/mongo-s3-content-storage.md

@@ -64,7 +64,7 @@ const storage = new MongoS3ContentStorage(
 
 - The function {@link initS3} creates an S3 client using the `aws-sdk` npm
   package.
-- The function {@link @lumieducation/h5p-server!initMongo} creates a MongoDB
+- The function {@link initMongo} creates a MongoDB
   client using the `mongodb` npm package.
 - You can pass credentials and other configuration values to `initS3` and
   `initMongo` through the function parameters. Alternatively you can use these

packages/h5p-mongos3/docs/s3-temporary-file-storage.md

@@ -91,7 +91,7 @@ TEMPORARYSTORAGE=s3 AWS_ACCESS_KEY_ID=minioaccesskey AWS_SECRET_ACCESS_KEY=minio
 By default the storage implementation allows all users read access to all files
 and every use can create new temporary files! It is very possible that this is
 not something you want! You can add a function to the options object of the
-constructor of {@link S3TemporayStorage} to customize access restrictions:
+constructor of {@link S3TemporaryFileStorage} to customize access restrictions:
 
 ```typescript
     getPermissions: (

packages/h5p-react/README.md

@@ -247,8 +247,9 @@ Note: You can also simply catch errors by wrapping the `save()` method in a `try
 
 ## Executing underlying H5P functionality
 
-The {@link H5PPlayerComponent} offers properties and methods that can be used to
-do things with the underlying "core" H5P data structures and objects:
+The {@link @lumieducation/h5p-webcomponents!H5PPlayerComponent} offers
+properties and methods that can be used to do things with the underlying "core"
+H5P data structures and objects:
 
 ### h5pInstance
 

packages/h5p-server/src/DependencyGetter.ts

@@ -16,19 +16,27 @@ export default class DependencyGetter {
     /**
      * Gets all dependent libraries of the libraries in the list.
      * @param libraries the libraries whose dependencies should be retrieved
-     * @param dynamic include dependencies that are part of the dynamicDependencies property or used in the content
-     * @param editor include dependencies that are listed in editorDependencies
-     * @param preloaded include regular dependencies that are included in preloadedDependencies
-     * @param doNotAdd libraries in this list will not be added to the dependency list
+     * @param options.dynamic include dependencies that are part of the
+     * dynamicDependencies property or used in the content
+     * @param options.editor include dependencies that are listed in
+     * editorDependencies
+     * @param options.preloaded include regular dependencies that are included
+     * in preloadedDependencies
+     * @param doNotAdd libraries in this list will not be added to the
+     * dependency list
      * @returns a list of libraries
      */
     public async getDependentLibraries(
         libraries: ILibraryName[],
-        {
-            dynamic = false,
-            editor = false,
-            preloaded = false
-        }: { dynamic?: boolean; editor?: boolean; preloaded?: boolean },
+        options: {
+            dynamic?: boolean;
+            editor?: boolean;
+            preloaded?: boolean;
+        } = {
+            dynamic: false,
+            editor: false,
+            preloaded: false
+        },
         doNotAdd?: ILibraryName[]
     ): Promise<ILibraryName[]> {
         log.info(
@@ -51,7 +59,11 @@ export default class DependencyGetter {
                         ? Number.parseInt(library.minorVersion, 10)
                         : library.minorVersion
                 ),
-                { preloaded, editor, dynamic },
+                {
+                    preloaded: options?.preloaded,
+                    editor: options?.editor,
+                    dynamic: options?.dynamic
+                },
                 dependencies,
                 doNotAdd
             );

packages/h5p-server/src/PackageImporter.ts

@@ -71,25 +71,25 @@ export default class PackageImporter {
      * disk
      * @param directoryPath The full path of the directory to which the package
      * should be extracted
-     * @param includeLibraries If true, the library directories inside the
+     * @param options.includeLibraries If true, the library directories inside
+     * the package will be extracted.
+     * @param options.includeContent If true, the content folder inside the
+     * package will be extracted.
+     * @param options.includeMetadata If true, the h5p.json file inside the
      * package will be extracted.
-     * @param includeContent If true, the content folder inside the package will
-     * be extracted.
-     * @param includeMetadata If true, the h5p.json file inside the package will
-     * be extracted.
      * @returns
      */
     public static async extractPackage(
         packagePath: string,
         directoryPath: string,
-        {
-            includeLibraries = false,
-            includeContent = false,
-            includeMetadata = false
-        }: {
+        options: {
             includeContent: boolean;
             includeLibraries: boolean;
             includeMetadata: boolean;
+        } = {
+            includeLibraries: false,
+            includeContent: false,
+            includeMetadata: false
         }
     ): Promise<void> {
         log.info(`extracting package ${packagePath} to ${directoryPath}`);
@@ -100,11 +100,12 @@ export default class PackageImporter {
                 !entry.filename.endsWith('/') &&
                 !basename.startsWith('.') &&
                 !basename.startsWith('_') &&
-                ((includeContent && entry.filename.startsWith('content/')) ||
-                    (includeLibraries &&
+                ((options.includeContent &&
+                    entry.filename.startsWith('content/')) ||
+                    (options.includeLibraries &&
                         entry.filename.includes('/') &&
                         !entry.filename.startsWith('content/')) ||
-                    (includeMetadata && entry.filename === 'h5p.json'))
+                    (options.includeMetadata && entry.filename === 'h5p.json'))
             ) {
                 const readStream = await entry.openReadStream();
                 const writePath = path.join(directoryPath, entry.filename);

packages/h5p-server/src/index.ts

@@ -32,6 +32,7 @@ import ContentUserDataManager from './ContentUserDataManager';
 import UrlGenerator from './UrlGenerator';
 import SimpleLockProvider from './implementation/SimpleLockProvider';
 import { LaissezFairePermissionSystem } from './implementation/LaissezFairePermissionSystem';
+import TemporaryFileManager from './TemporaryFileManager';
 
 // Interfaces
 import {
@@ -113,6 +114,7 @@ export {
     LibraryName,
     Logger,
     PackageExporter,
+    TemporaryFileManager,
     streamToString,
     // interfaces
     ContentId,

packages/h5p-shared-state-server/src/SharedStateServer.ts

@@ -13,6 +13,8 @@ import {
     GetLibraryFileAsJsonFunction,
     GetLibraryMetadataFunction,
     GetPermissionForUserFunction,
+    ILogicalOperator,
+    ILogicCheck,
     RequestToUserFunction
 } from './types';
 import checkPermissionsAndInjectContentContext from './middleware/checkPermissionsAndInjectContentContext';
@@ -178,3 +180,5 @@ export default class SharedStateServer {
         return '/shared-state';
     }
 }
+
+export { ILogicCheck, ILogicalOperator };

packages/h5p-webcomponents/src/h5p-player.ts

@@ -133,7 +133,6 @@ export class H5PPlayerComponent extends HTMLElement {
     /**
      * Indicates changes to which attributes should trigger calls to
      * attributeChangedCallback.
-     * @memberof H5PPlayerComponent
      */
     static get observedAttributes(): string[] {
         return ['content-id', 'context-id', 'as-user-id', 'read-only-state'];