@osdk/api 2.1.0-beta.8 → 2.1.0-rc.32

package/build/cjs/index.cjs

@@ -0,0 +1,75 @@
+'use strict';
+
+// src/aggregate/WhereClause.ts
+var DistanceUnitMapping = {
+  "centimeter": "CENTIMETERS",
+  "centimeters": "CENTIMETERS",
+  "cm": "CENTIMETERS",
+  "meter": "METERS",
+  "meters": "METERS",
+  "m": "METERS",
+  "kilometer": "KILOMETERS",
+  "kilometers": "KILOMETERS",
+  "km": "KILOMETERS",
+  "inch": "INCHES",
+  "inches": "INCHES",
+  "foot": "FEET",
+  "feet": "FEET",
+  "yard": "YARDS",
+  "yards": "YARDS",
+  "mile": "MILES",
+  "miles": "MILES",
+  "nautical_mile": "NAUTICAL_MILES",
+  "nauticalMile": "NAUTICAL_MILES",
+  "nautical miles": "NAUTICAL_MILES"
+};
+
+// src/mapping/DurationMapping.ts
+var TimeDurationMapping = {
+  "sec": "SECONDS",
+  "seconds": "SECONDS",
+  "min": "MINUTES",
+  "minute": "MINUTES",
+  "minutes": "MINUTES",
+  "hr": "HOURS",
+  "hrs": "HOURS",
+  "hour": "HOURS",
+  "hours": "HOURS",
+  "day": "DAYS",
+  "days": "DAYS",
+  "wk": "WEEKS",
+  "week": "WEEKS",
+  "weeks": "WEEKS",
+  "mos": "MONTHS",
+  "month": "MONTHS",
+  "months": "MONTHS",
+  "yr": "YEARS",
+  "year": "YEARS",
+  "years": "YEARS"
+};
+
+// src/groupby/GroupByClause.ts
+var DurationMapping = {
+  ...TimeDurationMapping,
+  "quarter": "QUARTERS",
+  "quarters": "QUARTERS"
+};
+
+// src/object/Result.ts
+function isOk(a) {
+  return "value" in a;
+}
+
+// src/timeseries/timeseries.ts
+var TimeseriesDurationMapping = {
+  "ms": "MILLISECONDS",
+  "milliseconds": "MILLISECONDS",
+  ...TimeDurationMapping
+};
+
+exports.DistanceUnitMapping = DistanceUnitMapping;
+exports.DurationMapping = DurationMapping;
+exports.TimeseriesDurationMapping = TimeseriesDurationMapping;
+exports.isOk = isOk;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/build/cjs/index.cjs.map

@@ -0,0 +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};"]}

package/build/cjs/index.d.cts

