@rippling/rippling-sdk 0.2.0-alpha.32 → 0.2.0-alpha.34

package/src/lib/manifest/index.ts

@@ -0,0 +1,114 @@
+/** Manifest builder public API (hand-written, not Stainless-generated). */
+
+export {
+  generateId,
+  type EdgeType,
+  type FieldType,
+  type FormulaFieldType,
+  type FunctionRuntime,
+  type ObjectScope,
+  type PageType,
+  type SortOrder,
+  type SummaryAggregation,
+  type SummaryFilterOperator,
+  type TriggerType,
+  type UpdateTriggerType,
+  type ValidationLevel,
+  type ValidationState,
+} from './_helpers';
+
+export { App, type AppIcon, type AppPage, type AppProps } from './app';
+
+export { Category, type CategoryProps } from './category';
+
+export { CustomObject, type CustomObjectProps, type IconConfig } from './custom-object';
+
+export { CustomObjectFieldSection, type CustomObjectFieldSectionProps } from './custom-object-field-section';
+
+export {
+  CustomObjectPageLayout,
+  type CustomObjectPageLayoutProps,
+  type CustomTab,
+  type FieldsSection,
+  type HeaderEdits,
+  type NewHeaderField,
+  type PageLayoutSection,
+  type PageLayoutTab,
+  type SectionField,
+  type SectionFieldsLayout,
+  type SystemHeaderFieldEdit,
+  type SystemSectionEdit,
+  type SystemTabEdit,
+  type TabEdits,
+  type TabWithSections,
+  type VisibilityCondition,
+  type VisibilityConditions,
+} from './custom-object-page-layout';
+
+export {
+  Field,
+  type FieldProps,
+  type SummaryFilter,
+
+  // Concrete field variants (one class per wire-level field type, mirroring
+  // AWS CDK's per-action-class pattern in `aws-codepipeline-actions`).
+  TextField,
+  type TextFieldProps,
+  LongTextField,
+  type LongTextFieldProps,
+  EmailField,
+  type EmailFieldProps,
+  UrlField,
+  type UrlFieldProps,
+  PhoneField,
+  type PhoneFieldProps,
+  NumberField,
+  type NumberFieldProps,
+  CurrencyField,
+  type CurrencyFieldProps,
+  PercentageField,
+  type PercentageFieldProps,
+  DateField,
+  type DateFieldProps,
+  DatetimeField,
+  type DatetimeFieldProps,
+  TimeField,
+  type TimeFieldProps,
+  SelectField,
+  type SelectFieldProps,
+  RadioField,
+  type RadioFieldProps,
+  BooleanField,
+  type BooleanFieldProps,
+  FileField,
+  type FileFieldProps,
+  LookupField,
+  type LookupFieldProps,
+  ParentChildField,
+  type ParentChildFieldProps,
+  FormulaField,
+  type FormulaFieldProps,
+  SummaryField,
+  type SummaryFieldProps,
+} from './field';
+
+export { ListViewDef, type ListViewDefProps } from './list-view';
+
+export {
+  ManifestBuilder,
+  type ManifestBuilderProps,
+  type ManifestComponent,
+  type ManifestScope,
+} from './manifest-builder';
+
+export {
+  ManifestFunction,
+  ManifestFunction as Function,
+  type ManifestFunctionProps,
+} from './manifest-function';
+
+export { Rule, type RuleAction, type RuleProps } from './rule';
+
+export { SduiPage, type SduiPageProps } from './sdui-page';
+
+export { Validation, type ValidationProps } from './validation';

package/src/lib/manifest/list-view.ts

