@rippling/rippling-sdk 0.2.0-alpha.34 → 0.2.0-alpha.35

package/lib/manifest/custom-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-object.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAKH,2EAA2E;AAC3E,6CAA6C;AAC7C,mEAAmE;AACnE,sEAAsE;AACtE,mDAAmD;AACnD,2EAA2E;AAE3E,+FAA+F;AAC/F,MAAM,oBAAoB,GAOrB;IACH;QACE,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,mBAAmB;QAC5B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,2DAA2D;QACxE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,aAAa;QACtB,WAAW,EAAE,aAAa;QAC1B,WAAW,EAAE,uEAAuE;QACpF,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,MAAM;QACf,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,yFAAyF;QACtG,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,OAAO;QACpB,WAAW,EACT,kIAAkI;QACpI,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc;IAClB,YACmB,mBAA2B,EAC3B,IAA2C;QAD3C,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,SAAI,GAAJ,IAAI,CAAuC;IAC3D,CAAC;IAEJ,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,mBAAmB;YAChD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YACjC,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YACzC,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC3E,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAClC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC/B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YAC3B,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,IAAI;YACjB,wBAAwB,EAAE,IAAI;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF;AAgCD,MAAa,YAAY;IAWvB,yFAAyF;IACzF,YAAY,KAAoB,EAAE,KAAwB;QACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QAC9D,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtB,6EAA6E;QAC7E,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACxC,KAAK,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,SAAS,CAAC,SAA4B;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,6BAA6B;IAC7B,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;YACtC,iBAAiB,EAAE,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;SACrG,CAAC;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAwB,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACnE,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI;gBAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACzF,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI;gBAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC7E,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACpE,yEAAyE;YACzE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7E,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC7F,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC1C,SAAS,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC1E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA3ED,oCA2EC"}
+{"version":3,"file":"custom-object.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":";;;AAGA,2EAA2E;AAC3E,6CAA6C;AAC7C,mEAAmE;AACnE,sEAAsE;AACtE,mDAAmD;AACnD,2EAA2E;AAE3E,+FAA+F;AAC/F,MAAM,oBAAoB,GAOrB;IACH;QACE,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,mBAAmB;QAC5B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,2DAA2D;QACxE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,aAAa;QACtB,WAAW,EAAE,aAAa;QAC1B,WAAW,EAAE,uEAAuE;QACpF,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,MAAM;QACf,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,yFAAyF;QACtG,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,OAAO;QACpB,WAAW,EACT,kIAAkI;QACpI,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc;IAClB,YACmB,mBAA2B,EAC3B,IAA2C;QAD3C,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,SAAI,GAAJ,IAAI,CAAuC;IAC3D,CAAC;IAEJ,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,mBAAmB;YAChD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YACjC,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YACzC,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC3E,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAClC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC/B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YAC3B,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,IAAI;YACjB,wBAAwB,EAAE,IAAI;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF;AAyFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,YAAY;IAWvB;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAwB;QACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QAC9D,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtB,6EAA6E;QAC7E,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACxC,KAAK,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,iFAAiF;IACjF,SAAS,CAAC,SAA4B;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;YACtC,iBAAiB,EAAE,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;SACrG,CAAC;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAwB,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACnE,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI;gBAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACzF,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI;gBAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC7E,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACpE,yEAAyE;YACzE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7E,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC7F,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC1C,SAAS,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC1E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA1FD,oCA0FC"}

package/lib/manifest/custom-object.mjs

@@ -1,24 +1,3 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * CustomObject builder. Backend schema: CUSTOM_OBJECT (v2).
- *
- * Construction is CDK-style: `new CustomObject(scope, props)` where `scope`
- * is the `ManifestBuilder` (or any `ManifestScope`). The CO also acts as a
- * scope for its own children (fields, validations, rules, list views, page
- * layouts, sections, actions) — those take the CO as their first arg and
- * auto-register with the manifest through it.
- *
- * Every CO auto-registers 9 platform-managed standard field stubs at
- * construction, matching `STANDARD_FIELDS` in the backend's `constants.py`:
- *   id, created_at, updated_at, system_updated_at, external_id, name,
- *   owner_role, last_modified_by, created_by
- * The backend's closed-world `extract_from_configs` path (used by
- * `POST /metadata/v2/validate`) treats these as hard dependencies of the CO —
- * for any brand-new CO their configs must already be present in the submitted
- * manifest, else validation raises `DEPENDENCY_ERROR`. Users never declare
- * them explicitly; the SDK emits them with `is_standard: true`.
- */
 // ────────────────────────────────────────────────────────────────────────
 // Platform-managed standard fields — mirrors
 // `app/hub_platform/custom_objects/constants.py::STANDARD_FIELDS`.
