Merge pull request #111 from opencomponents/add-before-render

add option to pass javascript that executes before render
opencomponents · Mar 29, 2024 · 947d863 · 947d863
2 parents 32330cc + 62b76f9
commit 947d863
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -16,11 +16,15 @@ interface TemplateRenderer {
 type Template = {
   externals: Array<{ global: string | string[]; url: string }>;
 };
-type CompileOptions = {
+interface CompileOptions {
   templates?: Record<string, Template> | TemplateRenderer[];
   retryInterval?: number;
   retryLimit?: number;
-};
+  /**
+   * JavaScript as a string code to be executed before rendering the templates
+   */
+  beforeRender?: string;
+}
 type Compiled = { code: string; map: string; dev: string };
 
 declare const ocClient: {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "oc-client-browser",
-  "version": "1.7.8",
+  "version": "1.7.9",
   "description": "OC browser client",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/src/oc-client.js b/src/oc-client.js
@@ -1,4 +1,4 @@
-/* globals define, exports, require, globalThis, __REGISTERED_TEMPLATES_PLACEHOLDER__, __DEFAULT_RETRY_INTERVAL__, __DEFAULT_RETRY_LIMIT__ */
+/* globals define, exports, require, globalThis, __REGISTERED_TEMPLATES_PLACEHOLDER__, __DEFAULT_RETRY_INTERVAL__, __DEFAULT_RETRY_LIMIT__, __BEFORE_RENDER__ */
 /* eslint no-var: 'off' */
 /* eslint prefer-arrow-callback: 'off' */
 
@@ -691,6 +691,8 @@ var oc = oc || {};
     });
   };
 
+  __BEFORE_RENDER__;
+
   // render the components
   oc.ready(oc.renderUnloadedComponents);
 

diff --git a/tasks/compile.js b/tasks/compile.js
@@ -64,6 +64,7 @@ function getFiles({ sync = false, conf = {} }) {
         '__REGISTERED_TEMPLATES_PLACEHOLDER__',
         JSON.stringify(registeredTemplates)
       )
+      .replaceAll('__BEFORE_RENDER__', conf.beforeRender || '')
       .replaceAll('__DEFAULT_RETRY_LIMIT__', conf.retryLimit || 30)
       .replaceAll('__DEFAULT_RETRY_INTERVAL__', conf.retryInterval || 5000);
 

diff --git a/test/get-data.js b/test/get-data.js
@@ -46,7 +46,11 @@ describe('oc-client : getData', function () {
   describe('when providing the mandatory parameters', function () {
     describe('when requesting data', function () {
       it('should call the $.ajax method correctly', function (done) {
-        var spy = sinon.spy(oc.$, 'ajax');
+        var spy = sinon.stub(oc.$, 'ajax').callsFake(function (options) {
+          return options.success([
+            { response: { renderMode: 'unrendered', data: 'hello' } }
+          ]);
+        });
 
         execute(
           {