@@ -0,0 +1,103 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * List view definitions for custom objects (column layout + sorting).
+ * Backend schema: CUSTOM_OBJECT_LIST_VIEW (v2)
+ *
+ * Construction is CDK-style: `new ListViewDef(customObject, props)` — the
+ * CO is the first positional arg, and the view auto-registers with the
+ * manifest via the CO's scope chain.
+ */
+
+import { generateId, type ObjectScope, type SortOrder } from './_helpers';
+import type { CustomObject } from './custom-object';
+import type { Field } from './field';
+
+export interface ListViewDefProps {
+  /** Required. Display name of the view. */
+  name: string;
+  /** Required. Column definitions (live `Field` refs; at least one). */
+  fields: Field[];
+  /** Required. Whether the view is visible to all users. */
+  isPublic: boolean;
+  /** Identity override. Override the view identifier. @default generateId('view') */
+  viewId?: string;
+  /** Optional. Sort column (live `Field` ref). Required if `sortOrder` is set. */
+  orderBy?: Field;
+  /** Conditional. Sort direction — requires `orderBy`. */
+  sortOrder?: SortOrder;
+  /** Optional. Object scope. @default 'all' */
+  objectScope?: ObjectScope;
+  /** Optional. Free-form description. @default null */
+  description?: string;
+  /** Optional. Per-column configuration overrides. @default {} */
+  columnConfig?: Record<string, any>;
+  /** Optional. RQL filter expression. @default null */
+  rqlFilter?: string;
+}
+
+export class ListViewDef {
+  private readonly _viewId: string;
+  private readonly _customObjectApiName: string;
+  private readonly _name: string;
+  private readonly _fields: Field[];
+  private readonly _isPublic: boolean;
+  private readonly _orderBy: Field | undefined;
+  private readonly _sortOrder: SortOrder | undefined;
+  private readonly _objectScope: ObjectScope | undefined;
+  private readonly _description: string | undefined;
+  private readonly _columnConfig: Record<string, any> | undefined;
+  private readonly _rqlFilter: string | undefined;
+
+  /** Build a new view def and auto-register with the CO's scope. */
+  constructor(customObject: CustomObject, props: ListViewDefProps) {
+    if (!props.name) throw new Error('ListViewDef: name cannot be empty');
+    if (!props.fields || props.fields.length === 0) {
+      throw new Error('ListViewDef: must have at least one field');
+    }
+    if (props.sortOrder && !props.orderBy) {
+      throw new Error('ListViewDef: sortOrder requires orderBy to be set');
+    }
+    this._viewId = props.viewId ?? generateId('view');
+    this._customObjectApiName = customObject.getApiName();
+    this._name = props.name;
+    this._fields = [...props.fields];
+    this._isPublic = props.isPublic;
+    this._orderBy = props.orderBy;
+    this._sortOrder = props.sortOrder;
+    this._objectScope = props.objectScope ?? 'all';
+    this._description = props.description;
+    this._columnConfig = props.columnConfig;
+    this._rqlFilter = props.rqlFilter;
+    customObject._register(this);
+  }
+
+  /** Backend view_id used as this view's identifier. */
+  getViewId(): string {
+    return this._viewId;
+  }
+
+  /** api_name of the CustomObject this view lives on. */
+  getCustomObjectApiName(): string {
+    return this._customObjectApiName;
+  }
+
+  /** Serialize to the backend `CUSTOM_OBJECT_LIST_VIEW` wire shape. */
+  toDict(): Record<string, any> {
+    const d: Record<string, any> = {
+      type: 'CUSTOM_OBJECT_LIST_VIEW',
+      object_rql_name: this._customObjectApiName,
+      view_id: this._viewId,
+      name: this._name,
+      public: this._isPublic,
+      fields: this._fields.map((f) => f.getApiName()),
+    };
+    if (this._description != null) d['description'] = this._description;
+    if (this._objectScope != null) d['object_scope'] = this._objectScope;
+    if (this._sortOrder != null) d['sort_order'] = this._sortOrder;
+    if (this._orderBy != null) d['order_by'] = this._orderBy.getApiName();
+    if (this._columnConfig != null) d['column_config'] = this._columnConfig;
+    if (this._rqlFilter != null) d['rql_filter'] = this._rqlFilter;
+    return d;
+  }
+}

package/src/lib/manifest/manifest-builder.ts

