@osdk/api 0.0.0-20230929184205

package/src/util/StringArrayToUnion.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 StringArrayToUnion<T extends string | readonly string[]> = T extends
+  ReadonlyArray<infer U> ? U : T;

package/src/util/createFetchHeaderMutator.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 function createFetchHeaderMutator(
+  fetchFn: typeof fetch = fetch,
+  mutator: (headers: Headers) => Promise<Headers> | Headers,
+): typeof fetch {
+  return async function headerMutatedFetch(
+    url: RequestInfo | URL,
+    requestInit?: RequestInit,
+  ) {
+    if (!requestInit) {
+      return fetchFn(url, { headers: await mutator(new Headers()) });
+    }
+
+    return fetchFn(url, {
+      ...requestInit,
+      headers: await mutator(new Headers(requestInit.headers)),
+    });
+  };
+}

package/src/util/createFetchOrThrow.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 "../client/PalantirApiError";
+import { UnknownError } from "../client/UnknownError";
+
+/**
+ * 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 function createFetchOrThrow(fetchFn: typeof fetch = fetch) {
+  return async function fetchOrThrow(
+    url: RequestInfo | URL,
+    requestInit?: RequestInit,
+  ) {
+    let response;
+
+    try {
+      response = await fetchFn(url, requestInit);
+    } catch (e) {
+      throw convertError(e, "A network error occured");
+    }
+
+    if (!response.ok) {
+      let body;
+      try {
+        body = await response.json();
+      } catch (e) {
+        throw convertError(e, "A network error occured while reading response");
+      }
+
+      throw new PalantirApiError(
+        body?.message
+          ?? `Failed to fetch ${response.status} ${response.statusText}`,
+        body?.errorName,
+        body?.errorCode,
+        response.status,
+        body?.errorInstanceId,
+        body?.parameters,
+      );
+    }
+    return response;
+  };
+}
+
+function convertError(
+  e: any,
+  msgIfNotError: string = "An unknown error occurred",
+) {
+  if (e instanceof Error) {
+    return new UnknownError(e.message, "UNKNOWN", e);
+  }
+  return new UnknownError(msgIfNotError, "UNKNOWN");
+}

package/src/util/createRetryingFetch.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 fetchRetry from "fetch-retry";
+import { PalantirApiError } from "../client/PalantirApiError";
+
+const INITIAL_DELAY = 1_000;
+const JITTER_FACTOR = 0.5;
+const MAX_RETRIES = 3;
+
+export function createRetryingFetch(fetch: typeof globalThis.fetch) {
+  return fetchRetry(fetch, {
+    retryDelay(attempt) {
+      const delay = INITIAL_DELAY * 2 ** attempt;
+      const jitter = delay * JITTER_FACTOR * (Math.random() * 2 - 1);
+      return delay + jitter;
+    },
+    retryOn(attempt, error, response) {
+      const status = response?.status ?? 0;
+      return (
+        !(status >= 200 && status < 300)
+        && isRetryable(error)
+        && attempt < MAX_RETRIES
+      );
+    },
+  });
+}
+
+function isRetryable(e: any): boolean {
+  if (e instanceof PalantirApiError) {
+    if (
+      e.statusCode !== SERVICE_UNAVAILABLE
+      && e.statusCode !== TOO_MANY_REQUESTS
+    ) {
+      return false;
+    }
+  }
+  return true; // I think this logic is flawed?
+}
+
+const SERVICE_UNAVAILABLE = 503;
+const TOO_MANY_REQUESTS = 429;

package/src/util/index.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.
+ */
+
+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/src/util/stringifyBody.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 function stringifyBody(
+  body: object | undefined,
+): BodyInit | null | undefined {
+  return body != null ? JSON.stringify(body) : undefined;
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "tsconfig/base",
+  "compilerOptions": { "rootDir": "src", "outDir": "lib" },
+  "include": ["./src/**/*", ".eslintrc.cjs"]
+}

package/tsup.config.js

@@ -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 { defineConfig } from "tsup";
+
+export default defineConfig(async (options) =>
+  (await import("mytsup")).default(options)
+);