@osdk/api 0.0.0-20230929184205

package/src/client/query/aggregations/AggregationsClause.test.ts

@@ -0,0 +1,60 @@
+/*
+ * 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.
+ */
+
+import type { AggregatableKeys } from "./AggregatableKeys";
+import type { AggregationClause } from "./AggregationsClause";
+
+export type huh = AggregatableKeys<
+  {
+    metadata: any;
+    objects: {
+      Todo: {
+        apiName: "Todo";
+        links: {};
+        properties: {
+          text: {
+            type: "string";
+          };
+          id: {
+            type: "double";
+          };
+        };
+      };
+    };
+  },
+  "Todo"
+>;
+
+export type Q = AggregationClause<
+  {
+    metadata: any;
+    objects: {
+      Todo: {
+        apiName: "Todo";
+        links: {};
+        properties: {
+          text: {
+            type: "string";
+          };
+          id: {
+            type: "double";
+          };
+        };
+      };
+    };
+  },
+  "Todo"
+>;

package/src/client/query/aggregations/AggregationsClause.ts

@@ -0,0 +1,44 @@
+/*
+ * 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.
+ */
+
+import type {
+  ObjectTypesFrom,
+  OntologyDefinition,
+  PropertyDefinitionsFrom,
+} from "#ontology";
+import type { AggregatableKeys } from "./AggregatableKeys";
+
+type StringAggregateOption = "approximateDistinct";
+type NumericAggregateOption =
+  | "min"
+  | "max"
+  | "sum"
+  | "avg"
+  | "approximateDistinct";
+
+export type AggregationClause<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = {
+  [P in AggregatableKeys<O, K>]?: PropertyDefinitionsFrom<
+    O,
+    K
+  >[P]["type"] extends "string"
+    ? StringAggregateOption | StringAggregateOption[]
+    : PropertyDefinitionsFrom<O, K>[P]["type"] extends "double"
+      ? NumericAggregateOption | NumericAggregateOption[]
+    : PropertyDefinitionsFrom<O, K>[P]["type"];
+};

package/src/client/query/aggregations/AggregationsResults.test.ts

@@ -0,0 +1,74 @@
+/*
+ * 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.
+ */
+
+import type { AggregationResultsWithoutGroups } from "./AggregationResultsWithoutGroups";
+import type { AggregationsResults } from "./AggregationsResults";
+
+type T_AGG_RESULTS_TEST_1 = AggregationsResults<
+  {
+    metadata: any;
+    objects: {
+      Todo: {
+        apiName: "Todo";
+        links: {};
+        properties: {
+          text: {
+            type: "string";
+          };
+          id: {
+            type: "double";
+          };
+        };
+      };
+    };
+  },
+  "Todo",
+  {
+    select: {
+      locationCity: "approximateDistinct";
+      text: "approximateDistinct";
+    };
+    groupBy: {
+      text: "exact";
+    };
+  }
+>;
+
+type Q = AggregationResultsWithoutGroups<
+  {
+    metadata: any;
+    objects: {
+      Todo: {
+        apiName: "Todo";
+        links: {};
+        properties: {
+          text: {
+            type: "string";
+          };
+          id: {
+            type: "double";
+          };
+        };
+      };
+    };
+  },
+  "Todo",
+  {
+    locationCity: "approximateDistinct";
+    id: ["max", "sum"];
+    text: "approximateDistinct";
+  }
+>;

package/src/client/query/aggregations/AggregationsResults.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import type { ObjectTypesFrom, OntologyDefinition } from "#ontology";
+import type { AggregateOpts } from "./AggregateOpts";
+import type { AggregationResultsWithGroups } from "./AggregationResultsWithGroups";
+import type { AggregationResultsWithoutGroups } from "./AggregationResultsWithoutGroups";
+
+export type AggregationsResults<
+  T extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<T>,
+  AO extends AggregateOpts<T, K, any>,
+> = unknown extends AO["groupBy"] // groupBy is missing
+  ? AggregationResultsWithoutGroups<T, K, AO["select"]>
+  : Exclude<AO["groupBy"], undefined> extends never // groupBy is explicitly undefined
+    ? AggregationResultsWithoutGroups<T, K, AO["select"]>
+  : AggregationResultsWithGroups<T, K, AO["select"], AO["groupBy"]>;