@@ -0,0 +1,97 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * ManifestBuilder collects manifest components and serializes to JSON.
+ *
+ * Wiring model (CDK-style scope-first):
+ *   - Every component takes its parent scope as the first positional
+ *     constructor arg. The scope is either a `ManifestBuilder` (root) or a
+ *     `CustomObject` / `CustomObjectFieldSection` for nested children.
+ *   - Constructing a component auto-registers it with the builder via the
+ *     scope's `_register` hook. There is no public `addComponent` — the
+ *     only way a component enters the manifest is by being constructed
+ *     with a scope that forwards up to this builder.
+ *   - The builder does not walk into components; each component emits the
+ *     foreign-key fields (`custom_object_api_name`, `model_rql_name`, ...)
+ *     itself in `toDict()`.
+ *
+ * Local operations only (no HTTP):
+ *   - preview()         — render manifest as a JSON string
+ *   - buildManifest()   — return the manifest as a plain object
+ *   - componentsList()  — return the flat list of component dicts
+ */
+
+/** Any object with a toDict() method can be a manifest component. */
+export interface ManifestComponent {
+  toDict(): Record<string, any>;
+}
+
+/**
+ * A scope — anything that can accept a child component for registration.
+ * Implemented by `ManifestBuilder` (root) and by nestable parents like
+ * `CustomObject` and `CustomObjectFieldSection` that forward to the builder.
+ */
+export interface ManifestScope {
+  /** @internal Register a child component; builder-bound scopes forward up. */
+  _register(component: ManifestComponent): void;
+}
+
+export interface ManifestBuilderProps {
+  /** Unique project key for this manifest. */
+  key: string;
+  /** Display name (defaults to key if not provided). */
+  name?: string;
+  /** Optional description. */
+  description?: string;
+}
+
+export class ManifestBuilder implements ManifestScope {
+  readonly key: string;
+  readonly name: string;
+  readonly description: string;
+  private readonly _components: ManifestComponent[] = [];
+
+  /** Build a new manifest; `name` defaults to `key` when unset. */
+  constructor(props: ManifestBuilderProps) {
+    if (!props.key) {
+      throw new Error('key is required');
+    }
+    this.key = props.key;
+    this.name = props.name || props.key;
+    this.description = props.description ?? '';
+  }
+
+  /**
+   * @internal Scope hook invoked by child constructors. Components enter the
+   * manifest here — there is no other path.
+   */
+  _register(component: ManifestComponent): void {
+    if (typeof component.toDict !== 'function') {
+      throw new TypeError('Component must have a toDict() method');
+    }
+    this._components.push(component);
+  }
+
+  /** Build the manifest object: metadata + flat component list. */
+  buildManifest(): { metadata: Record<string, any>; components: Record<string, any>[] } {
+    const metadata: Record<string, any> = {
+      key: this.key,
+      name: this.name,
+    };
+    if (this.description) {
+      metadata['description'] = this.description;
+    }
+    const components = this._components.map((c) => c.toDict());
+    return { metadata, components };
+  }
+
+  /** Flat list of all component dicts. */
+  componentsList(): Record<string, any>[] {
+    return this._components.map((c) => c.toDict());
+  }
+
+  /** Pretty-printed JSON string. */
+  preview(): string {
+    return JSON.stringify(this.buildManifest(), null, 2);
+  }
+}

package/src/lib/manifest/manifest-function.ts

