All files / src/app/test-controller/interfaces verona.interfaces.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
type Verona2NavigationTarget = 'next' | 'previous' | 'first' | 'last' | 'end';
 
type Verona2LogPolicy = 'disabled' | 'lean' | 'rich' | 'debug';
 
type Verona2StateReportPolicy = 'none' | 'eager' | 'on-demand';
 
type Verona3PagingMode = 'separate' | 'concat-scroll' | 'concat-scroll-snap';
 
interface Verona2PlayerConfig {
  logPolicy: Verona2LogPolicy;
  pagingMode: Verona3PagingMode;
  unitNumber: number;
  unitTitle: string;
  unitId: string;
}
 
interface Verona3PlayerConfig extends Verona2PlayerConfig {
  enabledNavigationTargets: Verona2NavigationTarget[];
  startPage?: string | number;
  stateReportPolicy: Verona2StateReportPolicy; // removed in Verona4, but we still need it to support older players
}
 
interface Verona4PlayerConfig extends Verona3PlayerConfig {
  directDownloadUrl?: string;
}
 
type Verona3NavigationDeniedReason = 'presentationIncomplete' | 'responsesIncomplete';
 
type Verona3Progress = 'none' | 'some' | 'complete';
 
export { Verona4PlayerConfig as VeronaPlayerConfig };
export { Verona2NavigationTarget as VeronaNavigationTarget };
export { Verona3NavigationDeniedReason as VeronaNavigationDeniedReason };
export { Verona3Progress as VeronaProgress };
 
export interface Verona5ValidPages {
  [id: string]: string
}
 
export interface Verona6ValidPage {
  id: string;
  label?: string;
}
 
export type Verona6ValidPages = Array<Verona6ValidPage>;
 
// those are just a proposal and not in any Verona-Standard right now
export const VeronaPlayerRuntimeErrorCodes = [
  'session-id-missing',
  'unit-definition-missing',
  'wrong-session-id',
  'unit-definition-type-unsupported',
  'unit-state-type-unsupported',
  'runtime-error'
];