@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/dist/esm/models/ScormNavigationDelivery.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const ScormNavigationDeliveryActivityTypeEnum = {
+    Sco: 'sco',
+    Asset: 'asset'
+};
+/**
+ * Check if a given object implements the ScormNavigationDelivery interface.
+ */
+export function instanceOfScormNavigationDelivery(value) {
+    if (!('activityIdentifier' in value) || value['activityIdentifier'] === undefined)
+        return false;
+    if (!('trackingUuid' in value) || value['trackingUuid'] === undefined)
+        return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('activityType' in value) || value['activityType'] === undefined)
+        return false;
+    return true;
+}
+export function ScormNavigationDeliveryFromJSON(json) {
+    return ScormNavigationDeliveryFromJSONTyped(json, false);
+}
+export function ScormNavigationDeliveryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activityIdentifier': json['activity_identifier'],
+        'trackingUuid': json['tracking_uuid'],
+        'launchUrl': json['launch_url'],
+        'title': json['title'],
+        'activityType': json['activity_type'],
+    };
+}
+export function ScormNavigationDeliveryToJSON(json) {
+    return ScormNavigationDeliveryToJSONTyped(json, false);
+}
+export function ScormNavigationDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activity_identifier': value['activityIdentifier'],
+        'tracking_uuid': value['trackingUuid'],
+        'launch_url': value['launchUrl'],
+        'title': value['title'],
+        'activity_type': value['activityType'],
+    };
+}

package/dist/esm/models/ScormNavigationRequest.d.ts

@@ -0,0 +1,55 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A SCORM 2004 navigation request
+ * @export
+ * @interface ScormNavigationRequest
+ */
+export interface ScormNavigationRequest {
+    /**
+     *
+     * @type {ScormNavigationRequestRequestEnum}
+     * @memberof ScormNavigationRequest
+     */
+    request: ScormNavigationRequestRequestEnum;
+    /**
+     * Required for choice and jump; forbidden for other requests
+     * @type {string}
+     * @memberof ScormNavigationRequest
+     */
+    targetIdentifier?: string;
+}
+/**
+ * @export
+ */
+export declare const ScormNavigationRequestRequestEnum: {
+    readonly Start: "start";
+    readonly ResumeAll: "resume_all";
+    readonly Continue: "continue";
+    readonly Previous: "previous";
+    readonly Choice: "choice";
+    readonly Jump: "jump";
+    readonly Exit: "exit";
+    readonly ExitAll: "exit_all";
+    readonly Abandon: "abandon";
+    readonly AbandonAll: "abandon_all";
+    readonly SuspendAll: "suspend_all";
+};
+export type ScormNavigationRequestRequestEnum = typeof ScormNavigationRequestRequestEnum[keyof typeof ScormNavigationRequestRequestEnum];
+/**
+ * Check if a given object implements the ScormNavigationRequest interface.
+ */
+export declare function instanceOfScormNavigationRequest(value: object): value is ScormNavigationRequest;
+export declare function ScormNavigationRequestFromJSON(json: any): ScormNavigationRequest;
+export declare function ScormNavigationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationRequest;
+export declare function ScormNavigationRequestToJSON(json: any): ScormNavigationRequest;
+export declare function ScormNavigationRequestToJSONTyped(value?: ScormNavigationRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormNavigationRequest.js

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const ScormNavigationRequestRequestEnum = {
+    Start: 'start',
+    ResumeAll: 'resume_all',
+    Continue: 'continue',
+    Previous: 'previous',
+    Choice: 'choice',
+    Jump: 'jump',
+    Exit: 'exit',
+    ExitAll: 'exit_all',
+    Abandon: 'abandon',
+    AbandonAll: 'abandon_all',
+    SuspendAll: 'suspend_all'
+};
+/**
+ * Check if a given object implements the ScormNavigationRequest interface.
+ */
+export function instanceOfScormNavigationRequest(value) {
+    if (!('request' in value) || value['request'] === undefined)
+        return false;
+    return true;
+}
+export function ScormNavigationRequestFromJSON(json) {
+    return ScormNavigationRequestFromJSONTyped(json, false);
+}
+export function ScormNavigationRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'request': json['request'],
+        'targetIdentifier': json['target_identifier'] == null ? undefined : json['target_identifier'],
+    };
+}
+export function ScormNavigationRequestToJSON(json) {
+    return ScormNavigationRequestToJSONTyped(json, false);
+}
+export function ScormNavigationRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'request': value['request'],
+        'target_identifier': value['targetIdentifier'],
+    };
+}

package/dist/esm/models/ScormNavigationResponse.d.ts