@@ -0,0 +1,81 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * Custom function definitions (TypeScript handler code).
+ * Backend schema: FUNCTION (v2)
+ *
+ * Named ManifestFunction to avoid collision with the JavaScript built-in Function.
+ * Re-exported as both ManifestFunction and Function from the barrel.
+ */
+
+import type { FunctionRuntime } from './_helpers';
+import type { ManifestScope } from './manifest-builder';
+
+export interface ManifestFunctionProps {
+  /** Required. Function api_name (snake_case identifier). */
+  apiName: string;
+  /** Required. Display name shown in the UI. */
+  name: string;
+  /** Optional. TypeScript handler source; must export `onRipplingEvent`. @default '' */
+  code?: string;
+  /** Optional. Function description. @default '' */
+  description?: string;
+  /** Optional. NPM package dependencies. @default null */
+  dependencies?: Record<string, string>;
+  /** Optional. Raw deployment options. Prefer `runtime`. @default null */
+  deploymentOptions?: Record<string, any>;
+  /** Optional. Shorthand: sets `deploymentOptions.runtime`. */
+  runtime?: FunctionRuntime;
+  /** Optional. Outbound domain allowlist. @default null */
+  allowedDomains?: string[];
+  /** Optional. Whether the function runs asynchronously. @default false */
+  isAsync?: boolean;
+}
+
+export class ManifestFunction {
+  private readonly _apiName: string;
+  private readonly _name: string;
+  private readonly _code: string;
+  private readonly _description: string;
+  private readonly _dependencies: Record<string, string> | undefined;
+  private readonly _deploymentOptions: Record<string, any> | undefined;
+  private readonly _allowedDomains: string[] | undefined;
+  private readonly _isAsync: boolean;
+
+  /** Build a new function and auto-register with `scope`; `runtime` is merged into `deploymentOptions` if set. */
+  constructor(scope: ManifestScope, props: ManifestFunctionProps) {
+    this._apiName = props.apiName;
+    this._name = props.name;
+    this._code = props.code ?? '';
+    this._description = props.description ?? '';
+    this._dependencies = props.dependencies;
+    this._deploymentOptions = props.deploymentOptions;
+    if (props.runtime) {
+      this._deploymentOptions = { ...(this._deploymentOptions ?? {}), runtime: props.runtime };
+    }
+    this._allowedDomains = props.allowedDomains;
+    this._isAsync = props.isAsync ?? false;
+    scope._register(this);
+  }
+
+  /** Backend api_name for this function. */
+  getApiName(): string {
+    return this._apiName;
+  }
+
+  /** Serialize to the backend `FUNCTION` wire shape; empty fields are omitted. */
+  toDict(): Record<string, any> {
+    const component: Record<string, any> = {
+      type: 'FUNCTION',
+      name: this._name,
+      api_name: this._apiName,
+    };
+    if (this._description) component['description'] = this._description;
+    if (this._code) component['code_draft'] = this._code;
+    if (this._dependencies != null) component['dependencies'] = this._dependencies;
+    if (this._deploymentOptions != null) component['deployment_options'] = this._deploymentOptions;
+    if (this._allowedDomains != null) component['allowed_domains'] = this._allowedDomains;
+    if (this._isAsync) component['is_async'] = true;
+    return component;
+  }
+}

package/src/lib/manifest/rule.ts

