@latest-thinking/lt-player 2.0.0-q → 3.0.0-beta.10

package/LICENSE.md

@@ -0,0 +1,121 @@
+# LT Player License Agreement
+
+Copyright (c) Latest Thinking GmbH. All rights reserved.
+
+This LT Player License Agreement (the "Agreement") governs the use of version 3 and later of
+the `@latest-thinking/lt-player` software package and its compiled files (the "Software"). The
+licensor is Latest Thinking GmbH, Am Feenteich 4, 22085 Hamburg, Germany (the "Licensor").
+
+This Agreement is a proprietary software license. It is not an open-source license. Installing,
+copying, or using the Software constitutes acceptance of this Agreement. If you do not accept
+these terms, do not install or use the Software.
+
+## 1. License grant
+
+Subject to this Agreement, the Licensor grants you a non-exclusive, worldwide, royalty-free,
+revocable, and non-transferable license to:
+
+1. install and use the Software in its compiled form;
+2. bundle the Software into applications and websites, including internal, commercial, and
+   client projects; and
+3. distribute the Software only as an embedded part of such an application or website bundle,
+   provided that the Software is not offered as a standalone package or reusable component.
+
+You may perform minification, tree-shaking, transpilation, module concatenation, and comparable
+automated transformations only when they are incidental to bundling the Software into an
+application or website. These transformations do not permit functional changes to the Software.
+
+## 2. Restrictions
+
+Except where applicable law expressly provides otherwise and does not permit contractual
+restriction, you must not:
+
+1. modify the Software, change its functionality, or create derivative works from it;
+2. reverse engineer, decompile, disassemble, or otherwise attempt to discover its source code or
+   internal design;
+3. redistribute, publish, sublicense, sell, rent, lease, or otherwise make the Software available
+   as a standalone package, library, component, download, or service;
+4. use the Software to create or distribute a competing standalone video-player package;
+5. remove, obscure, or alter any copyright, trademark, attribution, license, or proprietary notice;
+   or
+6. remove, obscure, or alter Latest Thinking branding included in the Software, except where the
+   Licensor has expressly authorized that removal in writing.
+
+You may not transfer this Agreement or the rights it grants without the Licensor's prior written
+consent. Contractors working on your behalf may use the Software only for your licensed project,
+under confidentiality and use restrictions at least as protective as this Agreement. You remain
+responsible for their compliance.
+
+## 3. Ownership and trademarks
+
+The Software is licensed, not sold. The Licensor and its suppliers retain all rights, title, and
+interest in and to the Software, including all intellectual property rights. No rights are granted
+except those expressly stated in this Agreement.
+
+This Agreement does not grant permission to use the Licensor's names, logos, trademarks, or
+service marks except as they appear in an authorized, unmodified use of the Software. Third-party
+names and trademarks remain the property of their respective owners.
+
+## 4. Third-party software
+
+The Software contains third-party components governed by their own license terms. Those terms
+apply only to the corresponding third-party components and are reproduced in
+`THIRD-PARTY-NOTICES.md`. Nothing in this Agreement limits rights granted by a third-party license
+or imposes this Agreement on third-party software.
+
+## 5. Updates and support
+
+The Licensor may provide updates at its discretion. Unless separate written terms state otherwise,
+updates are governed by the version of this Agreement supplied with them. This Agreement does not
+obligate the Licensor to provide maintenance, support, updates, or continued availability.
+
+## 6. Disclaimer of warranties
+
+To the maximum extent permitted by applicable law, the Software is provided "as is" and "as
+available," without warranties or conditions of any kind, whether express, implied, or statutory.
+The Licensor disclaims all implied warranties and conditions, including merchantability, fitness
+for a particular purpose, title, non-infringement, accuracy, and uninterrupted or error-free
+operation. You are responsible for evaluating whether the Software is suitable for your use.
+
+Nothing in this Agreement excludes a warranty or remedy that applicable law does not permit the
+parties to exclude.
+
+## 7. Limitation of liability
+
+To the maximum extent permitted by applicable law, the Licensor is not liable for indirect,
+incidental, special, exemplary, punitive, or consequential damages, or for loss of profits,
+revenue, data, goodwill, business opportunities, or business interruption, arising from or related
+to the Software or this Agreement, even if advised that such damages are possible.
+
+The limitations in this section do not apply to liability that cannot lawfully be limited or
+excluded, including liability for intent, gross negligence, death, personal injury, or mandatory
+product liability where applicable.
+
+## 8. Termination
+
+This Agreement terminates automatically if you materially breach it. Upon termination, you must
+stop using and distributing the Software and remove standalone copies under your control. Existing
+application or website bundles supplied to end users before termination may remain in use only to
+the extent required by mandatory law or expressly authorized by the Licensor in writing.
+
+Sections concerning restrictions, ownership, third-party software, warranties, liability,
+termination, and general terms survive termination to the extent necessary to give them effect.
+
+## 9. General terms
+
+This Agreement is the entire agreement concerning the Software unless you and the Licensor have
+signed a separate agreement that expressly supersedes it. If any provision is unenforceable, it
+will be limited to the minimum extent necessary, and the remaining provisions will remain in
+effect. A failure to enforce a provision is not a waiver.
+
+This Agreement is governed by the laws of the Federal Republic of Germany, excluding its conflict
+of laws rules and the United Nations Convention on Contracts for the International Sale of Goods.
+Where legally permitted, the exclusive place of jurisdiction is Hamburg, Germany. Mandatory
+consumer-protection and jurisdiction rules remain unaffected.
+
+Questions about this Agreement may be sent to `info@lt.org`.
+
+## Legal review status
+
+This license has been prepared for team review. External legal review is required before the
+stable v3.0.0 release is published.

