Merge pull request #475 from concord-consortium/plugin-api-resource-url

Add resourceUrl to Plugin runtime context

Author: scytacki

app/assets/javascripts/lara-typescript.js

@@ -147,7 +147,8 @@
         userEmail: #{@run.user && @run.user.email ? "'#{escape_javascript(@run.user.email)}'" : 'null'},
         classInfoUrl: #{@run.class_info_url ? "'#{escape_javascript(@run.class_info_url)}'" : 'null'},
         firebaseJwtUrl: '#{escape_javascript(firebase_jwt_url)}',
-        wrappedEmbeddable: embeddableContext
+        wrappedEmbeddable: embeddableContext,
+        resourceUrl: '#{escape_javascript(@sequence_run ? sequence_url(@sequence_run.sequence) : activity_url(@run.activity))}'
       }
       console.log("Adding #{plugin.name} runtime plugin as #{v3_plugin_label} with V3 LARA Plugin API")
       LARA.InternalAPI.initPlugin('#{v3_plugin_label}', pluginContext);

app/views/plugins/_show.haml

@@ -207,7 +207,7 @@ ___
 
 **Ƭ IInteractiveAvailableEventHandler**: *`function`*
 
-*Defined in [types.ts:233](../../lara-typescript/src/plugin-api/types.ts#L233)*
+*Defined in [types.ts:235](../../lara-typescript/src/plugin-api/types.ts#L235)*
 
 InteractiveAvailable event handler.
 
@@ -229,7 +229,7 @@ ___
 
 **Ƭ ILogEventHandler**: *`function`*
 
-*Defined in [types.ts:214](../../lara-typescript/src/plugin-api/types.ts#L214)*
+*Defined in [types.ts:216](../../lara-typescript/src/plugin-api/types.ts#L216)*
 
 Log event handler.
 

docs/lara-plugin-api/README.md

@@ -27,7 +27,7 @@
 
 **● class_hash**: *`string`*
 
-*Defined in [types.ts:185](../../../lara-typescript/src/plugin-api/types.ts#L185)*
+*Defined in [types.ts:187](../../../lara-typescript/src/plugin-api/types.ts#L187)*
 
 ___
 <a id="id"></a>
@@ -36,7 +36,7 @@ ___
 
 **● id**: *`number`*
 
-*Defined in [types.ts:183](../../../lara-typescript/src/plugin-api/types.ts#L183)*
+*Defined in [types.ts:185](../../../lara-typescript/src/plugin-api/types.ts#L185)*
 
 ___
 <a id="offerings"></a>
@@ -45,7 +45,7 @@ ___
 
 **● offerings**: *[IOffering](ioffering.md)[]*
 
-*Defined in [types.ts:188](../../../lara-typescript/src/plugin-api/types.ts#L188)*
+*Defined in [types.ts:190](../../../lara-typescript/src/plugin-api/types.ts#L190)*
 
 ___
 <a id="students"></a>
@@ -54,7 +54,7 @@ ___
 
 **● students**: *[IUser](iuser.md)[]*
 
-*Defined in [types.ts:187](../../../lara-typescript/src/plugin-api/types.ts#L187)*
+*Defined in [types.ts:189](../../../lara-typescript/src/plugin-api/types.ts#L189)*
 
 ___
 <a id="teachers"></a>
@@ -63,7 +63,7 @@ ___
 
 **● teachers**: *[IUser](iuser.md)[]*
 
-*Defined in [types.ts:186](../../../lara-typescript/src/plugin-api/types.ts#L186)*
+*Defined in [types.ts:188](../../../lara-typescript/src/plugin-api/types.ts#L188)*
 
 ___
 <a id="uri"></a>
@@ -72,7 +72,7 @@ ___
 
 **● uri**: *`string`*
 
-*Defined in [types.ts:184](../../../lara-typescript/src/plugin-api/types.ts#L184)*
+*Defined in [types.ts:186](../../../lara-typescript/src/plugin-api/types.ts#L186)*
 
 ___
 

docs/lara-plugin-api/interfaces/iclassinfo.md

@@ -27,7 +27,7 @@
 
 **● container**: *`HTMLElement`*
 
-*Defined in [types.ts:66](../../../lara-typescript/src/plugin-api/types.ts#L66)*
+*Defined in [types.ts:68](../../../lara-typescript/src/plugin-api/types.ts#L68)*
 
 Embeddable container.
 
@@ -38,7 +38,7 @@ ___
 
 **● getInteractiveState**: *`function`*
 
-*Defined in [types.ts:87](../../../lara-typescript/src/plugin-api/types.ts#L87)*
+*Defined in [types.ts:89](../../../lara-typescript/src/plugin-api/types.ts#L89)*
 
 Function that returns interactive state (Promise) or null if embeddable isn't interactive.
 
@@ -54,7 +54,7 @@ ___
 
 **● getReportingUrl**: *`function`*
 
-*Defined in [types.ts:97](../../../lara-typescript/src/plugin-api/types.ts#L97)*
+*Defined in [types.ts:99](../../../lara-typescript/src/plugin-api/types.ts#L99)*
 
 Function that returns reporting URL (Promise) or null if it's not an interactive or reporting URL is not defined. Note that reporting URL is defined in the interactive state (that can be obtained via #getInteractiveState method). If your code needs both interactive state and reporting URL, you can pass interactiveStatePromise as an argument to this method to limit number of network requests.
 
@@ -78,7 +78,7 @@ ___
 
 **● interactiveAvailable**: *`boolean`*
 
-*Defined in [types.ts:107](../../../lara-typescript/src/plugin-api/types.ts#L107)*
+*Defined in [types.ts:109](../../../lara-typescript/src/plugin-api/types.ts#L109)*
 
 True if the interactive is immediately available
 
@@ -89,7 +89,7 @@ ___
 
 **● laraJson**: *`any`*
 
-*Defined in [types.ts:85](../../../lara-typescript/src/plugin-api/types.ts#L85)*
+*Defined in [types.ts:87](../../../lara-typescript/src/plugin-api/types.ts#L87)*
 
 Serialized form of the embeddable. Defined by LARA export code, so it's format cannot be specified here. Example (interactive):
 
@@ -115,7 +115,7 @@ ___
 
 **● onInteractiveAvailable**: *`function`*
 
-*Defined in [types.ts:105](../../../lara-typescript/src/plugin-api/types.ts#L105)*
+*Defined in [types.ts:107](../../../lara-typescript/src/plugin-api/types.ts#L107)*
 
 Function that subscribes provided handler to event that gets called when the interactive's availablity changes. Normally an interactive starts as available unless click to play is enabled. When click to play is enabled the interactive starts as not available and this handler is called when the click to play overlay is hidden.
 

docs/lara-plugin-api/interfaces/iembeddableruntimecontext.md

@@ -25,7 +25,7 @@ Data passed to InteractiveAvailable event handlers.
 
 **● available**: *`boolean`*
 
-*Defined in [types.ts:227](../../../lara-typescript/src/plugin-api/types.ts#L227)*
+*Defined in [types.ts:229](../../../lara-typescript/src/plugin-api/types.ts#L229)*
 
 Availablility of interactive
 
@@ -36,7 +36,7 @@ ___
 
 **● container**: *`HTMLElement`*
 
-*Defined in [types.ts:223](../../../lara-typescript/src/plugin-api/types.ts#L223)*
+*Defined in [types.ts:225](../../../lara-typescript/src/plugin-api/types.ts#L225)*
 
 Interactive container of the interactive that was just started.
 

docs/lara-plugin-api/interfaces/iinteractiveavailableevent.md

@@ -27,7 +27,7 @@
 
 **● activity_name**: *`string`*
 
-*Defined in [types.ts:197](../../../lara-typescript/src/plugin-api/types.ts#L197)*
+*Defined in [types.ts:199](../../../lara-typescript/src/plugin-api/types.ts#L199)*
 
 ___
 <a id="id"></a>
@@ -36,7 +36,7 @@ ___
 
 **● id**: *`number`*
 
-*Defined in [types.ts:192](../../../lara-typescript/src/plugin-api/types.ts#L192)*
+*Defined in [types.ts:194](../../../lara-typescript/src/plugin-api/types.ts#L194)*
 
 ___
 <a id="interactive_name"></a>
@@ -45,7 +45,7 @@ ___
 
 **● interactive_name**: *`string`*
 
-*Defined in [types.ts:195](../../../lara-typescript/src/plugin-api/types.ts#L195)*
+*Defined in [types.ts:197](../../../lara-typescript/src/plugin-api/types.ts#L197)*
 
 ___
 <a id="interactive_state_url"></a>
@@ -54,7 +54,7 @@ ___
 
 **● interactive_state_url**: *`string`*
 
-*Defined in [types.ts:196](../../../lara-typescript/src/plugin-api/types.ts#L196)*
+*Defined in [types.ts:198](../../../lara-typescript/src/plugin-api/types.ts#L198)*
 
 ___
 <a id="key"></a>
@@ -63,7 +63,7 @@ ___
 
 **● key**: *`string`*
 
-*Defined in [types.ts:193](../../../lara-typescript/src/plugin-api/types.ts#L193)*
+*Defined in [types.ts:195](../../../lara-typescript/src/plugin-api/types.ts#L195)*
 
 ___
 <a id="raw_data"></a>
@@ -72,7 +72,7 @@ ___
 
 **● raw_data**: *`string`*
 
-*Defined in [types.ts:194](../../../lara-typescript/src/plugin-api/types.ts#L194)*
+*Defined in [types.ts:196](../../../lara-typescript/src/plugin-api/types.ts#L196)*
 
 ___
 

docs/lara-plugin-api/interfaces/iinteractivestate.md

@@ -35,7 +35,7 @@
 
 **● alg**: *`string`*
 
-*Defined in [types.ts:149](../../../lara-typescript/src/plugin-api/types.ts#L149)*
+*Defined in [types.ts:151](../../../lara-typescript/src/plugin-api/types.ts#L151)*
 
 ___
 <a id="aud"></a>
@@ -44,7 +44,7 @@ ___
 
 **● aud**: *`string`*
 
-*Defined in [types.ts:150](../../../lara-typescript/src/plugin-api/types.ts#L150)*
+*Defined in [types.ts:152](../../../lara-typescript/src/plugin-api/types.ts#L152)*
 
 ___
 <a id="claims"></a>
@@ -53,7 +53,7 @@ ___
 
 **● claims**: *[IPortalClaims](iportalclaims.md)*
 
-*Defined in [types.ts:162](../../../lara-typescript/src/plugin-api/types.ts#L162)*
+*Defined in [types.ts:164](../../../lara-typescript/src/plugin-api/types.ts#L164)*
 
 ___
 <a id="class_info_url"></a>
@@ -62,7 +62,7 @@ ___
 
 **● class_info_url**: *`string`*
 
-*Defined in [types.ts:151](../../../lara-typescript/src/plugin-api/types.ts#L151)*
+*Defined in [types.ts:153](../../../lara-typescript/src/plugin-api/types.ts#L153)*
 
 ___
 <a id="domain"></a>
@@ -71,7 +71,7 @@ ___
 
 **● domain**: *`string`*
 
-*Defined in [types.ts:152](../../../lara-typescript/src/plugin-api/types.ts#L152)*
+*Defined in [types.ts:154](../../../lara-typescript/src/plugin-api/types.ts#L154)*
 
 ___
 <a id="domain_uid"></a>
@@ -80,7 +80,7 @@ ___
 
 **● domain_uid**: *`number`*
 
-*Defined in [types.ts:153](../../../lara-typescript/src/plugin-api/types.ts#L153)*
+*Defined in [types.ts:155](../../../lara-typescript/src/plugin-api/types.ts#L155)*
 
 ___
 <a id="exp"></a>
@@ -89,7 +89,7 @@ ___
 
 **● exp**: *`number`*
 
-*Defined in [types.ts:154](../../../lara-typescript/src/plugin-api/types.ts#L154)*
+*Defined in [types.ts:156](../../../lara-typescript/src/plugin-api/types.ts#L156)*
 
 ___
 <a id="externalid"></a>
@@ -98,7 +98,7 @@ ___
 
 **● externalId**: *`number`*
 
-*Defined in [types.ts:155](../../../lara-typescript/src/plugin-api/types.ts#L155)*
+*Defined in [types.ts:157](../../../lara-typescript/src/plugin-api/types.ts#L157)*
 
 ___
 <a id="iat"></a>
@@ -107,7 +107,7 @@ ___
 
 **● iat**: *`number`*
 
-*Defined in [types.ts:156](../../../lara-typescript/src/plugin-api/types.ts#L156)*
+*Defined in [types.ts:158](../../../lara-typescript/src/plugin-api/types.ts#L158)*
 
 ___
 <a id="iss"></a>
@@ -116,7 +116,7 @@ ___
 
 **● iss**: *`string`*
 
-*Defined in [types.ts:157](../../../lara-typescript/src/plugin-api/types.ts#L157)*
+*Defined in [types.ts:159](../../../lara-typescript/src/plugin-api/types.ts#L159)*
 
 ___
 <a id="logging"></a>
@@ -125,7 +125,7 @@ ___
 
 **● logging**: *`boolean`*
 
-*Defined in [types.ts:158](../../../lara-typescript/src/plugin-api/types.ts#L158)*
+*Defined in [types.ts:160](../../../lara-typescript/src/plugin-api/types.ts#L160)*
 
 ___
 <a id="returnurl"></a>
@@ -134,7 +134,7 @@ ___
 
 **● returnUrl**: *`string`*
 
-*Defined in [types.ts:159](../../../lara-typescript/src/plugin-api/types.ts#L159)*
+*Defined in [types.ts:161](../../../lara-typescript/src/plugin-api/types.ts#L161)*
 
 ___
 <a id="sub"></a>
@@ -143,7 +143,7 @@ ___
 
 **● sub**: *`string`*
 
-*Defined in [types.ts:160](../../../lara-typescript/src/plugin-api/types.ts#L160)*
+*Defined in [types.ts:162](../../../lara-typescript/src/plugin-api/types.ts#L162)*
 
 ___
 <a id="uid"></a>
@@ -152,7 +152,7 @@ ___
 
 **● uid**: *`string`*
 
-*Defined in [types.ts:161](../../../lara-typescript/src/plugin-api/types.ts#L161)*
+*Defined in [types.ts:163](../../../lara-typescript/src/plugin-api/types.ts#L163)*
 
 ___
 

docs/lara-plugin-api/interfaces/ijwtclaims.md

@@ -23,7 +23,7 @@
 
 **● claims**: *[IJwtClaims](ijwtclaims.md)*
 
-*Defined in [types.ts:167](../../../lara-typescript/src/plugin-api/types.ts#L167)*
+*Defined in [types.ts:169](../../../lara-typescript/src/plugin-api/types.ts#L169)*
 
 ___
 <a id="token"></a>
@@ -32,7 +32,7 @@ ___
 
 **● token**: *`string`*
 
-*Defined in [types.ts:166](../../../lara-typescript/src/plugin-api/types.ts#L166)*
+*Defined in [types.ts:168](../../../lara-typescript/src/plugin-api/types.ts#L168)*
 
 ___
 

docs/lara-plugin-api/interfaces/ijwtresponse.md

@@ -26,7 +26,7 @@ That's the minimal set of properties that needs to be provided. All the other pr
 
 **● event**: *`string`*
 
-*Defined in [types.ts:205](../../../lara-typescript/src/plugin-api/types.ts#L205)*
+*Defined in [types.ts:207](../../../lara-typescript/src/plugin-api/types.ts#L207)*
 
 ___
 <a id="event_value"></a>
@@ -35,7 +35,7 @@ ___
 
 **● event_value**: *`any`*
 
-*Defined in [types.ts:206](../../../lara-typescript/src/plugin-api/types.ts#L206)*
+*Defined in [types.ts:208](../../../lara-typescript/src/plugin-api/types.ts#L208)*
 
 ___
 <a id="parameters"></a>
@@ -44,7 +44,7 @@ ___
 
 **● parameters**: *`any`*
 
-*Defined in [types.ts:207](../../../lara-typescript/src/plugin-api/types.ts#L207)*
+*Defined in [types.ts:209](../../../lara-typescript/src/plugin-api/types.ts#L209)*
 
 ___