@easyedu/js-lsm-api 1.90.0 → 1.91.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +15 -2
  3. package/dist/apis/PlayerApi.d.ts +115 -1
  4. package/dist/apis/PlayerApi.js +213 -1
  5. package/dist/esm/apis/PlayerApi.d.ts +115 -1
  6. package/dist/esm/apis/PlayerApi.js +212 -0
  7. package/dist/esm/models/GetResourceSession.d.ts +30 -0
  8. package/dist/esm/models/GetResourceSession.js +16 -0
  9. package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +76 -0
  10. package/dist/esm/models/GetResourceSessionDiagnostics.js +69 -0
  11. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  12. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.js +76 -0
  13. package/dist/esm/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  14. package/dist/esm/models/GetResourceSessionDiagnosticsResource.js +56 -0
  15. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  16. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.js +59 -0
  17. package/dist/esm/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  18. package/dist/esm/models/GetResourceSessionDiagnosticsUser.js +47 -0
  19. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  20. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.js +67 -0
  21. package/dist/esm/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  22. package/dist/esm/models/GetResourceSessionScormApiLogs.js +60 -0
  23. package/dist/esm/models/GetResourceSessionScormData.d.ts +77 -0
  24. package/dist/esm/models/GetResourceSessionScormData.js +66 -0
  25. package/dist/esm/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  26. package/dist/esm/models/GetResourceSessionScormDataActivity.js +45 -0
  27. package/dist/esm/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  28. package/dist/esm/models/ResourceSessionScormApiLogItem.js +73 -0
  29. package/dist/esm/models/index.d.ts +10 -0
  30. package/dist/esm/models/index.js +10 -0
  31. package/dist/models/GetResourceSession.d.ts +30 -0
  32. package/dist/models/GetResourceSession.js +16 -0
  33. package/dist/models/GetResourceSessionDiagnostics.d.ts +76 -0
  34. package/dist/models/GetResourceSessionDiagnostics.js +76 -0
  35. package/dist/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  36. package/dist/models/GetResourceSessionDiagnosticsCourseContext.js +83 -0
  37. package/dist/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  38. package/dist/models/GetResourceSessionDiagnosticsResource.js +63 -0
  39. package/dist/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  40. package/dist/models/GetResourceSessionDiagnosticsScormSummary.js +66 -0
  41. package/dist/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  42. package/dist/models/GetResourceSessionDiagnosticsUser.js +54 -0
  43. package/dist/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  44. package/dist/models/GetResourceSessionDiagnosticsVersion.js +74 -0
  45. package/dist/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  46. package/dist/models/GetResourceSessionScormApiLogs.js +67 -0
  47. package/dist/models/GetResourceSessionScormData.d.ts +77 -0
  48. package/dist/models/GetResourceSessionScormData.js +73 -0
  49. package/dist/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  50. package/dist/models/GetResourceSessionScormDataActivity.js +52 -0
  51. package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  52. package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
  53. package/dist/models/index.d.ts +10 -0
  54. package/dist/models/index.js +10 -0
  55. package/docs/GetResourceSession.md +10 -0
  56. package/docs/GetResourceSessionDiagnostics.md +47 -0
  57. package/docs/GetResourceSessionDiagnosticsCourseContext.md +50 -0
  58. package/docs/GetResourceSessionDiagnosticsResource.md +40 -0
  59. package/docs/GetResourceSessionDiagnosticsScormSummary.md +48 -0
  60. package/docs/GetResourceSessionDiagnosticsUser.md +36 -0
  61. package/docs/GetResourceSessionDiagnosticsVersion.md +52 -0
  62. package/docs/GetResourceSessionScormApiLogs.md +43 -0
  63. package/docs/GetResourceSessionScormData.md +49 -0
  64. package/docs/GetResourceSessionScormDataActivity.md +38 -0
  65. package/docs/PlayerApi.md +254 -3
  66. package/docs/ResourceSessionScormApiLogItem.md +47 -0
  67. package/package.json +1 -1
  68. package/src/apis/PlayerApi.ts +298 -1
  69. package/src/models/GetResourceSession.ts +43 -0
  70. package/src/models/GetResourceSessionDiagnostics.ts +161 -0
  71. package/src/models/GetResourceSessionDiagnosticsCourseContext.ts +148 -0
  72. package/src/models/GetResourceSessionDiagnosticsResource.ts +103 -0
  73. package/src/models/GetResourceSessionDiagnosticsScormSummary.ts +123 -0
  74. package/src/models/GetResourceSessionDiagnosticsUser.ts +75 -0
  75. package/src/models/GetResourceSessionDiagnosticsVersion.ts +141 -0
  76. package/src/models/GetResourceSessionScormApiLogs.ts +110 -0
  77. package/src/models/GetResourceSessionScormData.ts +134 -0
  78. package/src/models/GetResourceSessionScormDataActivity.ts +81 -0
  79. package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
  80. package/src/models/index.ts +10 -0
