@octostar/platform-types 0.3.0 → 0.5.0

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.
Files changed (280) hide show
  1. package/dist/docs/assets/navigation.js +1 -1
  2. package/dist/docs/assets/search.js +1 -1
  3. package/dist/docs/enums/ProcessingStatusCode.html +30 -0
  4. package/dist/docs/enums/SortOrder.html +3 -3
  5. package/dist/docs/enums/WorkspacePermissionValue.html +3 -3
  6. package/dist/docs/hierarchy.html +1 -1
  7. package/dist/docs/index.html +2 -2
  8. package/dist/docs/interfaces/ActionContext.html +5 -4
  9. package/dist/docs/interfaces/{QueryObjectFilterClause.html → BinaryObjectFilterClause.html} +6 -5
  10. package/dist/docs/interfaces/ChartDataResponseResult.html +20 -0
  11. package/dist/docs/interfaces/Colorful.html +3 -3
  12. package/dist/docs/interfaces/Concept.html +12 -12
  13. package/dist/docs/interfaces/Desktop.html +90 -81
  14. package/dist/docs/interfaces/DesktopActionContext.html +8 -7
  15. package/dist/docs/interfaces/DesktopSettings.html +5 -5
  16. package/dist/docs/interfaces/GetAttachmentOptions.html +5 -5
  17. package/dist/docs/interfaces/IDataTransfer.html +11 -11
  18. package/dist/docs/interfaces/Inheritance.html +5 -5
  19. package/dist/docs/interfaces/NativeFilterColumn.html +3 -0
  20. package/dist/docs/interfaces/NativeFilterScope.html +3 -0
  21. package/dist/docs/interfaces/NativeFilterTarget.html +3 -0
  22. package/dist/docs/interfaces/Ontology.html +23 -23
  23. package/dist/docs/interfaces/ProcessingStatus.html +12 -0
  24. package/dist/docs/interfaces/Property.html +5 -5
  25. package/dist/docs/interfaces/RecordData.html +20 -0
  26. package/dist/docs/interfaces/RecordProvider.html +6 -6
  27. package/dist/docs/interfaces/RefObject.html +3 -3
  28. package/dist/docs/interfaces/Relationship.html +20 -20
  29. package/dist/docs/interfaces/SavedDatasource.html +7 -0
  30. package/dist/docs/interfaces/SavedSearchAPIInterface.html +6 -0
  31. package/dist/docs/interfaces/SavedSearchContent.html +7 -0
  32. package/dist/docs/interfaces/SearchProps.html +7 -5
  33. package/dist/docs/interfaces/SearchXperienceModalProps.html +9 -9
  34. package/dist/docs/interfaces/SearchXperienceProps.html +7 -7
  35. package/dist/docs/interfaces/SemanticBindingProps.html +5 -5
  36. package/dist/docs/interfaces/StylerContext.html +11 -11
  37. package/dist/docs/interfaces/TagAttributes.html +7 -7
  38. package/dist/docs/interfaces/UnaryObjectFilterClause.html +5 -0
  39. package/dist/docs/interfaces/WorkspaceChangeEmitter.html +5 -5
  40. package/dist/docs/interfaces/WorkspaceItemConfig.html +6 -6
  41. package/dist/docs/interfaces/WorkspaceRecordIdentifier.html +5 -5
  42. package/dist/docs/modules.html +34 -3
  43. package/dist/docs/types/ActionHandler.html +2 -2
  44. package/dist/docs/types/AddCommentParams.html +2 -2
  45. package/dist/docs/types/AddListener.html +2 -2
  46. package/dist/docs/types/ApiErrorResult.html +2 -2
  47. package/dist/docs/types/ApiResult.html +2 -2
  48. package/dist/docs/types/ApiSuccessResult.html +2 -2
  49. package/dist/docs/types/App.html +2 -2
  50. package/dist/docs/types/AppRegistry.html +2 -2
  51. package/dist/docs/types/AppServiceCallOptions.html +2 -2
  52. package/dist/docs/types/AppServiceCallProps.html +2 -2
  53. package/dist/docs/types/AsyncFilter.html +2 -2
  54. package/dist/docs/types/AttachmentResponseType.html +2 -2
  55. package/dist/docs/types/AttachmentType.html +2 -2
  56. package/dist/docs/types/Behaviour.html +2 -2
  57. package/dist/docs/types/BinaryOperator.html +2 -2
  58. package/dist/docs/types/Callback.html +2 -2
  59. package/dist/docs/types/CommentWorkspaceItem.html +2 -2
  60. package/dist/docs/types/Comparator.html +2 -2
  61. package/dist/docs/types/ConceptFilter.html +3 -3
  62. package/dist/docs/types/ConceptMap.html +2 -2
  63. package/dist/docs/types/ConceptName.html +1 -1
  64. package/dist/docs/types/ConceptWithParents.html +2 -2
  65. package/dist/docs/types/ConnectedEntity.html +2 -2
  66. package/dist/docs/types/ContextMenuGroup.html +2 -2
  67. package/dist/docs/types/ContextMenuLabels.html +2 -2
  68. package/dist/docs/types/ContextMenuOptions.html +2 -2
  69. package/dist/docs/types/ContextMenuParams.html +2 -2
  70. package/dist/docs/types/ContextMenuRequest.html +2 -2
  71. package/dist/docs/types/CopyOptions.html +2 -2
  72. package/dist/docs/types/CreateEntityFormProps.html +4 -3
  73. package/dist/docs/types/CreateLinkChartFn.html +1 -0
  74. package/dist/docs/types/CreateLinkChartParams.html +1 -0
  75. package/dist/docs/types/CreateRelationsDialogProps.html +2 -2
  76. package/dist/docs/types/CustomEventListener.html +2 -2
  77. package/dist/docs/types/CustomTemplate.html +2 -2
  78. package/dist/docs/types/CustomTemplateIframeProps.html +2 -2
  79. package/dist/docs/types/DataContextType.html +2 -2
  80. package/dist/docs/types/DataMask.html +1 -0
  81. package/dist/docs/types/DesktopAction.html +2 -2
  82. package/dist/docs/types/DesktopActionFilter.html +2 -2
  83. package/dist/docs/types/DesktopActionMenuItem.html +2 -2
  84. package/dist/docs/types/DesktopActionMenuItemGroup.html +2 -2
  85. package/dist/docs/types/DesktopActionOptions.html +2 -2
  86. package/dist/docs/types/DesktopOpenParams.html +2 -2
  87. package/dist/docs/types/DesktopStylerContext.html +2 -2
  88. package/dist/docs/types/DraftWorkspaceItem.html +2 -2
  89. package/dist/docs/types/DragEndParams.html +2 -2
  90. package/dist/docs/types/DragStartParams.html +2 -2
  91. package/dist/docs/types/DropZoneRequestFn.html +1 -0
  92. package/dist/docs/types/DropZoneRequestResult.html +1 -0
  93. package/dist/docs/types/EConnection.html +2 -2
  94. package/dist/docs/types/EdgeSpec.html +2 -2
  95. package/dist/docs/types/EmitEventTransformDefinition.html +2 -2
  96. package/dist/docs/types/Entity.html +2 -2
  97. package/dist/docs/types/EntityEdge.html +2 -2
  98. package/dist/docs/types/EntityOTM.html +2 -2
  99. package/dist/docs/types/EntityPasteContext.html +2 -2
  100. package/dist/docs/types/EvalContext.html +1 -1
  101. package/dist/docs/types/EventContextType.html +2 -2
  102. package/dist/docs/types/EventEmitterType.html +2 -2
  103. package/dist/docs/types/EventName.html +2 -2
  104. package/dist/docs/types/EventProducer.html +2 -2
  105. package/dist/docs/types/EventPublisher.html +2 -2
  106. package/dist/docs/types/EventSubscriber.html +2 -2
  107. package/dist/docs/types/EventUnsubscriber.html +2 -2
  108. package/dist/docs/types/ExportOptions.html +2 -2
  109. package/dist/docs/types/ExtractEntitiesOptions.html +2 -2
  110. package/dist/docs/types/ExtrasApi.html +1 -0
  111. package/dist/docs/types/FileCode.html +2 -2
  112. package/dist/docs/types/FileTreeOptions.html +2 -2
  113. package/dist/docs/types/Filter.html +1 -0
  114. package/dist/docs/types/FilterDefinition.html +2 -2
  115. package/dist/docs/types/FilterDefinitions.html +2 -2
  116. package/dist/docs/types/FilterName.html +2 -2
  117. package/dist/docs/types/FilterReference.html +2 -2
  118. package/dist/docs/types/FilterState.html +1 -0
  119. package/dist/docs/types/FocusListItem.html +2 -2
  120. package/dist/docs/types/FolderPasteOptions.html +2 -2
  121. package/dist/docs/types/GraphDataSpec.html +1 -1
  122. package/dist/docs/types/GraphSpec.html +2 -2
  123. package/dist/docs/types/HttpTransformDefinition.html +2 -2
  124. package/dist/docs/types/Icon.html +2 -2
  125. package/dist/docs/types/IconProps.html +2 -2
  126. package/dist/docs/types/IframeTransformDefinition.html +2 -2
  127. package/dist/docs/types/ImageInfo.html +2 -2
  128. package/dist/docs/types/ImportZipOptions.html +2 -2
  129. package/dist/docs/types/InlineCode.html +2 -2
  130. package/dist/docs/types/JavascriptFileStylerDefinition.html +2 -2
  131. package/dist/docs/types/JavascriptFileTransformDefinition.html +2 -2
  132. package/dist/docs/types/JavascriptFilterDefinition.html +2 -2
  133. package/dist/docs/types/JavascriptInlineStylerDefinition.html +2 -2
  134. package/dist/docs/types/JavascriptInlineTransformDefinition.html +2 -2
  135. package/dist/docs/types/JavascriptType.html +2 -2
  136. package/dist/docs/types/JobManifest.html +3 -3
  137. package/dist/docs/types/KnownCounts.html +2 -2
  138. package/dist/docs/types/ManifestSecrets.html +1 -0
  139. package/dist/docs/types/ModalTemplateProps.html +2 -2
  140. package/dist/docs/types/NamedEntityGroup.html +2 -2
  141. package/dist/docs/types/NunjucksFileTransformDefinition.html +2 -2
  142. package/dist/docs/types/NunjucksInlineTransformDefinition.html +2 -2
  143. package/dist/docs/types/NunjucksType.html +2 -2
  144. package/dist/docs/types/OS_CONFIRM_MODAL_RESPONSE.html +2 -2
  145. package/dist/docs/types/OntologyTags.html +2 -2
  146. package/dist/docs/types/OsAuditFields.html +2 -2
  147. package/dist/docs/types/OsConfirmProps.html +2 -2
  148. package/dist/docs/types/OsNotification.html +2 -2
  149. package/dist/docs/types/OsProgress.html +2 -2
  150. package/dist/docs/types/OsTag.html +2 -2
  151. package/dist/docs/types/OsWorkspaceEntity.html +2 -2
  152. package/dist/docs/types/OsWorkspacePickerProps.html +2 -2
  153. package/dist/docs/types/PasteContextOptions.html +2 -2
  154. package/dist/docs/types/Permission.html +2 -2
  155. package/dist/docs/types/Point.html +2 -2
  156. package/dist/docs/types/ProvidedFilterDefinition.html +2 -2
  157. package/dist/docs/types/ProvidedTransformDefinition.html +2 -2
  158. package/dist/docs/types/PythonFileStylerDefinition.html +2 -2
  159. package/dist/docs/types/PythonFileTransformDefinition.html +2 -2
  160. package/dist/docs/types/PythonFilterDefinition.html +2 -2
  161. package/dist/docs/types/PythonInlineStylerDefinition.html +2 -2
  162. package/dist/docs/types/PythonInlineTransformDefinition.html +2 -2
  163. package/dist/docs/types/PythonType.html +2 -2
  164. package/dist/docs/types/Query.html +2 -2
  165. package/dist/docs/types/QueryBatchResult.html +2 -2
  166. package/dist/docs/types/QueryErrorResult.html +2 -2
  167. package/dist/docs/types/QueryExecutor.html +2 -2
  168. package/dist/docs/types/QueryObjectFilterClause.html +3 -0
  169. package/dist/docs/types/QueryResponse.html +2 -2
  170. package/dist/docs/types/QueryResult.html +2 -2
  171. package/dist/docs/types/QuerySuccessResult.html +2 -2
  172. package/dist/docs/types/ReactCssProperties.html +2 -2
  173. package/dist/docs/types/ReactNode.html +2 -2
  174. package/dist/docs/types/ReactRef.html +2 -2
  175. package/dist/docs/types/ReasonedBoolean.html +2 -2
  176. package/dist/docs/types/RecordFetchOptions.html +1 -0
  177. package/dist/docs/types/RefCallback.html +2 -2
  178. package/dist/docs/types/RelationshipCountResult.html +2 -2
  179. package/dist/docs/types/RemoteAppApi.html +1 -0
  180. package/dist/docs/types/SaveAsModalProps.html +2 -2
  181. package/dist/docs/types/SaveFileOptions.html +2 -2
  182. package/dist/docs/types/SaveOptions.html +2 -2
  183. package/dist/docs/types/SavedTemplate.html +2 -2
  184. package/dist/docs/types/SearchFilter.html +2 -2
  185. package/dist/docs/types/SemanticBinding.html +2 -2
  186. package/dist/docs/types/SemanticBindingType.html +2 -2
  187. package/dist/docs/types/SemanticBindings.html +2 -2
  188. package/dist/docs/types/SemanticallyBoundApp.html +2 -2
  189. package/dist/docs/types/SemanticallyBoundFilterDefinition.html +2 -2
  190. package/dist/docs/types/SendQueryOptions.html +2 -2
  191. package/dist/docs/types/ServiceDefinition.html +2 -2
  192. package/dist/docs/types/ServiceDefinitions.html +2 -2
  193. package/dist/docs/types/ServiceRole.html +2 -2
  194. package/dist/docs/types/SetTransformResultFn.html +1 -0
  195. package/dist/docs/types/ShowOntology.html +2 -2
  196. package/dist/docs/types/ShowTabProps.html +2 -2
  197. package/dist/docs/types/Styler.html +19 -10
  198. package/dist/docs/types/StylerConfig.html +2 -2
  199. package/dist/docs/types/StylerDefinition.html +2 -2
  200. package/dist/docs/types/StylerDefinitions.html +2 -2
  201. package/dist/docs/types/StylerOption.html +2 -2
  202. package/dist/docs/types/StylerProducer.html +2 -2
  203. package/dist/docs/types/SubscribeDragStartFn.html +1 -0
  204. package/dist/docs/types/SubscribeToContextFn.html +1 -0
  205. package/dist/docs/types/Tag.html +2 -2
  206. package/dist/docs/types/TagInfo.html +2 -2
  207. package/dist/docs/types/TagWithRelationship.html +2 -2
  208. package/dist/docs/types/TaskCleanupReason.html +2 -2
  209. package/dist/docs/types/TemplateMetadata.html +3 -2
  210. package/dist/docs/types/TemplateType.html +2 -2
  211. package/dist/docs/types/TemplateVariant.html +2 -2
  212. package/dist/docs/types/TransformAction.html +2 -2
  213. package/dist/docs/types/TransformActionContext.html +2 -2
  214. package/dist/docs/types/TransformDefinition.html +2 -2
  215. package/dist/docs/types/TransformDefinitions.html +2 -2
  216. package/dist/docs/types/Unsubscribe.html +2 -2
  217. package/dist/docs/types/UnsubscribeFn.html +1 -0
  218. package/dist/docs/types/UnsubscribeFromContextFn.html +1 -0
  219. package/dist/docs/types/UnsubscribeFromDragStartFn.html +1 -0
  220. package/dist/docs/types/UserProfile.html +2 -2
  221. package/dist/docs/types/Watcher.html +2 -2
  222. package/dist/docs/types/Whoami.html +2 -2
  223. package/dist/docs/types/WithProgressBarOptions.html +2 -2
  224. package/dist/docs/types/Workspace.html +2 -2
  225. package/dist/docs/types/WorkspaceFlags.html +2 -2
  226. package/dist/docs/types/WorkspaceIdentifier.html +2 -2
  227. package/dist/docs/types/WorkspaceItem.html +4 -2
  228. package/dist/docs/types/WorkspaceItemBase.html +2 -2
  229. package/dist/docs/types/WorkspaceItemIdentifier.html +2 -2
  230. package/dist/docs/types/WorkspaceItemModel.html +2 -2
  231. package/dist/docs/types/WorkspaceItemTitleProps.html +3 -2
  232. package/dist/docs/types/WorkspaceItems.html +2 -2
  233. package/dist/docs/types/WorkspacePermission.html +2 -2
  234. package/dist/docs/types/WorkspaceRecord.html +2 -2
  235. package/dist/docs/types/WorkspaceRecordInfo.html +2 -2
  236. package/dist/docs/types/WorkspaceRecordWithRelationships.html +2 -2
  237. package/dist/docs/types/WorkspaceRecords.html +2 -2
  238. package/dist/docs/types/WorkspaceRelationship.html +2 -2
  239. package/dist/docs/types/WorkspaceSettings.html +2 -2
  240. package/dist/docs/types/trigger.html +2 -2
  241. package/dist/docs/types/uuid.html +2 -2
  242. package/dist/docs/variables/OS_CONFIRM_MODAL_CANCEL.html +2 -2
  243. package/dist/docs/variables/OS_CONFIRM_MODAL_NO.html +2 -2
  244. package/dist/docs/variables/OS_CONFIRM_MODAL_YES.html +2 -2
  245. package/dist/docs/variables/SAVED_SEARCH_MESSAGE_TYPES.html +1 -0
  246. package/dist/docs/variables/SAVED_SEARCH_PREFIX.html +1 -0
  247. package/dist/platform-types.d.ts +355 -23
  248. package/lib/action.d.ts +2 -1
  249. package/lib/action.d.ts.map +1 -1
  250. package/lib/desktop.d.ts +37 -6
  251. package/lib/desktop.d.ts.map +1 -1
  252. package/lib/extras.d.ts +15 -0
  253. package/lib/extras.d.ts.map +1 -0
  254. package/lib/extras.js +2 -0
  255. package/lib/extras.js.map +1 -0
  256. package/lib/index.d.ts +3 -0
  257. package/lib/index.d.ts.map +1 -1
  258. package/lib/index.js +3 -0
  259. package/lib/index.js.map +1 -1
  260. package/lib/jobManifestTypes.d.ts +8 -0
  261. package/lib/jobManifestTypes.d.ts.map +1 -1
  262. package/lib/model.d.ts +86 -2
  263. package/lib/model.d.ts.map +1 -1
  264. package/lib/model.js +35 -0
  265. package/lib/model.js.map +1 -1
  266. package/lib/remoteApp.d.ts +21 -0
  267. package/lib/remoteApp.d.ts.map +1 -0
  268. package/lib/remoteApp.js +2 -0
  269. package/lib/remoteApp.js.map +1 -0
  270. package/lib/savedSearch.d.ts +128 -0
  271. package/lib/savedSearch.d.ts.map +1 -0
  272. package/lib/savedSearch.js +16 -0
  273. package/lib/savedSearch.js.map +1 -0
  274. package/lib/search.d.ts +5 -1
  275. package/lib/search.d.ts.map +1 -1
  276. package/lib/styling.d.ts +23 -10
  277. package/lib/styling.d.ts.map +1 -1
  278. package/lib/templates.d.ts +2 -0
  279. package/lib/templates.d.ts.map +1 -1
  280. package/package.json +2 -2
