@osdk/api 2.5.2 → 2.6.0-beta.10

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 (100) hide show
  1. package/CHANGELOG.md +37 -19
  2. package/build/browser/Definitions.js.map +1 -1
  3. package/build/browser/OsdkObjectFrom.js.map +1 -1
  4. package/build/browser/actions/Actions.js.map +1 -1
  5. package/build/browser/aggregate/BaseFilter.js +1 -0
  6. package/build/browser/aggregate/BaseFilter.js.map +1 -1
  7. package/build/browser/aggregate/WhereClause.js.map +1 -1
  8. package/build/browser/derivedProperties/DerivedProperty.js.map +1 -1
  9. package/build/browser/index.js +1 -0
  10. package/build/browser/index.js.map +1 -1
  11. package/build/browser/mapping/DataValueMapping.js.map +1 -1
  12. package/build/browser/mapping/PropertyValueMapping.js.map +1 -1
  13. package/build/browser/object/Media.js.map +1 -1
  14. package/build/browser/objectSet/ObjectSet.js.map +1 -1
  15. package/build/browser/objectSet/ObjectSet.test.js +57 -0
  16. package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
  17. package/build/browser/ontology/ObjectTypeDefinition.js.map +1 -1
  18. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  19. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  20. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  21. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  22. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  23. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  24. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  25. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  26. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  27. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  28. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  29. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  30. package/build/cjs/{ObjectSet-CRGBmCu9.d.cts → ObjectSet-D7jdSkmi.d.cts} +260 -21
  31. package/build/cjs/index.cjs +4 -0
  32. package/build/cjs/index.cjs.map +1 -1
  33. package/build/cjs/index.d.cts +13 -4
  34. package/build/cjs/public/unstable.d.cts +2 -2
  35. package/build/esm/Definitions.js.map +1 -1
  36. package/build/esm/OsdkObjectFrom.js.map +1 -1
  37. package/build/esm/actions/Actions.js.map +1 -1
  38. package/build/esm/aggregate/BaseFilter.js +1 -0
  39. package/build/esm/aggregate/BaseFilter.js.map +1 -1
  40. package/build/esm/aggregate/WhereClause.js.map +1 -1
  41. package/build/esm/derivedProperties/DerivedProperty.js.map +1 -1
  42. package/build/esm/index.js +1 -0
  43. package/build/esm/index.js.map +1 -1
  44. package/build/esm/mapping/DataValueMapping.js.map +1 -1
  45. package/build/esm/mapping/PropertyValueMapping.js.map +1 -1
  46. package/build/esm/object/Media.js.map +1 -1
  47. package/build/esm/objectSet/ObjectSet.js.map +1 -1
  48. package/build/esm/objectSet/ObjectSet.test.js +57 -0
  49. package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
  50. package/build/esm/ontology/ObjectTypeDefinition.js.map +1 -1
  51. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  52. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  53. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  54. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  55. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  56. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  57. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  58. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  59. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  60. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  61. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  62. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  63. package/build/types/Definitions.d.ts +3 -6
  64. package/build/types/Definitions.d.ts.map +1 -1
  65. package/build/types/OsdkObjectFrom.d.ts +4 -0
  66. package/build/types/OsdkObjectFrom.d.ts.map +1 -1
  67. package/build/types/actions/Actions.d.ts +2 -0
  68. package/build/types/actions/Actions.d.ts.map +1 -1
  69. package/build/types/aggregate/BaseFilter.d.ts +10 -4
  70. package/build/types/aggregate/BaseFilter.d.ts.map +1 -1
  71. package/build/types/aggregate/WhereClause.d.ts +34 -12
  72. package/build/types/aggregate/WhereClause.d.ts.map +1 -1
  73. package/build/types/derivedProperties/DerivedProperty.d.ts +10 -1
  74. package/build/types/derivedProperties/DerivedProperty.d.ts.map +1 -1
  75. package/build/types/index.d.ts +13 -5
  76. package/build/types/index.d.ts.map +1 -1
  77. package/build/types/mapping/DataValueMapping.d.ts +2 -2
  78. package/build/types/mapping/DataValueMapping.d.ts.map +1 -1
  79. package/build/types/mapping/PropertyValueMapping.d.ts +2 -2
  80. package/build/types/mapping/PropertyValueMapping.d.ts.map +1 -1
  81. package/build/types/object/Media.d.ts +7 -0
  82. package/build/types/object/Media.d.ts.map +1 -1
  83. package/build/types/objectSet/ObjectSet.d.ts +24 -1
  84. package/build/types/objectSet/ObjectSet.d.ts.map +1 -1
  85. package/build/types/objectSet/ObjectSet.test.d.ts.map +1 -1
  86. package/build/types/ontology/ObjectTypeDefinition.d.ts +2 -0
  87. package/build/types/ontology/ObjectTypeDefinition.d.ts.map +1 -1
  88. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts +5 -0
  89. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts.map +1 -0
  90. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts +37 -0
  91. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts.map +1 -0
  92. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts +8 -0
  93. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts.map +1 -0
  94. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts +117 -0
  95. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts.map +1 -0
  96. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts +8 -0
  97. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts.map +1 -0
  98. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts +12 -0
  99. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts.map +1 -0
  100. package/package.json +3 -3
@@ -52,6 +52,13 @@ interface MediaReference {
52
52
  };
53
53
  };
54
54
  }
55
+ /**
56
+ * Object for uploading Media
57
+ */
58
+ interface MediaUpload {
59
+ readonly fileName: string;
60
+ readonly data: Blob;
61
+ }
55
62
  /**
56
63
  * Metadata of a media item
57
64
  */
