@builder.io/sdk-react-native 1.0.31-2 → 1.0.32

package/src/types/components.ts

@@ -1,119 +0,0 @@
-import type { BuilderElement } from './element';
-import type { Input } from './input';
-export interface ComponentInfo {
-  /**
-   * Name your component something unique, e.g. 'MyButton'. You can override built-in components
-   * by registering a component with the same name, e.g. 'Text', to replace the built-in text component
-   */
-  name: string;
-  description?: string;
-  /**
-   * Link to a documentation page for this component
-   */
-  docsLink?: string;
-  image?: string;
-  /**
-   * Input schema for your component for users to fill in the options
-   */
-  inputs?: Input[];
-  class?: any;
-  type?: 'angular' | 'webcomponent' | 'react' | 'vue';
-  defaultStyles?: {
-    [key: string]: string;
-  };
-  /**
-   * Turn on if your component can accept children. Be sure to use in combination with
-   * withChildren(YourComponent) like here
-   * github.com/BuilderIO/builder/blob/master/examples/react-design-system/src/components/HeroWithChildren/HeroWithChildren.builder.js#L5
-   */
-  canHaveChildren?: boolean;
-  fragment?: boolean;
-  /**
-   * Do not wrap a component in a dom element. Be sure to use {...props.attributes} with this option
-   * like here github.com/BuilderIO/builder/blob/master/packages/react/src/blocks/forms/Input.tsx#L34
-   */
-  noWrap?: boolean;
-
-  /**
-   * TO-DO: make this optional only for RSC SDK.
-   *
-   * Set this to `true` if your component is a React Server Component (RSC).
-   */
-  isRSC?: boolean;
-
-  /**
-   * Default children
-   */
-  defaultChildren?: BuilderElement[];
-  defaults?: Partial<BuilderElement>;
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  hooks?: {
-    [key: string]: string | Function;
-  };
-  /**
-   * Hide your component in editor, useful for gradually deprecating components
-   */
-  hideFromInsertMenu?: boolean;
-  // For webcomponents
-  tag?: string;
-  static?: boolean;
-  /**
-   * Passing a list of model names will restrict using the component to only the models listed here, otherwise it'll be available for all models
-   */
-  models?: string[];
-
-  /**
-   * Specify restrictions direct children must match
-   */
-  childRequirements?: {
-    /** Message to show when this doesn't match, e.g. "Children of 'Columns' must be a 'Column'" */
-    message: string;
-    /** Simple way to say children must be a specific component name */
-    component?: string;
-    /**
-     * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
-     * of what the children objects should match, e.g.
-     *
-     * @example
-     *  query: {
-     *    // Child of this element must be a 'Button' or 'Text' component
-     *    'component.name': { $in: ['Button', 'Text'] }
-     *  }
-     */
-    query?: any;
-  };
-
-  /**
-   * Specify restrictions any parent must match
-   */
-  requiresParent?: {
-    /** Message to show when this doesn't match, e.g. "'Add to cart' buttons must be within a 'Product box'" */
-    message: string;
-    /** Simple way to say a parent must be a specific component name, e.g. 'Product box' */
-    component?: string;
-
-    /**
-     * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
-     * of what at least one parent in the parents hierarchy should match, e.g.
-     *
-     * @example
-     *  query: {
-     *    // Thils element must be somewhere inside either a 'Product box' or 'Collection' component
-     *    'component.name': { $in: ['Product Box', 'Collection'] }
-     *  }
-     */
-    query?: any;
-  };
-  friendlyName?: string;
-
-  /**
-   * Use to restrict access to your component based on a the current user permissions
-   * By default components will show to all users
-   * for more information on permissions in builder check https://www.builder.io/c/docs/guides/roles-and-permissions
-   */
-  requiredPermissions?: Array<Permission>;
-
-  // TO-DO: is this used?
-  hidden?: boolean;
-}
-type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create'

package/src/types/deep-partial.ts

@@ -1 +0,0 @@
-export type DeepPartial<T> = { [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]> }

package/src/types/element.ts

@@ -1,57 +0,0 @@
-type JSONValue = string | number | boolean | JSONObject | JSONArray;
-interface JSONObject {
-  [x: string]: JSONValue;
-}
-interface JSONArray extends Array<JSONValue> {}
-
-/** @todo typedoc this */
-export interface BuilderElement {
-  '@type': '@builder.io/sdk:Element';
-  '@version'?: number;
-  id?: string;
-  tagName?: string;
-  layerName?: string;
-  groupLocked?: boolean;
-  layerLocked?: boolean;
-  /** @todo make alias for properties.class */
-  class?: string;
-  children?: BuilderElement[];
-  responsiveStyles?: {
-    large?: Partial<CSSStyleDeclaration>;
-    medium?: Partial<CSSStyleDeclaration>;
-    small?: Partial<CSSStyleDeclaration>;
-    /** @deprecated */
-    xsmall?: Partial<CSSStyleDeclaration>;
-  };
-  component?: {
-    name: string;
-    options?: any;
-    tag?: string;
-  };
-  bindings?: {
-    [key: string]: string;
-  };
-  meta?: {
-    [key: string]: JSONValue;
-  };
-  actions?: {
-    [key: string]: string;
-  };
-  properties?: {
-    [key: string]: string;
-  };
-  code?: {
-    bindings?: {
-      [key: string]: string;
-    };
-    actions?: {
-      [key: string]: string;
-    };
-  };
-  repeat?: {
-    collection: string;
-    itemName?: string;
-  } | null;
-  animations?: Animation[]; // TODO: type the animation spec
-}
-interface Animation {}

