Skip to content

Commit 3772401

Browse files
committed
wip: missed merge changes
1 parent e1df70a commit 3772401

File tree

8 files changed

+50
-12
lines changed

8 files changed

+50
-12
lines changed

.github/workflows/node.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,6 @@ jobs:
758758
CI: true
759759
- name: Run check
760760
run: |
761-
node scripts/checkForMultipleVersions.mjs
761+
yarn validate:versions
762762
env:
763763
CI: true

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"meteor:run": "cd meteor && yarn start",
2626
"lint": "run lint:meteor && run lint:packages",
2727
"unit": "run unit:meteor && run unit:packages",
28-
"validate:release": "yarn install && run install-and-build && run validate:release:packages && run validate:release:meteor",
28+
"validate:release": "yarn install && run install-and-build && run validate:versions && run validate:release:packages && run validate:release:meteor",
2929
"validate:release:meteor": "cd meteor && yarn validate:prod-dependencies && yarn license-validate && yarn lint && yarn test",
3030
"validate:release:packages": "cd packages && run validate:dependencies && run test",
3131
"meteor": "cd meteor && meteor",
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_label: URL Query Parameters
3+
sidebar_position: 10
4+
---
5+
6+
# URL Query Parameters
7+
Appending query parameter(s) to the URL will allow you to modify the behaviour of the GUI, as well as control the [Access Levels](../user-guide/features/access-levels.md).
8+
9+
| Query Parameter | Description |
10+
| :---------------------------------- | :------------------------------------------------------------------------ |
11+
| `admin=1` | Gives the GUI the same access as the combination of [Configuration Mode](../user-guide/features/access-levels.md#Configuration-Mode) and [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) as well as having access to a set of [Testing Mode](../user-guide/features/access-levels.md#Testing-Mode) tools and a Manual Control section on the Rundown page. _Default value is `0`._ |
12+
| `studio=1` | [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) gives the GUI full control of the studio and all information associated to it. This includes allowing actions like activating and deactivating rundowns, taking parts, adlibbing, etcetera. _Default value is `0`._ |
13+
| `buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. |
14+
| `develop=1` | Enables the browser's default right-click menu to appear. It will also reveal the _Manual Control_ section on the Rundown page. _Default value is `0`._ |
15+
| `display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). |
16+
| `help=1` | Enables some tooltips that might be useful to new users. _Default value is `0`._ |
17+
| `ignore_piece_content_status=1` | Removes the "zebra" marking on VT pieces that have a "missing" status. _Default value is `0`._ |
18+
| `reportNotificationsId=1,...` | Sets a specific ID of the client GUI. Useful for troubleshooting since this ID shows up in _Sofie Core_'s log. _Default value is "0", which disables the feature and uses a user-defined string (user as-in whoever is opening the client GUI, not necessarily the actual end-user)._ |
19+
| `shelffollowsonair=1` | _Default value is `0`._ |
20+
| `show_hidden_source_layers=1` | _Default value is `0`._ |
21+
| `speak=1` | Experimental feature that starts playing an audible countdown 10 seconds before each planned _Take_. _Default value is `0`._ |
22+
| `vibrate=1` | Experimental feature that triggers the vibration API in the web browser 3 seconds before each planned _Take_. _Default value is `0`._ |
23+
| `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ |
24+

packages/documentation/docs/user-guide/features/access-levels.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,24 @@ There are some additional url parameters that can be used to simplify the granti
4040
- `?help=1` will enable some tooltips that might be useful to new users.
4141
- `?admin=1` will give the user the same access as the _Configuration_ and _Studio_ modes as well as having access to a set of _Test Tools_ and a _Manual Control_ section on the Rundown page.
4242

43+
#### See Also
44+
45+
[URL Query Parameters](../../for-developers/url-query-parameters.md)
46+
4347
### Header based
4448

4549
:::danger
4650

47-
This mode is very new and could have some undiscovered holes.
51+
This mode is very new and could have some undiscovered holes.
4852
It is known that secrets can be leaked to all clients who can connect to Sofie, which is not desirable.
4953

5054
:::
5155

52-
In this mode, we rely on Sofie being run behind a reverse-proxy which will inform Sofie of the permissions of each connection. This allows you to use your organisations preferred auth provider, and translate that into something that Sofie can understand.
56+
In this mode, we rely on Sofie being run behind a reverse-proxy which will inform Sofie of the permissions of each connection. This allows you to use your organisations preferred auth provider, and translate that into something that Sofie can understand.
5357
To enable this mode, you need to enable the `enableHeaderAuth` property in the [settings file](../configuration/sofie-core-settings.md)
5458

55-
Sofie expects that for each DDP connection or http request, the `dnt` header will be set containing a comma separated list of the levels from the above table. If the header is not defined or is empty, the connection will have view-only access to Sofie.
56-
This header can also contain simply `admin` to grant the connection permission to everything.
59+
Sofie expects that for each DDP connection or http request, the `dnt` header will be set containing a comma separated list of the levels from the above table. If the header is not defined or is empty, the connection will have view-only access to Sofie.
60+
This header can also contain simply `admin` to grant the connection permission to everything.
5761
We are using the `dnt` header due to limitations imposed by Meteor, but intend this to become a proper header name in a future release.
5862

5963
When in this mode, you should make sure that Sofie can only be accessed through the reverse proxy, and that the reverse-proxy will always override any value sent by a client.

packages/openapi/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"name": "@sofie-automation/openapi",
33
"version": "1.52.0-in-development",
4-
"private": true,
54
"license": "MIT",
65
"repository": {
76
"type": "git",

packages/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"build": "lerna run build --ignore @sofie-automation/openapi",
2020
"build:try": "lerna run --no-bail build --ignore @sofie-automation/openapi",
2121
"watch": "lerna run --parallel build:main --ignore @sofie-automation/openapi -- --watch --preserveWatchOutput",
22-
"stage-versions": "git add -u */package.json */CHANGELOG.md lerna.json yarn.lock",
22+
"stage-versions": "git add -u \"*/package.json\" \"*/CHANGELOG.md\" lerna.json yarn.lock",
2323
"set-version": "lerna version --exact --no-changelog --no-git-tag-version --no-push --yes",
2424
"set-version-and-commit": "lerna version --exact --no-changelog --no-changelog --no-commit-hooks --force-publish='*' --no-push --yes",
2525
"set-version-and-changelog": "lerna version --exact --force-publish --conventional-commits --no-git-tag-version --no-push --yes",

packages/webui/src/client/collections/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import { RundownBaselineAdLibAction } from '@sofie-automation/corelib/dist/dataM
4141
import { RundownBaselineAdLibItem } from '@sofie-automation/corelib/dist/dataModel/RundownBaselineAdLibPiece'
4242
import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
4343
import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
44-
import { DBNotificationObj } from '@sofie-automation/corelib/dist/dataModel/Notifications'
44+
import type { DBNotificationObj } from '@sofie-automation/corelib/dist/dataModel/Notifications'
4545

4646
export const AdLibActions = createSyncReadOnlyMongoCollection<AdLibAction>(CollectionName.AdLibActions)
4747

scripts/checkForMultipleVersions.mjs

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
import { buildDepTreeFromFiles } from "snyk-nodejs-lockfile-parser";
22

3+
function hr() {
4+
// write regular dashes if this is a "simple" output stream ()
5+
if (!process.stdout.hasColors || !process.stdout.hasColors())
6+
return "-".repeat(process.stdout.columns ?? 40);
7+
return '─'.repeat(process.stdout.columns ?? 40)
8+
}
9+
310
/**
411
* These are the libs we want to consider.
512
* Its an array of arrays, to allow for multiple names to be treated as one package
@@ -58,6 +65,10 @@ await addDepsForRoot("./packages", "live-status-gateway");
5865

5966
let hasFailure = false;
6067

68+
console.log(hr())
69+
console.log(" 🔢 Checking dependency version consistency...")
70+
console.log(hr())
71+
6172
// check each library
6273
for (const libName of libsToConsider) {
6374
const allVersions = new Set();
@@ -73,11 +84,11 @@ for (const libName of libsToConsider) {
7384
// output some info
7485
const str = Array.from(allVersions).join(", ");
7586
if (allVersions.size === 0) {
76-
console.log(`No versions of "${nameStr}" installed`);
87+
console.log(`No versions of "${nameStr}" installed`);
7788
} else if (allVersions.size === 1) {
78-
console.log(`Single version of "${nameStr}" installed: ${str}`);
89+
console.log(`Single version of "${nameStr}" installed: ${str}`);
7990
} else {
80-
console.error(`Multiple versions of "${nameStr}" installed: ${str}`);
91+
console.error(`⚠️ Multiple versions of "${nameStr}" installed: ${str}`);
8192
hasFailure = true;
8293
}
8394
}

0 commit comments

Comments
 (0)