@esri/hub-common 19.1.0 → 19.1.2

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 (185) hide show
  1. package/dist/esm/core/_internal/getEditorSlug.js +3 -2
  2. package/dist/esm/core/_internal/getEditorSlug.js.map +1 -1
  3. package/dist/esm/core/_internal/hubItemEntityFromEditor.js +2 -1
  4. package/dist/esm/core/_internal/hubItemEntityFromEditor.js.map +1 -1
  5. package/dist/esm/core/_internal/sharedMigrations.js +39 -0
  6. package/dist/esm/core/_internal/sharedMigrations.js.map +1 -0
  7. package/dist/esm/core/schemas/internal/addDynamicSlugValidation.js +2 -0
  8. package/dist/esm/core/schemas/internal/addDynamicSlugValidation.js.map +1 -1
  9. package/dist/esm/core/schemas/shared/subschemas.js +2 -1
  10. package/dist/esm/core/schemas/shared/subschemas.js.map +1 -1
  11. package/dist/esm/discussions/HubDiscussion.js +4 -0
  12. package/dist/esm/discussions/HubDiscussion.js.map +1 -1
  13. package/dist/esm/discussions/_internal/applyDiscussionMigrations.js +20 -0
  14. package/dist/esm/discussions/_internal/applyDiscussionMigrations.js.map +1 -0
  15. package/dist/esm/discussions/_internal/computeProps.js +3 -0
  16. package/dist/esm/discussions/_internal/computeProps.js.map +1 -1
  17. package/dist/esm/discussions/_internal/migrateDiscussionSlugAndOrgUrlKey.js +21 -0
  18. package/dist/esm/discussions/_internal/migrateDiscussionSlugAndOrgUrlKey.js.map +1 -0
  19. package/dist/esm/discussions/defaults.js +3 -2
  20. package/dist/esm/discussions/defaults.js.map +1 -1
  21. package/dist/esm/discussions/edit.js +2 -0
  22. package/dist/esm/discussions/edit.js.map +1 -1
  23. package/dist/esm/events/HubEvent.js +4 -0
  24. package/dist/esm/events/HubEvent.js.map +1 -1
  25. package/dist/esm/initiative-templates/HubInitiativeTemplate.js +3 -0
  26. package/dist/esm/initiative-templates/HubInitiativeTemplate.js.map +1 -1
  27. package/dist/esm/initiative-templates/edit.js +1 -0
  28. package/dist/esm/initiative-templates/edit.js.map +1 -1
  29. package/dist/esm/initiatives/HubInitiatives.js +3 -4
  30. package/dist/esm/initiatives/HubInitiatives.js.map +1 -1
  31. package/dist/esm/initiatives/_internal/applyInitiativeMigrations.js +17 -57
  32. package/dist/esm/initiatives/_internal/applyInitiativeMigrations.js.map +1 -1
  33. package/dist/esm/initiatives/_internal/migrateInitiativeAddDefaultCatalog.js +43 -0
  34. package/dist/esm/initiatives/_internal/migrateInitiativeAddDefaultCatalog.js.map +1 -0
  35. package/dist/esm/initiatives/_internal/migrateInitiativeSlugAndOrgUrlKey.js +21 -0
  36. package/dist/esm/initiatives/_internal/migrateInitiativeSlugAndOrgUrlKey.js.map +1 -0
  37. package/dist/esm/initiatives/_internal/migrateInvalidTimelineStages.js +16 -0
  38. package/dist/esm/initiatives/_internal/migrateInvalidTimelineStages.js.map +1 -0
  39. package/dist/esm/initiatives/defaults.js +3 -2
  40. package/dist/esm/initiatives/defaults.js.map +1 -1
  41. package/dist/esm/items/_internal/ensureUniqueEntitySlug.js +8 -4
  42. package/dist/esm/items/_internal/ensureUniqueEntitySlug.js.map +1 -1
  43. package/dist/esm/items/slugs.js +2 -2
  44. package/dist/esm/items/slugs.js.map +1 -1
  45. package/dist/esm/pages/HubPage.js +2 -0
  46. package/dist/esm/pages/HubPage.js.map +1 -1
  47. package/dist/esm/pages/HubPages.js +2 -0
  48. package/dist/esm/pages/HubPages.js.map +1 -1
  49. package/dist/esm/pages/_internal/applyPageMigrations.js +20 -0
  50. package/dist/esm/pages/_internal/applyPageMigrations.js.map +1 -0
  51. package/dist/esm/pages/_internal/computeProps.js +3 -0
  52. package/dist/esm/pages/_internal/computeProps.js.map +1 -1
  53. package/dist/esm/pages/_internal/migratePageSlugAndOrgUrlKey.js +21 -0
  54. package/dist/esm/pages/_internal/migratePageSlugAndOrgUrlKey.js.map +1 -0
  55. package/dist/esm/pages/defaults.js +3 -2
  56. package/dist/esm/pages/defaults.js.map +1 -1
  57. package/dist/esm/projects/HubProject.js +2 -0
  58. package/dist/esm/projects/HubProject.js.map +1 -1
  59. package/dist/esm/projects/_internal/applyProjectMigrations.js +22 -0
  60. package/dist/esm/projects/_internal/applyProjectMigrations.js.map +1 -0
  61. package/dist/esm/projects/_internal/computeProps.js +3 -0
  62. package/dist/esm/projects/_internal/computeProps.js.map +1 -1
  63. package/dist/esm/projects/_internal/migrateInvalidTimelineStages.js +16 -0
  64. package/dist/esm/projects/_internal/migrateInvalidTimelineStages.js.map +1 -0
  65. package/dist/esm/projects/_internal/migrateProjectSlugAndOrgUrlKey.js +21 -0
  66. package/dist/esm/projects/_internal/migrateProjectSlugAndOrgUrlKey.js.map +1 -0
  67. package/dist/esm/projects/defaults.js +3 -2
  68. package/dist/esm/projects/defaults.js.map +1 -1
  69. package/dist/esm/projects/edit.js +2 -0
  70. package/dist/esm/projects/edit.js.map +1 -1
  71. package/dist/esm/sites/HubSite.js +10 -2
  72. package/dist/esm/sites/HubSite.js.map +1 -1
  73. package/dist/esm/sites/HubSites.js +7 -7
  74. package/dist/esm/sites/HubSites.js.map +1 -1
  75. package/dist/esm/sites/_internal/ensureLowercaseOrgUrlKeySlugAndKeyword.js +29 -0
  76. package/dist/esm/sites/_internal/ensureLowercaseOrgUrlKeySlugAndKeyword.js.map +1 -0
  77. package/dist/esm/sites/upgrade-site-schema.js +2 -0
  78. package/dist/esm/sites/upgrade-site-schema.js.map +1 -1
  79. package/dist/esm/templates/HubTemplate.js +2 -0
  80. package/dist/esm/templates/HubTemplate.js.map +1 -1
  81. package/dist/esm/templates/edit.js +2 -0
  82. package/dist/esm/templates/edit.js.map +1 -1
  83. package/dist/node/core/_internal/getEditorSlug.js +3 -2
  84. package/dist/node/core/_internal/getEditorSlug.js.map +1 -1
  85. package/dist/node/core/_internal/hubItemEntityFromEditor.js +2 -1
  86. package/dist/node/core/_internal/hubItemEntityFromEditor.js.map +1 -1
  87. package/dist/node/core/_internal/sharedMigrations.js +43 -0
  88. package/dist/node/core/_internal/sharedMigrations.js.map +1 -0
  89. package/dist/node/core/schemas/internal/addDynamicSlugValidation.js +2 -0
  90. package/dist/node/core/schemas/internal/addDynamicSlugValidation.js.map +1 -1
  91. package/dist/node/core/schemas/shared/subschemas.js +2 -1
  92. package/dist/node/core/schemas/shared/subschemas.js.map +1 -1
  93. package/dist/node/discussions/HubDiscussion.js +4 -0
  94. package/dist/node/discussions/HubDiscussion.js.map +1 -1
  95. package/dist/node/discussions/_internal/applyDiscussionMigrations.js +24 -0
  96. package/dist/node/discussions/_internal/applyDiscussionMigrations.js.map +1 -0
  97. package/dist/node/discussions/_internal/computeProps.js +3 -0
  98. package/dist/node/discussions/_internal/computeProps.js.map +1 -1
  99. package/dist/node/discussions/_internal/migrateDiscussionSlugAndOrgUrlKey.js +25 -0
  100. package/dist/node/discussions/_internal/migrateDiscussionSlugAndOrgUrlKey.js.map +1 -0
  101. package/dist/node/discussions/defaults.js +4 -3
  102. package/dist/node/discussions/defaults.js.map +1 -1
  103. package/dist/node/discussions/edit.js +2 -0
  104. package/dist/node/discussions/edit.js.map +1 -1
  105. package/dist/node/events/HubEvent.js +4 -0
  106. package/dist/node/events/HubEvent.js.map +1 -1
  107. package/dist/node/initiative-templates/HubInitiativeTemplate.js +3 -0
  108. package/dist/node/initiative-templates/HubInitiativeTemplate.js.map +1 -1
  109. package/dist/node/initiative-templates/edit.js +1 -0
  110. package/dist/node/initiative-templates/edit.js.map +1 -1
  111. package/dist/node/initiatives/HubInitiatives.js +3 -4
  112. package/dist/node/initiatives/HubInitiatives.js.map +1 -1
  113. package/dist/node/initiatives/_internal/applyInitiativeMigrations.js +18 -58
  114. package/dist/node/initiatives/_internal/applyInitiativeMigrations.js.map +1 -1
  115. package/dist/node/initiatives/_internal/migrateInitiativeAddDefaultCatalog.js +47 -0
  116. package/dist/node/initiatives/_internal/migrateInitiativeAddDefaultCatalog.js.map +1 -0
  117. package/dist/node/initiatives/_internal/migrateInitiativeSlugAndOrgUrlKey.js +25 -0
  118. package/dist/node/initiatives/_internal/migrateInitiativeSlugAndOrgUrlKey.js.map +1 -0
  119. package/dist/node/initiatives/_internal/migrateInvalidTimelineStages.js +20 -0
  120. package/dist/node/initiatives/_internal/migrateInvalidTimelineStages.js.map +1 -0
  121. package/dist/node/initiatives/defaults.js +4 -3
  122. package/dist/node/initiatives/defaults.js.map +1 -1
  123. package/dist/node/items/_internal/ensureUniqueEntitySlug.js +8 -4
  124. package/dist/node/items/_internal/ensureUniqueEntitySlug.js.map +1 -1
  125. package/dist/node/items/slugs.js +2 -2
  126. package/dist/node/items/slugs.js.map +1 -1
  127. package/dist/node/pages/HubPage.js +2 -0
  128. package/dist/node/pages/HubPage.js.map +1 -1
  129. package/dist/node/pages/HubPages.js +2 -0
  130. package/dist/node/pages/HubPages.js.map +1 -1
  131. package/dist/node/pages/_internal/applyPageMigrations.js +24 -0
  132. package/dist/node/pages/_internal/applyPageMigrations.js.map +1 -0
  133. package/dist/node/pages/_internal/computeProps.js +3 -0
  134. package/dist/node/pages/_internal/computeProps.js.map +1 -1
  135. package/dist/node/pages/_internal/migratePageSlugAndOrgUrlKey.js +25 -0
  136. package/dist/node/pages/_internal/migratePageSlugAndOrgUrlKey.js.map +1 -0
  137. package/dist/node/pages/defaults.js +4 -3
  138. package/dist/node/pages/defaults.js.map +1 -1
  139. package/dist/node/projects/HubProject.js +2 -0
  140. package/dist/node/projects/HubProject.js.map +1 -1
  141. package/dist/node/projects/_internal/applyProjectMigrations.js +26 -0
  142. package/dist/node/projects/_internal/applyProjectMigrations.js.map +1 -0
  143. package/dist/node/projects/_internal/computeProps.js +3 -0
  144. package/dist/node/projects/_internal/computeProps.js.map +1 -1
  145. package/dist/node/projects/_internal/migrateInvalidTimelineStages.js +20 -0
  146. package/dist/node/projects/_internal/migrateInvalidTimelineStages.js.map +1 -0
  147. package/dist/node/projects/_internal/migrateProjectSlugAndOrgUrlKey.js +25 -0
  148. package/dist/node/projects/_internal/migrateProjectSlugAndOrgUrlKey.js.map +1 -0
  149. package/dist/node/projects/defaults.js +4 -3
  150. package/dist/node/projects/defaults.js.map +1 -1
  151. package/dist/node/projects/edit.js +2 -0
  152. package/dist/node/projects/edit.js.map +1 -1
  153. package/dist/node/sites/HubSite.js +10 -2
  154. package/dist/node/sites/HubSite.js.map +1 -1
  155. package/dist/node/sites/HubSites.js +7 -7
  156. package/dist/node/sites/HubSites.js.map +1 -1
  157. package/dist/node/sites/_internal/ensureLowercaseOrgUrlKeySlugAndKeyword.js +33 -0
  158. package/dist/node/sites/_internal/ensureLowercaseOrgUrlKeySlugAndKeyword.js.map +1 -0
  159. package/dist/node/sites/upgrade-site-schema.js +2 -0
  160. package/dist/node/sites/upgrade-site-schema.js.map +1 -1
  161. package/dist/node/templates/HubTemplate.js +2 -0
  162. package/dist/node/templates/HubTemplate.js.map +1 -1
  163. package/dist/node/templates/edit.js +2 -0
  164. package/dist/node/templates/edit.js.map +1 -1
  165. package/dist/types/core/_internal/sharedMigrations.d.ts +11 -0
  166. package/dist/types/core/schemas/shared/subschemas.d.ts +2 -0
  167. package/dist/types/core/traits/IWithSlug.d.ts +1 -1
  168. package/dist/types/discussions/_internal/applyDiscussionMigrations.d.ts +8 -0
  169. package/dist/types/discussions/_internal/migrateDiscussionSlugAndOrgUrlKey.d.ts +8 -0
  170. package/dist/types/discussions/defaults.d.ts +1 -0
  171. package/dist/types/initiatives/_internal/applyInitiativeMigrations.d.ts +4 -6
  172. package/dist/types/initiatives/_internal/migrateInitiativeAddDefaultCatalog.d.ts +7 -0
  173. package/dist/types/initiatives/_internal/migrateInitiativeSlugAndOrgUrlKey.d.ts +8 -0
  174. package/dist/types/initiatives/_internal/migrateInvalidTimelineStages.d.ts +2 -0
  175. package/dist/types/initiatives/defaults.d.ts +1 -0
  176. package/dist/types/pages/_internal/applyPageMigrations.d.ts +8 -0
  177. package/dist/types/pages/_internal/migratePageSlugAndOrgUrlKey.d.ts +8 -0
  178. package/dist/types/pages/defaults.d.ts +1 -0
  179. package/dist/types/projects/_internal/applyProjectMigrations.d.ts +8 -0
  180. package/dist/types/projects/_internal/migrateInvalidTimelineStages.d.ts +2 -0
  181. package/dist/types/projects/_internal/migrateProjectSlugAndOrgUrlKey.d.ts +8 -0
  182. package/dist/types/projects/defaults.d.ts +1 -0
  183. package/dist/types/sites/HubSite.d.ts +7 -0
  184. package/dist/types/sites/_internal/ensureLowercaseOrgUrlKeySlugAndKeyword.d.ts +11 -0
  185. package/package.json +1 -1
