@osdk/api 2.6.0-rc.14 → 2.7.0-beta.1

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 (61) hide show
  1. package/CHANGELOG.md +0 -9
  2. package/build/browser/OsdkObjectFrom.js.map +1 -1
  3. package/build/browser/derivedProperties/DerivedProperty.js.map +1 -1
  4. package/build/browser/index.js.map +1 -1
  5. package/build/browser/objectSet/ObjectSet.test.js +22 -0
  6. package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
  7. package/build/browser/ontology/ObjectTypeDefinition.js.map +1 -1
  8. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  9. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  10. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  11. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  12. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  13. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  14. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  15. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  16. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  17. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  18. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  19. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  20. package/build/cjs/{ObjectSet-DMlVNQym.d.cts → ObjectSet-Dtb6G0ll.d.cts} +203 -2
  21. package/build/cjs/index.d.cts +2 -2
  22. package/build/cjs/public/unstable.d.cts +2 -2
  23. package/build/esm/OsdkObjectFrom.js.map +1 -1
  24. package/build/esm/derivedProperties/DerivedProperty.js.map +1 -1
  25. package/build/esm/index.js.map +1 -1
  26. package/build/esm/objectSet/ObjectSet.test.js +22 -0
  27. package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
  28. package/build/esm/ontology/ObjectTypeDefinition.js.map +1 -1
  29. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  30. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  31. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  32. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  33. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  34. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  35. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  36. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  37. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  38. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  39. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  40. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  41. package/build/types/OsdkObjectFrom.d.ts +4 -0
  42. package/build/types/OsdkObjectFrom.d.ts.map +1 -1
  43. package/build/types/derivedProperties/DerivedProperty.d.ts +10 -1
  44. package/build/types/derivedProperties/DerivedProperty.d.ts.map +1 -1
  45. package/build/types/index.d.ts +6 -0
  46. package/build/types/index.d.ts.map +1 -1
  47. package/build/types/ontology/ObjectTypeDefinition.d.ts +2 -0
  48. package/build/types/ontology/ObjectTypeDefinition.d.ts.map +1 -1
  49. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts +5 -0
  50. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts.map +1 -0
  51. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts +37 -0
  52. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts.map +1 -0
  53. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts +8 -0
  54. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts.map +1 -0
  55. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts +117 -0
  56. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts.map +1 -0
  57. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts +8 -0
  58. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts.map +1 -0
  59. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts +12 -0
  60. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts.map +1 -0
  61. package/package.json +3 -3
@@ -37,6 +37,12 @@ export type { OntologyMetadata } from "./ontology/OntologyMetadata.js";
37
37
  export type { PrimaryKeyTypes } from "./ontology/PrimaryKeyTypes.js";
38
38
  export type { InterfaceQueryDataType, ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryDefinition, QueryMetadata, QueryParameterDefinition, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalQueryAggregationDefinition } from "./ontology/QueryDefinition.js";
39
39
  export type { SimplePropertyDef } from "./ontology/SimplePropertyDef.js";
40
+ export type { PropertyBooleanFormattingRule } from "./ontology/valueFormatting/PropertyBooleanFormattingRule.js";
41
+ export type { DatetimeFormat, DatetimeLocalizedFormat, DatetimeLocalizedFormatType, DatetimeStringFormat, DatetimeTimezone, DatetimeTimezoneStatic, DatetimeTimezoneUser, PropertyDateFormattingRule, PropertyTimestampFormattingRule } from "./ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js";
42
+ export type { KnownType, PropertyKnownTypeFormattingRule } from "./ontology/valueFormatting/PropertyKnownTypeFormattingRule.js";
43
+ export type { Affix, DurationBaseValue, DurationFormatStyle, DurationPrecision, HumanReadableFormat, NumberFormatAffix, NumberFormatCurrency, NumberFormatCurrencyStyle, NumberFormatCustomUnit, NumberFormatDuration, NumberFormatFixedValues, NumberFormatNotation, NumberFormatOptions, NumberFormatRatio, NumberFormatScale, NumberFormatStandard, NumberFormatStandardUnit, NumberRatioType, NumberRoundingMode, NumberScaleType, PropertyNumberFormattingRule, PropertyNumberFormattingRuleType, TimeCodeFormat } from "./ontology/valueFormatting/PropertyNumberFormattingRule.js";
44
+ export type { PropertyValueFormattingRule } from "./ontology/valueFormatting/PropertyValueFormattingRule.js";
45
+ export type { PropertyTypeReference, PropertyTypeReferenceOrStringConstant, StringConstant } from "./ontology/valueFormatting/PropertyValueFormattingUtils.js";
40
46
  export type { BaseWirePropertyTypes, WirePropertyTypes } from "./ontology/WirePropertyTypes.js";
