@osdk/api 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/build/js/chunk-I3UIWCJ4.js +17 -0
  3. package/build/js/chunk-I3UIWCJ4.js.map +1 -0
  4. package/build/js/chunk-II7ELH2S.mjs +8 -0
  5. package/build/js/chunk-II7ELH2S.mjs.map +1 -0
  6. package/build/js/index.js +20 -0
  7. package/build/js/index.js.map +1 -0
  8. package/build/js/index.mjs +9 -0
  9. package/build/js/index.mjs.map +1 -0
  10. package/build/js/public/objects.js +16 -0
  11. package/build/js/public/objects.js.map +1 -0
  12. package/build/js/public/objects.mjs +3 -0
  13. package/build/js/public/objects.mjs.map +1 -0
  14. package/build/types/client/Client.d.ts +8 -0
  15. package/build/types/client/ObjectSetCreator.d.ts +15 -0
  16. package/build/types/client/PageResult.d.ts +5 -0
  17. package/build/types/client/PalantirApiError.d.ts +9 -0
  18. package/build/types/client/ResultOrError.d.ts +11 -0
  19. package/build/types/client/ThinClient.d.ts +13 -0
  20. package/build/types/client/UnknownError.d.ts +5 -0
  21. package/build/types/client/createClient.d.ts +3 -0
  22. package/build/types/client/createThinClient.d.ts +6 -0
  23. package/build/types/client/index.d.ts +8 -0
  24. package/build/types/client/internal/conversions/index.d.ts +4 -0
  25. package/build/types/client/internal/conversions/legacyToModernSingleAggregationResult.d.ts +4 -0
  26. package/build/types/client/internal/conversions/modernToLegacyAggregationClause.d.ts +4 -0
  27. package/build/types/client/internal/conversions/modernToLegacyGroupByClause.d.ts +4 -0
  28. package/build/types/client/internal/conversions/modernToLegacyWhereClause.d.ts +4 -0
  29. package/build/types/client/internal/net/V2_BASE.d.ts +1 -0
  30. package/build/types/client/internal/net/createOpenApiRequest.d.ts +2 -0
  31. package/build/types/client/internal/net/createOpenApiRequest.test.d.ts +1 -0
  32. package/build/types/client/internal/net/index.d.ts +2 -0
  33. package/build/types/client/internal/net/types.d.ts +357 -0
  34. package/build/types/client/object/aggregateOrThrow.d.ts +5 -0
  35. package/build/types/client/object/aggregateOrThrow.test.d.ts +1 -0
  36. package/build/types/client/object/fetchPageOrThrow.d.ts +10 -0
  37. package/build/types/client/object/index.d.ts +2 -0
  38. package/build/types/client/objectSet/LinkTypesFrom.d.ts +2 -0
  39. package/build/types/client/objectSet/ObjectSet.d.ts +25 -0
  40. package/build/types/client/objectSet/createObjectSet.d.ts +5 -0
  41. package/build/types/client/query/WhereClause.d.ts +24 -0
  42. package/build/types/client/query/aggregations/AggregatableKeys.d.ts +4 -0
  43. package/build/types/client/query/aggregations/AggregateOpts.d.ts +7 -0
  44. package/build/types/client/query/aggregations/AggregationResultsWithGroups.d.ts +10 -0
  45. package/build/types/client/query/aggregations/AggregationResultsWithoutGroups.d.ts +10 -0
  46. package/build/types/client/query/aggregations/AggregationsClause.d.ts +8 -0
  47. package/build/types/client/query/aggregations/AggregationsClause.test.d.ts +36 -0
  48. package/build/types/client/query/aggregations/AggregationsResults.d.ts +5 -0
  49. package/build/types/client/query/aggregations/AggregationsResults.test.d.ts +1 -0
  50. package/build/types/client/query/aggregations/GroupByClause.d.ts +12 -0
  51. package/build/types/client/query/aggregations/GroupByClause.test.d.ts +18 -0
  52. package/build/types/client/query/aggregations/GroupByMapper.d.ts +4 -0
  53. package/build/types/client/query/index.d.ts +7 -0
  54. package/build/types/index.d.ts +6 -0
  55. package/build/types/ontology/Definition.d.ts +36 -0
  56. package/build/types/ontology/OntologyMetadata.d.ts +5 -0
  57. package/build/types/ontology/OsdkObject.d.ts +3 -0
  58. package/build/types/ontology/OsdkObjectFrom.d.ts +6 -0
  59. package/build/types/ontology/index.d.ts +4 -0
  60. package/build/types/public/objects.d.ts +1 -0
  61. package/build/types/util/ArrayElement.d.ts +1 -0
  62. package/build/types/util/FetchAsJson.d.ts +15 -0
  63. package/build/types/util/NOOP.d.ts +3 -0
  64. package/build/types/util/StringArrayToUnion.d.ts +1 -0
  65. package/build/types/util/createFetchHeaderMutator.d.ts +1 -0
  66. package/build/types/util/createFetchOrThrow.d.ts +9 -0
  67. package/build/types/util/createRetryingFetch.d.ts +2 -0
  68. package/build/types/util/index.d.ts +9 -0
  69. package/build/types/util/stringifyBody.d.ts +1 -0
  70. package/package.json +8 -5
