@osdk/client 2.38.0 → 2.39.0

package/build/esm/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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\nimport type {\n  ActionDefinition,\n  ActionMetadata,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  InterfaceMetadata,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  VersionBound,\n} from \"@osdk/api\";\nimport type {\n  Experiment,\n  ExperimentFns,\n  MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> = Q extends VersionBound<infer V> ? (\n    SatisfiesSemver<V, MaxOsdkVersion> extends true ? Q\n      : Q & {\n        [ErrorMessage]:\n          `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n      }\n  )\n  : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n  /**\n   * Returns the operation surface for the given ontology definition. The shape of the\n   * returned value is dispatched on what kind of definition is passed:\n   * - object type → the object set type for that ontology object (typically a generated extension of {@link ObjectSet})\n   * - interface → a {@link MinimalObjectSet} for the interface\n   * - action → a callable with `applyAction` / `batchApplyAction`\n   * - query → a callable with `executeFunction`\n   * - experiment → the unstable feature surface for that experiment\n   *\n   * @param o - The object type definition to wrap.\n   * @example\n   * ```ts\n   * const employees = await client(Employee).fetchPage({ $pageSize: 30 });\n   * const employee = await client(Employee).fetchOne(12345);\n   * ```\n   * @returns an object set scoped to all objects of this type.\n   */\n  <Q extends ObjectTypeDefinition>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? ObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  /**\n   * @param o - The interface definition to wrap.\n   * @example\n   * ```ts\n   * const page = await client(MyInterface).fetchPage({ $pageSize: 30 });\n   * ```\n   * @returns a minimal object set over all objects implementing the interface.\n   */\n  <Q extends (InterfaceDefinition)>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? MinimalObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  /**\n   * @param o - The action definition to invoke.\n   * @example\n   * ```ts\n   * const result = await client(createEmployee).applyAction(\n   *   { name: \"Jane\", department: \"Engineering\" },\n   *   { $returnEdits: true },\n   * );\n   * ```\n   * @returns a callable for applying (or batch-applying) the action.\n   */\n  <Q extends ActionDefinition<any>>(\n    o: Q,\n  ): ActionSignatureFromDef<Q>;\n\n  /**\n   * @param o - The query definition to invoke.\n   * @example\n   * ```ts\n   * const result = await client(getEmployeeCount).executeFunction({ department: \"Engineering\" });\n   * ```\n   * @returns a callable for executing the query function.\n   */\n  <Q extends QueryDefinition<any>>(\n    o: Q,\n  ): QuerySignatureFromDef<Q>;\n\n  /**\n   * @param experiment - The experiment marker that gates an unstable feature.\n   * @example\n   * ```ts\n   * const ref = await client(__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference)\n   *   .createMediaReference({ data: blob, fileName: \"media.mp4\", objectType: Employee, propertyType: \"photo\" });\n   * ```\n   * @returns the experiment-specific function surface.\n   */\n  <\n    Q extends\n      | Experiment<\"2.0.8\">\n      | Experiment<\"2.1.0\">\n      | Experiment<\"2.2.0\">\n      | Experiment<\"2.8.0\">\n      | Experiment<\"2.19.0\">,\n  >(\n    experiment: Q,\n  ): ExperimentFns<Q>;\n\n  /**\n   * Fetches runtime metadata for the given ontology definition. The returned shape\n   * is dispatched on the kind of definition passed: {@link ObjectMetadata},\n   * {@link InterfaceMetadata}, {@link ActionMetadata}, or {@link QueryMetadata}.\n   * @param o - The object type, interface, action, or query definition to look up.\n   * @example\n   * ```ts\n   * const meta = await client.fetchMetadata(Employee);\n   * console.log(meta.displayName, meta.description);\n   * ```\n   * @returns a promise resolving to the metadata for the given definition.\n   */\n  fetchMetadata<\n    Q extends (\n      | ObjectTypeDefinition\n      | InterfaceDefinition\n      | ActionDefinition<any>\n      | QueryDefinition<any>\n    ),\n  >(o: Q): Promise<\n    Q extends ObjectTypeDefinition ? ObjectMetadata\n      : Q extends InterfaceDefinition ? InterfaceMetadata\n      : Q extends ActionDefinition<any> ? ActionMetadata\n      : Q extends QueryDefinition<any> ? QueryMetadata\n      : never\n  >;\n\n  /** @internal */\n  [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.38.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA;;AA8HA;AACA;AACA,OAAO,MAAMA,iBAAgC,GAAGC,MAAM,CAAC,mBAAmB,CAAC;;AAE3E;AACA,MAAMC,cAAc,GAAG,QAAQ;AAC/B;;AAEA,MAAMC,YAA2B,GAAGF,MAAM,CAAC,cAAc,CAAC","ignoreList":[]}
+{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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\nimport type {\n  ActionDefinition,\n  ActionMetadata,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  InterfaceMetadata,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  VersionBound,\n} from \"@osdk/api\";\nimport type {\n  Experiment,\n  ExperimentFns,\n  MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> = Q extends VersionBound<infer V> ? (\n    SatisfiesSemver<V, MaxOsdkVersion> extends true ? Q\n      : Q & {\n        [ErrorMessage]:\n          `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n      }\n  )\n  : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n  /**\n   * Returns the operation surface for the given ontology definition. The shape of the\n   * returned value is dispatched on what kind of definition is passed:\n   * - object type → the object set type for that ontology object (typically a generated extension of {@link ObjectSet})\n   * - interface → a {@link MinimalObjectSet} for the interface\n   * - action → a callable with `applyAction` / `batchApplyAction`\n   * - query → a callable with `executeFunction`\n   * - experiment → the unstable feature surface for that experiment\n   *\n   * @param o - The object type definition to wrap.\n   * @example\n   * ```ts\n   * const employees = await client(Employee).fetchPage({ $pageSize: 30 });\n   * const employee = await client(Employee).fetchOne(12345);\n   * ```\n   * @returns an object set scoped to all objects of this type.\n   */\n  <Q extends ObjectTypeDefinition>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? ObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  /**\n   * @param o - The interface definition to wrap.\n   * @example\n   * ```ts\n   * const page = await client(MyInterface).fetchPage({ $pageSize: 30 });\n   * ```\n   * @returns a minimal object set over all objects implementing the interface.\n   */\n  <Q extends (InterfaceDefinition)>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? MinimalObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  /**\n   * @param o - The action definition to invoke.\n   * @example\n   * ```ts\n   * const result = await client(createEmployee).applyAction(\n   *   { name: \"Jane\", department: \"Engineering\" },\n   *   { $returnEdits: true },\n   * );\n   * ```\n   * @returns a callable for applying (or batch-applying) the action.\n   */\n  <Q extends ActionDefinition<any>>(\n    o: Q,\n  ): ActionSignatureFromDef<Q>;\n\n  /**\n   * @param o - The query definition to invoke.\n   * @example\n   * ```ts\n   * const result = await client(getEmployeeCount).executeFunction({ department: \"Engineering\" });\n   * ```\n   * @returns a callable for executing the query function.\n   */\n  <Q extends QueryDefinition<any>>(\n    o: Q,\n  ): QuerySignatureFromDef<Q>;\n\n  /**\n   * @param experiment - The experiment marker that gates an unstable feature.\n   * @example\n   * ```ts\n   * const ref = await client(__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference)\n   *   .createMediaReference({ data: blob, fileName: \"media.mp4\", objectType: Employee, propertyType: \"photo\" });\n   * ```\n   * @returns the experiment-specific function surface.\n   */\n  <\n    Q extends\n      | Experiment<\"2.0.8\">\n      | Experiment<\"2.1.0\">\n      | Experiment<\"2.2.0\">\n      | Experiment<\"2.8.0\">\n      | Experiment<\"2.19.0\">,\n  >(\n    experiment: Q,\n  ): ExperimentFns<Q>;\n\n  /**\n   * Fetches runtime metadata for the given ontology definition. The returned shape\n   * is dispatched on the kind of definition passed: {@link ObjectMetadata},\n   * {@link InterfaceMetadata}, {@link ActionMetadata}, or {@link QueryMetadata}.\n   * @param o - The object type, interface, action, or query definition to look up.\n   * @example\n   * ```ts\n   * const meta = await client.fetchMetadata(Employee);\n   * console.log(meta.displayName, meta.description);\n   * ```\n   * @returns a promise resolving to the metadata for the given definition.\n   */\n  fetchMetadata<\n    Q extends (\n      | ObjectTypeDefinition\n      | InterfaceDefinition\n      | ActionDefinition<any>\n      | QueryDefinition<any>\n    ),\n  >(o: Q): Promise<\n    Q extends ObjectTypeDefinition ? ObjectMetadata\n      : Q extends InterfaceDefinition ? InterfaceMetadata\n      : Q extends ActionDefinition<any> ? ActionMetadata\n      : Q extends QueryDefinition<any> ? QueryMetadata\n      : never\n  >;\n\n  /** @internal */\n  [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.39.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA;;AA8HA;AACA;AACA,OAAO,MAAMA,iBAAgC,GAAGC,MAAM,CAAC,mBAAmB,CAAC;;AAE3E;AACA,MAAMC,cAAc,GAAG,QAAQ;AAC/B;;AAEA,MAAMC,YAA2B,GAAGF,MAAM,CAAC,cAAc,CAAC","ignoreList":[]}

