docs: corrected inline typedocs

Author: sr258

packages/h5p-express/src/index.ts

@@ -9,7 +9,12 @@ import contentUserDataExpressRouter from './ContentUserDataRouter/ContentUserDat
 import contentTypeCacheExpressRouter from './ContentTypeCacheRouter/ContentTypeCacheExpressRouter';
 import finishedDataExpressRouter from './FinishedDataRouter/FinishedDataExpressRouter';
 
+import type H5PAjaxExpressRouterOptions from './H5PAjaxRouter/H5PAjaxExpressRouterOptions';
+import type LibraryAdministrationExpressRouterOptions from './LibraryAdministrationRouter/LibraryAdministrationExpressRouterOptions';
+
 export {
+    H5PAjaxExpressRouterOptions,
+    LibraryAdministrationExpressRouterOptions,
     IRequestWithLanguage,
     IRequestWithUser,
     IActionRequest,

packages/h5p-react/src/H5PEditorUI.tsx

@@ -25,7 +25,7 @@ declare global {
     }
 }
 
-interface IH5PEditorUIProps {
+export interface IH5PEditorUIProps {
     contentId: string;
     loadContentCallback: (contentId: string) => Promise<
         IEditorModel & {

packages/h5p-react/src/H5PPlayerUI.tsx

@@ -28,7 +28,7 @@ declare global {
     }
 }
 
-interface IH5PPlayerUIProps {
+export interface IH5PPlayerUIProps {
     contentId: string;
     contextId?: string;
     asUserId?: string;

packages/h5p-react/src/index.ts

@@ -1,4 +1,4 @@
-import H5PPlayerUI from './H5PPlayerUI';
-import H5PEditorUI from './H5PEditorUI';
+import H5PPlayerUI, { type IH5PPlayerUIProps } from './H5PPlayerUI';
+import H5PEditorUI, { type IH5PEditorUIProps } from './H5PEditorUI';
 
-export { H5PPlayerUI, H5PEditorUI };
+export { H5PPlayerUI, H5PEditorUI, IH5PPlayerUIProps, IH5PEditorUIProps };

packages/h5p-server/src/H5PEditor.ts

@@ -977,8 +977,7 @@ export default class H5PEditor {
      * of the file in the local filesystem
      * @param user the user who is uploading the package; optional if
      * onlyInstallLibraries is set to true
-     * @param options (optional) further options:
-     * @param onlyInstallLibraries true if content should be disregarded
+     * @param options.onlyInstallLibraries true if content should be disregarded
      * @returns the content information extracted from the package. The metadata
      * and parameters property will be undefined if onlyInstallLibraries was set
      * to true.

packages/h5p-server/src/H5PPlayer.ts

@@ -126,7 +126,7 @@ export default class H5PPlayer {
      * want to use the IContentStorage object passed into the constructor.
      * @param contentId the content id
      * @param actingUser the user who wants to access the content
-     * @param options.ignoreUserPermission (optional) If set to true, the user
+     * @param options.ignoreUserPermissions (optional) If set to true, the user
      * object won't be passed to the storage classes for permission checks. You
      * can use this option if you have already checked the user's permission in
      * a different layer.

packages/h5p-server/src/LibraryManager.ts

@@ -52,8 +52,8 @@ export default class LibraryManager {
      * @param translationFunction (optional) The translation function to use if
      * you want to localize library metadata (titles). If undefined, no
      * localization will be performed.
-     * @param lock (optional) an implementation of a locking mechanism that
-     * prevents race conditions. If this is left undefined a simple
+     * @param lockProvider (optional) an implementation of a locking mechanism
+     * that prevents race conditions. If this is left undefined a simple
      * single-process lock mechanism will be used. If the library is used within
      * a multi-process or cluster setup, it is necessary to pass in a
      * distributed locking implementation.
@@ -108,7 +108,7 @@ export default class LibraryManager {
      * Returns a readable stream of a library file's contents.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns a readable stream of the file's contents
      */
     public async getFileStats(
@@ -127,7 +127,7 @@ export default class LibraryManager {
      * Returns a readable stream of a library file's contents.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns a readable stream of the file's contents
      */
     public async getFileStream(

packages/h5p-server/src/LibraryName.ts

@@ -37,15 +37,13 @@ export default class LibraryName implements ILibraryName {
     }
 
     /**
-     * Creates a library object from a library name. Also validates the ubername
-     * to protect against attempts to manipulate the server by creating library
-     * names.
+     * Parses the ubername (e.g. "H5P.Example-1.0") and returns a library name
+     * object.
      * @param ubername The library name in a format "H5P.Example-1.0" or
      * "H5P.Example 1.0" (see options)
-     * @param restricted true if the library is restricted
-     * @param useWhitespace true if the parser should accept names like
+     * @param options.useWhitespace true if the parser should accept names like
      * "H5P.Library 1.0"
-     * @param useHyphen true if the parser should accept names like
+     * @param options.useHyphen true if the parser should accept names like
      * "H5P.Library-1.0"
      * @returns undefined if the name could not be parsed
      * @throws H5pError with 400 when the ubername is invalid

packages/h5p-server/src/types.ts

@@ -662,8 +662,7 @@ export interface IFinishedUserData {
 export interface IContentUserDataStorage {
     /**
      * Creates or updates the content user data.
-     * @param contextId an arbitrary value that can be used to save multiple
-     * states for one content - user tuple
+     * @param userData user data
      */
     createOrUpdateContentUserData(userData: IContentUserData): Promise<void>;
 
@@ -694,7 +693,7 @@ export interface IContentUserDataStorage {
      * @param contentId The id of the content to load user data from
      * @param dataType Used by the h5p.js client
      * @param subContentId The id provided by the h5p.js client call
-     * @param user The user who owns this object
+     * @param userId The user who owns this object
      * @param contextId an arbitrary value that can be used to save multiple
      * states for one content - user tuple
      * @returns the data
@@ -710,7 +709,7 @@ export interface IContentUserDataStorage {
     /**
      * Lists all associated contentUserData for a given contentId and user.
      * @param contentId The id of the content to load user data from
-     * @param user The id of the user to load user data from
+     * @param userId The id of the user to load user data from
      * @param contextId an arbitrary value that can be used to save multiple
      * states for one content - user tuple
      * @returns An array of objects containing the dataType, subContentId and
@@ -812,7 +811,7 @@ export interface IContentStorage {
     /**
      * Deletes a content object and all its dependent files from the repository.
      * Throws errors if something goes wrong.
-     * @param id The content id to delete.
+     * @param contentId The content id to delete.
      * @param user The user who wants to delete the content
      */
     deleteContent(contentId: ContentId, user?: IUser): Promise<void>;
@@ -841,8 +840,8 @@ export interface IContentStorage {
     /**
      * Returns information about a content file (e.g. image or video) inside a
      * piece of content.
-     * @param id the id of the content object that the file is attached to
-     * @param filename the filename of the file to get information about
+     * @param contentId the id of the content object that the file is attached to
+     * @param file the filename of the file to get information about
      * @param user the user who wants to retrieve the content file
      * @returns
      */
@@ -855,8 +854,9 @@ export interface IContentStorage {
     /**
      * Returns a readable stream of a content file (e.g. image or video) inside
      * a piece of content
-     * @param id the id of the content object that the file is attached to
-     * @param filename the filename of the file to get; can be a path including
+     * @param contentId the id of the content object that the file is attached
+     * to
+     * @param file the filename of the file to get; can be a path including
      * subdirectories (e.g. 'images/xyz.png')
      * @param user the user who wants to retrieve the content file
      * @param rangeStart (optional) the position in bytes at which the stream
@@ -952,7 +952,7 @@ export interface ILibraryStorage {
      * clean up the partly installed library.
      * @param library The library that is being installed
      * @param filename Filename of the file to add, relative to the library root
-     * @param stream The stream containing the file content
+     * @param readStream The stream containing the file content
      * @returns true if successful
      */
     addFile(
@@ -965,7 +965,7 @@ export interface ILibraryStorage {
      * Adds the metadata of the library to the repository and assigns a new id
      * to the installed library. This dea is used later when the library must be
      * referenced somewhere. Throws errors if something goes wrong.
-     * @param libraryMetadata The library metadata object (= content of
+     * @param libraryData The library metadata object (= content of
      * library.json)
      * @param restricted True if the library can only be used be users allowed
      * to install restricted libraries.
@@ -1035,7 +1035,7 @@ export interface ILibraryStorage {
      * Returns a information about a library file.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns the file stats
      */
     getFileStats(library: ILibraryName, file: string): Promise<IFileStats>;
@@ -1044,7 +1044,7 @@ export interface ILibraryStorage {
      * Returns a readable stream of a library file's contents.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns a readable stream of the file's contents
      */
     getFileStream(library: ILibraryName, file: string): Promise<Readable>;
@@ -2451,8 +2451,8 @@ export interface ILockProvider {
      *
      * @param key the key of the resource to lock
      * @param callback the code which should run once the lock was acquired
-     * @param timeout how long to wait until the lock is acquired
-     * @param maxOccupationTime how long to wait until the code in callback is
+     * @param options.timeout how long to wait until the lock is acquired
+     * @param options.maxOccupationTime how long to wait until the code in callback is
      * finished
      * @throws 'timeout' or 'occupation-time-exceed' errors
      */