@ormoshe/js-video-url-parser 0.5.1

package/lib/provider/soundcloud.js

@@ -0,0 +1,125 @@
+const {
+  combineParams,
+  getTime,
+} = require('../util');
+
+function SoundCloud() {
+  this.provider = 'soundcloud';
+  this.defaultFormat = 'long';
+  this.formats = {
+    long: this.createLongUrl,
+    embed: this.createEmbedUrl,
+  };
+  this.mediaTypes = {
+    TRACK: 'track',
+    PLAYLIST: 'playlist',
+    APITRACK: 'apitrack',
+    APIPLAYLIST: 'apiplaylist',
+  };
+}
+
+module.exports = SoundCloud;
+
+SoundCloud.prototype.parseUrl = function(url, result) {
+  var match = url.match(
+    /(?:m\.)?soundcloud\.com\/(?:([\w-]+)\/(sets\/)?)([\w-]+)/i
+  );
+  if (!match) {
+    return result;
+  }
+  result.channel = match[1];
+  if (match[1] === 'playlists' || match[2]) { //playlist
+    result.list = match[3];
+  } else { //track
+    result.id = match[3];
+  }
+  return result;
+};
+
+SoundCloud.prototype.parseParameters = function(params) {
+  if (params.t) {
+    params.start = getTime(params.t);
+    delete params.t;
+  }
+  return params;
+};
+
+SoundCloud.prototype.parseMediaType = function(result) {
+  if (result.id) {
+    if (result.channel === 'tracks') {
+      delete result.channel;
+      delete result.params.url;
+      result.mediaType = this.mediaTypes.APITRACK;
+    } else {
+      result.mediaType = this.mediaTypes.TRACK;
+    }
+  }
+  if (result.list) {
+    if (result.channel === 'playlists') {
+      delete result.channel;
+      delete result.params.url;
+      result.mediaType = this.mediaTypes.APIPLAYLIST;
+    } else {
+      result.mediaType = this.mediaTypes.PLAYLIST;
+    }
+  }
+  return result;
+};
+
+SoundCloud.prototype.parse = function(url, params) {
+  var result = {};
+  result = this.parseUrl(url, result);
+  result.params = this.parseParameters(params);
+  result = this.parseMediaType(result);
+  if (!result.id && !result.list) {
+    return undefined;
+  }
+  return result;
+};
+
+SoundCloud.prototype.createLongUrl = function(vi, params) {
+  var url = '';
+  var startTime = params.start;
+  delete params.start;
+
+  if (vi.mediaType === this.mediaTypes.TRACK && vi.id && vi.channel) {
+    url = 'https://soundcloud.com/' + vi.channel + '/' + vi.id;
+  }
+  else if (vi.mediaType === this.mediaTypes.PLAYLIST && vi.list && vi.channel) {
+    url = 'https://soundcloud.com/' + vi.channel + '/sets/' + vi.list;
+  }
+  else if (vi.mediaType === this.mediaTypes.APITRACK && vi.id) {
+    url = 'https://api.soundcloud.com/tracks/' + vi.id;
+  }
+  else if (vi.mediaType === this.mediaTypes.APIPLAYLIST && vi.list) {
+    url = 'https://api.soundcloud.com/playlists/' + vi.list;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+
+  if (startTime) {
+    url += '#t=' + startTime;
+  }
+  return url;
+};
+
+SoundCloud.prototype.createEmbedUrl = function(vi, params) {
+  var url = 'https://w.soundcloud.com/player/';
+  delete params.start;
+
+  if (vi.mediaType === this.mediaTypes.APITRACK && vi.id) {
+    params.url = 'https%3A//api.soundcloud.com/tracks/' + vi.id;
+  }
+  else if (vi.mediaType === this.mediaTypes.APIPLAYLIST && vi.list) {
+    params.url = 'https%3A//api.soundcloud.com/playlists/' + vi.list;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+  return url;
+};
+
+require('../base').bind(new SoundCloud());

package/lib/provider/teachertube.d.ts

@@ -0,0 +1,14 @@
+import { VideoInfo } from '../urlParser';
+
+export interface TeacherTubeUrlParameters {
+    [key: string]: any;
+}
+
+export type TeacherTubeMediaTypes = 'video' | 'audio' | 'document' | 'channel' | 'collection' | 'group';
+
+export interface TeacherTubeVideoInfo extends VideoInfo<TeacherTubeUrlParameters, TeacherTubeMediaTypes> {
+    provider: 'teachertube';
+    list?: string;
+}
+
+export type TeacherTubeParseResult = TeacherTubeVideoInfo | undefined;

package/lib/provider/teachertube.js

@@ -0,0 +1,110 @@
+const {
+  combineParams,
+} = require('../util');
+
+function TeacherTube() {
+  this.provider = 'teachertube';
+  this.alternatives = [];
+  this.defaultFormat = 'long';
+  this.formats = {
+    long: this.createLongUrl,
+    embed: this.createEmbedUrl,
+  };
+  this.mediaTypes = {
+    VIDEO: 'video',
+    AUDIO: 'audio',
+    DOCUMENT: 'document',
+    CHANNEL: 'channel',
+    COLLECTION: 'collection',
+    GROUP: 'group',
+  };
+}
+
+module.exports = TeacherTube;
+
+TeacherTube.prototype.parse = function(url, params) {
+  var result = {};
+
+  result.list = this.parsePlaylist(params);
+  result.params = params;
+
+  var match = url.match(
+    /\/(audio|video|document|user\/channel|collection|group)\/(?:[\w-]+-)?(\w+)/
+  );
+
+  if (!match) {
+    return undefined;
+  }
+  result.mediaType = this.parseMediaType(match[1]);
+  result.id = match[2];
+
+  return result;
+};
+
+TeacherTube.prototype.parsePlaylist = function(params) {
+  if (params['playlist-id']) {
+    var list = params['playlist-id'];
+    delete params['playlist-id'];
+    return list;
+  }
+  return undefined;
+};
+
+TeacherTube.prototype.parseMediaType = function(mediaTypeMatch) {
+  switch (mediaTypeMatch) {
+  case 'audio':
+    return this.mediaTypes.AUDIO;
+  case 'video':
+    return this.mediaTypes.VIDEO;
+  case 'document':
+    return this.mediaTypes.DOCUMENT;
+  case 'user/channel':
+    return this.mediaTypes.CHANNEL;
+  case 'collection':
+    return this.mediaTypes.COLLECTION;
+  case 'group':
+    return this.mediaTypes.GROUP;
+  }
+};
+
+TeacherTube.prototype.createLongUrl = function(vi, params) {
+  if (!vi.id) {
+    return undefined;
+  }
+  var url = 'https://www.teachertube.com/';
+
+  if (vi.list) {
+    params['playlist-id'] = vi.list;
+  }
+
+  if (vi.mediaType === this.mediaTypes.CHANNEL) {
+    url += 'user/channel/';
+  } else {
+    url += vi.mediaType + '/';
+  }
+  url += vi.id;
+
+  url += combineParams(params);
+
+  return url;
+};
+
+TeacherTube.prototype.createEmbedUrl = function(vi, params) {
+  if (!vi.id) {
+    return undefined;
+  }
+
+  var url = 'https://www.teachertube.com/embed/';
+
+  if (vi.mediaType === this.mediaTypes.VIDEO || vi.mediaType === this.mediaTypes.AUDIO) {
+    url += vi.mediaType + '/' + vi.id;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+
+  return url;
+};
+
+require('../base').bind(new TeacherTube());

package/lib/provider/ted.d.ts

@@ -0,0 +1,14 @@
+import { VideoInfo } from '../urlParser';
+
+export interface TedUrlParameters {
+    [key: string]: any;
+}
+
+export type TedMediaTypes = 'video' | 'playlist';
+
+export interface TedVideoInfo extends VideoInfo<TedUrlParameters, TedMediaTypes> {
+    provider: 'ted';
+    list?: string;
+}
+
+export type TedParseResult = TedVideoInfo | undefined;

package/lib/provider/ted.js

@@ -0,0 +1,96 @@
+const { combineParams } = require('../util');
+
+function Ted() {
+  this.provider = 'ted';
+  this.formats = {
+    long: this.createLongUrl,
+    embed: this.createEmbedUrl,
+  };
+  this.mediaTypes = {
+    VIDEO: 'video',
+    PLAYLIST: 'playlist',
+  };
+}
+
+module.exports = Ted;
+
+Ted.prototype.parseUrl = function(url, result) {
+  var match = url.match(/\/(talks|playlists\/(\d+))\/([\w-]+)/i);
+  var channel = match ? match[1] : undefined;
+
+  if (!channel) {
+    return result;
+  }
+
+  result.channel = channel.split('/')[0];
+  result.id = match[3];
+
+  if (result.channel === 'playlists') {
+    result.list = match[2];
+  }
+
+  return result;
+};
+
+Ted.prototype.parseMediaType = function(result) {
+  if (result.id && result.channel === 'playlists') {
+    delete result.channel;
+    result.mediaType = this.mediaTypes.PLAYLIST;
+  }
+  if (result.id && result.channel === 'talks') {
+    delete result.channel;
+    result.mediaType = this.mediaTypes.VIDEO;
+  }
+
+  return result;
+};
+
+Ted.prototype.parse = function(url, params) {
+  var result = {
+    params: params,
+  };
+
+  result = this.parseUrl(url, result);
+  result = this.parseMediaType(result);
+
+  if (!result.id) {
+    return undefined;
+  }
+
+  return result;
+};
+
+Ted.prototype.createLongUrl = function(vi, params) {
+  var url = '';
+
+  if (vi.mediaType === this.mediaTypes.VIDEO && vi.id) {
+    url += 'https://ted.com/talks/' + vi.id;
+  }
+  else if (vi.mediaType === this.mediaTypes.PLAYLIST && vi.id) {
+    url += 'https://ted.com/playlists/' + vi.list + '/' + vi.id;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+
+  return url;
+};
+
+Ted.prototype.createEmbedUrl = function(vi, params) {
+  var url = 'https://embed.ted.com/';
+
+  if (vi.mediaType === this.mediaTypes.PLAYLIST && vi.id) {
+    url += 'playlists/' + vi.list + '/' + vi.id;
+  }
+  else if (vi.mediaType === this.mediaTypes.VIDEO && vi.id) {
+    url += 'talks/' + vi.id;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+  return url;
+};
+
+require('../base').bind(new Ted());

package/lib/provider/tiktok.d.ts

@@ -0,0 +1,14 @@
+import { VideoInfo } from '../urlParser';
+
+export interface TiktokUrlParameters {
+    [key: string]: any;
+}
+
+export type TiktokMediaTypes = 'video';
+
+export interface TiktokVideoInfo extends VideoInfo<TiktokUrlParameters, TiktokMediaTypes> {
+    provider: 'tiktok';
+    channel: string;
+}
+
+export type TiktokParseResult = TiktokVideoInfo | undefined;

package/lib/provider/tiktok.js

@@ -0,0 +1,50 @@
+const {
+  combineParams,
+} = require('../util');
+
+function TikTok() {
+  this.provider = 'tiktok';
+  this.defaultFormat = 'long';
+  this.formats = {
+    long: this.createLongUrl,
+  };
+  this.mediaTypes = {
+    VIDEO: 'video',
+  };
+}
+
+module.exports = TikTok;
+
+TikTok.prototype.parse = function(url, params) {
+  var result = {
+    params: params,
+    mediaType: this.mediaTypes.VIDEO,
+  };
+
+  var match = url.match(/@([^/]+)\/video\/(\d{19})/);
+
+  if (!match) {
+    return;
+  }
+
+  result.channel = match[1];
+  result.id = match[2];
+
+  return result;
+};
+
+TikTok.prototype.createLongUrl = function(vi, params) {
+  var url = '';
+
+  if (vi.mediaType === this.mediaTypes.VIDEO && vi.id && vi.channel) {
+    url += `https://www.tiktok.com/@${vi.channel}/video/${vi.id}`;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+
+  return url;
+};
+
+require('../base').bind(new TikTok());

package/lib/provider/twitch.d.ts

@@ -0,0 +1,15 @@
+import { VideoInfo } from '../urlParser';
+
+export interface TwitchUrlParameters {
+    [key: string]: any;
+    start?: number;
+}
+
+export type TwitchMediaTypes = 'stream' | 'video' | 'clip';
+
+export interface TwitchVideoInfo extends VideoInfo<TwitchUrlParameters, TwitchMediaTypes> {
+    provider: 'twitch';
+    channel?: string;
+}
+
+export type TwitchParseResult = TwitchVideoInfo | undefined;

package/lib/provider/twitch.js

@@ -0,0 +1,150 @@
+const {
+  combineParams,
+  getTime,
+} = require('../util');
+
+function Twitch() {
+  this.provider = 'twitch';
+  this.defaultFormat = 'long';
+  this.formats = {
+    long: this.createLongUrl,
+    embed: this.createEmbedUrl,
+  };
+  this.mediaTypes = {
+    VIDEO: 'video',
+    STREAM: 'stream',
+    CLIP: 'clip',
+  };
+}
+
+module.exports = Twitch;
+
+Twitch.prototype.seperateId = function(id) {
+  return {
+    pre: id[0],
+    id: id.substr(1),
+  };
+};
+
+Twitch.prototype.parseChannel = function(result, params) {
+  var channel = params.channel || params.utm_content || result.channel;
+  delete params.utm_content;
+  delete params.channel;
+  return channel;
+};
+
+Twitch.prototype.parseUrl = function(url, result, params) {
+  var match;
+  match = url.match(
+    /(clips\.)?twitch\.tv\/(?:(?:videos\/(\d+))|(\w+(?:-[\w\d-]+)?)(?:\/clip\/(\w+))?)/i
+  );
+
+  if (match && match[2]) { //video
+    result.id = 'v' + match[2];
+  } else if (params.video) { //video embed
+    result.id = params.video;
+    delete params.video;
+  } else if (params.clip) { //clips embed
+    result.id = params.clip;
+    result.isClip = true;
+    delete params.clip;
+  } else if (match && match[1] && match[3]) { //clips.twitch.tv/id
+    result.id = match[3];
+    result.isClip = true;
+  } else if (match && match[3] && match[4]) { //twitch.tv/channel/clip/id
+    result.channel = match[3];
+    result.id = match[4];
+    result.isClip = true;
+  } else if (match && match[3]) {
+    result.channel = match[3];
+  }
+  return result;
+};
+
+Twitch.prototype.parseMediaType = function(result) {
+  var mediaType;
+  if (result.id) {
+    if (result.isClip) {
+      mediaType = this.mediaTypes.CLIP;
+      delete result.isClip;
+    } else {
+      mediaType = this.mediaTypes.VIDEO;
+    }
+  } else if (result.channel) {
+    mediaType = this.mediaTypes.STREAM;
+  }
+  return mediaType;
+};
+
+Twitch.prototype.parseParameters = function(params) {
+  if (params.t) {
+    params.start = getTime(params.t);
+    delete params.t;
+  }
+  return params;
+};
+
+Twitch.prototype.parse = function(url, params) {
+  var _this = this;
+  var result = {};
+  result = _this.parseUrl(url, result, params);
+  result.channel = _this.parseChannel(result, params);
+  result.mediaType = _this.parseMediaType(result);
+  result.params = _this.parseParameters(params);
+  return result.channel || result.id ? result : undefined;
+};
+
+Twitch.prototype.createLongUrl = function(vi, params) {
+  var url = '';
+
+  if (vi.mediaType === this.mediaTypes.STREAM && vi.channel) {
+    url = 'https://twitch.tv/' + vi.channel;
+  }
+  else if (vi.mediaType === this.mediaTypes.VIDEO && vi.id) {
+    var sep = this.seperateId(vi.id);
+    url = 'https://twitch.tv/videos/' + sep.id;
+    if (params.start) {
+      params.t = params.start + 's';
+      delete params.start;
+    }
+  }
+  else if (vi.mediaType === this.mediaTypes.CLIP && vi.id) {
+    if (vi.channel) {
+      url = 'https://www.twitch.tv/' + vi.channel + '/clip/' + vi.id;
+    } else {
+      url = 'https://clips.twitch.tv/' + vi.id;
+    }
+  } else {
+    return undefined;
+  }
+  url += combineParams(params);
+
+  return url;
+};
+
+Twitch.prototype.createEmbedUrl = function(vi, params) {
+  var url = 'https://player.twitch.tv/';
+
+  if (vi.mediaType === this.mediaTypes.STREAM && vi.channel) {
+    params.channel = vi.channel;
+  }
+  else if (vi.mediaType === this.mediaTypes.VIDEO && vi.id) {
+    params.video = vi.id;
+    if (params.start) {
+      params.t = params.start + 's';
+      delete params.start;
+    }
+  }
+  else if (vi.mediaType === this.mediaTypes.CLIP && vi.id) {
+    url = 'https://clips.twitch.tv/embed';
+    params.clip = vi.id;
+  } else {
+    return undefined;
+  }
+
+  url += combineParams(params);
+
+  return url;
+};
+
+require('../base').bind(new Twitch());

package/lib/provider/vimeo.d.ts

@@ -0,0 +1,14 @@
+import { VideoInfo } from '../urlParser';
+
+export interface VimeoUrlParameters {
+    [key: string]: any;
+    start?: number;
+}
+
+export type VimeoMediaTypes = 'video';
+
+export interface VimeoVideoInfo extends VideoInfo<VimeoUrlParameters, VimeoMediaTypes> {
+    provider: 'vimeo';
+}
+
+export type VimeoParseResult = VimeoVideoInfo | undefined;

package/lib/provider/vimeo.js

@@ -0,0 +1,89 @@
+const { combineParams, getTime } = require('../util');
+
+function Vimeo() {
+  this.provider = 'vimeo';
+  this.alternatives = ['vimeopro'];
+  this.defaultFormat = 'long';
+  this.formats = {
+    long: this.createLongUrl,
+    embed: this.createEmbedUrl,
+  };
+  this.mediaTypes = {
+    VIDEO: 'video',
+  };
+}
+
+module.exports = Vimeo;
+
+Vimeo.prototype.parseUrl = function(url) {
+  var match = url.match(
+    /(?:\/showcase\/\d+)?(?:\/(?:channels\/[\w]+|(?:(?:album\/\d+|groups\/[\w]+)\/)?videos?))?\/(\d+)/i
+  );
+  return match ? match[1] : undefined;
+};
+
+Vimeo.prototype.parseHash = function(url) {
+  var match = url.match(/\/\d+\/(\w+)$/i);
+  return match ? match[1] : undefined;
+};
+
+Vimeo.prototype.parseParameters = function(params) {
+  if (params.t) {
+    params.start = getTime(params.t);
+    delete params.t;
+  }
+  if (params.h) {
+    params.hash = params.h;
+    delete params.h;
+  }
+  return params;
+};
+
+Vimeo.prototype.parse = function(url, params) {
+  var result = {
+    mediaType: this.mediaTypes.VIDEO,
+    params: this.parseParameters(params),
+    id: this.parseUrl(url),
+  };
+  var hash = this.parseHash(url, params);
+  if (hash) {
+    result.params.hash = hash;
+  }
+  return result.id ? result : undefined;
+};
+
+Vimeo.prototype.createUrl = function(baseUrl, vi, params, type) {
+  if (!vi.id || vi.mediaType !== this.mediaTypes.VIDEO) {
+    return undefined;
+  }
+
+  var url = baseUrl + vi.id;
+  var startTime = params.start;
+  delete params.start;
+
+  if (params.hash) {
+    if (type === 'embed') {
+      params.h = params.hash;
+    } else if (type === 'long') {
+      url += '/' + params.hash;
+    }
+    delete params.hash;
+  }
+
+  url += combineParams(params);
+
+  if (startTime) {
+    url += '#t=' + startTime;
+  }
+  return url;
+};
+
+Vimeo.prototype.createLongUrl = function(vi, params) {
+  return this.createUrl('https://vimeo.com/', vi, params, 'long');
+};
+
+Vimeo.prototype.createEmbedUrl = function(vi, params) {
+  return this.createUrl('//player.vimeo.com/video/', vi, params, 'embed');
+};
+
+require('../base').bind(new Vimeo());