@builder.io/sdk-qwik 0.7.1-3 → 0.7.1-5

package/lib/node/index.qwik.cjs

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const qwik = require("@builder.io/qwik");
 const jsxRuntime = require("@builder.io/qwik/jsx-runtime");
+const nodeEvaluate = require("./node-evaluate-fc9f27d1.cjs");
+const build = require("@builder.io/qwik/build");
+require("node:module");
 const Button = /* @__PURE__ */ qwik.componentQrl(/* @__PURE__ */ qwik.inlinedQrl((props) => {
   qwik.useStylesScopedQrl(/* @__PURE__ */ qwik.inlinedQrl(STYLES$3, "Button_component_useStylesScoped_a1JZ0Q0Q2Oc"));
   return /* @__PURE__ */ qwik._jsxC(jsxRuntime.Fragment, {
@@ -120,6 +123,127 @@ const getFunctionArguments = ({ builder, context, event, state }) => {
     event
   });
 };
+const getBuilderGlobals = () => ({
+  isEditing: isEditing(),
+  isBrowser: isBrowser(),
+  isServer: !isBrowser(),
+  getUserAttributes: () => getUserAttributes()
+});
+const parseCode = (code, { isExpression = true }) => {
+  const useReturn = (
+    // we disable this for cases where we definitely don't want a return
+    isExpression && !(code.includes(";") || code.includes(" return ") || code.trim().startsWith("return "))
+  );
+  const useCode = useReturn ? `return (${code});` : code;
+  return useCode;
+};
+const fastClone = (obj) => JSON.parse(JSON.stringify(obj));
+const set = (obj, _path, value) => {
+  if (Object(obj) !== obj)
+    return obj;
+  const path = Array.isArray(_path) ? _path : _path.toString().match(/[^.[\]]+/g);
+  path.slice(0, -1).reduce((a, c, i) => Object(a[c]) === a[c] ? a[c] : a[c] = Math.abs(Number(path[i + 1])) >> 0 === +path[i + 1] ? [] : {}, obj)[path[path.length - 1]] = value;
+  return obj;
+};
+const ivm = nodeEvaluate.safeDynamicRequire("isolated-vm");
+const getSyncValName = (key) => `bldr_${key}_sync`;
+const BUILDER_SET_STATE_NAME = "BUILDER_SET_STATE";
+const INJECTED_IVM_GLOBAL = "BUILDER_IVM";
+const REF_TO_PROXY_FN = `
+var refToProxy = (obj) => {
+  if (typeof obj !== 'object' || obj === null) {
+    return obj;
+  }
+  return new Proxy({}, {
+    get(target, key) {
+        if (key === 'copySync') {
+          return () => obj.copySync();
+        }
+        const val = obj.getSync(key);
+        if (typeof val?.getSync === 'function') {
+            return refToProxy(val);
+        }
+        return val;
+    },
+    set(target, key, value) {
+        const v = typeof value === 'object' ? new ${INJECTED_IVM_GLOBAL}.Reference(value) : value;
+        obj.setSync(key, v);
+        ${BUILDER_SET_STATE_NAME}(key, value)
+    },
+    deleteProperty(target, key) {
+        obj.deleteSync(key);
+    }
+  })
+}
+`;
+const processCode = ({ code, args }) => {
+  const fnArgs = args.map(([name]) => `var ${name} = refToProxy(${getSyncValName(name)}); `).join("");
+  return `
+${REF_TO_PROXY_FN}
+${fnArgs}
+function theFunction() {
+  ${code}
+}
+
+let output = theFunction()
+
+if (typeof output === 'object' && output !== null) {
+  output = JSON.stringify(output.copySync ? output.copySync() : output);
+}
+
+output;
+`;
+};
+const getIsolateContext = () => {
+  const isolate = new ivm.Isolate({
+    memoryLimit: 128
+  });
+  return isolate.createContextSync();
+};
+const runInNode = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
+  const state = fastClone({
+    ...rootState,
+    ...localState
+  });
+  const args = getFunctionArguments({
+    builder,
+    context,
+    event,
+    state
+  });
+  const isolateContext = getIsolateContext();
+  const jail = isolateContext.global;
+  jail.setSync("global", jail.derefInto());
+  jail.setSync("log", function(...logArgs) {
+    console.log(...logArgs);
+  });
+  jail.setSync(BUILDER_SET_STATE_NAME, function(key, value) {
+    set(rootState, key, value);
+    rootSetState == null ? void 0 : rootSetState(rootState);
+  });
+  args.forEach(([key, arg]) => {
+    const val = typeof arg === "object" ? new ivm.Reference(
+      // workaround: methods with default values for arguments is not being cloned over
+      key === "builder" ? {
+        ...arg,
+        getUserAttributes: () => arg.getUserAttributes()
+      } : arg
+    ) : null;
+    jail.setSync(getSyncValName(key), val);
+  });
+  jail.setSync(INJECTED_IVM_GLOBAL, ivm);
+  const evalStr = processCode({
+    code,
+    args
+  });
+  const resultStr = isolateContext.evalSync(evalStr);
+  try {
+    const res = JSON.parse(resultStr);
+    return res;
+  } catch (_error) {
+    return resultStr;
+  }
+};
 const runInBrowser = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
   const functionArgs = getFunctionArguments({
     builder,
@@ -147,25 +271,17 @@ function flattenState(rootState, localState, rootSetState) {
     }
   });
 }
+const chooseBrowserOrServerEval = (args) => !build.isServer ? runInBrowser(args) : runInNode(args);
 function evaluate({ code, context, localState, rootState, rootSetState, event, isExpression = true }) {
   if (code === "") {
     logger.warn("Skipping evaluation of empty code block.");
     return;
   }
-  const builder = {
-    isEditing: isEditing(),
-    isBrowser: isBrowser(),
-    isServer: !isBrowser(),
-    getUserAttributes: () => getUserAttributes()
-  };
-  const useReturn = (
-    // we disable this for cases where we definitely don't want a return
-    isExpression && !(code.includes(";") || code.includes(" return ") || code.trim().startsWith("return "))
-  );
-  const useCode = useReturn ? `return (${code});` : code;
   const args = {
-    code: useCode,
-    builder,
+    code: parseCode(code, {
+      isExpression
+    }),
+    builder: getBuilderGlobals(),
     context,
     event,
     rootSetState,
@@ -173,7 +289,7 @@ function evaluate({ code, context, localState, rootState, rootSetState, event, i
     localState
   };
   try {
-    return runInBrowser(args);
+    return chooseBrowserOrServerEval(args);
   } catch (e) {
     logger.error("Failed code evaluation: " + e.message, {
       code
@@ -181,14 +297,6 @@ function evaluate({ code, context, localState, rootState, rootSetState, event, i
     return void 0;
   }
 }
-const fastClone = (obj) => JSON.parse(JSON.stringify(obj));
-const set = (obj, _path, value) => {
-  if (Object(obj) !== obj)
-    return obj;
-  const path = Array.isArray(_path) ? _path : _path.toString().match(/[^.[\]]+/g);
-  path.slice(0, -1).reduce((a, c, i) => Object(a[c]) === a[c] ? a[c] : a[c] = Math.abs(Number(path[i + 1])) >> 0 === +path[i + 1] ? [] : {}, obj)[path[path.length - 1]] = value;
-  return obj;
-};
 function transformBlock(block) {
   return block;
 }
@@ -2809,9 +2917,10 @@ const getBuilderSearchParamsFromWindow = () => {
 };
 const normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchParams ? convertSearchParamsToQueryObject(searchParams) : searchParams;
 const DEFAULT_API_VERSION = "v3";
+const isPositiveNumber = (thing) => typeof thing === "number" && !isNaN(thing) && thing >= 0;
 const generateContentUrl = (options) => {
   let { noTraverse = false } = options;
-  const { limit = 30, userAttributes, query, model, apiKey, includeRefs = true, enrich, locale, apiVersion = DEFAULT_API_VERSION } = options;
+  const { limit = 30, userAttributes, query, model, apiKey, includeRefs = true, enrich, locale, apiVersion = DEFAULT_API_VERSION, fields, omit, offset, cacheSeconds, staleCacheSeconds, sort, includeUnpublished } = options;
   if (!apiKey)
     throw new Error("Missing API key");
   if (![
@@ -2822,6 +2931,24 @@ const generateContentUrl = (options) => {
   if ((options.limit === void 0 || options.limit > 1) && !("noTraverse" in options))
     noTraverse = true;
   const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}?apiKey=${apiKey}&limit=${limit}&noTraverse=${noTraverse}&includeRefs=${includeRefs}${locale ? `&locale=${locale}` : ""}${enrich ? `&enrich=${enrich}` : ""}`);
+  url.searchParams.set("omit", omit || "meta.componentsUsed");
+  if (fields)
+    url.searchParams.set("fields", fields);
+  if (Number.isFinite(offset) && offset > -1)
+    url.searchParams.set("offset", String(Math.floor(offset)));
+  if (typeof includeUnpublished === "boolean")
+    url.searchParams.set("includeUnpublished", String(includeUnpublished));
+  if (cacheSeconds && isPositiveNumber(cacheSeconds))
+    url.searchParams.set("cacheSeconds", String(cacheSeconds));
+  if (staleCacheSeconds && isPositiveNumber(staleCacheSeconds))
+    url.searchParams.set("staleCacheSeconds", String(staleCacheSeconds));
+  if (sort) {
+    const flattened2 = flatten({
+      sort
+    });
+    for (const key in flattened2)
+      url.searchParams.set(key, JSON.stringify(flattened2[key]));
+  }
   const queryOptions = {
     ...getBuilderSearchParamsFromWindow(),
     ...normalizeSearchParams(options.options || {})
@@ -3095,7 +3222,7 @@ const getInteractionPropertiesForEvent = (event) => {
     }
   };
 };
-const SDK_VERSION = "0.7.1-3";
+const SDK_VERSION = "0.7.1-4";
 const registry = {};
 function register(type, info) {
   let typeList = registry[type];

package/lib/node/index.qwik.mjs

@@ -1,5 +1,8 @@
 import { componentQrl, inlinedQrl, useStylesScopedQrl, _jsxC, _jsxS, _fnSignal, createContextId, _jsxQ, _jsxBranch, useComputedQrl, useLexicalScope, _IMMUTABLE, Slot, useStore, useContextProvider, _wrapProp, useContext, createElement, Fragment as Fragment$1, useSignal, useTaskQrl, useOn } from "@builder.io/qwik";
 import { Fragment } from "@builder.io/qwik/jsx-runtime";
+import { s as safeDynamicRequire } from "./node-evaluate-15fe5e77.js";
+import { isServer } from "@builder.io/qwik/build";
+import "node:module";
 const Button = /* @__PURE__ */ componentQrl(/* @__PURE__ */ inlinedQrl((props) => {
   useStylesScopedQrl(/* @__PURE__ */ inlinedQrl(STYLES$3, "Button_component_useStylesScoped_a1JZ0Q0Q2Oc"));
   return /* @__PURE__ */ _jsxC(Fragment, {
@@ -118,6 +121,127 @@ const getFunctionArguments = ({ builder, context, event, state }) => {
     event
   });
 };
+const getBuilderGlobals = () => ({
+  isEditing: isEditing(),
+  isBrowser: isBrowser(),
+  isServer: !isBrowser(),
+  getUserAttributes: () => getUserAttributes()
+});
+const parseCode = (code, { isExpression = true }) => {
+  const useReturn = (
+    // we disable this for cases where we definitely don't want a return
+    isExpression && !(code.includes(";") || code.includes(" return ") || code.trim().startsWith("return "))
+  );
+  const useCode = useReturn ? `return (${code});` : code;
+  return useCode;
+};
+const fastClone = (obj) => JSON.parse(JSON.stringify(obj));
+const set = (obj, _path, value) => {
+  if (Object(obj) !== obj)
+    return obj;
+  const path = Array.isArray(_path) ? _path : _path.toString().match(/[^.[\]]+/g);
+  path.slice(0, -1).reduce((a, c, i) => Object(a[c]) === a[c] ? a[c] : a[c] = Math.abs(Number(path[i + 1])) >> 0 === +path[i + 1] ? [] : {}, obj)[path[path.length - 1]] = value;
+  return obj;
+};
+const ivm = safeDynamicRequire("isolated-vm");
+const getSyncValName = (key) => `bldr_${key}_sync`;
+const BUILDER_SET_STATE_NAME = "BUILDER_SET_STATE";
+const INJECTED_IVM_GLOBAL = "BUILDER_IVM";
+const REF_TO_PROXY_FN = `
+var refToProxy = (obj) => {
+  if (typeof obj !== 'object' || obj === null) {
+    return obj;
+  }
+  return new Proxy({}, {
+    get(target, key) {
+        if (key === 'copySync') {
+          return () => obj.copySync();
+        }
+        const val = obj.getSync(key);
+        if (typeof val?.getSync === 'function') {
+            return refToProxy(val);
+        }
+        return val;
+    },
+    set(target, key, value) {
+        const v = typeof value === 'object' ? new ${INJECTED_IVM_GLOBAL}.Reference(value) : value;
+        obj.setSync(key, v);
+        ${BUILDER_SET_STATE_NAME}(key, value)
+    },
+    deleteProperty(target, key) {
+        obj.deleteSync(key);
+    }
+  })
+}
+`;
+const processCode = ({ code, args }) => {
+  const fnArgs = args.map(([name]) => `var ${name} = refToProxy(${getSyncValName(name)}); `).join("");
+  return `
+${REF_TO_PROXY_FN}
+${fnArgs}
+function theFunction() {
+  ${code}
+}
+
+let output = theFunction()
+
+if (typeof output === 'object' && output !== null) {
+  output = JSON.stringify(output.copySync ? output.copySync() : output);
+}
+
+output;
+`;
+};
+const getIsolateContext = () => {
+  const isolate = new ivm.Isolate({
+    memoryLimit: 128
+  });
+  return isolate.createContextSync();
+};
+const runInNode = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
+  const state = fastClone({
+    ...rootState,
+    ...localState
+  });
+  const args = getFunctionArguments({
+    builder,
+    context,
+    event,
+    state
+  });
+  const isolateContext = getIsolateContext();
+  const jail = isolateContext.global;
+  jail.setSync("global", jail.derefInto());
+  jail.setSync("log", function(...logArgs) {
+    console.log(...logArgs);
+  });
+  jail.setSync(BUILDER_SET_STATE_NAME, function(key, value) {
+    set(rootState, key, value);
+    rootSetState == null ? void 0 : rootSetState(rootState);
+  });
+  args.forEach(([key, arg]) => {
+    const val = typeof arg === "object" ? new ivm.Reference(
+      // workaround: methods with default values for arguments is not being cloned over
+      key === "builder" ? {
+        ...arg,
+        getUserAttributes: () => arg.getUserAttributes()
+      } : arg
+    ) : null;
+    jail.setSync(getSyncValName(key), val);
+  });
+  jail.setSync(INJECTED_IVM_GLOBAL, ivm);
+  const evalStr = processCode({
+    code,
+    args
+  });
+  const resultStr = isolateContext.evalSync(evalStr);
+  try {
+    const res = JSON.parse(resultStr);
+    return res;
+  } catch (_error) {
+    return resultStr;
+  }
+};
 const runInBrowser = ({ code, builder, context, event, localState, rootSetState, rootState }) => {
   const functionArgs = getFunctionArguments({
     builder,
@@ -145,25 +269,17 @@ function flattenState(rootState, localState, rootSetState) {
     }
   });
 }
+const chooseBrowserOrServerEval = (args) => !isServer ? runInBrowser(args) : runInNode(args);
 function evaluate({ code, context, localState, rootState, rootSetState, event, isExpression = true }) {
   if (code === "") {
     logger.warn("Skipping evaluation of empty code block.");
     return;
   }
-  const builder = {
-    isEditing: isEditing(),
-    isBrowser: isBrowser(),
-    isServer: !isBrowser(),
-    getUserAttributes: () => getUserAttributes()
-  };
-  const useReturn = (
-    // we disable this for cases where we definitely don't want a return
-    isExpression && !(code.includes(";") || code.includes(" return ") || code.trim().startsWith("return "))
-  );
-  const useCode = useReturn ? `return (${code});` : code;
   const args = {
-    code: useCode,
-    builder,
+    code: parseCode(code, {
+      isExpression
+    }),
+    builder: getBuilderGlobals(),
     context,
     event,
     rootSetState,
@@ -171,7 +287,7 @@ function evaluate({ code, context, localState, rootState, rootSetState, event, i
     localState
   };
   try {
-    return runInBrowser(args);
+    return chooseBrowserOrServerEval(args);
   } catch (e) {
     logger.error("Failed code evaluation: " + e.message, {
       code
@@ -179,14 +295,6 @@ function evaluate({ code, context, localState, rootState, rootSetState, event, i
     return void 0;
   }
 }
-const fastClone = (obj) => JSON.parse(JSON.stringify(obj));
-const set = (obj, _path, value) => {
-  if (Object(obj) !== obj)
-    return obj;
-  const path = Array.isArray(_path) ? _path : _path.toString().match(/[^.[\]]+/g);
-  path.slice(0, -1).reduce((a, c, i) => Object(a[c]) === a[c] ? a[c] : a[c] = Math.abs(Number(path[i + 1])) >> 0 === +path[i + 1] ? [] : {}, obj)[path[path.length - 1]] = value;
-  return obj;
-};
 function transformBlock(block) {
   return block;
 }
@@ -2807,9 +2915,10 @@ const getBuilderSearchParamsFromWindow = () => {
 };
 const normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchParams ? convertSearchParamsToQueryObject(searchParams) : searchParams;
 const DEFAULT_API_VERSION = "v3";
+const isPositiveNumber = (thing) => typeof thing === "number" && !isNaN(thing) && thing >= 0;
 const generateContentUrl = (options) => {
   let { noTraverse = false } = options;
-  const { limit = 30, userAttributes, query, model, apiKey, includeRefs = true, enrich, locale, apiVersion = DEFAULT_API_VERSION } = options;
+  const { limit = 30, userAttributes, query, model, apiKey, includeRefs = true, enrich, locale, apiVersion = DEFAULT_API_VERSION, fields, omit, offset, cacheSeconds, staleCacheSeconds, sort, includeUnpublished } = options;
   if (!apiKey)
     throw new Error("Missing API key");
   if (![
@@ -2820,6 +2929,24 @@ const generateContentUrl = (options) => {
   if ((options.limit === void 0 || options.limit > 1) && !("noTraverse" in options))
     noTraverse = true;
   const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}?apiKey=${apiKey}&limit=${limit}&noTraverse=${noTraverse}&includeRefs=${includeRefs}${locale ? `&locale=${locale}` : ""}${enrich ? `&enrich=${enrich}` : ""}`);
+  url.searchParams.set("omit", omit || "meta.componentsUsed");
+  if (fields)
+    url.searchParams.set("fields", fields);
+  if (Number.isFinite(offset) && offset > -1)
+    url.searchParams.set("offset", String(Math.floor(offset)));
+  if (typeof includeUnpublished === "boolean")
+    url.searchParams.set("includeUnpublished", String(includeUnpublished));
+  if (cacheSeconds && isPositiveNumber(cacheSeconds))
+    url.searchParams.set("cacheSeconds", String(cacheSeconds));
+  if (staleCacheSeconds && isPositiveNumber(staleCacheSeconds))
+    url.searchParams.set("staleCacheSeconds", String(staleCacheSeconds));
+  if (sort) {
+    const flattened2 = flatten({
+      sort
+    });
+    for (const key in flattened2)
+      url.searchParams.set(key, JSON.stringify(flattened2[key]));
+  }
   const queryOptions = {
     ...getBuilderSearchParamsFromWindow(),
     ...normalizeSearchParams(options.options || {})
@@ -3093,7 +3220,7 @@ const getInteractionPropertiesForEvent = (event) => {
     }
   };
 };
-const SDK_VERSION = "0.7.1-3";
+const SDK_VERSION = "0.7.1-4";
 const registry = {};
 function register(type, info) {
   let typeList = registry[type];

package/lib/node/node-evaluate-15fe5e77.js

@@ -0,0 +1,10 @@
+import { createRequire } from "node:module";
+const noop = () => null;
+let safeDynamicRequire = noop;
+try {
+  safeDynamicRequire = createRequire(import.meta.url);
+} catch (error) {
+}
+export {
+  safeDynamicRequire as s
+};

package/lib/node/node-evaluate-fc9f27d1.cjs

@@ -0,0 +1,8 @@
+"use strict";
+const node_module = require("node:module");
+const noop = () => null;
+exports.safeDynamicRequire = noop;
+try {
+  exports.safeDynamicRequire = node_module.createRequire(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : document.currentScript && document.currentScript.src || new URL("node-evaluate-fc9f27d1.cjs", document.baseURI).href);
+} catch (error) {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/sdk-qwik",
-  "version": "0.7.1-3",
+  "version": "0.7.1-5",
   "description": "Builder.io Qwik SDK",
   "type": "module",
   "main": "./lib/edge/index.qwik.cjs",
@@ -109,6 +109,7 @@
   },
   "peerDependencies": {
     "@builder.io/qwik": ">=1.0.0",
+    "isolated-vm": "^4.6.0",
     "undici": "^5.14.0"
   },
   "nx": {

package/types/src/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.7.1-3";
+export declare const SDK_VERSION = "0.7.1-4";

package/types/src/functions/evaluate/choose-eval.d.ts

@@ -0,0 +1,6 @@
+import type { ExecutorArgs } from './helpers.js';
+/**
+ * Even though we have separate runtimes for browser/node/edge, sometimes frameworks will
+ * end up sending the server runtime code to the browser (most notably in dev mode).
+ */
+export declare const chooseBrowserOrServerEval: (args: ExecutorArgs) => any;

package/types/src/functions/evaluate/evaluate.d.ts

@@ -1,6 +1,2 @@
-import type { ExecutorArgs } from './helpers.js';
-export type EvaluatorArgs = Omit<ExecutorArgs, 'builder' | 'event'> & {
-    event?: Event;
-    isExpression?: boolean;
-};
+import type { EvaluatorArgs } from './helpers.js';
 export declare function evaluate({ code, context, localState, rootState, rootSetState, event, isExpression }: EvaluatorArgs): any;

package/types/src/functions/evaluate/helpers.d.ts

@@ -1,5 +1,9 @@
 import type { BuilderContextInterface, BuilderRenderState } from '../../context/types.js';
-import type { getUserAttributes } from '../track/helpers.js';
+import { getUserAttributes } from '../track/helpers.js';
+export type EvaluatorArgs = Omit<ExecutorArgs, 'builder' | 'event'> & {
+    event?: Event;
+    isExpression?: boolean;
+};
 export type BuilderGlobals = {
     isEditing: boolean | undefined;
     isBrowser: boolean | undefined;
@@ -16,3 +20,5 @@ export type FunctionArguments = ReturnType<typeof getFunctionArguments>;
 export declare const getFunctionArguments: ({ builder, context, event, state }: Pick<ExecutorArgs, "context" | "builder" | "event"> & {
     state: BuilderRenderState;
 }) => [string, Event | BuilderRenderState | import("../../context/types.js").BuilderRenderContext | BuilderGlobals | undefined][];
+export declare const getBuilderGlobals: () => BuilderGlobals;
+export declare const parseCode: (code: string, { isExpression }: Pick<EvaluatorArgs, 'isExpression'>) => string;

package/types/src/functions/evaluate/node-runtime/index.d.ts

@@ -1 +1 @@
-export { evaluator } from '../browser-runtime/index.js';
+export { runInNode as evaluator } from './node-runtime.js';

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

@@ -1,2 +1,2 @@
 import type { ExecutorArgs } from '../helpers.js';
-export declare const evaluator: ({ code, builder, context, event, localState, rootSetState, rootState }: ExecutorArgs) => any;
+export declare const runInNode: ({ code, builder, context, event, localState, rootSetState, rootState }: ExecutorArgs) => any;

package/types/src/functions/evaluate/node-runtime/safeDynamicRequire.d.ts

@@ -0,0 +1,7 @@
+/**
+ * We use the less hacky, but more modern `createRequire` API for Qwik. That's because the `eval('require')` trick does
+ * not work with Qwik.
+ */
+/// <reference types="node" />
+/// <reference types="react-native" />
+export declare let safeDynamicRequire: typeof require;

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

@@ -5,11 +5,42 @@ export interface GetContentOptions {
     apiKey: string;
     /** Number of items to fetch. Default is 1 */
     limit?: number;
-    /** User attributes to target on, such as { urlPath: '/foo', device: 'mobile', ...etc } */
+    /**
+     * Use to specify an offset for pagination of results. The default is 0.
+     */
+    offset?: number;
+    /**
+     * User attribute key value pairs to be used for targeting
+     * https://www.builder.io/c/docs/custom-targeting-attributes
+     *
+     * e.g.
+     * ```js
+     * userAttributes: {
+     *   urlPath: '/',
+     *   returnVisitor: true,
+     *   device: 'mobile'
+     * }
+     * ```
+     */
     userAttributes?: (Record<string, string> & {
         urlPath?: string;
     }) | null;
-    /** Custom query */
+    /**
+     * Mongodb style query of your data. E.g.:
+     *
+     * ```js
+     * query: {
+     *  id: 'abc123',
+     *  data: {
+     *    myCustomField: { $gt: 20 },
+     *  }
+     * }
+     * ```
+     *
+     * See more info on MongoDB's query operators and format.
+     *
+     * @see {@link https://docs.mongodb.com/manual/reference/operator/query/}
+     */
     query?: Record<string, any>;
     /**
      * Any other API options.
@@ -30,7 +61,7 @@ export interface GetContentOptions {
      */
     canTrack?: boolean;
     /**
-     * Include references in the response. Defaults to `true`.
+     * Include content of references in the response. Defaults to `true`.
      * @deprecated use `enrich` instead
      */
     includeRefs?: boolean;
@@ -48,4 +79,64 @@ export interface GetContentOptions {
      * Defaults to `v3`.
      */
     apiVersion?: 'v2' | 'v3';
+    /**
+     * Only include these fields.
+     * Note: 'omit' takes precedence over 'fields'
+     *
+     * @example
+     * ```
+     * fields: 'id, name, data.customField'
+     * ```
+     */
+    fields?: string;
+    /**
+     * Omit only these fields.
+     * Note: 'omit' takes precedence over 'fields'
+     *
+     * @example
+     * ```
+     * omit: 'data.bigField,data.blocks'
+     * ```
+     */
+    omit?: string;
+    /**
+     * Seconds to cache content. Sets the max-age of the cache-control header
+     * response header.
+     *
+     * Use a higher value for better performance, lower for content that will change more frequently
+     *
+     * @see {@link https://www.builder.io/c/docs/query-api#__next:~:text=%26includeRefs%3Dtrue-,cacheSeconds,-No}
+     */
+    cacheSeconds?: number;
+    /**
+     * Builder.io uses stale-while-revalidate caching at the CDN level. This means we always serve
+     * from edge cache and update caches in the background for maximum possible performance. This also
+     * means that the more frequently content is requested, the more fresh it will be. The longest we
+     * will ever hold something in stale cache is 1 day by default, and you can set this to be shorter
+     * yourself as well. We suggest keeping this high unless you have content that must change rapidly
+     * and gets very little traffic.
+     *
+     * @see {@link https://www.fastly.com/blog/prevent-application-network-instability-serve-stale-content}
+     */
+    staleCacheSeconds?: number;
+    /**
+     * Property to order results by.
+     * Use 1 for ascending and -1 for descending.
+     *
+     * The key is what you're sorting on, so the following example sorts by createdDate
+     * and because the value is 1, the sort is ascending.
+     *
+     * @example
+     * ```
+     * createdDate: 1
+     * ```
+     */
+    sort?: {
+        [key: string]: 1 | -1;
+    };
+    /**
+     * Include content entries in a response that are still in
+     * draft mode and un-archived. Default is false.
+     */
+    includeUnpublished?: boolean;
 }