@@ -145,8 +124,53 @@ class _StandardField {
         };
     }
 }
+/**
+ * Defines a custom object and registers it with the manifest.
+ *
+ * A custom object is a new entity type with its own fields, validations, rules, list views,
+ * and page layouts. You would normally define all custom objects near the top of your manifest
+ * file, then define their children (fields, sections, rules, etc.) below. Each child takes
+ * the `CustomObject` instance as its first argument and registers automatically.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ * });
+ *
+ * const gymCategory = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ *
+ * const memberObj = new CustomObject(manifest, {
+ *   apiName: 'gym_member__c',
+ *   name: 'Member',
+ *   pluralLabel: 'Members',
+ *   category: gymCategory,
+ *   description: 'Gym member profile, contact, and membership status',
+ *   icon: { emoji: '🏋️' },
+ * });
+ *
+ * // The object is now a scope — children register through it:
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   required: true,
+ * });
+ * ```
+ *
+ * @remarks
+ * **Required: every `CustomObject` must have at least one `CustomObjectPageLayout` in the
+ * manifest.** Omitting it passes component-level validation but fails at the package level
+ * with `DEPENDENCY_ERROR: Page layout config for CO (api_name=...) not found in package
+ * configs. CO requires at least one page layout in the package.`
+ * Use {@link CustomObjectPageLayout.basic} for a minimal single-tab layout.
+ */
 export class CustomObject {
-    /** Build a new CO and auto-register with `scope`; enforces `__c` suffix on `apiName`. */
+    /**
+     * @param scope - The manifest or parent scope to register this object with.
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.apiName` does not end with `__c`.
+     */
     constructor(scope, props) {
         if (!props.apiName.endsWith('__c')) {
             throw new Error(`Custom object api_name must end with __c: ${props.apiName}`);
@@ -166,19 +190,30 @@ export class CustomObject {
             scope._register(new _StandardField(this._apiName, spec));
         }
     }
-    /** @internal Scope hook: forward child registration up to the builder. */
+    /** @internal Scope hook — forwards child registration up to the root builder. */
     _register(component) {
         this._scope._register(component);
     }
-    /** Backend api_name for this custom object. */
+    /**
+     * Returns the api_name of this custom object (e.g. `'gym_member__c'`).
+     *
+     * Use the return value wherever a field or layout needs to reference this object by name.
+     */
     getApiName() {
         return this._apiName;
     }
-    /** Singular display name. */
+    /**
+     * Returns the singular display name of this custom object (e.g. `'Member'`).
+     */
     getName() {
         return this._name;
     }
-    /** Serialize to the backend `CUSTOM_OBJECT` wire shape. */
+    /**
+     * Serializes this custom object to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT'` and all configured fields.
+     * Optional fields are omitted when `null`. An `icon` with no populated keys is omitted entirely.
+     */
     toDict() {
         const component = {
             type: 'CUSTOM_OBJECT',

package/lib/manifest/custom-object.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"custom-object.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAKH,2EAA2E;AAC3E,6CAA6C;AAC7C,mEAAmE;AACnE,sEAAsE;AACtE,mDAAmD;AACnD,2EAA2E;AAE3E,+FAA+F;AAC/F,MAAM,oBAAoB,GAOrB;IACH;QACE,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,mBAAmB;QAC5B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,2DAA2D;QACxE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,aAAa;QACtB,WAAW,EAAE,aAAa;QAC1B,WAAW,EAAE,uEAAuE;QACpF,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,MAAM;QACf,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,yFAAyF;QACtG,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,OAAO;QACpB,WAAW,EACT,kIAAkI;QACpI,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc;IAClB,YACmB,mBAA2B,EAC3B,IAA2C;QAD3C,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,SAAI,GAAJ,IAAI,CAAuC;IAC3D,CAAC;IAEJ,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,mBAAmB;YAChD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YACjC,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YACzC,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC3E,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAClC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC/B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YAC3B,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,IAAI;YACjB,wBAAwB,EAAE,IAAI;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF;AAgCD,MAAM,OAAO,YAAY;IAWvB,yFAAyF;IACzF,YAAY,KAAoB,EAAE,KAAwB;QACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QAC9D,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtB,6EAA6E;QAC7E,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACxC,KAAK,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,SAAS,CAAC,SAA4B;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,6BAA6B;IAC7B,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;YACtC,iBAAiB,EAAE,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;SACrG,CAAC;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAwB,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACnE,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI;gBAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACzF,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI;gBAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC7E,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACpE,yEAAyE;YACzE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7E,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC7F,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC1C,SAAS,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC1E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"custom-object.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":"AAGA,2EAA2E;AAC3E,6CAA6C;AAC7C,mEAAmE;AACnE,sEAAsE;AACtE,mDAAmD;AACnD,2EAA2E;AAE3E,+FAA+F;AAC/F,MAAM,oBAAoB,GAOrB;IACH;QACE,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,6BAA6B;QAC1C,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,mBAAmB;QAC5B,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE,2DAA2D;QACxE,QAAQ,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE;QACpC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,aAAa;QACtB,WAAW,EAAE,aAAa;QAC1B,WAAW,EAAE,uEAAuE;QACpF,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;KACb;IACD;QACE,OAAO,EAAE,MAAM;QACf,WAAW,EAAE,MAAM;QACnB,WAAW,EAAE,yFAAyF;QACtG,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;QAChC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,OAAO;QACpB,WAAW,EACT,kIAAkI;QACpI,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,kBAAkB;QAC3B,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;IACD;QACE,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,YAAY;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE;YACR,UAAU,EAAE,aAAa;YACzB,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,iBAAiB;YAChC,6BAA6B,EAAE,QAAQ;SACxC;QACD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,KAAK;KACd;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc;IAClB,YACmB,mBAA2B,EAC3B,IAA2C;QAD3C,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,SAAI,GAAJ,IAAI,CAAuC;IAC3D,CAAC;IAEJ,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,mBAAmB;YAChD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YACjC,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YACzC,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC3E,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAClC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YAC/B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YAC3B,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,IAAI;YACjB,wBAAwB,EAAE,IAAI;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF;AAyFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,OAAO,YAAY;IAWvB;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAwB;QACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QAC9D,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtB,6EAA6E;QAC7E,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACxC,KAAK,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,iFAAiF;IACjF,SAAS,CAAC,SAA4B;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;YACtC,iBAAiB,EAAE,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;SACrG,CAAC;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAwB,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACnE,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI;gBAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YACzF,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI;gBAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC7E,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI;gBAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACpE,yEAAyE;YACzE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7E,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC7F,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC1C,SAAS,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC1E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/manifest/field.d.mts

@@ -1,12 +1,34 @@
 import { type FieldType, type FormulaFieldType, type SummaryAggregation, type SummaryFilterOperator } from "./_helpers.mjs";
 import type { CustomObject } from "./custom-object.mjs";
 import type { CustomObjectFieldSection } from "./custom-object-field-section.mjs";
-/** Summary filter. Lives here (not `_helpers.ts`) to avoid a circular import with `Field`. */
+/**
+ * A filter condition applied to a {@link SummaryField}.
+ *
+ * Filters restrict which child records are included in the aggregation.
+ * Only scalar field types are supported as filter fields — see
+ * `FILTER_OPERATORS_BY_TYPE` in `_helpers.ts` for the per-type operator allow-list.
+ */
 export interface SummaryFilter {
-    /** Filter field on the child CO. */
+    /**
+     * The child-CO field to filter on.
+     *
+     * Required. Must be a scalar field on the same child object as `lookup`.
+     * Cannot be a formula field, summary field, or the `lookup` field itself.
+     */
     field: Field;
+    /**
+     * Comparison operator. Allowed operators depend on the field's type —
+     * text/boolean fields support `=` and `!=`; numeric/date fields additionally
+     * support `>`, `>=`, `<`, `<=`.
+     *
+     * Required.
+     */
     operator: SummaryFilterOperator;
-    /** Raw RQL value, e.g. `"'Active'"`, `"50"`, `"true"`, `"DATE(2026,1,1)"`. */
+    /**
+     * Raw RQL value string, e.g. `"'Active'"`, `"50"`, `"true"`, `"DATE(2026,1,1)"`.
+     *
+     * Required.
+     */
     value: string;
 }
 interface SummarySpec {
@@ -50,9 +72,28 @@ export interface FieldProps {
     summarySpec?: SummarySpec | undefined;
 }
 /**
- * Base class for every custom-object field. Prefer the concrete subclasses
- * (`TextField`, `LookupField`, `SummaryField`, …). Construct `Field` directly
- * only for wire-types the SDK doesn't yet model.
+ * Base class for every custom-object field.
+ *
+ * Prefer the typed subclasses (`TextField`, `NumberField`, `LookupField`, …) over
+ * constructing `Field` directly. Use `Field` only for wire-level field types the
+ * SDK does not yet model with a dedicated subclass.
+ *
+ * All field classes share the same scope-first CDK pattern: pass the parent
+ * {@link CustomObject} as the first argument and the field auto-registers with
+ * the manifest. Every field api_name must end with `__c`.
+ *
+ * @example
+ * ```ts
+ * // Prefer typed subclasses:
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   required: true,
+ *   maxLength: 80,
+ * });
+ * ```
+ *
+ * @see {@link TextField}, {@link NumberField}, {@link LookupField}, {@link SummaryField}
  */
 export declare class Field {
     private readonly _fieldApiName;
@@ -69,205 +110,375 @@ export declare class Field {
     private readonly _section;
     private readonly _summarySpec;
     private readonly _derivedAggregatedFieldStatic;
-    /** Build a new field; enforces `__c` suffix and folds props into `data_type`. */
+    /**
+     * @param customObject - The custom object this field belongs to.
+     * @param props - Field configuration. See {@link FieldProps}.
+     * @throws {Error} If `props.apiName` does not end with `__c`.
+     */
     constructor(customObject: CustomObject, props: FieldProps);
-    /** Backend api_name for this field. */
+    /** Returns the api_name of this field (e.g. `'first_name__c'`). */
     getApiName(): string;
-    /** Human-readable display name. */
+    /** Returns the display name of this field. */
     getDisplayName(): string;
-    /** api_name of the CustomObject this field lives on. */
+    /** Returns the api_name of the custom object this field belongs to. */
     getCustomObjectApiName(): string;
-    /** Resolved `data_type.field_type`, or null if unset. */
+    /** Returns the resolved `field_type` (e.g. `'TEXT'`), or `null` if unset. */
     getFieldType(): FieldType | null;
-    /** Raw `data_type` dict (read-only view). */
+    /** Returns a read-only view of the raw `data_type` dict. */
     getDataType(): Readonly<Record<string, any>>;
-    /** True if this field is a simple formula field. */
+    /** Returns `true` if this is a formula (computed) field. */
     isFormula(): boolean;
-    /** True if this field is a summary/rollup field. */
+    /** Returns `true` if this is a summary (rollup) field. */
     isSummary(): boolean;
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD` wire shape. */
+    /**
+     * Serializes this field to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD'`.
+     */
     toDict(): Record<string, any>;
     /** Build the `derived_aggregated_field` dict from `_summarySpec` with cross-CO checks. */
     private _resolveAggregatedField;
 }
+/** Initialization properties for {@link TextField}. */
 export interface TextFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** Whether values must be unique across records. Optional. */
     unique?: boolean;
+    /** Maximum character length. Optional. */
     maxLength?: number;
 }
-/** Single-line text. */
+/** Single-line text field. */
 export declare class TextField extends Field {
     constructor(customObject: CustomObject, props: TextFieldProps);
 }
+/** Initialization properties for {@link LongTextField}. */
 export interface LongTextFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** Maximum character length. Optional. */
     maxLength?: number;
 }
-/** Multi-line text. */
+/** Multi-line text field. */
 export declare class LongTextField extends Field {
     constructor(customObject: CustomObject, props: LongTextFieldProps);
 }
+/** Initialization properties for {@link EmailField}. */
 export interface EmailFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** Whether values must be unique across records. Optional. */
     unique?: boolean;
 }
-/** Email address (format-validated by the UI). */
+/** Email address field. Format is validated by the Rippling UI. */
 export declare class EmailField extends Field {
     constructor(customObject: CustomObject, props: EmailFieldProps);
 }
+/** Initialization properties for {@link UrlField}. */
 export interface UrlFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** URL (format-validated by the UI). */
+/** URL field. Format is validated by the Rippling UI. */
 export declare class UrlField extends Field {
     constructor(customObject: CustomObject, props: UrlFieldProps);
 }
+/** Initialization properties for {@link PhoneField}. */
 export interface PhoneFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Phone number. */
+/** Phone number field. */
 export declare class PhoneField extends Field {
     constructor(customObject: CustomObject, props: PhoneFieldProps);
 }
+/** Initialization properties for {@link NumberField}. */
 export interface NumberFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** Whether values must be unique across records. Optional. */
     unique?: boolean;
+    /** Number of decimal places to display and store. Optional. */
     decimalPlaces?: number;
 }
-/** Number. */
+/** Numeric field. */
 export declare class NumberField extends Field {
     constructor(customObject: CustomObject, props: NumberFieldProps);
 }
+/** Initialization properties for {@link CurrencyField}. */
 export interface CurrencyFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** ISO 4217 currency code (e.g. `'USD'`). Optional. Forwarded to the wire only when set. */
     currency?: string;
+    /** Number of decimal places. Optional. */
     decimalPlaces?: number;
 }
-/** Currency amount; `currency` is forwarded only when set. */
+/** Currency amount field. */
 export declare class CurrencyField extends Field {
     constructor(customObject: CustomObject, props: CurrencyFieldProps);
 }
+/** Initialization properties for {@link PercentageField}. */
 export interface PercentageFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
+    /** Number of decimal places. Optional. */
     decimalPlaces?: number;
 }