@@ -0,0 +1,16 @@
1
+ var GenericDataType;
2
+ (function (GenericDataType) {
3
+ GenericDataType[GenericDataType["NUMERIC"] = 0] = "NUMERIC";
4
+ GenericDataType[GenericDataType["STRING"] = 1] = "STRING";
5
+ GenericDataType[GenericDataType["TEMPORAL"] = 2] = "TEMPORAL";
6
+ GenericDataType[GenericDataType["BOOLEAN"] = 3] = "BOOLEAN";
7
+ })(GenericDataType || (GenericDataType = {}));
8
+ export const SAVED_SEARCH_PREFIX = 'octostar:savedSearch:';
9
+ export const SAVED_SEARCH_MESSAGE_TYPES = Object.freeze({
10
+ getRecordsCount: `${SAVED_SEARCH_PREFIX}getRecordsCount`,
11
+ getRecordsCountQuery: `${SAVED_SEARCH_PREFIX}getRecordsCountQuery`,
12
+ getRecords: `${SAVED_SEARCH_PREFIX}getRecords`,
13
+ getRecordsQuery: `${SAVED_SEARCH_PREFIX}getRecordsQuery`,
14
+ getSavedSearchPasteContext: `${SAVED_SEARCH_PREFIX}getSavedSearchPasteContext`,
15
+ });
16
+ //# sourceMappingURL=savedSearch.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"savedSearch.js","sourceRoot":"","sources":["../src/savedSearch.ts"],"names":[],"mappings":"AAgFA,IAAK,eAKJ;AALD,WAAK,eAAe;IAClB,2DAAW,CAAA;IACX,yDAAU,CAAA;IACV,6DAAY,CAAA;IACZ,2DAAW,CAAA;AACb,CAAC,EALI,eAAe,KAAf,eAAe,QAKnB;AA2CD,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAC3D,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC;IACtD,eAAe,EAAE,GAAG,mBAAmB,iBAAiB;IACxD,oBAAoB,EAAE,GAAG,mBAAmB,sBAAsB;IAClE,UAAU,EAAE,GAAG,mBAAmB,YAAY;IAC9C,eAAe,EAAE,GAAG,mBAAmB,iBAAiB;IACxD,0BAA0B,EAAE,GAAG,mBAAmB,4BAA4B;CAC/E,CAAC,CAAC"}
package/lib/search.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
2
- import { Entity } from './model';
2
+ import { Entity, WorkspaceItem } from './model';
3
3
  /**
4
4
  * @beta
5
5
  * Interface representing the properties for the SearchXperience component.
@@ -60,5 +60,9 @@ export interface SearchProps {
60
60
  * the filters to apply to the search.
61
61
  */
