Skip to content

Commit 972d418

Browse files
committed
Renamed to MediaURL
1 parent cdf0413 commit 972d418

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+199
-360
lines changed
+7-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
2-
name: WATCHED issue, idea or request
3-
about: Anything related to the WATCHED SDK or our app
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: MediaURL issue, idea or request
3+
about: Anything related to the MediaURL SDK or our app
4+
title: ""
5+
labels: ""
6+
assignees: ""
87
---
98

109
Please describe your issue in as much detail as possible.
1110

12-
- **Only** post issues related to the WATCHED app or the WATCHED SDK.
11+
- **Only** post issues related to the MediaURL SDK.
1312

1413
- We do **not** give support for **3rd party addons**. Try to contact the addon creator.
1514

16-
- If you have an issue with one of [official addons](https://github.com/watchedcom) create an issue in the corresponding repo.
15+
- If you have an issue with one of [official addons](https://github.com/mediaurl) create an issue in the corresponding repo.

Diff for: CHANGELOG.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- Added `SetResultError` to set cache results in a different way. For more infos, see the code documentation.
88
- Added IPTV category property and default filter values
9-
- Removed the `@watchedcom/create` package
9+
- Removed the `@mediaurl/create` package
1010
- Removed the `watched-sdk` command line tool
1111
- Added experimental `FetchAgent`
1212

@@ -17,7 +17,7 @@
1717
- Dropping legacy Node.js versions (=> 12.9 is now required)
1818
- Added similar item system for items. See the `similarItem` property. Similar items will be displayed as horizontal lists below movie, series or channel items.
1919
- Created `toast` task to display toast messages inside the app (see `ctx.toast`)
20-
- Created `notification` task to display notifications with various options inside the app (see `ctx.notification`). Notifications can be displayed once every 30 minute per addon. You can set the `url` property to open an URL when the user clicks on the notification. WATCHED sharing URL's are handled internally, so you can promote for example an item or addon.
20+
- Created `notification` task to display notifications with various options inside the app (see `ctx.notification`). Notifications can be displayed once every 30 minute per addon. You can set the `url` property to open an URL when the user clicks on the notification. MediaURL sharing URL's are handled internally, so you can promote for example an item or addon.
2121
- Various bugfixes and improvments
2222

2323
### Upgrade instructions
@@ -45,8 +45,8 @@ with
4545
### Legacy
4646

4747
- The `watched-sdk` command line tool will be legacy starting with v0.32
48-
- The [`@watchedcom/create`](packages/create) command line tool is printing a legacy message
49-
- The `testAddon` function in [`@watchedcom/test`](packages/test) is printing a legacy message when it's used
48+
- The [`@mediaurl/create`](packages/create) command line tool is printing a legacy message
49+
- The `testAddon` function in [`@mediaurl/test`](packages/test) is printing a legacy message when it's used
5050

5151
### Upgrade instructions
5252

@@ -74,7 +74,7 @@ Since the `watched-sdk` command is legacy, you can't export your addons anymore.
7474
- **`src/index.ts`**
7575

7676
```ts
77-
import { runCli } from "@watchedcom/sdk";
77+
import { runCli } from "@mediaurl/sdk";
7878

7979
// Your code here
8080

Diff for: README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# WATCHED.com SDK and tools
1+
# MediaURL SDK and tools
22

3-
This monorepo includes all javascript modules needed to create addons for [WATCHED](https://www.watched.com/).
3+
This monorepo includes all javascript modules needed to create _MediaURL_ addons.
44

55
## Getting started
66

7-
In best way to create your own WATCHED addon is by cloning our example addon and modify it.
7+
In best way to create your own MediaURL addon is by cloning our example addon and modify it.
88

99
### Prerequisites
1010

@@ -14,10 +14,10 @@ In best way to create your own WATCHED addon is by cloning our example addon and
1414

1515
### Cloning the example addon
1616

17-
The best way to start is to clone our [watched-addon-example](https://github.com/watchedcom/watched-addon-example) addon:
17+
The best way to start is to clone our [mediaurl-addon-example](https://github.com/mediaurl/mediaurl-addon-example) addon:
1818

1919
```shell
20-
git clone https://github.com/watchedcom/watched-addon-example.git my-addon
20+
git clone https://github.com/mediaurl/mediaurl-addon-example.git my-addon
2121
```
2222

2323
Now open the created folder `my-addon` with your editor.
@@ -37,7 +37,7 @@ npm run develop
3737
You should see something like this:
3838

3939
```
40-
> watched[email protected] develop /home/myname/my-addon
40+
> mediaurl[email protected] develop /home/myname/my-addon
4141
> ts-node-dev --transpileOnly src
4242
4343
Using ts-node version 8.9.1, typescript version 3.8.3
@@ -48,9 +48,9 @@ Listening on 3000
4848

4949
**2. Enable developer mode**
5050

51-
In order to install addons in the WATCHED app, you first need to _unlock_ it:
51+
In order to install addons in the MediaURL app, you first need to _unlock_ it:
5252

53-
1. Open the WATCHED app, go to settings and make sure the **Developer mode** is enabled.
53+
1. Open the MediaURL app, go to settings and make sure the **Developer mode** is enabled.
5454
2. Go to the addon manager and deactivate the bundle addon if there is one active.
5555
3. To make things more clean and easy, disabled all currently activated addons.
5656

@@ -88,7 +88,7 @@ Please also check out our object schema here: https://www.watched.com/swagger
8888

8989
## Deploy your addon
9090

91-
Please check our deployment documentation at [docs/deployment.md](https://github.com/watchedcom/watched-js/blob/master/docs/deployment.md).
91+
Please check our deployment documentation at [docs/deployment.md](https://github.com/mediaurl/mediaurl-js/blob/master/docs/deployment.md).
9292

9393
## Tips for development and testing
9494

@@ -121,7 +121,7 @@ npm run develop -- replay test-session --watch
121121
Create a test case file, for example `src/record.test.ts`:
122122

123123
```javascript
124-
import { replayRecordFile } from "@watchedcom/sdk";
124+
import { replayRecordFile } from "@mediaurl/sdk";
125125
import { yourAddon } from "./index";
126126

127127
test(`Replay recorded actions`, (done) => {
@@ -143,7 +143,7 @@ We offer a very flexible caching solution for your addon. Please see [docs/cachi
143143

144144
## Translate your addon
145145

146-
For some suggestions regarding translations, please see either our `@watchedcom/i18n` package found inside [packages/i18n](packages/i18n), or the documentation at [docs/translations.md](docs/translations.md).
146+
For some suggestions regarding translations, please see either our `@mediaurl/i18n` package found inside [packages/i18n](packages/i18n), or the documentation at [docs/translations.md](docs/translations.md).
147147

148148
## Developing on this repo
149149

Diff for: docs/caching.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A cache which uses the file system for storage. This is the most easy to setup c
1919
To enable this, set the environment variable `DISK_CACHE` to a path.
2020

2121
```shell
22-
export DISK_CACHE=/data/watched-cache
22+
export DISK_CACHE=/data/mediaurl-cache
2323
npm run develop
2424
```
2525

Diff for: docs/deployment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deployment guide
22

3-
Instructions on how to deploy a WATCHED addon to various hosting providers.
3+
Instructions on how to deploy a MediaURL addon to various hosting providers.
44

55
- [Heroku](#Heroku)
66

@@ -37,7 +37,7 @@ Go to your addon directory, then run the following code:
3737

3838
```shell
3939
# Add files related to vercel
40-
$ npx @watchedcom/create init-vercel
40+
$ npx @mediaurl/create init-vercel
4141

4242
# Link project
4343
$ now

Diff for: docs/translations.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This type supports either a string of text, or a mapping of language=>text pairs
1818
}
1919
```
2020

21-
## Using `@watchedcom/i18n`
21+
## Using `@mediaurl/i18n`
2222

2323
Short after this documentation was written, I created a little helper module for `i18next`. Please see the documentation at `packages/i18n/README.md`.
2424

@@ -43,7 +43,7 @@ i18next.use(
4343
new FsBackend(null, {
4444
loadPath: path.join("locales", "{{lng}}", "{{ns}}.json"),
4545
addPath: path.join("locales", "{{lng}}", "{{ns}}.missing.json"),
46-
jsonIndent: 2
46+
jsonIndent: 2,
4747
})
4848
);
4949

@@ -55,7 +55,7 @@ i18next.init({
5555
defaultNS: "your-addon-id",
5656
load: "languageOnly",
5757
saveMissing: true,
58-
updateMissing: true
58+
updateMissing: true,
5959
});
6060

6161
export const i18n = i18next;
@@ -143,23 +143,23 @@ After this you can deploy your addon without using locize. This has many benefit
143143
Imagine you want to translate the `name` property of this addon:
144144
145145
```javascript
146-
import { createWorkerAddon } from "@watchedcom/sdk";
146+
import { createWorkerAddon } from "@mediaurl/sdk";
147147

148148
export const myAddon = createWorkerAddon({
149149
id: "i18n-example",
150-
name: "Name of this addon"
150+
name: "Name of this addon",
151151
});
152152
```
153153
154154
We created a helper function named `translateDeep` for cases like this. This function works similar to the `lodash.cloneDeep` function, but translates all strings beginning with a specific prefix (by default `i18n:`) using the `t` parameter.
155155
156156
```javascript
157-
import { createWorkerAddon, translateDeep } from "@watchedcom/sdk";
157+
import { createWorkerAddon, translateDeep } from "@mediaurl/sdk";
158158
import { i18n } from "./i18n";
159159

160160
export const myAddon = createWorkerAddon({
161161
id: "i18n-example",
162-
name: "i18n:Name of this addon"
162+
name: "i18n:Name of this addon",
163163
});
164164

165165
myAddon.registerActionHandler("addon", async (input, ctx, addon) => {

Diff for: package-lock.json

+52-41
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: packages/example/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# WATCHED SDK example addon
1+
# MediaURL SDK example addon
22

33
This example repository is more for testing the SDK inside this monorepo than for a real world example.
44

5-
If you are looking for a good example addon, please check out the [watched-addon-example](https://github.com/watchedcom/watched-addon-example) repository.
5+
If you are looking for a good example addon, please check out the [mediaurl-addon-example](https://github.com/mediaurl/mediaurl-addon-example) repository.

0 commit comments

Comments
 (0)