package/build/esm/util/UserAgent.js

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-export const USER_AGENT = `osdk-client/${"2.38.0"}`;
-export const OBSERVABLE_USER_AGENT = `osdk-observable-client/${"2.38.0"}`;
+export const USER_AGENT = `osdk-client/${"2.39.0"}`;
+export const OBSERVABLE_USER_AGENT = `osdk-observable-client/${"2.39.0"}`;
 //# sourceMappingURL=UserAgent.js.map

package/build/types/Client.d.ts

@@ -81,7 +81,7 @@ export interface Client extends SharedClient, OldSharedClient {
 	*/
 	fetchMetadata<Q extends (ObjectTypeDefinition | InterfaceDefinition | ActionDefinition<any> | QueryDefinition<any>)>(o: Q): Promise<Q extends ObjectTypeDefinition ? ObjectMetadata : Q extends InterfaceDefinition ? InterfaceMetadata : Q extends ActionDefinition<any> ? ActionMetadata : Q extends QueryDefinition<any> ? QueryMetadata : never>;
 }
-declare const MaxOsdkVersion = "2.38.0";
+declare const MaxOsdkVersion = "2.39.0";
 export type MaxOsdkVersion = typeof MaxOsdkVersion;
 declare const ErrorMessage: unique symbol;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/client",