@@ -0,0 +1,7 @@
1
+ import { IHubInitiative } from "../../core/types/IHubInitiative";
2
+ /**
3
+ * Apply the default catalog to the initiative model
4
+ * @param model
5
+ * @returns
6
+ */
7
+ export declare function migrateInitiativeAddDefaultCatalog(initiative: IHubInitiative): IHubInitiative;
@@ -0,0 +1,8 @@
1
+ import { IHubInitiative } from "../../core/types/IHubInitiative";
2
+ /**
3
+ * Ensures the orgUrlKey is lowercase and the slug is updated accordingly.
4
+ * Exported just for testing purposes. This is not exported from the main module.
5
+ * @param project
6
+ * @returns
7
+ */
8
+ export declare function migrateInitiativeSlugAndOrgUrlKey(initiative: IHubInitiative): IHubInitiative;
@@ -0,0 +1,2 @@
1
+ import { IHubInitiative } from "../../core/types/IHubInitiative";
2
+ export declare function migrateInvalidTimelineStages(initiative: IHubInitiative): IHubInitiative;
@@ -1,6 +1,7 @@
1
1
  import { IHubInitiative } from "../core/types";
2
2
  import { IModel } from "../hub-types";
3
3
  export declare const HUB_INITIATIVE_ITEM_TYPE = "Hub Initiative";
