apivideo / api.video-strapi-plugin Goto Github PK

View Code? Open in Web Editor NEW

24.0 1.0 2.0 1.6 MB

A Strapi plugin for managing uploads to api.video.

Home Page: https://api.video

License: MIT License

TypeScript 99.83% Shell 0.06% JavaScript 0.11%

strapi strapi-cms strapi-plugin strapi4 strapicms video video-processing

api.video-strapi-plugin's Introduction

Strapi v4 - api.video uploader

A powerful Strapi plugin to easily manage your videos and integrate them in your project.

This plugin provides the ability to upload content via a file to upload to api.video.

✨ Features
⏳ Installation
- Via Strapi Marketplace
- Via command line
🖐 Requirements
🔧 Configuration
👤 Permissions
💾 Metadata
🤝 Contributing
📚 References

✨ Features

Upload videos using a file to api.video inside of Strapi
Manage assets with the plugin's asset grid and pagination capabilities
Search for assets using title
Preview content using our player (powered by the api.video-player-react package)
Delete assets which result in the api.video Asset also being deleted

⏳ Installation

Via Strapi Marketplace

We're available on the Strapi Marketplace.

Via command line

(Use yarn to install this plugin within your Strapi project (recommended). Install yarn with these docs.)

yarn add @api.video/strapi-uploader-plugin@latest

After successful installation you've to re-build your Strapi instance. To archive that simply use:

yarn build
yarn develop

or just run Strapi in the development mode with --watch-admin option:

yarn develop --watch-admin

The api-video-uploader plugin should appear in the Plugins section of Strapi sidebar after you run app again.

As a next step you must configure your the plugin by the way you want to. See Configuration section.

All done. Enjoy 🎉

🖐 Requirements

api.video

A api.video account
You will only an Api Key which can be created in the api.video Dashboard

Complete installation requirements are exact same as for Strapi itself and can be found in the documentation under Installation Requirements.

Minimum environment requirements

Node.js >=14.19.1 <=18.x.x
NPM >=6.x.x

In our minimum support we're following official Node.js releases timelines.

Supported Strapi versions:

Strapi v4.5.1 (recently tested)
Strapi v4.x

This plugin is designed for Strapi v4 and is not working with v3.x.

We recommend always using the latest version of Strapi to start your new projects.

🔧 Configuration

In order for this plugin to communicate with api.video, a configuration needs to be set for the plugin before it can be used.

With your Api Key, navigate to the Settings view within Strapi and click the "General" section under API.VIDEO UPLOADER.

On this view, enter your Api Key and click the Save button.

To resolve Content Security Policy directive issue and to visualize the thumbnail and the video, we need to configure external ressource like embed.api.videoand cdn.api.video/vod/. Modify the middlewares.js file like below:

// config/middlewares.js
module.exports = ({ env }) => [
    'strapi::errors',
    {
        name: 'strapi::security',
        config: {
            contentSecurityPolicy: {
                useDefaults: true,
                directives: {
                    'connect-src': ["'self'", 'https:'],
                    'img-src': ["'self'", 'data:', 'blob:', 'embed.api.video', 'cdn.api.video/vod/'],
                    'frame-src': ["'self'", 'data:', 'blob:', 'embed.api.video'],
                    upgradeInsecureRequests: null,
                },
            },
        },
    },
    'strapi::cors',
    'strapi::poweredBy',
    'strapi::logger',
    'strapi::query',
    'strapi::body',
    'strapi::favicon',
    'strapi::public',
]

👤 Permissions

With the Community Edition of Strapi, any user with the role of super administrator can configure and use the plugin.

With Strapi Enterprise the permissions can be fine tuned according to the role of users. This is done in the Roles view in the Administration Panel.

💾 Metadata

By default we send the value Strapias Upload source to keep track. This value is set by default and can't be changed.

🤝 Contributing

Contributions, issues and feature requests are welcome!

If you encounter an error or have questions, please feel free to file inquiries on the Issues page for @api.video/strapi-uploader-plugin.

📚 References

api.video-strapi-plugin's People

Contributors

Stargazers

Watchers

Forkers

tommo56700 caephler

api.video-strapi-plugin's Issues

Enable private video upload & management

Currently it is not possible to upload videos as private from the Strapi plugin. As a user with a requirement to keep video secure at all times we need this to be possible.

Add a toggle for private video to the Strapi upload page. We should be able to then watch and manage private video using the api key for auth. This should be handled behind the scenes.

[Bug]: Strapi fails to build with this plugin installed.

Version

1.0.4

Environment that reproduces the issue

