@rippling/rippling-sdk 0.2.0-alpha.85 → 0.2.0-alpha.86

package/src/core/platform/custom-objects.ts

@@ -0,0 +1,269 @@
+/**
+ * Public custom-object authoring surface for the Rippling TypeScript SDK.
+ *
+ * Import this module when you want a TypeScript-first, structural definition
+ * layer for custom objects that can be reused across manifests, functions,
+ * validators, tests, and agent-authored code.
+ *
+ * The implementation lives under `core/platform/custom-objects/`, but this file
+ * is the stable public entrypoint that consumers should import from:
+ *
+ * ```ts
+ * import { defineCustomObject, text } from '@rippling/rippling-sdk/core/platform/custom-objects';
+ * ```
+ *
+ * Manifest-specific adapters for typed custom objects live under:
+ *
+ * ```ts
+ * import { registerManifestCustomObject } from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+ * ```
+ */
+
+/** Section-definition helper and foundational schema types. */
+export { section } from './custom-objects/types';
+
+/** Type-level contracts derived from typed custom-object definitions. */
+export type {
+  AnyCustomObjectDefinition,
+  AnyFieldDefinition,
+  CategoryApiName,
+  CreateInput,
+  CustomFieldApiName,
+  CustomObjectApiName,
+  CustomObjectDefinition,
+  CustomObjectIdentity,
+  CustomRecordFields,
+  FieldDefinitions,
+  FieldNames,
+  FieldValue,
+  FileReference,
+  FormulaFieldDefinition,
+  FormulaFieldKind,
+  FormulaValueByKind,
+  LogicalCategoryName,
+  LogicalCustomFieldName,
+  LogicalCustomObjectName,
+  LookupFieldDefinition,
+  LookupReference,
+  LookupTarget,
+  NameFieldDefinition,
+  NativeModelTarget,
+  OptionalWritableFieldNames,
+  ParentChildFieldDefinition,
+  ReadonlyFieldNames,
+  RecordShape,
+  RequiredWritableFieldNames,
+  ResolvedFieldDefinition,
+  SectionDefinition,
+  SectionDefinitions,
+  StandardCreateFields,
+  StandardRecordFields,
+  TargetApiName,
+  UpdateInput,
+  WritableFieldNames,
+} from './custom-objects/types';
+
+/** Field factories and reusable schema fragments. */
+export {
+  boolean,
+  currency,
+  date,
+  datetime,
+  email,
+  file,
+  formula,
+  longText,
+  lookup,
+  nativeModel,
+  number,
+  parentChild,
+  percentage,
+  phone,
+  radio,
+  sections,
+  select,
+  text,
+  time,
+  url,
+} from './custom-objects/fields';
+
+/** Immutable definition helpers for creating and extending schemas. */
+export {
+  defineCustomObject,
+  extendCustomObject,
+  fieldNames,
+  getFieldDefinition,
+  isWritableField,
+  toCustomCategoryApiName,
+  toCustomFieldApiName,
+  toCustomObjectApiName,
+} from './custom-objects/definition';
+
+/** Runtime validation result types for schema and record checks. */
+export type { ValidationIssue, ValidationResult } from './custom-objects/validation';
+
+/** Runtime validation and typed-record helpers. */
+export {
+  asTypedRecord,
+  assertValidCreateInput,
+  assertValidUpdateInput,
+  getRecordValue,
+  validateCreateInput,
+  validateCustomObjectDefinition,
+  validateLogicalCategoryName,
+  validateLogicalCustomFieldName,
+  validateLogicalCustomObjectName,
+  validateUpdateInput,
+} from './custom-objects/validation';
+
+/** Typed RQL helper types for custom-object query and formula authoring. */
+export type {
+  CustomObjectRqlHelpers,
+  RqlComparableValue,
+  RqlFieldName,
+  RqlFieldScope,
+  RqlFieldToken,
+  RqlFragment,
+  RqlInterpolation,
+  RqlValue,
+  StandardRqlFieldName,
+} from './custom-objects/rql';
+
+/** Typed parsed-string RQL field-name types for custom-object query authoring. */
+export type { ParsedRqlFieldName, ParsedRqlStandardFieldName } from './custom-objects/typed-rql';
+
+/** Typed RQL helper factories for custom-object query authoring. */
+export { createRqlHelpers } from './custom-objects/rql';
+
+/** Parsed-string RQL compiler that validates logical field names and value types. */
+export { typedRql } from './custom-objects/typed-rql';
+
+/** Typed category-definition and lifecycle types for custom-object metadata. */
+export type {
+  CustomObjectCategoryDefinition,
+  CustomObjectCategoryLifecycleAction,
+  CustomObjectCategoryMutationOptions,
+  ProvisionedCustomObjectCategory,
+  ReconciledCustomObjectCategory,
+} from './custom-objects/category';
+
+/** Typed category-definition helpers for custom-object metadata. */
+export {
+  buildObjectCategoryCreateParams,
+  buildObjectCategoryUpdateParams,
+  defineCustomObjectCategory,
+  deleteCustomObjectCategoryDefinition,
+  provisionCustomObjectCategoryDefinition,
+  provisionCustomObjectCategoryDefinitions,
+  reconcileCustomObjectCategoryDefinition,
+  reconcileCustomObjectCategoryDefinitions,
+} from './custom-objects/category';
+
+/** Provisioning result and option types for the REST custom-object helpers. */
+export type {
+  ProvisionCustomObjectOptions,
+  ProvisionCustomObjectsOptions,
+  ProvisionableFieldParams,
+  ProvisionedCustomObject,
+} from './custom-objects/provisioning';
+
+/** Helpers that compile typed schemas into low-level REST custom-object payloads. */
+export {
+  buildCustomObjectCreateParams,
+  buildCustomObjectNameFieldDetails,
+  buildCustomObjectUpdateParams,
+  buildProvisionableFieldParams,
+  provisionCustomObjectDefinition,
+  provisionCustomObjectDefinitions,
+} from './custom-objects/provisioning';
+
+/** Schema-lifecycle types for reconciling typed definitions with remote metadata. */
+export type {
+  CustomObjectLifecycleAction,
+  ReconcileCustomObjectDefinitionOptions,
+  ReconcileCustomObjectDefinitionsOptions,
+  ReconciledCustomObject,
+  ReconciledCustomObjectField,
+} from './custom-objects/lifecycle';
+
+/** Schema-lifecycle helpers for reconciling typed definitions with remote metadata. */
+export {
+  deleteCustomObjectDefinition,
+  reconcileCustomObjectDefinition,
+  reconcileCustomObjectDefinitions,
+} from './custom-objects/lifecycle';
+
+/** Typed schema-manager classes that bind definitions to a specific SDK client. */
+export type {} from './custom-objects/schema-manager';
+
+/** Typed schema-manager classes that bind definitions to a specific SDK client. */
+export {
+  COSchemaManager,
+  CustomObjectSchemaManager,
+  TypedCustomObjectCategoryManager,
+  TypedCustomObjectSchemaManager,
+} from './custom-objects/schema-manager';
+
+/** Low-level typed field-metadata payloads used by the generated REST resources. */
+export type {
+  ChoiceCustomObjectFieldDataType,
+  CurrencyCustomObjectFieldDataType,
+  CustomObjectFieldDataType,
+  CustomObjectFieldDerivedAggregationFilter,
+  CustomObjectFieldDerivedAggregatedField,
+  CustomObjectFieldFormulaAttrMetas,
+  CustomObjectFieldRqlDefinition,
+  CustomObjectFieldSection,
+  CustomObjectFieldSectionConfig,
+  CustomObjectFieldType,
+  CustomObjectNameFieldDetails,
+  DateCustomObjectFieldDataType,
+  DatetimeCustomObjectFieldDataType,
+  EmailCustomObjectFieldDataType,
+  FileCustomObjectFieldDataType,
+  LongTextCustomObjectFieldDataType,
+  NumberCustomObjectFieldDataType,
+  PercentageCustomObjectFieldDataType,
+  PhoneNumberCustomObjectFieldDataType,
+  ReferenceCustomObjectFieldDataType,
+  TextCustomObjectFieldDataType,
+  TimeCustomObjectFieldDataType,
+  URLCustomObjectFieldDataType,
+} from '../../resources/custom-objects/fields';
+
+/** Typed record-manager adapter, error, and pagination types. */
+export type {
+  CustomObjectManagerOptions,
+  CustomObjectRecordAdapter,
+  CustomObjectRecordBulkCreateRequest,
+  CustomObjectRecordBulkDeleteRequest,
+  CustomObjectRecordBulkUpdateRequest,
+  CustomObjectRecordQueryResponse,
+  CustomObjectRecordsClient,
+  InMemoryCustomObjectRecordAdapterOptions,
+  TypedBatchWriteOptions,
+  TypedBulkUpdateInput,
+  TypedRecordPage,
+  TypedRecordPageOptions,
+  TypedRecordQueryOptions,
+} from './custom-objects/manager';
+
+/** Typed record-manager utilities for CRUD, batch operations, and records-resource/in-memory adapters. */
+export {
+  COManager,
+  CustomObjectManager,
+  CustomObjectRecordValidationError,
+  InMemoryCustomObjectRecordAdapter,
+  TypedCustomObjectRecordManager,
+  createCustomObjectRecordAdapter,
+} from './custom-objects/manager';
+
+/** Shared function-runtime bootstrap types for custom-object-backed handlers. */
+export type {
+  CreateCustomObjectFunctionRuntimeOptions,
+  CustomObjectFunctionRuntime,
+  CustomObjectFunctionRuntimeClient,
+} from './custom-objects/function-runtime';
+
+/** Small bootstrap helper that creates one SDK client plus typed record managers for a function invocation. */
+export { createCustomObjectFunctionRuntime } from './custom-objects/function-runtime';

