@osdk/typescript-sdk-docs 0.25.0 → 0.25.1-main-90da45384efe5511167b3842002d74856955da34

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @osdk/typescript-sdk-docs
 
+## 0.25.1-main-90da45384efe5511167b3842002d74856955da34
+
+### Patch Changes
+
+- 2ab4d7c: Clarify that ontology-defined derived properties require explicit selection, distinguish runtime-defined derived properties, and add object-loading examples.
+
 ## 0.25.0
 
 ### Minor Changes

package/build/browser/generatedNoCheck/docsNoComputedVariables.js

@@ -318,14 +318,14 @@ export const snippets = {
           "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport { type Osdk, type PageResult } from \"@osdk/client\";\n\ntry {\n    const page: PageResult<Osdk.Instance<{{objectType}}>> = await client({{objectType}})\n        .where({\n            {{titleProperty}}: {$isNull: true}\n        })\n        .fetchPage({\n            $pageSize: 30\n        });\n    const objects = page.data;\n    const object = objects[0];\n} catch (e) {\n    throw e;\n}"
         }],
         "loadSingleObjectReference": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk } from \"@osdk/client\";\n\nconst responseNoErrorWrapper: Osdk.Instance<{{objectType}}> = await client({{objectType}}).fetchOne({{{primaryKeyPropertyValueV2}}});\n\n",
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk } from \"@osdk/client\";\n\nconst responseNoErrorWrapper: Osdk.Instance<{{objectType}}> = await client({{objectType}}).fetchOne({{{primaryKeyPropertyValueV2}}});\n\n// Ontology-defined derived properties are not returned by default.\n// Pass their API names in $select, along with any other properties you need.\n// Runtime-defined derived properties added via .withProperties(...) are returned\n// by default only when $select is omitted. If you pass $select, include them\n// in the selection as well.\nfunction getWithSelectedProperties(properties: {{objectType}}.PropertyKeys[]) {\n    return client({{objectType}}).fetchOne({{{primaryKeyPropertyValueV2}}}, {\n        $select: properties\n    });\n}\n\n",
           "computedVariables": ["primaryKeyPropertyValueV2"]
         }],
         "loadObjectsReference": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk, PageResult } from \"@osdk/client\";\ntry {\n    const responseNoErrorWrapper: PageResult<Osdk.Instance<{{objectType}}>>\n        = await client({{objectType}}).fetchPage({ $pageSize: 30 });\n} catch (e) {\n    throw e;\n}\n"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk, PageResult } from \"@osdk/client\";\ntry {\n    const responseNoErrorWrapper: PageResult<Osdk.Instance<{{objectType}}>>\n        = await client({{objectType}}).fetchPage({ $pageSize: 30 });\n} catch (e) {\n    throw e;\n}\n\n// Ontology-defined derived properties are not returned by default.\n// Pass their API names in $select, along with any other properties you need.\n// Runtime-defined derived properties added via .withProperties(...) are returned\n// by default only when $select is omitted. If you pass $select, include them\n// in the selection as well.\nfunction getPageWithSelectedProperties(properties: {{objectType}}.PropertyKeys[]) {\n    return client({{objectType}}).fetchPage({\n        $pageSize: 30,\n        $select: properties\n    });\n}\n"
         }],
         "loadAllObjectsReference": [{
-          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk } from \"@osdk/client\";\n\nasync function getAll(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    const objects: Osdk.Instance<{{objectType}}>[]= [];\n    for await(const obj of client({{objectType}}).asyncIter()) {\n        objects.push(obj);\n    }\n\n    return objects;\n}\n\n// If Array.fromAsync() is available in your target environment\nfunction getAllFromAsync(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    return Array.fromAsync(client({{objectType}}).asyncIter());\n}"
+          "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\nimport type { Osdk } from \"@osdk/client\";\n\nasync function getAll(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    const objects: Osdk.Instance<{{objectType}}>[]= [];\n    for await(const obj of client({{objectType}}).asyncIter()) {\n        objects.push(obj);\n    }\n\n    return objects;\n}\n\n// If Array.fromAsync() is available in your target environment\nfunction getAllFromAsync(): Promise<Array<Osdk.Instance<{{objectType}}>>> {\n    return Array.fromAsync(client({{objectType}}).asyncIter());\n}\n\n// Ontology-defined derived properties are not returned by default.\n// Pass their API names in $select, along with any other properties you need.\n// Runtime-defined derived properties added via .withProperties(...) are returned\n// by default only when $select is omitted. If you pass $select, include them\n// in the selection as well.\nasync function getAllWithSelectedProperties(properties: {{objectType}}.PropertyKeys[]) {\n    const objects = [];\n    for await (const obj of client({{objectType}}).asyncIter({ $select: properties })) {\n        objects.push(obj);\n    }\n    return objects;\n}"
         }],
         "loadLinkedObjectReference": [{
           "template": "import { type {{objectType}} } from \"{{{packageName}}}\";\nimport { type Osdk } from \"@osdk/client\";\n\nasync function getLinked{{linkedObjectType}}(source: Osdk.Instance<{{objectType}}>) {\n    try {\n        {{#isLinkManySided}}\n        return await source.$link.{{linkApiName}}.fetchPage();\n        {{/isLinkManySided}}\n        {{^isLinkManySided}}\n        return await source.$link.{{linkApiName}}.fetchOne();\n        {{/isLinkManySided}}\n    } catch (error) {\n        return { error };\n    }\n}"