@@ -0,0 +1,125 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * Record-triggered flows (automation rules) for custom objects.
+ * Backend schema: CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW (v2)
+ *
+ * Construction is CDK-style: `new Rule(customObject, props)` — the CO is
+ * the first positional arg, and the rule auto-registers with the manifest
+ * via the CO's scope chain.
+ */
+
+import { generateId, type TriggerType, type UpdateTriggerType } from './_helpers';
+import type { CustomObject } from './custom-object';
+import type { Field } from './field';
+
+const VALID_TRIGGERS: TriggerType[] = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
+
+export interface RuleAction {
+  /** Target field — live `Field` ref. */
+  targetField: Field;
+  /**
+   * Set the target to a fixed value. Mutually exclusive with `rqlFormula`.
+   * For `SELECT` / `RADIO` targets, the wire payload uses a list (multichoice
+   * shape); pass a string/one value or an array — both are normalized to an array.
+   */
+  fixedValue?: any;
+  /** Set the target to the result of an RQL formula. */
+  rqlFormula?: string;
+}
+
+export interface RuleProps {
+  /** Required. Display name of the flow. */
+  flowName: string;
+  /** Required. When the flow fires. */
+  triggerType: TriggerType;
+  /** Identity override. Override the flow identifier. @default generateId('flow') */
+  flowId?: string;
+  /** Optional. RQL formula guard — fires only when truthy. @default null */
+  rqlCondition?: string;
+  /** Conditional. Update-trigger condition type. @default 'MEETS_CONDITION_AFTER_ONLY' */
+  updateTriggerType?: UpdateTriggerType;
+  /** Optional. Internal description. @default null */
+  description?: string;
+  /** Optional. Actions to run when the flow fires. @default [] */
+  actions?: RuleAction[];
+}
+
+/** SELECT / RADIO rule actions use list `fixed_value` (Rippling rule builder). */
+function fixedValueToWire(targetField: Field, value: any): any {
+  const ft = targetField.getFieldType();
+  if (ft !== 'SELECT' && ft !== 'RADIO') {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    return value;
+  }
+  return [value];
+}
+
+function actionToDict(action: RuleAction): Record<string, any> {
+  const out: Record<string, any> = {
+    target_field: action.targetField.getApiName(),
+  };
+  if (action.fixedValue != null) {
+    out['fixed_value'] = fixedValueToWire(action.targetField, action.fixedValue);
+  } else if (action.rqlFormula != null) {
+    out['rql_formula'] = action.rqlFormula;
+  }
+  return out;
+}
+
+export class Rule {
+  private readonly _flowId: string;
+  private readonly _customObjectApiName: string;
+  private readonly _flowName: string;
+  private readonly _triggerType: TriggerType;
+  private readonly _rqlCondition: string | undefined;
+  private readonly _updateTriggerType: UpdateTriggerType | undefined;
+  private readonly _description: string | undefined;
+  private readonly _actions: RuleAction[];
+
+  /** Build a new rule and auto-register with the CO's scope; validates `triggerType`. */
+  constructor(customObject: CustomObject, props: RuleProps) {
+    if (!VALID_TRIGGERS.includes(props.triggerType)) {
+      throw new Error(
+        `Invalid trigger_type: ${props.triggerType}. Must be one of: ${VALID_TRIGGERS.join(', ')}`,
+      );
+    }
+    this._flowId = props.flowId ?? generateId('flow');
+    this._customObjectApiName = customObject.getApiName();
+    this._flowName = props.flowName;
+    this._triggerType = props.triggerType;
+    this._rqlCondition = props.rqlCondition;
+    this._updateTriggerType = props.updateTriggerType;
+    this._description = props.description;
+    this._actions = [...(props.actions ?? [])];
+    customObject._register(this);
+  }
+
+  /** Backend flow_id used as this rule's identifier. */
+  getFlowId(): string {
+    return this._flowId;
+  }
+
+  /** api_name of the CustomObject this rule lives on. */
+  getCustomObjectApiName(): string {
+    return this._customObjectApiName;
+  }
+
+  /** Serialize to the backend `CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW` wire shape. */
+  toDict(): Record<string, any> {
+    const component: Record<string, any> = {
+      type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW',
+      model_rql_name: this._customObjectApiName,
+      flow_id: this._flowId,
+      flow_name: this._flowName,
+      trigger_type: this._triggerType,
+    };
+    if (this._description != null) component['description'] = this._description;
+    if (this._updateTriggerType != null) component['update_trigger_type'] = this._updateTriggerType;
+    if (this._rqlCondition != null) component['rql_condition'] = this._rqlCondition;
+    if (this._actions.length > 0) component['actions'] = this._actions.map(actionToDict);
+    return component;
+  }
+}

package/src/lib/manifest/sdui-page.ts

@@ -0,0 +1,72 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * SDUI page definitions for Unity packages.
+ * Backend schema: SDUI_PAGE (v2) — `SDUIPageConfig` in
+ * `app/hub_platform/sdui/unity_package/sdui_page_interface.py`.
+ *
+ * Dependency order: FUNCTION → SDUI_PAGE → CUSTOM_APP.
+ */
+
+import type { ManifestFunction } from './manifest-function';
+import type { ManifestScope } from './manifest-builder';
+
+export interface SduiPageProps {
+  /** Required. Unique ID for this page within the package. */
+  sduiPageId: string;
+  /** Required. Display name shown as the tab label. */
+  name: string;
+  /**
+   * Required. Backing function. Pass a live `ManifestFunction` ref (the SDK
+   * reads its api_name) or a raw api_name string for functions authored
+   * outside this manifest.
+   */
+  function: ManifestFunction | string;
+  /** Optional. Human-readable description. */
+  description?: string;
+}
+
+export class SduiPage {
+  private readonly _sduiPageId: string;
+  private readonly _name: string;
+  private readonly _functionApiName: string;
+  private readonly _description: string;
+
+  /** Build a new SDUI page and auto-register with `scope`; resolves the function api_name eagerly. */
+  constructor(scope: ManifestScope, props: SduiPageProps) {
+    if (!props.sduiPageId) throw new Error('sduiPageId is required');
+    if (!props.name) throw new Error('name is required');
+    if (!props.function) throw new Error('function is required');
+    this._sduiPageId = props.sduiPageId;
+    this._name = props.name;
+    this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
+    this._description = props.description ?? '';
+    scope._register(this);
+  }
+
+  /** Identifier slug for this page within the package. */
+  getSduiPageId(): string {
+    return this._sduiPageId;
+  }
+
+  /** Display name (tab label). */
+  getName(): string {
+    return this._name;
+  }
+
+  /** api_name of the function backing this page. */
+  getFunctionApiName(): string {
+    return this._functionApiName;
+  }
+
+  /** Serialize to the backend `SDUI_PAGE` wire shape. */
+  toDict(): Record<string, any> {
+    return {
+      type: 'SDUI_PAGE',
+      name: this._name,
+      sdui_page_id: this._sduiPageId,
+      function_api_name: this._functionApiName,
+      description: this._description,
+    };
+  }
+}