-/** Percentage. */
+/** Percentage field. */
 export declare class PercentageField extends Field {
     constructor(customObject: CustomObject, props: PercentageFieldProps);
 }
+/** Initialization properties for {@link DateField}. */
 export interface DateFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Date (no time). */
+/** Date field (no time component). */
 export declare class DateField extends Field {
     constructor(customObject: CustomObject, props: DateFieldProps);
 }
+/** Initialization properties for {@link DatetimeField}. */
 export interface DatetimeFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Date + time. */
+/** Date and time field. */
 export declare class DatetimeField extends Field {
     constructor(customObject: CustomObject, props: DatetimeFieldProps);
 }
+/** Initialization properties for {@link TimeField}. */
 export interface TimeFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Time of day. */
+/** Time-of-day field. */
 export declare class TimeField extends Field {
     constructor(customObject: CustomObject, props: TimeFieldProps);
 }
+/** Initialization properties for {@link SelectField}. */
 export interface SelectFieldProps extends CommonFieldProps {
-    /** Required choice list. */
+    /**
+     * The list of selectable options (e.g. `['Active', 'Frozen', 'Cancelled']`).
+     *
+     * Required.
+     */
     options: string[];
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Dropdown select. */
+/** Dropdown single-select field. */
 export declare class SelectField extends Field {
     constructor(customObject: CustomObject, props: SelectFieldProps);
 }
+/** Initialization properties for {@link RadioField}. */
 export interface RadioFieldProps extends CommonFieldProps {
-    /** Required choice list. */
+    /**
+     * The list of selectable options.
+     *
+     * Required.
+     */
     options: string[];
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Radio button group. */
+/** Radio button group field. */
 export declare class RadioField extends Field {
     constructor(customObject: CustomObject, props: RadioFieldProps);
 }
+/** Initialization properties for {@link BooleanField}. */
 export interface BooleanFieldProps extends CommonFieldProps {
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Boolean (checkbox). */
+/** Boolean (checkbox) field. */
 export declare class BooleanField extends Field {
     constructor(customObject: CustomObject, props: BooleanFieldProps);
 }
+/** Initialization properties for {@link FileField}. */
 export interface FileFieldProps extends CommonFieldProps {
     /**
-     * File-type restriction. Matches the UI's "File type" dropdown options.
-     *   'images'     — jpg, jpeg, png, gif, bmp, svg
-     *   'documents'  — doc, docx, pdf, csv, txt, rtf, ppt, pptx
-     *   'any'        — any file type
+     * Restricts which file types can be uploaded. Mirrors the UI's "File type" dropdown.
+     *
+     * Required.
+     * - `'images'` — jpg, jpeg, png, gif, bmp, svg
+     * - `'documents'` — doc, docx, pdf, csv, txt, rtf, ppt, pptx
+     * - `'any'` — any file type
      */
     allowedType: 'images' | 'documents' | 'any';
+    /** Whether a file is required on save. Optional. */
     required?: boolean;
 }
-/** File attachment; `allowedType` mirrors the UI's "File type" dropdown. */
+/** File attachment field. */
 export declare class FileField extends Field {
     constructor(customObject: CustomObject, props: FileFieldProps);
 }
+/** Initialization properties for {@link LookupField}. */
 export interface LookupFieldProps extends CommonFieldProps {
-    /** Target object. Live `CustomObject` (SDK reads api_name) or native-model api_name string (e.g. `'role'`). */
+    /**
+     * The object this field points to. Pass a live {@link CustomObject} instance,
+     * or a raw api_name string for native Rippling models (e.g. `'role'`).
+     *
+     * Required.
+     */
     target: CustomObject | string;
+    /**
+     * Label for the related-records panel on the target object's detail page
+     * (e.g. `'Class enrollments'`).
+     *
+     * Optional.
+     */
     relatedDataLabel?: string;
+    /** Whether a value is required on save. Optional. */
     required?: boolean;
 }
-/** Many-to-one reference. */
+/**
+ * Many-to-one reference field. Links this record to one record on the target object.
+ *
+ * Use {@link ParentChildField} instead when the relationship should create a
+ * parent-child hierarchy with rollup support.
+ */
 export declare class LookupField extends Field {
     constructor(customObject: CustomObject, props: LookupFieldProps);
 }
+/** Initialization properties for {@link ParentChildField}. */
 export interface ParentChildFieldProps extends CommonFieldProps {
-    /** Target parent object. Must be a live `CustomObject`. */
+    /**
+     * The parent object. Must be a live {@link CustomObject} instance.
+     *
+     * Required.
+     */
     target: CustomObject;
+    /**
+     * Label for the child-records panel on the parent's detail page
+     * (e.g. `'Enrollments'`).
+     *
+     * Optional.
+     */
     relatedDataLabel?: string;
+    /**
+     * Whether this is the primary or secondary parent-child edge.
+     * One of `'PRIMARY'` | `'SECONDARY'`.
+     *
+     * Optional.
+     */
     parentChildType?: 'PRIMARY' | 'SECONDARY';
+    /**
+     * Whether the child record inherits the owner from the parent.
+     *
+     * Optional.
+     */
     enableParentOwnerInheritance?: boolean;
 }
-/** Parent-child reference — always required on the wire. */
+/**
+ * Parent-child reference field. Creates a hierarchical relationship between
+ * this object (child) and the target (parent), enabling {@link SummaryField}
+ * rollups from the child to the parent.
+ *
+ * Always emitted as `required: true` on the wire.
+ */
 export declare class ParentChildField extends Field {
     constructor(customObject: CustomObject, props: ParentChildFieldProps);
 }
+/** Initialization properties for {@link FormulaField}. */
 export interface FormulaFieldProps extends CommonFieldProps {
-    /** The computed RQL expression. */
+    /**
+     * The RQL expression that computes this field's value
+     * (e.g. `"CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))"`).
+     *
+     * Required.
+     */
     formula: string;
-    /** Output type narrowed to the 7 variants the UI "Data type" dropdown exposes. */
+    /**
+     * Output data type. One of `'TEXT'` | `'NUMBER'` | `'BOOLEAN'` | `'CURRENCY'`
+     * | `'PERCENTAGE'` | `'DATE'` | `'URL'`.
+     *
+     * Required.
+     */
     fieldType: FormulaFieldType;
-    /** Required when `fieldType === 'TEXT'`. */
+    /**
+     * Maximum character length of the computed value.
+     *
+     * Required when `fieldType === 'TEXT'`. The constructor throws if omitted for text formulas.
+     */
     maxLength?: number;
 }
 /**
- * Computed formula field (read-only). `fieldType` is required and narrowed
- * to the 7 variants the UI "Data type" dropdown exposes. `maxLength` is
- * required when `fieldType === 'TEXT'`.
+ * Read-only computed field whose value is derived from an RQL formula.
+ *
+ * `fieldType` is required and restricted to the 7 output types the Rippling
+ * formula editor supports. `maxLength` is required when `fieldType === 'TEXT'`.
+ *
+ * @example
+ * ```ts
+ * const memberDisplayName = new FormulaField(memberObj, {
+ *   apiName: 'member_display_name__c',
+ *   displayName: 'Display name',
+ *   fieldType: 'TEXT',
+ *   maxLength: 200,
+ *   formula: "CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))",
+ * });
+ * ```
  */
 export declare class FormulaField extends Field {
     constructor(customObject: CustomObject, props: FormulaFieldProps);
 }
+/** Initialization properties for {@link SummaryField}. */
 export interface SummaryFieldProps extends CommonFieldProps {
-    /** Child-CO field being aggregated. Must have a known fieldType. */
+    /**
+     * The child-CO field whose values are aggregated.
+     *
+     * Required. Must have a known `fieldType` (use a typed subclass, not bare `Field`).
+     * Must live on the same child object as `lookup`.
+     */
     aggregates: Field;
+    /**
+     * Aggregation function. One of `'COUNT'` | `'SUM'` | `'MIN'` | `'MAX'`.
+     *
+     * Required. `COUNT` always produces a `NUMBER` output; other functions
+     * inherit the output type from `aggregates`.
+     */
     using: SummaryAggregation;
-    /** Child-CO's parentChild field pointing back at this CO. */
+    /**
+     * The {@link ParentChildField} on the child CO that points back at this parent object.
+     *
+     * Required. Must be a `ParentChildField` (the constructor throws otherwise).
+     */
     lookup: Field;
+    /**
+     * Optional filter conditions applied before aggregating. Each filter restricts
+     * which child records are included.
+     *
+     * Optional. @default `[]`
+     */
     filters?: SummaryFilter[];
-    /** Only valid when the output fieldType resolves to `'CURRENCY'`. */
+    /**
+     * ISO 4217 currency code (e.g. `'USD'`). Only valid when the aggregated field
+     * resolves to `'CURRENCY'`.
+     *
+     * Optional.
+     */
     currencyCode?: string;
 }
 /**
- * Summary/rollup field — aggregates a child-object field (read-only).
- * SDK enforces only what backend/UI won't: `lookup` edge_type, output-type
- * inference, per-type filter operators, and same-child-CO residency for
- * `aggregates` + `lookup`. Per-filter residency / LONG_TEXT / formula
- * filter / currency pairing checks are left to the backend.
+ * Read-only rollup field that aggregates a child object's field values.
+ *
+ * Defined on the **parent** object. Requires a {@link ParentChildField} on the
+ * child object pointing back at this parent as the `lookup` edge.
+ *
+ * @example
+ * ```ts
+ * // Count enrollments on a class session:
+ * const enrollmentCount = new SummaryField(sessionObj, {
+ *   apiName: 'enrollment_count__c',
+ *   displayName: 'Enrolled (count)',
+ *   aggregates: enrollmentMemberRef,
+ *   using: 'COUNT',
+ *   lookup: enrollmentSessionRef,  // ParentChildField on enrollmentObj → sessionObj
+ * });
+ * ```
+ *
+ * @see {@link ParentChildField} — must be used as `lookup`.
  */
 export declare class SummaryField extends Field {
     constructor(customObject: CustomObject, props: SummaryFieldProps);