@@ -0,0 +1,70 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ScormNavigationDelivery } from './ScormNavigationDelivery';
+import type { ScormNavigationValidity } from './ScormNavigationValidity';
+/**
+ * Result of a SCORM 2004 sequencing transition
+ * @export
+ * @interface ScormNavigationResponse
+ */
+export interface ScormNavigationResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {ScormNavigationDelivery}
+     * @memberof ScormNavigationResponse
+     */
+    delivery?: ScormNavigationDelivery;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    sequencingEnded: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationResponse
+     */
+    suspended: boolean;
+    /**
+     *
+     * @type {ScormNavigationValidity}
+     * @memberof ScormNavigationResponse
+     */
+    valid: ScormNavigationValidity;
+    /**
+     *
+     * @type {string}
+     * @memberof ScormNavigationResponse
+     */
+    errorCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ScormNavigationResponse
+     */
+    diagnostic: string;
+}
+/**
+ * Check if a given object implements the ScormNavigationResponse interface.
+ */
+export declare function instanceOfScormNavigationResponse(value: object): value is ScormNavigationResponse;
+export declare function ScormNavigationResponseFromJSON(json: any): ScormNavigationResponse;
+export declare function ScormNavigationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationResponse;
+export declare function ScormNavigationResponseToJSON(json: any): ScormNavigationResponse;
+export declare function ScormNavigationResponseToJSONTyped(value?: ScormNavigationResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormNavigationResponse.js

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ScormNavigationDeliveryFromJSON, ScormNavigationDeliveryToJSON, } from './ScormNavigationDelivery';
+import { ScormNavigationValidityFromJSON, ScormNavigationValidityToJSON, } from './ScormNavigationValidity';
+/**
+ * Check if a given object implements the ScormNavigationResponse interface.
+ */
+export function instanceOfScormNavigationResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('sequencingEnded' in value) || value['sequencingEnded'] === undefined)
+        return false;
+    if (!('suspended' in value) || value['suspended'] === undefined)
+        return false;
+    if (!('valid' in value) || value['valid'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
+    return true;
+}
+export function ScormNavigationResponseFromJSON(json) {
+    return ScormNavigationResponseFromJSONTyped(json, false);
+}
+export function ScormNavigationResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'delivery': json['delivery'] == null ? undefined : ScormNavigationDeliveryFromJSON(json['delivery']),
+        'sequencingEnded': json['sequencing_ended'],
+        'suspended': json['suspended'],
+        'valid': ScormNavigationValidityFromJSON(json['valid']),
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+    };
+}
+export function ScormNavigationResponseToJSON(json) {
+    return ScormNavigationResponseToJSONTyped(json, false);
+}
+export function ScormNavigationResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'delivery': ScormNavigationDeliveryToJSON(value['delivery']),
+        'sequencing_ended': value['sequencingEnded'],
+        'suspended': value['suspended'],
+        'valid': ScormNavigationValidityToJSON(value['valid']),
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+    };
+}

package/dist/esm/models/ScormNavigationValidity.d.ts