Tried a fresh install with the latest version of Strapi [v4.9.1] & with the version called out in the README of this project [v4.5.1].

After running an npm build it fails to build, are you able to re-create this?

Building your admin UI with development configuration...

● Webpack █████████████████████████ building (21%) 0/1 entries 4624/4702 dependencies 1026/1577 modules 293 active
 node_modules\semver\functions\diff.js

ModuleNotFoundError: Module not found: Error: Can't resolve 'react/jsx-runtime' in 'C:\Users\Nathan\Documents\test-project\node_modules\@api.video\strapi-uploader-plugin\node_modules\@strapi\icons\dist'
Did you mean 'jsx-runtime.js'?
BREAKING CHANGE: The request 'react/jsx-runtime' failed to resolve only because it was resolved as fully specified
(probably because the origin is strict EcmaScript Module, e. g. a module with javascript mimetype, a '*.mjs' file, or a '*.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.

Is it reproducible in the example application?

Yes

Reproduction steps

npx [email protected] test-project
npm i @api.video/strapi-uploader-plugin
npm run build

Expected result

The app builds.

Actual result

The app doesn't build

Additional context

npm --version
6.11.1

node --version
v16.15.1

Relevant logs output

No response

Add License Information

There is no license information on this repository. I have noticed on many of the other api.video repositories there is an MIT license. Is it okay to fork this and clone for local use?

[Bug]: Using private api.video assets in a relation always returns default token

Version

1.0.2

Environment that reproduces the issue

@strapi/strapi: 4.8.2

Is it reproducible in the example application?

Reproduction steps

Setup an example strapi application
Install api.video plugin and upload a private video
Add a new content type (e.g. type Video) that has a relation to the api.video asset
Add a new entry of type Video that relates to an api.video entry
Query either the REST API endpoint with the following payload

REST

/api/videos?populate=*

Expected result

Expect results with a newly generated private video token with each request

Actual result

Results are returned with the default token on each request:
token=11111111-1111-1111-1111-111111111111

Example response: (api.video asset is data[0].attributes.video)

{
	"data": [
		{
			"id": 1,
			"attributes": {
				"createdAt": "2023-03-22T03:31:28.813Z",
				"updatedAt": "2023-03-22T03:31:39.598Z",
				"publishedAt": "2023-03-22T03:31:39.286Z",
				"title": "Tech Video 1 - The First Video",
				"description": "<h1>Big Header</h1><p>Some text underneath</p><h2>Second header</h2><p>More text underneath</p>",
				"video": {
					"data": {
						"id": 2,
						"attributes": {
							"title": "Technology Video 1",
							"description": "only for tech folks",
							"_public": false,
							"videoId": "vi5PTo2swHiwGDOdVRJ05I1Z",
							"hls": "https://vod.api.video/vod/vi5PTo2swHiwGDOdVRJ05I1Z/token/11111111-1111-1111-1111-111111111111/hls/manifest.m3u8",
							"iframe": "<iframe src=\"https://embed.api.video/vod/vi5PTo2swHiwGDOdVRJ05I1Z?token=11111111-1111-1111-1111-111111111111\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"true\"></iframe>",
							"mp4": "https://vod.api.video/vod/vi5PTo2swHiwGDOdVRJ05I1Z/token/11111111-1111-1111-1111-111111111111/mp4/source.mp4",
							"player": "https://embed.api.video/vod/vi5PTo2swHiwGDOdVRJ05I1Z?token=11111111-1111-1111-1111-111111111111",
							"thumbnail": "https://vod.api.video/vod/vi5PTo2swHiwGDOdVRJ05I1Z/token/11111111-1111-1111-1111-111111111111/thumbnail.jpg",
							"tags": [
								"Technology",
								"Short"
							],
							"metadata": [
								{
									"key": "Upload source",
									"value": "Strapi"
								}
							],
							"createdAt": "2023-03-22T03:01:13.805Z",
							"updatedAt": "2023-03-22T03:01:13.805Z"
						}
					}
				}
			}
		}
	],
	"meta": {
		"pagination": {
			"page": 1,
			"pageSize": 25,
			"pageCount": 1,
			"total": 1
		}
	}
}

Additional context

This also happens with the GraphQL interface, would be great if both interfaces could be fixed.

Relevant logs output

No response

[Bug]: Private video with graphql plugin

Version

1.0.1

Environment that reproduces the issue

@strapi/strapi: 4.6.0
@strapi/plugin-graphql: 4.6.0

Is it reproducible in the example application?

Reproduction steps

Setup an example strapi application
Install api.video plugin and upload a private video
Install graphql plugin: https://docs.strapi.io/dev-docs/plugins/graphql
Use the below graphql plugin config:

graphql: {
    config: {
      endpoint: '/graphql',
      shadowCRUD: true,
      playgroundAlways: false,
      federation: true,
      apolloServer: {
        introspection: true,
      }
    },
  }

Hit the graphql endpoint with the following query:

{apiVideoUploaderApiVideoAssets{data{attributes{title, videoId, player}}}}

Expected result

Expect results with a newly generated private video token with each request

Actual result

Results are returned with the default token on each request:
token=11111111-1111-1111-1111-111111111111

Additional context

First off, great work on the private video feature, it seems to work flawlessly with the REST API. My understanding is that the shadow CRUD operations generated by the Strapi grapql plugin most likely call the default entity service, therefore skipping the custom logic introduced for private videos in the content-api controller. As this is an official strapi plugin, can we get this to work natively within the api.video plugin? If not, a potential workaround would be to implement custom resolver login in the client application that calls the controller directly (https://strapi.io/blog/extending-and-building-custom-resolvers-with-strapi-v4). Here's the example code:

apiVideoUploaderApiVideoAsset: {
    resolve: async (parent, args, context) => {
        const { toEntityResponse } = strapi.service(
            "plugin::graphql.format"        ).returnTypes;
        const id = args.id;
        const ctx = {params: {id}}
        var result = await strapi.plugin('api-video-uploader').controller('content-api').findOne(ctx);
        const response = toEntityResponse(result)
        return response;
    }
}

Can the team confirm if this is the correct approach?

Relevant logs output

No response

Authorization forbidden via graphql

Describe the bug
It seems there is no way to query apiVideoAssets via strapi's graphql endpoint as it results in 'Forbidden Access'.

To Reproduce
I have followed the steps here in order to access the api-video-asset endpoint via the rest api. This works as expected.

Next setup the the graphql plugin with the configuration as follows:

'use strict';

const { join } = require('path');

module.exports = ({ env }) => ({
  graphql: {
    config: {
      endpoint: '/graphql',
      shadowCRUD: true,
      playgroundAlways: false,
      federation: true,
      apolloServer: {
        introspection: true
      },
      artifacts: {
        schema: join(__dirname, '..', 'schema.graphql'),
        typegen: join(__dirname, '..', 'types.d.ts'),
      },
    },
  },
});

This generates the graphql schema for strapi and includes api.video types such as:

type ApiVideoUploaderApiVideoAsset {
  createdAt: DateTime
  description: String
  hls: String!
  iframe: String!
  metadata: JSON
  mp4: String!
  player: String!
  tags: JSON
  thumbnail: String!
  title: String!
  updatedAt: DateTime
  videoId: String!
}

Using Insomnia or an equivalent hit strapi's graphql endpoint (http://localhost:1337/graphql) with the following query:

{apiVideoUploaderApiVideoAssets{data{attributes{videoId}}}}

This results in Forbidden access:

{
    "errors": [
        {
            "message": "Forbidden access",
            "extensions": {
                "error": {
                    "name": "ForbiddenError",
                    "message": "Forbidden access",
                    "details": {}
                },
                "code": "FORBIDDEN"
            }
        }
    ],
    "data": {
        "apiVideoUploaderApiVideoAssets": null
    }
}

I have also tried adding the same API bearer token which is needed for auth via the rest endpoint (mentioned in the final step of the blog post linked above). This still results in the same forbidden response.

Expected behavior
Expect data to be returned as queried.

apivideo / api.video-strapi-plugin Goto Github PK

api.video-strapi-plugin's Introduction

Strapi v4 - api.video uploader

Table of Contents

✨ Features

⏳ Installation

Via Strapi Marketplace

Via command line

🖐 Requirements

🔧 Configuration

👤 Permissions

💾 Metadata

🤝 Contributing

📚 References

api.video-strapi-plugin's People

Contributors

Stargazers

Watchers

Forkers

api.video-strapi-plugin's Issues

Version

Environment that reproduces the issue

Is it reproducible in the example application?

Reproduction steps

Expected result

Actual result

Additional context

Relevant logs output

Version

Environment that reproduces the issue

Is it reproducible in the example application?

Reproduction steps

Expected result

Actual result

Additional context

Relevant logs output

Version

Environment that reproduces the issue

Is it reproducible in the example application?

Reproduction steps

Expected result

Actual result

Additional context

Relevant logs output

Recommend Projects

Recommend Topics

Recommend Org