4
+ export declare const HUB_INITIATIVE_CURRENT_SCHEMA_VERSION = 2.2;
4
5
  /**
5
6
  * Default values of a IHubInitiative
6
7
  */
@@ -0,0 +1,8 @@
1
+ import { IHubPage } from "../../core/types/IHubPage";
2
+ /**
3
+ * Apply project migrations.
4
+ * Exported for testing purposes. This is not exported from the main module.
5
+ * @param page
6
+ * @returns
7
+ */
8
+ export declare function applyPageMigrations(page: IHubPage): IHubPage;
@@ -0,0 +1,8 @@
1
+ import { IHubPage } from "../../core/types/IHubPage";
2
+ /**
3
+ * Ensures the orgUrlKey is lowercase and the slug is updated accordingly.
4
+ * Exported just for testing purposes. This is not exported from the main module.
5
+ * @param project
6
+ * @returns
7
+ */
8
+ export declare function migratePageSlugAndOrgUrlKey(page: IHubPage): IHubPage;
@@ -3,6 +3,7 @@ import { IModel } from "../hub-types";
3
3
  export declare const HUB_PAGE_ITEM_TYPE = "Hub Page";
4
4
  export declare const ENTERPRISE_PAGE_ITEM_TYPE = "Site Page";
5
5
  export declare const PAGE_TYPE_KEYWORD = "hubPage";