@@ -266,7 +273,7 @@ interface PropertyValueWireToCreate {
266
273
  integer: number;
267
274
  long: string;
268
275
  marking: string;
269
- mediaReference: Media;
276
+ mediaReference: Media | MediaReference;
270
277
  short: number;
271
278
  string: string;
272
279
  timestamp: string;
@@ -290,6 +297,193 @@ interface OsdkMetadata {
290
297
 
291
298
  type PrimaryKeyTypes = "string" | "datetime" | "double" | "integer" | "timestamp" | "short" | "long" | "byte";
292
299
 
300
+ interface PropertyBooleanFormattingRule {
301
+ type: "boolean";
302
+ valueIfTrue: string;
303
+ valueIfFalse: string;
304
+ }
305
+
306
+ /**
307
+ * Reference to another property value or a string constant.
308
+ */
309
+ type PropertyTypeReferenceOrStringConstant = StringConstant | PropertyTypeReference;
310
+ interface StringConstant {
311
+ type: "constant";
312
+ value: string;
313
+ }
314
+ interface PropertyTypeReference {
315
+ type: "propertyType";
316
+ propertyApiName: string;
317
+ }
318
+
319
+ interface PropertyDateFormattingRule {
320
+ type: "date";
321
+ format: DatetimeFormat;
322
+ }
323
+ interface PropertyTimestampFormattingRule {
324
+ type: "timestamp";
325
+ format: DatetimeFormat;
326
+ displayTimezone: DatetimeTimezone;
327
+ }
328
+ type DatetimeFormat = DatetimeStringFormat | DatetimeLocalizedFormat;
329
+ /**
330
+ * A custom date format pattern.
331
+ */
332
+ interface DatetimeStringFormat {
333
+ type: "stringFormat";
334
+ pattern: string;
335
+ }
336
+ /**
337
+ * Predefined localized date/time formats.
338
+ */
339
+ interface DatetimeLocalizedFormat {
340
+ type: "localizedFormat";
341
+ format: DatetimeLocalizedFormatType;
342
+ }
343
+ 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";
344
+ type DatetimeTimezone = DatetimeTimezoneStatic | DatetimeTimezoneUser;
345
+ interface DatetimeTimezoneStatic {
346
+ type: "static";
347
+ zoneId: PropertyTypeReferenceOrStringConstant;
348
+ }
349
+ /**
350
+ * Use the user's local timezone.
351
+ */
352
+ interface DatetimeTimezoneUser {
353
+ type: "user";
354
+ }
355
+
356
+ interface PropertyKnownTypeFormattingRule {
357
+ type: "knownType";
358
+ knownType: KnownType;
359
+ }
360
+ /**
361
+ * Known Foundry types with specialized formatting.
362
+ */
363
+ type KnownType = "USER_OR_GROUP_ID" | "RESOURCE_RID" | "ARTIFACT_GID";
364
+
365
+ interface PropertyNumberFormattingRule {
366
+ type: "number";
367
+ numberType: PropertyNumberFormattingRuleType;
368
+ }
369
+ type PropertyNumberFormattingRuleType = NumberFormatStandard | NumberFormatFixedValues | NumberFormatCurrency | NumberFormatStandardUnit | NumberFormatCustomUnit | NumberFormatAffix | NumberFormatDuration | NumberFormatScale | NumberFormatRatio;
370
+ /**
371
+ * Base number formatting options.
372
+ */
373
+ interface NumberFormatOptions {
374
+ useGrouping?: boolean;
375
+ convertNegativeToParenthesis?: boolean;
376
+ minimumIntegerDigits?: number;
377
+ minimumFractionDigits?: number;
378
+ maximumFractionDigits?: number;
379
+ minimumSignificantDigits?: number;
380
+ maximumSignificantDigits?: number;
381
+ notation?: NumberFormatNotation;
382
+ roundingMode?: NumberRoundingMode;
383
+ }
384
+ /**
385
+ * Number notation style.
386
+ */
387
+ type NumberFormatNotation = "STANDARD" | "SCIENTIFIC" | "ENGINEERING" | "COMPACT";
388
+ /**
389
+ * Number rounding behavior.
390
+ */
391
+ type NumberRoundingMode = "CEIL" | "FLOOR" | "ROUND_CLOSEST";
392
+ /**
393
+ * Standard number formatting with configurable options.
394
+ */
395
+ interface NumberFormatStandard {
396
+ type: "standard";
397
+ baseFormatOptions: NumberFormatOptions;
398
+ }
399
+ /**
400
+ * Map integer values to custom strings.
401
+ */
402
+ interface NumberFormatFixedValues {
403
+ type: "fixedValues";
404
+ values: Record<number, string>;
405
+ }
406
+ /**
407
+ * Format numbers as currency values.
408
+ */
409
+ interface NumberFormatCurrency {
410
+ type: "currency";
411
+ baseFormatOptions: NumberFormatOptions;
412
+ style: NumberFormatCurrencyStyle;
413
+ currencyCode: PropertyTypeReferenceOrStringConstant;
414
+ }
415
+ type NumberFormatCurrencyStyle = "STANDARD" | "COMPACT";
416
+ /**
417
+ * Format numbers with standard units supported by Intl.NumberFormat.
418
+ */
419
+ interface NumberFormatStandardUnit {
420
+ type: "standardUnit";
421
+ baseFormatOptions: NumberFormatOptions;
422
+ unit: PropertyTypeReferenceOrStringConstant;
423
+ }
424
+ /**
425
+ * Format numbers with custom units.
426
+ */
427
+ interface NumberFormatCustomUnit {
428
+ type: "customUnit";
429
+ baseFormatOptions: NumberFormatOptions;
430
+ unit: PropertyTypeReferenceOrStringConstant;
431
+ }
432
+ /**
433
+ * Attach text before and/or after the formatted number.
434
+ */
435
+ interface NumberFormatAffix {
436
+ type: "affix";
437
+ baseFormatOptions: NumberFormatOptions;
438
+ affix: Affix;
439
+ }
440
+ interface Affix {
441
+ prefix?: PropertyTypeReferenceOrStringConstant;
442
+ postfix?: PropertyTypeReferenceOrStringConstant;
443
+ }
444
+ /**
445
+ * Format numeric values representing time durations.
446
+ */
447
+ interface NumberFormatDuration {
448
+ type: "duration";
449
+ formatStyle: DurationFormatStyle;
450
+ precision?: DurationPrecision;
451
+ baseValue: DurationBaseValue;
452
+ }
453
+ type DurationFormatStyle = HumanReadableFormat | TimeCodeFormat;
454
+ interface HumanReadableFormat {
455
+ type: "humanReadable";
456
+ showFullUnits?: boolean;
457
+ }
458
+ interface TimeCodeFormat {
459
+ type: "timecode";
460
+ }
461
+ type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
462
+ type DurationBaseValue = "SECONDS" | "MILLISECONDS";
463
+ /**
464
+ * Scale numeric values by the specified factor.
465
+ */
466
+ interface NumberFormatScale {
467
+ type: "scale";
468
+ scaleType: NumberScaleType;
469
+ baseFormatOptions: NumberFormatOptions;
470
+ }
471
+ type NumberScaleType = "THOUSANDS" | "MILLIONS" | "BILLIONS";
472
+ /**
473
+ * Display values as ratios with different scaling factors.
474
+ */
475
+ interface NumberFormatRatio {
476
+ type: "ratio";
477
+ ratioType: NumberRatioType;
478
+ baseFormatOptions: NumberFormatOptions;
479
+ }
480
+ type NumberRatioType = "PERCENTAGE" | "PER_MILLE" | "BASIS_POINTS";
481
+
482
+ /**
483
+ * Formatting configuration for property values.
484
+ */
485
+ type PropertyValueFormattingRule = PropertyNumberFormattingRule | PropertyTimestampFormattingRule | PropertyDateFormattingRule | PropertyBooleanFormattingRule | PropertyKnownTypeFormattingRule;
486
+
293
487
  type VersionString<Major extends number, Minor extends number, Patch extends number> = `${Major}.${Minor}.${Patch}`;
294
488
 
295
489
  type WirePropertyTypes = BaseWirePropertyTypes | Record<string, BaseWirePropertyTypes>;
@@ -344,6 +538,7 @@ declare namespace ObjectMetadata {
344
538
  multiplicity?: boolean;
345
539
  nullable?: boolean;
346
540
  valueTypeApiName?: string;
541
+ valueFormatting?: PropertyValueFormattingRule;
347
542
  }
348
543
  interface Link<Q extends ObjectTypeDefinition, M extends boolean> {
349
544
  __OsdkLinkTargetType?: Q;
@@ -572,21 +767,20 @@ type MaybeArray<T extends {
572
767
  multiplicity?: boolean | undefined;
573
768
  }, U> = T["multiplicity"] extends true ? Array<U> : U;
574
769
  type MaybeNullable$1<T extends ObjectMetadata.Property, U> = T["nullable"] extends true ? U | undefined : U;
575
- type Converted<T> = T extends Array<any> ? T[1] : T;
576
770
  /**
577
771
  * @param {T} ObjectMetadata.Property in literal form
578
772
  * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`
579
773
  */
580
- type OsdkObjectPropertyType<T extends ObjectMetadata.Property, STRICTLY_ENFORCE_NULLABLE extends boolean = true> = STRICTLY_ENFORCE_NULLABLE extends false ? MaybeArray<T, Converted<GetClientPropertyValueFromWire<T["type"]>>> | undefined : MaybeNullable$1<T, MaybeArray<T, Converted<GetClientPropertyValueFromWire<T["type"]>>>>;
774
+ type OsdkObjectPropertyType<T extends ObjectMetadata.Property, STRICTLY_ENFORCE_NULLABLE extends boolean = true> = STRICTLY_ENFORCE_NULLABLE extends false ? MaybeArray<T, GetClientPropertyValueFromWire<T["type"]>> | undefined : MaybeNullable$1<T, MaybeArray<T, GetClientPropertyValueFromWire<T["type"]>>>;
581
775
  /**
582
776
  * @param {T} ObjectMetadata.Property in literal form
583
777
  */
584
- type OsdkObjectPropertyTypeNotUndefined<T extends ObjectMetadata.Property> = MaybeArray<T, Converted<GetClientPropertyValueFromWire<T["type"]>>>;
778
+ type OsdkObjectPropertyTypeNotUndefined<T extends ObjectMetadata.Property> = MaybeArray<T, GetClientPropertyValueFromWire<T["type"]>>;
585
779
  /**
586
780
  * @param {T} ObjectMetadata.Property in literal form
587
781
  * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`
588
782
  */
589
- type OsdkObjectCreatePropertyType<T extends ObjectMetadata.Property, STRICTLY_ENFORCE_NULLABLE extends boolean = true> = STRICTLY_ENFORCE_NULLABLE extends false ? MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T["type"]>>> | undefined : MaybeNullable$1<T, MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T["type"]>>>>;
783
+ type OsdkObjectCreatePropertyType<T extends ObjectMetadata.Property, STRICTLY_ENFORCE_NULLABLE extends boolean = true> = STRICTLY_ENFORCE_NULLABLE extends false ? MaybeArray<T, GetCreatePropertyValueFromWire<T["type"]>> | undefined : MaybeNullable$1<T, MaybeArray<T, GetCreatePropertyValueFromWire<T["type"]>>>;
590
784
 
591
785
  type ExtractPropName<T extends string> = T extends `${infer PropName}:${string}` ? PropName : T extends "$count" ? T : never;
592
786
  type ExtractMetricNameForPropName<T, PropName extends string> = T extends `${PropName}:${infer MetricName}` ? MetricName : never;
@@ -773,6 +967,10 @@ declare namespace Osdk {
773
967
  ObjectMetadata: ObjectMetadata;
774
968
  InterfaceMetadata: InterfaceMetadata;
775
969
  };
970
+ readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__getFormattedValue: <PropertyApiName extends PropertyKeys<Q>>(propertyApiName: PropertyApiName, options?: {
971
+ locale?: string;
972
+ timezoneId?: string;
973
+ }) => string | undefined;
776
974
  } & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
777
975
  readonly $rid: string;
778
976
  } : {});
