npm - @fastpix/fastpix-node - Versions diffs - 2.0.2 → 2.0.3 - Mend

@fastpix/fastpix-node 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/LICENSE CHANGED Viewed

@@ -1,201 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-   1. Definitions.
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-   END OF TERMS AND CONDITIONS
-   APPENDIX: How to apply the Apache License to your work.
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-   Copyright 2025 FastPix, Inc
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-       http://www.apache.org/licenses/LICENSE-2.0
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+MIT License
+Copyright (c) 2025 FastPix
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md CHANGED Viewed

@@ -20,7 +20,7 @@ The FastPix Node.js SDK simplifies integration with the FastPix platform. It pro
 <tr>
 <td><strong>Node.js</strong></td>
 <td><code>18+</code></td>
-<td>Core runtime environment</td>
+<td>Core runtime environment</td>
 </tr>
 <tr>
 <td><strong>npm/yarn/pnpm</strong></td>
@@ -98,17 +98,32 @@ bun add @fastpix/fastpix-node
 ```bash
 yarn add @fastpix/fastpix-node
 ```
 ### Imports
-Import the necessary modules for your FastPix integration:
+This SDK supports both **ES modules** and **CommonJS**. Examples in this documentation use ES module syntax as it's the preferred format, but you can use either approach.
+#### ES Modules (Recommended)
 ```typescript
 // Basic imports
 import { Fastpix } from "@fastpix/fastpix-node";
 import type { CreateMediaRequest } from "@fastpix/fastpix-node/models/operations";
 ```
+#### CommonJS
+```javascript
+// CommonJS require syntax
+const { Fastpix } = require("@fastpix/fastpix-node");
+```
+> **Why ES Modules?** ES modules provide better tree-shaking, static analysis, and are the modern JavaScript standard. They enable smaller bundle sizes and better development tooling support.
+> **Note:** This SDK automatically provides both module formats. If you encounter import errors in your project, you may need to add `"type": "module"` to your `package.json` file to enable ES modules support.
+> **Security Note:** For production applications, it's recommended to make API calls from your backend server rather than directly from the browser to:
+> - Keep credentials secure
+> - Avoid CORS issues
+> - Implement proper authentication.
 ### Initialization
 Initialize the FastPix SDK with your credentials:
