@osdk/unit-testing 0.0.0 → 0.9.0
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.
- package/CHANGELOG.md +237 -0
- package/build/browser/api/MockClient.js +2 -0
- package/build/browser/api/MockClient.js.map +1 -0
- package/build/browser/api/MockOsdkObjectOptions.js +2 -0
- package/build/browser/api/MockOsdkObjectOptions.js.map +1 -0
- package/build/browser/api/StubBuilders.js +2 -0
- package/build/browser/api/StubBuilders.js.map +1 -0
- package/build/browser/api/StubClient.js +2 -0
- package/build/browser/api/StubClient.js.map +1 -0
- package/build/browser/api/index.js +2 -0
- package/build/browser/api/index.js.map +1 -0
- package/build/browser/example-function-tests/basicAggregate/basicAggregate.js +49 -0
- package/build/browser/example-function-tests/basicAggregate/basicAggregate.js.map +1 -0
- package/build/browser/example-function-tests/basicFetchPage/basicFetchPage.js +29 -0
- package/build/browser/example-function-tests/basicFetchPage/basicFetchPage.js.map +1 -0
- package/build/browser/example-function-tests/basicQuery/basicQuery.js +27 -0
- package/build/browser/example-function-tests/basicQuery/basicQuery.js.map +1 -0
- package/build/browser/example-function-tests/objectAsInput/objectAsInput.js +26 -0
- package/build/browser/example-function-tests/objectAsInput/objectAsInput.js.map +1 -0
- package/build/browser/example-function-tests/objectSetAsInput/objectSetAsInput.js +29 -0
- package/build/browser/example-function-tests/objectSetAsInput/objectSetAsInput.js.map +1 -0
- package/build/browser/example-function-tests/objectWithLinks/objectWithLinks.js +43 -0
- package/build/browser/example-function-tests/objectWithLinks/objectWithLinks.js.map +1 -0
- package/build/browser/example-function-tests/ontologyEdits/ontologyEdits.js +37 -0
- package/build/browser/example-function-tests/ontologyEdits/ontologyEdits.js.map +1 -0
- package/build/browser/example-function-tests/platformApiWithMsw/platformApiWithMsw.js +25 -0
- package/build/browser/example-function-tests/platformApiWithMsw/platformApiWithMsw.js.map +1 -0
- package/build/browser/example-function-tests/queryWithArrayParams/queryWithArrayParams.js +27 -0
- package/build/browser/example-function-tests/queryWithArrayParams/queryWithArrayParams.js.map +1 -0
- package/build/browser/index.js +21 -0
- package/build/browser/index.js.map +1 -0
- package/build/browser/mock/createMockAttachment.js +31 -0
- package/build/browser/mock/createMockAttachment.js.map +1 -0
- package/build/browser/mock/createMockClient.js +142 -0
- package/build/browser/mock/createMockClient.js.map +1 -0
- package/build/browser/mock/createMockObjectSet.js +36 -0
- package/build/browser/mock/createMockObjectSet.js.map +1 -0
- package/build/browser/mock/createMockObjectSetWithResolver.js +122 -0
- package/build/browser/mock/createMockObjectSetWithResolver.js.map +1 -0
- package/build/browser/mock/createMockOsdkObject.js +235 -0
- package/build/browser/mock/createMockOsdkObject.js.map +1 -0
- package/build/browser/public/experimental.js +21 -0
- package/build/browser/public/experimental.js.map +1 -0
- package/build/cjs/chunk-SEUQK2F4.cjs +445 -0
- package/build/cjs/chunk-SEUQK2F4.cjs.map +1 -0
- package/build/cjs/index.cjs +24 -0
- package/build/cjs/index.cjs.map +1 -0
- package/build/cjs/index.d.cts +99 -0
- package/build/cjs/public/experimental.cjs +24 -0
- package/build/cjs/public/experimental.cjs.map +1 -0
- package/build/cjs/public/experimental.d.cts +3 -0
- package/build/esm/api/MockClient.js +2 -0
- package/build/esm/api/MockClient.js.map +1 -0
- package/build/esm/api/MockOsdkObjectOptions.js +2 -0
- package/build/esm/api/MockOsdkObjectOptions.js.map +1 -0
- package/build/esm/api/StubBuilders.js +2 -0
- package/build/esm/api/StubBuilders.js.map +1 -0
- package/build/esm/api/StubClient.js +2 -0
- package/build/esm/api/StubClient.js.map +1 -0
- package/build/esm/api/index.js +2 -0
- package/build/esm/api/index.js.map +1 -0
- package/build/esm/example-function-tests/basicAggregate/basicAggregate.js +49 -0
- package/build/esm/example-function-tests/basicAggregate/basicAggregate.js.map +1 -0
- package/build/esm/example-function-tests/basicFetchPage/basicFetchPage.js +29 -0
- package/build/esm/example-function-tests/basicFetchPage/basicFetchPage.js.map +1 -0
- package/build/esm/example-function-tests/basicQuery/basicQuery.js +27 -0
- package/build/esm/example-function-tests/basicQuery/basicQuery.js.map +1 -0
- package/build/esm/example-function-tests/objectAsInput/objectAsInput.js +26 -0
- package/build/esm/example-function-tests/objectAsInput/objectAsInput.js.map +1 -0
- package/build/esm/example-function-tests/objectSetAsInput/objectSetAsInput.js +29 -0
- package/build/esm/example-function-tests/objectSetAsInput/objectSetAsInput.js.map +1 -0
- package/build/esm/example-function-tests/objectWithLinks/objectWithLinks.js +43 -0
- package/build/esm/example-function-tests/objectWithLinks/objectWithLinks.js.map +1 -0
- package/build/esm/example-function-tests/ontologyEdits/ontologyEdits.js +37 -0
- package/build/esm/example-function-tests/ontologyEdits/ontologyEdits.js.map +1 -0
- package/build/esm/example-function-tests/platformApiWithMsw/platformApiWithMsw.js +25 -0
- package/build/esm/example-function-tests/platformApiWithMsw/platformApiWithMsw.js.map +1 -0
- package/build/esm/example-function-tests/queryWithArrayParams/queryWithArrayParams.js +27 -0
- package/build/esm/example-function-tests/queryWithArrayParams/queryWithArrayParams.js.map +1 -0
- package/build/esm/index.js +21 -0
- package/build/esm/index.js.map +1 -0
- package/build/esm/mock/createMockAttachment.js +31 -0
- package/build/esm/mock/createMockAttachment.js.map +1 -0
- package/build/esm/mock/createMockClient.js +142 -0
- package/build/esm/mock/createMockClient.js.map +1 -0
- package/build/esm/mock/createMockObjectSet.js +36 -0
- package/build/esm/mock/createMockObjectSet.js.map +1 -0
- package/build/esm/mock/createMockObjectSetWithResolver.js +122 -0
- package/build/esm/mock/createMockObjectSetWithResolver.js.map +1 -0
- package/build/esm/mock/createMockOsdkObject.js +235 -0
- package/build/esm/mock/createMockOsdkObject.js.map +1 -0
- package/build/esm/public/experimental.js +21 -0
- package/build/esm/public/experimental.js.map +1 -0
- package/build/types/api/MockClient.d.ts +21 -0
- package/build/types/api/MockClient.d.ts.map +1 -0
- package/build/types/api/MockOsdkObjectOptions.d.ts +14 -0
- package/build/types/api/MockOsdkObjectOptions.d.ts.map +1 -0
- package/build/types/api/StubBuilders.d.ts +28 -0
- package/build/types/api/StubBuilders.d.ts.map +1 -0
- package/build/types/api/StubClient.d.ts +5 -0
- package/build/types/api/StubClient.d.ts.map +1 -0
- package/build/types/api/index.d.ts +4 -0
- package/build/types/api/index.d.ts.map +1 -0
- package/build/types/example-function-tests/basicAggregate/basicAggregate.d.ts +3 -0
- package/build/types/example-function-tests/basicAggregate/basicAggregate.d.ts.map +1 -0
- package/build/types/example-function-tests/basicFetchPage/basicFetchPage.d.ts +4 -0
- package/build/types/example-function-tests/basicFetchPage/basicFetchPage.d.ts.map +1 -0
- package/build/types/example-function-tests/basicQuery/basicQuery.d.ts +3 -0
- package/build/types/example-function-tests/basicQuery/basicQuery.d.ts.map +1 -0
- package/build/types/example-function-tests/objectAsInput/objectAsInput.d.ts +3 -0
- package/build/types/example-function-tests/objectAsInput/objectAsInput.d.ts.map +1 -0
- package/build/types/example-function-tests/objectSetAsInput/objectSetAsInput.d.ts +4 -0
- package/build/types/example-function-tests/objectSetAsInput/objectSetAsInput.d.ts.map +1 -0
- package/build/types/example-function-tests/objectWithLinks/objectWithLinks.d.ts +7 -0
- package/build/types/example-function-tests/objectWithLinks/objectWithLinks.d.ts.map +1 -0
- package/build/types/example-function-tests/ontologyEdits/ontologyEdits.d.ts +7 -0
- package/build/types/example-function-tests/ontologyEdits/ontologyEdits.d.ts.map +1 -0
- package/build/types/example-function-tests/platformApiWithMsw/platformApiWithMsw.d.ts +2 -0
- package/build/types/example-function-tests/platformApiWithMsw/platformApiWithMsw.d.ts.map +1 -0
- package/build/types/example-function-tests/queryWithArrayParams/queryWithArrayParams.d.ts +2 -0
- package/build/types/example-function-tests/queryWithArrayParams/queryWithArrayParams.d.ts.map +1 -0
- package/build/types/index.d.ts +5 -0
- package/build/types/index.d.ts.map +1 -0
- package/build/types/mock/createMockAttachment.d.ts +2 -0
- package/build/types/mock/createMockAttachment.d.ts.map +1 -0
- package/build/types/mock/createMockClient.d.ts +2 -0
- package/build/types/mock/createMockClient.d.ts.map +1 -0
- package/build/types/mock/createMockObjectSet.d.ts +9 -0
- package/build/types/mock/createMockObjectSet.d.ts.map +1 -0
- package/build/types/mock/createMockObjectSetWithResolver.d.ts +10 -0
- package/build/types/mock/createMockObjectSetWithResolver.d.ts.map +1 -0
- package/build/types/mock/createMockOsdkObject.d.ts +32 -0
- package/build/types/mock/createMockOsdkObject.d.ts.map +1 -0
- package/build/types/public/experimental.d.ts +5 -0
- package/build/types/public/experimental.d.ts.map +1 -0
- package/experimental.d.ts +17 -0
- package/package.json +92 -2
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"experimental.js","names":["createMockAttachment","createMockClient","createMockObjectSet","createMockOsdkObject"],"sources":["experimental.ts"],"sourcesContent":["/*\n * Copyright 2026 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 type {\n AggregateStubBuilder,\n FetchOneStubBuilder,\n FetchPageStubBuilder,\n QueryStubBuilder,\n StubBuilderFor,\n} from \"../api/index.js\";\nexport { createMockAttachment } from \"../mock/createMockAttachment.js\";\nexport { createMockClient } from \"../mock/createMockClient.js\";\nexport { createMockObjectSet } from \"../mock/createMockObjectSet.js\";\nexport { createMockOsdkObject } from \"../mock/createMockOsdkObject.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,SAASA,oBAAoB,QAAQ,iCAAiC;AACtE,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,mBAAmB,QAAQ,gCAAgC;AACpE,SAASC,oBAAoB,QAAQ,iCAAiC","ignoreList":[]}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { CompileTimeMetadata, ObjectOrInterfaceDefinition, ObjectSet, QueryDefinition } from "@osdk/api";
|
|
2
|
+
import type { Client } from "@osdk/client";
|
|
3
|
+
import type { QueryStubBuilder, StubBuilderFor } from "./StubBuilders.js";
|
|
4
|
+
import type { StubClient } from "./StubClient.js";
|
|
5
|
+
type QueryReturnTypeFromDef<Q extends QueryDefinition> = ReturnType<CompileTimeMetadata<Q>["signature"]> extends Promise<infer R> ? R : never;
|
|
6
|
+
type QueryParamsFromDef<Q extends QueryDefinition> = Parameters<CompileTimeMetadata<Q>["signature"]> extends [infer P] ? P : undefined;
|
|
7
|
+
export type StubPatternCallback<T> = (client: StubClient) => T;
|
|
8
|
+
export type ObjectSetStubCallback<
|
|
9
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
10
|
+
T
|
|
11
|
+
> = (os: ObjectSet<Q>) => T;
|
|
12
|
+
export interface MockClient extends Client {
|
|
13
|
+
when<T>(callback: StubPatternCallback<T>): StubBuilderFor<T>;
|
|
14
|
+
whenObjectSet<
|
|
15
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
16
|
+
T
|
|
17
|
+
>(objectSet: ObjectSet<Q>, callback: ObjectSetStubCallback<Q, T>): StubBuilderFor<T>;
|
|
18
|
+
whenQuery<Q extends QueryDefinition>(query: Q, params?: QueryParamsFromDef<Q>): QueryStubBuilder<QueryReturnTypeFromDef<Q>>;
|
|
19
|
+
clearStubs(): void;
|
|
20
|
+
}
|
|
21
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,qBACA,6BACA,WACA,uBACK,WAAY;AACnB,cAAc,cAAc,cAAe;AAC3C,cAAc,kBAAkB,sBAAsB,mBAAoB;AAC1E,cAAc,kBAAkB,iBAAkB;KAE7C,uBAAuB,UAAU,mBAAmB,WACvD,oBAAoB,GAAG,sBACf,cAAc,KAAK;KAExB,mBAAmB,UAAU,mBAChC,WAAW,oBAAoB,GAAG,6BAA6B,KAAK;AAGtE,YAAY,oBAAoB,MAAMA,QAAQ,eAAe;AAE7D,YAAY;CAAsB,UAAU;CAA6B;KACvEC,IAAI,UAAU,OACX;AAEL,iBAAiB,mBAAmB,OAAO;CACzC,KAAK,GAAGC,UAAU,oBAAoB,KAAK,eAAe;CAC1D;EAAc,UAAU;EAA6B;GACnDC,WAAW,UAAU,IACrBC,UAAU,sBAAsB,GAAG,KAClC,eAAe;CAClB,UAAU,UAAU,iBAClBC,OAAO,GACPC,SAAS,mBAAmB,KAC3B,iBAAiB,uBAAuB;CAC3C;AACD","names":["client: StubClient","os: ObjectSet<Q>","callback: StubPatternCallback<T>","objectSet: ObjectSet<Q>","callback: ObjectSetStubCallback<Q, T>","query: Q","params?: QueryParamsFromDef<Q>"],"sources":["../../../src/api/MockClient.ts"],"version":3,"file":"MockClient.d.ts"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { CompileTimeMetadata, LinkedType, LinkNames, ObjectSet, ObjectTypeDefinition, Osdk } from "@osdk/api";
|
|
2
|
+
type LinkStubs<Q extends ObjectTypeDefinition> = { [LINK_NAME in LinkNames<Q>]? : CompileTimeMetadata<Q>["links"][LINK_NAME]["multiplicity"] extends true ? Array<Osdk.Instance<LinkedType<Q, LINK_NAME>>> | ObjectSet<LinkedType<Q, LINK_NAME>> : Osdk.Instance<LinkedType<Q, LINK_NAME>> | Error };
|
|
3
|
+
/**
|
|
4
|
+
* Options for customizing mock object creation.
|
|
5
|
+
*/
|
|
6
|
+
export interface MockOsdkObjectOptions<Q extends ObjectTypeDefinition = ObjectTypeDefinition> {
|
|
7
|
+
/** Objects linked to this object by API name */
|
|
8
|
+
links?: LinkStubs<Q>;
|
|
9
|
+
/** The API name of the title property (optional, required for $title) */
|
|
10
|
+
titlePropertyApiName?: string;
|
|
11
|
+
/** Override the generated $rid */
|
|
12
|
+
$rid?: string;
|
|
13
|
+
}
|
|
14
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,qBACA,YACA,WACA,WACA,sBACA,YACK,WAAY;KAEd,UAAU,UAAU,2BACtB,aAAa,UAAU,OACtB,oBAAoB,GAAG,SAAS,WAAW,wBAAwB,OAC7D,MAAM,KAAK,SAAS,WAAW,GAAG,eAClC,UAAU,WAAW,GAAG,cAC1B,KAAK,SAAS,WAAW,GAAG,cAAc;;;;AAMlD,iBAAiB,sBACf,UAAU,uBAAuB,sBACjC;;CAEA,QAAQ,UAAU;;CAElB;;CAEA;AACD","names":[],"sources":["../../../src/api/MockOsdkObjectOptions.ts"],"version":3,"file":"MockOsdkObjectOptions.d.ts"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { PageResult } from "@osdk/api";
|
|
2
|
+
export interface FetchPageStubBuilder<T> {
|
|
3
|
+
thenReturnObjects(objects: T[]): void;
|
|
4
|
+
}
|
|
5
|
+
export interface FetchOneStubBuilder<T> {
|
|
6
|
+
thenReturnObject(object: T): void;
|
|
7
|
+
}
|
|
8
|
+
export interface AggregateStubBuilder<T> {
|
|
9
|
+
thenReturnAggregation(result: T): void;
|
|
10
|
+
}
|
|
11
|
+
export interface QueryStubBuilder<T> {
|
|
12
|
+
thenReturn(result: T): void;
|
|
13
|
+
thenThrow(error: Error): void;
|
|
14
|
+
}
|
|
15
|
+
type IsOsdkObject<T> = T extends {
|
|
16
|
+
$apiName: string
|
|
17
|
+
} ? true : false;
|
|
18
|
+
export type StubBuilderFor<T> = T extends Promise<infer R> ? StubBuilderFor<R> : T extends AsyncIterableIterator<infer U> ? FetchPageStubBuilder<U> : T extends PageResult<infer U> ? FetchPageStubBuilder<U> : T extends {
|
|
19
|
+
value: PageResult<infer U>
|
|
20
|
+
error?: never
|
|
21
|
+
} ? FetchPageStubBuilder<U> : T extends {
|
|
22
|
+
value: infer U
|
|
23
|
+
error?: never
|
|
24
|
+
} ? (IsOsdkObject<U> extends true ? FetchOneStubBuilder<U> : AggregateStubBuilder<U>) : T extends {
|
|
25
|
+
error: Error
|
|
26
|
+
value?: never
|
|
27
|
+
} ? never : IsOsdkObject<T> extends true ? FetchOneStubBuilder<T> : AggregateStubBuilder<T>;
|
|
28
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,kBAAkB,WAAY;AAE5C,iBAAiB,qBAAqB,GAAG;CACvC,kBAAkBA,SAAS;AAC5B;AAED,iBAAiB,oBAAoB,GAAG;CACtC,iBAAiBC,QAAQ;AAC1B;AAED,iBAAiB,qBAAqB,GAAG;CACvC,sBAAsBC,QAAQ;AAC/B;AAED,iBAAiB,iBAAiB,GAAG;CACnC,WAAWA,QAAQ;CACnB,UAAUC,OAAO;AAClB;KAEI,aAAa,KAAK,UAAU;CAAE;AAAkB,IAAG,OAAO;AAE/D,YAAY,eAAe,KAAK,UAAU,cAAc,KAAK,eAAe,KACxE,UAAU,4BAA4B,KAAK,qBAAqB,KAChE,UAAU,iBAAiB,KAAK,qBAAqB,KACrD,UAAU;CAAE,OAAO,iBAAiB;CAAI;AAAe,IACrD,qBAAqB,KACvB,UAAU;CAAE,aAAa;CAAG;AAAe,KACxC,aAAa,WAAW,OAAO,oBAAoB,KAClD,qBAAqB,MACzB,UAAU;CAAE,OAAO;CAAO;AAAe,YACzC,aAAa,WAAW,OAAO,oBAAoB,KACnD,qBAAqB","names":["objects: T[]","object: T","result: T","error: Error"],"sources":["../../../src/api/StubBuilders.ts"],"version":3,"file":"StubBuilders.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,qBACA,WACA,4BACK,WAAY;AAEnB,YAAY,aAAa;EACtB,UAAU,sBAAsBA,GAAG,IAAI,UAAU;EACjD,UAAU,qBAAqBA,GAAG,IAAI,UAAU;AAClD","names":["o: Q"],"sources":["../../../src/api/StubClient.ts"],"version":3,"file":"StubClient.d.ts"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type { MockClient } from "./MockClient.js";
|
|
2
|
+
export type { MockOsdkObjectOptions } from "./MockOsdkObjectOptions.js";
|
|
3
|
+
export type { AggregateStubBuilder, FetchOneStubBuilder, FetchPageStubBuilder, QueryStubBuilder, StubBuilderFor } from "./StubBuilders.js";
|
|
4
|
+
export type { StubClient } from "./StubClient.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,kBAAkB;AAChC,cAAc,6BAA6B;AAC3C,cACE,sBACA,qBACA,sBACA,kBACA,sBACK;AACP,cAAc,kBAAkB","names":[],"sources":["../../../src/api/index.ts"],"version":3,"file":"index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAE3C,cAAc,eAAe,iBAAkB;AAE/C,OAAO,iBAAe,eACpBA,QAAQ,SACP,QAAQ","names":["client: Client"],"sources":["../../../../src/example-function-tests/basicAggregate/basicAggregate.ts"],"version":3,"file":"basicAggregate.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,YAAY,WAAY;AACtC,cAAc,cAAc,cAAe;AAC3C,SAAS,gBAAgB,4BAA6B;AAEtD,OAAO,iBAAe,eACpBA,QAAQ,SACP,QAAQ,KAAK,SAAS","names":["client: Client"],"sources":["../../../../src/example-function-tests/basicFetchPage/basicFetchPage.ts"],"version":3,"file":"basicFetchPage.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAE3C,cAAc,eAAe,iBAAkB;AAE/C,OAAO,iBAAe,WACpBA,QAAQ,QACRC,GAAG,UACF,QAAQ","names":["client: Client","n: Integer"],"sources":["../../../../src/example-function-tests/basicQuery/basicQuery.ts"],"version":3,"file":"basicQuery.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,YAAY,WAAY;AACtC,cAAc,gBAAgB,4BAA6B;AAE3D,OAAO,iBAAS,cACdA,QAAQ,KAAK,SAAS,YACrB,KAAK,SAAS","names":["object: Osdk.Instance<Employee>"],"sources":["../../../../src/example-function-tests/objectAsInput/objectAsInput.ts"],"version":3,"file":"objectAsInput.d.ts"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { ObjectSet } from "@osdk/api";
|
|
2
|
+
import type { Employee } from "@osdk/client.test.ontology";
|
|
3
|
+
export declare function getEmployeeNames(employees: ObjectSet<Employee>): Promise<string[]>;
|
|
4
|
+
export declare function countEmployees(employees: ObjectSet<Employee>): Promise<number>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,iBAAiB,WAAY;AAC3C,cAAc,gBAAgB,4BAA6B;AAE3D,OAAO,iBAAe,iBACpBA,WAAW,UAAU,YACpB;AAKH,OAAO,iBAAe,eACpBA,WAAW,UAAU,YACpB","names":["employees: ObjectSet<Employee>"],"sources":["../../../../src/example-function-tests/objectSetAsInput/objectSetAsInput.ts"],"version":3,"file":"objectSetAsInput.d.ts"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Osdk } from "@osdk/api";
|
|
2
|
+
import type { Employee } from "@osdk/client.test.ontology";
|
|
3
|
+
export declare function getEmployeeOfficeName(employee: Osdk.Instance<Employee>): Promise<string | undefined>;
|
|
4
|
+
export declare function getEmployeePeepNames(employee: Osdk.Instance<Employee>): Promise<string[]>;
|
|
5
|
+
export declare function countEmployeePeeps(employee: Osdk.Instance<Employee>): Promise<number>;
|
|
6
|
+
export declare function getSpecificPeep(employee: Osdk.Instance<Employee>, peepId: number): Promise<Osdk.Instance<Employee>>;
|
|
7
|
+
export declare function countPeepsViaAggregate(employee: Osdk.Instance<Employee>): Promise<number>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,YAAY,WAAY;AACtC,cAAc,gBAAgB,4BAA6B;AAE3D,OAAO,iBAAe,sBACpBA,UAAU,KAAK,SAAS,YACvB;AAKH,OAAO,iBAAe,qBACpBA,UAAU,KAAK,SAAS,YACvB;AAKH,OAAO,iBAAe,mBACpBA,UAAU,KAAK,SAAS,YACvB;AAQH,OAAO,iBAAe,gBACpBA,UAAU,KAAK,SAAS,WACxBC,iBACC,QAAQ,KAAK,SAAS;AAIzB,OAAO,iBAAe,uBACpBD,UAAU,KAAK,SAAS,YACvB","names":["employee: Osdk.Instance<Employee>","peepId: number"],"sources":["../../../../src/example-function-tests/objectWithLinks/objectWithLinks.ts"],"version":3,"file":"objectWithLinks.d.ts"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Client, Osdk } from "@osdk/client";
|
|
2
|
+
import type { $Interfaces } from "@osdk/client.test.ontology";
|
|
3
|
+
import { Employee } from "@osdk/client.test.ontology";
|
|
4
|
+
import { type Edits } from "@osdk/functions";
|
|
5
|
+
type edits = Edits.Object<Employee> | Edits.Link<Employee, "peeps"> | Edits.Interface<$Interfaces.FooInterface>;
|
|
6
|
+
export declare function ontologyEdits(client: Client, object: Osdk.Instance<Employee>): edits[];
|
|
7
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,QAAQ,YAAY,cAAe;AACjD,cAAc,mBAAmB,4BAA6B;AAC9D,SAAS,gBAA8B,4BAA6B;AACpE,cAA+B,aAAa,iBAAkB;KAEzD,QACD,MAAM,OAAO,YACb,MAAM,KAAK,UAAU,WACrB,MAAM,UAAU,YAAY;AAChC,OAAO,iBAAS,cACdA,QAAQ,QACRC,QAAQ,KAAK,SAAS,YACrB","names":["client: Client","object: Osdk.Instance<Employee>"],"sources":["../../../../src/example-function-tests/ontologyEdits/ontologyEdits.ts"],"version":3,"file":"ontologyEdits.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAG3C,OAAO,iBAAe,iBACpBA,QAAQ,SACP","names":["client: Client"],"sources":["../../../../src/example-function-tests/platformApiWithMsw/platformApiWithMsw.ts"],"version":3,"file":"platformApiWithMsw.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAG3C,OAAO,iBAAe,qBACpBA,QAAQ,QACRC,4BACC","names":["client: Client","people: readonly string[]"],"sources":["../../../../src/example-function-tests/queryWithArrayParams/queryWithArrayParams.ts"],"version":3,"file":"queryWithArrayParams.d.ts"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export type { AggregateStubBuilder, FetchOneStubBuilder, FetchPageStubBuilder, MockClient, MockOsdkObjectOptions, QueryStubBuilder, StubBuilderFor, StubClient } from "./api/index.js";
|
|
2
|
+
export { createMockAttachment } from "./mock/createMockAttachment.js";
|
|
3
|
+
export { createMockClient } from "./mock/createMockClient.js";
|
|
4
|
+
export { createMockObjectSet } from "./mock/createMockObjectSet.js";
|
|
5
|
+
export { createMockOsdkObject } from "./mock/createMockOsdkObject.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,sBACA,qBACA,sBACA,YACA,uBACA,kBACA,gBACA,kBACK;AAEP,SAAS,4BAA4B;AACrC,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,4BAA4B","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,YAAY,0BAA0B,WAAY;AAGhE,OAAO,iBAAS,qBACdA,aACAC,OAAO,MACPC,WAAW,qBACV","names":["rid: string","blob?: Blob","metadata?: AttachmentMetadata"],"sources":["../../../src/mock/createMockAttachment.ts"],"version":3,"file":"createMockAttachment.d.ts"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAwBA,cACE,kBAGK,sBAAuB;AAkC9B,OAAO,iBAAS,oBAAoB","names":[],"sources":["../../../src/mock/createMockClient.ts"],"version":3,"file":"createMockClient.d.ts"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { ObjectOrInterfaceDefinition, ObjectSet } from "@osdk/api";
|
|
2
|
+
import { type Call } from "./createMockObjectSetWithResolver.js";
|
|
3
|
+
declare const MOCK_OBJECT_SET_BRAND: unique symbol;
|
|
4
|
+
export type MockObjectSetBranded<Q extends ObjectOrInterfaceDefinition> = ObjectSet<Q> & {
|
|
5
|
+
[MOCK_OBJECT_SET_BRAND]: true
|
|
6
|
+
__registerStub(calls: Call[], value: unknown): void
|
|
7
|
+
};
|
|
8
|
+
export declare function createMockObjectSet<Q extends ObjectOrInterfaceDefinition>(objectType: Q): ObjectSet<Q>;
|
|
9
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,6BAA6B,iBAAiB,WAAY;AACxE,cACO,YAIA,sCAAuC;AAE9C,cAAMA;AAEN,YAAY,qBAAqB,UAAU,+BACvC,UAAU,KACV;EACC,wBAAwB;CACzB,eAAeC,OAAO,QAAQC;AAC/B;AAEH,OAAO,iBAAS,oBAAoB,UAAU,6BAC5CC,YAAY,IACX,UAAU","names":["MOCK_OBJECT_SET_BRAND: unique symbol","calls: Call[]","value: unknown","objectType: Q"],"sources":["../../../src/mock/createMockObjectSet.ts"],"version":3,"file":"createMockObjectSet.d.ts"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { ObjectOrInterfaceDefinition, ObjectSet } from "@osdk/api";
|
|
2
|
+
export type Call = [method: string, args: unknown];
|
|
3
|
+
export type Resolver = (calls: Call[]) => unknown;
|
|
4
|
+
export type Stub = {
|
|
5
|
+
calls: Call[]
|
|
6
|
+
value: unknown
|
|
7
|
+
};
|
|
8
|
+
export declare function createMockObjectSetWithResolver<Q extends ObjectOrInterfaceDefinition>(objectType: Q, resolver: Resolver, calls?: Call[]): ObjectSet<Q>;
|
|
9
|
+
export declare function resolveStub(stubs: Stub[], calls: Call[], errorMsg: string): unknown;
|
|
10
|
+
export declare function deepEqual(a: unknown, b: unknown): boolean;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAGE,6BACA,iBAIK,WAAY;AAGnB,YAAY,QAAQ,gBAAgB;AAEpC,YAAY,YAAYA,OAAO;AAE/B,YAAY,OAAO;CAAE,OAAO;CAAQ;AAAgB;AAEpD,OAAO,iBAAS,gCACd,UAAU,6BAEVC,YAAY,GACZC,UAAU,UACVF,QAAO,SACN,UAAU;AA6Eb,OAAO,iBAAS,YACdG,OAAO,QACPH,OAAO,QACPI;AAmBF,OAAO,iBAAS,UAAUC,YAAYC","names":["calls: Call[]","objectType: Q","resolver: Resolver","stubs: Stub[]","errorMsg: string","a: unknown","b: unknown"],"sources":["../../../src/mock/createMockObjectSetWithResolver.ts"],"version":3,"file":"createMockObjectSetWithResolver.d.ts"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { CompileTimeMetadata, ObjectTypeDefinition, Osdk } from "@osdk/api";
|
|
2
|
+
import type { MockOsdkObjectOptions } from "../api/MockOsdkObjectOptions.js";
|
|
3
|
+
/**
|
|
4
|
+
* Creates a mock OSDK object for testing purposes.
|
|
5
|
+
*
|
|
6
|
+
* The mock object has the same shape as a real OSDK object including:
|
|
7
|
+
* - $apiName, $objectType, $primaryKey, $title, $rid
|
|
8
|
+
* - All provided properties
|
|
9
|
+
* - Stub implementations that throw errors for unsupported operations
|
|
10
|
+
*
|
|
11
|
+
* Note: The primary key property must be included in the provided properties.
|
|
12
|
+
* The primary key API name is read from the object type definition's
|
|
13
|
+
* `primaryKeyApiName` field (set on generated object consts).
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* const employee = createMockOsdkObject(
|
|
18
|
+
* Employee,
|
|
19
|
+
* { employeeId: 1, fullName: "John Doe" },
|
|
20
|
+
* { titlePropertyApiName: "fullName" },
|
|
21
|
+
* );
|
|
22
|
+
*
|
|
23
|
+
* expect(employee.$primaryKey).toBe(1);
|
|
24
|
+
* expect(employee.$title).toBe("John Doe");
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* @param objectType - The object type definition (e.g., Employee)
|
|
28
|
+
* @param properties - The properties for the mock object
|
|
29
|
+
* @param options - Configuration including links, titlePropertyApiName, and $rid
|
|
30
|
+
* @returns A frozen mock OSDK object
|
|
31
|
+
*/
|
|
32
|
+
export declare function createMockOsdkObject<Q extends ObjectTypeDefinition>(objectType: Q, properties?: Partial<CompileTimeMetadata<Q>["props"]>, options?: MockOsdkObjectOptions<Q>): Osdk.Instance<Q>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,qBACA,sBACA,YAEK,WAAY;AAEnB,cAAc,6BAA6B,iCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkI7E,OAAO,iBAAS,qBACd,UAAU,sBAEVA,YAAY,GACZC,aAAa,QAAQ,oBAAoB,GAAG,WAC5CC,UAAS,sBAAsB,KAC9B,KAAK,SAAS","names":["objectType: Q","properties?: Partial<CompileTimeMetadata<Q>[\"props\"]>","options: MockOsdkObjectOptions<Q>"],"sources":["../../../src/mock/createMockOsdkObject.ts"],"version":3,"file":"createMockOsdkObject.d.ts"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export type { AggregateStubBuilder, FetchOneStubBuilder, FetchPageStubBuilder, QueryStubBuilder, StubBuilderFor } from "../api/index.js";
|
|
2
|
+
export { createMockAttachment } from "../mock/createMockAttachment.js";
|
|
3
|
+
export { createMockClient } from "../mock/createMockClient.js";
|
|
4
|
+
export { createMockObjectSet } from "../mock/createMockObjectSet.js";
|
|
5
|
+
export { createMockOsdkObject } from "../mock/createMockOsdkObject.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cACE,sBACA,qBACA,sBACA,kBACA,sBACK;AACP,SAAS,4BAA4B;AACrC,SAAS,wBAAwB;AACjC,SAAS,2BAA2B;AACpC,SAAS,4BAA4B","names":[],"sources":["../../../src/public/experimental.ts"],"version":3,"file":"experimental.d.ts"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2024 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
export * from "./build/cjs/public/experimental.cjs";
|
package/package.json
CHANGED
|
@@ -1,4 +1,94 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/unit-testing",
|
|
3
|
-
"version": "0.
|
|
4
|
-
|
|
3
|
+
"version": "0.9.0",
|
|
4
|
+
"description": "",
|
|
5
|
+
"access": "public",
|
|
6
|
+
"license": "Apache-2.0",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/palantir/osdk-ts.git"
|
|
10
|
+
},
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"browser": "./build/browser/index.js",
|
|
14
|
+
"import": {
|
|
15
|
+
"types": "./build/types/index.d.ts",
|
|
16
|
+
"default": "./build/esm/index.js"
|
|
17
|
+
},
|
|
18
|
+
"require": "./build/cjs/index.cjs",
|
|
19
|
+
"default": "./build/browser/index.js"
|
|
20
|
+
},
|
|
21
|
+
"./experimental": {
|
|
22
|
+
"browser": "./build/browser/public/experimental.js",
|
|
23
|
+
"import": {
|
|
24
|
+
"types": "./build/types/public/experimental.d.ts",
|
|
25
|
+
"default": "./build/esm/public/experimental.js"
|
|
26
|
+
},
|
|
27
|
+
"require": "./build/cjs/public/experimental.cjs",
|
|
28
|
+
"default": "./build/browser/public/experimental.js"
|
|
29
|
+
},
|
|
30
|
+
"./*": {
|
|
31
|
+
"browser": "./build/browser/public/*.js",
|
|
32
|
+
"import": {
|
|
33
|
+
"types": "./build/types/public/*.d.ts",
|
|
34
|
+
"default": "./build/esm/public/*.js"
|
|
35
|
+
},
|
|
36
|
+
"require": "./build/cjs/public/*.cjs",
|
|
37
|
+
"default": "./build/browser/public/*.js"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"dependencies": {
|
|
41
|
+
"tiny-invariant": "^1.3.3",
|
|
42
|
+
"vitest": "^3.2.4"
|
|
43
|
+
},
|
|
44
|
+
"peerDependencies": {
|
|
45
|
+
"@osdk/api": "^2.19.0",
|
|
46
|
+
"@osdk/functions": "^1.9.0",
|
|
47
|
+
"@osdk/client": "^2.19.0"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@microsoft/api-documenter": "^7.26.32",
|
|
51
|
+
"@microsoft/api-extractor": "^7.52.11",
|
|
52
|
+
"@osdk/foundry.admin": "2.57.0",
|
|
53
|
+
"msw": "^2.11.1",
|
|
54
|
+
"typescript": "~5.5.4",
|
|
55
|
+
"@osdk/api": "~2.19.0",
|
|
56
|
+
"@osdk/client": "~2.19.0",
|
|
57
|
+
"@osdk/client.test.ontology": "~2.19.0",
|
|
58
|
+
"@osdk/monorepo.api-extractor": "~0.7.0",
|
|
59
|
+
"@osdk/functions": "~1.9.0",
|
|
60
|
+
"@osdk/monorepo.tsconfig": "~0.7.0"
|
|
61
|
+
},
|
|
62
|
+
"publishConfig": {
|
|
63
|
+
"access": "public"
|
|
64
|
+
},
|
|
65
|
+
"keywords": [],
|
|
66
|
+
"files": [
|
|
67
|
+
"build/cjs",
|
|
68
|
+
"build/esm",
|
|
69
|
+
"build/browser",
|
|
70
|
+
"build/types",
|
|
71
|
+
"CHANGELOG.md",
|
|
72
|
+
"package.json",
|
|
73
|
+
"templates",
|
|
74
|
+
"*.d.ts"
|
|
75
|
+
],
|
|
76
|
+
"main": "./build/cjs/index.cjs",
|
|
77
|
+
"module": "./build/esm/index.js",
|
|
78
|
+
"types": "./build/cjs/index.d.cts",
|
|
79
|
+
"type": "module",
|
|
80
|
+
"scripts": {
|
|
81
|
+
"check-api": "api-extractor run --verbose --local",
|
|
82
|
+
"check-attw": "attw --pack .",
|
|
83
|
+
"check-spelling": "cspell --quiet .",
|
|
84
|
+
"clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
|
|
85
|
+
"fix-lint": "eslint . --fix && dprint fmt",
|
|
86
|
+
"lint": "eslint . && dprint check",
|
|
87
|
+
"test": "vitest run --pool=forks",
|
|
88
|
+
"transpileBrowser": "monorepo.tool.transpile -f esm -m normal -t browser",
|
|
89
|
+
"transpileCjs": "monorepo.tool.transpile -f cjs -m bundle -t node",
|
|
90
|
+
"transpileEsm": "monorepo.tool.transpile -f esm -m normal -t node",
|
|
91
|
+
"transpileTypes": "monorepo.tool.transpile -f esm -m types -t node",
|
|
92
|
+
"typecheck": "tsc --noEmit --emitDeclarationOnly false"
|
|
93
|
+
}
|
|
94
|
+
}
|