@osdk/maker 0.13.0-beta.12 → 0.13.0-beta.14

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @osdk/maker
 
+## 0.13.0-beta.14
+
+### Minor Changes
+
+- 9dd5a63: Intermediary links in oac
+- e62408b: Fix Maker Rid Generation
+
+### Patch Changes
+
+- Updated dependencies [b7edfb5]
+  - @osdk/api@2.5.0-beta.14
+
+## 0.13.0-beta.13
+
+### Minor Changes
+
+- d815339: Allow interface props to be excluded from actions
+
+### Patch Changes
+
+- @osdk/api@2.5.0-beta.13
+
 ## 0.13.0-beta.12
 
 ### Minor Changes

package/README.md

@@ -495,18 +495,18 @@ const departmentToEmployeesLink = defineLink({
   one: {
     object: departmentObject, // The "one" side of the relationship
     metadata: {
-      apiName: "department",
-      displayName: "Department",
-      pluralDisplayName: "Departments",
+      apiName: "employees",
+      displayName: "Employee",
+      pluralDisplayName: "Employees",
       visibility: "NORMAL",
     },
   },
   toMany: {
     object: employeeObject, // The "many" side of the relationship
     metadata: {
-      apiName: "employees",
-      displayName: "Employee",
-      pluralDisplayName: "Employees",
+      apiName: "department",
+      displayName: "Department",
+      pluralDisplayName: "Departments",
       visibility: "NORMAL",
     },
   },
@@ -522,6 +522,15 @@ const productToCategoriesLink = defineLink({
   apiName: "productToCategories",
   many: {
     object: productObject, // One side of the many-to-many relationship
+    metadata: {
+      apiName: "categories",
+      displayName: "Category",
+      pluralDisplayName: "Categories",
+      visibility: "NORMAL",
+    },
+  },
+  toMany: {
+    object: categoryObject, // Other side of the many-to-many relationship
     metadata: {
       apiName: "products",
       displayName: "Product",
@@ -529,15 +538,38 @@ const productToCategoriesLink = defineLink({
       visibility: "NORMAL",
     },
   },
+});
+```
+
+### Intermediary Link
+
+```typescript
+// Define an object-backed link type between aircraft and flights using a manifest
+const manifest = defineObject(...); // define an intermediary object
+const aircraftToManifestLink = defineLink(...); // define a one-to-many link between aircraft and intermediary object
+const flightsToManifestLink = defineLink(...); // define a one-to-many link between flights and intermediary object
+
+const aircraftToFlightsLink = defineLink({
+  apiName: "aircraftToFlights",
+  many: {
+    object: aircraft,
+    metadata: {
+      displayName: "Flight",
+      pluralDisplayName: "Flights",
+      apiName: "flights",
+    },
+    linkToIntermediary: aircraftToManifestLink,
+  },
   toMany: {
-    object: categoryObject, // Other side of the many-to-many relationship
+    object: flight,
     metadata: {
-      apiName: "categories",
-      displayName: "Category",
-      pluralDisplayName: "Categories",
-      visibility: "NORMAL",
+      displayName: "Aircraft",
+      pluralDisplayName: "Aircraft",
+      apiName: "aircraft",
     },
+    linkToIntermediary: flightsToManifestLink,
   },
+  intermediaryObjectType: manifest,
 });
 ```
 
@@ -609,7 +641,9 @@ import {
 } from "@osdk/maker";
 
 // Define an action to create objects implementing an interface
-const createPersonAction = defineCreateInterfaceObjectAction(personInterface);
+const createPersonAction = defineCreateInterfaceObjectAction({
+  interfaceType: personInterface,
+});
 
 // Define an action for a specific object type that implements an interface
 const createEmployeePersonAction = defineCreateInterfaceObjectAction(
@@ -618,7 +652,9 @@ const createEmployeePersonAction = defineCreateInterfaceObjectAction(
 );
 
 // Define an action to modify objects implementing an interface
-const modifyPersonAction = defineModifyInterfaceObjectAction(personInterface);
+const modifyPersonAction = defineModifyInterfaceObjectAction({
+  interfaceType: personInterface,
+});
 ```
 
 ### Custom Action

package/build/browser/api/defineAction.js

@@ -26,36 +26,36 @@ import { getFlattenedInterfaceProperties } from "./interface/getFlattenedInterfa
 import { isStruct } from "./properties/PropertyTypeType.js";
 export const MODIFY_OBJECT_PARAMETER = "objectToModifyParameter";
 export const CREATE_OR_MODIFY_OBJECT_PARAMETER = "objectToCreateOrModifyParameter";
-export function defineCreateInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getFlattenedInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(interfaceType)).length) {
-    consola.info(`Some properties on ${interfaceType.apiName} were skipped in the create action because they are structs`);
+export function defineCreateInterfaceObjectAction(def) {
+  const allProperties = Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type) && !(def.excludedProperties ?? []).includes(prop.sharedPropertyType.nonNameSpacedApiName));
+  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).length) {
+    consola.info(`Some properties on ${def.interfaceType.apiName} were skipped in the create action because they are structs`);
   }
   return defineAction({
-    apiName: `create-${kebab(interfaceType.apiName.split(".").pop() ?? interfaceType.apiName)}${objectType === undefined ? "" : `-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`}`,
-    displayName: `Create ${interfaceType.displayMetadata.displayName}`,
+    apiName: `create-${kebab(def.interfaceType.apiName.split(".").pop() ?? def.interfaceType.apiName)}${def.objectType === undefined ? "" : `-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`}`,
+    displayName: `Create ${def.interfaceType.displayMetadata.displayName}`,
     parameters: [{
       id: "objectTypeParameter",
       displayName: "Object type to create",
       type: {
         type: "objectTypeReference",
         objectTypeReference: {
-          interfaceTypeRids: [interfaceType.apiName]
+          interfaceTypeRids: [def.interfaceType.apiName]
         }
       },
       validation: {
         required: true,
-        allowedValues: objectType === undefined ? {
+        allowedValues: def.objectType === undefined ? {
           type: "objectTypeReference",
-          interfaceTypes: [interfaceType.apiName]
+          interfaceTypes: [def.interfaceType.apiName]
         } : {
           type: "oneOf",
           oneOf: [{
-            label: objectType.displayName,
+            label: def.objectType.displayName,
             value: {
               type: "objectType",
               objectType: {
-                objectTypeId: objectType.apiName
+                objectTypeId: def.objectType.apiName
               }
             }
           }]
@@ -73,9 +73,9 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
-    status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
+    status: def.interfaceType.status.type !== "deprecated" ? def.interfaceType.status.type : def.interfaceType.status,
     entities: {
-      affectedInterfaceTypes: [interfaceType.apiName],
+      affectedInterfaceTypes: [def.interfaceType.apiName],
       affectedObjectTypes: [],
       affectedLinkTypes: [],
       typeGroups: []
@@ -83,7 +83,7 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
     rules: [{
       type: "addInterfaceRule",
       addInterfaceRule: {
-        interfaceApiName: interfaceType.apiName,
+        interfaceApiName: def.interfaceType.apiName,
         objectTypeParameter: "objectTypeParameter",
         sharedPropertyValues: Object.fromEntries(allProperties.map(([id, _prop]) => [id, {
           type: "parameterId",
@@ -91,8 +91,8 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }
@@ -153,35 +153,35 @@ export function defineCreateObjectAction(def) {
     })
   });
 }
-export function defineModifyInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getFlattenedInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(interfaceType)).length) {
-    consola.info(`Some properties on ${interfaceType.apiName} were skipped in the modify action because they are structs`);
+export function defineModifyInterfaceObjectAction(def) {
+  const allProperties = Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type) && !(def.excludedProperties ?? []).includes(prop.sharedPropertyType.nonNameSpacedApiName));
+  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).length) {
+    consola.info(`Some properties on ${def.interfaceType.apiName} were skipped in the modify action because they are structs`);
   }
   return defineAction({
-    apiName: `modify-${kebab(interfaceType.apiName.split(".").pop() ?? interfaceType.apiName)}${objectType === undefined ? "" : `-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`}`,
-    displayName: `Modify ${interfaceType.displayMetadata.displayName}`,
+    apiName: `modify-${kebab(def.interfaceType.apiName.split(".").pop() ?? def.interfaceType.apiName)}${def.objectType === undefined ? "" : `-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`}`,
+    displayName: `Modify ${def.interfaceType.displayMetadata.displayName}`,
     parameters: [{
       id: "interfaceObjectToModifyParameter",
       displayName: "Object type to modify",
       type: {
         type: "interfaceReference",
         interfaceReference: {
-          interfaceTypeRid: interfaceType.apiName
+          interfaceTypeRid: def.interfaceType.apiName
         }
       },
       validation: {
         required: true,
-        allowedValues: objectType === undefined ? {
+        allowedValues: def.objectType === undefined ? {
           type: "interfaceObjectQuery"
         } : {
           type: "oneOf",
           oneOf: [{
-            label: objectType.displayName,
+            label: def.objectType.displayName,
             value: {
               type: "objectType",
               objectType: {
-                objectTypeId: objectType.apiName
+                objectTypeId: def.objectType.apiName
               }
             }
           }]
@@ -199,9 +199,9 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
-    status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
+    status: def.interfaceType.status.type !== "deprecated" ? def.interfaceType.status.type : def.interfaceType.status,
     entities: {
-      affectedInterfaceTypes: [interfaceType.apiName],
+      affectedInterfaceTypes: [def.interfaceType.apiName],
       affectedObjectTypes: [],
       affectedLinkTypes: [],
       typeGroups: []
@@ -216,8 +216,8 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }