@builder.io/sdk-react-native 1.0.31-0 → 1.0.31

package/src/functions/get-block-properties.ts

@@ -1,62 +0,0 @@
-import type { BuilderContextInterface } from '../context/types';
-import type { BuilderBlock } from '../types/builder-block';
-import { getClassPropName } from './get-class-prop-name';
-import { getStyle } from './get-style';
-import { transformBlockProperties } from './transform-block-properties';
-const extractRelevantRootBlockProperties = (block: BuilderBlock) => {
-  // currently we are only spreading the `href` property
-  // TO-DO: potentially spread all properties from block, but only if they are not already defined by BuilderBlock
-
-  // const {
-  //   '@type': _type,
-  //   '@version': _version,
-  //   id: _id,
-  //   tagName: _tagName,
-  //   layerName: _layerName,
-  //   groupLocked: _groupLocked,
-  //   layerLocked: _layerLocked,
-  //   class: _class,
-  //   children: _children,
-  //   responsiveStyles: _responsiveStyles,
-  //   component: _component,
-  //   bindings: _bindings,
-  //   meta: _meta,
-  //   actions: _actions,
-  //   properties: _properties,
-  //   code: _code,
-  //   repeat: _repeat,
-  //   animations: _animations,
-  //   style: _style,
-  //   hide: _hide,
-  //   show: _show,
-  //   // anything set by dynamic bindings outside of predefined `BuilderBlock` properties
-  //   ...remainingBlockProperties
-  // } = block;
-
-  return {
-    href: (block as any).href
-  };
-};
-export function getBlockProperties({
-  block,
-  context
-}: {
-  block: BuilderBlock;
-  context: BuilderContextInterface;
-}) {
-  const properties = {
-    ...extractRelevantRootBlockProperties(block),
-    ...block.properties,
-    'builder-id': block.id,
-    style: getStyle({
-      block,
-      context
-    }),
-    [getClassPropName()]: [block.id, 'builder-block', block.class, block.properties?.class].filter(Boolean).join(' ')
-  };
-  return transformBlockProperties({
-    properties,
-    context,
-    block
-  });
-}

package/src/functions/get-builder-search-params/index.ts

@@ -1,33 +0,0 @@
-import type { QueryObject } from '../../helpers/search/search';
-import { normalizeSearchParams } from '../../helpers/search/search';
-import { isBrowser } from '../is-browser';
-const BUILDER_SEARCHPARAMS_PREFIX = 'builder.';
-const BUILDER_OPTIONS_PREFIX = 'options.';
-
-/**
- * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
- * relevant to the Builder SDK.
- *
- * @returns
- */
-export const getBuilderSearchParams = (_options: QueryObject | URLSearchParams | undefined) => {
-  if (!_options) {
-    return {};
-  }
-  const options = normalizeSearchParams(_options);
-  const newOptions: QueryObject = {};
-  Object.keys(options).forEach(key => {
-    if (key.startsWith(BUILDER_SEARCHPARAMS_PREFIX)) {
-      const trimmedKey = key.replace(BUILDER_SEARCHPARAMS_PREFIX, '').replace(BUILDER_OPTIONS_PREFIX, '');
-      newOptions[trimmedKey] = options[key];
-    }
-  });
-  return newOptions;
-};
-export const getBuilderSearchParamsFromWindow = () => {
-  if (!isBrowser()) {
-    return {};
-  }
-  const searchParams = new URLSearchParams(window.location.search);
-  return getBuilderSearchParams(searchParams);
-}

package/src/functions/get-class-prop-name.ts

@@ -1,15 +0,0 @@
-import { TARGET } from '../constants/target';
-export const getClassPropName = () => {
-  switch (TARGET) {
-    case 'react':
-    case 'reactNative':
-    case 'rsc':
-      return 'className';
-    case 'svelte':
-    case 'vue':
-    case 'solid':
-    case 'qwik':
-    case 'angular':
-      return 'class';
-  }
-}