package/src/lib/manifest/validation.ts

@@ -0,0 +1,87 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * Validation rules for custom objects (RQL formulas with violation semantics).
+ * Backend schema: CUSTOM_OBJECT_VALIDATION_RULE (v2)
+ *
+ * VIOLATION SEMANTICS: `rqlFormula` returns true when the record is INVALID.
+ * Construction is CDK-style: `new Validation(customObject, props)` — the CO
+ * is the first positional arg, and the validation auto-registers with the
+ * manifest via the CO's scope chain.
+ */
+
+import { generateId, type ValidationLevel, type ValidationState } from './_helpers';
+import type { CustomObject } from './custom-object';
+import type { Field } from './field';
+
+export interface ValidationProps {
+  /** Required. Display name of the validation rule. */
+  displayName: string;
+  /** Required. RQL formula — returns true when the record is INVALID. */
+  rqlFormula: string;
+  /** Required. User-facing error message (empty string for no message). */
+  errorMessage: string;
+  /** Required. Rule state. */
+  state: ValidationState;
+  /** Required. Rule level. */
+  level: ValidationLevel;
+  /** Required. Internal description (empty string if unused). */
+  ruleDescription: string;
+  /** Identity override. Override the rule identifier. @default generateId('rule') */
+  ruleId?: string;
+  /** Optional. Field reference (typically paired with `level: 'FIELD'`). */
+  fieldRef?: Field;
+}
+
+export class Validation {
+  private readonly _ruleId: string;
+  private readonly _customObjectApiName: string;
+  private readonly _displayName: string;
+  private readonly _rqlFormula: string;
+  private readonly _errorMessage: string;
+  private readonly _state: ValidationState;
+  private readonly _level: ValidationLevel;
+  private readonly _ruleDescription: string;
+  private readonly _fieldRef: Field | undefined;
+
+  /** Build a new validation rule and auto-register with the CO's scope. */
+  constructor(customObject: CustomObject, props: ValidationProps) {
+    this._ruleId = props.ruleId ?? generateId('rule');
+    this._customObjectApiName = customObject.getApiName();
+    this._displayName = props.displayName;
+    this._rqlFormula = props.rqlFormula;
+    this._errorMessage = props.errorMessage;
+    this._state = props.state;
+    this._level = props.level;
+    this._ruleDescription = props.ruleDescription;
+    this._fieldRef = props.fieldRef;
+    customObject._register(this);
+  }
+
+  /** Backend rule_id used as this validation's identifier. */
+  getRuleId(): string {
+    return this._ruleId;
+  }
+
+  /** api_name of the CustomObject this validation lives on. */
+  getCustomObjectApiName(): string {
+    return this._customObjectApiName;
+  }
+
+  /** Serialize to the backend `CUSTOM_OBJECT_VALIDATION_RULE` wire shape. */
+  toDict(): Record<string, any> {
+    const component: Record<string, any> = {
+      type: 'CUSTOM_OBJECT_VALIDATION_RULE',
+      model_rql_name: this._customObjectApiName,
+      rule_id: this._ruleId,
+      state: this._state,
+      level: this._level,
+      display_name: this._displayName,
+      rule_description: this._ruleDescription,
+      custom_error_message: this._errorMessage,
+      rql_formula: this._rqlFormula,
+    };
+    if (this._fieldRef != null) component['field_rql_name'] = this._fieldRef.getApiName();
+    return component;
+  }
+}