@rippling/rippling-sdk 0.2.0-alpha.109 → 0.2.0-alpha.110

package/src/lib/manifest/definitions/custom-field-section.ts

@@ -0,0 +1,39 @@
+import { defineComponent, withApiName, detachedManifestScope, type ComponentDefinition } from './component';
+import { CustomFieldSection, type CustomFieldSectionProps } from '../custom-field-section';
+
+export type DefinedCustomFieldSection<TModel extends string> = CustomFieldSection & {
+  readonly [modelScope]: TModel;
+};
+
+export type DefineCustomFieldSectionProps<TModel extends string> = Omit<
+  CustomFieldSectionProps,
+  'sectionId' | 'apiName' | 'modelRqlName'
+> & {
+  apiName: `${string}__cfs`;
+  modelName: string;
+  modelRqlName: TModel;
+};
+
+export function defineCustomFieldSection<const TModel extends string>(
+  props: DefineCustomFieldSectionProps<TModel>,
+): DefinedCustomFieldSection<TModel> {
+  if (!/^[A-Za-z][A-Za-z0-9_]*__cfs$/.test(props.apiName))
+    throw new Error(
+      `Native field section apiName must start with a letter, contain only letters, digits or underscores, and end with __cfs: ${props.apiName}`,
+    );
+  return customFieldSectionComponent.register(
+    withApiName(
+      new CustomFieldSection(detachedManifestScope, { ...props, sectionId: props.apiName }),
+      props.apiName,
+      { model_name: props.modelName },
+    ) as unknown as DefinedCustomFieldSection<TModel>,
+    props,
+  );
+}
+
+declare const modelScope: unique symbol;
+
+const customFieldSectionComponent: ComponentDefinition<typeof defineCustomFieldSection> = defineComponent({
+  type: 'CUSTOM_FIELD_SECTION',
+  define: defineCustomFieldSection,
+});

package/src/lib/manifest/definitions/custom-field.ts

@@ -0,0 +1,32 @@
+import { defineComponent, withApiName, detachedManifestScope, type ComponentDefinition } from './component';
+import { CustomField, type CustomFieldProps } from '../custom-field';
+import type { DefinedCustomFieldSection } from './custom-field-section';
+
+export type DefineCustomFieldProps<TModel extends string> = WithoutLegacyCustomFieldIdentity<
+  CustomFieldProps<TModel>
+> & { modelName: string; section: DefinedCustomFieldSection<NoInfer<TModel>> };
+
+export function defineCustomField<const TModel extends string>(
+  props: DefineCustomFieldProps<TModel>,
+): CustomField<TModel> {
+  return customFieldComponent.register(
+    withApiName(
+      new CustomField(detachedManifestScope, {
+        ...props,
+        ...(props.rqlDefinitionFormula == null ? { collectDuring: props.collectDuring ?? 'NONE' } : {}),
+        fieldId: props.apiName,
+      } as unknown as CustomFieldProps<TModel>),
+      props.apiName,
+      { model_name: props.modelName },
+    ),
+    props,
+  );
+}
+
+type WithoutLegacyCustomFieldIdentity<T> = T extends unknown ? Omit<T, 'fieldId' | 'section'> : never;
+
+const customFieldComponent: ComponentDefinition<typeof defineCustomField> = defineComponent({
+  type: 'CUSTOM_FIELD_V2',
+  define: defineCustomField,
+  references: (_definition, props) => [props.section],
+});