-  "version": "2.38.0",
+  "version": "2.39.0",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -82,12 +82,12 @@
     "tiny-invariant": "^1.3.3",
     "type-fest": "^4.41.0",
     "ws": "^8.20.1",
-    "@osdk/api": "~2.38.0",
-    "@osdk/client.unstable": "2.38.0",
-    "@osdk/generator-converters": "2.38.0",
-    "@osdk/shared.client.impl": "~1.13.0",
+    "@osdk/api": "~2.39.0",
+    "@osdk/client.unstable": "2.39.0",
     "@osdk/shared.net.errors": "~2.11.0",
-    "@osdk/shared.net.fetch": "~1.11.0"
+    "@osdk/shared.net.fetch": "~1.11.0",
+    "@osdk/shared.client.impl": "~1.13.0",
+    "@osdk/generator-converters": "2.39.0"
   },
   "peerDependencies": {
     "@osdk/shared.test": "^2.28.0"
@@ -117,7 +117,7 @@
     "ts-expect": "^1.3.0",
     "typescript": "~5.5.4",
     "zod": "^3.25.76",
-    "@osdk/client.test.ontology": "2.38.0",
+    "@osdk/client.test.ontology": "2.39.0",
     "@osdk/monorepo.api-extractor": "~0.7.0",
     "@osdk/monorepo.tsconfig": "~0.7.0",
     "@osdk/shared.test.intellisense": "~0.6.0"