@osdk/generator 2.7.0-beta.9 → 2.7.0

package/build/browser/v2.0/generateClientSdkVersionTwoPointZero.test.js

@@ -237,9 +237,6 @@ const referencedOntology = {
       rid: "idk"
     }
   },
-  "branch": {
-    rid: "someRidHere"
-  },
   valueTypes: {}
 };
 const referencingOntology = {
@@ -475,7 +472,7 @@ describe("generator", () => {
             /**
              * Todo(s) to be deleted
              */
-            readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>>;
+            readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>> | null;
           }
 
           // Represents a fqn of the action
@@ -497,6 +494,11 @@ describe("generator", () => {
 
         /**
          * An action which takes in an array of objects
+         *
+         * **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
+         * can change the behavior of the applied action. If prefills are configured, null prevents them
+         * from being applied. If a parameter modifies an object's property, null will clear the data from
+         * the object, whereas undefined would not modify that property._
          * @param {ActionParam.ObjectType<Todo>} [object] Todo(s) to be deleted
          */
         export interface deleteTodos extends ActionDefinition<deleteTodos.Signatures> {
@@ -551,7 +553,7 @@ describe("generator", () => {
             /**
              * A Todo to mark completed
              */
-            readonly object?: ActionParam.ObjectType<Todo>;
+            readonly object?: ActionParam.ObjectType<Todo> | null;
           }
 
           // Represents a fqn of the action
@@ -573,6 +575,11 @@ describe("generator", () => {
 
         /**
          * An action which takes different types of parameters
+         *
+         * **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
+         * can change the behavior of the applied action. If prefills are configured, null prevents them
+         * from being applied. If a parameter modifies an object's property, null will clear the data from
+         * the object, whereas undefined would not modify that property._
          * @param {ActionParam.ObjectType<Todo>} [object] A Todo to mark completed
          */
         export interface markTodoCompleted extends ActionDefinition<markTodoCompleted.Signatures> {
@@ -673,11 +680,14 @@ describe("generator", () => {
           };
         }
 
-        export const SomeInterface: SomeInterface = {
+        export const SomeInterface = {
           type: 'interface',
           apiName: 'SomeInterface',
           osdkMetadata: $osdkMetadata,
-        };
+          internalDoNotUseMetadata: {
+            rid: 'idk',
+          },
+        } satisfies SomeInterface & { internalDoNotUseMetadata: { rid: string } } as SomeInterface;
         ",
           "/foo/ontology/objects.ts": "export { Person } from './objects/Person.js';
         export { Todo } from './objects/Todo.js';
@@ -1100,7 +1110,7 @@ describe("generator", () => {
             /**
              * Todo(s) to be deleted
              */
-            readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>>;
+            readonly object?: ReadonlyArray<ActionParam.ObjectType<Todo>> | null;
           }
 
           // Represents a fqn of the action
@@ -1122,6 +1132,11 @@ describe("generator", () => {
 
         /**
          * An action which takes in an array of objects
+         *
+         * **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
+         * can change the behavior of the applied action. If prefills are configured, null prevents them
+         * from being applied. If a parameter modifies an object's property, null will clear the data from
+         * the object, whereas undefined would not modify that property._
          * @param {ActionParam.ObjectType<Todo>} [object] Todo(s) to be deleted
          */
         export interface deleteTodos extends ActionDefinition<deleteTodos.Signatures> {
@@ -1176,7 +1191,7 @@ describe("generator", () => {
             /**
              * A Todo to mark completed
              */
-            readonly object?: ActionParam.ObjectType<Todo>;
+            readonly object?: ActionParam.ObjectType<Todo> | null;
           }
 
           // Represents a fqn of the action
@@ -1198,6 +1213,11 @@ describe("generator", () => {
 
         /**
          * An action which takes different types of parameters
+         *
+         * **Note on null values:** _For optional parameters, explicitly providing a null value instead of undefined
+         * can change the behavior of the applied action. If prefills are configured, null prevents them
+         * from being applied. If a parameter modifies an object's property, null will clear the data from
+         * the object, whereas undefined would not modify that property._
          * @param {ActionParam.ObjectType<Todo>} [object] A Todo to mark completed
          */
         export interface markTodoCompleted extends ActionDefinition<markTodoCompleted.Signatures> {
@@ -1298,11 +1318,14 @@ describe("generator", () => {
           };
         }
 
-        export const SomeInterface: SomeInterface = {
+        export const SomeInterface = {
           type: 'interface',
           apiName: 'foo.bar.SomeInterface',
           osdkMetadata: $osdkMetadata,
-        };
+          internalDoNotUseMetadata: {
+            rid: 'idk',
+          },
+        } satisfies SomeInterface & { internalDoNotUseMetadata: { rid: string } } as SomeInterface;
         ",
           "/foo/ontology/objects.ts": "export { Person } from './objects/Person.js';
         export { Todo } from './objects/Todo.js';
@@ -2362,8 +2385,6 @@ describe("generator", () => {
         export const $osdkMetadata = { extraUserAgent: '' };
 
         export const $ontologyRid = 'ri.ontology.main.ontology.dep';
-
-        export const $branch = 'someRidHere';
         ",
           "/foo/index.ts": "export {} from './ontology/actions.js';
         export * as $Actions from './ontology/actions.js';
@@ -2452,11 +2473,14 @@ describe("generator", () => {
           };
         }
 
-        export const SomeInterface: SomeInterface = {
+        export const SomeInterface = {
           type: 'interface',
           apiName: 'com.example.dep.SomeInterface',
           osdkMetadata: $osdkMetadata,
-        };
+          internalDoNotUseMetadata: {
+            rid: 'idk2',
+          },
+        } satisfies SomeInterface & { internalDoNotUseMetadata: { rid: string } } as SomeInterface;
         ",
           "/foo/ontology/objects.ts": "export { Task } from './objects/Task.js';
         ",