package/README.md

@@ -1,164 +1,107 @@
 # LT Player
 
-The LT Player is a custom video player tailored for the Latest Thinking GmbH digital ecosystem, designed to enhance user
-engagement and provide a seamless video viewing experience. Built on the robust Vidstack framework, it supports diverse
-video formats and offers advanced features such as rich metadata embedding and infinite scrolling for mobile users.
+`@latest-thinking/lt-player` is the Latest Thinking video player package. Version 3 is currently
+available as a beta and provides the internal Video.js 10 media-engine foundation for browser
+applications.
 
-## Getting Started
+The package is ESM-only and bundles its runtime dependencies. Consumers need Node.js 20 or newer
+for package tooling and a modern browser for playback.
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing
-purposes.
+## Install the beta
 
-### Prerequisites
-
-- Node.js (LTS version recommended)
-- npm
-
-### Installation
-
-1. Clone the repository:
-
-```bash
-git clone ssh://git@git.welink.ro:2424/project/external/lt/player.git
-```
-
-2. Navigate to the project directory:
+Install the version published on the npm `next` channel:
 
 ```bash
-cd player
+npm install @latest-thinking/lt-player@next
 ```
 
-3. Install dependencies:
-
-```bash
-npm install
-```
-
-### Development
-
-To start the development server:
-
-```bash
-npm run dev
+Beta interfaces may change before the stable v3 release.
+
+## Use the player
+
+Import the factory and the required stylesheet, then create a player in an existing host:
+
+```ts
+import { createPlayer, type PlayerConfig } from '@latest-thinking/lt-player';
+import '@latest-thinking/lt-player/styles.css';
+
+const config: PlayerConfig = {
+  version: 3,
+  layout: 'landscape',
+  content: {
+    sources: [{ src: 'https://example.com/video.mp4', type: 'video/mp4' }],
+    chapters: [{ name: 'Opening', start: 0 }],
+  },
+  capabilities: {
+    speed: { options: [1, 1.5, 2] },
+  },
+  strings: {
+    coverButton: 'Watch now',
+  },
+};
+
+const host = document.querySelector<HTMLElement>('#player');
+if (host) {
+  const player = createPlayer(host, config);
+  player.on('play', ({ currentTime }) => console.log('Playing at', currentTime));
+}
 ```
 
-This command will start a local development server and open up a browser window. Most changes are reflected live without
-having to restart the server.
-
-### Building
-
-To build the project for production:
-
-```bash
-npm run build
+Only `layout` and `content.sources` are required by the type contract. Optional values remain
+optional until configuration defaults are resolved by the player. String override keys are open
+so capabilities added by future releases can contribute their own catalog entries. At runtime,
+the current module catalog accepts declared keys such as `coverButton`; undeclared keys are omitted
+and included in the configuration application's single consolidated warning.
+
+`createPlayer` returns a stable handle for updates, state snapshots, playback and preference
+commands, share and context-panel actions, event subscriptions, and destruction. The package does
+not scan the consumer document when imported. The stylesheet gives the host, media-engine
+container, video element, and LT-owned headless controls their complete baseline presentation.
+Width remains an application layout decision; the selected landscape or portrait shell owns its
+aspect ratio. Core controls can be removed individually through configuration, including a
+supported fully chromeless surface that remains operable through the page API.
+
+## Use the feed
+
+The optional feed entry coordinates an ordered list of complete portrait configurations while
+reusing one player and media element:
+
+```ts
+import { createFeed } from '@latest-thinking/lt-player/feed';
+import type { PlayerConfig } from '@latest-thinking/lt-player';
+
+const configurations: PlayerConfig[] = [firstPortraitVideo, secondPortraitVideo];
+const host = document.querySelector<HTMLElement>('#shorts');
+if (host) {
+  const feed = createFeed(host, configurations);
+  feed.on('indexChange', ({ index }) => console.log('Current item', index));
+}
 ```
 
