feat(integration): Add support to execute packaged custom scripts (#2281

)

.github/workflows/update-origins.js

@@ -27,7 +27,9 @@ const getOrigins = () => {
 };
 
 const formatOriginsFile = (origins) =>
-  `export default {\n${Object.entries(origins)
+  `export { CustomScripts } from './custom-scripts'
+
+export default {\n${Object.entries(origins)
     .sort((a, b) =>
       a[1].name.toLowerCase() < b[1].name.toLowerCase() ? -1 : 1
     )
@@ -40,11 +42,12 @@ const formatOriginsFile = (origins) =>
     .join(",\n")}\n};\n`;
 
 exec(`git diff --name-only HEAD^ HEAD`, (_, out) => {
-  const files = out.split(/[\r\n]+/).filter((name) => !!name && name.startsWith('src/content/'));
+  const files = out.split(/[\r\n]+/).filter((name) => !!name && name.startsWith('src/content/') && !path.basename(name).startsWith("_custom_"));
   if (files.length === 0) {
     console.log(`::No files to process`);
     process.exit(0);
   }
+
   const infos = files
     .map((file) => ({
       ...getFileInfo(readFileSync(file).toString()),

src/content/_custom_SampleScript.js

@@ -0,0 +1,8 @@
+/**
+ * @name SampleScript
+ * @urlAlias script_a_shortcode
+ * @urlRegex app.sample.com
+ */
+'use strict'
+
+console.log('Custom script executed')

src/custom-scripts.js

@@ -0,0 +1,6 @@
+export const CustomScripts = {
+  'script_a_shortcode': {
+    name: 'Custom Script For XYZ',
+    file: '_custom_SampleScript.js',
+  },
+}

src/index.d.ts

@@ -1,4 +1,4 @@
-import origins from './origins';
+import origins, { CustomScripts as customScripts } from './origins';
 
 declare const _default = origins as {
   [key: string]: {
@@ -9,3 +9,10 @@ declare const _default = origins as {
 };
 
 export default _default;
+
+export declare const CustomScripts = customScripts as {
+  [key: string]: {
+    name: string;
+    file?: string;
+  };
+}

src/origins.js

@@ -1,3 +1,5 @@
+export { CustomScripts } from './custom-scripts'
+
 export default {
   'airtable.com': {
     url: '*://airtable.com/*',
@@ -707,3 +709,4 @@ export default {
     name: 'Zube'
   }
 };
+