@osdk/api 0.0.0-20230929184205

package/lib/util/FetchAsJson.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 declare function createFetchAsJson(fetchFn?: typeof fetch): FetchAsJsonFn;

package/lib/util/NOOP.d.ts

@@ -0,0 +1,3 @@
+export type NOOP<T> = T extends (...args: any[]) => any ? T : T extends abstract new (...args: any[]) => any ? T : {
+    [K in keyof T]: T[K];
+};

package/lib/util/StringArrayToUnion.d.ts

@@ -0,0 +1 @@
+export type StringArrayToUnion<T extends string | readonly string[]> = T extends ReadonlyArray<infer U> ? U : T;

package/lib/util/createFetchHeaderMutator.d.ts

@@ -0,0 +1 @@
+export declare function createFetchHeaderMutator(fetchFn: typeof fetch | undefined, mutator: (headers: Headers) => Promise<Headers> | Headers): typeof fetch;

package/lib/util/createFetchOrThrow.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Wraps a fetch plugin so that all errors (including when statusCode is not in the 200s) are converted to either PalantirApiError or UnknownError.
+ *
+ * If the returned promise does not have an error state, you are free to immediately call `.json()` or equivalent.
+ *
+ * @param fetchFn
+ * @returns
+ */
+export declare function createFetchOrThrow(fetchFn?: typeof fetch): (url: RequestInfo | URL, requestInit?: RequestInit) => Promise<Response>;

package/lib/util/createRetryingFetch.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="fetch-retry" />
+export declare function createRetryingFetch(fetch: typeof globalThis.fetch): (input: RequestInfo | URL, init?: import("fetch-retry").RequestInitWithRetry | undefined) => Promise<Response>;

package/lib/util/index.d.ts

@@ -0,0 +1,9 @@
+export type { ArrayElement } from "./ArrayElement";
+export { createFetchHeaderMutator } from "./createFetchHeaderMutator";
+export { createFetchOrThrow } from "./createFetchOrThrow";
+export { createRetryingFetch } from "./createRetryingFetch";
+export { createFetchAsJson } from "./FetchAsJson";
+export type { FetchAsJsonFn } from "./FetchAsJson";
+export type { NOOP } from "./NOOP";
+export type { StringArrayToUnion } from "./StringArrayToUnion";
+export { stringifyBody } from "./stringifyBody";

package/lib/util/stringifyBody.d.ts

@@ -0,0 +1 @@
+export declare function stringifyBody(body: object | undefined): BodyInit | null | undefined;

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@osdk/api",
+  "version": "0.0.0-20230929184205",
+  "description": "",
+  "access": "public",
+  "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./src/public/*.ts",
+      "import": "./dist/public/*.mjs",
+      "require": "./dist/public/*.js"
+    }
+  },
+  "dependencies": {
+    "fetch-retry": "^5.0.6",
+    "tiny-invariant": "^1.3.1"
+  },
+  "devDependencies": {
+    "ts-expect": "^1.3.0",
+    "typescript": "^5.2.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "imports": {
+    "#net": "./src/client/internal/net/index.ts",
+    "#util": "./src/util/index.ts",
+    "#ontology": "./src/ontology/index.ts",
+    "#client/converters": "./src/client/internal/conversions/index.ts",
+    "#client/query": "./src/client/query/index.ts"
+  },
+  "keywords": [],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
+    "dev": "tsup --watch",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "prettier": "prettier .",
+    "typecheck": "tsc-absolute"
+  }
+}

package/src/client/Client.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 { ObjectTypesFrom, OntologyDefinition } from "#ontology";
+import type { ObjectSet, ObjectSetOptions } from "./objectSet/ObjectSet";
+import type { ObjectSetCreator } from "./ObjectSetCreator";
+
+export type ConcreteObjectType<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+> = O["objects"][K];
+
+export interface Client<O extends OntologyDefinition<any>> {
+  objectSet: <const K extends ObjectTypesFrom<O>>(
+    type: K,
+    opts?: ObjectSetOptions<O, K>,
+  ) => ObjectSet<O, K>;
+
+  objects: ObjectSetCreator<O>;
+}