-### Previewing
+The host owns the feed's available height. Each snap item fills that height, so applications can
+use the module inside a full viewport or another explicitly sized container.
 
-To preview the production build:
+## Package exports
 
-```bash
-npm run preview
-```
+| Export                                    | Purpose                                       |
+| ----------------------------------------- | --------------------------------------------- |
+| `@latest-thinking/lt-player`              | `createPlayer` and public v3 TypeScript types |
+| `@latest-thinking/lt-player/feed`         | `createFeed` and public feed TypeScript types |
+| `@latest-thinking/lt-player/styles.css`   | Bundled player stylesheet                     |
+| `@latest-thinking/lt-player/package.json` | Published package metadata                    |
 
-## Running the Tests
+HLS playback uses the package's `dist/hls.js` chunk. The player imports it dynamically only when an
+HLS source requires the hls.js adapter, and it is never fetched from a CDN. Consumer bundlers that
+support code splitting keep the adapter lazy; bundlers without code splitting include it in their
+own application bundle.
 
-To run the configured tests:
+## License
 
-```bash
-npm test
-```
+LT Player v3 is proprietary software, not open-source software. The license permits installing,
+using, and bundling the compiled package into applications and websites, including client
+projects. It prohibits functional modification, reverse engineering, standalone redistribution,
+and removal of legal notices or Latest Thinking branding, subject to applicable law.
 
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see
-the [tags on this repository](https://git.welink.ro/project/external/lt/player/-/tags).
-
-## Authors
-
-**Welink**
-
-
-## Acknowledgments
-
-- Vidstack for the core video player framework.
-
-## Player config
-
-The JSON below is an example configuration that should be provided by any client who wants to initialize a LT Player:
-
-```json
-{
-    "version": 3,
-    "body": {
-        "title": "Video Title",
-        "author": "Author Name",
-        "sources": [
-            {
-                "src": "http://www.example.com/path/to/video.m3u8",
-                "type": "application/x-mpegURL"
-            },
-            {
-                "src": "http://www.example.com/path/to/video.mp4",
-                "type": "video/mp4"
-            }
-        ],
-        "duration": 320.37,
-        "poster": "http://www.example.com/path/to/poster.jpg",
-        "chapters": [
-            {
-                "timestamp": 7.205,
-                "name": "Question"
-            },
-            {
-                "timestamp": 77.205,
-                "name": "Method"
-            }
-        ],
-        "tracks": [
-            {
-                "kind": "subtitles",
-                "label": "English",
-                "srclang": "en",
-                "src": "http://www.example.com/path/to/subtitles.vtt",
-                "default": true
-            },
-            {
-                "kind": "subtitles",
-                "label": "Romanian",
-                "srclang": "ro",
-                "src": "http://www.example.com/path/to/romanian-subtitles.vtt"
-            },
-            {
-                "kind": "subtitles",
-                "label": "German",
-                "srclang": "de",
-                "src": "http://www.example.com/path/to/german-subtitles.vtt"
-            }
-        ],
-        "share": {
-            "canonicalUrl": "http://www.example.com/path/to/video",
-            "embedUrl": "http://www.example.com/embed/path/to/video"
-        },
-        "metadata": {
-            "bio": {
-                "title": "Author Name",
-                "description": "Author description"
-            },
-            "abstract": {
-                "title": "Modal Title",
-                "description": "Video description"
-            },
-            "institution": {
-                "title": "Institution Name",
-                "description": "Institution description"
-            }
-        },
-        "type": "full|main|beyond|expert|short",
-        "showLogo": true,
-        "isEmbedded": true,
-        "theme": "light|dark",
-        "background": true
-    }
-}
-```
+Read the complete [LT Player License Agreement](LICENSE.md) before using the package. Licenses and
+attributions for bundled open-source components are listed in
+[Third-Party Notices](THIRD-PARTY-NOTICES.md).