@@ -197,22 +212,23 @@ For detailed documentation, see [FastPix Video on Demand Overview](https://docs.
 - [Get Media by ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#getmedia) - Get detailed information for specific media
 - [Update Media](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#updatedmedia) - Modify media metadata and settings
 - [Delete Media](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#deletemedia) - Remove media files from library
-- [Add Track](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#addmediatrack) - Add audio or subtitle tracks to media
 - [Cancel Upload](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#cancelupload) - Stop ongoing media upload process
-- [Update Track](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#updatemediatrack) - Modify existing audio or subtitle tracks
-- [Delete Track](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#deletemediatrack) - Remove audio or subtitle tracks
-- [Generate Subtitles](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#generatesubtitletrack) - Create automatic subtitles for media
-- [Update Source Access](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#updatedsourceaccess) - Control access permissions for media source
-- [Update MP4 Support](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#updatedmp4support) - Configure MP4 download capabilities
 - [Get Input Info](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#retrievemediainputinfo) - Retrieve detailed input information
 - [List Uploads](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#listuploads) - Get all available upload URLs
-- [Get Media Clips](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managevideos/README.md#getmediaclips) - Retrieve all video clips for media
 #### Playback
 - [Create Playback ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/playback/README.md#createmediaplaybackid) - Generate secure playback identifier
 - [Delete Playback ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/playback/README.md#deletemediaplaybackid) - Remove playback access
 - [Get Playback ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/playback/README.md#getplaybackid) - Retrieve playback configuration details
+#### Play Specific Segments
+- Stream only a portion of a video by appending `start`/`end` parameters to the playback URL. Explore: [Play specific segments](https://docs.fastpix.io/docs/play-your-videos#play-specific-segments). For creating reusable assets instead, see [Create clips from existing media](https://docs.fastpix.io/docs/create-clips-from-existing-media).
+- Try it: `https://stream.fastpix.io/{PLAYBACK_ID}.m3u8?start=20&end=60` (replace `{PLAYBACK_ID}` and tweak times).
+#### Create Clips from Existing Media
+- Create reusable, shareable clip assets from a source video with precise start/end control. Explore: [Create clips from existing media](https://docs.fastpix.io/docs/create-clips-from-existing-media).
+- Try it: use the clipping API from the guide to generate a new clip asset, then retrieve it via Media Clips to validate.
 #### Playlist
 - [Create Playlist](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/playlist/README.md#createaplaylist) - Create new video playlist
 - [List Playlists](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/playlist/README.md#getallplaylists) - Get all available playlists
@@ -239,8 +255,10 @@ Stream, manage, and transform live video content with real-time broadcasting cap
 For detailed documentation, see [FastPix Live Stream Overview](https://docs.fastpix.io/docs/live-stream-overview).
 #### Start Live Stream
-- [Create Stream](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/startlivestream/README.md#createnewstream) - Initialize new live streaming session
+- [Create Stream](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/startlivestream/README.md#createnewstream) - Initialize new live streaming session with **DVR mode support**
 #### Manage Live Stream
 - [List Streams](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/managelivestream/README.md#getallstreams) - Retrieve all active live streams
@@ -257,6 +275,10 @@ For detailed documentation, see [FastPix Live Stream Overview](https://docs.fast
 - [Delete Playback ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/liveplayback/README.md#deleteplaybackidofstream) - Revoke live playback access
 - [Get Playback ID](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/liveplayback/README.md#getlivestreamplaybackid) - Retrieve live playback configuration
+#### Live Clipping
+- Explore instant live clipping during a live stream to capture key moments without creating new assets. See the Live Clipping guide: [Instant Live Clipping](https://docs.fastpix.io/docs/instant-live-clipping).
+- Try it: enable a test live stream and capture a highlight clip while broadcasting to see it appear instantly.
 #### Simulcast Stream
 - [Create Simulcast](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/simulcaststream/README.md#createsimulcastofstream) - Set up multi-platform streaming
 - [Delete Simulcast](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/simulcaststream/README.md#deletesimulcastofstream) - Remove simulcast configuration
@@ -273,7 +295,6 @@ For detailed documentation, see [FastPix Video Data Overview](https://docs.fastp
 - [List Breakdown Values](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/metrics/README.md#listbreakdownvalues) - Get detailed breakdown of metrics by dimension
 - [List Overall Values](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/metrics/README.md#listoverallvalues) - Get aggregated metric values across all content
 - [Get Timeseries Data](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/metrics/README.md#gettimeseriesdata) - Retrieve time-based metric trends and patterns
-- [List Comparison Values](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/metrics/README.md#listcomparisonvalues) - Compare metrics across different time periods
 #### Views
 - [List Video Views](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/views/README.md#listvideoviews) - Get comprehensive list of video viewing sessions
@@ -286,16 +307,62 @@ For detailed documentation, see [FastPix Video Data Overview](https://docs.fastp
 - [List Dimensions](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/dimensions/README.md#listdimensions) - Get available data dimensions for filtering and analysis
 - [List Filter Values](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/dimensions/README.md#listfiltervaluesfordimension) - Get specific values for a particular dimension
-### In-Video AI Features
+### Transformations
+Transform and enhance your video content with powerful AI and editing capabilities.
+#### In-Video AI Features
 Enhance video content with AI-powered features including moderation, summarization, and intelligent categorization.
 For detailed documentation, see [Video Moderation Guide](https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation).
-- [Generate Summary](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/invideoaifeatures/README.md#updatemediasummary) - Create AI-generated video summaries
-- [Create Chapters](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/invideoaifeatures/README.md#updatemediachapters) - Automatically generate video chapter markers
-- [Extract Entities](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/invideoaifeatures/README.md#updatemedianamedentities) - Identify and extract named entities from content
-- [Enable Moderation](https://github.com/FastPix/node-sdk/blob/main/docs/sdks/invideoaifeatures/README.md#updatemediamoderation) - Activate content moderation and safety checks
+- [Generate Summary](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/in-video-ai/README.md#updatemediasummary) - Create AI-generated video summaries
+- [Create Chapters](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/in-video-ai/README.md#updatemediachapters) - Automatically generate video chapter markers
+- [Extract Entities](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/in-video-ai/README.md#updatemedianamedentities) - Identify and extract named entities from content
+- [Enable Moderation](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/in-video-ai/README.md#updatemediamoderation) - Activate content moderation and safety checks
+#### Media Clips
+Retrieve and manage media clips created from your source content.
+For detailed documentation, see [Create clips from existing media](https://docs.fastpix.io/docs/create-clips-from-existing-media).
+- [Get Media Clips](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/get-clips/README.md#getmediaclips) - Retrieve all clips associated with a source media
+#### Subtitles
+Generate automatic subtitles for enhanced accessibility and user experience.
+For detailed documentation, see [Generate subtitles](https://docs.fastpix.io/docs/generate-subtitles).
+- [Generate Subtitles](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/subtitles/README.md#generatesubtitletrack) - Create automatic subtitles for media
+#### Media Tracks
+Add, update, and manage audio and subtitle tracks for your media content.
+For detailed documentation, see [Add tracks](https://docs.fastpix.io/docs/add-tracks).
+- [Add Track](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/tracks/README.md#addmediatrack) - Add audio or subtitle tracks to media
+- [Update Track](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/tracks/README.md#updatemediatrack) - Modify existing audio or subtitle tracks
+- [Delete Track](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/tracks/README.md#deletemediatrack) - Remove audio or subtitle tracks
+#### Access Control
+Control access permissions and visibility for your media content.
+For detailed documentation, see [Access control](https://docs.fastpix.io/docs/access-control).
+- [Update Source Access](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/access-control/README.md#updatesourceaccess) - Control access permissions for media source
+#### Format Support
+Configure download capabilities and format support for your media content.
+For detailed documentation, see [MP4 support](https://docs.fastpix.io/docs/mp4-support).
+- [Update MP4 Support](https://github.com/FastPix/node-sdk/blob/main/docs/transformations/format-support/README.md#updatemp4support) - Configure MP4 download capabilities
 ### Error Handling

package/package.json CHANGED Viewed

@@ -1,12 +1,12 @@
 {
   "name": "@fastpix/fastpix-node",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "author": {
     "name": "FastPix-Dev",
     "email": "devs@fastpix.io",
     "url": "https://www.fastpix.io/"
   },
-  "license": "Apache-2.0",
+  "license": "MIT",
   "type": "module",
   "tshy": {
     "sourceDialects": [