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

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

@@ -1,70 +0,0 @@
-import { Validation, type ValidationProps } from '../../../../lib/manifest';
-import type { AnyCustomObjectDefinition } from '../../custom-objects/types';
-import type { TypedManifestFieldInput } from './field-resolution';
-import { resolveTypedManifestField } from './field-resolution';
-import type { ManifestRegistration } from './types';
-import type { ManifestConditionInput } from './conditions';
-import { resolveManifestConditionInput } from './conditions';
-
-/**
- * Initialization properties for {@link defineTypedValidation}.
- *
- * @typeParam TDefinition - Typed custom-object definition whose field namespace should be enforced.
- */
-type TypedValidationBaseProps<TDefinition extends AnyCustomObjectDefinition> = Omit<
-  ValidationProps,
-  'rqlFormula' | 'fieldRef' | 'level'
-> & {
-  /** Manifest condition/formula that returns `true` when the record is invalid. */
-  readonly whenInvalid: ManifestConditionInput<TDefinition>;
-};
-
-/**
- * Initialization properties for {@link defineTypedValidation}.
- *
- * `level` and `field` intentionally form a discriminated union so field-scoped
- * validations must provide a typed field target and record-scoped validations
- * must omit it.
- *
- * @typeParam TDefinition - Typed custom-object definition whose field namespace should be enforced.
- */
-export type TypedValidationProps<TDefinition extends AnyCustomObjectDefinition> =
-  | (TypedValidationBaseProps<TDefinition> & {
-      readonly level: 'FIELD';
-      /** Field that should receive the validation error when `level` is `'FIELD'`. */
-      readonly field: TypedManifestFieldInput<TDefinition>;
-    })
-  | (TypedValidationBaseProps<TDefinition> & {
-      readonly level: 'RECORD';
-      /** Field targets are not allowed for record-level validations. */
-      readonly field?: never;
-    });
-
-/**
- * Defines a validation rule using typed field names and manifest-condition fragments.
- *
- * @param registration - Manifest registration produced from the typed object definition.
- * @param props - Typed validation properties.
- * @returns Low-level validation manifest instance.
- * @throws {Error} When `level` is `'FIELD'` but no `field` is provided, or when `field` is provided for a record-level validation.
- * @typeParam TDefinition - Typed custom-object definition whose field namespace should be enforced.
- */
-export function defineTypedValidation<TDefinition extends AnyCustomObjectDefinition>(
-  registration: ManifestRegistration<TDefinition>,
-  props: TypedValidationProps<TDefinition>,
-): Validation {
-  const { whenInvalid, field, ...rest } = props;
-
-  if (rest.level === 'FIELD' && field == null) {
-    throw new Error('defineTypedValidation(...): field is required when level is FIELD.');
-  }
-  if (rest.level === 'RECORD' && field != null) {
-    throw new Error('defineTypedValidation(...): field must be omitted when level is RECORD.');
-  }
-
-  return new Validation(registration.object, {
-    ...rest,
-    rqlFormula: resolveManifestConditionInput(registration, whenInvalid),
-    ...(field != null ? { fieldRef: resolveTypedManifestField(registration, field) } : {}),
-  });
-}

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

@@ -1,71 +0,0 @@
-import { Workflow, type WorkflowProps } from '../../../../lib/manifest';
-import type { ManifestScope } from '../../../../lib/manifest/manifest-builder';
-import type { WorkflowTrigger } from '../../../../lib/manifest/workflow';
-import type { AnyCustomObjectDefinition } from '../../custom-objects/types';
-import type { TypedCustomObjectLifecycleTriggerBuilder } from './conditions';
-
-/**
- * Workflow-trigger inputs accepted by {@link defineTypedWorkflow}.
- *
- * @typeParam TDefinition - Typed custom-object definition carried by lifecycle-trigger builders.
- */
-export type TypedWorkflowTriggerInput<
-  TDefinition extends AnyCustomObjectDefinition = AnyCustomObjectDefinition,
-> = WorkflowTrigger | TypedCustomObjectLifecycleTriggerBuilder<TDefinition, any>;
-
-/**
- * Initialization properties for {@link defineTypedWorkflow}.
- *
- * The helper keeps the low-level workflow manifest class intact while allowing
- * typed custom-object lifecycle builders to flow directly into the final
- * workflow authoring step.
- *
- * @typeParam TDefinition - Typed custom-object definition carried by lifecycle-trigger builders.
- */
-export interface TypedWorkflowProps<TDefinition extends AnyCustomObjectDefinition = AnyCustomObjectDefinition>
-  extends Omit<WorkflowProps, 'trigger'> {
-  /** Workflow trigger authored either as a low-level trigger object or a typed lifecycle builder. */
-  readonly trigger: TypedWorkflowTriggerInput<TDefinition>;
-}
-
-function isTypedLifecycleTriggerBuilder<TDefinition extends AnyCustomObjectDefinition>(
-  value: TypedWorkflowTriggerInput<TDefinition>,
-): value is TypedCustomObjectLifecycleTriggerBuilder<TDefinition, any> {
-  return typeof value === 'object' && value != null && 'build' in value && typeof value.build === 'function';
-}
-
-/**
- * Resolves a typed workflow-trigger input into the low-level manifest trigger shape.
- *
- * @param trigger - Workflow trigger input to resolve.
- * @returns Low-level workflow trigger consumed by {@link Workflow}.
- * @typeParam TDefinition - Typed custom-object definition carried by lifecycle-trigger builders.
- */
-export function resolveTypedWorkflowTrigger<TDefinition extends AnyCustomObjectDefinition>(
-  trigger: TypedWorkflowTriggerInput<TDefinition>,
-): WorkflowTrigger {
-  return isTypedLifecycleTriggerBuilder(trigger) ? trigger.build() : trigger;
-}
-
-/**
- * Defines a workflow while accepting typed custom-object lifecycle trigger builders.
- *
- * Prefer {@link defineTypedWorkflowFromFunctionFile} for the common colocated-
- * handler path. Use this lower-level explicit form when the backing function is
- * already defined separately or when the caller wants to pass a fully built
- * low-level trigger object.
- *
- * @param scope - Manifest scope that should own the workflow.
- * @param props - Workflow properties with a typed or low-level trigger.
- * @returns Low-level workflow manifest instance.
- * @typeParam TDefinition - Typed custom-object definition carried by lifecycle-trigger builders.
- */
-export function defineTypedWorkflow<TDefinition extends AnyCustomObjectDefinition>(
-  scope: ManifestScope,
-  props: TypedWorkflowProps<TDefinition>,
-): Workflow {
-  return new Workflow(scope, {
-    ...props,
-    trigger: resolveTypedWorkflowTrigger(props.trigger),
-  });
-}

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