@@ -0,0 +1,416 @@
+import { A as Attachment, M as MediaReference, a as AttachmentUpload, O as ObjectTypeDefinition, b as OsdkBase, c as OsdkObjectPrimaryKeyType, d as ObjectSet, I as InterfaceDefinition, R as ReleaseStatus, e as OsdkMetadata, P as PropertyValueWireToClient, f as PrimaryKeyTypes } from './ObjectSet-BPh3Vefb.cjs';
+export { g as AggregateOpts, h as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, k as AggregationClause, i as AggregationResultsWithGroups, j as AggregationResultsWithoutGroups, l as AggregationsResults, s as AllGroupByValues, v as AsyncIterArgs, w as Augment, x as Augments, L as BaseObjectSet, a0 as BaseWirePropertyTypes, Y as CompileTimeMetadata, a3 as ConvertProps, D as DistanceUnitMapping, r as DurationMapping, F as FetchPageArgs, B as FetchPageResult, G as GeoFilterOptions, m as GeoFilter_Intersects, n as GeoFilter_Within, a7 as GeotimeSeriesProperty, t as GroupByClause, u as GroupByRange, T as InterfaceMetadata, ac as LinkNames, ab as LinkedType, E as Media, H as MediaMetadata, N as NullabilityAdherence, Z as ObjectMetadata, U as ObjectOrInterfaceDefinition, Q as ObjectSetSubscription, a4 as Osdk, q as OsdkObjectLinksObject, p as OsdkObjectPropertyType, a5 as PageResult, o as PossibleWhereClauseFilters, a2 as PrimaryKeyType, _ as PropertyDef, X as PropertyKeys, K as Result, y as SelectArg, z as SelectArgToKeys, S as SingleLinkAccessor, C as SingleOsdkResult, a8 as TimeSeriesPoint, a9 as TimeSeriesProperty, aa as TimeSeriesQuery, a6 as TimeseriesDurationMapping, V as ValidAggregationKeys, $ as VersionBound, W as WhereClause, a1 as WirePropertyTypes, J as isOk } from './ObjectSet-BPh3Vefb.cjs';
+import 'type-fest';
+import 'geojson';
+
+/**
+ * Map from the DataValue type to the typescript type that we return
+ */
+interface DataValueWireToClient {
+    attachment: Attachment;
+    boolean: boolean;
+    byte: number;
+    datetime: string;
+    date: string;
+    decimal: string;
+    float: number;
+    double: number;
+    integer: number;
+    long: string;
+    marking: string;
+    null: null;
+    short: number;
+    string: string;
+    timestamp: string;
+    mediaReference: MediaReference;
+    twoDimensionalAggregation: {
+        key: AllowedBucketKeyTypes$1;
+        value: AllowedBucketTypes$1;
+    }[];
+    threeDimensionalAggregation: {
+        key: AllowedBucketKeyTypes$1;
+        groups: {
+            key: AllowedBucketKeyTypes$1;
+            value: AllowedBucketTypes$1;
+        }[];
+    }[];
+    struct: Record<string, any>;
+    set: Set<any>;
+    objectType: string;
+}
+/**
+ * Map from the DataValue type to the typescript type that we accept
+ */
+interface DataValueClientToWire {
+    attachment: string | AttachmentUpload | Blob & {
+        readonly name: string;
+    };
+    boolean: boolean;
+    byte: number;
+    datetime: string;
+    date: string;
+    decimal: string | number;
+    float: number;
+    double: number;
+    integer: number;
+    long: string | number;
+    marking: string;
+    null: null;
+    short: number;
+    string: string;
+    timestamp: string;
+    set: Set<any>;
+    mediaReference: MediaReference;
+    twoDimensionalAggregation: {
+        key: AllowedBucketKeyTypes$1;
+        value: AllowedBucketTypes$1;
+    }[];
+    threeDimensionalAggregation: {
+        key: AllowedBucketKeyTypes$1;
+        groups: {
+            key: AllowedBucketKeyTypes$1;
+            value: AllowedBucketTypes$1;
+        }[];
+    }[];
+    struct: Record<string, any>;
+    objectType: string;
+}
+type AllowedBucketTypes$1 = string | number | boolean;
+type AllowedBucketKeyTypes$1 = AllowedBucketTypes$1 | {
+    startValue: AllowedBucketTypes$1;
+    endValue: AllowedBucketTypes$1;
+};
+
+type ActionResults = (ObjectEdits | LargeScaleObjectEdits) & {
+    editedObjectTypes: Array<String>;
+};
+interface ObjectEdits {
+    type: "edits";
+    addedObjects: Array<ObjectReference>;
+    modifiedObjects: Array<ObjectReference>;
+    addedLinks: Array<LinkReference>;
+    deletedObjectsCount: number;
+    deletedLinksCount: number;
+}
+interface LargeScaleObjectEdits {
+    type: "largeScaleEdits";
+    addedObjects?: never;
+    modifiedObjects?: never;
+    addedLinks?: never;
+    deletedObjectsCount?: never;
+    deletedLinksCount?: never;
+}
+type LinkReference = {
+    linkTypeApiNameAtoB: string;
+    linkTypeApiNameBtoA: string;
+    aSideObject: ObjectReference;
+    bSideObject: ObjectReference;
+};
+interface ObjectReference {
+    primaryKey: string | number;
+    objectType: string;
+}
+interface ValidateActionResponseV2 {
+    result: "VALID" | "INVALID";
+    submissionCriteria: Array<{
+        configuredFailureMessage?: string;
+        result: "VALID" | "INVALID";
+    }>;
+    parameters: Record<string, {
+        result: "VALID" | "INVALID";
+        evaluatedConstraints: Array<ParameterEvaluatedConstraint>;
+        required: boolean;
+    }>;
+}
+type ParameterEvaluatedConstraint = {
+    type: "arraySize";
+    lt?: any;
+    lte?: any;
+    gt?: any;
+    gte?: any;
+} | {
+    type: "groupMember";
+} | {
+    type: "objectPropertyValue";
+} | {
+    type: "objectQueryResult";
+} | {
+    type: "oneOf";
+    options: Array<{
+        displayName?: string;
+        value?: any;
+    }>;
+    otherValuesAllowed: boolean;
+} | {
+    type: "range";
+    lt?: any;
+    lte?: any;
+    gt?: any;
+    gte?: any;
+} | {
+    type: "stringLength";
+    lt?: any;
+    lte?: any;
+    gt?: any;
+    gte?: any;
+} | {
+    type: "stringRegexMatch";
+    regex: string;
+    configuredFailureMessage?: string;
+} | {
+    type: "unevaluable";
+};
+
+type ApplyActionOptions = {
+    $returnEdits?: true;
+    $validateOnly?: false;
+} | {
+    $validateOnly?: true;
+    $returnEdits?: false;
+};
+type ApplyBatchActionOptions = {
+    $returnEdits?: boolean;
+};
+/**
+ * Helper types for converting action definition parameter types to typescript types
+ */
+declare namespace ActionParam {
+    /**
+     * Helper type to convert action definition parameter primitives to typescript types
+     */
+    type PrimitiveType<T extends keyof DataValueClientToWire> = DataValueClientToWire[T];
+    /**
+     * Helper type to convert action definition parameter object types to typescript types
+     */
+    type ObjectType<T extends ObjectTypeDefinition> = OsdkBase<T> | OsdkObjectPrimaryKeyType<T>;
+    /**
+     * Helper type to convert action definition parameter object sets to typescript types
+     */
+    type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;
+    /**
+     * Helper type to convert action definition parameter interface types to typescript types
+     */
+    type InterfaceType<T extends InterfaceDefinition> = {
+        $objectType: NonNullable<T["__DefinitionMetadata"]> extends {
+            implementedBy: infer U;
+        } ? (U extends ReadonlyArray<string> ? U[number] : string) : string;
+        $primaryKey: string | number;
+    };
+    type StructType<T extends Record<string, keyof DataValueClientToWire>> = {
+        [K in keyof T]: DataValueClientToWire[T[K]];
+    };
+}
+type ActionEditResponse = ActionResults;
+type ActionValidationResponse = ValidateActionResponseV2;
+
+type ActionReturnTypeForOptions<Op extends ApplyActionOptions | ApplyBatchActionOptions> = Op extends {
+    $validateOnly: true;
+} ? ActionValidationResponse : Op extends {
+    $returnEdits: true;
+} ? ActionEditResponse : undefined;
+
+interface ActionMetadata {
+    type: "action";
+    apiName: string;
+    description?: string;
+    displayName?: string;
+    parameters: Record<any, ActionMetadata.Parameter<any>>;
+    modifiedEntities?: Partial<Record<any, {
+        created: boolean;
+        modified: boolean;
+    }>>;
+    status: ReleaseStatus;
+    rid: string;
+}
+declare namespace ActionMetadata {
+    interface Parameter<T_Target extends ObjectTypeDefinition = never> {
+        type: DataType.BaseActionParameterTypes | DataType.Object<any> | DataType.ObjectSet<any> | DataType.Interface<any> | DataType.Struct<any>;
+        description?: string;
+        multiplicity?: boolean;
+        nullable?: boolean;
+    }
+    namespace DataType {
+        type BaseActionParameterTypes = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking" | "mediaReference" | "objectType";
+        interface Object<T_Target extends ObjectTypeDefinition = never> {
+            __OsdkTargetType?: T_Target;
+            type: "object";
+            object: T_Target["apiName"];
+        }
+        interface Interface<T_Target extends InterfaceDefinition = never> {
+            __OsdkTargetType?: T_Target;
+            type: "interface";
+            interface: T_Target["apiName"];
+        }
+        interface ObjectSet<T_Target extends ObjectTypeDefinition = never> {
+            __OsdkTargetType?: T_Target;
+            type: "objectSet";
+            objectSet: T_Target["apiName"];
+        }
+        interface Struct<T extends Record<string, DataType.BaseActionParameterTypes>> {
+            type: "struct";
+            struct: T;
+        }
+    }
+}
+interface ActionCompileTimeMetadata<T> {
+    signatures: T;
+}
+interface ActionDefinition<T_signatures = never> {
+    type: "action";
+    apiName: string;
+    osdkMetadata?: OsdkMetadata;
+    __DefinitionMetadata?: ActionCompileTimeMetadata<T_signatures> & ActionMetadata;
+}
+
+interface OntologyMetadata<_NEVER_USED_KEPT_FOR_BACKCOMPAT = any> {
+    expectsClientVersion?: _NEVER_USED_KEPT_FOR_BACKCOMPAT;
+    ontologyRid: string;
+    ontologyApiName: string;
+    userAgent: string;
+}
+
+interface QueryMetadata {
+    type: "query";
+    apiName: string;
+    description?: string;
+    displayName?: string;
+    version: string;
+    parameters: Record<string, QueryParameterDefinition<any>>;
+    output: QueryDataTypeDefinition;
+    rid: string;
+}
+interface QueryCompileTimeMetadata<T> {
+    signature: T;
+}
+interface QueryDefinition<T = any> {
+    type: "query";
+    apiName: string;
+    osdkMetadata?: OsdkMetadata;
+    __DefinitionMetadata?: QueryCompileTimeMetadata<T> & QueryMetadata;
+}
+type QueryParameterDefinition<T_Target extends ObjectTypeDefinition = any> = {
+    description?: string;
+} & QueryDataTypeDefinition<T_Target>;
+type QueryDataTypeDefinition<T_Target extends ObjectTypeDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
+type BaseQueryDataTypeDefinition<T extends string> = {
+    multiplicity?: boolean;
+    nullable?: boolean;
+    type: T;
+};
+type WireQueryDataTypes = "double" | "float" | "integer" | "long" | "boolean" | "string" | "date" | "timestamp" | "attachment";
+type PrimitiveDataType<Q extends WireQueryDataTypes = WireQueryDataTypes> = BaseQueryDataTypeDefinition<Q>;
+interface ObjectQueryDataType<T_Target extends ObjectTypeDefinition = never> extends BaseQueryDataTypeDefinition<"object"> {
+    object: string;
+    __OsdkTargetType?: T_Target;
+}
+interface ObjectSetQueryDataType<T_Target extends ObjectTypeDefinition = never> extends BaseQueryDataTypeDefinition<"objectSet"> {
+    objectSet: string;
+    __OsdkTargetType?: T_Target;
+}
+interface SetQueryDataType extends BaseQueryDataTypeDefinition<"set"> {
+    set: QueryDataTypeDefinition;
+}
+interface UnionQueryDataType extends BaseQueryDataTypeDefinition<"union"> {
+    union: ReadonlyArray<QueryDataTypeDefinition>;
+}
+interface StructQueryDataType extends BaseQueryDataTypeDefinition<"struct"> {
+    struct: Record<string, QueryDataTypeDefinition>;
+}
+interface TwoDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"twoDimensionalAggregation"> {
+    twoDimensionalAggregation: TwoDimensionalQueryAggregationDefinition;
+}
+interface ThreeDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"threeDimensionalAggregation"> {
+    threeDimensionalAggregation: ThreeDimensionalQueryAggregationDefinition;
+}
+type AggregationKeyDataType<V = any> = SimpleAggregationKeyDataType<V> | RangeAggregationKeyDataType<V>;
+interface SimpleAggregationKeyDataType<V = any> {
+    keyType: Exclude<AggregationKeyTypes, "range">;
+    valueType: V;
+}
+interface RangeAggregationKeyDataType<V = any> {
+    keyType: "range";
+    keySubtype: AggregationRangeKeyTypes;
+    valueType: V;
+}
+type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<AggregationValueTypes>;
+type ThreeDimensionalQueryAggregationDefinition = AggregationKeyDataType<TwoDimensionalQueryAggregationDefinition>;
+type AggregationKeyTypes = "boolean" | "string" | "date" | "double" | "integer" | "timestamp" | "range";
+type AggregationRangeKeyTypes = "date" | "double" | "integer" | "timestamp";
+type AggregationValueTypes = "date" | "double" | "timestamp";
+
+/**
+ * @deprecated Use OsdkBase
+ */
+type OsdkObject<N extends string> = {
+    readonly $apiName: N;
+    readonly $objectType: string;
+    readonly $primaryKey: PropertyValueWireToClient[PrimaryKeyTypes];
+};
+
+type Range<T extends AllowedBucketTypes> = {
+    startValue?: T;
+    endValue: T;
+} | {
+    startValue: T;
+    endValue?: T;
+};
+type AllowedBucketTypes = string | number | boolean;
+type AllowedBucketKeyTypes = AllowedBucketTypes | Range<AllowedBucketTypes>;
+type TwoDimensionalAggregation<T extends AllowedBucketKeyTypes, U extends AllowedBucketTypes> = {
+    key: T;
+    value: U;
+}[];
+type ThreeDimensionalAggregation<T extends AllowedBucketKeyTypes, U extends AllowedBucketKeyTypes, V extends AllowedBucketTypes> = {
+    key: T;
+    groups: {
+        key: U;
+        value: V;
+    }[];
+}[];
+type AggKeyWireToClient<T extends AggregationKeyTypes, S extends AggregationRangeKeyTypes = never> = T extends keyof DataValueWireToClient ? DataValueWireToClient[T] : T extends "range" ? S extends keyof DataValueWireToClient ? Range<DataValueWireToClient[S]> : never : never;
+type AggKeyClientToWire<T extends AggregationKeyTypes, S extends AggregationRangeKeyTypes = never> = T extends keyof DataValueClientToWire ? DataValueClientToWire[T] : T extends "range" ? S extends keyof DataValueClientToWire ? Range<DataValueClientToWire[S]> : never : never;
+type AggValueWireToClient<T extends AggregationValueTypes> = T extends keyof DataValueWireToClient ? DataValueWireToClient[T] : never;
+type AggValueClientToWire<T extends AggregationValueTypes> = T extends keyof DataValueClientToWire ? DataValueClientToWire[T] : never;
+
+/**
+ * Helper types for converting query definition parameter types to typescript types
+ */
+declare namespace QueryParam {
+    /**
+     * Helper type to convert action definition parameter primitives to typescript types
+     */
+    type PrimitiveType<T extends keyof DataValueClientToWire> = DataValueClientToWire[T];
+    /**
+     * Helper type to convert action definition parameter object types to typescript types
+     */
+    type ObjectType<T extends ObjectTypeDefinition> = OsdkBase<T> | OsdkObjectPrimaryKeyType<T>;
+    /**
+     * Helper type to convert action definition parameter object sets to typescript types
+     */
+    type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;
+    type RangeKey<T extends AggregationRangeKeyTypes> = AggKeyClientToWire<"range", T>;
+    type TwoDimensionalAggregationType<T extends AggregationKeyTypes | RangeKey<any>, V extends AggregationValueTypes> = TwoDimensionalAggregation<T extends AggregationKeyTypes ? AggKeyClientToWire<T> : T, AggValueClientToWire<V>>;
+    type ThreeDimensionalAggregationType<OUT extends AggregationKeyTypes | RangeKey<any>, IN extends AggregationKeyTypes | RangeKey<any>, V extends AggregationValueTypes> = ThreeDimensionalAggregation<OUT extends AggregationKeyTypes ? AggKeyClientToWire<OUT> : OUT, IN extends AggregationKeyTypes ? AggKeyClientToWire<IN> : IN, AggValueClientToWire<V>>;
+}
+/**
+ * Helper types for converting query result types to typescript types
+ */
+declare namespace QueryResult {
+    /**
+     * Helper type to convert action definition parameter primitives to typescript types
+     */
+    type PrimitiveType<T extends keyof DataValueClientToWire> = DataValueWireToClient[T];
+    /**
+     * Helper type to convert action definition parameter object types to typescript types
+     */
+    type ObjectType<T extends ObjectTypeDefinition> = OsdkBase<T>;
+    /**
+     * Helper type to convert action definition parameter object sets to typescript types
+     */
+    type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;
+    type RangeKey<T extends AggregationRangeKeyTypes> = AggKeyWireToClient<"range", T>;
+    type TwoDimensionalAggregationType<T extends AggregationKeyTypes | RangeKey<any>, V extends AggregationValueTypes> = TwoDimensionalAggregation<T extends AggregationKeyTypes ? AggKeyWireToClient<T> : T, AggValueWireToClient<V>>;
+    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>>;
+}
+
+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, type DataValueClientToWire, type DataValueWireToClient, InterfaceDefinition, MediaReference, 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 ThreeDimensionalQueryAggregationDefinition, type TwoDimensionalQueryAggregationDefinition };