6
+ export declare const HUB_PAGE_CURRENT_SCHEMA_VERSION = 1.1;
6
7
  /**
7
8
  * Default values of a IHubPage
8
9
  */
@@ -0,0 +1,8 @@
1
+ import { IHubProject } from "../../core/types/IHubProject";
2
+ /**
3
+ * Apply project migrations.
4
+ * Exported for testing purposes. This is not exported from the main module.
5
+ * @param project
6
+ * @returns
7
+ */
8
+ export declare function applyProjectMigrations(project: IHubProject): IHubProject;
@@ -0,0 +1,2 @@
1
+ import { IHubProject } from "../../core/types/IHubProject";
2
+ export declare function migrateInvalidTimelineStages(project: IHubProject): IHubProject;
@@ -0,0 +1,8 @@
1
+ import { IHubProject } from "../../core";
2
+ /**
3
+ * Ensures the orgUrlKey is lowercase and the slug is updated accordingly.
4
+ * Exported just for testing purposes. This is not exported from the main module.
5
+ * @param project
6
+ * @returns
7
+ */
8
+ export declare function migrateProjectSlugAndOrgUrlKey(project: IHubProject): IHubProject;
@@ -1,6 +1,7 @@
1
1
  import { IHubProject } from "../core";
2
2
  import { IModel } from "../hub-types";
