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

package/core/platform/custom-objects/fields.js

@@ -1,369 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formula = void 0;
-exports.nativeModel = nativeModel;
-exports.text = text;
-exports.longText = longText;
-exports.email = email;
-exports.url = url;
-exports.phone = phone;
-exports.number = number;
-exports.currency = currency;
-exports.percentage = percentage;
-exports.date = date;
-exports.datetime = datetime;
-exports.time = time;
-exports.select = select;
-exports.radio = radio;
-exports.boolean = boolean;
-exports.file = file;
-exports.lookup = lookup;
-exports.parentChild = parentChild;
-exports.sections = sections;
-/**
- * Freezes a field definition so reusable fragments stay immutable at runtime.
- *
- * @typeParam TField - Concrete field definition being frozen.
- */
-/**
- * Freezes one field definition fragment before returning it to callers.
- *
- * @param field - Concrete field definition to freeze.
- * @returns The same field definition, frozen for safe reuse.
- * @typeParam TField - Concrete field definition being frozen.
- */
-function freezeField(field) {
-    return Object.freeze(field);
-}
-/**
- * Normalizes an optional required flag into the literal type expected by field definitions.
- *
- * @typeParam TRequired - Literal boolean requested by the caller.
- */
-/**
- * Normalizes an optional `required` flag into the literal boolean type used by field definitions.
- *
- * @param required - Optional literal required flag supplied by the caller.
- * @returns Normalized required flag, defaulting to `false`.
- * @typeParam TRequired - Literal boolean requested by the caller.
- */
-function normalizeRequired(required) {
-    return (required ?? false);
-}
-/**
- * Declares a native Rippling model target for lookup fields.
- *
- * @param apiName - Native model API name, for example `'Employee'`.
- * @returns Immutable native-model target descriptor for lookup fields.
- * @typeParam TApiName - Native model api name, for example `'Employee'`.
- */
-function nativeModel(apiName) {
-    return Object.freeze({ kind: 'native-model-target', apiName });
-}
-/**
- * Defines a single-line text field.
- *
- * @param props - Text-field metadata and presentation properties.
- * @returns Immutable text field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function text(props) {
-    return freezeField({ kind: 'text', required: normalizeRequired(props.required), writable: true, ...props });
-}
-/**
- * Defines a multi-line text field.
- *
- * @param props - Long-text field metadata and presentation properties.
- * @returns Immutable long-text field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function longText(props) {
-    return freezeField({
-        kind: 'long-text',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines an email-address field.
- *
- * @param props - Email-field metadata and presentation properties.
- * @returns Immutable email field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function email(props) {
-    return freezeField({
-        kind: 'email',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a URL field.
- *
- * @param props - URL-field metadata and presentation properties.
- * @returns Immutable URL field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function url(props) {
-    return freezeField({ kind: 'url', required: normalizeRequired(props.required), writable: true, ...props });
-}
-/**
- * Defines a phone-number field.
- *
- * @param props - Phone-field metadata and presentation properties.
- * @returns Immutable phone field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function phone(props) {
-    return freezeField({
-        kind: 'phone',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a numeric field.
- *
- * @param props - Number-field metadata and presentation properties.
- * @returns Immutable number field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function number(props) {
-    return freezeField({
-        kind: 'number',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a currency field.
- *
- * @param props - Currency-field metadata and presentation properties.
- * @returns Immutable currency field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function currency(props) {
-    return freezeField({
-        kind: 'currency',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a percentage field.
- *
- * @param props - Percentage-field metadata and presentation properties.
- * @returns Immutable percentage field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function percentage(props) {
-    return freezeField({
-        kind: 'percentage',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a date-only field.
- *
- * @param props - Date-field metadata and presentation properties.
- * @returns Immutable date field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function date(props) {
-    return freezeField({ kind: 'date', required: normalizeRequired(props.required), writable: true, ...props });
-}
-/**
- * Defines a date-time field.
- *
- * @param props - Datetime-field metadata and presentation properties.
- * @returns Immutable datetime field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function datetime(props) {
-    return freezeField({
-        kind: 'datetime',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a time-of-day field.
- *
- * @param props - Time-field metadata and presentation properties.
- * @returns Immutable time field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function time(props) {
-    return freezeField({ kind: 'time', required: normalizeRequired(props.required), writable: true, ...props });
-}
-/**
- * Defines a multi-select choice field.
- *
- * @param props - Multi-select field metadata and presentation properties.
- * @returns Immutable multi-select field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function select(props) {
-    return freezeField({
-        kind: 'select',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a single-select radio field.
- *
- * @param props - Radio-field metadata and presentation properties.
- * @returns Immutable radio field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function radio(props) {
-    return freezeField({
-        kind: 'radio',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a boolean field.
- *
- * @param props - Boolean-field metadata and presentation properties.
- * @returns Immutable boolean field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function boolean(props) {
-    return freezeField({
-        kind: 'boolean',
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a file attachment field.
- *
- * @param props - File-field metadata and presentation properties.
- * @returns Immutable file field definition.
- * @typeParam TRequired - Whether the field is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function file(props) {
-    return freezeField({ kind: 'file', required: normalizeRequired(props.required), writable: true, ...props });
-}
-/**
- * Defines a many-to-one lookup field.
- *
- * @param target - Target object or native model referenced by the lookup.
- * @param props - Lookup-field metadata and presentation properties.
- * @returns Immutable lookup field definition.
- * @typeParam TTarget - Target object or native model referenced by the lookup.
- * @typeParam TRequired - Whether the lookup is required during record creation.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function lookup(target, props) {
-    return freezeField({
-        kind: 'lookup',
-        target,
-        targetApiName: target.apiName,
-        required: normalizeRequired(props.required),
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Defines a parent-child relationship field.
- *
- * @param target - Parent object definition referenced by the relationship.
- * @param props - Parent-child field metadata and presentation properties.
- * @returns Immutable parent-child field definition.
- * @typeParam TTarget - Parent object definition referenced by the relationship.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function parentChild(target, props) {
-    return freezeField({
-        kind: 'parent-child',
-        target,
-        targetApiName: target.apiName,
-        required: true,
-        writable: true,
-        ...props,
-    });
-}
-/**
- * Shared implementation for the public formula helpers.
- *
- * @typeParam TKind - Concrete formula-field discriminant.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-/**
- * Builds one immutable read-only formula field definition.
- *
- * @param kind - Concrete formula-field discriminant to produce.
- * @param props - Formula metadata and presentation properties.
- * @returns Immutable formula field definition.
- * @typeParam TKind - Concrete formula-field discriminant.
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
- */
-function formulaField(kind, props) {
-    return freezeField({ ...props, kind, writable: false, required: false });
-}
-/** Typed helpers for read-only formula fields. */
-exports.formula = Object.freeze({
-    text(props) {
-        return formulaField('formula-text', props);
-    },
-    number(props) {
-        return formulaField('formula-number', props);
-    },
-    boolean(props) {
-        return formulaField('formula-boolean', props);
-    },
-    currency(props) {
-        return formulaField('formula-currency', props);
-    },
-    percentage(props) {
-        return formulaField('formula-percentage', props);
-    },
-    date(props) {
-        return formulaField('formula-date', props);
-    },
-    url(props) {
-        return formulaField('formula-url', props);
-    },
-});
-/**
- * Immutable helper for authoring section maps in reusable fragments.
- *
- * @param definitions - Section definitions to freeze and preserve as-is.
- * @returns Frozen section-definition map retaining the caller's key/value types.
- * @typeParam TSections - Concrete section map to preserve in the returned value.
- */
-function sections(definitions) {
-    return Object.freeze({ ...definitions });
-}
-//# sourceMappingURL=fields.js.map

