Add "" around linkApi names and convert to camelCase (#356)

* Add "" around linkApi names and convert to camelCase * Generate pivotTo arg with lowercase first char * Fix formatting of the searchAroundThis test Not actually sure if the test string or the output is incorrect, but this test passes now. * Add changeset
palantir · May 29, 2024 · 111f928 · 111f928
1 parent 091787e
commit 111f928
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 6 deletions.
diff --git a/.changeset/fuzzy-queens-pump.md b/.changeset/fuzzy-queens-pump.md
@@ -0,0 +1,9 @@
+---
+"@osdk/generator": patch
+---
+
+Update searchAround deprecation message
+
+- Add quotes around link API name, and convert to camelCase
+
+ex) pivotTo(Assignee) -> pivotTo("assignee")
diff --git a/examples-extra/one_dot_one/src/generatedNoCheck/ontology/objects/Person.ts b/examples-extra/one_dot_one/src/generatedNoCheck/ontology/objects/Person.ts
@@ -8,8 +8,8 @@ import type { Todo } from './Todo';
 export interface Person extends OntologyObject {
   /** @deprecated please migrate to $apiName instead */
   readonly __apiName: 'Person' & {
-    /** @deprecated please migrate to pivotTo(Todos) instead */ searchAroundTodos?: never;
-    /** @deprecated please migrate to pivotTo(Friends) instead */ searchAroundFriends?: never;
+    /** @deprecated please migrate to pivotTo("todos") instead */ searchAroundTodos?: never;
+    /** @deprecated please migrate to pivotTo("friends") instead */ searchAroundFriends?: never;
   };
   /** @deprecated please migrate to $primaryKey instead */
   readonly __primaryKey: string;

diff --git a/examples-extra/one_dot_one/src/generatedNoCheck/ontology/objects/Todo.ts b/examples-extra/one_dot_one/src/generatedNoCheck/ontology/objects/Todo.ts
@@ -8,7 +8,7 @@ import type { Person } from './Person';
 export interface Todo extends OntologyObject {
   /** @deprecated please migrate to $apiName instead */
   readonly __apiName: 'Todo' & {
-    /** @deprecated please migrate to pivotTo(Assignee) instead */ searchAroundAssignee?: never;
+    /** @deprecated please migrate to pivotTo("assignee") instead */ searchAroundAssignee?: never;
   };
   /** @deprecated please migrate to $primaryKey instead */
   readonly __primaryKey: number;

diff --git a/packages/generator/src/v1.1/wireObjectTypeV2ToV1ObjectInterfaceString.test.ts b/packages/generator/src/v1.1/wireObjectTypeV2ToV1ObjectInterfaceString.test.ts
@@ -36,7 +36,7 @@ describe("wireObjectTypeV2ToObjectInterfaceStringV1", () => {
       export interface Todo extends OntologyObject {
         /** @deprecated please migrate to $apiName instead */
         readonly __apiName: 'Todo' & {
-          /** @deprecated please migrate to pivotTo(Assignee) instead */ searchAroundAssignee?: never;
+          /** @deprecated please migrate to pivotTo("assignee") instead */ searchAroundAssignee?: never;
         };
         /** @deprecated please migrate to $primaryKey instead */
         readonly __primaryKey: number;
@@ -85,7 +85,9 @@ describe("wireObjectTypeV2ToObjectInterfaceStringV1", () => {
 
       export interface Todo extends OntologyObject {
         /** @deprecated please migrate to $apiName instead */
-        readonly __apiName: 'Todo' & { /** @deprecated please migrate to pivotTo(this) instead */ searchAroundThis?: never };
+        readonly __apiName: 'Todo' & {
+          /** @deprecated please migrate to pivotTo("this") instead */ searchAroundThis?: never;
+        };
         /** @deprecated please migrate to $primaryKey instead */
         readonly __primaryKey: number;
         readonly $apiName: 'Todo';

diff --git a/packages/generator/src/v1.1/wireObjectTypeV2ToV1ObjectInterfaceString.ts b/packages/generator/src/v1.1/wireObjectTypeV2ToV1ObjectInterfaceString.ts
@@ -41,7 +41,9 @@ ${
   /** \@deprecated please migrate to \$apiName instead */
   readonly __apiName: "${objectTypeWithLinks.objectType.apiName}" & {${
     objectTypeWithLinks.linkTypes.map(linkType => {
-      return `/** \@deprecated please migrate to pivotTo(${linkType.apiName}) instead */ searchAround${
+      return `/** \@deprecated please migrate to pivotTo("${
+        linkType.apiName.charAt(0).toLowerCase() + linkType.apiName.slice(1)
+      }") instead */ searchAround${
         linkType.apiName.charAt(0).toUpperCase() + linkType.apiName.slice(1)
       }?: never`;
     })