@osdk/typescript-sdk-docs 0.1.0-beta.0 → 0.2.0-beta.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @osdk/typescript-sdk-docs
 
+## 0.1.0-beta.1
+
+### Minor Changes
+
+- dc418de: Add doc snippets for contains + searchAround
+
 ## 0.1.0-beta.0
 
 ### Minor Changes

package/build/browser/generatedNoCheck/docsNoComputedVariables.js

@@ -432,6 +432,10 @@ export const snippets = {
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n    .where({ $or:[\n        { $not: { {{primaryKeyPropertyV2.apiName}}: { $isNull: true }}},\n        { {{primaryKeyPropertyV2.apiName}}: { $eq: \"<primaryKey>\" }}\n    ]});",
           "computedVariables": ["primaryKeyPropertyV2"]
         }],
+        "containsTemplate": [{
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst filteredObjects = client({{objectType}})\n    .where({\n        {{property}} : { $contains: {{{arrayElementValue}}} }\n    })",
+          "computedVariables": ["arrayElementValue"]
+        }],
         "loadInterfacesReference": [{
           "template": "import { {{interfaceApiName}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport { type Osdk, type PageResult, type Result } from \"@osdk/client\";\n\nconst response:  Result<PageResult<Osdk<{{interfaceApiName}}>>>\n    = await client({{interfaceApiName}}).fetchPageWithErrors({ $pageSize: 30 });\n\n// To fetch a page without a result wrapper, use fetchPage instead\nconst responseNoErrorWrapper: PageResult<Osdk<{{interfaceApiName}}>>\n    = await client({{interfaceApiName}}).fetchPage({ $pageSize: 30 });"
         }],
@@ -514,16 +518,19 @@ export const snippets = {
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst sum{{objectType}} = await client({{objectType}})\n    .withProperties({\n      \"newPropertyName\": (baseObjectSet) =>\n        baseObjectSet.pivotTo(\"{{linkName}}\").aggregate(\"{{property}}:{{operation}}\")\n    })"
         }],
         "objectSetOperationsGuide": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n// Object set operations can be chained. e.g. To find all objects in objectSetA \n// that are present in objectSetB but do not exist in objectSetC:\nconst result: {{objectType}}.ObjectSet = objectSetA\n  .intersect(objectSetB)\n  .subtract(objectSetC);"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n// Object set operations can be chained. e.g. To find all objects in objectSetA \n// that are present in objectSetB but do not exist in objectSetC:\nconst result = objectSetA\n  .intersect(objectSetB)\n  .subtract(objectSetC);"
         }],
         "objectSetOperationsUnion": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n// Combine objectSetA, objectSetB and objectSetC\nconst result: {{objectType}}.ObjectSet = objectSetA\n  .union(objectSetB)\n  .union(objectSetC); // alternatively: objectSetA.union(objectSetB, objectSetC)"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n// Combine objectSetA, objectSetB and objectSetC\nconst result = objectSetA\n  .union(objectSetB)\n  .union(objectSetC); // alternatively: objectSetA.union(objectSetB, objectSetC)"
         }],
         "objectSetOperationsSubtract": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n\n// Return objects in objectSetA that are not present in either objectSetB or objectSetC\nconst result: {{objectType}}.ObjectSet = objectSetA\n  .subtract(objectSetB)\n  .subtract(objectSetC); // alternatively: objectSetA.subtract(objectSetB, objectSetC)"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n\n// Return objects in objectSetA that are not present in either objectSetB or objectSetC\nconst result = objectSetA\n  .subtract(objectSetB)\n  .subtract(objectSetC); // alternatively: objectSetA.subtract(objectSetB, objectSetC)"
         }],
         "objectSetOperationsIntersect": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n\n// Return all objects common to objectSetA, objectSetB and objectSetC\nconst result: {{objectType}}.ObjectSet = objectSetA\n  .intersect(objectSetB)\n  .intersect(objectSetC); // alternatively: objectSetA.intersect(objectSetB, objectSetC)"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}/ontology/objects\";\n\nconst objectSetA = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"a\"}})\nconst objectSetB = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"b\"}})\nconst objectSetC = client({{objectType}}).where({ {{titleProperty}}: { $containsAnyTerm: \"c\"}})\n\n\n// Return all objects common to objectSetA, objectSetB and objectSetC\nconst result = objectSetA\n  .intersect(objectSetB)\n  .intersect(objectSetC); // alternatively: objectSetA.intersect(objectSetB, objectSetC)"
+        }],
+        "searchAround": [{
+          "template": "import { {{sourceObjectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\n// Object set containing objects a, b and c\nconst objects = client({{sourceObjectType}})\n    .where({ {{rawLinkedPrimaryKeyProperty.apiName}}: { $in: [\"a\", \"b\", \"c\"]}});\n\n// Traverse the selected link type to find all objects of type\n// {{linkedObjectType}} linked to objects a, b and c\nconst linkedObjects = await objects.pivotTo(\"{{linkApiName}}\");"
         }]
       }
     },