package/core/platform/custom-objects/fields.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/fields.ts"],"names":[],"mappings":";;;AA4HA,kCAEC;AAUD,oBAQC;AAUD,4BAaC;AAUD,sBAaC;AAUD,kBAOC;AAUD,sBAYC;AAUD,wBAYC;AAUD,4BAaC;AAUD,gCAYC;AAUD,oBAOC;AAUD,4BAYC;AAUD,oBAOC;AAUD,wBAYC;AAUD,sBAYC;AAUD,0BAYC;AAUD,oBAQC;AAYD,wBAoBC;AAWD,kCAoBC;AAqJD,4BAIC;AAvjBD;;;;GAIG;AACH;;;;;;GAMG;AACH,SAAS,WAAW,CAAoC,KAAa;IACnE,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH;;;;;;GAMG;AACH,SAAS,iBAAiB,CAA4B,QAA+B;IACnF,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAc,CAAC;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAA0B,OAAiB;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAIlB,KACuG;IAEvG,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CAItB,KAC4E;IAE5E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,WAAW;QACjB,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CAInB,KAC0E;IAE1E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,GAAG,CAIjB,KAA+E;IAE/E,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAC7G,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CAInB,KAA+E;IAE/E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,MAAM,CAIpB,KAA2G;IAE3G,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CAItB,KACuE;IAEvE,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAIxB,KAA+E;IAE/E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAIlB,KAA+E;IAE/E,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CAItB,KAA+E;IAE/E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAIlB,KAA+E;IAE/E,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,MAAM,CAIpB,KAA0E;IAE1E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CAInB,KAA0E;IAE1E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,OAAO,CAIrB,KAA+E;IAE/E,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAIlB,KACqG;IAErG,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CAKpB,MAAe,EACf,KAIG;IAEH,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,MAAM;QACN,aAAa,EAAE,MAAM,CAAC,OAAiC;QACvD,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAIzB,MAAe,EACf,KAKC;IAED,OAAO,WAAW,CAAC;QACjB,IAAI,EAAE,cAAc;QACpB,MAAM;QACN,aAAa,EAAE,MAAM,CAAC,OAA+D;QACrF,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;QACd,GAAG,KAAK;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH;;;;;;;;GAQG;AACH,SAAS,YAAY,CAInB,IAAW,EACX,KAAgG;IAEhG,OAAO,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAc,EAAE,CAI/E,CAAC;AACJ,CAAC;AAoED,kDAAkD;AACrC,QAAA,OAAO,GAAmB,MAAM,CAAC,MAAM,CAAC;IACnD,IAAI,CACF,KAA+F;QAE/F,OAAO,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CACJ,KAAmE;QAEnE,OAAO,YAAY,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,CACL,KAAmE;QAEnE,OAAO,YAAY,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,QAAQ,CACN,KAAmE;QAEnE,OAAO,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,UAAU,CACR,KAAmE;QAEnE,OAAO,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CACF,KAAmE;QAEnE,OAAO,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,GAAG,CACD,KAAmE;QAEnE,OAAO,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;CACF,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAgB,QAAQ,CACtB,WAAsB;IAEtB,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;AAC3C,CAAC"}