@arpproject/recrate 0.1.7-test5 → 0.1.7-test7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app/App.d.ts +2 -0
- package/dist/app/EmbeddedComponent.d.ts +3 -0
- package/dist/app/index.d.ts +0 -0
- package/dist/app/lookup.d.ts +82 -0
- package/dist/crate-builder/CrateManager/contexts.d.ts +6 -0
- package/dist/crate-builder/CrateManager/crate-manager-benchmarking.spec.d.ts +1 -0
- package/dist/crate-builder/CrateManager/crate-manager-loading-exporting.spec.d.ts +1 -0
- package/dist/crate-builder/CrateManager/crate-manager-operations.spec.d.ts +0 -0
- package/dist/crate-builder/CrateManager/crate-manager.d.ts +641 -0
- package/dist/crate-builder/CrateManager/crate-manager.spec.d.ts +1 -0
- package/dist/crate-builder/CrateManager/lib.d.ts +26 -0
- package/dist/crate-builder/CrateManager/lib.spec.d.ts +1 -0
- package/dist/crate-builder/CrateManager/profile-manager.d.ts +143 -0
- package/dist/crate-builder/CrateManager/profile-manager.spec.d.ts +1 -0
- package/{src/crate-builder/CrateManager/schema-type-definitions.json → dist/crate-builder/CrateManager/schema-type-definitions.json.d.ts} +4 -1
- package/dist/crate-builder/CrateManager/validate-identifier.d.ts +10 -0
- package/dist/crate-builder/CrateManager/validate-identifier.spec.d.ts +1 -0
- package/dist/crate-builder/RenderEntity/Add.d.ts +26 -0
- package/dist/crate-builder/RenderEntity/AddControl.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/AddControl.stories.d.ts +29 -0
- package/dist/crate-builder/RenderEntity/AutoComplete.d.ts +12 -0
- package/dist/crate-builder/RenderEntity/BulkAdd.d.ts +10 -0
- package/dist/crate-builder/RenderEntity/DeleteProperty.d.ts +8 -0
- package/dist/crate-builder/RenderEntity/DialogAddProperty.d.ts +9 -0
- package/dist/crate-builder/RenderEntity/DialogBrowseEntities.d.ts +8 -0
- package/dist/crate-builder/RenderEntity/DialogEditContext.d.ts +8 -0
- package/dist/crate-builder/RenderEntity/DialogPreviewCrate.d.ts +7 -0
- package/dist/crate-builder/RenderEntity/DialogSaveCrateAsTemplate.d.ts +13 -0
- package/dist/crate-builder/RenderEntity/DialogSaveEntityTemplate.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/DisplayPropertyName.d.ts +8 -0
- package/dist/crate-builder/RenderEntity/DisplayPropertyName.stories.d.ts +6 -0
- package/dist/crate-builder/RenderEntity/EntityId.d.ts +13 -0
- package/dist/crate-builder/RenderEntity/EntityName.d.ts +13 -0
- package/dist/crate-builder/RenderEntity/EntityProperty.d.ts +19 -0
- package/dist/crate-builder/RenderEntity/EntityPropertyInstance.d.ts +25 -0
- package/dist/crate-builder/RenderEntity/EntityType.d.ts +12 -0
- package/dist/crate-builder/RenderEntity/ItemLink.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/PaginateLinkedEntities.d.ts +23 -0
- package/dist/crate-builder/RenderEntity/PaginateLinkedEntities.stories.d.ts +7 -0
- package/dist/crate-builder/RenderEntity/PropertyHelp.d.ts +6 -0
- package/dist/crate-builder/RenderEntity/RenderControls.d.ts +22 -0
- package/dist/crate-builder/RenderEntity/RenderLinkedItem.d.ts +20 -0
- package/dist/crate-builder/RenderEntity/RenderPropertyHelp.d.ts +6 -0
- package/dist/crate-builder/RenderEntity/RenderReverseConnections.d.ts +16 -0
- package/dist/crate-builder/RenderEntity/RenderTypes.d.ts +6 -0
- package/dist/crate-builder/RenderEntity/Shell2.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/UnlinkEntity.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/auto-complete.lib.d.ts +25 -0
- package/dist/crate-builder/RenderEntity/keys.d.ts +4 -0
- package/dist/crate-builder/RenderEntity/layout.d.ts +14 -0
- package/dist/crate-builder/RenderEntity/layout.spec.d.ts +1 -0
- package/dist/crate-builder/Shell.d.ts +40 -0
- package/dist/crate-builder/editor-state.d.ts +72 -0
- package/dist/crate-builder/emotionCache.d.ts +1 -0
- package/dist/crate-builder/helpers.d.ts +9 -0
- package/dist/crate-builder/i18n.d.ts +2 -0
- package/dist/crate-builder/lib/validate-iri.d.ts +6 -0
- package/dist/crate-builder/locales/en.d.ts +79 -0
- package/dist/crate-builder/locales/hu.d.ts +79 -0
- package/dist/crate-builder/primitives/Boolean.d.ts +11 -0
- package/dist/crate-builder/primitives/Boolean.stories.d.ts +7 -0
- package/dist/crate-builder/primitives/Date.d.ts +11 -0
- package/dist/crate-builder/primitives/Date.stories.d.ts +5 -0
- package/dist/crate-builder/primitives/DateTime.d.ts +11 -0
- package/dist/crate-builder/primitives/DateTime.stories.d.ts +5 -0
- package/dist/crate-builder/primitives/Geo.d.ts +12 -0
- package/dist/crate-builder/primitives/Geo.stories.d.ts +26 -0
- package/dist/crate-builder/primitives/Map.SelectArea.d.ts +9 -0
- package/dist/crate-builder/primitives/Map.d.ts +15 -0
- package/dist/crate-builder/primitives/Map.stories.d.ts +6 -0
- package/dist/crate-builder/primitives/Number.d.ts +16 -0
- package/dist/crate-builder/primitives/Number.stories.d.ts +10 -0
- package/dist/crate-builder/primitives/Select.d.ts +15 -0
- package/dist/crate-builder/primitives/Select.stories.d.ts +9 -0
- package/dist/crate-builder/primitives/SelectObject.d.ts +13 -0
- package/dist/crate-builder/primitives/SelectObject.stories.d.ts +5 -0
- package/dist/crate-builder/primitives/SelectUrl.d.ts +14 -0
- package/dist/crate-builder/primitives/SelectUrl.stories.d.ts +7 -0
- package/dist/crate-builder/primitives/Text.d.ts +19 -0
- package/dist/crate-builder/primitives/Text.stories.d.ts +13 -0
- package/dist/crate-builder/primitives/Time.d.ts +11 -0
- package/dist/crate-builder/primitives/Time.stories.d.ts +7 -0
- package/dist/crate-builder/primitives/Url.d.ts +11 -0
- package/dist/crate-builder/primitives/Url.stories.d.ts +7 -0
- package/dist/crate-builder/primitives/Value.d.ts +7 -0
- package/dist/crate-builder/primitives/Value.stories.d.ts +7 -0
- package/dist/crate-builder/primitives/date-libs.d.ts +1 -0
- package/dist/crate-builder/property-definitions.d.ts +78 -0
- package/dist/crate-builder/store.d.ts +8 -0
- package/dist/index.d.ts +5 -0
- package/dist/recrate.css +1896 -0
- package/dist/recrate.es.js +38508 -0
- package/dist/types.d.ts +42 -0
- package/package.json +41 -28
- package/.eslintrc.json +0 -37
- package/.storybook/main.ts +0 -40
- package/.storybook/preview.tsx +0 -46
- package/babel.config.json +0 -5
- package/docker-compose.yml +0 -30
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -99
- package/docs/assets/icons.js +0 -18
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/main.js +0 -60
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1448
- package/docs/classes/src_crate_builder_CrateManager_crate_manager.CrateManager.html +0 -240
- package/docs/classes/src_crate_builder_CrateManager_profile_manager.ProfileManager.html +0 -42
- package/docs/classes/src_crate_builder_editor_state.EditorState.html +0 -28
- package/docs/classes/src_crate_builder_types.CrateManagerType.html +0 -57
- package/docs/classes/src_crate_builder_types.ProfileManagerType.html +0 -13
- package/docs/functions/src_crate_builder_CrateManager_lib.isURL.html +0 -2
- package/docs/functions/src_crate_builder_CrateManager_lib.mintNewCrate.html +0 -3
- package/docs/functions/src_crate_builder_CrateManager_lib.normalise.html +0 -5
- package/docs/functions/src_crate_builder_CrateManager_lib.normaliseEntityType.html +0 -1
- package/docs/index.html +0 -58
- package/docs/interfaces/src_crate_builder_types.NormalisedCrate.html +0 -3
- package/docs/interfaces/src_crate_builder_types.NormalisedEntityDefinition.html +0 -4
- package/docs/interfaces/src_crate_builder_types.NormalisedProfile.html +0 -9
- package/docs/interfaces/src_crate_builder_types.ProfileLayout.html +0 -2
- package/docs/interfaces/src_crate_builder_types.ProfileLayoutGroup.html +0 -9
- package/docs/interfaces/src_crate_builder_types.UnverifiedCrate.html +0 -3
- package/docs/interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html +0 -4
- package/docs/modules/src_crate_builder_CrateManager_crate_manager.html +0 -2
- package/docs/modules/src_crate_builder_CrateManager_lib.html +0 -6
- package/docs/modules/src_crate_builder_CrateManager_profile_manager.html +0 -2
- package/docs/modules/src_crate_builder_editor_state.html +0 -2
- package/docs/modules/src_crate_builder_types.html +0 -16
- package/docs/types/src_crate_builder_types.EntityReference.html +0 -1
- package/docs/types/src_crate_builder_types.NormalisedContext.html +0 -1
- package/docs/types/src_crate_builder_types.PrimitiveType.html +0 -1
- package/docs/types/src_crate_builder_types.ProfileAssociation.html +0 -1
- package/docs/types/src_crate_builder_types.ProfileInput.html +0 -1
- package/docs/types/src_crate_builder_types.UnverifiedContext.html +0 -1
- package/docs/variables/src_crate_builder_CrateManager_lib.urlProtocols.html +0 -1
- package/index.html +0 -13
- package/load-data-packs.cjs +0 -38
- package/postcss.config.cjs +0 -6
- package/react-app-env.d.ts +0 -1
- package/rollup.config.js +0 -26
- package/src/app/App.tsx +0 -13
- package/src/app/EmbeddedComponent.tsx +0 -432
- package/src/app/index.html +0 -20
- package/src/app/index.tsx +0 -19
- package/src/app/lookup.ts +0 -141
- package/src/app/override-styles.css +0 -96
- package/src/crate-builder/CrateManager/contexts/1.1-context.jsonld +0 -2660
- package/src/crate-builder/CrateManager/contexts/1.2-DRAFT-context.jsonld +0 -2918
- package/src/crate-builder/CrateManager/contexts.ts +0 -42
- package/src/crate-builder/CrateManager/crate-manager-benchmarking.spec.ts +0 -31
- package/src/crate-builder/CrateManager/crate-manager-loading-exporting.spec.ts +0 -431
- package/src/crate-builder/CrateManager/crate-manager-operations.spec.ts +0 -298
- package/src/crate-builder/CrateManager/crate-manager.spec.ts +0 -2336
- package/src/crate-builder/CrateManager/crate-manager.ts +0 -2111
- package/src/crate-builder/CrateManager/lib.spec.ts +0 -133
- package/src/crate-builder/CrateManager/lib.ts +0 -170
- package/src/crate-builder/CrateManager/profile-manager.spec.ts +0 -593
- package/src/crate-builder/CrateManager/profile-manager.ts +0 -367
- package/src/crate-builder/CrateManager/validate-identifier.spec.ts +0 -82
- package/src/crate-builder/CrateManager/validate-identifier.ts +0 -65
- package/src/crate-builder/RenderEntity/Add.tsx +0 -249
- package/src/crate-builder/RenderEntity/AddControl.stories.tsx +0 -126
- package/src/crate-builder/RenderEntity/AddControl.tsx +0 -84
- package/src/crate-builder/RenderEntity/AutoComplete.tsx +0 -215
- package/src/crate-builder/RenderEntity/BulkAdd.tsx +0 -136
- package/src/crate-builder/RenderEntity/DeleteProperty.tsx +0 -33
- package/src/crate-builder/RenderEntity/DialogAddProperty.tsx +0 -83
- package/src/crate-builder/RenderEntity/DialogBrowseEntities.tsx +0 -136
- package/src/crate-builder/RenderEntity/DialogEditContext.tsx +0 -107
- package/src/crate-builder/RenderEntity/DialogPreviewCrate.tsx +0 -54
- package/src/crate-builder/RenderEntity/DialogSaveCrateAsTemplate.tsx +0 -65
- package/src/crate-builder/RenderEntity/DialogSaveEntityTemplate.tsx +0 -87
- package/src/crate-builder/RenderEntity/DisplayPropertyName.stories.tsx +0 -30
- package/src/crate-builder/RenderEntity/DisplayPropertyName.tsx +0 -21
- package/src/crate-builder/RenderEntity/EntityId.tsx +0 -75
- package/src/crate-builder/RenderEntity/EntityName.tsx +0 -49
- package/src/crate-builder/RenderEntity/EntityProperty.tsx +0 -188
- package/src/crate-builder/RenderEntity/EntityPropertyInstance.tsx +0 -255
- package/src/crate-builder/RenderEntity/EntityType.tsx +0 -95
- package/src/crate-builder/RenderEntity/ItemLink.tsx +0 -37
- package/src/crate-builder/RenderEntity/PaginateLinkedEntities.stories.tsx +0 -43
- package/src/crate-builder/RenderEntity/PaginateLinkedEntities.tsx +0 -141
- package/src/crate-builder/RenderEntity/PropertyHelp.tsx +0 -39
- package/src/crate-builder/RenderEntity/RenderControls.tsx +0 -278
- package/src/crate-builder/RenderEntity/RenderLinkedItem.tsx +0 -139
- package/src/crate-builder/RenderEntity/RenderPropertyHelp.tsx +0 -41
- package/src/crate-builder/RenderEntity/RenderReverseConnections.tsx +0 -150
- package/src/crate-builder/RenderEntity/RenderTypes.tsx +0 -102
- package/src/crate-builder/RenderEntity/Shell2.tsx +0 -576
- package/src/crate-builder/RenderEntity/UnlinkEntity.tsx +0 -30
- package/src/crate-builder/RenderEntity/auto-complete.lib.ts +0 -184
- package/src/crate-builder/RenderEntity/keys.ts +0 -4
- package/src/crate-builder/RenderEntity/layout.spec.js +0 -593
- package/src/crate-builder/RenderEntity/layout.ts +0 -220
- package/src/crate-builder/Shell.tsx +0 -337
- package/src/crate-builder/component.css +0 -65
- package/src/crate-builder/editor-state.ts +0 -114
- package/src/crate-builder/emotionCache.ts +0 -8
- package/src/crate-builder/helpers.ts +0 -16
- package/src/crate-builder/i18n.ts +0 -22
- package/src/crate-builder/lib/validate-iri.ts +0 -57
- package/src/crate-builder/locales/en.js +0 -149
- package/src/crate-builder/locales/hu.js +0 -147
- package/src/crate-builder/primitives/Boolean.stories.tsx +0 -33
- package/src/crate-builder/primitives/Boolean.tsx +0 -67
- package/src/crate-builder/primitives/Date.stories.tsx +0 -32
- package/src/crate-builder/primitives/Date.tsx +0 -58
- package/src/crate-builder/primitives/DateTime.stories.tsx +0 -32
- package/src/crate-builder/primitives/DateTime.tsx +0 -64
- package/src/crate-builder/primitives/Geo.stories.tsx +0 -57
- package/src/crate-builder/primitives/Geo.tsx +0 -225
- package/src/crate-builder/primitives/Map.SelectArea.js +0 -359
- package/src/crate-builder/primitives/Map.stories.tsx +0 -61
- package/src/crate-builder/primitives/Map.tsx +0 -124
- package/src/crate-builder/primitives/Number.stories.tsx +0 -74
- package/src/crate-builder/primitives/Number.tsx +0 -166
- package/src/crate-builder/primitives/Select.stories.tsx +0 -66
- package/src/crate-builder/primitives/Select.tsx +0 -121
- package/src/crate-builder/primitives/SelectObject.stories.tsx +0 -29
- package/src/crate-builder/primitives/SelectObject.tsx +0 -105
- package/src/crate-builder/primitives/SelectUrl.stories.tsx +0 -42
- package/src/crate-builder/primitives/SelectUrl.tsx +0 -110
- package/src/crate-builder/primitives/Text.stories.tsx +0 -106
- package/src/crate-builder/primitives/Text.tsx +0 -197
- package/src/crate-builder/primitives/Time.stories.tsx +0 -38
- package/src/crate-builder/primitives/Time.tsx +0 -71
- package/src/crate-builder/primitives/Url.stories.tsx +0 -43
- package/src/crate-builder/primitives/Url.tsx +0 -75
- package/src/crate-builder/primitives/Value.stories.tsx +0 -37
- package/src/crate-builder/primitives/Value.tsx +0 -30
- package/src/crate-builder/primitives/date-libs.ts +0 -12
- package/src/crate-builder/profile-schema.json +0 -145
- package/src/crate-builder/property-definitions.ts +0 -78
- package/src/crate-builder/recrate.css +0 -3
- package/src/crate-builder/store.ts +0 -14
- package/src/crate-builder/tailwind.css +0 -5
- package/src/crate-builder/types.d.ts +0 -318
- package/src/examples/collection/collections-entity-example.json +0 -131
- package/src/examples/collection/crate-builder-entity-example.json +0 -33
- package/src/examples/item/complex-collection/ro-crate-metadata.json +0 -174
- package/src/examples/item/complex-item/ro-crate-metadata.json +0 -769
- package/src/examples/item/crate-with-language.json +0 -38
- package/src/examples/item/empty/ro-crate-metadata.json +0 -20
- package/src/examples/item/item-with-relationship-and-action/ro-crate-metadata.json +0 -66
- package/src/examples/item/large-crate/ro-crate-metadata.json +0 -5762
- package/src/examples/item/multiple-types/ro-crate-metadata.json +0 -20
- package/src/examples/item/ridiculously-big-collection/ro-crate-metadata.json +0 -162977
- package/src/examples/profile/aroma.complex.profile.json +0 -11098
- package/src/examples/profile/aroma.profile.json +0 -9158
- package/src/examples/profile/nyingarn-item-profile.json +0 -426
- package/src/examples/profile/profile-to-test-inverse-associations.json +0 -73
- package/src/examples/profile/profile-to-test-multiple-types.json +0 -31
- package/src/examples/profile/profile-with-all-primitives-and-groups.json +0 -207
- package/src/examples/profile/profile-with-all-primitives.json +0 -244
- package/src/examples/profile/profile-with-constraints.json +0 -446
- package/src/examples/profile/profile-with-resolve.json +0 -57
- package/src/examples/profile/vocabulary-creation-profile.json +0 -231
- package/src/images.d.ts +0 -5
- package/src/index.ts +0 -12
- package/src/types.ts +0 -104
- package/tailwind.config.js +0 -21
- package/tsconfig.app.json +0 -31
- package/tsconfig.json +0 -26
- package/typedoc.json +0 -11
- package/update-deps.sh +0 -4
- package/vite-env.d.ts +0 -1
- package/vite.config.ts +0 -67
- /package/{public → dist}/favicon.ico +0 -0
- /package/{public → dist}/index.html +0 -0
- /package/{public → dist}/logo192.png +0 -0
- /package/{public → dist}/logo512.png +0 -0
- /package/{public → dist}/manifest.json +0 -0
- /package/{public → dist}/marker-icon.png +0 -0
- /package/{public → dist}/marker-shadow.png +0 -0
- /package/{public → dist}/robots.txt +0 -0
|
@@ -1,240 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CrateManager | @describo/crate-builder-component</title><meta name="description" content="Documentation for @describo/crate-builder-component"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@describo/crate-builder-component</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@describo/crate-builder-component</a></li><li><a href="../modules/src_crate_builder_CrateManager_crate_manager.html">src/crate-builder/CrateManager/crate-manager</a></li><li><a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html">CrateManager</a></li></ul><h1>Class CrateManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CrateManager</p>
|
|
2
|
-
<p>A class to work with RO-Crates</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: -" class="tsd-anchor"></a>Param: -<a href="#Param: -" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an RO Crate to handle</p>
|
|
4
|
-
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L62">CrateManager/crate-manager.ts:62</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
5
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#blankNodes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blank<wbr/>Nodes</span></a>
|
|
6
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#contextDefinitions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Definitions</span></a>
|
|
7
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#coreProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>core<wbr/>Properties</span></a>
|
|
8
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#crate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crate</span></a>
|
|
9
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#entityIdIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Id<wbr/>Index</span></a>
|
|
10
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#entityTimestamps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Timestamps</span></a>
|
|
11
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#entityTypes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Types</span></a>
|
|
12
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#errors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>errors</span></a>
|
|
13
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#graphLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>graph<wbr/>Length</span></a>
|
|
14
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#localContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Context</span></a>
|
|
15
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#pm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pm</span></a>
|
|
16
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#providedContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provided<wbr/>Context</span></a>
|
|
17
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#reverse" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reverse</span></a>
|
|
18
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#rootDataset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>root<wbr/>Dataset?</span></a>
|
|
19
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#rootDescriptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>root<wbr/>Descriptor?</span></a>
|
|
20
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#warnings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>warnings</span></a>
|
|
21
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__addReverse" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__add<wbr/>Reverse</span></a>
|
|
22
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__collectAllDefinitions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__collect<wbr/>All<wbr/>Definitions</span></a>
|
|
23
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__confirmNoClash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__confirm<wbr/>No<wbr/>Clash</span></a>
|
|
24
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__materialiseEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__materialise<wbr/>Entity</span></a>
|
|
25
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__normaliseContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__normalise<wbr/>Context</span></a>
|
|
26
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__removeAssociations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__remove<wbr/>Associations</span></a>
|
|
27
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__removeEntityType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__remove<wbr/>Entity<wbr/>Type</span></a>
|
|
28
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__setError" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__set<wbr/>Error</span></a>
|
|
29
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__setWarning" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__set<wbr/>Warning</span></a>
|
|
30
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__storeEntityType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__store<wbr/>Entity<wbr/>Type</span></a>
|
|
31
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__updateContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__update<wbr/>Context</span></a>
|
|
32
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#__updateEntityId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__update<wbr/>Entity<wbr/>Id</span></a>
|
|
33
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#addBlankNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Blank<wbr/>Node</span></a>
|
|
34
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#addEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Entity</span></a>
|
|
35
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#addFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>File</span></a>
|
|
36
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#addFileOrFolder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>File<wbr/>Or<wbr/>Folder</span></a>
|
|
37
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#addFolder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Folder</span></a>
|
|
38
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#deleteEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Entity</span></a>
|
|
39
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#deleteProperty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Property</span></a>
|
|
40
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#exportCrate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Crate</span></a>
|
|
41
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#exportEntityTemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Entity<wbr/>Template</span></a>
|
|
42
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#flatten" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>flatten</span></a>
|
|
43
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Context</span></a>
|
|
44
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getEntities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entities</span></a>
|
|
45
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entity</span></a>
|
|
46
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getEntityTypes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entity<wbr/>Types</span></a>
|
|
47
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getErrors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Errors</span></a>
|
|
48
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getRootDataset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Dataset</span></a>
|
|
49
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getRootDescriptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Descriptor</span></a>
|
|
50
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#getWarnings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Warnings</span></a>
|
|
51
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#ingestAndLink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ingest<wbr/>And<wbr/>Link</span></a>
|
|
52
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#linkEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>link<wbr/>Entity</span></a>
|
|
53
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#locateEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>locate<wbr/>Entity</span></a>
|
|
54
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#purgeUnlinkedEntities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>purge<wbr/>Unlinked<wbr/>Entities</span></a>
|
|
55
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#resolveLinkedEntityAssociations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resolve<wbr/>Linked<wbr/>Entity<wbr/>Associations</span></a>
|
|
56
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#setContext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Context</span></a>
|
|
57
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#setProfileManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Profile<wbr/>Manager</span></a>
|
|
58
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#setProperty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Property</span></a>
|
|
59
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#unlinkEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unlink<wbr/>Entity</span></a>
|
|
60
|
-
<a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html#updateProperty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Property</span></a>
|
|
61
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_CrateManager" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Crate<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html" class="tsd-signature-type tsd-kind-class">CrateManager</a><a href="#constructor.new_CrateManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">crate</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.UnverifiedCrate.html" class="tsd-signature-type tsd-kind-interface">UnverifiedCrate</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">entityTimestamps</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pm</span><span class="tsd-signature-symbol">?: </span><a href="src_crate_builder_types.ProfileManagerType.html" class="tsd-signature-type tsd-kind-class">ProfileManagerType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">crate</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.UnverifiedCrate.html" class="tsd-signature-type tsd-kind-interface">UnverifiedCrate</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">entity<wbr/>Timestamps</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pm</span><span class="tsd-signature-symbol">?: </span><a href="src_crate_builder_types.ProfileManagerType.html" class="tsd-signature-type tsd-kind-class">ProfileManagerType</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="src_crate_builder_CrateManager_crate_manager.CrateManager.html" class="tsd-signature-type tsd-kind-class">CrateManager</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L87">CrateManager/crate-manager.ts:87</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="blankNodes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>blank<wbr/>Nodes</span><a href="#blankNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">blank<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L82">CrateManager/crate-manager.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contextDefinitions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>context<wbr/>Definitions</span><a href="#contextDefinitions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">context<wbr/>Definitions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L78">CrateManager/crate-manager.ts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="coreProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>core<wbr/>Properties</span><a href="#coreProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">core<wbr/>Properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L83">CrateManager/crate-manager.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="crate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>crate</span><a href="#crate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">crate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@context</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">@graph</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L63">CrateManager/crate-manager.ts:63</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="entityIdIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entity<wbr/>Id<wbr/>Index</span><a href="#entityIdIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entity<wbr/>Id<wbr/>Index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L74">CrateManager/crate-manager.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="entityTimestamps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entity<wbr/>Timestamps</span><a href="#entityTimestamps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entity<wbr/>Timestamps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L81">CrateManager/crate-manager.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="entityTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entity<wbr/>Types</span><a href="#entityTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entity<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L80">CrateManager/crate-manager.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="errors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>errors</span><a href="#errors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">errors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">errorsInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L84">CrateManager/crate-manager.ts:84</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="graphLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>graph<wbr/>Length</span><a href="#graphLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">graph<wbr/>Length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L71">CrateManager/crate-manager.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="localContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>local<wbr/>Context</span><a href="#localContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">local<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L79">CrateManager/crate-manager.ts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pm</span><a href="#pm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pm</span><span class="tsd-signature-symbol">:</span> <a href="src_crate_builder_types.ProfileManagerType.html" class="tsd-signature-type tsd-kind-class">ProfileManagerType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L67">CrateManager/crate-manager.ts:67</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="providedContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>provided<wbr/>Context</span><a href="#providedContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">provided<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L77">CrateManager/crate-manager.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="reverse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reverse</span><a href="#reverse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reverse</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L68">CrateManager/crate-manager.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rootDataset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>root<wbr/>Dataset</span><a href="#rootDataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">root<wbr/>Dataset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L73">CrateManager/crate-manager.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rootDescriptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>root<wbr/>Descriptor</span><a href="#rootDescriptor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">root<wbr/>Descriptor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L72">CrateManager/crate-manager.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="warnings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>warnings</span><a href="#warnings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">warnings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">warningsInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L85">CrateManager/crate-manager.ts:85</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="__addReverse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__add<wbr/>Reverse</span><a href="#__addReverse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__addReverse.__addReverse-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__add<wbr/>Reverse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__addReverse.__addReverse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L2001">CrateManager/crate-manager.ts:2001</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__collectAllDefinitions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__collect<wbr/>All<wbr/>Definitions</span><a href="#__collectAllDefinitions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__collectAllDefinitions.__collectAllDefinitions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__collect<wbr/>All<wbr/>Definitions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#__collectAllDefinitions.__collectAllDefinitions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5></li></ul><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1775">CrateManager/crate-manager.ts:1775</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__confirmNoClash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__confirm<wbr/>No<wbr/>Clash</span><a href="#__confirmNoClash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__confirmNoClash.__confirmNoClash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__confirm<wbr/>No<wbr/>Clash</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#__confirmNoClash.__confirmNoClash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mintNewId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">mint<wbr/>New<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1821">CrateManager/crate-manager.ts:1821</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__materialiseEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__materialise<wbr/>Entity</span><a href="#__materialiseEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__materialiseEntity.__materialiseEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__materialise<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#__materialiseEntity.__materialiseEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1814">CrateManager/crate-manager.ts:1814</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__normaliseContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__normalise<wbr/>Context</span><a href="#__normaliseContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__normaliseContext.__normaliseContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__normalise<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a><a href="#__normaliseContext.__normaliseContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Normalise context</p>
|
|
62
|
-
<p>Collapse all objects into a single object</p>
|
|
63
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a></h4><p>context</p>
|
|
64
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1748">CrateManager/crate-manager.ts:1748</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__removeAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__remove<wbr/>Associations</span><a href="#__removeAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__removeAssociations.__removeAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__remove<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#__removeAssociations.__removeAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L2028">CrateManager/crate-manager.ts:2028</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__removeEntityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__remove<wbr/>Entity<wbr/>Type</span><a href="#__removeEntityType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__removeEntityType.__removeEntityType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__remove<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__removeEntityType.__removeEntityType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1768">CrateManager/crate-manager.ts:1768</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__setError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__set<wbr/>Error</span><a href="#__setError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__setError.__setError-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__set<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__setError.__setError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">errorsInterface</span></span></li><li><span><span class="tsd-kind-parameter">entity</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1796">CrateManager/crate-manager.ts:1796</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__setWarning" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__set<wbr/>Warning</span><a href="#__setWarning" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__setWarning.__setWarning-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__set<wbr/>Warning</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">warning</span>, <span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__setWarning.__setWarning-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">warning</span>: <span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">warningsInterface</span></span></li><li><span><span class="tsd-kind-parameter">entity</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1804">CrateManager/crate-manager.ts:1804</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__storeEntityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__store<wbr/>Entity<wbr/>Type</span><a href="#__storeEntityType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__storeEntityType.__storeEntityType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__store<wbr/>Entity<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__storeEntityType.__storeEntityType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1758">CrateManager/crate-manager.ts:1758</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__updateContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__update<wbr/>Context</span><a href="#__updateContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__updateContext.__updateContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__update<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__updateContext.__updateContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1729">CrateManager/crate-manager.ts:1729</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="__updateEntityId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__update<wbr/>Entity<wbr/>Id</span><a href="#__updateEntityId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__updateEntityId.__updateEntityId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">__update<wbr/>Entity<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__updateEntityId.__updateEntityId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">newId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">oldId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">new<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">old<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1865">CrateManager/crate-manager.ts:1865</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addBlankNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Blank<wbr/>Node</span><a href="#addBlankNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addBlankNode.addBlankNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Blank<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#addBlankNode.addBlankNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add an entity with a blank node id ('_:...') to the graph.</p>
|
|
65
|
-
<p>Use this when you want to add a non contextual entity to the graph. In thoses
|
|
66
|
-
cases providing an <code>@id</code> and name don't really make sense even though those properties are still required
|
|
67
|
-
therefore this method simplifies the process of adding those entity types. For example,
|
|
68
|
-
Actions (e.g. CreateAction), Relationships, GeoShape, GeoCoordinates etc</p>
|
|
69
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the entity type to configure for the new entity</p>
|
|
70
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
71
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">r</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">addBlankNode</span><span class="hl-1">(</span><span class="hl-7">'Relationship)</span><span class="hl-8">;</span><br/><br/><span class="hl-0">r</span><span class="hl-1"> === {</span><br/><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'_:Relationship1'</span><span class="hl-1">,</span><br/><span class="hl-7">'@type'</span><span class="hl-0">:</span><span class="hl-1"> [ </span><span class="hl-7">'Relationship'</span><span class="hl-1"> ],</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">'_:Relationship1'</span><br/><span class="hl-1">}</span>
|
|
72
|
-
</code><button type="button">Copy</button></pre>
|
|
73
|
-
|
|
74
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L852">CrateManager/crate-manager.ts:852</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Entity</span><a href="#addEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addEntity.addEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#addEntity.addEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add an entity to the graph</p>
|
|
75
|
-
<p>The entity must have '@id' and '@type' defined.</p>
|
|
76
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a></span><div class="tsd-comment tsd-typography"><p>an entity definition to add to the crate</p>
|
|
77
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
78
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entity</span><span class="hl-1"> = {</span><br/><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#e1'</span><span class="hl-1">,</span><br/><span class="hl-7">"@type"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">"Person"</span><span class="hl-1">,</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">'person1'</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">r</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">addEntity</span><span class="hl-1">(</span><span class="hl-0">entity</span><span class="hl-1">);</span>
|
|
79
|
-
</code><button type="button">Copy</button></pre>
|
|
80
|
-
|
|
81
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L783">CrateManager/crate-manager.ts:783</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>File</span><a href="#addFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addFile.addFile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#addFile.addFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add file</p>
|
|
82
|
-
<p>This is a helper method specifically for adding files to the crate. This method
|
|
83
|
-
will add the intermediate paths as 'Datasets' (as per the spec) and link everything via the hasPart
|
|
84
|
-
property as required. It is assumed that the path is relative to the root of the folder.</p>
|
|
85
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a file path to add - ensure the file path is relative to the folder root</p>
|
|
86
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
87
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">r</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">addFile</span><span class="hl-1">(</span><span class="hl-7">'/a/b/c/file.txt)</span><span class="hl-8">;</span>
|
|
88
|
-
</code><button type="button">Copy</button></pre>
|
|
89
|
-
|
|
90
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L981">CrateManager/crate-manager.ts:981</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addFileOrFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>File<wbr/>Or<wbr/>Folder</span><a href="#addFileOrFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addFileOrFolder.addFileOrFolder-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>File<wbr/>Or<wbr/>Folder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#addFileOrFolder.addFileOrFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add files or folders - use addFile or addFolder in preference to this</p>
|
|
91
|
-
<p>This is a helper method specifically for adding files and folders in the crate. This method
|
|
92
|
-
will add the intermediate paths as 'Datasets' (as per the spec) and link everything via the hasPart
|
|
93
|
-
property as required. It is assumed that the path is relative to the root of the folder.</p>
|
|
94
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>a file or folder path</p>
|
|
95
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the type of thing being added - File or Dataset</p>
|
|
96
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
97
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-3" class="tsd-anchor"></a>Example<a href="#Example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">r</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">addFileOrFolder</span><span class="hl-1">(</span><span class="hl-7">'/a/b/c/file.txt)</span><span class="hl-8">;</span>
|
|
98
|
-
</code><button type="button">Copy</button></pre>
|
|
99
|
-
|
|
100
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L880">CrateManager/crate-manager.ts:880</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Folder</span><a href="#addFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addFolder.addFolder-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Folder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#addFolder.addFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add folder</p>
|
|
101
|
-
<p>This is a helper method specifically for adding folders to the crate. This method
|
|
102
|
-
will add the intermediate paths as 'Datasets' (as per the spec) and link everything via the hasPart
|
|
103
|
-
property as required. It is assumed that the path is relative to the root of the folder.</p>
|
|
104
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a folder path to add - ensure the folder path is relative to the folder root</p>
|
|
105
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
106
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-4" class="tsd-anchor"></a>Example<a href="#Example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">r</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">addFolder</span><span class="hl-1">(</span><span class="hl-7">'/a/b/c)</span><span class="hl-8">;</span>
|
|
107
|
-
</code><button type="button">Copy</button></pre>
|
|
108
|
-
|
|
109
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L999">CrateManager/crate-manager.ts:999</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Entity</span><a href="#deleteEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteEntity.deleteEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><a href="#deleteEntity.deleteEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete an entity</p>
|
|
110
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to delete from the crate</p>
|
|
111
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h4><p>true if successful</p>
|
|
112
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-5" class="tsd-anchor"></a>Example<a href="#Example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">deleteEntity</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'#e1'</span><span class="hl-1"> })</span>
|
|
113
|
-
</code><button type="button">Copy</button></pre>
|
|
114
|
-
|
|
115
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1016">CrateManager/crate-manager.ts:1016</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteProperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Property</span><a href="#deleteProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteProperty.deleteProperty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteProperty.deleteProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a specific property from the entity. That is, an instance of a property.</p>
|
|
116
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">idx</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">idx</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-6" class="tsd-anchor"></a>Example<a href="#Example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">deleteProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"author"</span><span class="hl-1">, </span><span class="hl-0">idx:</span><span class="hl-1"> </span><span class="hl-4">1</span><span class="hl-1"> });</span>
|
|
117
|
-
</code><button type="button">Copy</button></pre>
|
|
118
|
-
|
|
119
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1258">CrateManager/crate-manager.ts:1258</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="exportCrate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export<wbr/>Crate</span><a href="#exportCrate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="exportCrate.exportCrate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export<wbr/>Crate</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedCrate.html" class="tsd-signature-type tsd-kind-interface">NormalisedCrate</a><a href="#exportCrate.exportCrate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export the RO-Crate</p>
|
|
120
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedCrate.html" class="tsd-signature-type tsd-kind-interface">NormalisedCrate</a></h4><p>the complete ro-crate</p>
|
|
121
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-7" class="tsd-anchor"></a>Example<a href="#Example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">crate</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">exportCrate</span><span class="hl-1">()</span>
|
|
122
|
-
</code><button type="button">Copy</button></pre>
|
|
123
|
-
|
|
124
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1611">CrateManager/crate-manager.ts:1611</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="exportEntityTemplate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export<wbr/>Entity<wbr/>Template</span><a href="#exportEntityTemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="exportEntityTemplate.exportEntityTemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export<wbr/>Entity<wbr/>Template</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#exportEntityTemplate.exportEntityTemplate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>exportEntityTemplate</p>
|
|
125
|
-
<p>Export an entity as a template to be reused.</p>
|
|
126
|
-
<ol>
|
|
127
|
-
<li>If resolveDepth = 0 then the entity is returned with all associations removed</li>
|
|
128
|
-
<li>If resolveDepth = 1 then the entity is returned with one level of associations populated but
|
|
129
|
-
all of their associations will be removed.</li>
|
|
130
|
-
</ol>
|
|
131
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">resolveDepth</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to export as a template</p>
|
|
132
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">resolve<wbr/>Depth</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>0 or 1. If 1, linked entities will be joined in</p>
|
|
133
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>entity</p>
|
|
134
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-8" class="tsd-anchor"></a>Example<a href="#Example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entity</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">exportEntityTemplate</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'#person'</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entity</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">exportEntityTemplate</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'#person'</span><span class="hl-1">, </span><span class="hl-0">resolveDepth:</span><span class="hl-1"> </span><span class="hl-4">1</span><span class="hl-1"> })</span>
|
|
135
|
-
</code><button type="button">Copy</button></pre>
|
|
136
|
-
|
|
137
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1671">CrateManager/crate-manager.ts:1671</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="flatten" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>flatten</span><a href="#flatten" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="flatten.flatten-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">flatten</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">json</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">[]</span><a href="#flatten.flatten-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Flatten a nested json object to an array</p>
|
|
138
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">json</span>: <a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a></span><div class="tsd-comment tsd-typography"><p>a potentially nested data blob to flatten into array</p>
|
|
139
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">[]</span></h4><p>an array of objects</p>
|
|
140
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-9" class="tsd-anchor"></a>Example<a href="#Example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">json</span><span class="hl-1"> = {</span><br/><span class="hl-1">...,</span><br/><span class="hl-1">}</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">arrayOfObjects</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">flatten</span><span class="hl-1">(</span><span class="hl-0">json</span><span class="hl-1">)</span>
|
|
141
|
-
</code><button type="button">Copy</button></pre>
|
|
142
|
-
|
|
143
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1371">CrateManager/crate-manager.ts:1371</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Context</span><a href="#getContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getContext.getContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a><a href="#getContext.getContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the context</p>
|
|
144
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a></h4><p>the crate context</p>
|
|
145
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L339">CrateManager/crate-manager.ts:339</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getEntities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Entities</span><a href="#getEntities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getEntities.getEntities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Entities</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Generator</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#getEntities.getEntities-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>how many entities to return</p>
|
|
146
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>a string to match against @id,</p>
|
|
147
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>a string to match against</p>
|
|
148
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Generator</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Generator" class="tsd-anchor"></a>Generator<a href="#Generator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><h4 class="tsd-anchor-link"><a id="Yields" class="tsd-anchor"></a>Yields<a href="#Yields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><h4 class="tsd-anchor-link"><a id="Example-10" class="tsd-anchor"></a>Example<a href="#Example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({</span><span class="hl-0">crate</span><span class="hl-1">})</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entities</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">getEntities</span><span class="hl-1">()</span><br/><br/><span class="hl-9">for</span><span class="hl-1"> (</span><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entity</span><span class="hl-1"> </span><span class="hl-5">of</span><span class="hl-1"> </span><span class="hl-0">entities</span><span class="hl-1">) {</span><br/><span class="hl-1">...</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">To</span><span class="hl-1"> </span><span class="hl-0">get</span><span class="hl-1"> </span><span class="hl-0">an</span><span class="hl-1"> </span><span class="hl-0">array</span><span class="hl-1"> </span><span class="hl-0">just</span><span class="hl-1"> </span><span class="hl-0">spread</span><span class="hl-1"> </span><span class="hl-0">the</span><span class="hl-1"> </span><span class="hl-9">return</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entities</span><span class="hl-1"> = [ ...</span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">getEntities</span><span class="hl-1">() ]</span><br/><br/><span class="hl-10">// query @id,</span>
|
|
149
|
-
</code><button type="button">Copy</button></pre>
|
|
150
|
-
|
|
151
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L511">CrateManager/crate-manager.ts:511</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Entity</span><a href="#getEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getEntity.getEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#getEntity.getEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get an entity</p>
|
|
152
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">link</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">materialise</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">stub</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to get</p>
|
|
153
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">link</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true, all the associated entities are filled out as stubs</p>
|
|
154
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">materialise</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true, the entity will be created if it doesn't exist (consider
|
|
155
|
-
when URL's point outside the crate, in this case, they will be created as entities inside it)</p>
|
|
156
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">stub</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true, only the <code>@id, @type and name</code> prop's will be returned. That is,
|
|
157
|
-
you get a stub entry not the complete entity data.</p>
|
|
158
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the entity</p>
|
|
159
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-11" class="tsd-anchor"></a>Example<a href="#Example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><br/><span class="hl-10">// get the full entity</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">rd</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">getEntity</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'./'</span><span class="hl-1"> })</span><br/><br/><span class="hl-10">// return a stub entry</span><br/><span class="hl-0">rd</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">getEntity</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'./'</span><span class="hl-1">, </span><span class="hl-0">stub:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> })</span>
|
|
160
|
-
</code><button type="button">Copy</button></pre>
|
|
161
|
-
|
|
162
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L425">CrateManager/crate-manager.ts:425</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getEntityTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Entity<wbr/>Types</span><a href="#getEntityTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getEntityTypes.getEntityTypes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Entity<wbr/>Types</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getEntityTypes.getEntityTypes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get Entity Types</p>
|
|
163
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>an array of entity types, sorted, found in the crate</p>
|
|
164
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L477">CrateManager/crate-manager.ts:477</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getErrors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Errors</span><a href="#getErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getErrors.getErrors-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">errorsInterface</span><a href="#getErrors.getErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>getErrors</p>
|
|
165
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">errorsInterface</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1716">CrateManager/crate-manager.ts:1716</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRootDataset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Root<wbr/>Dataset</span><a href="#getRootDataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRootDataset.getRootDataset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Root<wbr/>Dataset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#getRootDataset.getRootDataset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the root dataset</p>
|
|
166
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><p>the root dataset entity</p>
|
|
167
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-12" class="tsd-anchor"></a>Example<a href="#Example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">rd</span><span class="hl-1"> = </span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">getRootDataset</span><span class="hl-1">()</span>
|
|
168
|
-
</code><button type="button">Copy</button></pre>
|
|
169
|
-
|
|
170
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L390">CrateManager/crate-manager.ts:390</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRootDescriptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Root<wbr/>Descriptor</span><a href="#getRootDescriptor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRootDescriptor.getRootDescriptor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Root<wbr/>Descriptor</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#getRootDescriptor.getRootDescriptor-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L396">CrateManager/crate-manager.ts:396</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWarnings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Warnings</span><a href="#getWarnings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWarnings.getWarnings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Warnings</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">warningsInterface</span><a href="#getWarnings.getWarnings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>getWarnings</p>
|
|
171
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">warningsInterface</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1725">CrateManager/crate-manager.ts:1725</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ingestAndLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ingest<wbr/>And<wbr/>Link</span><a href="#ingestAndLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ingestAndLink.ingestAndLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ingest<wbr/>And<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#ingestAndLink.ingestAndLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Ingest and link a nested json object</p>
|
|
172
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">json</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">propertyId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to join the data into</p>
|
|
173
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">json</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.UnverifiedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">UnverifiedEntityDefinition</a></h5><div class="tsd-comment tsd-typography"><p>the data object to join in</p>
|
|
174
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the property to join the data into</p>
|
|
175
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the propertyId of the property - ie the url to the definition</p>
|
|
176
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-13" class="tsd-anchor"></a>Example<a href="#Example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">json</span><span class="hl-1"> = {</span><br/><span class="hl-1">...,</span><br/><span class="hl-1">}</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">ingestAndLink</span><span class="hl-1">({</span><br/><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">,</span><br/><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"language"</span><span class="hl-1">,</span><br/><span class="hl-0">json</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
177
|
-
</code><button type="button">Copy</button></pre>
|
|
178
|
-
|
|
179
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1316">CrateManager/crate-manager.ts:1316</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="linkEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>link<wbr/>Entity</span><a href="#linkEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="linkEntity.linkEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">link<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#linkEntity.linkEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Link two entities</p>
|
|
180
|
-
<p>Link two entities via a property. If there is a profile defined
|
|
181
|
-
and it has reverse associations, then they will be added.</p>
|
|
182
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">propertyId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to add the association to</p>
|
|
183
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the property to add the association to</p>
|
|
184
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">property<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the propertyId of the property - ie the url to the definition</p>
|
|
185
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>an object with '@id' defining the association to create</p>
|
|
186
|
-
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-14" class="tsd-anchor"></a>Example<a href="#Example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">linkEntity</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'./'</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">'author'</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> { </span><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#e1'</span><span class="hl-1"> }})</span>
|
|
187
|
-
</code><button type="button">Copy</button></pre>
|
|
188
|
-
|
|
189
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1411">CrateManager/crate-manager.ts:1411</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="locateEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>locate<wbr/>Entity</span><a href="#locateEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="locateEntity.locateEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">locate<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">[]</span><a href="#locateEntity.locateEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>locateEntity</p>
|
|
190
|
-
<p>Given a set of id's, find the entity or entities that link to all of them.
|
|
191
|
-
This is really for finding grouping type entities like Relationships and Actions so that
|
|
192
|
-
you can augment their description.</p>
|
|
193
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">entityIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">strict</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">entity<wbr/>Ids</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>an array of entity id's that are linked to from another entity</p>
|
|
194
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">strict</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>if true return entities that have exactly entityIds linked. If false,
|
|
195
|
-
return entities that have at least entityIds linked</p>
|
|
196
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">[]</span></h4><p>[] entities matching or undefined</p>
|
|
197
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L584">CrateManager/crate-manager.ts:584</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="purgeUnlinkedEntities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>purge<wbr/>Unlinked<wbr/>Entities</span><a href="#purgeUnlinkedEntities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="purgeUnlinkedEntities.purgeUnlinkedEntities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">purge<wbr/>Unlinked<wbr/>Entities</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#purgeUnlinkedEntities.purgeUnlinkedEntities-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Purge unlinked entities from the crate</p>
|
|
198
|
-
<p>Clean up the graph and purge any unlinked entities including disconnected subtrees.</p>
|
|
199
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-15" class="tsd-anchor"></a>Example<a href="#Example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">purgeUnlinkedEntities</span><span class="hl-1">()</span>
|
|
200
|
-
</code><button type="button">Copy</button></pre>
|
|
201
|
-
|
|
202
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1539">CrateManager/crate-manager.ts:1539</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resolveLinkedEntityAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resolve<wbr/>Linked<wbr/>Entity<wbr/>Associations</span><a href="#resolveLinkedEntityAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resolveLinkedEntityAssociations.resolveLinkedEntityAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resolve<wbr/>Linked<wbr/>Entity<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">@type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><a href="#resolveLinkedEntityAssociations.resolveLinkedEntityAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>resolveLinkedEntities</p>
|
|
203
|
-
<p>Given an entity and a profile, if the entity matches a resolve configuration
|
|
204
|
-
this method will populate the entities linked from the resolve properties
|
|
205
|
-
defined in the profile.</p>
|
|
206
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">profile</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedProfile.html" class="tsd-signature-type tsd-kind-interface">NormalisedProfile</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">entity</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">profile</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/src_crate_builder_types.NormalisedProfile.html" class="tsd-signature-type tsd-kind-interface">NormalisedProfile</a></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">@type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></h4><p>an array of associations</p>
|
|
207
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-16" class="tsd-anchor"></a>Example<a href="#Example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-10">// given an entity</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">entity</span><span class="hl-1"> = {</span><br/><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">"#createAction1"</span><span class="hl-1">,</span><br/><span class="hl-7">"@type"</span><span class="hl-0">:</span><span class="hl-1"> [</span><span class="hl-7">"CreateAction"</span><span class="hl-1">],</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">"A very long named create action to demonstrate what happens with display of long names"</span><span class="hl-1">,</span><br/><span class="hl-0">object:</span><span class="hl-1"> { </span><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">"#person2"</span><span class="hl-1"> },</span><br/><span class="hl-0">participant:</span><span class="hl-1"> { </span><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">"#participant1"</span><span class="hl-1"> },</span><br/><span class="hl-0">agent:</span><span class="hl-1"> { </span><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">"#agent1"</span><span class="hl-1"> },</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-10">// and a profile with a resolve configuration</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">profile</span><span class="hl-1"> = {</span><br/><span class="hl-1">...</span><br/><span class="hl-0">resolve</span><span class="hl-1">: [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">types:</span><span class="hl-1"> [ </span><span class="hl-7">'Relationship'</span><span class="hl-1">, </span><span class="hl-7">'Related'</span><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-0">properties:</span><span class="hl-1"> [ </span><span class="hl-7">'source'</span><span class="hl-1">, </span><span class="hl-7">'target'</span><span class="hl-1"> ]</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">types:</span><span class="hl-1"> [ </span><span class="hl-7">'CreateAction'</span><span class="hl-1">, </span><span class="hl-7">'EditAction'</span><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-0">properties:</span><span class="hl-1"> [ </span><span class="hl-7">'object'</span><span class="hl-1">, </span><span class="hl-7">'participant'</span><span class="hl-1">, </span><span class="hl-7">'agent'</span><span class="hl-1"> ]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">]</span><br/><span class="hl-1">...</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-10">// get a list of the associated entities</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-2">log</span><span class="hl-1">(</span><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">resolveLinkedEntityAssociations</span><span class="hl-1">({ </span><span class="hl-0">entity</span><span class="hl-1">, </span><span class="hl-0">profile</span><span class="hl-1"> }))</span><br/><br/><br/><span class="hl-0">associations</span><span class="hl-1"> === [</span><br/><span class="hl-1">{</span><br/><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">'object'</span><span class="hl-1">,</span><br/><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#person2'</span><span class="hl-1">,</span><br/><span class="hl-7">'@type'</span><span class="hl-0">:</span><span class="hl-1"> [ </span><span class="hl-7">'Thing'</span><span class="hl-1"> ],</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">'#person2'</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">'participant'</span><span class="hl-1">,</span><br/><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#participant1'</span><span class="hl-1">,</span><br/><span class="hl-7">'@type'</span><span class="hl-0">:</span><span class="hl-1"> [ </span><span class="hl-7">'Thing'</span><span class="hl-1"> ],</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">'#participant1'</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">'agent'</span><span class="hl-1">,</span><br/><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#agent1'</span><span class="hl-1">,</span><br/><span class="hl-7">'@type'</span><span class="hl-0">:</span><span class="hl-1"> [ </span><span class="hl-7">'Thing'</span><span class="hl-1"> ],</span><br/><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-7">'#agent1'</span><br/><span class="hl-1">}</span><br/><span class="hl-1">]</span>
|
|
208
|
-
</code><button type="button">Copy</button></pre>
|
|
209
|
-
|
|
210
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L704">CrateManager/crate-manager.ts:704</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Context</span><a href="#setContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setContext.setContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setContext.setContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the context</p>
|
|
211
|
-
<p>This is equivalent to a profile author setting a context. It gets
|
|
212
|
-
used as is and data updates going forward do not get dealth with.</p>
|
|
213
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../types/src_crate_builder_types.NormalisedContext.html" class="tsd-signature-type tsd-kind-type-alias">NormalisedContext</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L359">CrateManager/crate-manager.ts:359</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setProfileManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Profile<wbr/>Manager</span><a href="#setProfileManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setProfileManager.setProfileManager-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Profile<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setProfileManager.setProfileManager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set a profile</p>
|
|
214
|
-
<p>CrateManager can set reverse associations if defined in a profile.</p>
|
|
215
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pm</span>: <a href="src_crate_builder_types.ProfileManagerType.html" class="tsd-signature-type tsd-kind-class">ProfileManagerType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L369">CrateManager/crate-manager.ts:369</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setProperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Property</span><a href="#setProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setProperty.setProperty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><a href="#setProperty.setProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set a property on an entity</p>
|
|
216
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">propertyId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to add the property to</p>
|
|
217
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the property to add</p>
|
|
218
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">property<wbr/>Id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a></h5><div class="tsd-comment tsd-typography"><p>the data to add to that property. Can be string or object with '@id'</p>
|
|
219
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4><p>true if successful</p>
|
|
220
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-17" class="tsd-anchor"></a>Example<a href="#Example-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">authorId</span><span class="hl-1"> = </span><span class="hl-0">chance</span><span class="hl-1">.</span><span class="hl-2">url</span><span class="hl-1">();</span><br/><br/><span class="hl-10">// setting an object reference</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">setProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"author"</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> { </span><span class="hl-7">"@id"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">authorId</span><span class="hl-1"> } });</span><br/><br/><span class="hl-10">// setting a text string</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">setProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"author"</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-7">"text"</span><span class="hl-1"> });</span><br/><br/><span class="hl-10">// setting a number</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">setProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"author"</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-4">3</span><span class="hl-1"> });</span>
|
|
221
|
-
</code><button type="button">Copy</button></pre>
|
|
222
|
-
|
|
223
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1113">CrateManager/crate-manager.ts:1113</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unlinkEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unlink<wbr/>Entity</span><a href="#unlinkEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unlinkEntity.unlinkEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unlink<wbr/>Entity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unlinkEntity.unlinkEntity-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unlink two entities</p>
|
|
224
|
-
<p>Remove an association between two entities. If there is a profile defined
|
|
225
|
-
and it has reverse associations, then they will be removed as well.</p>
|
|
226
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">stop</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to remove the association from</p>
|
|
227
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the property containing the association</p>
|
|
228
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">stop</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">@id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>an object with '@id' defining the association to remove</p>
|
|
229
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-18" class="tsd-anchor"></a>Example<a href="#Example-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">unlinkEntity</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">'./'</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">'author'</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> { </span><span class="hl-7">'@id'</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-7">'#e1'</span><span class="hl-1"> }})</span>
|
|
230
|
-
</code><button type="button">Copy</button></pre>
|
|
231
|
-
|
|
232
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1460">CrateManager/crate-manager.ts:1460</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateProperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Property</span><a href="#updateProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateProperty.updateProperty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a><a href="#updateProperty.updateProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update a property on an entity</p>
|
|
233
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">idx</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id of the entity to add the property to</p>
|
|
234
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">idx</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the idx of the property array to update</p>
|
|
235
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">property</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the property to add</p>
|
|
236
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">: </span><a href="../types/src_crate_builder_types.EntityReference.html" class="tsd-signature-type tsd-kind-type-alias">EntityReference</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a><span class="tsd-signature-symbol"> | </span><a href="../types/src_crate_builder_types.PrimitiveType.html" class="tsd-signature-type tsd-kind-type-alias">PrimitiveType</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>the data to add to that property, string or object with '@id'</p>
|
|
237
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/src_crate_builder_types.NormalisedEntityDefinition.html" class="tsd-signature-type tsd-kind-interface">NormalisedEntityDefinition</a></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-19" class="tsd-anchor"></a>Example<a href="#Example-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">cm</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-2">CrateManager</span><span class="hl-1">({ </span><span class="hl-0">crate</span><span class="hl-1"> })</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">updateProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"@id"</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-7">"something else"</span><span class="hl-1"> });</span><br/><span class="hl-0">cm</span><span class="hl-1">.</span><span class="hl-2">updateProperty</span><span class="hl-1">({ </span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-7">"./"</span><span class="hl-1">, </span><span class="hl-0">property:</span><span class="hl-1"> </span><span class="hl-7">"author"</span><span class="hl-1">, </span><span class="hl-0">idx:</span><span class="hl-1"> </span><span class="hl-4">1</span><span class="hl-1">, </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-7">"new"</span><span class="hl-1"> });</span>
|
|
238
|
-
</code><button type="button">Copy</button></pre>
|
|
239
|
-
|
|
240
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/describo/crate-builder-component/blob/57d3569567e5df610e341812d50c76069c89806b/src/crate-builder/CrateManager/crate-manager.ts#L1186">CrateManager/crate-manager.ts:1186</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#blankNodes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blank<wbr/>Nodes</span></a><a href="#contextDefinitions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Definitions</span></a><a href="#coreProperties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>core<wbr/>Properties</span></a><a href="#crate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crate</span></a><a href="#entityIdIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Id<wbr/>Index</span></a><a href="#entityTimestamps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Timestamps</span></a><a href="#entityTypes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Types</span></a><a href="#errors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>errors</span></a><a href="#graphLength" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>graph<wbr/>Length</span></a><a href="#localContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Context</span></a><a href="#pm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pm</span></a><a href="#providedContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provided<wbr/>Context</span></a><a href="#reverse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reverse</span></a><a href="#rootDataset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>root<wbr/>Dataset</span></a><a href="#rootDescriptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>root<wbr/>Descriptor</span></a><a href="#warnings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>warnings</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#__addReverse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__add<wbr/>Reverse</span></a><a href="#__collectAllDefinitions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__collect<wbr/>All<wbr/>Definitions</span></a><a href="#__confirmNoClash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__confirm<wbr/>No<wbr/>Clash</span></a><a href="#__materialiseEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__materialise<wbr/>Entity</span></a><a href="#__normaliseContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__normalise<wbr/>Context</span></a><a href="#__removeAssociations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__remove<wbr/>Associations</span></a><a href="#__removeEntityType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__remove<wbr/>Entity<wbr/>Type</span></a><a href="#__setError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__set<wbr/>Error</span></a><a href="#__setWarning" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__set<wbr/>Warning</span></a><a href="#__storeEntityType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__store<wbr/>Entity<wbr/>Type</span></a><a href="#__updateContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__update<wbr/>Context</span></a><a href="#__updateEntityId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>__update<wbr/>Entity<wbr/>Id</span></a><a href="#addBlankNode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Blank<wbr/>Node</span></a><a href="#addEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Entity</span></a><a href="#addFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>File</span></a><a href="#addFileOrFolder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>File<wbr/>Or<wbr/>Folder</span></a><a href="#addFolder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Folder</span></a><a href="#deleteEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Entity</span></a><a href="#deleteProperty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Property</span></a><a href="#exportCrate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Crate</span></a><a href="#exportEntityTemplate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Entity<wbr/>Template</span></a><a href="#flatten" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>flatten</span></a><a href="#getContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Context</span></a><a href="#getEntities" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entities</span></a><a href="#getEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entity</span></a><a href="#getEntityTypes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entity<wbr/>Types</span></a><a href="#getErrors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Errors</span></a><a href="#getRootDataset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Dataset</span></a><a href="#getRootDescriptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Descriptor</span></a><a href="#getWarnings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Warnings</span></a><a href="#ingestAndLink" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ingest<wbr/>And<wbr/>Link</span></a><a href="#linkEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>link<wbr/>Entity</span></a><a href="#locateEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>locate<wbr/>Entity</span></a><a href="#purgeUnlinkedEntities" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>purge<wbr/>Unlinked<wbr/>Entities</span></a><a href="#resolveLinkedEntityAssociations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resolve<wbr/>Linked<wbr/>Entity<wbr/>Associations</span></a><a href="#setContext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Context</span></a><a href="#setProfileManager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Profile<wbr/>Manager</span></a><a href="#setProperty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Property</span></a><a href="#unlinkEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unlink<wbr/>Entity</span></a><a href="#updateProperty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Property</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@describo/crate-builder-component</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|