package/src/types/enforced-partials.ts

@@ -1,19 +0,0 @@
-import type { Prettify } from './typescript';
-
-/**
- * Lol Typescript
- * https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
- */
-type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
-type OptionalFieldsOnly<T> = { [K in keyof T as T[K] extends Required<T>[K] ? IfAny<T[K], K, never> : K]: T[K] };
-type RequiredFieldsOnly<T> = { [K in keyof T as T[K] extends Required<T>[K] ? IfAny<T[K], never, K> : never]: T[K] };
-type Enforced<T> = { [K in keyof T]-?: T[K] };
-type AndUndefined<T> = { [K in keyof T]: T[K] | undefined };
-
-/**
- * Enforce that all optional fields are undefined
- * @example
- * type Foo = { a: string, b?: number }
- * type Bar = EnforcePartials<Foo> // { a: string, b: number | undefined }
- */
-export type EnforcePartials<From> = Prettify<AndUndefined<Enforced<OptionalFieldsOnly<From>>> & RequiredFieldsOnly<From>>

package/src/types/input.ts

@@ -1,123 +0,0 @@
-export interface Input {
-  /** This is the name of the component prop this input represents */
-  name: string;
-  /** A friendlier name to show in the UI if the component prop name is not ideal for end users */
-  friendlyName?: string;
-  /** @hidden @deprecated */
-  description?: string;
-  /** A default value to use */
-  defaultValue?: any;
-  /**
-   * The type of input to use, such as 'text'
-   *
-   * See all available inputs [here](https://www.builder.io/c/docs/custom-react-components#input-types)
-   * and you can create your own custom input types and associated editor UIs with [plugins](https://www.builder.io/c/docs/extending/plugins)
-   */
-  type: string;
-  /** Is this input mandatory or not */
-  required?: boolean;
-  /** @hidden */
-  autoFocus?: boolean;
-  subFields?: Input[];
-  /**
-   * Additional text to render in the UI to give guidance on how to use this
-   *
-   * @example
-   * ```js
-   * helperText: 'Be sure to use a proper URL, starting with "https://"'
-   * 111
-   */
-  helperText?: string;
-  /** @hidden */
-  allowedFileTypes?: string[];
-  /** @hidden */
-  imageHeight?: number;
-  /** @hidden */
-  imageWidth?: number;
-  /** @hidden */
-  mediaHeight?: number;
-  /** @hidden */
-  mediaWidth?: number;
-  /** @hidden */
-  hideFromUI?: boolean;
-  /** @hidden */
-  modelId?: string;
-  /**
-   * Number field type validation maximum accepted input
-   */
-  max?: number;
-  /**
-   * Number field type validation minimum accepted input
-   */
-  min?: number;
-  /**
-   * Number field type step size when using arrows
-   */
-  step?: number;
-  /**
-   * Set this to `true` to show the editor for this input when
-   * children of this component are selected. This is useful for things
-   * like Tabs, such that users may not always select the Tabs component
-   * directly but will still be looking for how to add additional tabs
-   */
-  broadcast?: boolean;
-  /**
-   * Set this to `true` to show the editor for this input when
-   * group locked parents of this component are selected. This is useful
-   * to bubble up important inputs for locked groups, like text and images
-   */
-  bubble?: boolean;
-  /**
-   * Set this to `true` if you want this component to be translatable
-   */
-  localized?: boolean;
-  /** @hidden */
-  options?: {
-    [key: string]: any;
-  };
-  /**
-   * For "text" input type, specifying an enum will show a dropdown of options instead
-   */
-  enum?: string[] | {
-    label: string;
-    value: any;
-    helperText?: string;
-  }[];
-  /** Regex field validation for all string types (text, longText, html, url, etc) */
-  regex?: {
-    /** pattern to test, like "^\/[a-z]$" */
-    pattern: string;
-    /** flags for the RegExp constructor, e.g. "gi"  */
-    options?: string;
-    /**
-     * Friendly message to display to end-users if the regex fails, e.g.
-     * "You must use a relative url starting with '/...' "
-     */
-    message: string;
-  };
-  /**
-   * Set this to `true` to put this under the "show more" section of
-   * the options editor. Useful for things that are more advanced
-   * or more rarely used and don't need to be too prominent
-   */
-  advanced?: boolean;
-  /** @hidden */
-  // onChange?: Function | string;
-  /** @hidden */
-  code?: boolean;
-  /** @hidden */
-  richText?: boolean;
-  /** @hidden */
-  showIf?: ((options: Map<string, any>) => boolean) | string;
-  /** @hidden */
-  copyOnAdd?: boolean;
-  /**
-   * Use optionally with inputs of type `reference`. Restricts the content entry picker to a specific model by name.
-   */
-  model?: string;
-  valueType?: {
-    type?: string;
-  };
-  onChange?: ((options: Map<string, any>) => void | Promise<void>) | string;
-  meta?: Record<string, any>;
-}

package/src/types/targets.ts

@@ -1 +0,0 @@
-export type Target = 'vue' | 'reactNative' | 'svelte' | 'qwik' | 'react' | 'solid' | 'rsc' | 'angular'

package/src/types/typescript.ts

@@ -1,9 +0,0 @@
-export type Nullable<T> = T | null | undefined;
-export type Dictionary<T> = {
-  [key: string]: T;
-};
-export type Overwrite<T, U> = keyof U extends keyof T ? Pick<T, Exclude<keyof T, keyof U>> & U : never;
-export type Prettify<T> = {
-
-  // eslint-disable-next-line @typescript-eslint/ban-types
-[K in keyof T]: T[K] } & {}