@@ -1,203 +0,0 @@
-/**
- * Public manifest-integration surface for typed custom objects.
- *
- * Import this module when you want to materialize typed custom-object
- * definitions into low-level manifest classes or use manifest-specific helpers
- * such as typed list views and page layouts.
- *
- * Relationship to the rest of the SDK:
- *
- * ```text
- * core/platform/custom-objects
- *          |
- *          v
- * core/platform/manifest/custom-objects
- *          |
- *          v
- * lib/manifest
- * ```
- *
- * The implementation lives under `core/platform/manifest/custom-objects/`, but
- * this file is the stable public entrypoint that consumers should import from:
- *
- * ```ts
- * import { registerManifestCustomObject } from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
- * ```
- */
-
-/** Manifest-registration result and field-class mapping types used by the typed manifest adapters. */
-export type { ManifestFieldForDefinition, ManifestRegistration } from './custom-objects/types';
-
-/** Manifest-bridge options and tuple types used when materializing typed schemas. */
-export type {
-  ManifestRegistrationTuple,
-  RegisterManifestCustomObjectOptions,
-  RegisterManifestCustomObjectsOptions,
-} from './custom-objects/register';
-
-/** Bridges that convert typed schemas into the existing manifest class model. */
-export { registerManifestCustomObject, registerManifestCustomObjects } from './custom-objects/register';
-
-/** Source-file loading props and result types for typed workflow/action wiring plus SDUI page wiring. */
-export type {
-  ManifestFunctionFileSource,
-  ManifestFunctionFromFileProps,
-  SduiPageFromFunctionFileProps,
-  SduiPageFromFunctionFileResult,
-  TypedWorkflowFromFunctionFileProps,
-  TypedWorkflowFromFunctionFileResult,
-} from './custom-objects/function-file';
-
-/** Helpers that wire one colocated handler file into a typed workflow or SDUI page plus backing manifest function. */
-export {
-  defineSduiPageFromFunctionFile,
-  defineTypedWorkflowFromFunctionFile,
-} from './custom-objects/function-file';
-
-/** Shared manifest field-name types used by typed list-view and page-layout helpers. */
-export type {
-  StandardManifestFieldName,
-  TypedManifestFieldInput,
-  TypedManifestFieldName,
-} from './custom-objects/field-resolution';
-
-/** Shared field resolver used by typed manifest helpers. */
-export { resolveTypedManifestField } from './custom-objects/field-resolution';
-
-/** Typed manifest-condition fragments, field tokens, lifecycle builders, and helper inputs. */
-export type {
-  ManifestConditionCategory,
-  ManifestConditionFieldCategory,
-  ManifestConditionFieldScope,
-  ManifestConditionFieldToken,
-  ManifestConditionFragment,
-  ManifestConditionFunctionToken,
-  ManifestConditionHelpers,
-  ManifestConditionInput,
-  ManifestCustomObjectTarget,
-  TypedCustomObjectLifecycle,
-  TypedCustomObjectLifecycleTriggerBuilder,
-} from './custom-objects/conditions';
-
-/** Typed manifest-condition and custom-object lifecycle helper families. */
-export { createManifestConditionHelpers, customObjectLifecycle } from './custom-objects/conditions';
-
-/** Parsed-string typed manifest-condition field-name types. */
-export type {
-  ParsedConditionFieldName,
-  ParsedConditionStandardFieldName,
-} from './custom-objects/typed-condition';
-
-/** Parsed-string manifest-condition compiler for the typed custom-object lane. */
-export { typedCondition } from './custom-objects/typed-condition';
-
-/** Typed list-view field names and props for manifest custom-object registrations. */
-export type {
-  StandardListViewFieldName,
-  TypedListViewDefProps,
-  TypedListViewFieldInput,
-  TypedListViewFieldName,
-} from './custom-objects/list-view';
-
-/** Typed list-view helper with object-specific field-name IntelliSense. */
-export { defineTypedListView } from './custom-objects/list-view';
-
-/** Typed page-layout field-array types for manifest custom-object registrations. */
-export type {
-  TypedBasicPageLayoutProps,
-  TypedCustomObjectPageLayoutProps,
-  TypedFieldsSection,
-  TypedPageLayoutSection,
-  TypedPageLayoutTab,
-  TypedSectionField,
-  TypedSectionFieldInput,
-  TypedSystemSectionEdit,
-  TypedSystemTabEdit,
-  TypedTabEdits,
-  TypedTabWithSections,
-} from './custom-objects/page-layout';
-
-/** Typed page-layout helpers with object-specific field-name IntelliSense for common field arrays and basic layouts. */
-export { defineBasicTypedPageLayout, defineTypedPageLayout } from './custom-objects/page-layout';
-
-/** Typed validation helper properties. */
-export type { TypedValidationProps } from './custom-objects/validation';
-
-/** Typed validation helper that accepts manifest-condition fragments and typed fields. */
-export { defineTypedValidation } from './custom-objects/validation';
-
-/** Typed rule-action values, helpers, and rule properties. */
-export type {
-  TypedRuleAction,
-  TypedRuleFieldSetter,
-  TypedRuleFixedValue,
-  TypedRuleHelpers,
-  TypedRuleProps,
-} from './custom-objects/rule';
-
-/** Typed rule-action helpers and record-triggered rule helper. */
-export { createTypedRuleHelpers, defineTypedRule } from './custom-objects/rule';
-
-/** Typed workflow helper properties and trigger inputs. */
-export type { TypedWorkflowProps, TypedWorkflowTriggerInput } from './custom-objects/workflow';
-
-/** Typed workflow helper that accepts lifecycle-trigger builders. */
-export { defineTypedWorkflow, resolveTypedWorkflowTrigger } from './custom-objects/workflow';
-
-/** Typed custom-object action helper props and file-wiring result types. */
-export type {
-  TypedCustomObjectActionFromFunctionFileProps,
-  TypedCustomObjectActionFromFunctionFileResult,
-  TypedCustomObjectActionProps,
-} from './custom-objects/action';
-
-/** Typed custom-object action helpers. Prefer the file-backed helper for the common one-action/one-handler path. */
-export {
-  defineTypedCustomObjectAction,
-  defineTypedCustomObjectActionFromFunctionFile,
-} from './custom-objects/action';
-
-/** Standard input/output types for init-only custom-object object-list page functions. */
-export type { TypedObjectListPageInput, TypedObjectListPageOutput } from './custom-objects/object-list-page';
-
-/** Helper that renders the standard ObjectListView-backed SDUI page-function response. */
-export { handleTypedObjectListPageEvent } from './custom-objects/object-list-page';
-
-/** Shared output unions and payload shapes for stateful SDUI page functions. */
-export type {
-  TypedSduiMutationTriggerOptions,
-  TypedSduiPageActionName,
-  TypedSduiPageActionParams,
-  TypedSduiPageErrorOutput,
-  TypedSduiPageHandlerArgs,
-  TypedSduiPageHandlerOptions,
-  TypedSduiPageOutput,
-  TypedSduiPageSpecOutput,
-  TypedSduiStateAssignments,
-  TypedSduiStatePath,
-  TypedSduiStatePathForValue,
-  TypedSduiStatePathValue,
-} from './custom-objects/sdui-page';
-
-/** Stateful SDUI action-dispatch helpers. Prefer `defineTypedSduiPageHandlerFor(...)` for the default authoring path and keep `defineTypedSduiPageHandler(...)` as the more explicit escape hatch. */
-export {
-  createTypedSduiMutationTrigger,
-  defineTypedSduiPageHandler,
-  defineTypedSduiPageHandlerFor,
-  defineTypedSduiStateAssignments,
-  resolveTypedSduiStatePath,
-} from './custom-objects/sdui-page';
-
-/** Existing-manifest rebinding option and result types for typed custom-object extensions. */
-export type {
-  BindExistingManifestCustomObjectOptions,
-  BindExistingManifestCustomObjectsOptions,
-  ExistingManifestRegistration,
-  ExistingManifestRegistrationTuple,
-} from './custom-objects/existing';
-
-/** Existing-manifest rebinding helpers for the typed custom-object lane. */
-export {
-  bindExistingManifestCustomObject,
-  bindExistingManifestCustomObjects,
-} from './custom-objects/existing';

package/src/pebble-sdui-web-custom-apps-shim.d.ts

@@ -1,3 +0,0 @@
-declare module '@rippling/pebble-sdui-web/catalogs/custom-apps' {
-  export * from '@rippling/pebble-sdui-web/dist/catalogs/custom-apps/index';
-}