@@ -804,12 +1002,14 @@ declare namespace ArrayFilter {
804
1002
  }
805
1003
  type ArrayFilter<T> = ArrayFilter.$contains<T> | ArrayFilter.$isNull<T>;
806
1004
 
807
- type BaseFilterOptions<T> = {
1005
+ type EqFilterOption<T> = {
808
1006
  "$eq": T;
1007
+ };
1008
+ interface BaseFilterOptions<T> extends EqFilterOption<T> {
809
1009
  "$ne": T;
810
1010
  "$isNull": boolean;
811
1011
  "$in": ReadonlyArray<T>;
812
- };
1012
+ }
813
1013
  declare namespace BaseFilter {
814
1014
  interface $eq<T> extends Just<"$eq", BaseFilterOptions<T>> {
815
1015
  }
@@ -1007,7 +1207,12 @@ type GeoFilter_Intersects = {
1007
1207
  $bbox?: never;
1008
1208
  } | Polygon;
1009
1209
  };
1010
- type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? (PD["type"] extends "string" | "geopoint" | "geoshape" | "datetime" | "timestamp" ? ArrayFilter<string> : (PD["type"] extends boolean ? ArrayFilter<boolean> : ArrayFilter<number>)) : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : (PD["type"] extends "string" ? StringFilter : PD["type"] extends "geopoint" | "geoshape" ? GeoFilter : PD["type"] extends "datetime" | "timestamp" ? DatetimeFilter : PD["type"] extends "boolean" ? BooleanFilter : PD["type"] extends "double" | "integer" | "long" | "float" | "decimal" | "byte" ? NumberFilter : BaseFilter<string>);
1210
+ type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? (PD["type"] extends Record<string, BaseWirePropertyTypes> ? ArrayFilter<StructArrayFilterOpts<PD["type"]>> : PD["type"] extends PropertyTypesRepresentedAsStringsForArrayWhereClause ? ArrayFilter<string> : (PD["type"] extends boolean ? ArrayFilter<boolean> : ArrayFilter<number>)) : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : (PD["type"] extends "string" ? StringFilter : PD["type"] extends "geopoint" | "geoshape" ? GeoFilter : PD["type"] extends "datetime" | "timestamp" ? DatetimeFilter : PD["type"] extends "boolean" ? BooleanFilter : PD["type"] extends WhereClauseNumberPropertyTypes ? NumberFilter : BaseFilter<string>);
1211
+ type StructArrayFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
1212
+ [K in keyof ST]?: FilterFor<{
1213
+ "type": ST[K];
1214
+ }>;
1215
+ };
1011
1216
  type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