package/src/functions/get-content/generate-content-url.ts

@@ -1,88 +0,0 @@
-import { flatten, flattenMongoQuery } from '../../helpers/flatten';
-import { normalizeSearchParams } from '../../helpers/search/search';
-import { DEFAULT_API_VERSION } from '../../types/api-version';
-import { getBuilderSearchParamsFromWindow } from '../get-builder-search-params/index';
-import type { GetContentOptions } from './types';
-const isPositiveNumber = (thing: unknown) => typeof thing === 'number' && !isNaN(thing) && thing >= 0;
-export const generateContentUrl = (options: GetContentOptions): URL => {
-  const {
-    limit = 30,
-    userAttributes,
-    query,
-    model,
-    apiKey,
-    enrich,
-    locale,
-    apiVersion = DEFAULT_API_VERSION,
-    fields,
-    omit,
-    offset,
-    cacheSeconds,
-    staleCacheSeconds,
-    sort,
-    includeUnpublished
-  } = options;
-  if (!apiKey) {
-    throw new Error('Missing API key');
-  }
-  if (!['v3'].includes(apiVersion)) {
-    throw new Error(`Invalid apiVersion: expected 'v3', received '${apiVersion}'`);
-  }
-
-  // if we are fetching an array of content, we disable noTraverse for perf reasons.
-  const noTraverse = limit !== 1;
-  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}`);
-  url.searchParams.set('apiKey', apiKey);
-  url.searchParams.set('limit', String(limit));
-  url.searchParams.set('noTraverse', String(noTraverse));
-  url.searchParams.set('includeRefs', String(true));
-  if (locale) url.searchParams.set('locale', locale);
-  if (enrich) url.searchParams.set('enrich', String(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 flattened = flatten({
-      sort
-    });
-    for (const key in flattened) {
-      url.searchParams.set(key, JSON.stringify((flattened as any)[key]));
-    }
-  }
-
-  // TODO: how to express 'offset' in the url - as direct queryparam or as flattened in options[key] ?
-
-  const queryOptions = {
-    ...getBuilderSearchParamsFromWindow(),
-    ...normalizeSearchParams(options.options || {})
-  };
-  const flattened = flatten(queryOptions);
-  for (const key in flattened) {
-    url.searchParams.set(key, String(flattened[key]));
-  }
-  if (userAttributes) {
-    url.searchParams.set('userAttributes', JSON.stringify(userAttributes));
-  }
-  if (query) {
-    const flattened = flattenMongoQuery({
-      query
-    });
-    for (const key in flattened) {
-      url.searchParams.set(key, JSON.stringify(flattened[key]));
-    }
-  }
-  return url;
-}

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

@@ -1,99 +0,0 @@
-import { TARGET } from '../../constants/target';
-import { handleABTesting } from '../../helpers/ab-tests';
-import { getDefaultCanTrack } from '../../helpers/canTrack';
-import { logger } from '../../helpers/logger';
-import { getPreviewContent } from '../../helpers/preview-lru-cache/get';
-import type { BuilderContent } from '../../types/builder-content';
-import { fetch } from '../get-fetch';
-import { isBrowser } from '../is-browser';
-import { generateContentUrl } from './generate-content-url';
-import type { GetContentOptions } from './types';
-const checkContentHasResults = (content: ContentResponse): content is ContentResults => 'results' in content;
-
-/**
- * Returns the first content entry that matches the given options.
- */
-export async function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null> {
-  const allContent = await fetchEntries({
-    ...options,
-    limit: 1
-  });
-  if (allContent) {
-    return allContent[0] || null;
-  }
-  return null;
-}
-type ContentResults = {
-  results: BuilderContent[];
-};
-type ContentResponse = ContentResults | {
-  status: number;
-  message: string;
-};
-const _fetchContent = async (options: GetContentOptions) => {
-  const url = generateContentUrl(options);
-  const _fetch = options.fetch ?? fetch;
-  const res = await _fetch(url.href, options.fetchOptions);
-  const content = await (res.json() as Promise<ContentResponse>);
-  return content;
-};
-
-/**
- * @internal Exported only for testing purposes. Do not use.
- */
-export const _processContentResult = async (options: GetContentOptions, content: ContentResults, url: URL = generateContentUrl(options)): Promise<BuilderContent[]> => {
-  const canTrack = getDefaultCanTrack(options.canTrack);
-  const isPreviewing = url.search.includes(`preview=`);
-  if (TARGET === 'rsc' && isPreviewing) {
-    const newResults: BuilderContent[] = [];
-    for (const item of content.results) {
-      const previewContent = getPreviewContent(url.searchParams);
-      newResults.push(previewContent || item);
-    }
-    content.results = newResults;
-  }
-  if (!canTrack) return content.results;
-  if (!(isBrowser() || TARGET === 'reactNative')) return content.results;
-
-  /**
-   * For client-side navigations, it is ideal to handle AB testing at this point instead of using our
-   * complex multi-rendering variants approach, which is only needed for SSR'd content.
-   *
-   * This is also where react-native would handle AB testing.
-   */
-  try {
-    const newResults: BuilderContent[] = [];
-    for (const item of content.results) {
-      newResults.push(await handleABTesting({
-        item,
-        canTrack
-      }));
-    }
-    content.results = newResults;
-  } catch (e) {
-    logger.error('Could not process A/B tests. ', e);
-  }
-  return content.results;
-};
-
-/**
- * Returns a paginated array of entries that match the given options.
- */
-export async function fetchEntries(options: GetContentOptions) {
-  try {
-    const url = generateContentUrl(options);
-    const content = await _fetchContent(options);
-    if (!checkContentHasResults(content)) {
-      logger.error('Error fetching data. ', {
-        url,
-        content,
-        options
-      });
-      return null;
-    }
-    return _processContentResult(options, content);
-  } catch (error) {
-    logger.error('Error fetching data. ', error);
-    return null;
-  }
-}

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

@@ -1,157 +0,0 @@
-export interface GetContentOptions {
-  /** The model to get content for (required) */
-  model: string;
-
-  /** Your public API key (required) */
-  apiKey: string;
-
-  /** Number of items to fetch. Default is 1 */
-  limit?: number;
-
-  /**
-   * 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, any> & {
-    urlPath?: string;
-  }) | null;
-
-  /**
-   * 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.
-   * Accepts both a key/value object or a `URLSearchParams` instance
-   * */
-  options?: Record<string, any> | URLSearchParams;
-
-  /**
-   * If set to `false`, it will not use cookies to target content. Therefore, A/B Testing will be disabled and
-   * only the default variation will be returned to every user.
-   *
-   * Defaults to `true`.
-   */
-  canTrack?: boolean;
-
-  /**
-   * Include multilevel references in the response.
-   */
-  enrich?: boolean;
-
-  /**
-   * If provided, the API will auto-resolve localized objects to the value of this `locale` key.
-   */
-  locale?: string;
-
-  /**
-   * If provided, sets the Builder API version used to fetch content.
-   *
-   * Currently, the only available API version is `v3`.
-   */
-  apiVersion?: '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;
-
-  /**
-   * Optional override of the `fetch` function. (Defaults to global `fetch`)
-   */
-  fetch?: (input: string, init?: object) => Promise<any>;
-
-  /**
-   * Optional fetch options to be passed as the second argument to the `fetch` function.
-   */
-  fetchOptions?: object;
-}

package/src/functions/get-env.ts

@@ -1,5 +0,0 @@
-export const validEnvList = ['production', 'qa', 'test', 'development', 'dev', 'cdn-qa', 'cloud', 'fast', 'cdn2', 'cdn-prod'];
-export const getEnv = (): string => {
-  const env = process.env.NODE_ENV || 'production';
-  return validEnvList.includes(env) ? env : 'production';
-}

package/src/functions/get-fetch.ts

@@ -1,11 +0,0 @@
-import { getGlobalThis } from './get-global-this';
-function getFetch(): typeof global.fetch {
-  const globalFetch: typeof global.fetch = getGlobalThis().fetch;
-  if (typeof globalFetch === 'undefined') {
-    console.warn(`Builder SDK could not find a global fetch function. Make sure you have a polyfill for fetch in your project. 
-      For more information, read https://github.com/BuilderIO/this-package-uses-fetch`);
-    throw new Error('Builder SDK could not find a global `fetch` function');
-  }
-  return globalFetch;
-}
-export const fetch = getFetch()