@@ -0,0 +1,134 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { GetResourceSessionScormDataActivity } from './GetResourceSessionScormDataActivity';
17
+ import {
18
+ GetResourceSessionScormDataActivityFromJSON,
19
+ GetResourceSessionScormDataActivityFromJSONTyped,
20
+ GetResourceSessionScormDataActivityToJSON,
21
+ GetResourceSessionScormDataActivityToJSONTyped,
22
+ } from './GetResourceSessionScormDataActivity';
23
+
24
+ /**
25
+ * Current SCORM CMI state for a reusable resource session.
26
+ * @export
27
+ * @interface GetResourceSessionScormData
28
+ */
29
+ export interface GetResourceSessionScormData {
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GetResourceSessionScormData
34
+ */
35
+ id: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof GetResourceSessionScormData
40
+ */
41
+ scormVersion: string;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetResourceSessionScormData
46
+ */
47
+ createdAt: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof GetResourceSessionScormData
52
+ */
53
+ updatedAt: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof GetResourceSessionScormData
58
+ */
59
+ initializedAt?: number | null;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof GetResourceSessionScormData
64
+ */
65
+ terminatedAt?: number | null;
66
+ /**
67
+ *
68
+ * @type {GetResourceSessionScormDataActivity}
69
+ * @memberof GetResourceSessionScormData
70
+ */
71
+ activity?: GetResourceSessionScormDataActivity | null;
72
+ /**
73
+ *
74
+ * @type {{ [key: string]: string; }}
75
+ * @memberof GetResourceSessionScormData
76
+ */
77
+ cmiData: { [key: string]: string; };
78
+ }
79
+
80
+ /**
81
+ * Check if a given object implements the GetResourceSessionScormData interface.
82
+ */
83
+ export function instanceOfGetResourceSessionScormData(value: object): value is GetResourceSessionScormData {
84
+ if (!('id' in value) || value['id'] === undefined) return false;
85
+ if (!('scormVersion' in value) || value['scormVersion'] === undefined) return false;
86
+ if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
87
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
88
+ if (!('cmiData' in value) || value['cmiData'] === undefined) return false;
89
+ return true;
90
+ }
91
+
92
+ export function GetResourceSessionScormDataFromJSON(json: any): GetResourceSessionScormData {
93
+ return GetResourceSessionScormDataFromJSONTyped(json, false);
94
+ }
95
+
96
+ export function GetResourceSessionScormDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionScormData {
97
+ if (json == null) {
98
+ return json;
99
+ }
100
+ return {
101
+
102
+ 'id': json['id'],
103
+ 'scormVersion': json['scorm_version'],
104
+ 'createdAt': json['created_at'],
105
+ 'updatedAt': json['updated_at'],
106
+ 'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
107
+ 'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
108
+ 'activity': json['activity'] == null ? undefined : GetResourceSessionScormDataActivityFromJSON(json['activity']),
109
+ 'cmiData': json['cmi_data'],
110
+ };
111
+ }
112
+
113
+ export function GetResourceSessionScormDataToJSON(json: any): GetResourceSessionScormData {
114
+ return GetResourceSessionScormDataToJSONTyped(json, false);
115
+ }
116
+
117
+ export function GetResourceSessionScormDataToJSONTyped(value?: GetResourceSessionScormData | null, ignoreDiscriminator: boolean = false): any {
118
+ if (value == null) {
119
+ return value;
120
+ }
121
+
122
+ return {
123
+
124
+ 'id': value['id'],
125
+ 'scorm_version': value['scormVersion'],
126
+ 'created_at': value['createdAt'],
127
+ 'updated_at': value['updatedAt'],
128
+ 'initialized_at': value['initializedAt'],
129
+ 'terminated_at': value['terminatedAt'],
130
+ 'activity': GetResourceSessionScormDataActivityToJSON(value['activity']),
131
+ 'cmi_data': value['cmiData'],
132
+ };
133
+ }
134
+
@@ -0,0 +1,81 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface GetResourceSessionScormDataActivity
20
+ */
21
+ export interface GetResourceSessionScormDataActivity {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof GetResourceSessionScormDataActivity
26
+ */
27
+ identifier?: string | null;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof GetResourceSessionScormDataActivity
32
+ */
33
+ name?: string | null;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof GetResourceSessionScormDataActivity
38
+ */
39
+ launchPath?: string | null;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the GetResourceSessionScormDataActivity interface.
44
+ */
45
+ export function instanceOfGetResourceSessionScormDataActivity(value: object): value is GetResourceSessionScormDataActivity {
46
+ return true;
47
+ }
48
+
49
+ export function GetResourceSessionScormDataActivityFromJSON(json: any): GetResourceSessionScormDataActivity {
50
+ return GetResourceSessionScormDataActivityFromJSONTyped(json, false);
51
+ }
52
+
53
+ export function GetResourceSessionScormDataActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionScormDataActivity {
54
+ if (json == null) {
55
+ return json;
56
+ }
57
+ return {
58
+
59
+ 'identifier': json['identifier'] == null ? undefined : json['identifier'],
60
+ 'name': json['name'] == null ? undefined : json['name'],
61
+ 'launchPath': json['launch_path'] == null ? undefined : json['launch_path'],
62
+ };
63
+ }
64
+
65
+ export function GetResourceSessionScormDataActivityToJSON(json: any): GetResourceSessionScormDataActivity {
66
+ return GetResourceSessionScormDataActivityToJSONTyped(json, false);
67
+ }
68
+
69
+ export function GetResourceSessionScormDataActivityToJSONTyped(value?: GetResourceSessionScormDataActivity | null, ignoreDiscriminator: boolean = false): any {
70
+ if (value == null) {
71
+ return value;
72
+ }
73
+
74
+ return {
75
+
76
+ 'identifier': value['identifier'],
77
+ 'name': value['name'],
78
+ 'launch_path': value['launchPath'],
79
+ };
80
+ }
81
+
@@ -0,0 +1,132 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * A recorded SCORM runtime call for a resource session.
18
+ * @export
19
+ * @interface ResourceSessionScormApiLogItem
20
+ */
21
+ export interface ResourceSessionScormApiLogItem {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof ResourceSessionScormApiLogItem
26
+ */
27
+ id: number;
28
+ /**
29
+ *
30
+ * @type {number}
31
+ * @memberof ResourceSessionScormApiLogItem
32
+ */
33
+ createdAt: number;
34
+ /**
35
+ *
36
+ * @type {ResourceSessionScormApiLogItemMethodEnum}
37
+ * @memberof ResourceSessionScormApiLogItem
38
+ */
39
+ method: ResourceSessionScormApiLogItemMethodEnum;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof ResourceSessionScormApiLogItem
44
+ */
45
+ element?: string | null;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof ResourceSessionScormApiLogItem
50
+ */
51
+ value?: string | null;
52
+ /**
53
+ *
54
+ * @type {boolean}
55
+ * @memberof ResourceSessionScormApiLogItem
56
+ */
57
+ valueTruncated: boolean;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof ResourceSessionScormApiLogItem
62
+ */
63
+ errorCode: string;
64
+ }
65
+
66
+
67
+ /**
68
+ * @export
69
+ */
70
+ export const ResourceSessionScormApiLogItemMethodEnum = {
71
+ Initialize: 'Initialize',
72
+ GetValue: 'GetValue',
73
+ SetValue: 'SetValue',
74
+ Commit: 'Commit',
75
+ Terminate: 'Terminate'
76
+ } as const;
77
+ export type ResourceSessionScormApiLogItemMethodEnum = typeof ResourceSessionScormApiLogItemMethodEnum[keyof typeof ResourceSessionScormApiLogItemMethodEnum];
78
+
79
+
80
+ /**
81
+ * Check if a given object implements the ResourceSessionScormApiLogItem interface.
82
+ */
83
+ export function instanceOfResourceSessionScormApiLogItem(value: object): value is ResourceSessionScormApiLogItem {
84
+ if (!('id' in value) || value['id'] === undefined) return false;
85
+ if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
86
+ if (!('method' in value) || value['method'] === undefined) return false;
87
+ if (!('valueTruncated' in value) || value['valueTruncated'] === undefined) return false;
88
+ if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
89
+ return true;
90
+ }
91
+
92
+ export function ResourceSessionScormApiLogItemFromJSON(json: any): ResourceSessionScormApiLogItem {
93
+ return ResourceSessionScormApiLogItemFromJSONTyped(json, false);
94
+ }
95
+
96
+ export function ResourceSessionScormApiLogItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceSessionScormApiLogItem {
97
+ if (json == null) {
98
+ return json;
99
+ }
100
+ return {
101
+
102
+ 'id': json['id'],
103
+ 'createdAt': json['created_at'],
104
+ 'method': json['method'],
105
+ 'element': json['element'] == null ? undefined : json['element'],
106
+ 'value': json['value'] == null ? undefined : json['value'],
107
+ 'valueTruncated': json['value_truncated'],
108
+ 'errorCode': json['error_code'],
109
+ };
110
+ }
111
+
112
+ export function ResourceSessionScormApiLogItemToJSON(json: any): ResourceSessionScormApiLogItem {
113
+ return ResourceSessionScormApiLogItemToJSONTyped(json, false);
114
+ }
115
+
116
+ export function ResourceSessionScormApiLogItemToJSONTyped(value?: ResourceSessionScormApiLogItem | null, ignoreDiscriminator: boolean = false): any {
117
+ if (value == null) {
118
+ return value;
119
+ }
120
+
121
+ return {
122
+
123
+ 'id': value['id'],
124
+ 'created_at': value['createdAt'],
125
+ 'method': value['method'],
126
+ 'element': value['element'],
127
+ 'value': value['value'],
128
+ 'value_truncated': value['valueTruncated'],
129
+ 'error_code': value['errorCode'],
130
+ };
131
+ }
132
+
@@ -183,7 +183,16 @@ export * from './GetQuizStatistics';
183
183
  export * from './GetResource';
184
184
  export * from './GetResourceList';
185
185
  export * from './GetResourceSession';
186
+ export * from './GetResourceSessionDiagnostics';
187
+ export * from './GetResourceSessionDiagnosticsCourseContext';
188
+ export * from './GetResourceSessionDiagnosticsResource';
189
+ export * from './GetResourceSessionDiagnosticsScormSummary';
190
+ export * from './GetResourceSessionDiagnosticsUser';
191
+ export * from './GetResourceSessionDiagnosticsVersion';
186
192
  export * from './GetResourceSessionList';
193
+ export * from './GetResourceSessionScormApiLogs';
194
+ export * from './GetResourceSessionScormData';
195
+ export * from './GetResourceSessionScormDataActivity';
187
196
  export * from './GetResourceUsage';
188
197
  export * from './GetResourceUsageCoursesInner';
189
198
  export * from './GetResourceVersionUpload';
@@ -354,6 +363,7 @@ export * from './QuizContent';
354
363
  export * from './QuizContentAssignment';
355
364
  export * from './QuizContentSettings';
356
365
  export * from './ResourceSessionEnvironment';
366
+ export * from './ResourceSessionScormApiLogItem';
357
367
  export * from './ResourceType';
358
368
  export * from './RichTextAsset';
359
369
  export * from './RichTextDocument';