@builder.io/sdk-svelte 1.0.20 → 1.0.21

package/lib/browser/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.20";
+export declare const SDK_VERSION = "1.0.21";

package/lib/browser/constants/sdk-version.js

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.20";
+export const SDK_VERSION = "1.0.21";

package/lib/browser/functions/evaluate/node-runtime/init.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export declare const initializeNodeRuntime: () => void;

package/lib/browser/functions/evaluate/node-runtime/init.js

@@ -0,0 +1,26 @@
+/**
+ * This file:
+ * - imports `isolated-vm`, which can only be made from a file that never runs
+ * on the client (e.g. Next's `_document.tsx`)
+ * - stores the ivm instance in a global variable using `setIvm`
+ *
+ * This is needed for when bundlers/meta-frameworks are not able to reliably
+ * import the `isolated-vm` package using our `safeDynamicRequire` trick.
+ *
+ * The `isolated-vm` import must exist in this separate file, or it will end up
+ * in the SDK's main entry point, causing errors for users.
+ */
+import ivm from 'isolated-vm';
+import { setIvm } from './node-runtime';
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export const initializeNodeRuntime = () => {
+    setIvm(ivm);
+};

package/lib/browser/functions/evaluate/node-runtime/node-runtime.d.ts

@@ -1,2 +1,8 @@
 import type { ExecutorArgs } from '../helpers';
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export declare const setIvm: (ivm: typeof import('isolated-vm')) => void;
 export declare const runInNode: ({ code, builder, context, event, localState, rootSetState, rootState }: ExecutorArgs) => any;

package/lib/browser/functions/evaluate/node-runtime/node-runtime.js

@@ -1,3 +1,4 @@
+import { MSG_PREFIX, logger } from '../../../helpers/logger';
 import { fastClone } from '../../fast-clone';
 import { set } from '../../set';
 import { getFunctionArguments } from '../helpers';