package/src/functions/get-global-this.ts

@@ -1,16 +0,0 @@
-type Global = typeof global | typeof window | typeof self | typeof globalThis;
-export function getGlobalThis(): Global {
-  if (typeof globalThis !== 'undefined') {
-    return globalThis;
-  }
-  if (typeof window !== 'undefined') {
-    return window;
-  }
-  if (typeof global !== 'undefined') {
-    return global;
-  }
-  if (typeof self !== 'undefined') {
-    return self;
-  }
-  return globalThis;
-}

package/src/functions/get-processed-block.ts

@@ -1,70 +0,0 @@
-import type { BuilderContextInterface } from '../context/types';
-import type { BuilderBlock } from '../types/builder-block';
-import { evaluate } from './evaluate/index';
-import { fastClone } from './fast-clone';
-import { set } from './set';
-import { transformBlock } from './transform-block';
-const evaluateBindings = ({
-  block,
-  context,
-  localState,
-  rootState,
-  rootSetState
-}: {
-  block: BuilderBlock;
-} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock => {
-  if (!block.bindings) {
-    return block;
-  }
-  const copy = fastClone(block);
-  const copied = {
-    ...copy,
-    properties: {
-      ...copy.properties
-    },
-    actions: {
-      ...copy.actions
-    }
-  };
-  for (const binding in block.bindings) {
-    const expression = block.bindings[binding];
-    const value = evaluate({
-      code: expression,
-      localState,
-      rootState,
-      rootSetState,
-      context,
-      enableCache: true
-    });
-    set(copied, binding, value);
-  }
-  return copied;
-};
-export function getProcessedBlock({
-  block,
-  context,
-  shouldEvaluateBindings,
-  localState,
-  rootState,
-  rootSetState
-}: {
-  block: BuilderBlock;
-  /**
-   * In some cases, we want to avoid evaluating bindings and only want framework-specific block transformation. It is
-   * also sometimes too early to consider bindings, e.g. when we might be looking at a repeated block.
-   */
-  shouldEvaluateBindings: boolean;
-} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock {
-  const transformedBlock = transformBlock(block);
-  if (shouldEvaluateBindings) {
-    return evaluateBindings({
-      block: transformedBlock,
-      localState,
-      rootState,
-      rootSetState,
-      context
-    });
-  } else {
-    return transformedBlock;
-  }
-}

package/src/functions/get-style.ts

@@ -1,38 +0,0 @@
-import { TARGET } from '../constants/target';
-import type { BuilderContextInterface } from '../context/types';
-import { convertStyleMapToCSSArray } from '../helpers/css';
-import type { BuilderBlock } from '../types/builder-block';
-import { transformStyleProperty } from './transform-style-property';
-export const getStyle = ({
-  block,
-  context
-}: {
-  block: BuilderBlock;
-  context: BuilderContextInterface;
-}) => {
-  return mapStyleObjToStrIfNeeded(transformStyleProperty({
-    style: block.style || {},
-    context,
-    block
-  }));
-};
-
-/**
- * Svelte does not support style attribute as an object so we need to flatten it.
- *
- * Additionally, Svelte, Vue and other frameworks use kebab-case styles, so we need to convert them.
- */
-export function mapStyleObjToStrIfNeeded(style: Partial<CSSStyleDeclaration>): string | Partial<CSSStyleDeclaration> {
-  switch (TARGET) {
-    case 'svelte':
-    case 'vue':
-    case 'solid':
-    case 'angular':
-      return convertStyleMapToCSSArray(style).join(' ');
-    case 'qwik':
-    case 'reactNative':
-    case 'react':
-    case 'rsc':
-      return style;
-  }
-}

package/src/functions/get.ts

@@ -1,4 +0,0 @@
-export const get = (obj: any, path: string, defaultValue?: any) => {
-  const result = String.prototype.split.call(path, /[,[\].]+?/).filter(Boolean).reduce((res, key) => res !== null && res !== undefined ? res[key] : res, obj);
-  return result === undefined || result === obj ? defaultValue : result;
-}

package/src/functions/is-browser.ts

@@ -1,3 +0,0 @@
-export function isBrowser(): boolean {
-  return typeof window !== 'undefined' && typeof document !== 'undefined';
-}

package/src/functions/is-edge-runtime.ts

@@ -1,9 +0,0 @@
-import { isBrowser } from './is-browser';
-import { isNodeRuntime } from './is-node-runtime';
-
-/**
- * Identifies edge runtimes (edge, workers, serverless, etc.)
- */
-export function isEdgeRuntime(): boolean {
-  return !isBrowser() && !isNodeRuntime();
-}

package/src/functions/is-editing.ts

@@ -1,8 +0,0 @@
-import { TARGET } from '../constants/target';
-import { getSearchString, type Search } from '../helpers/search/search';
-import { isIframe } from './is-iframe';
-export function isEditing(search?: Search) {
-  return isIframe() && (TARGET === 'reactNative' ||
-  // accessing window.location.search is safe here because `isIframe()` is only `true` if we're in a browser.
-  getSearchString(search || window.location.search).indexOf('builder.frameEditing=') !== -1);
-}

package/src/functions/is-from-trusted-host.ts

@@ -1,8 +0,0 @@
-const DEFAULT_TRUSTED_HOSTS = ['*.beta.builder.io', 'beta.builder.io', 'builder.io', 'localhost', 'qa.builder.io'];
-export function isFromTrustedHost(trustedHosts: string[] | undefined, e: {
-  origin: string;
-}): boolean {
-  const url = new URL(e.origin),
-    hostname = url.hostname;
-  return (trustedHosts || DEFAULT_TRUSTED_HOSTS).findIndex(trustedHost => trustedHost.startsWith('*.') ? hostname.endsWith(trustedHost.slice(1)) : trustedHost === hostname) > -1;
-}

package/src/functions/is-iframe.ts

@@ -1,4 +0,0 @@
-import { isBrowser } from './is-browser';
-export function isIframe(): boolean {
-  return isBrowser() && window.self !== window.top;
-}

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

@@ -1,8 +0,0 @@
-import { checkIsDefined } from '../helpers/nullable';
-
-/**
- * Identifies node runtime
- */
-export function isNodeRuntime(): boolean {
-  return typeof process !== 'undefined' && checkIsDefined(process?.versions?.node);
-}

package/src/functions/is-previewing.ts

@@ -1,16 +0,0 @@
-import type { Search } from '../helpers/search/search';
-import { getSearchString } from '../helpers/search/search';
-import { isBrowser } from './is-browser';
-export function isPreviewing(_search?: Search) {
-  const search = _search || (isBrowser() ? window.location.search : undefined);
-
-  /**
-   * If this function is called on the server without an explicit `search` argument,
-   * then it can't check if the user is previewing, and will return `false`.
-   */
-  if (!search) {
-    return false;
-  }
-  const normalizedSearch = getSearchString(search);
-  return Boolean(normalizedSearch.indexOf('builder.preview=') !== -1);
-}