Implementations need to implement the ILibraryStorage interface and pass it to H5PEditor. It is used to persist library information and files permanently. Note that the library metadata and semantics are accessed regularly, so caching them is a good idea. The library files will also be accessed frequently, so it makes sense to keep them in memory and not access a hard disk every time they are downloaded. See the FileLibraryStorage sample implementation in the examples directory for more details.

Implements

Constructors

  • Parameters

    • s3: S3

      the S3 content storage; Must be either set to a bucket or the bucket must be specified in the options!

    • mongodb: Collection<
          {
              additionalMetadata: Partial<IAdditionalLibraryMetadata>;
              metadata: ILibraryMetadata;
              ubername: string;
          },
      >

      a MongoDB collection (read- and writable)

    • options: {
          invalidCharactersRegexp?: RegExp;
          maxKeyLength?: number;
          s3Acl?: ObjectCannedACL;
          s3Bucket: string;
      }

      options

      • OptionalinvalidCharactersRegexp?: RegExp

        These characters will be removed from files that are saved to S3. There is a very strict default list that basically only leaves alphanumeric filenames intact. Should you need more relaxed settings you can specify them here.

      • OptionalmaxKeyLength?: number

        Indicates how long keys in S3 can be. Defaults to 1024. (S3 supports 1024 characters, other systems such as Minio might only support 255 on Windows).

      • Optionals3Acl?: ObjectCannedACL

        The ACL to use for uploaded content files. Defaults to private.

      • s3Bucket: string

        The bucket to upload to and download from. (required)

    Returns MongoS3LibraryStorage

Methods

  • Adds a library file to a library. The library metadata must have been installed with addLibrary(...) first. Throws an error if something unexpected happens. In this case the method calling addFile(...) will clean up the partly installed library.

    Parameters

    • library: ILibraryName

      The library that is being installed

    • filename: string

      Filename of the file to add, relative to the library root

    • readStream: Readable

    Returns Promise<boolean>

    true if successful

  • Adds the metadata of the library to the repository and assigns a new id to the installed library. This id is used later when the library must be referenced somewhere. Throws errors if something goes wrong.

    Parameters

    • libraryData: ILibraryMetadata
    • restricted: boolean

      True if the library can only be used be users allowed to install restricted libraries.

    Returns Promise<IInstalledLibrary>

    The newly created library object to use when adding library files with addFile(...)

  • Creates indexes to speed up read access. Can be safely used even if indexes already exist.

    Returns Promise<void>

  • Counts how often libraries are listed in the dependencies of other libraries and returns a list of the number.

    Note: Implementations should not count circular dependencies that are caused by editorDependencies. Example: H5P.InteractiveVideo has H5PEditor.InteractiveVideo in its editor dependencies. H5PEditor.Interactive video has H5P.InteractiveVideo in its preloaded dependencies. In this case H5P.InteractiveVideo should get a dependency count of 0 and H5PEditor.InteractiveVideo should have 1. That way it is still possible to delete the library from storage.

    Returns Promise<{ [ubername: string]: number }>

    an object with ubernames as key. Example: { 'H5P.Example': 10 } This means that H5P.Example is used by 10 other libraries.

  • Returns a list of library addons that are installed in the system. Addons are libraries that have the property 'addTo' in their metadata. ILibraryStorage implementation CAN but NEED NOT implement the method. If it is not implemented, addons won't be available in the system.

    Returns Promise<ILibraryMetadata[]>

  • Gets a list of all library files that exist for this library.

    Parameters

    • library: ILibraryName

      the library name

    • options: { withMetadata?: boolean } = ...

    Returns Promise<string[]>

    all files that exist for the library

  • Migrates the DB schema from one version to another. You need to call this, when you first deploy the new version.

    Parameters

    • from: number

      the old major version of @lumieducation/h5p-mongos3

    • to: number

      the new major version of @lumieducation/h5p-mongos3

    Returns Promise<void>

  • Updates the additional metadata properties that is added to the stored libraries. This metadata can be used to customize behavior like restricting libraries to specific users.

    Implementations should avoid updating the metadata if the additional metadata if nothing has changed.

    Parameters

    Returns Promise<boolean>

    true if the additionalMetadata object contained real changes and if they were successfully saved; false if there were not changes. Throws an error if saving was not possible.