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

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

@@ -1,269 +0,0 @@
-/**
- * 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/core/platform/manifest/README.md

@@ -1,26 +0,0 @@
-# `core/platform/manifest`
-
-This directory holds public manifest-integration adapters for higher-level platform abstractions.
-
-Use this layer when code is primarily about translating typed platform/domain definitions into low-level `lib/manifest` classes rather than defining the domain model itself.
-
-Rule of thumb:
-
-- if code owns schema semantics, validation, provisioning, lifecycle, records, or query typing, it belongs in `core/platform/<domain>/`
-- if code primarily produces `lib/manifest` components or manifest-specific typed authoring helpers, it belongs in `core/platform/manifest/<domain>/`
-
-For example:
-
-- `core/platform/custom-objects/*` owns typed custom-object schema and runtime helpers
-- `core/platform/manifest/custom-objects/*` owns manifest registration, typed conditions, typed validations/rules/workflows, typed list-view helpers, typed page-layout helpers, function wiring helpers, and manifest field-resolution helpers for those custom-object definitions
-
-Current author-facing golden paths in this manifest layer:
-
-The custom-object review path should read top-down: registration/conditions/rules/workflows/actions/existing-manifest rebinding first, then the SDUI helper family as an additive UI-specific lane.
-
-- use `defineTypedWorkflowFromFunctionFile(...)` when one workflow owns one colocated function file and you want the handler loaded from disk plus wired into the workflow in one step
-- use `defineTypedCustomObjectActionFromFunctionFile(...)` when one custom-object action owns one colocated function file and you want the action plus `ManifestFunction` created together
-- use `bindExistingManifestCustomObject(...)` when extending an existing manifest through the typed custom-object lane instead of manually loading raw object, field, section, layout, and action classes
-- treat raw `lib/manifest` field/section construction as the explicit escape hatch when an existing-manifest mutation needs to create brand-new manifest components that do not yet have a dedicated typed helper
-- use `defineTypedRule(..., { actions: (rules) => [...] })` as the default rule-authoring path, and keep `createTypedRuleHelpers(...)` as the more explicit escape hatch when a caller wants to reuse one helper namespace across multiple rules
-- use `createManifestConditionHelpers(...)` callback inputs for typed conditions, prefer `c.where('field_name').eq(...)` plus `c.all(...)` / `c.any(...)` / `c.none(...)` for the higher-order condition path, use `typedCondition(...)` when a bounded parsed-string condition is clearer, and keep `c.raw(...)` as the explicit escape hatch for unsupported condition snippets

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

@@ -1,87 +0,0 @@
-import {
-  CustomObjectAction,
-  type CustomObjectActionProps,
-  type ManifestFunction,
-} from '../../../../lib/manifest';
-import type { ManifestScope } from '../../../../lib/manifest/manifest-builder';
-import type { AnyCustomObjectDefinition } from '../../custom-objects/types';
-import { defineManifestFunctionFromFile, type ManifestFunctionFromFileProps } from './function-file';
-import type { ManifestRegistration } from './types';
-
-/**
- * Initialization properties for {@link defineTypedCustomObjectAction}.
- *
- * @typeParam TDefinition - Typed custom-object definition whose object action is being authored.
- */
-export interface TypedCustomObjectActionProps<TDefinition extends AnyCustomObjectDefinition>
-  extends Omit<CustomObjectActionProps, 'function'> {
-  /** Existing manifest function invoked by this action. */
-  readonly function: ManifestFunction;
-  /** Phantom type anchor that keeps the props definition-scoped in editor hover/help. */
-  readonly __typedActionDefinition__?: TDefinition;
-}
-
-/**
- * Initialization properties for {@link defineTypedCustomObjectActionFromFunctionFile}.
- *
- * @typeParam TDefinition - Typed custom-object definition whose object action is being authored.
- */
-export interface TypedCustomObjectActionFromFunctionFileProps<TDefinition extends AnyCustomObjectDefinition>
-  extends Omit<TypedCustomObjectActionProps<TDefinition>, 'function'> {
-  /** Function metadata and source-file location for the action handler. */
-  readonly function: ManifestFunctionFromFileProps;
-}
-
-/** Result returned by {@link defineTypedCustomObjectActionFromFunctionFile}. */
-export interface TypedCustomObjectActionFromFunctionFileResult {
-  /** Manifest function created from the provided source file. */
-  readonly function: ManifestFunction;
-  /** Custom-object action wired to the created manifest function. */
-  readonly action: CustomObjectAction;
-}
-
-/**
- * Defines one custom-object action for a typed manifest registration.
- *
- * Prefer {@link defineTypedCustomObjectActionFromFunctionFile} for the common
- * colocated-handler path. Use this lower-level form when the backing manifest
- * function already exists separately and you only need to wire the action.
- *
- * @param registration - Manifest registration produced from the typed object definition.
- * @param props - Action metadata plus the backing manifest function.
- * @returns Low-level custom-object action manifest instance.
- * @typeParam TDefinition - Typed custom-object definition whose action is being authored.
- */
-export function defineTypedCustomObjectAction<TDefinition extends AnyCustomObjectDefinition>(
-  registration: ManifestRegistration<TDefinition>,
-  props: TypedCustomObjectActionProps<TDefinition>,
-): CustomObjectAction {
-  return new CustomObjectAction(registration.object, props);
-}
-
-/**
- * Defines one custom-object action and its backing manifest function from a source file.
- *
- * This is the intended golden path when one custom-object action owns one
- * colocated handler file.
- *
- * @param registration - Manifest registration produced from the typed object definition.
- * @param props - Action metadata plus the function source-file location.
- * @returns Created manifest function plus the action wired to it.
- * @typeParam TDefinition - Typed custom-object definition whose action is being authored.
- */
-export function defineTypedCustomObjectActionFromFunctionFile<TDefinition extends AnyCustomObjectDefinition>(
-  scope: ManifestScope,
-  registration: ManifestRegistration<TDefinition>,
-  props: TypedCustomObjectActionFromFunctionFileProps<TDefinition>,
-): TypedCustomObjectActionFromFunctionFileResult {
-  const { function: functionProps, ...actionProps } = props;
-  const createdFunction = defineManifestFunctionFromFile(scope, functionProps);
-  return {
-    function: createdFunction,
-    action: defineTypedCustomObjectAction(registration, {
-      ...actionProps,
-      function: createdFunction,
-    }),
-  };
-}