62
62
  filters?: SearchFilter[];
63
+ /**
64
+ * the default image to use for the search.
65
+ */
66
+ image?: WorkspaceItem;
63
67
  }
64
68
  //# sourceMappingURL=search.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB"}
package/lib/styling.d.ts CHANGED
@@ -7,22 +7,35 @@ type TODO = any;
7
7
  /**
8
8
  * @beta
9
9
  * Type representing a styler with methods for getting G6 node and edge styles.
10
+ * See ColorByType.ts for an example
10
11
  */
11
12
  export type Styler = {
12
13
  /**
13
- * Gets the style for a G6 node.
14
- * @param e - The entity for which to get the node style.
15
- * @param curr - The current style.
16
- * @returns A promise that resolves to the new style.
14
+ * Use this function to modify style of a node from outside the graph.
15
+ * You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
16
+ * This can lead do recursive clone error later on.
17
+ * Merging with actual style will be handled automatically!
18
+ * Use them just as a reference:
19
+ * - @param originStyle for eg original node radius (if its a circural node), so you want to eg multiply it by amount of connections.
20
+ * - @param currentStyle for eg current node radius (if its a circural node), so you want to eg apply a holor like a heatmap by amount of connections.
21
+ * @param entity - The entity for which to get the node style.
22
+ * @param originStyle - The original style (the one passed to node during it's initialization). See '@antv/graphin' -> NodeStyle
23
+ * @param currentStyle - The current style. See '@antv/graphin' -> NodeStyle
24
+ * @returns A promise that resolves to the style patch. See '@antv/graphin' -> NodeStyle
17
25
  */
18
- getG6NodeStyle?: (e: Entity, curr: TODO) => Promise<TODO>;
26
+ getG6NodeStyle?: (entity: Entity, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
19
27
  /**
20
- * Gets the style for a G6 edge.
21
- * @param e - The edge specification for which to get the edge style.
22
- * @param curr - The current style.
23
- * @returns A promise that resolves to the new style.
28
+ * Use this function to modify style of a edge from outside the graph.
29
+ * You can overwrite the style, but DO NOT merge currentStyle or originStyle when returning new styling (or rather styling patch).
30
+ * This can lead do recursive clone error later on.
31
+ * Merging with actual style will be handled automatically!
32
+ * Use them just as a reference, eg edge width to multiply.
33
+ * @param edge - The edge specification for which to get the edge style.
34
+ * @param originStyle - The original style (the one passed to edge during it's initialization). See '@antv/graphin' -> EdgeStyle
35
+ * @param currentStyle - The current style. See '@antv/graphin' -> EdgeStyle
36
+ * @returns A promise that resolves to the style patch. See '@antv/graphin' -> EdgeStyle
24
37
  */
25
- getG6EdgeStyle?: (e: EdgeSpec, curr: TODO) => Promise<TODO>;
38
+ getG6EdgeStyle?: (edge: EdgeSpec, originStyle: TODO, currentStyle: TODO) => Promise<TODO>;
26
39
  };
27
40
  /**
28
41
  * @beta
@@ -1 +1 @@
1
- {"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../src/styling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,KAAK,IAAI,GAAG,GAAG,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,iCAAiC;IACjC,WAAW,EAAE,QAAQ,CAAC;IACtB,gCAAgC;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,kCAAkC;IAClC,EAAE,EAAE,gBAAgB,CAAC;IACrB,8BAA8B;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,gEAAgE;IAChE,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IACxC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B,CAAC"}
1
+ {"version":3,"file":"styling.d.ts","sourceRoot":"","sources":["../src/styling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,KAAK,IAAI,GAAG,GAAG,CAAC;AAEhB;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CACf,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,IAAI,EACjB,YAAY,EAAE,IAAI,KACf,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CACf,IAAI,EAAE,QAAQ,EACd,WAAW,EAAE,IAAI,EACjB,YAAY,EAAE,IAAI,KACf,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,iCAAiC;IACjC,WAAW,EAAE,QAAQ,CAAC;IACtB,gCAAgC;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,kCAAkC;IAClC,EAAE,EAAE,gBAAgB,CAAC;IACrB,8BAA8B;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,gEAAgE;IAChE,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IACxC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B,CAAC"}
@@ -22,6 +22,8 @@ export type TemplateMetadata = {
22
22
  description: string;
23
23
  /** The concepts associated with the template. */
24
24
  concepts: string[];
25
+ /** The priority of the template. Default is 100, lower is higher priority. */
26
+ priority?: number;
25
27
  /** The type of the template. */
26
28
  type: TemplateType;
27
29
  /** The layout of the template. */
@@ -1 +1 @@
1
- {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gCAAgC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,4CAA4C;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,IAAI,EAAE,YAAY,CAAC;IACnB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC3C,4CAA4C;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,qDAAqD;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@octostar/platform-types",
3
- "version": "0.3.0",
3
+ "version": "0.5.0",
4
4
  "description": "Types for the API exposed by Octostar platform to third parties",
5
5
  "keywords": [
6
6
  "octostar",
@@ -54,5 +54,5 @@
54
54
  "publishConfig": {
55
55
  "access": "public"
56
56
  },
57
- "gitHead": "3b451839beefea65b510c53d88186bf25145cab7"
57
+ "gitHead": "63aeec6895a1470e0066fa0266a3ca76f060fb5c"
58
58
  }