@osdk/client 0.20.0-beta.3 → 0.20.0-beta.4

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @osdk/client
 
+## 0.20.0-beta.4
+
+### Minor Changes
+
+- 7afa226: Fix action params that take objects to correctly parse out primary key.
+- 3ec7c38: Add support for queries in 2.0
+- 4824449: Fix asyncIter to fetch subsequent pages
+- bc89b62: Spelling fixes and spell check in CI
+- a92e032: ClientCache now uses a key field as the cache key instead of the entire client
+
+### Patch Changes
+
+- Updated dependencies [3ec7c38]
+- Updated dependencies [bc89b62]
+  - @osdk/client.api@0.20.0-beta.4
+  - @osdk/api@1.9.0-beta.1
+  - @osdk/generator-converters@0.7.0-beta.1
+  - @osdk/client.unstable.osw@0.1.0-beta.0
+  - @osdk/shared.client.impl@0.1.0-beta.1
+  - @osdk/shared.net.errors@1.1.0-beta.0
+  - @osdk/shared.net.fetch@0.1.0-beta.1
+  - @osdk/client.unstable@0.1.0-beta.0
+
 ## 0.20.0-beta.3
 
 ### Minor Changes
@@ -60,7 +83,7 @@
 - 5378312: Added batch action support for 2.0 client
 - b3563e0: OSDK learns \_\_EXPERIMENTAL_strictNonNull to throw, drop objects, or return `| undefined` for properties, allowing for correct typesafety.
 - dd6033a: Adds a createPlatformClient if you only need platform apis
-- 4dbac7e: Fixes link direction for experiental bulk loads
+- 4dbac7e: Fixes link direction for experimental bulk loads
 - 413e511: Added attachment uploading, reading, and metadata fetching support to 2.0.
 - 44add10: Standardize the use of dollar signs as prefixes for object properties that are specific to the OSDK.
 
@@ -76,7 +99,7 @@
 
 - 0a64def: Adds experimental batch link support
 - f9b3c72: Support importing the unstable-do-not-use from moduleResolution: node
-- 978ecd5: Rexport PalantirApiError
+- 978ecd5: Reexport PalantirApiError
 - 978ecd5: Client is now usable for calling Platform SDK
 - c9f3214: Interfaces are now mapped as views
 
@@ -111,7 +134,7 @@
 
   - Introduced an optional pino logger to the client
   - Fixes issues with where clauses for equality in subscriptions
-  - Fixes issues with inconsistent idname and apiName's in the mapping data
+  - Fixes issues with inconsistent id name and apiName's in the mapping data
 
 - 9906a41: Foundry Platform API support
 - 9906a41: Compatible version checks now use versions that are both embedded in the code and updated automatically as part of the release process.
@@ -197,7 +220,7 @@
 
 ### Minor Changes
 
-- 6d81f7f: Add priliminary action support to v2
+- 6d81f7f: Add preliminary action support to v2
 
 ## 0.0.11
 
@@ -267,7 +290,7 @@
 
 ### Patch Changes
 
-- f3120fb: Move 2.0 client into @osdk/client to fix typescript 4.9 compatability in @osdk/api"
+- f3120fb: Move 2.0 client into @osdk/client to fix typescript 4.9 compatibility in @osdk/api"
 - 848404c: Handle conflicts between object, action, and query names
 - Updated dependencies [f3120fb]
 - Updated dependencies [848404c]

package/build/browser/{chunk-M3BF5ESV.js → chunk-3ZYIZQ7V.js}

