@osdk/typescript-sdk-docs 0.3.0 → 0.4.0-beta.2

package/CHANGELOG.md

@@ -1,13 +1,10 @@
 # @osdk/typescript-sdk-docs
 
-## 0.3.0
+## 0.4.0-beta.2
 
-### Patch Changes
+### Minor Changes
 
-- 776ae8a: Simulated release
-- d8cdf4d: fix aggregation doc example
-- 29d2ada: Fix type in docs and tests
-- 5659984: Fix formatting of subscribeToObjectSetInstructions template and fix aggregationTemplate syntax error
+- e9239a1: Add pivot docs.
 
 ## 0.3.0-beta.4
 

package/build/browser/generatedNoCheck/docsNoComputedVariables.js

@@ -330,7 +330,7 @@ export const snippets = {
           "computedVariables": ["linkedPrimaryKeyPropertyV2"]
         }],
         "loadLinkedObjectsReference": [{
-          "template": "import { {{linkedObjectType}} } from \"{{{packageName}}}\";\n\nfunction getLinked{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>) {\n    {{#isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchPageWithErrors({ $pageSize: 30 });\n    {{/isLinkManySided}}\n    {{^isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchOneWithErrors();\n    {{/isLinkManySided}}\n}"
+          "template": "import { {{linkedObjectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nfunction getLinked{{linkedObjectType}}(source: Osdk.Instance<{{sourceObjectType}}>) {\n    {{#isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchPageWithErrors({ $pageSize: 30 });\n    {{/isLinkManySided}}\n    {{^isLinkManySided}}\n    return source.$link.{{linkApiName}}.fetchOneWithErrors();\n    {{/isLinkManySided}}\n}\n\n// You can also get a linked object by doing an object set searcharound\nfunction getLinkedWithPivot{{linkedObjectType}}(){\n    return client({{sourceObjectType}}).pivotTo({{linkApiName}}).fetchPage();\n}"
         }],
         "aggregationTemplate": [{
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst num{{objectType}} = await client({{objectType}})\n    .where({{property}}: { $isNull : false }})\n    .aggregate({\n        $select: { $count: \"unordered\" },\n        $groupBy: { name: \"exact\" },\n    });"
@@ -558,6 +558,16 @@ export const snippets = {
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { MediaMetadata, MediaReference } from \"@osdk/api\";\nimport { Osdk, Result } from \"@osdk/client\";\n\nconst result = await client({{objectType}}).fetchOne(\"<primaryKey>\");\n\n// Fetch metadata of a media property\nconst mediaMetadata = await result.{{property}}?.fetchMetadata();\n\n// Fetch contents of a media property\nconst response = await result.{{property}}?.fetchContents();\n\nif (response.ok) {\n    const data = await response.blob();\n    ...\n}"
         }]
       }
+    },
+    "2.4.0": {
+      "snippets": {
+        "derivedPropertyNumericExpression": [{
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}WithExpression = await client({{objectType}})\n    .withProperties({\n      \"newPropertyName\": (baseObjectSet) =>\n          {{^isUnary}}\n          baseObjectSet.pivotTo(\"{{linkName}}\")\n              .selectProperty(\"{{property}}\").{{operation}}(\n                  baseObjectSet.pivotTo(\"{{linkName}}\").aggregate(\"$count\"))\n          {{/isUnary}}\n          {{#isUnary}}\n          baseObjectSet.pivotTo(\"{{linkName}}\").selectProperty(\"{{property}}\").{{operation}}()\n          {{/isUnary}}\n    });"
+        }],
+        "derivedPropertyDatetimeExpression": [{
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}WithExpression = await client({{objectType}})\n    .withProperties({\n      \"newPropertyName\": (baseObjectSet) =>\n          {{^isExtractPart}} \n          baseObjectSet.pivotTo(\"{{linkName}}\")\n              .selectProperty(\"{{property}}\")\n              .{{operation}}(baseObjectSet.pivotTo(\"{{linkName}}\").selectProperty(\"{{property}}\"))\n          {{/isExtractPart}}\n          {{#isExtractPart}}\n          baseObjectSet.pivotTo(\"{{linkName}}\")\n              .selectProperty(\"{{property}}\").{{operation}}(\"DAY\")\n          {{/isExtractPart}}\n    });"
+        }]
+      }
     }
   }
 };