1012
1217
  [K in keyof ST]?: FilterFor<{
1013
1218
  "type": ST[K];
@@ -1016,19 +1221,22 @@ type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
1016
1221
  type StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {
1017
1222
  [K in keyof ST]: Just<K, StructFilterOpts<ST>>;
1018
1223
  }[keyof ST];
1019
- interface AndWhereClause<T extends ObjectOrInterfaceDefinition> {
1020
- $and: WhereClause<T>[];
1021
- }
1022
- interface OrWhereClause<T extends ObjectOrInterfaceDefinition> {
1023
- $or: WhereClause<T>[];
1024
- }
1025
- interface NotWhereClause<T extends ObjectOrInterfaceDefinition> {
1026
- $not: WhereClause<T>;
1027
- }
1224
+ type PropertyTypesRepresentedAsStringsForArrayWhereClause = "string" | "geopoint" | "geoshape" | "datetime" | "timestamp";
1225
+ type WhereClauseNumberPropertyTypes = "double" | "integer" | "long" | "float" | "decimal" | "byte";
1226
+ type AndWhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = {
1227
+ $and: WhereClause<T, RDPs>[];
1228
+ };
1229
+ type OrWhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = {
1230
+ $or: WhereClause<T, RDPs>[];
1231
+ };
1232
+ type NotWhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = {
1233
+ $not: WhereClause<T, RDPs>;
1234
+ };
1028
1235
  type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {
1029
1236
  [P in keyof CompileTimeMetadata<T>["properties"]]?: FilterFor<CompileTimeMetadata<T>["properties"][P]>;
1030
1237
  };
1031
- type WhereClause<T extends ObjectOrInterfaceDefinition> = OrWhereClause<T> | AndWhereClause<T> | NotWhereClause<T> | (IsNever<keyof CompileTimeMetadata<T>["properties"]> extends true ? Record<string, never> : PropertyWhereClause<T>);
1238
+ type MergedPropertyWhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = PropertyWhereClause<DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>>;
1239
+ type WhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = OrWhereClause<T, RDPs> | AndWhereClause<T, RDPs> | NotWhereClause<T, RDPs> | (IsNever<keyof CompileTimeMetadata<T>["properties"]> extends true ? Record<string, never> : MergedPropertyWhereClause<T, RDPs>);
1032
1240
 
1033
1241
  type LinkNames<Q extends ObjectOrInterfaceDefinition> = Q extends InterfaceDefinition ? keyof CompileTimeMetadata<Q>["links"] : keyof CompileTimeMetadata<Q>["links"] & string;
1034
1242
  type LinkedType<Q extends ObjectOrInterfaceDefinition, L extends LinkNames<Q>> = NonNullable<CompileTimeMetadata<Q>["links"][L]["__OsdkLinkTargetType"]>;
@@ -1073,7 +1281,7 @@ declare namespace DerivedProperty {
1073
1281
  };
1074
1282
  interface BaseBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {
1075
1283
  }
1076
- export interface Builder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Selectable<Q> {
1284
+ export interface Builder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Selectable<Q>, Constant<Q> {
1077
1285
  }
1078
1286
  export interface AggregateBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Aggregatable<Q> {
1079
1287
  }
@@ -1089,6 +1297,15 @@ type Filterable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boole
1089
1297
  type Pivotable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> = {
1090
1298
  readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>;
1091
1299
  };
1300
+ type Constant<Q extends ObjectOrInterfaceDefinition> = {
1301
+ readonly constant: {
1302
+ readonly double: (value: number) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"double", "non-nullable", "single">, Q>;
1303
+ readonly integer: (value: number) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"integer", "non-nullable", "single">, Q>;
1304
+ readonly long: (value: string) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"long", "non-nullable", "single">, Q>;
1305
+ readonly datetime: (value: string) => DerivedProperty.DatetimePropertyDefinition<SimplePropertyDef.Make<"datetime", "non-nullable", "single">, Q>;
1306
+ readonly timestamp: (value: string) => DerivedProperty.DatetimePropertyDefinition<SimplePropertyDef.Make<"timestamp", "non-nullable", "single">, Q>;
1307
+ };
1308
+ };
1092
1309
  type Aggregatable<Q extends ObjectOrInterfaceDefinition> = {
1093
1310
  readonly aggregate: <V extends ValidAggregationKeys<Q, "withPropertiesAggregate">>(aggregationSpecifier: V, opts?: V extends `${any}:${infer P}` ? P extends CollectWithPropAggregations ? {
1094
1311
  limit: number;
@@ -1358,7 +1575,29 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
1358
1575
  unsubscribe: () => void;
1359
1576
  };
1360
1577
  }
1361
- interface ObjectSetCleanedTypes<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>, MERGED extends ObjectOrInterfaceDefinition & Q, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> extends MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<Q>, FetchOne<Q, D>, Subscribe<MERGED>, NearestNeighbors<Q> {
1578
+ interface AsType<Q extends ObjectOrInterfaceDefinition> {
1579
+ /**
1580
+ * Casts the object set to the specified object type or interface type.
1581
+ * Any downstream object set operations (e.g. where, fetchPage, aggregate) will be
1582
+ * performed on the specified type. Objects from the original object set that do not
1583
+ * implement the specified interface or match the specified object set will be filtered out.
1584
+ * @param type - The object type you want to cast to.
1585
+ * @returns an object set of the specified type.
1586
+ */
1587
+ readonly asType: <CONVERT_TO extends RestrictToImplementingObjectTypes<Q>>(type: CONVERT_TO) => ObjectSet<CONVERT_TO>;
1588
+ }
1589
+ type RestrictToImplementingObjectTypes<T extends ObjectOrInterfaceDefinition> = T extends ObjectTypeDefinition ? ExtractImplementedInterfaces<T> : T extends InterfaceDefinition ? ExtractImplementingTypes<T> : never;
1590
+ type ExtractImplementedInterfaces<T extends ObjectTypeDefinition> = CompileTimeMetadata<T> extends {
1591
+ implements: ReadonlyArray<infer API_NAME>;
1592
+ } ? API_NAME extends string ? InterfaceDefinition & {
1593
+ apiName: API_NAME;
1594
+ } : never : never;
1595
+ type ExtractImplementingTypes<T extends InterfaceDefinition> = CompileTimeMetadata<T> extends {
1596
+ implementedBy: ReadonlyArray<infer API_NAME extends string>;
1597
+ } ? (ObjectTypeDefinition & {
1598
+ apiName: API_NAME;
1599
+ }) | InterfaceDefinition : InterfaceDefinition;
1600
+ interface ObjectSetCleanedTypes<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>, MERGED extends ObjectOrInterfaceDefinition & Q, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> extends MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<Q>, FetchOne<Q, D>, Subscribe<MERGED>, NearestNeighbors<Q>, AsType<Q> {
1362
1601
  }
1363
1602
 
1364
- export { PropertyKeys as $, type AttachmentUpload as A, type Augment as B, type CompileTimeMetadata as C, DistanceUnitMapping as D, type Augments as E, type FetchPageArgs as F, type GeoFilterOptions as G, type SelectArg as H, type InterfaceDefinition as I, type SelectArgToKeys as J, type FetchPageResult as K, type SingleOsdkResult as L, type MediaReference as M, NullabilityAdherence as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, type Media as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type MediaMetadata as T, isOk as U, type ValidAggregationKeys as V, type WhereClause as W, type Result as X, type BaseObjectSet as Y, ObjectSetSubscription as Z, InterfaceMetadata as _, type Attachment as a, type ObjectSpecifier as a0, ObjectMetadata as a1, type PropertyDef as a2, type VersionBound as a3, type BaseWirePropertyTypes as a4, type WirePropertyTypes as a5, type PrimaryKeyType as a6, type ConvertProps as a7, Osdk as a8, type PageResult as a9, TimeseriesDurationMapping as aa, type GeotimeSeriesProperty as ab, type TimeSeriesPoint as ac, type TimeSeriesProperty as ad, type TimeSeriesQuery as ae, type LinkedType as af, type LinkNames as ag, type ExtractOptions as ah, type MinimalObjectSet as ai, type ObjectIdentifiers as b, type OsdkObjectPrimaryKeyType as c, type ObjectSet as d, type OsdkMetadata as e, type ObjectOrInterfaceDefinition as f, type PrimaryKeyTypes as g, type OsdkBase as h, type AggregateOpts as i, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as j, type AggregationResultsWithGroups as k, type AggregationResultsWithoutGroups as l, type AggregationClause as m, type AggregationsResults as n, type GeoFilter_Intersects as o, type GeoFilter_Within as p, type PossibleWhereClauseFilters as q, type OsdkObjectCreatePropertyType as r, type OsdkObjectPropertyType as s, type OsdkObjectLinksObject as t, DerivedProperty as u, DurationMapping as v, type AllGroupByValues as w, type GroupByClause as x, type GroupByRange as y, type AsyncIterArgs as z };
1603
+ export { isOk as $, type AttachmentUpload as A, type GroupByClause as B, type CompileTimeMetadata as C, DistanceUnitMapping as D, type GroupByRange as E, type AsyncIterArgs as F, type GeoFilterOptions as G, type Augment as H, type InterfaceDefinition as I, type Augments as J, type FetchPageArgs as K, NullabilityAdherence as L, type MediaReference as M, type NotWhereClause as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, ObjectSetArgs as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type SelectArg as T, type SelectArgToKeys as U, type ValidAggregationKeys as V, type WhereClause as W, type FetchPageResult as X, type SingleOsdkResult as Y, type Media as Z, type MediaMetadata as _, type MediaUpload as a, type ExtractOptions as a$, type Result as a0, type BaseObjectSet as a1, ObjectSetSubscription as a2, InterfaceMetadata as a3, PropertyKeys as a4, type ObjectSpecifier as a5, ObjectMetadata as a6, type PropertyDef as a7, type VersionBound as a8, SimplePropertyDef as a9, type NumberFormatScale as aA, type NumberFormatStandard as aB, type NumberFormatStandardUnit as aC, type NumberRatioType as aD, type NumberRoundingMode as aE, type NumberScaleType as aF, type PropertyNumberFormattingRule as aG, type PropertyNumberFormattingRuleType as aH, type TimeCodeFormat as aI, type PropertyValueFormattingRule as aJ, type PropertyTypeReference as aK, type PropertyTypeReferenceOrStringConstant as aL, type StringConstant as aM, type BaseWirePropertyTypes as aN, type WirePropertyTypes as aO, type PrimaryKeyType as aP, type ConvertProps as aQ, type MaybeScore as aR, Osdk as aS, type PageResult as aT, TimeseriesDurationMapping as aU, type GeotimeSeriesProperty as aV, type TimeSeriesPoint as aW, type TimeSeriesProperty as aX, type TimeSeriesQuery as aY, type LinkedType as aZ, type LinkNames as a_, type PropertyBooleanFormattingRule as aa, type DatetimeFormat as ab, type DatetimeLocalizedFormat as ac, type DatetimeLocalizedFormatType as ad, type DatetimeStringFormat as ae, type DatetimeTimezone as af, type DatetimeTimezoneStatic as ag, type DatetimeTimezoneUser as ah, type PropertyDateFormattingRule as ai, type PropertyTimestampFormattingRule as aj, type KnownType as ak, type PropertyKnownTypeFormattingRule as al, type Affix as am, type DurationBaseValue as an, type DurationFormatStyle as ao, type DurationPrecision as ap, type HumanReadableFormat as aq, type NumberFormatAffix as ar, type NumberFormatCurrency as as, type NumberFormatCurrencyStyle as at, type NumberFormatCustomUnit as au, type NumberFormatDuration as av, type NumberFormatFixedValues as aw, type NumberFormatNotation as ax, type NumberFormatOptions as ay, type NumberFormatRatio as az, type Attachment as b, type MinimalObjectSet as b0, type ObjectIdentifiers as c, type OsdkObjectPrimaryKeyType as d, type ObjectSet as e, type OsdkMetadata as f, type ObjectOrInterfaceDefinition as g, type PrimaryKeyTypes as h, type OsdkBase as i, type AggregateOpts as j, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as k, type AggregationResultsWithGroups as l, type AggregationResultsWithoutGroups as m, type AggregationClause as n, type AggregationsResults as o, type AndWhereClause as p, type GeoFilter_Intersects as q, type GeoFilter_Within as r, type OrWhereClause as s, type PossibleWhereClauseFilters as t, type OsdkObjectCreatePropertyType as u, type OsdkObjectPropertyType as v, type OsdkObjectLinksObject as w, DerivedProperty as x, DurationMapping as y, type AllGroupByValues as z };
@@ -1,5 +1,8 @@
1
1
  'use strict';
2
2
 
3
+ // src/actions/NullValue.ts
4
+ var NULL_VALUE = Symbol.for("NULL_VALUE");
5
+
3
6
  // src/aggregate/WhereClause.ts
4
7
  var DistanceUnitMapping = {
5
8
  "centimeter": "CENTIMETERS",
@@ -69,6 +72,7 @@ var TimeseriesDurationMapping = {
69
72
 
70
73
  exports.DistanceUnitMapping = DistanceUnitMapping;
71
74
  exports.DurationMapping = DurationMapping;
75
+ exports.NULL_VALUE = NULL_VALUE;
72
76
  exports.TimeseriesDurationMapping = TimeseriesDurationMapping;
73
77
  exports.isOk = isOk;
74
78
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAkBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA;AACpB;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA;AACX,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA;AACd;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA;AACpB;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG;AACL","file":"index.cjs","sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// the value side of this needs to match DistanceUnit from @osdk/foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping = {\n \"centimeter\": \"CENTIMETERS\",\n \"centimeters\": \"CENTIMETERS\",\n \"cm\": \"CENTIMETERS\",\n \"meter\": \"METERS\",\n \"meters\": \"METERS\",\n \"m\": \"METERS\",\n \"kilometer\": \"KILOMETERS\",\n \"kilometers\": \"KILOMETERS\",\n \"km\": \"KILOMETERS\",\n \"inch\": \"INCHES\",\n \"inches\": \"INCHES\",\n \"foot\": \"FEET\",\n \"feet\": \"FEET\",\n \"yard\": \"YARDS\",\n \"yards\": \"YARDS\",\n \"mile\": \"MILES\",\n \"miles\": \"MILES\",\n \"nautical_mile\": \"NAUTICAL_MILES\",\n \"nauticalMile\": \"NAUTICAL_MILES\",\n \"nautical miles\": \"NAUTICAL_MILES\"\n};\n\n// FIXME we need to represent all types","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const TimeDurationMapping = {\n \"sec\": \"SECONDS\",\n \"seconds\": \"SECONDS\",\n \"min\": \"MINUTES\",\n \"minute\": \"MINUTES\",\n \"minutes\": \"MINUTES\",\n \"hr\": \"HOURS\",\n \"hrs\": \"HOURS\",\n \"hour\": \"HOURS\",\n \"hours\": \"HOURS\",\n \"day\": \"DAYS\",\n \"days\": \"DAYS\",\n \"wk\": \"WEEKS\",\n \"week\": \"WEEKS\",\n \"weeks\": \"WEEKS\",\n \"mos\": \"MONTHS\",\n \"month\": \"MONTHS\",\n \"months\": \"MONTHS\",\n \"yr\": \"YEARS\",\n \"year\": \"YEARS\",\n \"years\": \"YEARS\"\n};","/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n ...TimeDurationMapping,\n \"quarter\": \"QUARTERS\",\n \"quarters\": \"QUARTERS\"\n};","/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n return \"error\" in a;\n}","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n \"ms\": \"MILLISECONDS\",\n \"milliseconds\": \"MILLISECONDS\",\n ...TimeDurationMapping\n};"]}
1
+ {"version":3,"sources":["../../src/actions/NullValue.ts","../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAgBa,IAAA,UAAA,GAAa,MAAO,CAAA,GAAA,CAAI,YAAY;;;ACE1C,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA;AACpB;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA;AACX,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA;AACd;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA;AACpB;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG;AACL","file":"index.cjs","sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const NULL_VALUE = Symbol.for(\"NULL_VALUE\");","/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// the value side of this needs to match DistanceUnit from @osdk/foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping = {\n \"centimeter\": \"CENTIMETERS\",\n \"centimeters\": \"CENTIMETERS\",\n \"cm\": \"CENTIMETERS\",\n \"meter\": \"METERS\",\n \"meters\": \"METERS\",\n \"m\": \"METERS\",\n \"kilometer\": \"KILOMETERS\",\n \"kilometers\": \"KILOMETERS\",\n \"km\": \"KILOMETERS\",\n \"inch\": \"INCHES\",\n \"inches\": \"INCHES\",\n \"foot\": \"FEET\",\n \"feet\": \"FEET\",\n \"yard\": \"YARDS\",\n \"yards\": \"YARDS\",\n \"mile\": \"MILES\",\n \"miles\": \"MILES\",\n \"nautical_mile\": \"NAUTICAL_MILES\",\n \"nauticalMile\": \"NAUTICAL_MILES\",\n \"nautical miles\": \"NAUTICAL_MILES\"\n};\n\n// FIXME we need to represent all types","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const TimeDurationMapping = {\n \"sec\": \"SECONDS\",\n \"seconds\": \"SECONDS\",\n \"min\": \"MINUTES\",\n \"minute\": \"MINUTES\",\n \"minutes\": \"MINUTES\",\n \"hr\": \"HOURS\",\n \"hrs\": \"HOURS\",\n \"hour\": \"HOURS\",\n \"hours\": \"HOURS\",\n \"day\": \"DAYS\",\n \"days\": \"DAYS\",\n \"wk\": \"WEEKS\",\n \"week\": \"WEEKS\",\n \"weeks\": \"WEEKS\",\n \"mos\": \"MONTHS\",\n \"month\": \"MONTHS\",\n \"months\": \"MONTHS\",\n \"yr\": \"YEARS\",\n \"year\": \"YEARS\",\n \"years\": \"YEARS\"\n};","/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n ...TimeDurationMapping,\n \"quarter\": \"QUARTERS\",\n \"quarters\": \"QUARTERS\"\n};","/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n return \"error\" in a;\n}","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n \"ms\": \"MILLISECONDS\",\n \"milliseconds\": \"MILLISECONDS\",\n ...TimeDurationMapping\n};"]}
@@ -1,5 +1,5 @@
1
- import { A as AttachmentUpload, M as MediaReference, a as Attachment, O as ObjectTypeDefinition, b as ObjectIdentifiers, c as OsdkObjectPrimaryKeyType, d as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, e as OsdkMetadata, R as ReleaseStatus, f as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, g as PrimaryKeyTypes, h as OsdkBase } from './ObjectSet-CRGBmCu9.cjs';
2
- export { i as AggregateOpts, j as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, m as AggregationClause, k as AggregationResultsWithGroups, l as AggregationResultsWithoutGroups, n as AggregationsResults, w as AllGroupByValues, z as AsyncIterArgs, B as Augment, E as Augments, Y as BaseObjectSet, a4 as BaseWirePropertyTypes, a7 as ConvertProps, u as DerivedProperty, D as DistanceUnitMapping, v as DurationMapping, F as FetchPageArgs, K as FetchPageResult, G as GeoFilterOptions, o as GeoFilter_Intersects, p as GeoFilter_Within, ab as GeotimeSeriesProperty, x as GroupByClause, y as GroupByRange, _ as InterfaceMetadata, ag as LinkNames, af as LinkedType, Q as Media, T as MediaMetadata, N as NullabilityAdherence, a1 as ObjectMetadata, Z as ObjectSetSubscription, a0 as ObjectSpecifier, a8 as Osdk, r as OsdkObjectCreatePropertyType, t as OsdkObjectLinksObject, s as OsdkObjectPropertyType, a9 as PageResult, q as PossibleWhereClauseFilters, a6 as PrimaryKeyType, a2 as PropertyDef, $ as PropertyKeys, X as Result, H as SelectArg, J as SelectArgToKeys, S as SingleLinkAccessor, L as SingleOsdkResult, ac as TimeSeriesPoint, ad as TimeSeriesProperty, ae as TimeSeriesQuery, aa as TimeseriesDurationMapping, V as ValidAggregationKeys, a3 as VersionBound, W as WhereClause, a5 as WirePropertyTypes, U as isOk } from './ObjectSet-CRGBmCu9.cjs';
1
+ import { A as AttachmentUpload, M as MediaReference, a as MediaUpload, b as Attachment, O as ObjectTypeDefinition, c as ObjectIdentifiers, d as OsdkObjectPrimaryKeyType, e as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, f as OsdkMetadata, R as ReleaseStatus, g as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, h as PrimaryKeyTypes, i as OsdkBase } from './ObjectSet-D7jdSkmi.cjs';
2
+ export { am as Affix, j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults, z as AllGroupByValues, p as AndWhereClause, F as AsyncIterArgs, H as Augment, J as Augments, a1 as BaseObjectSet, aN as BaseWirePropertyTypes, aQ as ConvertProps, ab as DatetimeFormat, ac as DatetimeLocalizedFormat, ad as DatetimeLocalizedFormatType, ae as DatetimeStringFormat, af as DatetimeTimezone, ag as DatetimeTimezoneStatic, ah as DatetimeTimezoneUser, x as DerivedProperty, D as DistanceUnitMapping, an as DurationBaseValue, ao as DurationFormatStyle, y as DurationMapping, ap as DurationPrecision, K as FetchPageArgs, X as FetchPageResult, G as GeoFilterOptions, q as GeoFilter_Intersects, r as GeoFilter_Within, aV as GeotimeSeriesProperty, B as GroupByClause, E as GroupByRange, aq as HumanReadableFormat, a3 as InterfaceMetadata, ak as KnownType, a_ as LinkNames, aZ as LinkedType, aR as MaybeScore, Z as Media, _ as MediaMetadata, N as NotWhereClause, L as NullabilityAdherence, ar as NumberFormatAffix, as as NumberFormatCurrency, at as NumberFormatCurrencyStyle, au as NumberFormatCustomUnit, av as NumberFormatDuration, aw as NumberFormatFixedValues, ax as NumberFormatNotation, ay as NumberFormatOptions, az as NumberFormatRatio, aA as NumberFormatScale, aB as NumberFormatStandard, aC as NumberFormatStandardUnit, aD as NumberRatioType, aE as NumberRoundingMode, aF as NumberScaleType, a6 as ObjectMetadata, Q as ObjectSetArgs, a2 as ObjectSetSubscription, a5 as ObjectSpecifier, s as OrWhereClause, aS as Osdk, u as OsdkObjectCreatePropertyType, w as OsdkObjectLinksObject, v as OsdkObjectPropertyType, aT as PageResult, t as PossibleWhereClauseFilters, aP as PrimaryKeyType, aa as PropertyBooleanFormattingRule, ai as PropertyDateFormattingRule, a7 as PropertyDef, a4 as PropertyKeys, al as PropertyKnownTypeFormattingRule, aG as PropertyNumberFormattingRule, aH as PropertyNumberFormattingRuleType, aj as PropertyTimestampFormattingRule, aK as PropertyTypeReference, aL as PropertyTypeReferenceOrStringConstant, aJ as PropertyValueFormattingRule, a0 as Result, T as SelectArg, U as SelectArgToKeys, a9 as SimplePropertyDef, S as SingleLinkAccessor, Y as SingleOsdkResult, aM as StringConstant, aI as TimeCodeFormat, aW as TimeSeriesPoint, aX as TimeSeriesProperty, aY as TimeSeriesQuery, aU as TimeseriesDurationMapping, V as ValidAggregationKeys, a8 as VersionBound, W as WhereClause, aO as WirePropertyTypes, $ as isOk } from './ObjectSet-D7jdSkmi.cjs';
3
3
  import 'type-fest';
4
4
  import 'geojson';
5
5
 
@@ -62,7 +62,7 @@ interface DataValueClientToWire {
62
62
  string: string;
63
63
  timestamp: string;
64
64
  set: Set<any>;
65
- mediaReference: MediaReference;
65
+ mediaReference: MediaReference | MediaUpload;
66
66
  twoDimensionalAggregation: {
67
67
  key: AllowedBucketKeyTypes$1;
68
68
  value: AllowedBucketTypes$1;
@@ -169,6 +169,10 @@ type ParameterEvaluatedConstraint = {
169
169
  type: "unevaluable";
170
170
  };
171
171
 
172
+ declare const NULL_VALUE: symbol & {
173
+ __type: "NULL_VALUE";
174
+ };
175
+
172
176
  type ApplyActionOptions = {
173
177
  $returnEdits?: true;
174
178
  $validateOnly?: false;
@@ -207,6 +211,11 @@ declare namespace ActionParam {
207
211
  type StructType<T extends Record<string, keyof DataValueClientToWire>> = {
208
212
  [K in keyof T]: DataValueClientToWire[T[K]];
209
213
  };
214
+ /**
215
+ * Type of the symbol that indicates that a "null" value should be passed for the action parameter.
216
+ * For any autogenerated modify actions, this will cause the action to clear the value of the parameter.
217
+ */
218
+ type NullValueType = typeof NULL_VALUE;
210
219
  }
211
220
  type ActionEditResponse = ActionResults;
212
221
  type ActionValidationResponse = ValidateActionResponseV2;
@@ -474,4 +483,4 @@ declare namespace QueryResult {
474
483
  type ThreeDimensionalAggregationType<OUT extends AggregationKeyTypes | RangeKey<any>, IN extends AggregationKeyTypes | RangeKey<any>, V extends AggregationValueTypes> = ThreeDimensionalAggregation<OUT extends AggregationKeyTypes ? AggKeyWireToClient<OUT> : OUT, IN extends AggregationKeyTypes ? AggKeyWireToClient<IN> : IN, AggValueWireToClient<V>>;
475
484
  }
476
485
 
477
- export { type ActionDefinition, type ActionEditResponse, ActionMetadata, ActionParam, type ActionReturnTypeForOptions, type ActionValidationResponse, type AllowedBucketKeyTypes$1 as AllowedBucketKeyTypes, type AllowedBucketTypes$1 as AllowedBucketTypes, type ApplyActionOptions, type ApplyBatchActionOptions, Attachment, AttachmentUpload, CompileTimeMetadata, type DataValueClientToWire, type DataValueWireToClient, InterfaceDefinition, type InterfaceQueryDataType, Logger, MediaReference, ObjectIdentifiers, ObjectOrInterfaceDefinition, type ObjectQueryDataType, type ObjectSet, type ObjectSetQueryDataType, ObjectTypeDefinition, type OntologyMetadata, OsdkBase, type OsdkObject, PrimaryKeyTypes, PropertyValueWireToClient, type QueryDataTypeDefinition, type QueryDefinition, type QueryMetadata, QueryParam, type QueryParameterDefinition, QueryResult, type Range, type ThreeDimensionalAggregation, type ThreeDimensionalQueryAggregationDefinition, type TwoDimensionalAggregation, type TwoDimensionalQueryAggregationDefinition };
486
+ export { type ActionDefinition, type ActionEditResponse, ActionMetadata, ActionParam, type ActionReturnTypeForOptions, type ActionValidationResponse, type AllowedBucketKeyTypes$1 as AllowedBucketKeyTypes, type AllowedBucketTypes$1 as AllowedBucketTypes, type ApplyActionOptions, type ApplyBatchActionOptions, Attachment, AttachmentUpload, CompileTimeMetadata, type DataValueClientToWire, type DataValueWireToClient, InterfaceDefinition, type InterfaceQueryDataType, Logger, MediaReference, MediaUpload, NULL_VALUE, ObjectIdentifiers, ObjectOrInterfaceDefinition, type ObjectQueryDataType, type ObjectSet, type ObjectSetQueryDataType, ObjectTypeDefinition, type OntologyMetadata, OsdkBase, type OsdkObject, PrimaryKeyTypes, PropertyValueWireToClient, type QueryDataTypeDefinition, type QueryDefinition, type QueryMetadata, QueryParam, type QueryParameterDefinition, QueryResult, type Range, type ThreeDimensionalAggregation, type ThreeDimensionalQueryAggregationDefinition, type TwoDimensionalAggregation, type TwoDimensionalQueryAggregationDefinition };
@@ -1,5 +1,5 @@
1
- import { f as ObjectOrInterfaceDefinition, $ as PropertyKeys, M as MediaReference, O as ObjectTypeDefinition, N as NullabilityAdherence, H as SelectArg, a8 as Osdk, ah as ExtractOptions, F as FetchPageArgs, K as FetchPageResult, h as OsdkBase } from '../ObjectSet-CRGBmCu9.cjs';
2
- export { ai as MinimalObjectSet } from '../ObjectSet-CRGBmCu9.cjs';
1
+ import { g as ObjectOrInterfaceDefinition, a4 as PropertyKeys, M as MediaReference, O as ObjectTypeDefinition, L as NullabilityAdherence, T as SelectArg, aS as Osdk, a$ as ExtractOptions, K as FetchPageArgs, X as FetchPageResult, i as OsdkBase } from '../ObjectSet-D7jdSkmi.cjs';
2
+ export { b0 as MinimalObjectSet } from '../ObjectSet-D7jdSkmi.cjs';
3
3
  import 'type-fest';
4
4
  import 'geojson';
5
5
 
@@ -1 +1 @@
1
- {"version":3,"file":"Definitions.js","names":[],"sources":["Definitions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n GetClientPropertyValueFromWire,\n GetCreatePropertyValueFromWire,\n} from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectMetadata } from \"./ontology/ObjectTypeDefinition.js\";\n\ntype MaybeArray<T extends { multiplicity?: boolean | undefined }, U> =\n T[\"multiplicity\"] extends true ? Array<U> : U;\n\ntype MaybeNullable<T extends ObjectMetadata.Property, U> = T[\"nullable\"] extends\n true ? U | undefined\n : U;\n\ntype Raw<T> = T extends Array<any> ? T[0] : T;\ntype Converted<T> = T extends Array<any> ? T[1] : T;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectPropertyType<\n T extends ObjectMetadata.Property,\n STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n | MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n | undefined\n : MaybeNullable<\n T,\n MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n >;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n */\nexport type OsdkObjectPropertyTypeNotUndefined<\n T extends ObjectMetadata.Property,\n> = MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectCreatePropertyType<\n T extends ObjectMetadata.Property,\n STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n | MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T[\"type\"]>>>\n | undefined\n : MaybeNullable<\n T,\n MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T[\"type\"]>>>\n >;\n\nexport type OsdkObjectRawPropertyType<T extends ObjectMetadata.Property> =\n MaybeNullable<\n T,\n MaybeArray<T, Raw<GetClientPropertyValueFromWire<T[\"type\"]>>>\n >;\n"],"mappings":"","ignoreList":[]}
1
+ {"version":3,"file":"Definitions.js","names":[],"sources":["Definitions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n GetClientPropertyValueFromWire,\n GetCreatePropertyValueFromWire,\n} from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectMetadata } from \"./ontology/ObjectTypeDefinition.js\";\n\ntype MaybeArray<T extends { multiplicity?: boolean | undefined }, U> =\n T[\"multiplicity\"] extends true ? Array<U> : U;\n\ntype MaybeNullable<T extends ObjectMetadata.Property, U> = T[\"nullable\"] extends\n true ? U | undefined\n : U;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectPropertyType<\n T extends ObjectMetadata.Property,\n STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n | MaybeArray<T, GetClientPropertyValueFromWire<T[\"type\"]>>\n | undefined\n : MaybeNullable<\n T,\n MaybeArray<T, GetClientPropertyValueFromWire<T[\"type\"]>>\n >;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n */\nexport type OsdkObjectPropertyTypeNotUndefined<\n T extends ObjectMetadata.Property,\n> = MaybeArray<T, GetClientPropertyValueFromWire<T[\"type\"]>>;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE} S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectCreatePropertyType<\n T extends ObjectMetadata.Property,\n STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n | MaybeArray<T, GetCreatePropertyValueFromWire<T[\"type\"]>>\n | undefined\n : MaybeNullable<\n T,\n MaybeArray<T, GetCreatePropertyValueFromWire<T[\"type\"]>>\n >;\n"],"mappings":"","ignoreList":[]}
@@ -1 +1 @@
1
- {"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n DefaultToFalse,\n OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type {\n NullabilityAdherence,\n ObjectSetArgs,\n} from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type {\n InterfaceDefinition,\n InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nimport type {\n ObjectOrInterfaceDefinition,\n PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nimport type {\n CompileTimeMetadata,\n ObjectMetadata,\n ObjectTypeDefinition,\n} from \"./ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nimport type { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n T,\n \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n T,\n \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n | \"$all\"\n | \"$rid\"\n | \"$strict\"\n | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n | SpecialOsdkPropParams\n | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n T extends ObjectOrInterfaceDefinition,\n P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ObjectTypeDefinition,\n P extends ValidOsdkPropParams<FROM>,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = \"$allBaseProperties\" extends OPTIONS\n ? PropertyKeys<FROM> extends P ? PropertyKeys<TO>\n : PropMapToObject<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>]\n : PropMapToObject<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\ntype NamespaceOf<S extends string> = S extends `${infer Before}.${infer After}`\n ? After extends `${string}.${string}` ? `${Before}.${NamespaceOf<After>}`\n : Before\n : never;\n\ntype MaybeStripNamespaces<S extends string, TO extends InterfaceDefinition> =\n S extends `${NamespaceOf<S>}.${infer Rest}`\n ? NamespaceOf<S> extends NamespaceOf<ApiNameAsString<TO>> ? Rest : S\n : S;\n\nexport type PropMapToInterface<\n FROM extends ObjectTypeDefinition,\n TO extends InterfaceDefinition,\n> = NonNullable<\n CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n FROM extends ObjectTypeDefinition,\n TO extends InterfaceDefinition,\n P extends ValidOsdkPropParams<FROM>,\n> = MaybeStripNamespaces<\n PropMapToInterface<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>],\n TO\n>;\n/**\n * Older version of this helper that allows for `$rid` and co in\n * the properties field.\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ValidToFrom<FROM>,\n P extends ValidOsdkPropParams<FROM>,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = TO extends FROM ? P\n : TO extends ObjectTypeDefinition ? (\n UnionIfTrue<\n MapPropNamesToObjectType<FROM, TO, P, OPTIONS>,\n P extends \"$rid\" ? true : false,\n \"$rid\"\n >\n )\n : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n UnionIfTrue<\n MapPropNamesToInterface<FROM, TO, P>,\n P extends \"$rid\" ? true : false,\n \"$rid\"\n >\n )\n : never\n : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n : InterfaceDefinition;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n Q extends ObjectOrInterfaceDefinition,\n P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n ? [keyof T] extends [never] ? false : true\n : false;\n\nexport type GetPropsKeys<\n Q extends ObjectOrInterfaceDefinition,\n P extends PropertyKeys<Q>,\n N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n : IsAny<P> extends true ? PropertyKeys<Q>\n : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n Q extends ObjectOrInterfaceDefinition,\n OPTIONS extends string = never,\n P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n // no middle options is simplest\n IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n // Options only includes the two allowed in the new style\n : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n // else we are in the old style which was just Q and OPTIONS\n // and OPTIONS was $things + prop names\n : Osdk.Instance<\n Q,\n (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n >;\n\nexport type MaybeScore<\n T extends Osdk.Instance<any>,\n ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<any>,\n> = ORDER_BY_OPTIONS extends \"relevance\" ? T & { $score: number } : T;\n\nexport namespace Osdk {\n export type Instance<\n Q extends ObjectOrInterfaceDefinition,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n P extends PropertyKeys<Q> = PropertyKeys<Q>,\n R extends Record<string, SimplePropertyDef> = {},\n > =\n & OsdkBase<Q>\n & Pick<\n CompileTimeMetadata<Q>[\"props\"],\n // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n >\n & ([R] extends [never] ? {}\n : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n & {\n readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n : Q extends ObjectOrInterfaceDefinition ? OsdkObjectLinksObject<Q>\n : never;\n\n readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n type: NEW_Q | string,\n ) => Osdk.Instance<\n NEW_Q,\n OPTIONS,\n ConvertProps<Q, NEW_Q, P, OPTIONS>\n >;\n\n readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n updatedObject?:\n | Osdk.Instance<Q, any, NEW_PROPS>\n | {\n [K in NEW_PROPS]?: CompileTimeMetadata<\n Q\n >[\"props\"][K];\n },\n ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n\n readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__metadata: Q extends\n ObjectTypeDefinition ? {\n ObjectMetadata: ObjectMetadata;\n }\n : {\n ObjectMetadata: ObjectMetadata;\n InterfaceMetadata: InterfaceMetadata;\n };\n }\n // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n & (IsNever<OPTIONS> extends true ? {}\n : IsAny<OPTIONS> extends true ? {}\n : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n IsNever<S> extends true ? never\n : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n IsNever<R> extends true ? never\n : DefaultToFalse<R> extends false ? never\n : \"$rid\";\n\nexport type ExtractAllPropertiesOption<T extends boolean> = // comment for readability\n IsNever<T> extends true ? never\n : DefaultToFalse<T> extends false ? never\n : \"$allBaseProperties\";\n\n// not exported from package\nexport type ExtractOptions<\n R extends boolean,\n S extends NullabilityAdherence = NullabilityAdherence.Default,\n T extends boolean = false,\n> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA0GA;AACA;AACA;AACA;AACA;AACA;AACA;AAwBA;AA0BA;AACA;AACA;AAFA,WA2BiBA,IAAI;AAsDrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAWA","ignoreList":[]}
1
+ {"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n DefaultToFalse,\n OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type {\n NullabilityAdherence,\n ObjectSetArgs,\n} from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type {\n InterfaceDefinition,\n InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nimport type {\n ObjectOrInterfaceDefinition,\n PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nimport type {\n CompileTimeMetadata,\n ObjectMetadata,\n ObjectTypeDefinition,\n} from \"./ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nimport type { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n T,\n \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n T,\n \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n | \"$all\"\n | \"$rid\"\n | \"$strict\"\n | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n | SpecialOsdkPropParams\n | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n T extends ObjectOrInterfaceDefinition,\n P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ObjectTypeDefinition,\n P extends ValidOsdkPropParams<FROM>,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = \"$allBaseProperties\" extends OPTIONS\n ? PropertyKeys<FROM> extends P ? PropertyKeys<TO>\n : PropMapToObject<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>]\n : PropMapToObject<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\ntype NamespaceOf<S extends string> = S extends `${infer Before}.${infer After}`\n ? After extends `${string}.${string}` ? `${Before}.${NamespaceOf<After>}`\n : Before\n : never;\n\ntype MaybeStripNamespaces<S extends string, TO extends InterfaceDefinition> =\n S extends `${NamespaceOf<S>}.${infer Rest}`\n ? NamespaceOf<S> extends NamespaceOf<ApiNameAsString<TO>> ? Rest : S\n : S;\n\nexport type PropMapToInterface<\n FROM extends ObjectTypeDefinition,\n TO extends InterfaceDefinition,\n> = NonNullable<\n CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n FROM extends ObjectTypeDefinition,\n TO extends InterfaceDefinition,\n P extends ValidOsdkPropParams<FROM>,\n> = MaybeStripNamespaces<\n PropMapToInterface<\n FROM,\n TO\n >[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>],\n TO\n>;\n/**\n * Older version of this helper that allows for `$rid` and co in\n * the properties field.\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n FROM extends ObjectOrInterfaceDefinition,\n TO extends ValidToFrom<FROM>,\n P extends ValidOsdkPropParams<FROM>,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = TO extends FROM ? P\n : TO extends ObjectTypeDefinition ? (\n UnionIfTrue<\n MapPropNamesToObjectType<FROM, TO, P, OPTIONS>,\n P extends \"$rid\" ? true : false,\n \"$rid\"\n >\n )\n : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n UnionIfTrue<\n MapPropNamesToInterface<FROM, TO, P>,\n P extends \"$rid\" ? true : false,\n \"$rid\"\n >\n )\n : never\n : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n : InterfaceDefinition;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n Q extends ObjectOrInterfaceDefinition,\n P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n ? [keyof T] extends [never] ? false : true\n : false;\n\nexport type GetPropsKeys<\n Q extends ObjectOrInterfaceDefinition,\n P extends PropertyKeys<Q>,\n N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n : IsAny<P> extends true ? PropertyKeys<Q>\n : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n Q extends ObjectOrInterfaceDefinition,\n OPTIONS extends string = never,\n P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n // no middle options is simplest\n IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n // Options only includes the two allowed in the new style\n : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n // else we are in the old style which was just Q and OPTIONS\n // and OPTIONS was $things + prop names\n : Osdk.Instance<\n Q,\n (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n >;\n\nexport type MaybeScore<\n T extends Osdk.Instance<any>,\n ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<any>,\n> = ORDER_BY_OPTIONS extends \"relevance\" ? T & { $score: number } : T;\n\nexport namespace Osdk {\n export type Instance<\n Q extends ObjectOrInterfaceDefinition,\n OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n P extends PropertyKeys<Q> = PropertyKeys<Q>,\n R extends Record<string, SimplePropertyDef> = {},\n > =\n & OsdkBase<Q>\n & Pick<\n CompileTimeMetadata<Q>[\"props\"],\n // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n >\n & ([R] extends [never] ? {}\n : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n & {\n readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n : Q extends ObjectOrInterfaceDefinition ? OsdkObjectLinksObject<Q>\n : never;\n\n readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n type: NEW_Q | string,\n ) => Osdk.Instance<\n NEW_Q,\n OPTIONS,\n ConvertProps<Q, NEW_Q, P, OPTIONS>\n >;\n\n readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n updatedObject?:\n | Osdk.Instance<Q, any, NEW_PROPS>\n | {\n [K in NEW_PROPS]?: CompileTimeMetadata<\n Q\n >[\"props\"][K];\n },\n ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n\n readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__metadata: Q extends\n ObjectTypeDefinition ? {\n ObjectMetadata: ObjectMetadata;\n }\n : {\n ObjectMetadata: ObjectMetadata;\n InterfaceMetadata: InterfaceMetadata;\n };\n\n readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__getFormattedValue: <\n PropertyApiName extends PropertyKeys<Q>,\n >(\n propertyApiName: PropertyApiName,\n options?: { locale?: string; timezoneId?: string },\n ) => string | undefined;\n }\n // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n & (IsNever<OPTIONS> extends true ? {}\n : IsAny<OPTIONS> extends true ? {}\n : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n IsNever<S> extends true ? never\n : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n IsNever<R> extends true ? never\n : DefaultToFalse<R> extends false ? never\n : \"$rid\";\n\nexport type ExtractAllPropertiesOption<T extends boolean> = // comment for readability\n IsNever<T> extends true ? never\n : DefaultToFalse<T> extends false ? never\n : \"$allBaseProperties\";\n\n// not exported from package\nexport type ExtractOptions<\n R extends boolean,\n S extends NullabilityAdherence = NullabilityAdherence.Default,\n T extends boolean = false,\n> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA0GA;AACA;AACA;AACA;AACA;AACA;AACA;AAwBA;AA0BA;AACA;AACA;AAFA,WA2BiBA,IAAI;AA6DrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAWA","ignoreList":[]}
@@ -1 +1 @@
1
- {"version":3,"file":"Actions.js","names":["ActionParam"],"sources":["Actions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DataValueClientToWire } from \"../mapping/DataValueMapping.js\";\nimport type { ObjectSet } from \"../objectSet/ObjectSet.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type {\n CompileTimeMetadata,\n ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { ObjectIdentifiers } from \"../OsdkBase.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"../OsdkObjectPrimaryKeyType.js\";\n\nimport type {\n ActionResults,\n ValidateActionResponseV2,\n} from \"./ActionResults.js\";\n\nexport type ApplyActionOptions =\n | { $returnEdits?: true; $validateOnly?: false }\n | {\n $validateOnly?: true;\n $returnEdits?: false;\n };\n\nexport type ApplyBatchActionOptions = { $returnEdits?: boolean };\n\n/**\n * Helper types for converting action definition parameter types to typescript types\n */\nexport namespace ActionParam {\n /**\n * Helper type to convert action definition parameter primitives to typescript types\n */\n export type PrimitiveType<T extends keyof DataValueClientToWire> =\n DataValueClientToWire[T];\n\n /**\n * Helper type to convert action definition parameter object types to typescript types\n */\n export type ObjectType<T extends ObjectTypeDefinition> =\n | ObjectIdentifiers<T>\n | OsdkObjectPrimaryKeyType<T>;\n\n /**\n * Helper type to convert action definition parameter object sets to typescript types\n */\n export type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;\n\n /**\n * Helper type to convert action definition parameter interface types to typescript types\n */\n export type InterfaceType<T extends InterfaceDefinition> = {\n $objectType: CompileTimeMetadata<T> extends { implementedBy: infer U }\n ? (U extends ReadonlyArray<never> ? string\n : U extends ReadonlyArray<string> ? U[number]\n : string)\n : string;\n $primaryKey: string | number;\n };\n\n export type StructType<\n T extends Record<string, keyof DataValueClientToWire>,\n > = { [K in keyof T]: DataValueClientToWire[T[K]] };\n}\n\nexport type ActionEditResponse = ActionResults;\nexport type ActionValidationResponse = ValidateActionResponseV2;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA0BA;AACA;AACA;AAFA,WAGiBA,WAAW","ignoreList":[]}
1
+ {"version":3,"file":"Actions.js","names":["ActionParam"],"sources":["Actions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DataValueClientToWire } from \"../mapping/DataValueMapping.js\";\nimport type { ObjectSet } from \"../objectSet/ObjectSet.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type {\n CompileTimeMetadata,\n ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { ObjectIdentifiers } from \"../OsdkBase.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"../OsdkObjectPrimaryKeyType.js\";\n\nimport type {\n ActionResults,\n ValidateActionResponseV2,\n} from \"./ActionResults.js\";\nimport type { NULL_VALUE } from \"./NullValue.js\";\n\nexport type ApplyActionOptions =\n | { $returnEdits?: true; $validateOnly?: false }\n | {\n $validateOnly?: true;\n $returnEdits?: false;\n };\n\nexport type ApplyBatchActionOptions = { $returnEdits?: boolean };\n\n/**\n * Helper types for converting action definition parameter types to typescript types\n */\nexport namespace ActionParam {\n /**\n * Helper type to convert action definition parameter primitives to typescript types\n */\n export type PrimitiveType<T extends keyof DataValueClientToWire> =\n DataValueClientToWire[T];\n\n /**\n * Helper type to convert action definition parameter object types to typescript types\n */\n export type ObjectType<T extends ObjectTypeDefinition> =\n | ObjectIdentifiers<T>\n | OsdkObjectPrimaryKeyType<T>;\n\n /**\n * Helper type to convert action definition parameter object sets to typescript types\n */\n export type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;\n\n /**\n * Helper type to convert action definition parameter interface types to typescript types\n */\n export type InterfaceType<T extends InterfaceDefinition> = {\n $objectType: CompileTimeMetadata<T> extends { implementedBy: infer U }\n ? (U extends ReadonlyArray<never> ? string\n : U extends ReadonlyArray<string> ? U[number]\n : string)\n : string;\n $primaryKey: string | number;\n };\n\n export type StructType<\n T extends Record<string, keyof DataValueClientToWire>,\n > = { [K in keyof T]: DataValueClientToWire[T[K]] };\n\n /**\n * Type of the symbol that indicates that a \"null\" value should be passed for the action parameter.\n * For any autogenerated modify actions, this will cause the action to clear the value of the parameter.\n */\n export type NullValueType = typeof NULL_VALUE;\n}\n\nexport type ActionEditResponse = ActionResults;\nexport type ActionValidationResponse = ValidateActionResponseV2;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA2BA;AACA;AACA;AAFA,WAGiBA,WAAW","ignoreList":[]}
@@ -13,6 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ export let EqFilter;
16
17
  export let BaseFilter;
17
18
  /** @internal */
18
19
  // extends for union distribution