package/build/cjs/public/unstable.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+// src/experimental/createMediaReference.ts
+var __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = {
+  name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference",
+  type: "experiment",
+  version: "2.1.0"
+};
+
+// src/experimental/fetchOneByRid.ts
+var __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = {
+  name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid",
+  type: "experiment",
+  version: "2.1.0"
+};
+
+// src/experimental/getBulkLinks.ts
+var __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {
+  name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks",
+  type: "experiment",
+  version: "2.0.8"
+};
+
+exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference;
+exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid;
+exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks;
+//# sourceMappingURL=unstable.cjs.map
+//# sourceMappingURL=unstable.cjs.map

package/build/cjs/public/unstable.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/experimental/createMediaReference.ts","../../../src/experimental/fetchOneByRid.ts","../../../src/experimental/getBulkLinks.ts"],"names":[],"mappings":";;;AA6BO,IAAM,uDAA0D,GAAA;AAAA,EACrE,IAAM,EAAA,yDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACjBO,IAAM,gDAAmD,GAAA;AAAA,EAC9D,IAAM,EAAA,kDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACJO,IAAM,+CAAkD,GAAA;AAAA,EAC7D,IAAM,EAAA,iDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX","file":"unstable.cjs","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\n/**\n * @experimental This feature is experimental and might change in the future.\n *\n * Uploads a media item to the media property of the specified object type.\n *\n * @param data - Data to upload as media item\n * @param fileName - Name that will be assigned as path to the uploaded media item.\n * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.\n * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.\n *\n * @returns media reference of the uploaded media item.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n  type: \"experiment\",\n  version: \"2.1.0\"\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\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid\",\n  type: \"experiment\",\n  version: \"2.1.0\"\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\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks\",\n  type: \"experiment\",\n  version: \"2.0.8\"\n};"]}

package/build/cjs/public/unstable.d.cts

@@ -0,0 +1,53 @@
+import { M as MediaReference, O as ObjectTypeDefinition, X as PropertyKeys, N as NullabilityAdherence, y as SelectArg, a4 as Osdk, ad as ExtractOptions, b as OsdkBase, U as ObjectOrInterfaceDefinition } from '../ObjectSet-BPh3Vefb.cjs';
+export { ae as MinimalObjectSet } from '../ObjectSet-BPh3Vefb.cjs';
+import 'type-fest';
+import 'geojson';
+
+type Experiment<V extends string, T extends string = string, K extends Record<string, (...args: any[]) => any> = any> = {
+    type: "experiment";
+    name: T;
+    branded?: K;
+    version: V;
+};
+type ExperimentFns<B extends Experiment<string, string>> = NonNullable<B["branded"]>;
+
+/**
+ * @experimental This feature is experimental and might change in the future.
+ *
+ * Uploads a media item to the media property of the specified object type.
+ *
+ * @param data - Data to upload as media item
+ * @param fileName - Name that will be assigned as path to the uploaded media item.
+ * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.
+ * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.
+ *
+ * @returns media reference of the uploaded media item.
+ */
+type createMediaReference = (args: {
+    data: Blob;
+    fileName: string;
+    objectTypeApi: string;
+    propertyTypeApi: string;
+}) => Promise<MediaReference>;
+declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference: Experiment<"2.1.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference", {
+    createMediaReference: createMediaReference;
+}>;
+
+type fetchOneByRidFn = <Q extends ObjectTypeDefinition, const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(objectType: Q, rid: string, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
+declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid: Experiment<"2.1.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid", {
+    fetchOneByRid: fetchOneByRidFn;
+}>;
+
+interface EXPERIMENTAL_BulkLinkResult {
+    object: OsdkBase<any>;
+    linkApiName: string;
+    otherObjectApiName: string | undefined;
+    otherObjectPk: unknown;
+}
+
+type getBulkLinksFn = <T extends ObjectOrInterfaceDefinition>(objs: Osdk.Instance<T>[], links: string[]) => AsyncGenerator<EXPERIMENTAL_BulkLinkResult, void, undefined>;
+declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks: Experiment<"2.0.8", "__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks", {
+    getBulkLinks: getBulkLinksFn;
+}>;
+
+export { type EXPERIMENTAL_BulkLinkResult, type Experiment, type ExperimentFns, __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks };

package/build/esm/Definitions.js

@@ -1,17 +1,2 @@
-/*
- * Copyright 2023 Palantir Technologies, Inc. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 export {};
 //# sourceMappingURL=Definitions.js.map

package/build/esm/Definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Definitions.js","names":[],"sources":["Definitions.js"],"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 */\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"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} 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\nexport type OsdkObjectRawPropertyType<T extends ObjectMetadata.Property> =\n  MaybeNullable<\n    T,\n    MaybeArray<T, Raw<GetClientPropertyValueFromWire<T[\"type\"]>>>\n  >;\n"],"mappings":"","ignoreList":[]}