@@ -1241,6 +1241,7 @@ function createObjectSet(objectType, clientCtx, objectSet = {
         const result = await base.fetchPage({
           $nextPageToken
         });
+        $nextPageToken = result.nextPageToken;
         for (const obj of result.data) {
           yield obj;
         }
@@ -1597,7 +1598,7 @@ function applyFetchArgs(args, body) {
 async function fetchObjectPage(client, objectType, args, objectSet) {
   const r = await esm_exports2.OntologyObjectSets.loadObjectSetV2(addUserAgent(client, objectType), await client.ontologyRid, applyFetchArgs(args, {
     objectSet,
-    // We have to do the following case because LoadObjectSetRequestV2 isnt readonly
+    // We have to do the following case because LoadObjectSetRequestV2 isn't readonly
     select: args?.$select ?? [],
     // FIXME?
     excludeRid: !args?.$includeRid
@@ -1626,6 +1627,11 @@ function isOntologyObjectV2(o) {
   return o && typeof o === "object" && typeof o.__apiName === "string" && o.__primaryKey != null;
 }
 
+// src/util/isOsdkObject.ts
+function isOsdkBaseObject(o) {
+  return o && typeof o === "object" && typeof o.$apiName === "string" && o.$primaryKey != null;
+}
+
 // src/util/toDataValue.ts
 async function toDataValue(value, client) {
   if (value == null) {
@@ -1647,6 +1653,9 @@ async function toDataValue(value, client) {
   if (isOntologyObjectV2(value)) {
     return await toDataValue(value.__primaryKey, client);
   }
+  if (isOsdkBaseObject(value)) {
+    return await toDataValue(value.$primaryKey, client);
+  }
   if (isWireObjectSet(value)) {
     return value;
   }
@@ -1708,19 +1717,19 @@ async function remapBatchActionParams(params, client) {
   }));
   return remappedParams;
 }
-async function loadFullObjectMetadata(client, objtype) {
-  const full = await esm_exports2.OntologyObjectsV2.getObjectTypeFullMetadata(client, await client.ontologyRid, objtype, {
+async function loadFullObjectMetadata(client, objectType) {
+  const full = await esm_exports2.OntologyObjectsV2.getObjectTypeFullMetadata(client, await client.ontologyRid, objectType, {
     preview: true
   });
   const ret = wireObjectTypeFullMetadataToSdkObjectTypeDefinition(full, true);
-  client.logger?.debug(`END loadFullObjectMetadata(${objtype})`);
+  client.logger?.debug(`END loadFullObjectMetadata(${objectType})`);
   return {
     ...ret,
     rid: full.objectType.rid
   };
 }
-async function loadInterfaceDefinition(client, objtype) {
-  const r = await esm_exports2.OntologyObjectsV2.getInterfaceType(client, await client.ontologyRid, objtype, {
+async function loadInterfaceDefinition(client, objectType) {
+  const r = await esm_exports2.OntologyObjectsV2.getInterfaceType(client, await client.ontologyRid, objectType, {
     preview: true
   });
   return __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(r, true);
@@ -1761,7 +1770,7 @@ var createStandardOntologyProviderFactory = (client) => {
 };
 
 // src/util/UserAgent.ts
-var USER_AGENT = `osdk-client/${"0.20.0-beta.3"}`;
+var USER_AGENT = `osdk-client/${"0.20.0-beta.4"}`;
 
 // src/createMinimalClient.ts
 function createMinimalClient(metadata, baseUrl, tokenProvider, options = {}, fetchFn = global.fetch, objectSetFactory = createObjectSet) {
@@ -1785,6 +1794,277 @@ function createMinimalClient(metadata, baseUrl, tokenProvider, options = {}, fet
   });
 }
 
+// src/util/isOsdkBaseObject.ts
+function isOsdkBaseObject2(o) {
+  return o && typeof o === "object" && typeof o.$apiName === "string" && o.$primaryKey != null;
+}
+
+// src/util/toDataValueQueries.ts
+async function toDataValueQueries(value, client, desiredType) {
+  if (value == null) {
+    return value;
+  }
+  if (Array.isArray(value) && desiredType.multiplicity) {
+    const promiseArray = Array.from(value, async (innerValue) => await toDataValueQueries(innerValue, client, desiredType));
+    return Promise.all(promiseArray);
+  }
+  switch (desiredType.type) {
+    case "attachment": {
+      if (isAttachmentUpload(value)) {
+        const attachment = await esm_exports.Attachments.uploadAttachment(client, value, {
+          filename: value.name
+        }, {
+          "Content-Length": value.size.toString(),
+          "Content-Type": value.type
+        });
+        return attachment.rid;
+      }
+      return value;
+    }
+    case "twoDimensionalAggregation": {
+      return {
+        groups: value
+      };
+    }
+    case "threeDimensionalAggregation": {
+      return {
+        groups: value
+      };
+    }
+    case "set": {
+      if (value instanceof Set) {
+        const promiseArray = Array.from(value, async (innerValue) => await toDataValueQueries(innerValue, client, desiredType["set"]));
+        return Promise.all(promiseArray);
+      }
+      break;
+    }
+    case "object": {
+      if (isOsdkBaseObject2(value)) {
+        return value.$primaryKey;
+      }
+      break;
+    }
+    case "objectSet": {
+      if (isWireObjectSet(value)) {
+        return value;
+      }
+      if (isObjectSet(value)) {
+        return getWireObjectSet(value);
+      }
+      break;
+    }
+    case "struct": {
+      if (typeof value === "object") {
+        const structMap = {};
+        for (const [key, structValue] of Object.entries(value)) {
+          structMap[key] = await toDataValueQueries(structValue, client, desiredType["struct"][key]);
+        }
+        return structMap;
+      }
+    }
+    case "boolean":
+    case "date":
+    case "double":
+    case "float":
+    case "integer":
+    case "long":
+    case "string":
+    case "timestamp":
+      return value;
+  }
+  return value;
+}
+
+// src/queries/applyQuery.ts
+async function applyQuery(client, query, params) {
+  const response = await esm_exports2.QueryTypes.executeQueryV2(addUserAgent(client, query), await client.ontologyRid, query.apiName, {
+    parameters: params ? await remapQueryParams(params, client, query.parameters) : {}
+  });
+  const objectOutputDefs = await getRequiredDefinitions(query.output, client);
+  const remappedResponse = await remapQueryResponse(client, query.output, response.value, objectOutputDefs);
+  return remappedResponse;
+}
+async function remapQueryParams(params, client, paramTypes) {
+  const parameterMap = {};
+  for (const [key, value] of Object.entries(params)) {
+    parameterMap[key] = await toDataValueQueries(value, client, paramTypes[key]);
+  }
+  return parameterMap;
+}
+async function remapQueryResponse(client, responseDataType, responseValue, definitions) {
+  if (responseValue == null) {
+    if (responseDataType.nullable) {
+      return void 0;
+    } else {
+      throw new Error("Got null response when nullable was not allowed");
+    }
+  }
+  if (responseDataType.multiplicity != null && responseDataType.multiplicity !== false) {
+    const withoutMultiplicity = {
+      ...responseDataType,
+      multiplicity: false
+    };
+    for (let i = 0; i < responseValue.length; i++) {
+      responseValue[i] = await remapQueryResponse(responseValue[i], withoutMultiplicity, client, definitions);
+    }
+    return responseValue;
+  }
+  switch (responseDataType.type) {
+    case "union": {
+      throw new Error("Union return types are not yet supported");
+    }
+    case "set": {
+      for (let i = 0; i < responseValue.length; i++) {
+        responseValue[i] = await remapQueryResponse(responseValue[i], responseDataType.set, client, definitions);
+      }
+      return responseValue;
+    }
+    case "attachment": {
+      return createAttachmentFromRid(client, responseValue);
+    }
+    case "object": {
+      const def = definitions.get(responseDataType.object);
+      if (!def) {
+        throw new Error(`Missing definition for ${responseDataType.object}`);
+      }
+      return createQueryObjectResponse(responseValue, def);
+    }
+    case "objectSet": {
+      const def = definitions.get(responseDataType.objectSet);
+      if (!def) {
+        throw new Error(`Missing definition for ${responseDataType.objectSet}`);
+      }
+      if (typeof responseValue === "string") {
+        return createObjectSet(def, client, {
+          type: "intersect",
+          objectSets: [{
+            type: "base",
+            objectType: responseDataType.objectSet
+          }, {
+            type: "reference",
+            reference: responseValue
+          }]
+        });
+      }
+      return createObjectSet(def, client, responseValue);
+    }
+    case "struct": {
+      for (const [key, subtype] of Object.entries(responseDataType.struct)) {
+        if (requiresConversion(subtype)) {
+          responseValue[key] = await remapQueryResponse(responseValue[key], subtype, client, definitions);
+        }
+      }
+      return responseValue;
+    }
+    case "twoDimensionalAggregation": {
+      const result = [];
+      for (const {
+        key,
+        value
+      } of responseValue.groups) {
+        result.push({
+          key,
+          value
+        });
+      }
+      return result;
+    }
+    case "threeDimensionalAggregation": {
+      const result = [];
+      for (const {
+        key,
+        groups
+      } of responseValue.groups) {
+        const subResult = [];
+        for (const {
+          key: subKey,
+          value
+        } of groups) {
+          subResult.push({
+            key: subKey,
+            value
+          });
+        }
+        result.push({
+          key,
+          groups: subResult
+        });
+      }
+      return result;
+    }
+  }
+  return responseValue;
+}
+async function getRequiredDefinitions(dataType, client) {
+  const result = /* @__PURE__ */ new Map();
+  switch (dataType.type) {
+    case "objectSet": {
+      const objectDef = await client.ontologyProvider.getObjectDefinition(dataType.objectSet);
+      result.set(dataType.objectSet, objectDef);
+      break;
+    }
+    case "object": {
+      const objectDef = await client.ontologyProvider.getObjectDefinition(dataType.object);
+      result.set(dataType.object, objectDef);
+      break;
+    }
+    case "set": {
+      return getRequiredDefinitions(dataType.set, client);
+    }
+    case "struct": {
+      for (const value of Object.values(dataType.struct)) {
+        for (const [type, objectDef] of await getRequiredDefinitions(value, client)) {
+          result.set(type, objectDef);
+        }
+      }
+      break;
+    }
+  }
+  return result;
+}
+function requiresConversion(dataType) {
+  switch (dataType.type) {
+    case "boolean":
+    case "date":
+    case "double":
+    case "float":
+    case "integer":
+    case "long":
+    case "object":
+    case "string":
+    case "timestamp":
+      return false;
+    case "union":
+      return true;
+    case "struct":
+      return Object.values(dataType.struct).some(requiresConversion);
+    case "set":
+      return requiresConversion(dataType.set);
+    case "attachment":
+    case "objectSet":
+    case "twoDimensionalAggregation":
+    case "threeDimensionalAggregation":
+      return true;
+    default:
+      return false;
+  }
+}
+function createQueryObjectResponse(primaryKey, objectDef) {
+  return {
+    $apiName: objectDef.apiName,
+    $title: void 0,
+    $objectType: objectDef.apiName,
+    $primaryKey: primaryKey
+  };
+}
+
+// src/queries/createQueryInvoker.ts
+function createQueryInvoker(client, query) {
+  return function(...args) {
+    return applyQuery(client, query, ...args);
+  };
+}
+
 // src/createClient.ts
 var ActionInvoker = class {
   constructor(clientCtx, actionDef) {
@@ -1802,6 +2082,8 @@ function createClientInternal(objectSetFactory, baseUrl, ontologyRid, tokenProvi
     } else if (o.type === "action") {
       clientCtx.ontologyProvider.maybeSeed(o);
       return new ActionInvoker(clientCtx, o);
+    } else if (o.type === "query") {
+      return createQueryInvoker(clientCtx, o);
     } else {
       throw new Error("not implemented");
     }
@@ -1817,4 +2099,4 @@ var createClient = createClientInternal.bind(void 0, createObjectSet);
 
 export { ActionValidationError, USER_AGENT, augment, convertWireToOsdkObjects, createAttachmentFromRid, createClient, createClientInternal, createObjectSet, createSimpleAsyncCache, esm_exports2 as esm_exports };
 //# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-M3BF5ESV.js.map
+//# sourceMappingURL=chunk-3ZYIZQ7V.js.map