package/src/client/query/aggregations/GroupByClause.test.ts

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+import type { GroupByClause } from "./GroupByClause";
+
+export type F = GroupByClause<
+  {
+    metadata: any;
+    objects: {
+      Todo: {
+        apiName: "Todo";
+        links: {};
+        properties: {
+          text: {
+            type: "string";
+          };
+          id: {
+            type: "double";
+          };
+        };
+      };
+    };
+  },
+  "Todo"
+>;

package/src/client/query/aggregations/GroupByClause.ts

@@ -0,0 +1,41 @@
+/*
+ * 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.
+ */
+
+import type {
+  ObjectTypesFrom,
+  OntologyDefinition,
+  PropertyDefinitionFrom,
+} from "#ontology";
+import type { AggregatableKeys } from "./AggregatableKeys";
+import type { GroupByMapper } from "./GroupByMapper";
+
+export type GroupByClause<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = {
+  [P in AggregatableKeys<O, K>]?: GroupByEntry<O, K, P>;
+};
+export type StringGroupByValue = "exact" | { exactWithLimit: number };
+
+type GroupByEntry<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+  P extends AggregatableKeys<O, K>,
+> = PropertyDefinitionFrom<O, K, P>["type"] extends keyof GroupByMapper
+  ? GroupByMapper[PropertyDefinitionFrom<O, K, P>["type"]]
+  : never;
+
+export type AllGroupByValues = GroupByMapper[keyof GroupByMapper];

package/src/client/query/aggregations/GroupByMapper.ts

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+import type { StringGroupByValue } from "./GroupByClause";
+
+export interface GroupByMapper {
+  string: StringGroupByValue;
+}

package/src/client/query/index.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 type * from "./aggregations/AggregatableKeys";
+export type * from "./aggregations/AggregationResultsWithGroups";
+export type * from "./aggregations/AggregationResultsWithoutGroups";
+export type * from "./aggregations/AggregationsClause";
+export type * from "./aggregations/AggregationsResults";
+export type {
+  AllGroupByValues,
+  GroupByClause,
+} from "./aggregations/GroupByClause";
+export type {
+  AndWhereClause,
+  NotWhereClause,
+  OrWhereClause,
+  PossibleWhereClauseFilters,
+  WhereClause,
+} from "./WhereClause";

package/src/index.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 type { WhereClause } from "#client/query";
+export type { OsdkObject } from "#ontology";
+export { createClient, createThinClient, isOk } from "./client";
+export type { Client, ObjectSet, ResultOrError, ThinClient } from "./client";
+
+// FIXME: Shoudl this be Objects or Object?
+export * as Objects from "./client/object";
+
+export type {
+  ObjectDefinition,
+  OntologyDefinition,
+} from "./ontology/Definition";

package/src/ontology/Definition.ts

@@ -0,0 +1,89 @@
+/*
+ * 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.
+ */
+
+import type { OntologyMetadata } from "./OntologyMetadata";
+
+export type ObjectInfoFrom<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = O["objects"][K];
+
+export type ObjectTypesFrom<O extends OntologyDefinition<string>> =
+  & keyof O["objects"]
+  & string;
+
+export type PropertyKeysFrom<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = keyof ObjectInfoFrom<O, K>["properties"] & string;
+
+export type PropertyDefinitionsFrom<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = ObjectInfoFrom<O, K>["properties"];
+
+export type PropertyDefinitionFrom<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+  P extends PropertyKeysFrom<O, K>,
+> = PropertyDefinitionsFrom<O, K>[P];
+
+export interface OntologyDefinition<K extends string> {
+  metadata: OntologyMetadata;
+  objects: {
+    [KK in K]: ObjectDefinition<KK, K>;
+  };
+}
+
+export interface ObjectDefinition<N extends K, K extends string> {
+  apiName: N;
+  properties: Record<string, PropertyDefinition>;
+  links: Record<string, LinkDefinition<K>>;
+}
+export interface LinkDefinition<K extends string> {
+  targetType: K;
+  multiplicity: boolean;
+}
+export interface PropertyDefinition {
+  readonly?: boolean;
+  type: keyof ValidPropertyTypes; // FIXME WHAT ARE THE TYPES
+  nullable?: boolean;
+}
+
+interface ValidPropertyTypes {
+  string: string;
+  datetime: Date;
+  double: number;
+  boolean: boolean;
+}
+
+export type OsdkObjectPropertyType<T extends PropertyDefinition> =
+  T["nullable"] extends false ? ValidPropertyTypes[T["type"]]
+    : ValidPropertyTypes[T["type"]] | undefined;
+
+export type OsdkObjectLink<
+  K extends string,
+  O extends OntologyDefinition<K>,
+  T extends LinkDefinition<any>,
+> = T["multiplicity"] extends true ? Array<OsdkObjectLink_Inner<K, O, T>>
+  : OsdkObjectLink_Inner<K, O, T>;
+
+type OsdkObjectLink_Inner<
+  K extends string,
+  O extends OntologyDefinition<K>,
+  T extends LinkDefinition<any>,
+> = T["targetType"] extends keyof O["objects"] ? O["objects"][T["targetType"]]
+  : never;

