@osdk/client 2.0.0-beta.13 → 2.0.0-beta.15

package/build/esm/fetchMetadata.test.js

@@ -0,0 +1,218 @@
+/*
+ * Copyright 2024 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 { $Actions, $Interfaces, $Objects, $ontologyRid, $Queries } from "@osdk/client.test.ontology";
+import { apiServer } from "@osdk/shared.test";
+import { afterAll, beforeAll, describe, expect, expectTypeOf, it } from "vitest";
+import { createClient } from "./createClient.js";
+describe("FetchMetadata", () => {
+  let client;
+  beforeAll(async () => {
+    apiServer.listen();
+    client = createClient("https://stack.palantir.com", $ontologyRid, async () => "myAccessToken");
+  });
+  afterAll(() => {
+    apiServer.close();
+  });
+  it("fetches object metadata correctly", async () => {
+    const objectMetadata = await client.fetchMetadata($Objects.Employee);
+    expectTypeOf(objectMetadata).toEqualTypeOf();
+    expect(objectMetadata).toMatchInlineSnapshot(`
+      {
+        "apiName": "Employee",
+        "description": "A full-time or part-time 
+
+       employee of our firm",
+        "displayName": "Employee",
+        "icon": {
+          "color": "blue",
+          "name": "person",
+          "type": "blueprint",
+        },
+        "implements": [
+          "FooInterface",
+        ],
+        "interfaceMap": {
+          "FooInterface": {
+            "fooSpt": "fullName",
+          },
+        },
+        "inverseInterfaceMap": {
+          "FooInterface": {
+            "fullName": "fooSpt",
+          },
+        },
+        "links": {
+          "lead": {
+            "multiplicity": false,
+            "targetType": "Employee",
+          },
+          "officeLink": {
+            "multiplicity": false,
+            "targetType": "Office",
+          },
+          "peeps": {
+            "multiplicity": true,
+            "targetType": "Employee",
+          },
+        },
+        "pluralDisplayName": "Employees",
+        "primaryKeyApiName": "employeeId",
+        "primaryKeyType": "integer",
+        "properties": {
+          "employeeId": {
+            "description": undefined,
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": false,
+            "type": "integer",
+          },
+          "employeeStatus": {
+            "description": "TimeSeries of the status of the employee",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "stringTimeseries",
+          },
+          "fullName": {
+            "description": undefined,
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
+          "office": {
+            "description": "The unique "ID" of the employee's \\"primary\\" assigned office.
+       This is some more text.",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
+          "startDate": {
+            "description": "The date the employee was hired (most recently, if they were re-hired)",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "datetime",
+          },
+        },
+        "rid": "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44",
+        "status": "ACTIVE",
+        "titleProperty": "fullName",
+        "type": "object",
+        "visibility": "NORMAL",
+      }
+    `);
+  });
+  it("fetches interface metadata correctly", async () => {
+    const interfaceMetadata = await client.fetchMetadata($Interfaces.FooInterface);
+    expectTypeOf(interfaceMetadata).toEqualTypeOf();
+    expect(interfaceMetadata).toMatchInlineSnapshot(`
+      {
+        "apiName": "FooInterface",
+        "description": "Interface for Foo",
+        "displayName": "Foo Interface",
+        "implements": [],
+        "links": {},
+        "properties": {
+          "fooSpt": {
+            "description": "A foo",
+            "displayName": "Foo",
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
+        },
+        "rid": "ri.interface.main.interface.1",
+        "type": "interface",
+      }
+    `);
+  });
+  it("fetches action metadata correctly", async () => {
+    const actionMetadata = await client.fetchMetadata($Actions.moveOffice);
+    expectTypeOf(actionMetadata).toEqualTypeOf();
+    expect(actionMetadata).toMatchInlineSnapshot(`
+      {
+        "apiName": "moveOffice",
+        "description": "Update an office's physical location",
+        "displayName": "move-office",
+        "modifiedEntities": {
+          "Office": {
+            "created": false,
+            "modified": true,
+          },
+        },
+        "parameters": {
+          "newAddress": {
+            "description": "The office's new physical address (not necessarily shipping address)",
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
+          "newCapacity": {
+            "description": "The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)",
+            "multiplicity": false,
+            "nullable": true,
+            "type": "integer",
+          },
+          "officeId": {
+            "description": undefined,
+            "multiplicity": false,
+            "nullable": false,
+            "type": "string",
+          },
+          "officeNames": {
+            "description": "A list of all office names",
+            "multiplicity": true,
+            "nullable": true,
+            "type": "integer",
+          },
+        },
+        "rid": "ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2",
+        "status": "ACTIVE",
+        "type": "action",
+      }
+    `);
+  });
+  it("fetches query metadata correctly", async () => {
+    const queryMetadata = await client.fetchMetadata($Queries.queryAcceptsObject);
+    expectTypeOf(queryMetadata).toEqualTypeOf();
+    expect(queryMetadata).toMatchInlineSnapshot(`
+      {
+        "apiName": "queryAcceptsObject",
+        "description": "description of the query that takes object types",
+        "displayName": "QueryAcceptsObject",
+        "output": {
+          "nullable": false,
+          "object": "Employee",
+          "type": "object",
+        },
+        "parameters": {
+          "object": {
+            "description": undefined,
+            "nullable": false,
+            "object": "Employee",
+            "type": "object",
+          },
+        },
+        "rid": "ri.function-registry.main.function.9b55870a-63c7-4d48-8f06-9627c0805968",
+        "type": "query",
+        "version": "0.11.0",
+      }
+    `);
+  });
+});
+//# sourceMappingURL=fetchMetadata.test.js.map

package/build/esm/fetchMetadata.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchMetadata.test.js","names":["$Actions","$Interfaces","$Objects","$ontologyRid","$Queries","apiServer","afterAll","beforeAll","describe","expect","expectTypeOf","it","createClient","client","listen","close","objectMetadata","fetchMetadata","Employee","toEqualTypeOf","toMatchInlineSnapshot","interfaceMetadata","FooInterface","actionMetadata","moveOffice","queryMetadata","queryAcceptsObject"],"sources":["fetchMetadata.test.js"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport { $Actions, $Interfaces, $Objects, $ontologyRid, $Queries, } from \"@osdk/client.test.ontology\";\nimport { apiServer } from \"@osdk/shared.test\";\nimport { afterAll, beforeAll, describe, expect, expectTypeOf, it, } from \"vitest\";\nimport { createClient } from \"./createClient.js\";\ndescribe(\"FetchMetadata\", () => {\n    let client;\n    beforeAll(async () => {\n        apiServer.listen();\n        client = createClient(\"https://stack.palantir.com\", $ontologyRid, async () => \"myAccessToken\");\n    });\n    afterAll(() => {\n        apiServer.close();\n    });\n    it(\"fetches object metadata correctly\", async () => {\n        const objectMetadata = await client.fetchMetadata($Objects.Employee);\n        expectTypeOf(objectMetadata).toEqualTypeOf();\n        expect(objectMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"Employee\",\n        \"description\": \"A full-time or part-time \n\n       employee of our firm\",\n        \"displayName\": \"Employee\",\n        \"icon\": {\n          \"color\": \"blue\",\n          \"name\": \"person\",\n          \"type\": \"blueprint\",\n        },\n        \"implements\": [\n          \"FooInterface\",\n        ],\n        \"interfaceMap\": {\n          \"FooInterface\": {\n            \"fooSpt\": \"fullName\",\n          },\n        },\n        \"inverseInterfaceMap\": {\n          \"FooInterface\": {\n            \"fullName\": \"fooSpt\",\n          },\n        },\n        \"links\": {\n          \"lead\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Employee\",\n          },\n          \"officeLink\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Office\",\n          },\n          \"peeps\": {\n            \"multiplicity\": true,\n            \"targetType\": \"Employee\",\n          },\n        },\n        \"pluralDisplayName\": \"Employees\",\n        \"primaryKeyApiName\": \"employeeId\",\n        \"primaryKeyType\": \"integer\",\n        \"properties\": {\n          \"employeeId\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"integer\",\n          },\n          \"employeeStatus\": {\n            \"description\": \"TimeSeries of the status of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"stringTimeseries\",\n          },\n          \"fullName\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"office\": {\n            \"description\": \"The unique \"ID\" of the employee's \\\\\"primary\\\\\" assigned office.\n       This is some more text.\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"startDate\": {\n            \"description\": \"The date the employee was hired (most recently, if they were re-hired)\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"datetime\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44\",\n        \"status\": \"ACTIVE\",\n        \"titleProperty\": \"fullName\",\n        \"type\": \"object\",\n        \"visibility\": \"NORMAL\",\n      }\n    `);\n    });\n    it(\"fetches interface metadata correctly\", async () => {\n        const interfaceMetadata = await client.fetchMetadata($Interfaces.FooInterface);\n        expectTypeOf(interfaceMetadata).toEqualTypeOf();\n        expect(interfaceMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"FooInterface\",\n        \"description\": \"Interface for Foo\",\n        \"displayName\": \"Foo Interface\",\n        \"implements\": [],\n        \"links\": {},\n        \"properties\": {\n          \"fooSpt\": {\n            \"description\": \"A foo\",\n            \"displayName\": \"Foo\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n        },\n        \"rid\": \"ri.interface.main.interface.1\",\n        \"type\": \"interface\",\n      }\n    `);\n    });\n    it(\"fetches action metadata correctly\", async () => {\n        const actionMetadata = await client.fetchMetadata($Actions.moveOffice);\n        expectTypeOf(actionMetadata).toEqualTypeOf();\n        expect(actionMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"moveOffice\",\n        \"description\": \"Update an office's physical location\",\n        \"displayName\": \"move-office\",\n        \"modifiedEntities\": {\n          \"Office\": {\n            \"created\": false,\n            \"modified\": true,\n          },\n        },\n        \"parameters\": {\n          \"newAddress\": {\n            \"description\": \"The office's new physical address (not necessarily shipping address)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"newCapacity\": {\n            \"description\": \"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n          \"officeId\": {\n            \"description\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"string\",\n          },\n          \"officeNames\": {\n            \"description\": \"A list of all office names\",\n            \"multiplicity\": true,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2\",\n        \"status\": \"ACTIVE\",\n        \"type\": \"action\",\n      }\n    `);\n    });\n    it(\"fetches query metadata correctly\", async () => {\n        const queryMetadata = await client.fetchMetadata($Queries.queryAcceptsObject);\n        expectTypeOf(queryMetadata).toEqualTypeOf();\n        expect(queryMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"queryAcceptsObject\",\n        \"description\": \"description of the query that takes object types\",\n        \"displayName\": \"QueryAcceptsObject\",\n        \"output\": {\n          \"nullable\": false,\n          \"object\": \"Employee\",\n          \"type\": \"object\",\n        },\n        \"parameters\": {\n          \"object\": {\n            \"description\": undefined,\n            \"nullable\": false,\n            \"object\": \"Employee\",\n            \"type\": \"object\",\n          },\n        },\n        \"rid\": \"ri.function-registry.main.function.9b55870a-63c7-4d48-8f06-9627c0805968\",\n        \"type\": \"query\",\n        \"version\": \"0.11.0\",\n      }\n    `);\n    });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,QAAQ,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,QAAS,4BAA4B;AACrG,SAASC,SAAS,QAAQ,mBAAmB;AAC7C,SAASC,QAAQ,EAAEC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,YAAY,EAAEC,EAAE,QAAS,QAAQ;AACjF,SAASC,YAAY,QAAQ,mBAAmB;AAChDJ,QAAQ,CAAC,eAAe,EAAE,MAAM;EAC5B,IAAIK,MAAM;EACVN,SAAS,CAAC,YAAY;IAClBF,SAAS,CAACS,MAAM,CAAC,CAAC;IAClBD,MAAM,GAAGD,YAAY,CAAC,4BAA4B,EAAET,YAAY,EAAE,YAAY,eAAe,CAAC;EAClG,CAAC,CAAC;EACFG,QAAQ,CAAC,MAAM;IACXD,SAAS,CAACU,KAAK,CAAC,CAAC;EACrB,CAAC,CAAC;EACFJ,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAChD,MAAMK,cAAc,GAAG,MAAMH,MAAM,CAACI,aAAa,CAACf,QAAQ,CAACgB,QAAQ,CAAC;IACpER,YAAY,CAACM,cAAc,CAAC,CAACG,aAAa,CAAC,CAAC;IAC5CV,MAAM,CAACO,cAAc,CAAC,CAACI,qBAAqB,CAAC;AACrD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACF,CAAC,CAAC;EACFT,EAAE,CAAC,sCAAsC,EAAE,YAAY;IACnD,MAAMU,iBAAiB,GAAG,MAAMR,MAAM,CAACI,aAAa,CAAChB,WAAW,CAACqB,YAAY,CAAC;IAC9EZ,YAAY,CAACW,iBAAiB,CAAC,CAACF,aAAa,CAAC,CAAC;IAC/CV,MAAM,CAACY,iBAAiB,CAAC,CAACD,qBAAqB,CAAC;AACxD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACF,CAAC,CAAC;EACFT,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAChD,MAAMY,cAAc,GAAG,MAAMV,MAAM,CAACI,aAAa,CAACjB,QAAQ,CAACwB,UAAU,CAAC;IACtEd,YAAY,CAACa,cAAc,CAAC,CAACJ,aAAa,CAAC,CAAC;IAC5CV,MAAM,CAACc,cAAc,CAAC,CAACH,qBAAqB,CAAC;AACrD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACF,CAAC,CAAC;EACFT,EAAE,CAAC,kCAAkC,EAAE,YAAY;IAC/C,MAAMc,aAAa,GAAG,MAAMZ,MAAM,CAACI,aAAa,CAACb,QAAQ,CAACsB,kBAAkB,CAAC;IAC7EhB,YAAY,CAACe,aAAa,CAAC,CAACN,aAAa,CAAC,CAAC;IAC3CV,MAAM,CAACgB,aAAa,CAAC,CAACL,qBAAqB,CAAC;AACpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACF,CAAC,CAAC;AACN,CAAC,CAAC","ignoreList":[]}

package/build/esm/index.d.ts

@@ -1,5 +1,5 @@
-export type { ActionEditResponse, ActionReturnTypeForOptions, ActionValidationResponse, ApplyActionOptions, ApplyBatchActionOptions, InterfaceObjectSet, ObjectSet, Osdk, OsdkObject, PageResult, Result, WhereClause, } from "@osdk/client.api";
-export { isOk } from "@osdk/client.api";
+export type { ActionEditResponse, ActionReturnTypeForOptions, ActionValidationResponse, ApplyActionOptions, ApplyBatchActionOptions, ObjectSet, Osdk, OsdkObject, PageResult, Result, WhereClause, } from "@osdk/api";
+export { isOk } from "@osdk/api";
 export { PalantirApiError } from "@osdk/shared.net.errors";
 export { ActionValidationError } from "./actions/ActionValidationError.js";
 export type { Client } from "./Client.js";

package/build/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,SAAS,EACT,IAAI,EACJ,UAAU,EACV,UAAU,EACV,MAAM,EACN,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,SAAS,EACT,IAAI,EACJ,UAAU,EACV,UAAU,EACV,MAAM,EACN,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}