package/src/client/ObjectSetCreator.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 } from "#ontology";
+import type { Client } from "./Client";
+import type { ObjectSet } from "./objectSet/ObjectSet";
+
+/**
+ * A type that creates an object set for each object in the ontology.
+ */
+export type ObjectSetCreator<D extends OntologyDefinition<any>> = {
+  [T in ObjectTypesFrom<D>]: ObjectSet<D, T>;
+};
+
+/**
+ * Create a proxy for the object set creator.
+ * @param client The client to use to create the object sets.
+ * @returns A proxy for the object set creator.
+ */
+export function createObjectSetCreator<T extends Client<any>>(client: T) {
+  return new Proxy(
+    {},
+    {
+      get: (target, p, receiver) => {
+        if (typeof p === "string") return client.objectSet(p);
+
+        return undefined;
+      },
+    },
+  );
+}

package/src/client/PageResult.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { OsdkObject } from "#ontology";
+
+export interface PageResult<T extends OsdkObject<any>> {
+  data: T[];
+  nextPageToken: string | undefined;
+}

package/src/client/PalantirApiError.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.
+ */
+
+export class PalantirApiError extends Error implements PalantirApiError {
+  public message: string;
+  public errorName?: string;
+  public errorType?: string;
+  public statusCode?: number;
+  public errorInstanceId?: string;
+  public parameters?: any;
+
+  constructor(
+    message: string,
+    errorName?: string,
+    errorType?: string,
+    statusCode?: number,
+    errorInstanceId?: string,
+    parameters?: any,
+  ) {
+    super(message);
+    this.message = message;
+    this.errorName = errorName;
+    this.errorType = errorType;
+    this.statusCode = statusCode;
+    this.errorInstanceId = errorInstanceId;
+    this.parameters = parameters;
+  }
+}

package/src/client/ResultOrError.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 ResultOrError<T extends object> =
+  | ({ type: "ok"; err?: never } & T)
+  | { type: "err"; data?: never; err?: unknown };
+
+export function isOk(result: ResultOrError<any>): result is { type: "ok" } {
+  return result.type === "ok";
+}

package/src/client/ThinClient.ts

@@ -0,0 +1,31 @@
+/*
+ * 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 * as ontology from "#ontology";
+import type { FetchAsJsonFn } from "#util";
+
+export interface ThinClient<O extends ontology.OntologyDefinition<any>> {
+  ontology: O;
+  stack: string;
+  /**
+   * The fetch function to use for all requests.
+   *
+   * TODO: Document what is needed to get retry logic
+   */
+  fetch: typeof globalThis.fetch;
+
+  fetchJson: FetchAsJsonFn;
+}

package/src/client/UnknownError.ts

@@ -0,0 +1,25 @@
+/*
+ * 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 { PalantirApiError } from "./PalantirApiError";
+
+export class UnknownError extends PalantirApiError {
+  originalError: Error | undefined;
+  constructor(message: string, errorType: string, originalError?: Error) {
+    super(message, errorType);
+    this.originalError = originalError;
+  }
+}

package/src/client/createClient.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 } from "#ontology";
+import type { Client } from "./Client";
+import { createThinClient } from "./createThinClient";
+import { createObjectSet } from "./objectSet/createObjectSet";
+import type { ObjectSetFactory } from "./objectSet/ObjectSet";
+import { createObjectSetCreator } from "./ObjectSetCreator";
+
+export function createClient<O extends OntologyDefinition<any>>(
+  ontology: O,
+  stack: string,
+  tokenProvider: () => string,
+  fetchFn: typeof globalThis.fetch = fetch,
+): Client<O> {
+  const thinClient = createThinClient<O>(
+    ontology,
+    stack,
+    tokenProvider,
+    fetchFn,
+  );
+
+  const objectSetFactory: ObjectSetFactory<O> = (type, opts) =>
+    createObjectSet(type, thinClient, opts);
+
+  const client: Client<O> = Object.defineProperties(
+    {} as Client<O>,
+    {
+      objectSet: { get: () => objectSetFactory },
+      objects: { get: () => createObjectSetCreator(client) },
+    } satisfies Record<keyof Client<any>, PropertyDescriptor>,
+  );
+
+  return client;
+}

package/src/client/createThinClient.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 } from "#ontology";
+import {
+  createFetchAsJson,
+  createFetchHeaderMutator,
+  createFetchOrThrow,
+  createRetryingFetch,
+} from "#util";
+import type { ThinClient } from "./ThinClient";
+
+/**
+ * The goal of the thin client is to provide a way to tree shake as much as possible.
+ */
+
+export function createThinClient<T extends OntologyDefinition<any>>(
+  ontology: T,
+  stack: string,
+  tokenProvider: () => string,
+  fetchFn: typeof globalThis.fetch = fetch,
+): ThinClient<T> {
+  const retryingFetchWithAuthOrThrow = createFetchHeaderMutator(
+    createRetryingFetch(createFetchOrThrow(fetchFn)),
+    async (headers) => {
+      const token = await tokenProvider();
+      headers.set("Authorization", `Bearer ${token}`);
+      headers.set("Fetch-User-Agent", ontology.metadata.userAgent);
+      return headers;
+    },
+  );
+
+  return {
+    ontology,
+    stack,
+    fetch: retryingFetchWithAuthOrThrow,
+    fetchJson: createFetchAsJson(retryingFetchWithAuthOrThrow),
+  };
+}