package/src/resources/custom-objects/custom-objects.ts

@@ -89,6 +89,7 @@ export class CustomObjects extends APIResource {
 
 export type CustomObjectsPageCursorURL = PageCursorURL<CustomObject>;
 
+/** Public custom-object DTO returned by the REST API. */
 export interface CustomObject {
   /**
    * Identifier field
@@ -151,6 +152,7 @@ export interface CustomObject {
   owner_id?: string;
 }
 
+/** Request payload accepted by `client.customObjects.create(...)`. */
 export interface CustomObjectCreateParams {
   /**
    * The category that this custom object belongs to.
@@ -168,6 +170,7 @@ export interface CustomObjectCreateParams {
   name?: string;
 }
 
+/** Request payload accepted by `client.customObjects.update(...)`. */
 export interface CustomObjectUpdateParams {
   /**
    * The category that this custom object belongs to.
@@ -179,6 +182,11 @@ export interface CustomObjectUpdateParams {
    */
   description?: string;
 
+  /**
+   * Whether to record the history of the custom object.
+   */
+  enable_history?: boolean;
+
   /**
    * The name of the custom object.
    */

package/src/resources/custom-objects/fields.ts

@@ -77,6 +77,175 @@ export class Fields extends APIResource {
 
 export type CustomObjectFieldsPageCursorURL = PageCursorURL<CustomObjectField>;
 
+/** Supported wire-level field-type identifiers for custom-object fields. */
+export type CustomObjectFieldType =
+  | 'TEXT'
+  | 'LONG_TEXT'
+  | 'EMAIL'
+  | 'URL'
+  | 'PHONE_NUMBER'
+  | 'NUMBER'
+  | 'CURRENCY'
+  | 'PERCENTAGE'
+  | 'DATE'
+  | 'DATETIME'
+  | 'TIME'
+  | 'SELECT'
+  | 'RADIO'
+  | 'BOOLEAN'
+  | 'FILE'
+  | 'OG_REFERENCE_FIELD';
+
+/** Structured `data_type` payload for text fields. */
+export interface TextCustomObjectFieldDataType {
+  field_type: 'TEXT';
+  max_length?: number;
+}
+
+/** Structured `data_type` payload for long-text fields. */
+export interface LongTextCustomObjectFieldDataType {
+  field_type: 'LONG_TEXT';
+  max_length?: number;
+}
+
+/** Structured `data_type` payload for email fields. */
+export interface EmailCustomObjectFieldDataType {
+  field_type: 'EMAIL';
+}
+
+/** Structured `data_type` payload for URL fields. */
+export interface URLCustomObjectFieldDataType {
+  field_type: 'URL';
+}
+
+/** Structured `data_type` payload for phone-number fields. */
+export interface PhoneNumberCustomObjectFieldDataType {
+  field_type: 'PHONE_NUMBER';
+}
+
+/** Structured `data_type` payload for numeric fields. */
+export interface NumberCustomObjectFieldDataType {
+  field_type: 'NUMBER';
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for currency fields. */
+export interface CurrencyCustomObjectFieldDataType {
+  field_type: 'CURRENCY';
+  currency?: string;
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for percentage fields. */
+export interface PercentageCustomObjectFieldDataType {
+  field_type: 'PERCENTAGE';
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for date fields. */
+export interface DateCustomObjectFieldDataType {
+  field_type: 'DATE';
+}
+
+/** Structured `data_type` payload for date-time fields. */
+export interface DatetimeCustomObjectFieldDataType {
+  field_type: 'DATETIME';
+}
+
+/** Structured `data_type` payload for time-of-day fields. */
+export interface TimeCustomObjectFieldDataType {
+  field_type: 'TIME';
+}
+
+/** Structured `data_type` payload for choice fields. */
+export interface ChoiceCustomObjectFieldDataType {
+  field_type: 'SELECT' | 'RADIO';
+  options_list: string[];
+}
+
+/** Structured `data_type` payload for boolean fields. */
+export interface BooleanCustomObjectFieldDataType {
+  field_type: 'BOOLEAN';
+}
+
+/** Structured `data_type` payload for file fields. */
+export interface FileCustomObjectFieldDataType {
+  field_type: 'FILE';
+  supported_types?: string[];
+}
+
+/** Structured `data_type` payload for relationship fields. */
+export interface ReferenceCustomObjectFieldDataType {
+  field_type: 'OG_REFERENCE_FIELD';
+  og_model_rql_name: string;
+  edge_type?: 'LOOKUP' | 'PARENT_CHILD';
+  related_data_label?: string;
+  lookup_filter_rql_condition?: string;
+  parent_child_type?: 'PRIMARY' | 'SECONDARY';
+  enable_parent_owner_inheritance?: boolean;
+}
+
+/** Typed `data_type` union for custom-object field create/update payloads. */
+export type CustomObjectFieldDataType =
+  | TextCustomObjectFieldDataType
+  | LongTextCustomObjectFieldDataType
+  | EmailCustomObjectFieldDataType
+  | URLCustomObjectFieldDataType
+  | PhoneNumberCustomObjectFieldDataType
+  | NumberCustomObjectFieldDataType
+  | CurrencyCustomObjectFieldDataType
+  | PercentageCustomObjectFieldDataType
+  | DateCustomObjectFieldDataType
+  | DatetimeCustomObjectFieldDataType
+  | TimeCustomObjectFieldDataType
+  | ChoiceCustomObjectFieldDataType
+  | BooleanCustomObjectFieldDataType
+  | FileCustomObjectFieldDataType
+  | ReferenceCustomObjectFieldDataType;
+
+/** Filter entry accepted by derived aggregated field metadata. */
+export interface CustomObjectFieldDerivedAggregationFilter {
+  field_name: string;
+  filter_value: string;
+  operator: string;
+}
+
+/** Structured payload for derived aggregated field metadata. */
+export interface CustomObjectFieldDerivedAggregatedField {
+  aggregation_function?: string;
+  child_model_name?: string;
+  currency_code?: string | null;
+  field_to_aggregate?: string;
+  filters?: CustomObjectFieldDerivedAggregationFilter[];
+  lookup_field_api_name?: string;
+  [key: string]: unknown;
+}
+
+/** Formula attribute metadata accepted by field create/update APIs. */
+export type CustomObjectFieldFormulaAttrMetas = Record<string, unknown>;
+
+/** Computed-field RQL definition metadata accepted by field create/update APIs. */
+export type CustomObjectFieldRqlDefinition = Record<string, unknown>;
+
+/** Legacy object-shaped field-section payload surfaced by the generated schema. */
+export interface CustomObjectFieldSectionConfig {
+  name?: string;
+  section_id?: string;
+  [key: string]: unknown;
+}
+
+/** Field-section value accepted by the custom-object field APIs. */
+export type CustomObjectFieldSection = string | CustomObjectFieldSectionConfig;
+
+/** Name-field display / autonumber metadata accepted by field update APIs. */
+export interface CustomObjectNameFieldDetails {
+  is_autonumber_field?: boolean;
+  autonumber_format?: string;
+  starting_number?: number;
+  [key: string]: unknown;
+}
+
+/** Public custom-object field DTO returned by the REST API. */
 export interface CustomObjectField {
   /**
    * Identifier field
@@ -99,9 +268,9 @@ export interface CustomObjectField {
   custom_object: string;
 
   /**
-   * The data type configuration for the field.
+   * The field type
    */
-  data_type: unknown;
+  data_type: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * whether the history is enable for the field
@@ -144,32 +313,17 @@ export interface CustomObjectField {
   managed_package_install_id?: string;
 }
 
-export namespace CustomObjectField {
-  /**
-   * The data type configuration for the field.
-   */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
-}
-
 /** Request payload accepted by `client.customObjects.fields.create(...)`. */
 export interface FieldCreateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: unknown;
+  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * Configuration for derived aggregated fields.
    */
-  derived_aggregated_field?: unknown;
+  derived_aggregated_field?: CustomObjectFieldDerivedAggregatedField;
 
   /**
    * The formula for derived fields.
@@ -189,7 +343,7 @@ export interface FieldCreateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -209,27 +363,12 @@ export interface FieldCreateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
-
-  /**
-   * The section configuration for the field.
-   */
-  section?: unknown;
-}
+  rql_definition?: CustomObjectFieldRqlDefinition;
 
-export namespace FieldCreateParams {
   /**
-   * The data type configuration for the field.
+   * The section identifier or section configuration for the field.
    */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
+  section?: CustomObjectFieldSection;
 }
 
 /** Request payload accepted by `client.customObjects.fields.update(...)`. */
@@ -237,7 +376,7 @@ export interface FieldUpdateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: unknown;
+  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * The formula for derived fields.
@@ -257,7 +396,7 @@ export interface FieldUpdateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -272,7 +411,7 @@ export interface FieldUpdateParams {
   /**
    * Configuration for name field display.
    */
-  name_field_details?: unknown;
+  name_field_details?: CustomObjectNameFieldDetails;
 
   /**
    * Whether this field is required.
@@ -282,31 +421,25 @@ export interface FieldUpdateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
-
-  /**
-   * The section configuration for the field.
-   */
-  section?: unknown;
-}
+  rql_definition?: CustomObjectFieldRqlDefinition;
 
-export namespace FieldUpdateParams {
   /**
-   * The data type configuration for the field.
+   * The section identifier or section configuration for the field.
    */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
+  section?: CustomObjectFieldSection;
 }
 
 export declare namespace Fields {
   export {
+    type CustomObjectFieldType as CustomObjectFieldType,
+    type CustomObjectFieldDataType as CustomObjectFieldDataType,
+    type CustomObjectFieldDerivedAggregationFilter as CustomObjectFieldDerivedAggregationFilter,
+    type CustomObjectFieldDerivedAggregatedField as CustomObjectFieldDerivedAggregatedField,
+    type CustomObjectFieldFormulaAttrMetas as CustomObjectFieldFormulaAttrMetas,
+    type CustomObjectFieldRqlDefinition as CustomObjectFieldRqlDefinition,
+    type CustomObjectFieldSectionConfig as CustomObjectFieldSectionConfig,
+    type CustomObjectFieldSection as CustomObjectFieldSection,
+    type CustomObjectNameFieldDetails as CustomObjectNameFieldDetails,
     type CustomObjectField as CustomObjectField,
     type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL,
     type FieldCreateParams as FieldCreateParams,

package/src/resources/levels.ts

@@ -139,8 +139,8 @@ export interface Level {
   track?: TracksAPI.Track;
 
   /**
-   * The track associated with the level. Required during creation and cannot be
-   * changed through this API.
+   * The track associated with the level. Required during creation. Include
+   * global_level when changing it.
    */
   track_id?: string;
 }
@@ -165,8 +165,8 @@ export interface LevelCreateParams {
   name: string;
 
   /**
-   * The track associated with the level. Required during creation and cannot be
-   * changed through this API.
+   * The track associated with the level. Required during creation. Include
+   * global_level when changing it.
    */
   track_id: string;
 
@@ -180,6 +180,15 @@ export interface LevelCreateParams {
    */
   experience_requirements?: string;
 
+  /**
+   * Global level is used to track the seniority of levels. The higher up a level is
+   * placed on the page, the more senior and higher-ranked the level. Global level is
+   * used in workflows, policies, and reports that use the level attribute (e.g., you
+   * can use Level Lookup to set up a workflow that notifies the nearest person in an
+   * worker's management chain at or above the specified level).
+   */
+  global_level?: number;
+
   /**
    * The scope of responsibilities for the level.
    */
@@ -201,6 +210,15 @@ export interface LevelUpdateParams {
    */
   experience_requirements?: string;
 
+  /**
+   * Global level is used to track the seniority of levels. The higher up a level is
+   * placed on the page, the more senior and higher-ranked the level. Global level is
+   * used in workflows, policies, and reports that use the level attribute (e.g., you
+   * can use Level Lookup to set up a workflow that notifies the nearest person in an
+   * worker's management chain at or above the specified level).
+   */
+  global_level?: number;
+
   /**
    * The name of the level. Must be unique within the company or organization.
    */
@@ -210,6 +228,12 @@ export interface LevelUpdateParams {
    * The scope of responsibilities for the level.
    */
   scope_of_responsibilities?: string;
+
+  /**
+   * The track associated with the level. Required during creation. Include
+   * global_level when changing it.
+   */
+  track_id?: string;
 }
 
 export declare namespace Levels {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.85'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.86'; // x-release-please-version