@@ -0,0 +1 @@
1
+ export type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Fetches the given URL, converting the body to JSON, setting the Content-Type header to application/json,
3
+ * and calling .json() on the response.
4
+ */
5
+ export type FetchAsJsonFn = (url: URL, requestInit: Omit<RequestInit, "body"> & {
6
+ body?: object | undefined;
7
+ }) => Promise<any>;
8
+ /**
9
+ * Wraps a fetch function to set the Content-Type header to application/json, to handle JSON.stringify(),
10
+ * and to parse the response as JSON.
11
+ *
12
+ * @param fetchFn The fetch function to wrap
13
+ * @returns
14
+ */
15
+ export declare function createFetchAsJson(fetchFn?: typeof fetch): FetchAsJsonFn;
@@ -0,0 +1,3 @@
1
+ export type NOOP<T> = T extends (...args: any[]) => any ? T : T extends abstract new (...args: any[]) => any ? T : {
2
+ [K in keyof T]: T[K];
3
+ };
@@ -0,0 +1 @@
1
+ export type StringArrayToUnion<T extends string | readonly string[]> = T extends ReadonlyArray<infer U> ? U : T;
@@ -0,0 +1 @@
1
+ export declare function createFetchHeaderMutator(fetchFn: typeof fetch | undefined, mutator: (headers: Headers) => Promise<Headers> | Headers): typeof fetch;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Wraps a fetch plugin so that all errors (including when statusCode is not in the 200s) are converted to either PalantirApiError or UnknownError.
3
+ *
4
+ * If the returned promise does not have an error state, you are free to immediately call `.json()` or equivalent.
5
+ *
6
+ * @param fetchFn
7
+ * @returns
8
+ */
9
+ export declare function createFetchOrThrow(fetchFn?: typeof fetch): (url: RequestInfo | URL, requestInit?: RequestInit) => Promise<Response>;
@@ -0,0 +1,2 @@
1
+ /// <reference types="fetch-retry" />
2
+ export declare function createRetryingFetch(fetch: typeof globalThis.fetch): (input: RequestInfo | URL, init?: import("fetch-retry").RequestInitWithRetry | undefined) => Promise<Response>;
@@ -0,0 +1,9 @@
1
+ export type { ArrayElement } from "./ArrayElement";
2
+ export { createFetchHeaderMutator } from "./createFetchHeaderMutator";
3
+ export { createFetchOrThrow } from "./createFetchOrThrow";
4
+ export { createRetryingFetch } from "./createRetryingFetch";
5
+ export { createFetchAsJson } from "./FetchAsJson";
6
+ export type { FetchAsJsonFn } from "./FetchAsJson";
7
+ export type { NOOP } from "./NOOP";
8
+ export type { StringArrayToUnion } from "./StringArrayToUnion";
9
+ export { stringifyBody } from "./stringifyBody";
@@ -0,0 +1 @@
1
+ export declare function stringifyBody(body: object | undefined): BodyInit | null | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/api",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "",
5
5
  "access": "public",
6
6
  "license": "Apache-2.0",
@@ -18,7 +18,8 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "fetch-retry": "^5.0.6",
21
- "tiny-invariant": "^1.3.1"
21
+ "tiny-invariant": "^1.3.1",
22
+ "@osdk/gateway": "0.0.0"
22
23
  },
23
24
  "devDependencies": {
24
25
  "ts-expect": "^1.3.0",
@@ -36,16 +37,18 @@
36
37
  },
37
38
  "keywords": [],
38
39
  "files": [
39
- "dist",
40
- "types",
40
+ "build/types",
41
+ "build/js",
41
42
  "CHANGELOG.md",
42
43
  "package.json"
43
44
  ],
44
45
  "scripts": {
45
46
  "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
46
47
  "dev:transpile": "tsup --watch",
48
+ "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
47
49
  "lint": "eslint . && dprint check --config $(find-up dprint.json)",
48
- "prettier": "prettier .",
50
+ "test": "vitest run",
51
+ "test:watch": "vitest",
49
52
  "transpile": "tsup",
50
53
  "transpileWatch": "tsup --watch",
51
54
  "typecheck": "tsc-absolute --build"