@rippling/rippling-sdk 0.2.0-alpha.39 → 0.2.0-alpha.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts +240 -0
  2. package/lib/manifest/custom-object-page-layout.d.mts +185 -0
  3. package/lib/manifest/custom-object-page-layout.d.mts.map +1 -1
  4. package/lib/manifest/custom-object-page-layout.d.ts +185 -0
  5. package/lib/manifest/custom-object-page-layout.d.ts.map +1 -1
  6. package/lib/manifest/custom-object-page-layout.js +569 -0
  7. package/lib/manifest/custom-object-page-layout.js.map +1 -1
  8. package/lib/manifest/custom-object-page-layout.mjs +569 -0
  9. package/lib/manifest/custom-object-page-layout.mjs.map +1 -1
  10. package/lib/manifest/existing-manifest-context.d.mts.map +1 -1
  11. package/lib/manifest/existing-manifest-context.d.ts.map +1 -1
  12. package/lib/manifest/existing-manifest-context.js +1 -0
  13. package/lib/manifest/existing-manifest-context.js.map +1 -1
  14. package/lib/manifest/existing-manifest-context.mjs +1 -0
  15. package/lib/manifest/existing-manifest-context.mjs.map +1 -1
  16. package/lib/manifest/field.d.mts +2 -2
  17. package/lib/manifest/field.d.mts.map +1 -1
  18. package/lib/manifest/field.d.ts +2 -2
  19. package/lib/manifest/field.d.ts.map +1 -1
  20. package/lib/manifest/field.js +14 -7
  21. package/lib/manifest/field.js.map +1 -1
  22. package/lib/manifest/field.mjs +14 -7
  23. package/lib/manifest/field.mjs.map +1 -1
  24. package/lib/manifest/index.d.mts +1 -1
  25. package/lib/manifest/index.d.mts.map +1 -1
  26. package/lib/manifest/index.d.ts +1 -1
  27. package/lib/manifest/index.d.ts.map +1 -1
  28. package/lib/manifest/index.js.map +1 -1
  29. package/lib/manifest/index.mjs.map +1 -1
  30. package/package.json +1 -1
  31. package/src/lib/manifest/custom-object-page-layout.ts +830 -0
  32. package/src/lib/manifest/existing-manifest-context.ts +1 -0
  33. package/src/lib/manifest/field.ts +18 -9
  34. package/src/lib/manifest/index.ts +10 -0
  35. package/src/version.ts +1 -1
  36. package/version.d.mts +1 -1
  37. package/version.d.ts +1 -1
  38. package/version.js +1 -1
  39. package/version.mjs +1 -1
@@ -600,6 +600,7 @@ export class ExistingManifestContext {
600
600
  }
601
601
  if (field == null || typeof field !== 'object') return;
602
602
  const record = field as Record<string, any>;
603
+ this.loadFieldSectionIfPresent(customObjectApiName, record['fieldSection'] ?? record['field_section']);
603
604
  this.loadFieldDependencyIfString(customObjectApiName, record['fieldRqlName'] ?? record['field_rql_name']);
604
605
  }
605
606
 
@@ -70,7 +70,7 @@ interface CommonFieldProps {
70
70
  apiName: string;
71
71
  displayName: string;
72
72
  description?: string;
73
- section?: CustomObjectFieldSection | string;
73
+ section?: CustomObjectFieldSection;
74
74
  }
75
75
 
76
76
  /**
@@ -93,7 +93,7 @@ export interface FieldProps {
93
93
  formulaAttrMetas?: Record<string, any> | null | undefined;
94
94
  derivedAggregatedField?: Record<string, any> | null | undefined;
95
95
  derivedFieldFormula?: string | null | undefined;
96
- section?: CustomObjectFieldSection | string | null | undefined;
96
+ section?: CustomObjectFieldSection | null | undefined;
97
97
  maxLength?: number | undefined;
98
98
  decimalPlaces?: number | undefined;
99
99
  currency?: string | undefined;
@@ -106,6 +106,17 @@ export interface FieldLoadFromExistingOptions extends ExistingManifestContextOpt
106
106
  customObjectApiName?: string;
107
107
  }
108
108
 
109
+ function normalizeSectionInput(section: CustomObjectFieldSection | string | null | undefined): string | null {
110
+ if (section == null) return null;
111
+ if (typeof section === 'string') {
112
+ throw new TypeError(
113
+ `Field section must be a CustomObjectFieldSection object; received raw section id "${section}". ` +
114
+ 'Load/include the existing field section first.',
115
+ );
116
+ }
117
+ return section.getSectionId();
118
+ }
119
+
109
120
  class ExistingFieldReference {
110
121
  private _section: string | null;
111
122
 
@@ -240,11 +251,8 @@ export class Field {
240
251
  this._derivedFieldFormula = props.derivedFieldFormula ?? null;
241
252
  this._summarySpec = props.summarySpec ?? null;
242
253
 
243
- const rawSection = props.section;
244
- this._section =
245
- rawSection == null ? null
246
- : typeof rawSection === 'string' ? rawSection
247
- : rawSection.getSectionId();
254
+ const rawSection = props.section as CustomObjectFieldSection | string | null | undefined;
255
+ this._section = normalizeSectionInput(rawSection);
248
256
 
249
257
  customObject._register(this);
250
258
  }
@@ -278,8 +286,9 @@ export class Field {
278
286
  }
279
287
  if (component['derived_field_formula'] !== undefined)
280
288
  props.derivedFieldFormula = component['derived_field_formula'];
281
- if (component['section'] !== undefined) props.section = component['section'];
282
- return new Field(customObject, props);
289
+ const field = new Field(customObject, props);
290
+ if (typeof component['section'] === 'string') field._assignSection(component['section']);
291
+ return field;
283
292
  }
284
293
 
285
294
  /** @internal Creates a non-registered reference for standard or external fields. */
@@ -31,6 +31,11 @@ export {
31
31
 
32
32
  export {
33
33
  CustomObjectPageLayout,
34
+ type AddHeaderFieldOptions,
35
+ type AddPageLayoutFieldOptions,
36
+ type AddPageLayoutFieldsOptions,
37
+ type AddPageLayoutSectionOptions,
38
+ type AddPageLayoutTabOptions,
34
39
  type CustomObjectPageLayoutLoadFromExistingOptions,
35
40
  type CustomObjectPageLayoutProps,
36
41
  type CustomTab,
@@ -38,8 +43,13 @@ export {
38
43
  type HeaderEdits,
39
44
  type NewHeaderField,
40
45
  type PageLayoutDeletionIdentifier,
46
+ type PageLayoutMutationPosition,
41
47
  type PageLayoutSection,
42
48
  type PageLayoutTab,
49
+ type RemoveHeaderFieldOptions,
50
+ type RemovePageLayoutFieldOptions,
51
+ type RemovePageLayoutSectionOptions,
52
+ type RemovePageLayoutTabOptions,
43
53
  type SectionField,
44
54
  type SectionFieldOptions,
45
55
  type SectionFieldRef,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.2.0-alpha.39'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.41'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.39";
1
+ export declare const VERSION = "0.2.0-alpha.41";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.39";
1
+ export declare const VERSION = "0.2.0-alpha.41";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.2.0-alpha.39'; // x-release-please-version
4
+ exports.VERSION = '0.2.0-alpha.41'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.2.0-alpha.39'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.41'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map