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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @osdk/typescript-sdk-docs
 
+## 0.3.0-beta.4
+
+### Minor Changes
+
+- 5659984: Fix formatting of subscribeToObjectSetInstructions template and fix aggregationTemplate syntax error
+
+## 0.3.0-beta.3
+
+### Minor Changes
+
+- d8cdf4d: fix aggregation doc example
+
 ## 0.3.0-beta.2
 
 ### Minor Changes

package/build/browser/generatedNoCheck/docsNoComputedVariables.js

@@ -333,7 +333,7 @@ export const snippets = {
           "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}"
         }],
         "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    });"
+          "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    });"
         }],
         "countAggregationTemplate": [{
           "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    .aggregate({\n        $select: {$count: \"unordered\"},\n    });"
@@ -549,7 +549,7 @@ export const snippets = {
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n\nfunction getLastTimeSeriesPoint(obj: {{objectType}}) {\n    return obj.{{property}}.getLatestValue();\n}"
         }],
         "subscribeToObjectSetInstructions": [{
-          "template": "import { {{objectOrInterfaceApiName}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\n// A map of primary keys to objects loaded through the SDK\nconst objects: { [key: string]: {{objectOrInterfaceApiName}}.OsdkInstance } = ...\n\nconst subscription = client({{objectOrInterfaceApiName}}).subscribe(         {\n            onChange(update) {\n                if (update.state === \"ADDED_OR_UPDATED\") {\n                    // An object has received an update or an object was added to the object set\n                    const currentObject = objects[update.object.$primaryKey];\n                    if (currentObject !== undefined) {\n                        currentObject[\"<propertyName>\"] = update.object[\"<propertyName>\"] ?? currentObject[\"<propertyName>\"];\n                    }\n                }\n                else if (update.state === \"REMOVED\") {\n                    // The object was removed from the object set, which could mean it was deleted or no longer meets the filter criteria\n                    delete objects[update.object.$primaryKey];\n                }\n            },\n            onSuccessfulSubscription() {\n                // The subscription was successful and you can expect to receive updates\n            },\n            onError(err) {\n                // There was an error with the subscription and you will not receive any more updates\n                console.error(err);\n            },\n            onOutOfDate() {\n                // We could not keep track of all changes. Please reload the objects in your set.\n            },\n        },\n        { properties: [ {{#propertyNames}}\"{{.}}\", {{/propertyNames}}\b\b]}\n    );\n\nsubscription.unsubscribe();"
+          "template": "import { {{objectOrInterfaceApiName}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\n// A map of primary keys to objects loaded through the SDK\nconst objects: { [key: string]: {{objectOrInterfaceApiName}}.OsdkInstance } = ...\n\nconst subscription = client({{objectOrInterfaceApiName}}).subscribe(\n    {\n        onChange(update) {\n            if (update.state === \"ADDED_OR_UPDATED\") {\n                // An object has received an update or an object was added to the object set\n                const currentObject = objects[update.object.$primaryKey];\n                if (currentObject !== undefined) {\n                    currentObject[\"<propertyName>\"] = update.object[\"<propertyName>\"] ?? currentObject[\"<propertyName>\"];\n                }\n            }\n            else if (update.state === \"REMOVED\") {\n                // The object was removed from the object set, which could mean it was deleted or no longer meets the filter criteria\n                delete objects[update.object.$primaryKey];\n            }\n        },\n        onSuccessfulSubscription() {\n            // The subscription was successful and you can expect to receive updates\n        },\n        onError(err) {\n            // There was an error with the subscription and you will not receive any more updates\n            console.error(err);\n        },\n        onOutOfDate() {\n            // We could not keep track of all changes. Please reload the objects in your set.\n        },\n    },\n    { properties: [ {{#propertyNames}}\"{{.}}\", {{/propertyNames}}] }\n);\n\nsubscription.unsubscribe();"
         }],
         "uploadMedia": [{
           "template": "import { __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference } from \"@osdk/api/unstable\";\nimport { {{objectType}} } from \"{{{packageName}}}\"\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport { Result, isOk } from \"@osdk/client\";\nimport type { MediaReference } from \"@osdk/api\";\n\n// To upload media with 2.x, it has to be linked to an Action call\nasync function uploadMedia() {\n    const file = await fetch(\"file.json\");\n    const data = await file.blob();\n\n    // Upload media to an object type with a media property. This returns a media reference that can passed to\n    // a media parameter in an Action.\n    return await client(\n        __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference,\n    ).createMediaReference({\n        data,\n        fileName: \"myFile\",\n        objectType: {{objectType}},\n        propertyType: \"MediaPropertyApi\",\n    });\n}\n\nconst mediaReference: MediaReference = await uploadMedia();\nconst actionResult = client(mediaUploadingAction).applyAction({ media_parameter: mediaReference });"