3
3
  export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
4
+ export declare const HUB_PROJECT_CURRENT_SCHEMA_VERSION = 1.2;
4
5
  /**
5
6
  * Default values of a IHubProject
6
7
  */
@@ -50,6 +50,13 @@ export declare class HubSite extends HubItemEntity<IHubSite> implements IWithSto
50
50
  * @returns
51
51
  */
52
52
  static fetch(identifier: string, context: IArcGISContext): Promise<HubSite>;
53
+ /**
54
+ * Ensure the Site has the baseline set of properties
55
+ * that are required for a HubSite.
56
+ * @param partialSite
57
+ * @param context
58
+ * @returns
59
+ */
53
60
  private static applyDefaults;
54
61
  /**
55
62
  * Apply a new state to the instance
@@ -0,0 +1,11 @@
1
+ import { IModel } from "../../hub-types";
2
+ /**
3
+ * Fix issues caused by mixed case orgUrlKeys in the past.
4
+ * Problems include:
5
+ * - orgUrlKey not being lowercase
6
+ * - slug getting the downcased orgUrlKey prepended to it multiple times
7
+ * - slug typekeyword having an entry with the orgUrlKey prepended to it multiple times
8
+ * @param model
9
+ * @returns
10
+ */
11
+ export declare function ensureLowercaseOrgUrlKeySlugAndKeyword(model: IModel): IModel;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esri/hub-common",
3
- "version": "19.1.0",
3
+ "version": "19.1.2",
4
4
  "description": "Common TypeScript types and utility functions for @esri/hub.js.",
5
5
  "main": "dist/node/index.js",
6
6
  "module": "dist/esm/index.js",