@osdk/api 2.6.0-beta.1 → 2.6.0-beta.11
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.
- package/CHANGELOG.md +47 -0
- package/build/browser/OsdkObjectFrom.js.map +1 -1
- package/build/browser/aggregate/BaseFilter.js +1 -0
- package/build/browser/aggregate/BaseFilter.js.map +1 -1
- package/build/browser/aggregate/WhereClause.js.map +1 -1
- package/build/browser/index.js.map +1 -1
- package/build/browser/mapping/PropertyValueMapping.js.map +1 -1
- package/build/browser/object/Media.js.map +1 -1
- package/build/browser/objectSet/ObjectSet.js.map +1 -1
- package/build/browser/objectSet/ObjectSet.test.js +9 -0
- package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
- package/build/browser/ontology/ObjectTypeDefinition.js.map +1 -1
- package/build/browser/ontology/QueryDefinition.js.map +1 -1
- package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
- package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
- package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
- package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
- package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
- package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
- package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
- package/build/cjs/{ObjectSet-COyrRxYW.d.cts → ObjectSet-D7jdSkmi.d.cts} +221 -19
- package/build/cjs/index.d.cts +7 -3
- package/build/cjs/public/unstable.d.cts +2 -2
- package/build/esm/OsdkObjectFrom.js.map +1 -1
- package/build/esm/aggregate/BaseFilter.js +1 -0
- package/build/esm/aggregate/BaseFilter.js.map +1 -1
- package/build/esm/aggregate/WhereClause.js.map +1 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/mapping/PropertyValueMapping.js.map +1 -1
- package/build/esm/object/Media.js.map +1 -1
- package/build/esm/objectSet/ObjectSet.js.map +1 -1
- package/build/esm/objectSet/ObjectSet.test.js +9 -0
- package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
- package/build/esm/ontology/ObjectTypeDefinition.js.map +1 -1
- package/build/esm/ontology/QueryDefinition.js.map +1 -1
- package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
- package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
- package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
- package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
- package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
- package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
- package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
- package/build/types/OsdkObjectFrom.d.ts +4 -0
- package/build/types/OsdkObjectFrom.d.ts.map +1 -1
- package/build/types/aggregate/BaseFilter.d.ts +10 -4
- package/build/types/aggregate/BaseFilter.d.ts.map +1 -1
- package/build/types/aggregate/WhereClause.d.ts +34 -12
- package/build/types/aggregate/WhereClause.d.ts.map +1 -1
- package/build/types/index.d.ts +9 -2
- package/build/types/index.d.ts.map +1 -1
- package/build/types/mapping/PropertyValueMapping.d.ts +2 -2
- package/build/types/mapping/PropertyValueMapping.d.ts.map +1 -1
- package/build/types/object/Media.d.ts +1 -1
- package/build/types/objectSet/ObjectSet.d.ts +3 -3
- package/build/types/objectSet/ObjectSet.d.ts.map +1 -1
- package/build/types/ontology/ObjectTypeDefinition.d.ts +2 -0
- package/build/types/ontology/ObjectTypeDefinition.d.ts.map +1 -1
- package/build/types/ontology/QueryDefinition.d.ts +5 -1
- package/build/types/ontology/QueryDefinition.d.ts.map +1 -1
- package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts +5 -0
- package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts.map +1 -0
- package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts +37 -0
- package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts.map +1 -0
- package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts +8 -0
- package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts.map +1 -0
- package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts +117 -0
- package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts.map +1 -0
- package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts +8 -0
- package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts.map +1 -0
- package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts +12 -0
- package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts.map +1 -0
- package/package.json +3 -3
|
@@ -56,7 +56,7 @@ interface MediaReference {
|
|
|
56
56
|
* Object for uploading Media
|
|
57
57
|
*/
|
|
58
58
|
interface MediaUpload {
|
|
59
|
-
readonly
|
|
59
|
+
readonly fileName: string;
|
|
60
60
|
readonly data: Blob;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
@@ -273,7 +273,7 @@ interface PropertyValueWireToCreate {
|
|
|
273
273
|
integer: number;
|
|
274
274
|
long: string;
|
|
275
275
|
marking: string;
|
|
276
|
-
mediaReference: Media;
|
|
276
|
+
mediaReference: Media | MediaReference;
|
|
277
277
|
short: number;
|
|
278
278
|
string: string;
|
|
279
279
|
timestamp: string;
|
|
@@ -297,6 +297,193 @@ interface OsdkMetadata {
|
|
|
297
297
|
|
|
298
298
|
type PrimaryKeyTypes = "string" | "datetime" | "double" | "integer" | "timestamp" | "short" | "long" | "byte";
|
|
299
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
|
+
|
|
300
487
|
type VersionString<Major extends number, Minor extends number, Patch extends number> = `${Major}.${Minor}.${Patch}`;
|
|
301
488
|
|
|
302
489
|
type WirePropertyTypes = BaseWirePropertyTypes | Record<string, BaseWirePropertyTypes>;
|
|
@@ -351,6 +538,7 @@ declare namespace ObjectMetadata {
|
|
|
351
538
|
multiplicity?: boolean;
|
|
352
539
|
nullable?: boolean;
|
|
353
540
|
valueTypeApiName?: string;
|
|
541
|
+
valueFormatting?: PropertyValueFormattingRule;
|
|
354
542
|
}
|
|
355
543
|
interface Link<Q extends ObjectTypeDefinition, M extends boolean> {
|
|
356
544
|
__OsdkLinkTargetType?: Q;
|
|
@@ -779,6 +967,10 @@ declare namespace Osdk {
|
|
|
779
967
|
ObjectMetadata: ObjectMetadata;
|
|
780
968
|
InterfaceMetadata: InterfaceMetadata;
|
|
781
969
|
};
|
|
970
|
+
readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__getFormattedValue: <PropertyApiName extends PropertyKeys<Q>>(propertyApiName: PropertyApiName, options?: {
|
|
971
|
+
locale?: string;
|
|
972
|
+
timezoneId?: string;
|
|
973
|
+
}) => string | undefined;
|
|
782
974
|
} & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
|
|
783
975
|
readonly $rid: string;
|
|
784
976
|
} : {});
|
|
@@ -810,12 +1002,14 @@ declare namespace ArrayFilter {
|
|
|
810
1002
|
}
|
|
811
1003
|
type ArrayFilter<T> = ArrayFilter.$contains<T> | ArrayFilter.$isNull<T>;
|
|
812
1004
|
|
|
813
|
-
type
|
|
1005
|
+
type EqFilterOption<T> = {
|
|
814
1006
|
"$eq": T;
|
|
1007
|
+
};
|
|
1008
|
+
interface BaseFilterOptions<T> extends EqFilterOption<T> {
|
|
815
1009
|
"$ne": T;
|
|
816
1010
|
"$isNull": boolean;
|
|
817
1011
|
"$in": ReadonlyArray<T>;
|
|
818
|
-
}
|
|
1012
|
+
}
|
|
819
1013
|
declare namespace BaseFilter {
|
|
820
1014
|
interface $eq<T> extends Just<"$eq", BaseFilterOptions<T>> {
|
|
821
1015
|
}
|
|
@@ -1013,7 +1207,12 @@ type GeoFilter_Intersects = {
|
|
|
1013
1207
|
$bbox?: never;
|
|
1014
1208
|
} | Polygon;
|
|
1015
1209
|
};
|
|
1016
|
-
type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? (PD["type"] extends
|
|
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
|
+
};
|
|
1017
1216
|
type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
|
|
1018
1217
|
[K in keyof ST]?: FilterFor<{
|
|
1019
1218
|
"type": ST[K];
|
|
@@ -1022,19 +1221,22 @@ type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
|
|
|
1022
1221
|
type StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {
|
|
1023
1222
|
[K in keyof ST]: Just<K, StructFilterOpts<ST>>;
|
|
1024
1223
|
}[keyof ST];
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
}
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
}
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
}
|
|
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
|
+
};
|
|
1034
1235
|
type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {
|
|
1035
1236
|
[P in keyof CompileTimeMetadata<T>["properties"]]?: FilterFor<CompileTimeMetadata<T>["properties"][P]>;
|
|
1036
1237
|
};
|
|
1037
|
-
type
|
|
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>);
|
|
1038
1240
|
|
|
1039
1241
|
type LinkNames<Q extends ObjectOrInterfaceDefinition> = Q extends InterfaceDefinition ? keyof CompileTimeMetadata<Q>["links"] : keyof CompileTimeMetadata<Q>["links"] & string;
|
|
1040
1242
|
type LinkedType<Q extends ObjectOrInterfaceDefinition, L extends LinkNames<Q>> = NonNullable<CompileTimeMetadata<Q>["links"][L]["__OsdkLinkTargetType"]>;
|
|
@@ -1391,11 +1593,11 @@ type ExtractImplementedInterfaces<T extends ObjectTypeDefinition> = CompileTimeM
|
|
|
1391
1593
|
apiName: API_NAME;
|
|
1392
1594
|
} : never : never;
|
|
1393
1595
|
type ExtractImplementingTypes<T extends InterfaceDefinition> = CompileTimeMetadata<T> extends {
|
|
1394
|
-
implementedBy: ReadonlyArray<infer API_NAME>;
|
|
1395
|
-
} ?
|
|
1596
|
+
implementedBy: ReadonlyArray<infer API_NAME extends string>;
|
|
1597
|
+
} ? (ObjectTypeDefinition & {
|
|
1396
1598
|
apiName: API_NAME;
|
|
1397
|
-
}) | InterfaceDefinition :
|
|
1599
|
+
}) | InterfaceDefinition : InterfaceDefinition;
|
|
1398
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> {
|
|
1399
1601
|
}
|
|
1400
1602
|
|
|
1401
|
-
export {
|
|
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 };
|
package/build/cjs/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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-
|
|
2
|
-
export { j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults,
|
|
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
|
|
|
@@ -330,7 +330,7 @@ interface QueryDefinition<T = any> {
|
|
|
330
330
|
type QueryParameterDefinition<T_Target extends ObjectTypeDefinition = any> = {
|
|
331
331
|
description?: string;
|
|
332
332
|
} & QueryDataTypeDefinition<T_Target>;
|
|
333
|
-
type QueryDataTypeDefinition<T_Target extends ObjectOrInterfaceDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | InterfaceQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | InterfaceObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType | MapDataType;
|
|
333
|
+
type QueryDataTypeDefinition<T_Target extends ObjectOrInterfaceDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | InterfaceQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | InterfaceObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType | MapDataType | ArrayQueryDataType;
|
|
334
334
|
type BaseQueryDataTypeDefinition<T extends string> = {
|
|
335
335
|
multiplicity?: boolean;
|
|
336
336
|
nullable?: boolean;
|
|
@@ -357,6 +357,10 @@ interface InterfaceObjectSetQueryDataType<T_Target extends ObjectOrInterfaceDefi
|
|
|
357
357
|
interface SetQueryDataType extends BaseQueryDataTypeDefinition<"set"> {
|
|
358
358
|
set: QueryDataTypeDefinition;
|
|
359
359
|
}
|
|
360
|
+
interface ArrayQueryDataType extends BaseQueryDataTypeDefinition<"array"> {
|
|
361
|
+
array: QueryDataTypeDefinition;
|
|
362
|
+
multiplicity: true;
|
|
363
|
+
}
|
|
360
364
|
interface UnionQueryDataType extends BaseQueryDataTypeDefinition<"union"> {
|
|
361
365
|
union: ReadonlyArray<QueryDataTypeDefinition>;
|
|
362
366
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { g as ObjectOrInterfaceDefinition,
|
|
2
|
-
export {
|
|
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":"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":"BaseFilter.js","names":["BaseFilter"],"sources":["BaseFilter.ts"],"sourcesContent":["/*\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 type { Just } from \"./Just.js\";\n\
|
|
1
|
+
{"version":3,"file":"BaseFilter.js","names":["EqFilter","BaseFilter"],"sources":["BaseFilter.ts"],"sourcesContent":["/*\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 type { Just } from \"./Just.js\";\n\ntype EqFilterOption<T> = {\n \"$eq\": T;\n};\n\nexport namespace EqFilter {\n export interface $eq<T> extends Just<\"$eq\", EqFilterOption<T>> {}\n}\n\nexport interface BaseFilterOptions<T> extends EqFilterOption<T> {\n \"$ne\": T;\n \"$isNull\": boolean;\n \"$in\": ReadonlyArray<T>;\n}\n\nexport namespace BaseFilter {\n export interface $eq<T> extends Just<\"$eq\", BaseFilterOptions<T>> {}\n export interface $ne<T> extends Just<\"$ne\", BaseFilterOptions<T>> {}\n export interface $in<T> extends Just<\"$in\", BaseFilterOptions<T>> {}\n export interface $isNull<T> extends Just<\"$isNull\", BaseFilterOptions<T>> {}\n}\n\nexport type BaseFilter<T> =\n | BaseFilter.$eq<T>\n | BaseFilter.$ne<T>\n | BaseFilter.$in<T>\n | BaseFilter.$isNull<T>;\n\n/** @internal */\nexport type CatchThemAll<T> = CatchThemAllInternal<T, keyof T>;\n\n// extends for union distribution\n/** @internal */\ntype CatchThemAllInternal<T, K extends keyof T> = K extends keyof T\n ? { [k in K]: T[k] }\n : never;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAsBiBA,QAAQ;AAAA,WAURC,UAAU;AAa3B;AAGA;AACA","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WhereClause.js","names":["DistanceUnitMapping"],"sources":["WhereClause.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 { BBox, Point, Polygon } from \"geojson\";\nimport type {\n ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n CompileTimeMetadata,\n ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { BaseWirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { IsNever } from \"../OsdkObjectFrom.js\";\nimport type { ArrayFilter } from \"./ArrayFilter.js\";\nimport type { BaseFilter } from \"./BaseFilter.js\";\nimport type { BooleanFilter } from \"./BooleanFilter.js\";\nimport type { DatetimeFilter } from \"./DatetimeFilter.js\";\nimport type { GeoFilter } from \"./GeoFilter.js\";\nimport type { Just } from \"./Just.js\";\nimport type { NumberFilter } from \"./NumberFilter.js\";\nimport type { StringFilter } from \"./StringFilter.js\";\n\nexport type PossibleWhereClauseFilters =\n | \"$gt\"\n | \"$eq\"\n | \"$ne\"\n | \"$isNull\"\n | \"$contains\"\n | \"$gte\"\n | \"$lt\"\n | \"$lte\"\n | \"$within\"\n | \"$in\"\n | \"$intersects\"\n | \"$startsWith\"\n | \"$containsAllTermsInOrder\"\n | \"$containsAnyTerm\"\n | \"$containsAllTerms\";\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 \"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} satisfies Record<\n string,\n | \"CENTIMETERS\"\n | \"METERS\"\n | \"KILOMETERS\"\n | \"INCHES\"\n | \"FEET\"\n | \"YARDS\"\n | \"MILES\"\n | \"NAUTICAL_MILES\"\n>;\n\nexport type GeoFilter_Within = {\n \"$within\":\n | {\n $distance: [number, keyof typeof DistanceUnitMapping];\n $of: [number, number] | Readonly<Point>;\n $bbox?: never;\n $polygon?: never;\n }\n | {\n $bbox: BBox;\n $distance?: never;\n $of?: never;\n $polygon?: never;\n }\n | BBox\n | {\n $polygon: Polygon[\"coordinates\"];\n $bbox?: never;\n $distance?: never;\n $of?: never;\n }\n | Polygon;\n};\n\nexport type GeoFilter_Intersects = {\n \"$intersects\":\n | {\n $bbox: BBox;\n $polygon?: never;\n }\n | BBox\n | {\n $polygon: Polygon[\"coordinates\"];\n $bbox?: never;\n }\n | Polygon;\n};\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n true\n ? (PD[\"type\"] extends
|
|
1
|
+
{"version":3,"file":"WhereClause.js","names":["DistanceUnitMapping"],"sources":["WhereClause.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 { BBox, Point, Polygon } from \"geojson\";\nimport type {\n DerivedObjectOrInterfaceDefinition,\n ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n CompileTimeMetadata,\n ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { BaseWirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { IsNever } from \"../OsdkObjectFrom.js\";\nimport type { ArrayFilter } from \"./ArrayFilter.js\";\nimport type { BaseFilter } from \"./BaseFilter.js\";\nimport type { BooleanFilter } from \"./BooleanFilter.js\";\nimport type { DatetimeFilter } from \"./DatetimeFilter.js\";\nimport type { GeoFilter } from \"./GeoFilter.js\";\nimport type { Just } from \"./Just.js\";\nimport type { NumberFilter } from \"./NumberFilter.js\";\nimport type { StringFilter } from \"./StringFilter.js\";\n\nexport type PossibleWhereClauseFilters =\n | \"$gt\"\n | \"$eq\"\n | \"$ne\"\n | \"$isNull\"\n | \"$contains\"\n | \"$gte\"\n | \"$lt\"\n | \"$lte\"\n | \"$within\"\n | \"$in\"\n | \"$intersects\"\n | \"$startsWith\"\n | \"$containsAllTermsInOrder\"\n | \"$containsAnyTerm\"\n | \"$containsAllTerms\";\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 \"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} satisfies Record<\n string,\n | \"CENTIMETERS\"\n | \"METERS\"\n | \"KILOMETERS\"\n | \"INCHES\"\n | \"FEET\"\n | \"YARDS\"\n | \"MILES\"\n | \"NAUTICAL_MILES\"\n>;\n\nexport type GeoFilter_Within = {\n \"$within\":\n | {\n $distance: [number, keyof typeof DistanceUnitMapping];\n $of: [number, number] | Readonly<Point>;\n $bbox?: never;\n $polygon?: never;\n }\n | {\n $bbox: BBox;\n $distance?: never;\n $of?: never;\n $polygon?: never;\n }\n | BBox\n | {\n $polygon: Polygon[\"coordinates\"];\n $bbox?: never;\n $distance?: never;\n $of?: never;\n }\n | Polygon;\n};\n\nexport type GeoFilter_Intersects = {\n \"$intersects\":\n | {\n $bbox: BBox;\n $polygon?: never;\n }\n | BBox\n | {\n $polygon: Polygon[\"coordinates\"];\n $bbox?: never;\n }\n | Polygon;\n};\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n true\n ? (PD[\"type\"] extends Record<string, BaseWirePropertyTypes>\n ? ArrayFilter<StructArrayFilterOpts<PD[\"type\"]>>\n : PD[\"type\"] extends PropertyTypesRepresentedAsStringsForArrayWhereClause\n ? ArrayFilter<string>\n : (PD[\"type\"] extends boolean ? ArrayFilter<boolean>\n : ArrayFilter<number>))\n : PD[\"type\"] extends Record<string, BaseWirePropertyTypes> ?\n | StructFilter<PD[\"type\"]>\n | BaseFilter.$isNull<string>\n : (PD[\"type\"] extends \"string\" ? StringFilter\n : PD[\"type\"] extends \"geopoint\" | \"geoshape\" ? GeoFilter\n : PD[\"type\"] extends \"datetime\" | \"timestamp\" ? DatetimeFilter\n : PD[\"type\"] extends \"boolean\" ? BooleanFilter\n : PD[\"type\"] extends WhereClauseNumberPropertyTypes ? NumberFilter\n : BaseFilter<string>); // FIXME we need to represent all types\n\ntype StructArrayFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {\n [K in keyof ST]?: FilterFor<{ \"type\": ST[K] }>;\n};\n\ntype StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {\n [K in keyof ST]?: FilterFor<{ \"type\": ST[K] }>;\n};\ntype StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {\n [K in keyof ST]: Just<K, StructFilterOpts<ST>>;\n}[keyof ST];\n\ntype PropertyTypesRepresentedAsStringsForArrayWhereClause =\n | \"string\"\n | \"geopoint\"\n | \"geoshape\"\n | \"datetime\"\n | \"timestamp\";\ntype WhereClauseNumberPropertyTypes =\n | \"double\"\n | \"integer\"\n | \"long\"\n | \"float\"\n | \"decimal\"\n | \"byte\";\n\nexport type AndWhereClause<\n T extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n $and: WhereClause<T, RDPs>[];\n};\n\nexport type OrWhereClause<\n T extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n $or: WhereClause<T, RDPs>[];\n};\n\nexport type NotWhereClause<\n T extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n $not: WhereClause<T, RDPs>;\n};\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n CompileTimeMetadata<T>[\"properties\"][P]\n >;\n};\n\ntype MergedPropertyWhereClause<\n T extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = {},\n> = PropertyWhereClause<\n DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>\n>;\n\nexport type WhereClause<\n T extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n | OrWhereClause<T, RDPs>\n | AndWhereClause<T, RDPs>\n | NotWhereClause<T, RDPs>\n | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n ? Record<string, never>\n : MergedPropertyWhereClause<T, RDPs>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;AACA;AACA,OAAO,MAAMA,mBAqBZ,GAAG;EACF,YAAY,EAAE,aAAa;EAC3B,aAAa,EAAE,aAAa;EAC5B,IAAI,EAAE,aAAa;EACnB,OAAO,EAAE,QAAQ;EACjB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,QAAQ;EACb,WAAW,EAAE,YAAY;EACzB,YAAY,EAAE,YAAY;EAC1B,IAAI,EAAE,YAAY;EAClB,MAAM,EAAE,QAAQ;EAChB,QAAQ,EAAE,QAAQ;EAClB,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,eAAe,EAAE,gBAAgB;EACjC,cAAc,EAAE,gBAAgB;EAChC,gBAAgB,EAAE;AACpB,CAUC;;AAwD0B","ignoreList":[]}
|
package/build/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["NULL_VALUE","DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n ActionEditResponse,\n ActionParam,\n ActionValidationResponse,\n ApplyActionOptions,\n ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport { NULL_VALUE } from \"./actions/NullValue.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n GeoFilter_Intersects,\n GeoFilter_Within,\n PossibleWhereClauseFilters,\n WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type {\n OsdkObjectCreatePropertyType,\n OsdkObjectPropertyType,\n} from \"./Definitions.js\";\nexport type {\n OsdkObjectLinksObject,\n SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type
|
|
1
|
+
{"version":3,"file":"index.js","names":["NULL_VALUE","DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n ActionEditResponse,\n ActionParam,\n ActionValidationResponse,\n ApplyActionOptions,\n ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport { NULL_VALUE } from \"./actions/NullValue.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n AndWhereClause,\n GeoFilter_Intersects,\n GeoFilter_Within,\n NotWhereClause,\n OrWhereClause,\n PossibleWhereClauseFilters,\n WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type {\n OsdkObjectCreatePropertyType,\n OsdkObjectPropertyType,\n} from \"./Definitions.js\";\nexport type {\n OsdkObjectLinksObject,\n SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport { type DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n AllGroupByValues,\n GroupByClause,\n GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type { Logger } from \"./Logger.js\";\nexport type {\n AllowedBucketKeyTypes,\n AllowedBucketTypes,\n DataValueClientToWire,\n DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n AsyncIterArgs,\n Augment,\n Augments,\n FetchPageArgs,\n NullabilityAdherence,\n ObjectSetArgs,\n SelectArg,\n SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n FetchPageResult,\n SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type {\n Media,\n MediaMetadata,\n MediaReference,\n MediaUpload,\n} from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetSubscription } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n ActionDefinition,\n ActionMetadata,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n InterfaceDefinition,\n InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n ObjectOrInterfaceDefinition,\n PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nexport type {\n CompileTimeMetadata,\n ObjectMetadata,\n ObjectTypeDefinition,\n PropertyDef,\n VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n InterfaceQueryDataType,\n ObjectQueryDataType,\n ObjectSetQueryDataType,\n QueryDataTypeDefinition,\n QueryDefinition,\n QueryMetadata,\n QueryParameterDefinition,\n ThreeDimensionalQueryAggregationDefinition,\n TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nexport type { PropertyBooleanFormattingRule } from \"./ontology/valueFormatting/PropertyBooleanFormattingRule.js\";\nexport type {\n DatetimeFormat,\n DatetimeLocalizedFormat,\n DatetimeLocalizedFormatType,\n DatetimeStringFormat,\n DatetimeTimezone,\n DatetimeTimezoneStatic,\n DatetimeTimezoneUser,\n PropertyDateFormattingRule,\n PropertyTimestampFormattingRule,\n} from \"./ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js\";\nexport type {\n KnownType,\n PropertyKnownTypeFormattingRule,\n} from \"./ontology/valueFormatting/PropertyKnownTypeFormattingRule.js\";\nexport type {\n Affix,\n DurationBaseValue,\n DurationFormatStyle,\n DurationPrecision,\n HumanReadableFormat,\n NumberFormatAffix,\n NumberFormatCurrency,\n NumberFormatCurrencyStyle,\n NumberFormatCustomUnit,\n NumberFormatDuration,\n NumberFormatFixedValues,\n NumberFormatNotation,\n NumberFormatOptions,\n NumberFormatRatio,\n NumberFormatScale,\n NumberFormatStandard,\n NumberFormatStandardUnit,\n NumberRatioType,\n NumberRoundingMode,\n NumberScaleType,\n PropertyNumberFormattingRule,\n PropertyNumberFormattingRuleType,\n TimeCodeFormat,\n} from \"./ontology/valueFormatting/PropertyNumberFormattingRule.js\";\nexport type { PropertyValueFormattingRule } from \"./ontology/valueFormatting/PropertyValueFormattingRule.js\";\nexport type {\n PropertyTypeReference,\n PropertyTypeReferenceOrStringConstant,\n StringConstant,\n} from \"./ontology/valueFormatting/PropertyValueFormattingUtils.js\";\nexport type {\n BaseWirePropertyTypes,\n WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n ObjectIdentifiers,\n OsdkBase,\n PrimaryKeyType,\n} from \"./OsdkBase.js\";\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, MaybeScore, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type {\n Range,\n ThreeDimensionalAggregation,\n TwoDimensionalAggregation,\n} from \"./queries/Aggregations.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n GeotimeSeriesProperty,\n TimeSeriesPoint,\n TimeSeriesProperty,\n TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,UAAU,QAAQ,wBAAwB;AASnD,SAASC,mBAAmB,QAAQ,4BAA4B;AAmBhE,SAASC,eAAe,QAAQ,4BAA4B;AAqC5D,SAASC,IAAI,QAAQ,oBAAoB;;AA+FzC;;AAUA,SAASC,yBAAyB,QAAQ,4BAA4B;AAQtE","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PropertyValueMapping.js","names":[],"sources":["PropertyValueMapping.ts"],"sourcesContent":["/*\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 type { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { Media } from \"../object/Media.js\";\nimport type {\n GeotimeSeriesProperty,\n TimeSeriesProperty,\n} from \"../timeseries/timeseries.js\";\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we return\n */\nexport interface PropertyValueWireToClient {\n attachment: Attachment;\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string;\n marking: string;\n mediaReference: Media;\n short: number;\n string: string;\n timestamp: string;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\n\nexport type GetClientPropertyValueFromWire<\n T extends\n | keyof PropertyValueWireToClient\n | Record<string, keyof PropertyValueWireToClient>,\n> = T extends keyof PropertyValueWireToClient ? PropertyValueWireToClient[T]\n : T extends Record<string, keyof PropertyValueWireToClient>\n ? { [K in keyof T]: PropertyValueWireToClient[T[K]] }\n : never;\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we accept\n */\nexport interface PropertyValueClientToWire {\n attachment: string | AttachmentUpload | Blob & { readonly name: string };\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string | number;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string | number;\n marking: string;\n short: number;\n string: string;\n timestamp: string;\n mediaReference: Media;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\nexport type GetWirePropertyValueFromClient<\n T extends\n | keyof PropertyValueClientToWire\n | Record<string, keyof PropertyValueClientToWire>,\n> = T extends keyof PropertyValueClientToWire ? PropertyValueClientToWire[T]\n : T extends Record<string, keyof PropertyValueClientToWire>\n ? { [K in keyof T]: PropertyValueClientToWire[T[K]] }\n : never;\n\nexport interface PropertyValueWireToCreate {\n attachment: Attachment | string;\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string;\n marking: string;\n mediaReference: Media;\n short: number;\n string: string;\n timestamp: string;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\n\nexport type GetCreatePropertyValueFromWire<\n T extends\n | keyof PropertyValueWireToCreate\n | Record<string, keyof PropertyValueWireToCreate>,\n> = T extends keyof PropertyValueWireToCreate ? PropertyValueWireToCreate[T]\n : T extends Record<string, keyof PropertyValueWireToCreate>\n ? { [K in keyof T]: PropertyValueWireToCreate[T[K]] | undefined }\n : never;\n"],"mappings":"","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"PropertyValueMapping.js","names":[],"sources":["PropertyValueMapping.ts"],"sourcesContent":["/*\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 type { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { Media, MediaReference } from \"../object/Media.js\";\nimport type {\n GeotimeSeriesProperty,\n TimeSeriesProperty,\n} from \"../timeseries/timeseries.js\";\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we return\n */\nexport interface PropertyValueWireToClient {\n attachment: Attachment;\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string;\n marking: string;\n mediaReference: Media;\n short: number;\n string: string;\n timestamp: string;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\n\nexport type GetClientPropertyValueFromWire<\n T extends\n | keyof PropertyValueWireToClient\n | Record<string, keyof PropertyValueWireToClient>,\n> = T extends keyof PropertyValueWireToClient ? PropertyValueWireToClient[T]\n : T extends Record<string, keyof PropertyValueWireToClient>\n ? { [K in keyof T]: PropertyValueWireToClient[T[K]] }\n : never;\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we accept\n */\nexport interface PropertyValueClientToWire {\n attachment: string | AttachmentUpload | Blob & { readonly name: string };\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string | number;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string | number;\n marking: string;\n short: number;\n string: string;\n timestamp: string;\n mediaReference: Media;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\nexport type GetWirePropertyValueFromClient<\n T extends\n | keyof PropertyValueClientToWire\n | Record<string, keyof PropertyValueClientToWire>,\n> = T extends keyof PropertyValueClientToWire ? PropertyValueClientToWire[T]\n : T extends Record<string, keyof PropertyValueClientToWire>\n ? { [K in keyof T]: PropertyValueClientToWire[T[K]] }\n : never;\n\nexport interface PropertyValueWireToCreate {\n attachment: Attachment | string;\n boolean: boolean;\n byte: number;\n datetime: string;\n decimal: string;\n double: number;\n float: number;\n geopoint: GeoJSON.Point;\n geoshape: GeoJSON.GeoJSON;\n integer: number;\n long: string;\n marking: string;\n mediaReference: Media | MediaReference;\n short: number;\n string: string;\n timestamp: string;\n numericTimeseries: TimeSeriesProperty<number>;\n stringTimeseries: TimeSeriesProperty<string>;\n sensorTimeseries: TimeSeriesProperty<string | number>;\n geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n vector: number[];\n}\n\nexport type GetCreatePropertyValueFromWire<\n T extends\n | keyof PropertyValueWireToCreate\n | Record<string, keyof PropertyValueWireToCreate>,\n> = T extends keyof PropertyValueWireToCreate ? PropertyValueWireToCreate[T]\n : T extends Record<string, keyof PropertyValueWireToCreate>\n ? { [K in keyof T]: PropertyValueWireToCreate[T[K]] | undefined }\n : never;\n"],"mappings":"","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Media.js","names":[],"sources":["Media.ts"],"sourcesContent":["/*\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 interface Media {\n /**\n * Fetches metadata for media reference property\n */\n fetchMetadata(): Promise<MediaMetadata>;\n /**\n * Fetches content of a media reference property\n */\n fetchContents(): Promise<Response>;\n /**\n * Returns the media reference\n */\n getMediaReference(): MediaReference;\n}\n\n/**\n * Unique identifier of a media item in Foundry.\n */\nexport interface MediaReference {\n mimeType: string;\n reference: {\n type: \"mediaSetViewItem\";\n mediaSetViewItem: {\n mediaItemRid: string;\n mediaSetRid: string;\n mediaSetViewRid: string;\n readToken?: string;\n };\n };\n}\n\n/**\n * Object for uploading Media\n */\nexport interface MediaUpload {\n readonly
|
|
1
|
+
{"version":3,"file":"Media.js","names":[],"sources":["Media.ts"],"sourcesContent":["/*\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 interface Media {\n /**\n * Fetches metadata for media reference property\n */\n fetchMetadata(): Promise<MediaMetadata>;\n /**\n * Fetches content of a media reference property\n */\n fetchContents(): Promise<Response>;\n /**\n * Returns the media reference\n */\n getMediaReference(): MediaReference;\n}\n\n/**\n * Unique identifier of a media item in Foundry.\n */\nexport interface MediaReference {\n mimeType: string;\n reference: {\n type: \"mediaSetViewItem\";\n mediaSetViewItem: {\n mediaItemRid: string;\n mediaSetRid: string;\n mediaSetViewRid: string;\n readToken?: string;\n };\n };\n}\n\n/**\n * Object for uploading Media\n */\nexport interface MediaUpload {\n readonly fileName: string;\n readonly data: Blob;\n}\n\n/**\n * Metadata of a media item\n */\nexport interface MediaMetadata {\n path?: string;\n sizeBytes: number;\n mediaType: string;\n}\n"],"mappings":"","ignoreList":[]}
|