41
47
  export type { ObjectIdentifiers, OsdkBase, PrimaryKeyType } from "./OsdkBase.js";
42
48
  export type { OsdkObject } from "./OsdkObject.js";
@@ -1 +1 @@
1
- {"mappings":"AAgBA,cAAc,kCAAkC;AAChD,cACE,oBACA,aACA,0BACA,oBACA,+BACK;AACP,SAAS,kBAAkB;AAC3B,cAAc,4BAA4B;AAC1C,cAAc,qBAAqB;AACnC,cAAc,sEAAsE;AACpF,cAAc,oCAAoC;AAClD,cAAc,uCAAuC;AACrD,cAAc,yBAAyB;AACvC,cAAc,2BAA2B;AACzC,cAAc,wBAAwB;AACtC,SAAS,2BAA2B;AACpC,cACE,gBACA,sBACA,kBACA,gBACA,eACA,4BACA,mBACK;AACP,cACE,8BACA,8BACK;AACP,cACE,uBACA,0BACK;AACP,cAAc,uBAAuB;AACrC,SAAS,uBAAuB;AAChC,cACE,kBACA,eACA,oBACK;AACP,cAAc,cAAc;AAC5B,cACE,uBACA,oBACA,uBACA,6BACK;AACP,cACE,iCACK;AACP,cAAc,YAAY,wBAAwB;AAClD,cACE,eACA,SACA,UACA,eACA,sBACA,eACA,WACA,uBACK;AACP,cACE,iBACA,wBACK;AACP,cACE,OACA,eACA,gBACA,mBACK;AACP,SAAS,YAAY;AACrB,cAAc,cAAc;AAC5B,cAAc,qBAAqB;AACnC,cAAc,iBAAiB;AAC/B,cAAc,6BAA6B;AAC3C,cACE,kBACA,sBACK;AACP,cACE,qBACA,yBACK;AACP,cACE,6BACA,oBACK;AACP,cAAc,uBAAuB;AACrC,cACE,qBACA,gBACA,sBACA,aACA,oBACK;AACP,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cACE,wBACA,qBACA,wBACA,yBACA,iBACA,eACA,0BACA,4CACA,gDACK;AACP,cAAc,yBAAyB;AACvC,cACE,uBACA,yBACK;AACP,cACE,mBACA,UACA,sBACK;AAEP,cAAc,kBAAkB;AAChC,cAAc,cAAc,YAAY,YAAY;AACpD,cAAc,kBAAkB;AAChC,cACE,OACA,6BACA,iCACK;AACP,cAAc,YAAY,mBAAmB;AAC7C,SAAS,iCAAiC;AAC1C,cACE,uBACA,iBACA,oBACA,uBACK;AACP,cAAc,YAAY,iBAAiB;AAC3C","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
1
+ {"mappings":"AAgBA,cAAc,kCAAkC;AAChD,cACE,oBACA,aACA,0BACA,oBACA,+BACK;AACP,SAAS,kBAAkB;AAC3B,cAAc,4BAA4B;AAC1C,cAAc,qBAAqB;AACnC,cAAc,sEAAsE;AACpF,cAAc,oCAAoC;AAClD,cAAc,uCAAuC;AACrD,cAAc,yBAAyB;AACvC,cAAc,2BAA2B;AACzC,cAAc,wBAAwB;AACtC,SAAS,2BAA2B;AACpC,cACE,gBACA,sBACA,kBACA,gBACA,eACA,4BACA,mBACK;AACP,cACE,8BACA,8BACK;AACP,cACE,uBACA,0BACK;AACP,cAAc,uBAAuB;AACrC,SAAS,uBAAuB;AAChC,cACE,kBACA,eACA,oBACK;AACP,cAAc,cAAc;AAC5B,cACE,uBACA,oBACA,uBACA,6BACK;AACP,cACE,iCACK;AACP,cAAc,YAAY,wBAAwB;AAClD,cACE,eACA,SACA,UACA,eACA,sBACA,eACA,WACA,uBACK;AACP,cACE,iBACA,wBACK;AACP,cACE,OACA,eACA,gBACA,mBACK;AACP,SAAS,YAAY;AACrB,cAAc,cAAc;AAC5B,cAAc,qBAAqB;AACnC,cAAc,iBAAiB;AAC/B,cAAc,6BAA6B;AAC3C,cACE,kBACA,sBACK;AACP,cACE,qBACA,yBACK;AACP,cACE,6BACA,oBACK;AACP,cAAc,uBAAuB;AACrC,cACE,qBACA,gBACA,sBACA,aACA,oBACK;AACP,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cACE,wBACA,qBACA,wBACA,yBACA,iBACA,eACA,0BACA,4CACA,gDACK;AACP,cAAc,yBAAyB;AACvC,cAAc,qCAAqC;AACnD,cACE,gBACA,yBACA,6BACA,sBACA,kBACA,wBACA,sBACA,4BACA,uCACK;AACP,cACE,WACA,uCACK;AACP,cACE,OACA,mBACA,qBACA,mBACA,qBACA,mBACA,sBACA,2BACA,wBACA,sBACA,yBACA,sBACA,qBACA,mBACA,mBACA,sBACA,0BACA,iBACA,oBACA,iBACA,8BACA,kCACA,sBACK;AACP,cAAc,mCAAmC;AACjD,cACE,uBACA,uCACA,sBACK;AACP,cACE,uBACA,yBACK;AACP,cACE,mBACA,UACA,sBACK;AAEP,cAAc,kBAAkB;AAChC,cAAc,cAAc,YAAY,YAAY;AACpD,cAAc,kBAAkB;AAChC,cACE,OACA,6BACA,iCACK;AACP,cAAc,YAAY,mBAAmB;AAC7C,SAAS,iCAAiC;AAC1C,cACE,uBACA,iBACA,oBACA,uBACK;AACP,cAAc,YAAY,iBAAiB;AAC3C","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
@@ -1,6 +1,7 @@
1
1
  import type { OsdkMetadata } from "../OsdkMetadata.js";
2
2
  import type { ObjectOrInterfaceDefinition, PropertyKeys } from "./ObjectOrInterface.js";
3
3
  import type { PrimaryKeyTypes } from "./PrimaryKeyTypes.js";
4
+ import type { PropertyValueFormattingRule } from "./valueFormatting/PropertyValueFormattingRule.js";
4
5
  import type { VersionString } from "./VersionString.js";
5
6
  import type { WirePropertyTypes } from "./WirePropertyTypes.js";
6
7
  export type CompileTimeMetadata<T extends {
@@ -56,6 +57,7 @@ export declare namespace ObjectMetadata {
56
57
  multiplicity?: boolean;
57
58
  nullable?: boolean;
58
59
  valueTypeApiName?: string;
60
+ valueFormatting?: PropertyValueFormattingRule;
59
61
  }
60
62
  interface Link<
61
63
  Q extends ObjectTypeDefinition,
@@ -1 +1 @@
1
- {"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cACE,6BACA,oBACK,wBAAyB;AAChC,cAAc,uBAAuB,sBAAuB;AAC5D,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,yBAAyB,wBAAyB;AAEhE,YAAY,oBAAoB,UAAU;CAAE,uBAAuB,CAAE;AAAE,KACrE,YACE,EAAE;AAGN,YAAY;CACV,UAAU;CACV,UAAU,aAAa;IACrB,oBAAoB,GAAG,cAAc;AAEzC,YAAY,8BAA8B;CACxC,MAAM,WAAW;CACjB;CACA;CACA;CACA,YAAY,YAAY,eAAe;CACvC;;;;;;CAMA,aAAa;AACd;AAED,iBAAiB,iCAAiC;CAChD,MAAM,WAAW;CACjB;CACA;CACA;CACA;AACD;AAED,iBAAiB,aAAa,UAAU,8BAA8B;CACpE,0BAA0B;AAC3B;AAED,iBAAiB,uBAAuB,4BAA4B;CAClE,MAAM;CACN,8BAA8B;CAC9B,0BAA0B;CAC1B,OAAO,eAEL,eAAe;CAEjB,gBAAgB;CAChB,MAAM;CACN,YAAY;CACZ;CACA,QAAQ;CACR,cAAc,eAEZ;CAKF,qBAAqB,eAEnB;AAKH;AAED,yBAAiB;WACE,SAAS;EACxB;EACA;EACA;EACA,MAAM;EACN;EACA;EACA;CACD;WAEgB;EACf,UAAU;EACV;GACA;EACA,uBAAuB;EACvB,YAAY,EAAE;EACd,cAAc;CACf;;AAGH,iBAAiB,qBAAqB;CACpC,MAAM;CACN;CACA,eAAe;CACf,uBACI,iBACA;AACL;AAED,YAAY,wBACV,UAAU,qCAEF,oBAAoB,GAAG;AAGjC,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,iBAAiB;CACxC,UAAU,UAAU,WAAW;UACvB,eAAe,SAAS;CAChC,MAAM;CACN,cAAc,UAAU,UAAU,OAAO;CACzC,UAAU,UAAU,aAAa,OAAO;AACzC;AAED,YAAY,gBACR,WACA,iBACA,eACA;KAEC,uBAAuB,WAAW,cAAc;KAEhD,gBAAgB;CACnB,MAAM;CACN;CACA;AACD;KAEI,OAAO","names":[],"sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"version":3,"file":"ObjectTypeDefinition.d.ts"}
1
+ {"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cACE,6BACA,oBACK,wBAAyB;AAChC,cAAc,uBAAuB,sBAAuB;AAC5D,cAAc,mCAAmC,kDAAmD;AACpG,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,yBAAyB,wBAAyB;AAEhE,YAAY,oBAAoB,UAAU;CAAE,uBAAuB,CAAE;AAAE,KACrE,YACE,EAAE;AAGN,YAAY;CACV,UAAU;CACV,UAAU,aAAa;IACrB,oBAAoB,GAAG,cAAc;AAEzC,YAAY,8BAA8B;CACxC,MAAM,WAAW;CACjB;CACA;CACA;CACA,YAAY,YAAY,eAAe;CACvC;;;;;;CAMA,aAAa;AACd;AAED,iBAAiB,iCAAiC;CAChD,MAAM,WAAW;CACjB;CACA;CACA;CACA;AACD;AAED,iBAAiB,aAAa,UAAU,8BAA8B;CACpE,0BAA0B;AAC3B;AAED,iBAAiB,uBAAuB,4BAA4B;CAClE,MAAM;CACN,8BAA8B;CAC9B,0BAA0B;CAC1B,OAAO,eAEL,eAAe;CAEjB,gBAAgB;CAChB,MAAM;CACN,YAAY;CACZ;CACA,QAAQ;CACR,cAAc,eAEZ;CAKF,qBAAqB,eAEnB;AAKH;AAED,yBAAiB;WACE,SAAS;EACxB;EACA;EACA;EACA,MAAM;EACN;EACA;EACA;EACA,kBAAkB;CACnB;WAEgB;EACf,UAAU;EACV;GACA;EACA,uBAAuB;EACvB,YAAY,EAAE;EACd,cAAc;CACf;;AAGH,iBAAiB,qBAAqB;CACpC,MAAM;CACN;CACA,eAAe;CACf,uBACI,iBACA;AACL;AAED,YAAY,wBACV,UAAU,qCAEF,oBAAoB,GAAG;AAGjC,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,iBAAiB;CACxC,UAAU,UAAU,WAAW;UACvB,eAAe,SAAS;CAChC,MAAM;CACN,cAAc,UAAU,UAAU,OAAO;CACzC,UAAU,UAAU,aAAa,OAAO;AACzC;AAED,YAAY,gBACR,WACA,iBACA,eACA;KAEC,uBAAuB,WAAW,cAAc;KAEhD,gBAAgB;CACnB,MAAM;CACN;CACA;AACD;KAEI,OAAO","names":[],"sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"version":3,"file":"ObjectTypeDefinition.d.ts"}
@@ -0,0 +1,5 @@
1
+ export interface PropertyBooleanFormattingRule {
2
+ type: "boolean";
3
+ valueIfTrue: string;
4
+ valueIfFalse: string;
5
+ }
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,iBAAiB,8BAA8B;CAC7C,MAAM;CACN;CACA;AACD","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyBooleanFormattingRule.ts"],"version":3,"file":"PropertyBooleanFormattingRule.d.ts"}
@@ -0,0 +1,37 @@
1
+ import type { PropertyTypeReferenceOrStringConstant } from "./PropertyValueFormattingUtils.js";
2
+ export interface PropertyDateFormattingRule {
3
+ type: "date";
4
+ format: DatetimeFormat;
5
+ }
6
+ export interface PropertyTimestampFormattingRule {
7
+ type: "timestamp";
8
+ format: DatetimeFormat;
9
+ displayTimezone: DatetimeTimezone;
10
+ }
11
+ export type DatetimeFormat = DatetimeStringFormat | DatetimeLocalizedFormat;
12
+ /**
13
+ * A custom date format pattern.
14
+ */
15
+ export interface DatetimeStringFormat {
16
+ type: "stringFormat";
17
+ pattern: string;
18
+ }
19
+ /**
20
+ * Predefined localized date/time formats.
21
+ */
22
+ export interface DatetimeLocalizedFormat {
23
+ type: "localizedFormat";
24
+ format: DatetimeLocalizedFormatType;
25
+ }
26
+ export type DatetimeLocalizedFormatType = "DATE_FORMAT_RELATIVE_TO_NOW" | "DATE_FORMAT_DATE" | "DATE_FORMAT_YEAR_AND_MONTH" | "DATE_FORMAT_DATE_TIME" | "DATE_FORMAT_DATE_TIME_SHORT" | "DATE_FORMAT_TIME" | "DATE_FORMAT_ISO_INSTANT";
27
+ export type DatetimeTimezone = DatetimeTimezoneStatic | DatetimeTimezoneUser;
28
+ export interface DatetimeTimezoneStatic {
29
+ type: "static";
30
+ zoneId: PropertyTypeReferenceOrStringConstant;
31
+ }
32
+ /**
33
+ * Use the user's local timezone.
34
+ */
35
+ export interface DatetimeTimezoneUser {
36
+ type: "user";
37
+ }
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAc,6CAA6C,mCAAoC;AAE/F,iBAAiB,2BAA2B;CAC1C,MAAM;CACN,QAAQ;AACT;AAED,iBAAiB,gCAAgC;CAC/C,MAAM;CACN,QAAQ;CACR,iBAAiB;AAClB;AAED,YAAY,iBAAiB,uBAAuB;;;;AAKpD,iBAAiB,qBAAqB;CACpC,MAAM;CACN;AACD;;;;AAKD,iBAAiB,wBAAwB;CACvC,MAAM;CACN,QAAQ;AACT;AAED,YAAY,8BACR,gCACA,qBACA,+BACA,0BACA,gCACA,qBACA;AAEJ,YAAY,mBAAmB,yBAAyB;AAExD,iBAAiB,uBAAuB;CACtC,MAAM;CACN,QAAQ;AACT;;;;AAKD,iBAAiB,qBAAqB;CACpC,MAAM;AACP","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.ts"],"version":3,"file":"PropertyDateAndTimestampFormattingRule.d.ts"}
@@ -0,0 +1,8 @@
1
+ export interface PropertyKnownTypeFormattingRule {
2
+ type: "knownType";
3
+ knownType: KnownType;
4
+ }
5
+ /**
6
+ * Known Foundry types with specialized formatting.
7
+ */
8
+ export type KnownType = "USER_OR_GROUP_ID" | "RESOURCE_RID" | "ARTIFACT_GID";
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,iBAAiB,gCAAgC;CAC/C,MAAM;CACN,WAAW;AACZ;;;;AAKD,YAAY,YAAY,qBAAqB,iBAAiB","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyKnownTypeFormattingRule.ts"],"version":3,"file":"PropertyKnownTypeFormattingRule.d.ts"}
@@ -0,0 +1,117 @@
1
+ import type { PropertyTypeReferenceOrStringConstant } from "./PropertyValueFormattingUtils.js";
2
+ export interface PropertyNumberFormattingRule {
3
+ type: "number";
4
+ numberType: PropertyNumberFormattingRuleType;
5
+ }
6
+ export type PropertyNumberFormattingRuleType = NumberFormatStandard | NumberFormatFixedValues | NumberFormatCurrency | NumberFormatStandardUnit | NumberFormatCustomUnit | NumberFormatAffix | NumberFormatDuration | NumberFormatScale | NumberFormatRatio;
7
+ /**
8
+ * Base number formatting options.
9
+ */
10
+ export interface NumberFormatOptions {
11
+ useGrouping?: boolean;
12
+ convertNegativeToParenthesis?: boolean;
13
+ minimumIntegerDigits?: number;
14
+ minimumFractionDigits?: number;
15
+ maximumFractionDigits?: number;
16
+ minimumSignificantDigits?: number;
17
+ maximumSignificantDigits?: number;
18
+ notation?: NumberFormatNotation;
19
+ roundingMode?: NumberRoundingMode;
20
+ }
21
+ /**
22
+ * Number notation style.
23
+ */
24
+ export type NumberFormatNotation = "STANDARD" | "SCIENTIFIC" | "ENGINEERING" | "COMPACT";
25
+ /**
26
+ * Number rounding behavior.
27
+ */
28
+ export type NumberRoundingMode = "CEIL" | "FLOOR" | "ROUND_CLOSEST";
29
+ /**
30
+ * Standard number formatting with configurable options.
31
+ */
32
+ export interface NumberFormatStandard {
33
+ type: "standard";
34
+ baseFormatOptions: NumberFormatOptions;
35
+ }
36
+ /**
37
+ * Map integer values to custom strings.
38
+ */
39
+ export interface NumberFormatFixedValues {
40
+ type: "fixedValues";
41
+ values: Record<number, string>;
42
+ }
43
+ /**
44
+ * Format numbers as currency values.
45
+ */
46
+ export interface NumberFormatCurrency {
47
+ type: "currency";
48
+ baseFormatOptions: NumberFormatOptions;
49
+ style: NumberFormatCurrencyStyle;
50
+ currencyCode: PropertyTypeReferenceOrStringConstant;
51
+ }
52
+ export type NumberFormatCurrencyStyle = "STANDARD" | "COMPACT";
53
+ /**
54
+ * Format numbers with standard units supported by Intl.NumberFormat.
55
+ */
56
+ export interface NumberFormatStandardUnit {
57
+ type: "standardUnit";
58
+ baseFormatOptions: NumberFormatOptions;
59
+ unit: PropertyTypeReferenceOrStringConstant;
60
+ }
61
+ /**
62
+ * Format numbers with custom units.
63
+ */
64
+ export interface NumberFormatCustomUnit {
65
+ type: "customUnit";
66
+ baseFormatOptions: NumberFormatOptions;
67
+ unit: PropertyTypeReferenceOrStringConstant;
68
+ }
69
+ /**
70
+ * Attach text before and/or after the formatted number.
71
+ */
72
+ export interface NumberFormatAffix {
73
+ type: "affix";
74
+ baseFormatOptions: NumberFormatOptions;
75
+ affix: Affix;
76
+ }
77
+ export interface Affix {
78
+ prefix?: PropertyTypeReferenceOrStringConstant;
79
+ postfix?: PropertyTypeReferenceOrStringConstant;
80
+ }
81
+ /**
82
+ * Format numeric values representing time durations.
83
+ */
84
+ export interface NumberFormatDuration {
85
+ type: "duration";
86
+ formatStyle: DurationFormatStyle;
87
+ precision?: DurationPrecision;
88
+ baseValue: DurationBaseValue;
89
+ }
90
+ export type DurationFormatStyle = HumanReadableFormat | TimeCodeFormat;
91
+ export interface HumanReadableFormat {
92
+ type: "humanReadable";
93
+ showFullUnits?: boolean;
94
+ }
95
+ export interface TimeCodeFormat {
96
+ type: "timecode";
97
+ }
98
+ export type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
99
+ export type DurationBaseValue = "SECONDS" | "MILLISECONDS";
100
+ /**
101
+ * Scale numeric values by the specified factor.
102
+ */
103
+ export interface NumberFormatScale {
104
+ type: "scale";
105
+ scaleType: NumberScaleType;
106
+ baseFormatOptions: NumberFormatOptions;
107
+ }
108
+ export type NumberScaleType = "THOUSANDS" | "MILLIONS" | "BILLIONS";
109
+ /**
110
+ * Display values as ratios with different scaling factors.
111
+ */
112
+ export interface NumberFormatRatio {
113
+ type: "ratio";
114
+ ratioType: NumberRatioType;
115
+ baseFormatOptions: NumberFormatOptions;
116
+ }
117
+ export type NumberRatioType = "PERCENTAGE" | "PER_MILLE" | "BASIS_POINTS";
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAc,6CAA6C,mCAAoC;AAE/F,iBAAiB,6BAA6B;CAC5C,MAAM;CACN,YAAY;AACb;AAED,YAAY,mCACR,uBACA,0BACA,uBACA,2BACA,yBACA,oBACA,uBACA,oBACA;;;;AAKJ,iBAAiB,oBAAoB;CACnC;CACA;CACA;CACA;CACA;CACA;CACA;CACA,WAAW;CACX,eAAe;AAChB;;;;AAKD,YAAY,uBACR,aACA,eACA,gBACA;;;;AAKJ,YAAY,qBAAqB,SAAS,UAAU;;;;AAKpD,iBAAiB,qBAAqB;CACpC,MAAM;CACN,mBAAmB;AACpB;;;;AAKD,iBAAiB,wBAAwB;CACvC,MAAM;CACN,QAAQ;AACT;;;;AAKD,iBAAiB,qBAAqB;CACpC,MAAM;CACN,mBAAmB;CACnB,OAAO;CACP,cAAc;AACf;AAED,YAAY,4BAA4B,aAAa;;;;AAKrD,iBAAiB,yBAAyB;CACxC,MAAM;CACN,mBAAmB;CACnB,MAAM;AACP;;;;AAKD,iBAAiB,uBAAuB;CACtC,MAAM;CACN,mBAAmB;CACnB,MAAM;AACP;;;;AAKD,iBAAiB,kBAAkB;CACjC,MAAM;CACN,mBAAmB;CACnB,OAAO;AACR;AAED,iBAAiB,MAAM;CACrB,SAAS;CACT,UAAU;AACX;;;;AAKD,iBAAiB,qBAAqB;CACpC,MAAM;CACN,aAAa;CACb,YAAY;CACZ,WAAW;AACZ;AAED,YAAY,sBAAsB,sBAAsB;AAExD,iBAAiB,oBAAoB;CACnC,MAAM;CACN;AACD;AAED,iBAAiB,eAAe;CAC9B,MAAM;AACP;AAED,YAAY,oBACR,SACA,UACA,YACA,YACA;AACJ,YAAY,oBAAoB,YAAY;;;;AAK5C,iBAAiB,kBAAkB;CACjC,MAAM;CACN,WAAW;CACX,mBAAmB;AACpB;AAED,YAAY,kBAAkB,cAAc,aAAa;;;;AAKzD,iBAAiB,kBAAkB;CACjC,MAAM;CACN,WAAW;CACX,mBAAmB;AACpB;AAED,YAAY,kBAAkB,eAAe,cAAc","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyNumberFormattingRule.ts"],"version":3,"file":"PropertyNumberFormattingRule.d.ts"}
@@ -0,0 +1,8 @@
1
+ import type { PropertyBooleanFormattingRule } from "./PropertyBooleanFormattingRule.js";
2
+ import type { PropertyDateFormattingRule, PropertyTimestampFormattingRule } from "./PropertyDateAndTimestampFormattingRule.js";
3
+ import type { PropertyKnownTypeFormattingRule } from "./PropertyKnownTypeFormattingRule.js";
4
+ import type { PropertyNumberFormattingRule } from "./PropertyNumberFormattingRule.js";
5
+ /**
6
+ * Formatting configuration for property values.
7
+ */
8
+ export type PropertyValueFormattingRule = PropertyNumberFormattingRule | PropertyTimestampFormattingRule | PropertyDateFormattingRule | PropertyBooleanFormattingRule | PropertyKnownTypeFormattingRule;
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAc,qCAAqC,oCAAqC;AACxF,cACE,4BACA,uCACK,6CAA8C;AACrD,cAAc,uCAAuC,sCAAuC;AAC5F,cAAc,oCAAoC,mCAAoC;;;;AAKtF,YAAY,8BACR,+BACA,kCACA,6BACA,gCACA","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyValueFormattingRule.ts"],"version":3,"file":"PropertyValueFormattingRule.d.ts"}
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Reference to another property value or a string constant.
3
+ */
4
+ export type PropertyTypeReferenceOrStringConstant = StringConstant | PropertyTypeReference;
5
+ export interface StringConstant {
6
+ type: "constant";
7
+ value: string;
8
+ }
9
+ export interface PropertyTypeReference {
10
+ type: "propertyType";
11
+ propertyApiName: string;
12
+ }
@@ -0,0 +1 @@
1
+ {"mappings":";;;AAmBA,YAAY,wCACR,iBACA;AAEJ,iBAAiB,eAAe;CAC9B,MAAM;CACN;AACD;AAED,iBAAiB,sBAAsB;CACrC,MAAM;CACN;AACD","names":[],"sources":["../../../../src/ontology/valueFormatting/PropertyValueFormattingUtils.ts"],"version":3,"file":"PropertyValueFormattingUtils.d.ts"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "2.6.0-rc.14",
3
+ "version": "2.7.0-beta.1",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -48,8 +48,8 @@
48
48
  "@microsoft/api-extractor": "^7.52.11",
49
49
  "ts-expect": "^1.3.0",
50
50
  "typescript": "~5.5.4",
51
- "@osdk/monorepo.api-extractor": "~0.5.0-beta.1",
52
- "@osdk/monorepo.tsconfig": "~0.5.0-beta.1"
51
+ "@osdk/monorepo.api-extractor": "~0.6.0-beta.1",
52
+ "@osdk/monorepo.tsconfig": "~0.6.0-beta.1"
53
53
  },
54
54
  "publishConfig": {
55
55
  "access": "public"