cpvalente/ontime
1
0
Fork 0
mirror of https://github.com/cpvalente/ontime.git synced 2026-08-13 03:13:47 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

feat: lots of renaming

Browse Source
This commit is contained in:
Ary
2024-02-25 11:32:53 -07:00
parent 257f2259e0
commit 1bc6c3e852
11 changed files with 87 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/server/src/controllers/ontimeController.ts
+8 -8
View File
@@ -159,16 +159,16 @@ export const getInfo = async (_req: Request, res: Response<GetInfo>) => {
});
};
// Create controller for POST request to '/ontime/aliases'
// Create controller for POST request to '/ontime/presets'
// Returns -
export const getAliases = async (_req: Request, res: Response) => {
export const getPresets = async (_req: Request, res: Response) => {
const aliases = DataProvider.getAliases();
res.status(200).send(aliases);
};
// Create controller for POST request to '/ontime/aliases'
// Create controller for POST request to '/ontime/presets'
// Returns ACK message
export const postAlias = async (req: Request, res: Response) => {
export const postPreset = async (req: Request, res: Response) => {
try {
const newAlias = {
enabled: req.body.enabled,
@@ -183,9 +183,9 @@ export const postAlias = async (req: Request, res: Response) => {
}
};
// Update controller for PUT request to '/ontime/aliases'
// Update controller for PUT request to '/ontime/presets/:preset'
// Returns ACK message
export const updateAliases = async (req: Request, res: Response) => {
export const updatePreset = async (req: Request, res: Response) => {
try {
const { alias, enabled, pathAndParams } = req.body;
@@ -211,9 +211,9 @@ export const updateAliases = async (req: Request, res: Response) => {
}
};
// Delete controller for DELETE request to '/ontime/aliases/:alias'
// Delete controller for DELETE request to '/ontime/presets/:preset'
// Returns ACK message
export const deleteAlias = async (req: Request, res: Response) => {
export const deletePreset = async (req: Request, res: Response) => {
try {
const alias = req.params.alias;
apps/server/src/controllers/ontimeController.validate.ts
+7 -7
View File
@@ -24,9 +24,9 @@ export const viewValidator = [
];
/**
* @description Validates object for POST /ontime/aliases
* @description Validates object for POST /ontime/presets
*/
export const validateAliases = [
export const validatePresets = [
body().isArray(),
body('*.enabled').isBoolean(),
body('*.alias').isString().trim(),
@@ -40,9 +40,9 @@ export const validateAliases = [
];
/**
* @description Validates object for POST /ontime/aliases
* @description Validates object for POST /ontime/presets
*/
export const validateCreateAlias = [
export const validateCreatePreset = [
body('alias').isString().trim(),
body('pathAndParams').isString().trim(),
body('enabled').isBoolean(),
@@ -55,9 +55,9 @@ export const validateCreateAlias = [
];
/**
* @description Validates object for PUT /ontime/aliases
* @description Validates object for PUT /ontime/presets
*/
export const validateUpdateAlises = [
export const validateUpdatePreset = [
body('alias').isString().trim(),
body('pathAndParams').isString().trim().optional(),
body('enabled').isBoolean().optional(),
@@ -151,7 +151,7 @@ export const validatePatchProjectFile = [
body('project').isObject().optional({ nullable: false }),
body('settings').isObject().optional({ nullable: false }),
body('viewSettings').isObject().optional({ nullable: false }),
body('aliases').isArray().optional({ nullable: false }),
body('aliases').isArray().optional({ nullable: false }), // TODO
body('userFields').isObject().optional({ nullable: false }),
body('osc').isObject().optional({ nullable: false }),
apps/server/src/routes/ontimeRouter.ts
+10 -10
View File
@@ -3,7 +3,6 @@ import { uploadFile } from '../utils/upload.js';
import {
dbDownload,
dbUpload,
getAliases,
getInfo,
getOSC,
getHTTP,
@@ -31,9 +30,10 @@ import {
postId,
getAuthentication,
getClientSecrect as getClientSecret,
updateAliases,
deleteAlias,
postAlias,
postPreset,
updatePreset,
deletePreset,
getPresets,
} from '../controllers/ontimeController.js';
import {
@@ -49,8 +49,8 @@ import {
validateSheetid,
validateWorksheet,
validateSheetOptions,
validateUpdateAlises,
validateCreateAlias,
validateCreatePreset,
validateUpdatePreset,
} from '../controllers/ontimeController.validate.js';
import { projectSanitiser } from '../controllers/projectController.validate.js';
import { sanitizeProjectFilename } from '../utils/sanitizeProjectFilename.js';
@@ -85,16 +85,16 @@ router.get('/views', getViewSettings);
router.post('/views', viewValidator, postViewSettings);
// create route between controller and '/ontime/aliases' endpoint
router.get('/aliases', getAliases);
router.get('/presets', getPresets);
// create route between controller and '/ontime/aliases' endpoint
router.post('/aliases', validateCreateAlias, postAlias);
router.post('/presets', validateCreatePreset, postPreset);
// create route between controller and /ontime/aliases' endpoint
router.put('/aliases', validateUpdateAlises, updateAliases);
router.put('/presets', validateUpdatePreset, updatePreset);
// create route between controller and '/ontime/aliases' endpoint
router.delete('/aliases/:alias', deleteAlias);
router.delete('/presets/:preset', deletePreset);
// create route between controller and '/ontime/aliases' endpoint
router.get('/userfields', getUserFields);
apps/server/src/utils/parser.ts
+2
View File
@@ -37,6 +37,7 @@ import {
parseSettings,
parseUserFields,
parseViewSettings,
parsePresets,
} from './parserFunctions.js';
import { parseExcelDate } from './time.js';
import { configService } from '../services/ConfigService.js';
@@ -329,6 +330,7 @@ export const parseJson = async (jsonData: Partial<DatabaseModel>): Promise<Datab
settings: parseSettings(jsonData) ?? dbModel.settings,
viewSettings: parseViewSettings(jsonData) ?? dbModel.viewSettings,
aliases: parseAliases(jsonData),
presets: parsePresets(jsonData),
userFields: parseUserFields(jsonData),
osc: parseOsc(jsonData) ?? dbModel.osc,
http: parseHttp(jsonData) ?? dbModel.http,
apps/server/src/utils/parserFunctions.ts
+27
View File
@@ -15,6 +15,7 @@ import {
isOntimeBlock,
isOntimeCycle,
HttpSubscription,
Presets,
} from 'ontime-types';
import { block as blockDef, delay as delayDef } from '../models/eventsDefinition.js';
@@ -250,6 +251,32 @@ export const parseAliases = (data): Alias[] => {
return newAliases;
};
/**
* Parse presets portion of an entry
* @param {object} data - data object
* @returns {object} - event object data
*/
export const parsePresets = (data): Presets => {
const newPresets: { [key: string]: { alias: string; pathAndParams: string; enabled: boolean } } = {};
if ('presets' in data) {
console.log('Found Presets definition, importing...');
try {
for (const preset in data.presets) {
const newPreset = {
alias: data.presets[preset].alias,
pathAndParams: data.presets[preset].pathAndParams,
enabled: data.presets[preset].enabled,
};
newPresets[preset] = newPreset;
}
console.log(`Uploaded ${Object.keys(newPresets).length} preset(s)`);
} catch (error) {
console.log(`Error: ${error}`);
}
}
return newPresets;
};
/**
* Parse userFields entry
* @param {object} data - data object
apps/server/test-db/db.json
+7
View File
@@ -436,6 +436,13 @@
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
],
"presets": {
"test": {
"enabled": true,
"preset": "test",
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
},
"userFields": {
"user0": "user0",
"user1": "user1",
demo-db/db.json
+7
View File
@@ -436,6 +436,13 @@
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
],
"presets": {
"test": {
"enabled": true,
"preset": "test",
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
},
"userFields": {
"user0": "user0",
"user1": "user1",
e2e/tests/fixtures/test-db.json
Vendored
+7
View File
@@ -436,6 +436,13 @@
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
],
"presets": {
"test": {
"enabled": true,
"preset": "test",
"pathAndParams": "lower?bg=ff2&text=f00&size=0.6&transition=5"
}
},
"userFields": {
"user0": "user0",
"user1": "user1",
packages/types/src/definitions/DataModel.type.ts
+2
View File
@@ -6,6 +6,7 @@ import { Settings } from './core/Settings.type.js';
import { UserFields } from './core/UserFields.type.js';
import { ViewSettings } from './core/Views.type.js';
import { HttpSettings } from '../index.js';
import { Presets } from './core/Presets.type.js';
export type DatabaseModel = {
rundown: OntimeRundown;
@@ -13,6 +14,7 @@ export type DatabaseModel = {
settings: Settings;
viewSettings: ViewSettings;
aliases: Alias[];
presets: Presets;
userFields: UserFields;
osc: OSCSettings;
http: HttpSettings;
packages/types/src/definitions/core/Presets.type.ts
+7
View File
@@ -0,0 +1,7 @@
export type Presets = {
[key: string]: {
alias: string;
pathAndParams: string;
enabled: boolean;
};
};
packages/types/src/index.ts
+3
View File
@@ -27,6 +27,9 @@ export type { TimeFormat } from './definitions/core/TimeFormat.type.js';
// ---> Aliases
export type { Alias } from './definitions/core/Alias.type.js';
// ---> Presets
export type { Presets } from './definitions/core/Presets.type.js';
// ---> User Fields
export type { UserFields } from './definitions/core/UserFields.type.js';