@@ -53,19 +54,44 @@ if (typeof output === 'object' && output !== null) {
 output;
 `;
 };
+let IVM_INSTANCE = null;
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export const setIvm = (ivm) => {
+    IVM_INSTANCE = ivm;
+};
+const getIvm = () => {
+    try {
+        if (IVM_INSTANCE)
+            return IVM_INSTANCE;
+        const dynRequiredIvm = safeDynamicRequire('isolated-vm');
+        if (dynRequiredIvm)
+            return dynRequiredIvm;
+    }
+    catch (error) {
+        logger.error('isolated-vm import error.', error);
+    }
+    throw new Error(`${MSG_PREFIX}could not import \`isolated-vm\` module for safe script execution on Node server.
+    
+    In certain Node environments, the SDK requires additional initialization steps. This can be achieved by 
+    importing and calling \`initializeNodeRuntime()\` from "@builder.io/sdk-react/node/init". This must be done in
+    a server-only execution path within your application.
+
+    Please see the documentation for more information: https://builder.io/c/docs/integration-tips#enabling-data-bindings-in-node-environments
+    `);
+};
 const getIsolateContext = () => {
-    // if (Builder.serverContext) {
-    //   return Builder.serverContext;
-    // }
-    // Builder.setServerContext(isolate.createContextSync());
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const isolate = new ivm.Isolate({
         memoryLimit: 128
     });
     return isolate.createContextSync();
 };
 export const runInNode = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const state = fastClone({
         ...rootState,
         ...localState

package/lib/browser/functions/get-content/types.d.ts

@@ -131,9 +131,9 @@ export interface GetContentOptions {
     /**
      * Optional override of the `fetch` function. (Defaults to global `fetch`)
      */
-    fetch?: typeof global.fetch;
+    fetch?: (input: string, init?: object) => Promise<any>;
     /**
-     * Optional fetch options to be passed to the `fetch` function.
+     * Optional fetch options to be passed as the second argument to the `fetch` function.
      */
-    fetchOptions?: RequestInit;
+    fetchOptions?: object;
 }

package/lib/browser/helpers/logger.d.ts

@@ -1,3 +1,4 @@
+export declare const MSG_PREFIX = "[Builder.io]: ";
 export declare const logger: {
     log: (...message: any[]) => void;
     error: (...message: any[]) => void;

package/lib/browser/helpers/logger.js

@@ -1,4 +1,4 @@
-const MSG_PREFIX = '[Builder.io]: ';
+export const MSG_PREFIX = '[Builder.io]: ';
 export const logger = {
     log: (...message) => console.log(MSG_PREFIX, ...message),
     error: (...message) => console.error(MSG_PREFIX, ...message),

package/lib/edge/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.20";
+export declare const SDK_VERSION = "1.0.21";

package/lib/edge/constants/sdk-version.js

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.20";
+export const SDK_VERSION = "1.0.21";

package/lib/edge/functions/evaluate/node-runtime/init.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export declare const initializeNodeRuntime: () => void;

package/lib/edge/functions/evaluate/node-runtime/init.js

@@ -0,0 +1,26 @@
+/**
+ * This file:
+ * - imports `isolated-vm`, which can only be made from a file that never runs
+ * on the client (e.g. Next's `_document.tsx`)
+ * - stores the ivm instance in a global variable using `setIvm`
+ *
+ * This is needed for when bundlers/meta-frameworks are not able to reliably
+ * import the `isolated-vm` package using our `safeDynamicRequire` trick.
+ *
+ * The `isolated-vm` import must exist in this separate file, or it will end up
+ * in the SDK's main entry point, causing errors for users.
+ */
+import ivm from 'isolated-vm';
+import { setIvm } from './node-runtime';
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export const initializeNodeRuntime = () => {
+    setIvm(ivm);
+};

package/lib/edge/functions/evaluate/node-runtime/node-runtime.d.ts

@@ -1,2 +1,8 @@
 import type { ExecutorArgs } from '../helpers';
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export declare const setIvm: (ivm: typeof import('isolated-vm')) => void;
 export declare const runInNode: ({ code, builder, context, event, localState, rootSetState, rootState }: ExecutorArgs) => any;

package/lib/edge/functions/evaluate/node-runtime/node-runtime.js

@@ -1,3 +1,4 @@
+import { MSG_PREFIX, logger } from '../../../helpers/logger';
 import { fastClone } from '../../fast-clone';
 import { set } from '../../set';
 import { getFunctionArguments } from '../helpers';
@@ -53,19 +54,44 @@ if (typeof output === 'object' && output !== null) {
 output;
 `;
 };
+let IVM_INSTANCE = null;
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export const setIvm = (ivm) => {
+    IVM_INSTANCE = ivm;
+};
+const getIvm = () => {
+    try {
+        if (IVM_INSTANCE)
+            return IVM_INSTANCE;
+        const dynRequiredIvm = safeDynamicRequire('isolated-vm');
+        if (dynRequiredIvm)
+            return dynRequiredIvm;
+    }
+    catch (error) {
+        logger.error('isolated-vm import error.', error);
+    }
+    throw new Error(`${MSG_PREFIX}could not import \`isolated-vm\` module for safe script execution on Node server.
+    
+    In certain Node environments, the SDK requires additional initialization steps. This can be achieved by 
+    importing and calling \`initializeNodeRuntime()\` from "@builder.io/sdk-react/node/init". This must be done in
+    a server-only execution path within your application.
+
+    Please see the documentation for more information: https://builder.io/c/docs/integration-tips#enabling-data-bindings-in-node-environments
+    `);
+};
 const getIsolateContext = () => {
-    // if (Builder.serverContext) {
-    //   return Builder.serverContext;
-    // }
-    // Builder.setServerContext(isolate.createContextSync());
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const isolate = new ivm.Isolate({
         memoryLimit: 128
     });
     return isolate.createContextSync();
 };
 export const runInNode = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const state = fastClone({
         ...rootState,
         ...localState

package/lib/edge/functions/get-content/types.d.ts

@@ -131,9 +131,9 @@ export interface GetContentOptions {
     /**
      * Optional override of the `fetch` function. (Defaults to global `fetch`)
      */
-    fetch?: typeof global.fetch;
+    fetch?: (input: string, init?: object) => Promise<any>;
     /**
-     * Optional fetch options to be passed to the `fetch` function.
+     * Optional fetch options to be passed as the second argument to the `fetch` function.
      */
-    fetchOptions?: RequestInit;
+    fetchOptions?: object;
 }

package/lib/edge/helpers/logger.d.ts

@@ -1,3 +1,4 @@
+export declare const MSG_PREFIX = "[Builder.io]: ";
 export declare const logger: {
     log: (...message: any[]) => void;
     error: (...message: any[]) => void;

package/lib/edge/helpers/logger.js

@@ -1,4 +1,4 @@
-const MSG_PREFIX = '[Builder.io]: ';
+export const MSG_PREFIX = '[Builder.io]: ';
 export const logger = {
     log: (...message) => console.log(MSG_PREFIX, ...message),
     error: (...message) => console.error(MSG_PREFIX, ...message),

package/lib/node/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.20";
+export declare const SDK_VERSION = "1.0.21";

package/lib/node/constants/sdk-version.js

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.20";
+export const SDK_VERSION = "1.0.21";

package/lib/node/functions/evaluate/node-runtime/init.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export declare const initializeNodeRuntime: () => void;

package/lib/node/functions/evaluate/node-runtime/init.js

@@ -0,0 +1,26 @@
+/**
+ * This file:
+ * - imports `isolated-vm`, which can only be made from a file that never runs
+ * on the client (e.g. Next's `_document.tsx`)
+ * - stores the ivm instance in a global variable using `setIvm`
+ *
+ * This is needed for when bundlers/meta-frameworks are not able to reliably
+ * import the `isolated-vm` package using our `safeDynamicRequire` trick.
+ *
+ * The `isolated-vm` import must exist in this separate file, or it will end up
+ * in the SDK's main entry point, causing errors for users.
+ */
+import ivm from 'isolated-vm';
+import { setIvm } from './node-runtime';
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export const initializeNodeRuntime = () => {
+    setIvm(ivm);
+};

package/lib/node/functions/evaluate/node-runtime/node-runtime.d.ts

@@ -1,2 +1,8 @@
 import type { ExecutorArgs } from '../helpers';
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export declare const setIvm: (ivm: typeof import('isolated-vm')) => void;
 export declare const runInNode: ({ code, builder, context, event, localState, rootSetState, rootState }: ExecutorArgs) => any;

package/lib/node/functions/evaluate/node-runtime/node-runtime.js

@@ -1,3 +1,4 @@
+import { MSG_PREFIX, logger } from '../../../helpers/logger';
 import { fastClone } from '../../fast-clone';
 import { set } from '../../set';
 import { getFunctionArguments } from '../helpers';
@@ -53,19 +54,44 @@ if (typeof output === 'object' && output !== null) {
 output;
 `;
 };
+let IVM_INSTANCE = null;
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export const setIvm = (ivm) => {
+    IVM_INSTANCE = ivm;
+};
+const getIvm = () => {
+    try {
+        if (IVM_INSTANCE)
+            return IVM_INSTANCE;
+        const dynRequiredIvm = safeDynamicRequire('isolated-vm');
+        if (dynRequiredIvm)
+            return dynRequiredIvm;
+    }
+    catch (error) {
+        logger.error('isolated-vm import error.', error);
+    }
+    throw new Error(`${MSG_PREFIX}could not import \`isolated-vm\` module for safe script execution on Node server.
+    
+    In certain Node environments, the SDK requires additional initialization steps. This can be achieved by 
+    importing and calling \`initializeNodeRuntime()\` from "@builder.io/sdk-react/node/init". This must be done in
+    a server-only execution path within your application.
+
+    Please see the documentation for more information: https://builder.io/c/docs/integration-tips#enabling-data-bindings-in-node-environments
+    `);
+};
 const getIsolateContext = () => {
-    // if (Builder.serverContext) {
-    //   return Builder.serverContext;
-    // }
-    // Builder.setServerContext(isolate.createContextSync());
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const isolate = new ivm.Isolate({
         memoryLimit: 128
     });
     return isolate.createContextSync();
 };
 export const runInNode = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
-    const ivm = safeDynamicRequire('isolated-vm');
+    const ivm = getIvm();
     const state = fastClone({
         ...rootState,
         ...localState

package/lib/node/functions/get-content/types.d.ts

@@ -131,9 +131,9 @@ export interface GetContentOptions {
     /**
      * Optional override of the `fetch` function. (Defaults to global `fetch`)
      */
-    fetch?: typeof global.fetch;
+    fetch?: (input: string, init?: object) => Promise<any>;
     /**
-     * Optional fetch options to be passed to the `fetch` function.
+     * Optional fetch options to be passed as the second argument to the `fetch` function.
      */
-    fetchOptions?: RequestInit;
+    fetchOptions?: object;
 }

package/lib/node/helpers/logger.d.ts

@@ -1,3 +1,4 @@
+export declare const MSG_PREFIX = "[Builder.io]: ";
 export declare const logger: {
     log: (...message: any[]) => void;
     error: (...message: any[]) => void;

package/lib/node/helpers/logger.js

@@ -1,4 +1,4 @@
-const MSG_PREFIX = '[Builder.io]: ';
+export const MSG_PREFIX = '[Builder.io]: ';
 export const logger = {
     log: (...message) => console.log(MSG_PREFIX, ...message),
     error: (...message) => console.error(MSG_PREFIX, ...message),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@builder.io/sdk-svelte",
   "description": "Builder.io SDK for Svelte",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "type": "module",
   "files": [
     "lib",

package/src/constants/sdk-version.ts

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.20"
+export const SDK_VERSION = "1.0.21"

package/src/functions/evaluate/node-runtime/init.ts

@@ -0,0 +1,27 @@
+/**
+ * This file:
+ * - imports `isolated-vm`, which can only be made from a file that never runs
+ * on the client (e.g. Next's `_document.tsx`)
+ * - stores the ivm instance in a global variable using `setIvm`
+ *
+ * This is needed for when bundlers/meta-frameworks are not able to reliably
+ * import the `isolated-vm` package using our `safeDynamicRequire` trick.
+ *
+ * The `isolated-vm` import must exist in this separate file, or it will end up
+ * in the SDK's main entry point, causing errors for users.
+ */
+import ivm from 'isolated-vm';
+import { setIvm } from './node-runtime';
+
+/**
+ * This function initializes the SDK on a Node server. It handles importing the
+ * `isolated-vm` package which is needed for dynamic bindings.
+ *
+ * NOTE: this function cannot be called on the client. You must call this function
+ * from a server-only location, such as:
+ * - The NextJS Pages router's `_document.tsx`
+ * - Your Remix route's `loader`
+ */
+export const initializeNodeRuntime = () => {
+  setIvm(ivm);
+}

package/src/functions/evaluate/node-runtime/node-runtime.ts

@@ -1,3 +1,4 @@
+import { MSG_PREFIX, logger } from '../../../helpers/logger';
 import { fastClone } from '../../fast-clone';
 import { set } from '../../set';
 import type { BuilderGlobals, ExecutorArgs, FunctionArguments } from '../helpers';
@@ -62,12 +63,35 @@ if (typeof output === 'object' && output !== null) {
 output;
 `;
 };
+let IVM_INSTANCE: typeof import('isolated-vm') | null = null;
+
+/**
+ * Set the `isolated-vm` instance to be used by the node runtime.
+ * This is useful for environments that are not able to rely on our
+ * `safeDynamicRequire` trick to import the `isolated-vm` package.
+ */
+export const setIvm = (ivm: typeof import('isolated-vm')) => {
+  IVM_INSTANCE = ivm;
+};
+const getIvm = (): typeof import('isolated-vm') => {
+  try {
+    if (IVM_INSTANCE) return IVM_INSTANCE;
+    const dynRequiredIvm = safeDynamicRequire('isolated-vm');
+    if (dynRequiredIvm) return dynRequiredIvm;
+  } catch (error) {
+    logger.error('isolated-vm import error.', error);
+  }
+  throw new Error(`${MSG_PREFIX}could not import \`isolated-vm\` module for safe script execution on Node server.
+    
+    In certain Node environments, the SDK requires additional initialization steps. This can be achieved by 
+    importing and calling \`initializeNodeRuntime()\` from "@builder.io/sdk-react/node/init". This must be done in
+    a server-only execution path within your application.
+
+    Please see the documentation for more information: https://builder.io/c/docs/integration-tips#enabling-data-bindings-in-node-environments
+    `);
+};
 const getIsolateContext = () => {
-  // if (Builder.serverContext) {
-  //   return Builder.serverContext;
-  // }
-  // Builder.setServerContext(isolate.createContextSync());
-  const ivm: typeof import('isolated-vm') = safeDynamicRequire('isolated-vm');
+  const ivm = getIvm();
   const isolate = new ivm.Isolate({
     memoryLimit: 128
   });
@@ -82,7 +106,7 @@ export const runInNode = ({
   rootSetState,
   rootState
 }: ExecutorArgs) => {
-  const ivm: typeof import('isolated-vm') = safeDynamicRequire('isolated-vm');
+  const ivm = getIvm();
   const state = fastClone({
     ...rootState,
     ...localState

package/src/functions/get-content/types.ts

@@ -148,10 +148,10 @@ export interface GetContentOptions {
   /**
    * Optional override of the `fetch` function. (Defaults to global `fetch`)
    */
-  fetch?: typeof global.fetch;
+  fetch?: (input: string, init?: object) => Promise<any>;
 
   /**
-   * Optional fetch options to be passed to the `fetch` function.
+   * Optional fetch options to be passed as the second argument to the `fetch` function.
    */
-  fetchOptions?: RequestInit;
+  fetchOptions?: object;
 }

package/src/helpers/logger.ts

@@ -1,4 +1,4 @@
-const MSG_PREFIX = '[Builder.io]: ';
+export const MSG_PREFIX = '[Builder.io]: ';
 export const logger = {
   log: (...message: any[]) => console.log(MSG_PREFIX, ...message),
   error: (...message: any[]) => console.error(MSG_PREFIX, ...message),