package/src/client/index.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 { Client } from "./Client";
+export { createClient } from "./createClient";
+export { createThinClient } from "./createThinClient";
+export type { ObjectSet } from "./objectSet/ObjectSet";
+export type { PageResult } from "./PageResult";
+export { isOk } from "./ResultOrError";
+export type { ResultOrError } from "./ResultOrError";
+export type { ThinClient } from "./ThinClient";

package/src/client/internal/conversions/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 { legacyToModernSingleAggregationResult } from "./legacyToModernSingleAggregationResult";
+export { modernToLegacyAggregationClause } from "./modernToLegacyAggregationClause";
+export { modernToLegacyGroupByClause } from "./modernToLegacyGroupByClause";
+export { modernToLegacyWhereClause } from "./modernToLegacyWhereClause";

package/src/client/internal/conversions/legacyToModernSingleAggregationResult.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 {
+  AggregationClause,
+  AggregationResultsWithoutGroups,
+} from "#client/query";
+import type { Wire } from "#net";
+import type { ArrayElement } from "#util";
+import invariant from "tiny-invariant";
+
+export function legacyToModernSingleAggregationResult<
+  AC extends AggregationClause<any, any>,
+>(
+  entry: ArrayElement<Wire.AggregateObjectsResponseV2["data"]>,
+): AggregationResultsWithoutGroups<any, any, AC> {
+  return entry.metrics.reduce(
+    (accumulator, curValue) => {
+      const parts = curValue.name.split(".");
+      invariant(
+        parts.length == 2,
+        "assumed we were getting a `${key}.${type}`",
+      );
+      if (!(parts[0] in accumulator)) {
+        accumulator[parts[0]] = {};
+      }
+      accumulator[parts[0]][parts[1]] = curValue.value;
+
+      return accumulator;
+    },
+    {} as AggregationResultsWithoutGroups<any, any, any>,
+  );
+}

package/src/client/internal/conversions/modernToLegacyAggregationClause.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { AggregationClause } from "#client/query";
+import type { Wire } from "#net";
+import type { ObjectTypesFrom, OntologyDefinition } from "#ontology";
+
+export function modernToLegacyAggregationClause<
+  T extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<T>,
+  AC extends AggregationClause<T, K>,
+>(select: AC) {
+  return Object.entries(select).flatMap<Wire.AggregationClause>(([k, v]) => {
+    if (Array.isArray(v)) {
+      return (v as string[]).map((v2) => {
+        return {
+          type: v2,
+          name: `${k}.${v2}`,
+          field: k,
+        };
+      });
+    } else {
+      return [
+        {
+          type: v as string,
+          name: `${k}.${v}`,
+          field: k,
+        },
+      ];
+    }
+  });
+}

package/src/client/internal/conversions/modernToLegacyGroupByClause.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 { AllGroupByValues, GroupByClause } from "#client/query";
+import type { Wire } from "#net";
+import type { ObjectTypesFrom, OntologyDefinition } from "#ontology";
+
+export function modernToLegacyGroupByClause<
+  O extends OntologyDefinition<any>,
+  K extends ObjectTypesFrom<O>,
+>(groupByClause: GroupByClause<O, K> | undefined) {
+  if (!groupByClause) return undefined;
+
+  return Object.entries(
+    groupByClause as Record<string, AllGroupByValues>,
+  ).flatMap<Wire.GroupByClause>(([field, type]) => {
+    if (type === "exact") {
+      return [{ type, field }];
+    } else if (type.exactWithLimit) {
+      return [
+        {
+          type: "exact",
+          field,
+          maxGroupCount: type.exactWithLimit,
+        },
+      ];
+    } else {
+      return [];
+    }
+  });
+}