@@ -0,0 +1,92 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Navigation requests valid in the resulting sequencing state
+ * @export
+ * @interface ScormNavigationValidity
+ */
+export interface ScormNavigationValidity {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    start: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    resumeAll: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    _continue: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    previous: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    exit: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    exitAll: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    abandon: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    abandonAll: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormNavigationValidity
+     */
+    suspendAll: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ScormNavigationValidity
+     */
+    choiceTargets: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ScormNavigationValidity
+     */
+    jumpTargets: Array<string>;
+}
+/**
+ * Check if a given object implements the ScormNavigationValidity interface.
+ */
+export declare function instanceOfScormNavigationValidity(value: object): value is ScormNavigationValidity;
+export declare function ScormNavigationValidityFromJSON(json: any): ScormNavigationValidity;
+export declare function ScormNavigationValidityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormNavigationValidity;
+export declare function ScormNavigationValidityToJSON(json: any): ScormNavigationValidity;
+export declare function ScormNavigationValidityToJSONTyped(value?: ScormNavigationValidity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormNavigationValidity.js

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ScormNavigationValidity interface.
+ */
+export function instanceOfScormNavigationValidity(value) {
+    if (!('start' in value) || value['start'] === undefined)
+        return false;
+    if (!('resumeAll' in value) || value['resumeAll'] === undefined)
+        return false;
+    if (!('_continue' in value) || value['_continue'] === undefined)
+        return false;
+    if (!('previous' in value) || value['previous'] === undefined)
+        return false;
+    if (!('exit' in value) || value['exit'] === undefined)
+        return false;
+    if (!('exitAll' in value) || value['exitAll'] === undefined)
+        return false;
+    if (!('abandon' in value) || value['abandon'] === undefined)
+        return false;
+    if (!('abandonAll' in value) || value['abandonAll'] === undefined)
+        return false;
+    if (!('suspendAll' in value) || value['suspendAll'] === undefined)
+        return false;
+    if (!('choiceTargets' in value) || value['choiceTargets'] === undefined)
+        return false;
+    if (!('jumpTargets' in value) || value['jumpTargets'] === undefined)
+        return false;
+    return true;
+}
+export function ScormNavigationValidityFromJSON(json) {
+    return ScormNavigationValidityFromJSONTyped(json, false);
+}
+export function ScormNavigationValidityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'start': json['start'],
+        'resumeAll': json['resume_all'],
+        '_continue': json['continue'],
+        'previous': json['previous'],
+        'exit': json['exit'],
+        'exitAll': json['exit_all'],
+        'abandon': json['abandon'],
+        'abandonAll': json['abandon_all'],
+        'suspendAll': json['suspend_all'],
+        'choiceTargets': json['choice_targets'],
+        'jumpTargets': json['jump_targets'],
+    };
+}
+export function ScormNavigationValidityToJSON(json) {
+    return ScormNavigationValidityToJSONTyped(json, false);
+}
+export function ScormNavigationValidityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'start': value['start'],
+        'resume_all': value['resumeAll'],
+        'continue': value['_continue'],
+        'previous': value['previous'],
+        'exit': value['exit'],
+        'exit_all': value['exitAll'],
+        'abandon': value['abandon'],
+        'abandon_all': value['abandonAll'],
+        'suspend_all': value['suspendAll'],
+        'choice_targets': value['choiceTargets'],
+        'jump_targets': value['jumpTargets'],
+    };
+}

package/dist/esm/models/ScormRuntimeResponse.d.ts

@@ -0,0 +1,44 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Typed result of a SCORM runtime API operation
+ * @export
+ * @interface ScormRuntimeResponse
+ */
+export interface ScormRuntimeResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScormRuntimeResponse
+     */
+    success: boolean;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormRuntimeResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormRuntimeResponse
+     */
+    diagnostic: string;
+}
+/**
+ * Check if a given object implements the ScormRuntimeResponse interface.
+ */
+export declare function instanceOfScormRuntimeResponse(value: object): value is ScormRuntimeResponse;
+export declare function ScormRuntimeResponseFromJSON(json: any): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseToJSON(json: any): ScormRuntimeResponse;
+export declare function ScormRuntimeResponseToJSONTyped(value?: ScormRuntimeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScormRuntimeResponse.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ScormRuntimeResponse interface.
+ */
+export function instanceOfScormRuntimeResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
+    return true;
+}
+export function ScormRuntimeResponseFromJSON(json) {
+    return ScormRuntimeResponseFromJSONTyped(json, false);
+}
+export function ScormRuntimeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
+    };
+}
+export function ScormRuntimeResponseToJSON(json) {
+    return ScormRuntimeResponseToJSONTyped(json, false);
+}
+export function ScormRuntimeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
+    };
+}

package/dist/esm/models/ScormSetValueResponse.d.ts

@@ -21,6 +21,18 @@ export interface ScormSetValueResponse {
      * @memberof ScormSetValueResponse
      */
     success: boolean;
+    /**
+     * Exact SCORM runtime error code for this API call
+     * @type {string}
+     * @memberof ScormSetValueResponse
+     */
+    errorCode: string;
+    /**
+     * Diagnostic detail for the error code, empty on success
+     * @type {string}
+     * @memberof ScormSetValueResponse
+     */
+    diagnostic: string;
 }
 /**
  * Check if a given object implements the ScormSetValueResponse interface.

package/dist/esm/models/ScormSetValueResponse.js

@@ -17,6 +17,10 @@
 export function instanceOfScormSetValueResponse(value) {
     if (!('success' in value) || value['success'] === undefined)
         return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('diagnostic' in value) || value['diagnostic'] === undefined)
+        return false;
     return true;
 }
 export function ScormSetValueResponseFromJSON(json) {
@@ -28,6 +32,8 @@ export function ScormSetValueResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'success': json['success'],
+        'errorCode': json['error_code'],
+        'diagnostic': json['diagnostic'],
     };
 }
 export function ScormSetValueResponseToJSON(json) {
@@ -39,5 +45,7 @@ export function ScormSetValueResponseToJSONTyped(value, ignoreDiscriminator = fa
     }
     return {
         'success': value['success'],
+        'error_code': value['errorCode'],
+        'diagnostic': value['diagnostic'],
     };
 }