package/build/esm/OsdkBase.js

@@ -1,17 +1,2 @@
-/*
- * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 export {};
 //# sourceMappingURL=OsdkBase.js.map

package/build/esm/OsdkBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"OsdkBase.js","names":[],"sources":["OsdkBase.js"],"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 */\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"OsdkBase.js","names":[],"sources":["OsdkBase.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 { PropertyValueWireToClient } from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectOrInterfaceDefinition } from \"./ontology/ObjectOrInterface.js\";\nimport type { ObjectTypeDefinition } from \"./ontology/ObjectTypeDefinition.js\";\nimport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"./OsdkObjectPrimaryKeyType.js\";\n\nexport type OsdkBase<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly $apiName: Q[\"apiName\"];\n\n  readonly $objectType: string;\n\n  readonly $primaryKey: PrimaryKeyType<Q>;\n\n  readonly $title: string | undefined;\n};\n\nexport type PrimaryKeyType<Q extends ObjectOrInterfaceDefinition> =\n  & (Q extends ObjectTypeDefinition ? OsdkObjectPrimaryKeyType<Q>\n    : unknown)\n  // if the type is `unknown` then the next line will\n  // restrict it down to all valid primary key types\n  & PropertyValueWireToClient[PrimaryKeyTypes];\n"],"mappings":"","ignoreList":[]}