package/src/ontology/OntologyMetadata.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 interface OntologyMetadata {
+  ontologyRid: string;
+  ontologyApiName: string;
+  userAgent: string;
+}

package/src/ontology/OsdkObject.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 type OsdkObject<N extends string> = { __name: N };

package/src/ontology/OsdkObjectFrom.ts

@@ -0,0 +1,33 @@
+/*
+ * 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.
+ */
+
+import type {
+  OntologyDefinition,
+  OsdkObjectPropertyType,
+  PropertyKeysFrom,
+} from "./Definition";
+
+export type OsdkObjectFrom<
+  K extends string,
+  T extends OntologyDefinition<K>,
+  L extends PropertyKeysFrom<T, K>,
+> =
+  & {
+    [P in L]: OsdkObjectPropertyType<T["objects"][K]["properties"][P]>;
+  }
+  & {
+    __name: K;
+  }; // TODO

package/src/ontology/index.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 type * from "./Definition";
+export type { OntologyMetadata } from "./OntologyMetadata";
+export type { OsdkObject } from "./OsdkObject";
+export type { OsdkObjectFrom } from "./OsdkObjectFrom";

package/src/public/objects.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 * from "../client/object";

package/src/util/ArrayElement.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 type ArrayElement<ArrayType extends readonly unknown[]> =
+  ArrayType extends readonly (infer ElementType)[] ? ElementType : never;

package/src/util/FetchAsJson.ts

@@ -0,0 +1,55 @@
+/*
+ * 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.
+ */
+
+import { createFetchHeaderMutator } from "./createFetchHeaderMutator";
+import { stringifyBody } from "./stringifyBody";
+
+/**
+ * Fetches the given URL, converting the body to JSON, setting the Content-Type header to application/json,
+ * and calling .json() on the response.
+ */
+export type FetchAsJsonFn = (
+  url: URL,
+  requestInit: Omit<RequestInit, "body"> & { body?: object | undefined },
+) => Promise<any>;
+/**
+ * Wraps a fetch function to set the Content-Type header to application/json, to handle JSON.stringify(),
+ * and to parse the response as JSON.
+ *
+ * @param fetchFn The fetch function to wrap
+ * @returns
+ */
+export function createFetchAsJson(
+  fetchFn: typeof fetch = fetch,
+): FetchAsJsonFn {
+  fetchFn = createFetchHeaderMutator(fetchFn, (headers) => {
+    headers.set("Content-Type", "application/json");
+    return headers;
+  });
+
+  return async function fetchAsJson(
+    url: URL,
+    requestInit: Omit<RequestInit, "body"> & { body?: object },
+  ) {
+    return (
+      await fetchFn(url, {
+        ...requestInit,
+        body: stringifyBody(requestInit.body),
+        // TODO fix headers
+      })
+    ).json();
+  };
+}

package/src/util/NOOP.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 type NOOP<T> = T extends (...args: any[]) => any ? T
+  : T extends abstract new(...args: any[]) => any ? T
+  : {
+    [K in keyof T]: T[K];
+  };