@esri/hub-common 10.1.0 → 11.0.0-beta.3

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 (161) hide show
  1. package/dist/esm/Hub.js +0 -26
  2. package/dist/esm/Hub.js.map +1 -1
  3. package/dist/esm/core/PermissionManager.js +60 -0
  4. package/dist/esm/core/PermissionManager.js.map +1 -0
  5. package/dist/esm/core/_internal/PropertyMapper.js +1 -0
  6. package/dist/esm/core/_internal/PropertyMapper.js.map +1 -1
  7. package/dist/esm/core/_internal/sharedWith.js +14 -0
  8. package/dist/esm/core/_internal/sharedWith.js.map +1 -0
  9. package/dist/esm/core/behaviors/IWithCatalogBehavior.js +1 -0
  10. package/dist/esm/core/behaviors/IWithCatalogBehavior.js.map +1 -0
  11. package/dist/esm/core/behaviors/IWithPermissionBehavior.js +69 -0
  12. package/dist/esm/core/behaviors/IWithPermissionBehavior.js.map +1 -0
  13. package/dist/esm/core/behaviors/IWithSharingBehavior.js +1 -0
  14. package/dist/esm/core/behaviors/IWithSharingBehavior.js.map +1 -0
  15. package/dist/esm/core/behaviors/IWithStoreBehavior.js +1 -0
  16. package/dist/esm/core/behaviors/IWithStoreBehavior.js.map +1 -0
  17. package/dist/esm/core/behaviors/index.js +5 -0
  18. package/dist/esm/core/behaviors/index.js.map +1 -0
  19. package/dist/esm/core/index.js +2 -0
  20. package/dist/esm/core/index.js.map +1 -1
  21. package/dist/esm/core/traits/IWithBannerImage.js +1 -0
  22. package/dist/esm/core/traits/IWithBannerImage.js.map +1 -0
  23. package/dist/esm/core/traits/IWithCatalogDefinition.js +1 -0
  24. package/dist/esm/core/traits/IWithCatalogDefinition.js.map +1 -0
  25. package/dist/esm/core/traits/IWithLayout.js +1 -0
  26. package/dist/esm/core/traits/IWithLayout.js.map +1 -0
  27. package/dist/esm/core/traits/IWithPermissions.js +1 -0
  28. package/dist/esm/core/traits/IWithPermissions.js.map +1 -0
  29. package/dist/esm/core/traits/IWithSlug.js +1 -0
  30. package/dist/esm/core/traits/IWithSlug.js.map +1 -0
  31. package/dist/esm/core/traits/index.js +4 -3
  32. package/dist/esm/core/traits/index.js.map +1 -1
  33. package/dist/esm/core/types/IHubPermission.js +1 -0
  34. package/dist/esm/core/types/IHubPermission.js.map +1 -0
  35. package/dist/esm/core/types/index.js +1 -0
  36. package/dist/esm/core/types/index.js.map +1 -1
  37. package/dist/esm/index.js +2 -1
  38. package/dist/esm/index.js.map +1 -1
  39. package/dist/esm/items/slugs.js +1 -1
  40. package/dist/esm/models/index.js +15 -10
  41. package/dist/esm/models/index.js.map +1 -1
  42. package/dist/esm/projects/HubProject.js +369 -0
  43. package/dist/esm/projects/HubProject.js.map +1 -0
  44. package/dist/esm/projects/HubProjectManager.js +4 -4
  45. package/dist/esm/projects/HubProjectManager.js.map +1 -1
  46. package/dist/esm/projects/HubProjects.js +37 -39
  47. package/dist/esm/projects/HubProjects.js.map +1 -1
  48. package/dist/esm/projects/defaults.js +36 -0
  49. package/dist/esm/projects/defaults.js.map +1 -0
  50. package/dist/esm/projects/index.js +1 -1
  51. package/dist/esm/projects/index.js.map +1 -1
  52. package/dist/esm/search/Catalog.js +22 -5
  53. package/dist/esm/search/Catalog.js.map +1 -1
  54. package/dist/esm/sites/HubSiteManager.js +1 -1
  55. package/dist/esm/sites/HubSiteManager.js.map +1 -1
  56. package/dist/esm/sites/index.js +0 -1
  57. package/dist/esm/sites/index.js.map +1 -1
  58. package/dist/node/Hub.js +0 -26
  59. package/dist/node/Hub.js.map +1 -1
  60. package/dist/node/core/PermissionManager.js +64 -0
  61. package/dist/node/core/PermissionManager.js.map +1 -0
  62. package/dist/node/core/_internal/PropertyMapper.js +1 -0
  63. package/dist/node/core/_internal/PropertyMapper.js.map +1 -1
  64. package/dist/node/core/_internal/sharedWith.js +18 -0
  65. package/dist/node/core/_internal/sharedWith.js.map +1 -0
  66. package/dist/node/core/behaviors/IWithCatalogBehavior.js +3 -0
  67. package/dist/node/core/behaviors/IWithCatalogBehavior.js.map +1 -0
  68. package/dist/node/core/behaviors/IWithPermissionBehavior.js +76 -0
  69. package/dist/node/core/behaviors/IWithPermissionBehavior.js.map +1 -0
  70. package/dist/node/core/behaviors/IWithSharingBehavior.js +3 -0
  71. package/dist/node/core/behaviors/IWithSharingBehavior.js.map +1 -0
  72. package/dist/node/core/behaviors/IWithStoreBehavior.js +3 -0
  73. package/dist/node/core/behaviors/IWithStoreBehavior.js.map +1 -0
  74. package/dist/node/core/behaviors/index.js +8 -0
  75. package/dist/node/core/behaviors/index.js.map +1 -0
  76. package/dist/node/core/index.js +2 -0
  77. package/dist/node/core/index.js.map +1 -1
  78. package/dist/node/core/traits/{WithBannerImage.js → IWithBannerImage.js} +1 -1
  79. package/dist/node/core/traits/IWithBannerImage.js.map +1 -0
  80. package/dist/node/core/traits/IWithCatalogDefinition.js +3 -0
  81. package/dist/node/core/traits/IWithCatalogDefinition.js.map +1 -0
  82. package/dist/node/core/traits/{WithCatalog.js → IWithLayout.js} +1 -1
  83. package/dist/node/core/traits/IWithLayout.js.map +1 -0
  84. package/dist/node/core/traits/IWithPermissions.js +3 -0
  85. package/dist/node/core/traits/IWithPermissions.js.map +1 -0
  86. package/dist/node/core/traits/{WithSlug.js → IWithSlug.js} +1 -1
  87. package/dist/node/core/traits/IWithSlug.js.map +1 -0
  88. package/dist/node/core/traits/index.js +4 -3
  89. package/dist/node/core/traits/index.js.map +1 -1
  90. package/dist/node/core/{traits/WithLayout.js → types/IHubPermission.js} +1 -1
  91. package/dist/node/core/types/IHubPermission.js.map +1 -0
  92. package/dist/node/core/types/index.js +1 -0
  93. package/dist/node/core/types/index.js.map +1 -1
  94. package/dist/node/index.js +2 -1
  95. package/dist/node/index.js.map +1 -1
  96. package/dist/node/items/slugs.js +1 -1
  97. package/dist/node/models/index.js +15 -10
  98. package/dist/node/models/index.js.map +1 -1
  99. package/dist/node/projects/HubProject.js +373 -0
  100. package/dist/node/projects/HubProject.js.map +1 -0
  101. package/dist/node/projects/HubProjectManager.js +3 -3
  102. package/dist/node/projects/HubProjectManager.js.map +1 -1
  103. package/dist/node/projects/HubProjects.js +42 -44
  104. package/dist/node/projects/HubProjects.js.map +1 -1
  105. package/dist/node/projects/defaults.js +39 -0
  106. package/dist/node/projects/defaults.js.map +1 -0
  107. package/dist/node/projects/index.js +1 -1
  108. package/dist/node/projects/index.js.map +1 -1
  109. package/dist/node/search/Catalog.js +22 -5
  110. package/dist/node/search/Catalog.js.map +1 -1
  111. package/dist/node/sites/HubSiteManager.js +1 -1
  112. package/dist/node/sites/HubSiteManager.js.map +1 -1
  113. package/dist/node/sites/index.js +0 -1
  114. package/dist/node/sites/index.js.map +1 -1
  115. package/dist/types/Hub.d.ts +0 -18
  116. package/dist/types/core/PermissionManager.d.ts +43 -0
  117. package/dist/types/core/_internal/PropertyMapper.d.ts +1 -0
  118. package/dist/types/core/_internal/sharedWith.d.ts +10 -0
  119. package/dist/types/core/behaviors/IWithCatalogBehavior.d.ts +4 -0
  120. package/dist/types/core/behaviors/IWithPermissionBehavior.d.ts +40 -0
  121. package/dist/types/core/behaviors/IWithSharingBehavior.d.ts +27 -0
  122. package/dist/types/core/behaviors/IWithStoreBehavior.d.ts +22 -0
  123. package/dist/types/core/behaviors/index.d.ts +4 -0
  124. package/dist/types/core/index.d.ts +2 -0
  125. package/dist/types/core/traits/{WithBannerImage.d.ts → IWithBannerImage.d.ts} +0 -0
  126. package/dist/types/core/traits/IWithCatalogDefinition.d.ts +7 -0
  127. package/dist/types/core/traits/{WithLayout.d.ts → IWithLayout.d.ts} +0 -0
  128. package/dist/types/core/traits/IWithPermissions.d.ts +10 -0
  129. package/dist/types/core/traits/{WithSlug.d.ts → IWithSlug.d.ts} +0 -0
  130. package/dist/types/core/traits/index.d.ts +4 -3
  131. package/dist/types/core/types/IHubEntityManager.d.ts +1 -1
  132. package/dist/types/core/types/IHubInitiative.d.ts +1 -1
  133. package/dist/types/core/types/IHubPage.d.ts +1 -1
  134. package/dist/types/core/types/IHubPermission.d.ts +23 -0
  135. package/dist/types/core/types/IHubProject.d.ts +4 -3
  136. package/dist/types/core/types/IHubSite.d.ts +2 -2
  137. package/dist/types/core/types/index.d.ts +1 -0
  138. package/dist/types/core/types/types.d.ts +5 -1
  139. package/dist/types/index.d.ts +0 -1
  140. package/dist/types/projects/HubProject.d.ts +92 -0
  141. package/dist/types/projects/HubProjectManager.d.ts +1 -1
  142. package/dist/types/projects/HubProjects.d.ts +7 -2
  143. package/dist/types/projects/defaults.d.ts +11 -0
  144. package/dist/types/projects/index.d.ts +1 -1
  145. package/dist/types/search/Catalog.d.ts +4 -3
  146. package/dist/types/sites/HubSiteManager.d.ts +1 -1
  147. package/dist/types/sites/index.d.ts +0 -1
  148. package/package.json +1 -1
  149. package/dist/esm/core/traits/WithBannerImage.js +0 -1
  150. package/dist/esm/core/traits/WithBannerImage.js.map +0 -1
  151. package/dist/esm/core/traits/WithCatalog.js +0 -1
  152. package/dist/esm/core/traits/WithCatalog.js.map +0 -1
  153. package/dist/esm/core/traits/WithLayout.js +0 -1
  154. package/dist/esm/core/traits/WithLayout.js.map +0 -1
  155. package/dist/esm/core/traits/WithSlug.js +0 -1
  156. package/dist/esm/core/traits/WithSlug.js.map +0 -1
  157. package/dist/node/core/traits/WithBannerImage.js.map +0 -1
  158. package/dist/node/core/traits/WithCatalog.js.map +0 -1
  159. package/dist/node/core/traits/WithLayout.js.map +0 -1
  160. package/dist/node/core/traits/WithSlug.js.map +0 -1
  161. package/dist/types/core/traits/WithCatalog.d.ts +0 -7
@@ -69,7 +69,7 @@ export declare class HubProjectManager implements IHubEntityManager<IHubProject>
69
69
  * @param requestOptions
70
70
  * @returns
71
71
  */
72
- destroy(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
72
+ delete(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
73
73
  /**
74
74
  * Fetch a Project via id or it's slug
75
75
  *
@@ -4,8 +4,8 @@ import { IItem } from "@esri/arcgis-rest-portal";
4
4
  import { IRequestOptions } from "@esri/arcgis-rest-request";
5
5
  import { IHubProject } from "../core/types";
6
6
  import { IHubSearchResponse, IHubSearchResult, IQuery } from "../search";
7
- export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
8
7
  /**
8
+ * @private
9
9
  * Create a new Hub Project item
10
10
  *
11
11
  * Minimal properties are name and org
@@ -15,23 +15,26 @@ export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
15
15
  */
16
16
  export declare function createProject(partialProject: Partial<IHubProject>, requestOptions: IUserRequestOptions): Promise<IHubProject>;
17
17
  /**
18
+ * @private
18
19
  * Update a Hub Project
19
20
  * @param project
20
21
  * @param requestOptions
21
22
  */
22
23
  export declare function updateProject(project: IHubProject, requestOptions: IUserRequestOptions): Promise<IHubProject>;
23
24
  /**
25
+ * @private
24
26
  * Get a Hub Project by id or slug
25
27
  * @param identifier item id or slug
26
28
  * @param requestOptions
27
29
  */
28
30
  export declare function fetchProject(identifier: string, requestOptions: IRequestOptions): Promise<IHubProject>;
29
31
  /**
32
+ * @private
30
33
  * Remove a Hub Project
31
34
  * @param id
32
35
  * @param requestOptions
33
36
  */
34
- export declare function destroyProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
37
+ export declare function deleteProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
35
38
  /**
36
39
  * Search for Projects, and get IHubProject results
37
40
  *
@@ -43,6 +46,7 @@ export declare function destroyProject(id: string, requestOptions: IUserRequestO
43
46
  */
44
47
  export declare function searchProjects(query: string | IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubProject>>;
45
48
  /**
49
+ * @private
46
50
  * Convert an Hub Project Item into a Hub Project, fetching any additional
47
51
  * information that may be required
48
52
  * @param item
@@ -51,6 +55,7 @@ export declare function searchProjects(query: string | IQuery, options: IHubSear
51
55
  */
52
56
  export declare function convertItemToProject(item: IItem, requestOptions: IRequestOptions): Promise<IHubProject>;
53
57
  /**
58
+ * @private
54
59
  * Fetch project specific enrichments
55
60
  * @param item
56
61
  * @param include
@@ -0,0 +1,11 @@
1
+ import { IHubProject } from "../core";
2
+ import { IModel } from "../types";
3
+ export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
4
+ /**
5
+ * Default values of a IHubProject
6
+ */
7
+ export declare const DEFAULT_PROJECT: Partial<IHubProject>;
8
+ /**
9
+ * Default values for a new HubProject Model
10
+ */
11
+ export declare const DEFAULT_PROJECT_MODEL: IModel;
@@ -1,2 +1,2 @@
1
- export * from "./HubProjectManager";
2
1
  export * from "./HubProjects";
2
+ export * from "./HubProject";
@@ -21,7 +21,7 @@ export declare class Catalog implements IHubCatalog {
21
21
  private _catalog;
22
22
  private constructor();
23
23
  /**
24
- * Create a Collection instance from a Catalog json object, a site url or itemId
24
+ * Create a Catalog instance from a site url or itemId
25
25
  * '''js
26
26
  * const catalog = await Catalog.create('https://site-org.hub.arcgis.com', context);
27
27
  * '''
@@ -32,12 +32,12 @@ export declare class Catalog implements IHubCatalog {
32
32
  */
33
33
  static init(identifier: string, context?: IArcGISContext): Promise<Catalog>;
34
34
  /**
35
- * Create a Catalog instance from a Catalog Json object
35
+ * Create a Catalog instance from a Catalog Definition Json object
36
36
  * @param json
37
37
  * @param context
38
38
  * @returns
39
39
  */
40
- static fromJson(json: any, context?: IArcGISContext): Catalog;
40
+ static fromJson(json: IHubCatalog, context?: IArcGISContext): Catalog;
41
41
  /**
42
42
  * Return the JSON object backing the instance
43
43
  * @returns
@@ -140,4 +140,5 @@ export declare class Catalog implements IHubCatalog {
140
140
  * @returns
141
141
  */
142
142
  private getEmptyResult;
143
+ private getDefaultSearchOptions;
143
144
  }
@@ -66,7 +66,7 @@ export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHub
66
66
  * @param requestOptions
67
67
  * @returns
68
68
  */
69
- destroy(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
69
+ delete(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
70
70
  /**
71
71
  * Fetch a Site via Id, slug or domain
72
72
  *
@@ -3,7 +3,6 @@ export * from "./domains";
3
3
  export * from "./drafts";
4
4
  export * from "./fetchSiteModel";
5
5
  export * from "./get-site-by-id";
6
- export * from "./HubSiteManager";
7
6
  export * from "./HubSites";
8
7
  export * from "./registerSiteAsApplication";
9
8
  export * from "./site-schema-version";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esri/hub-common",
3
- "version": "10.1.0",
3
+ "version": "11.0.0-beta.3",
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",
@@ -1 +0,0 @@
1
- //# sourceMappingURL=WithBannerImage.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithBannerImage.js","sourceRoot":"","sources":["../../../../src/core/traits/WithBannerImage.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=WithCatalog.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithCatalog.js","sourceRoot":"","sources":["../../../../src/core/traits/WithCatalog.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=WithLayout.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithLayout.js","sourceRoot":"","sources":["../../../../src/core/traits/WithLayout.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=WithSlug.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithSlug.js","sourceRoot":"","sources":["../../../../src/core/traits/WithSlug.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithBannerImage.js","sourceRoot":"","sources":["../../../../src/core/traits/WithBannerImage.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithCatalog.js","sourceRoot":"","sources":["../../../../src/core/traits/WithCatalog.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithLayout.js","sourceRoot":"","sources":["../../../../src/core/traits/WithLayout.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"WithSlug.js","sourceRoot":"","sources":["../../../../src/core/traits/WithSlug.ts"],"names":[],"mappings":""}
@@ -1,7 +0,0 @@
1
- import { Catalog } from "../../search/Catalog";
2
- export interface IWithCatalog {
3
- /**
4
- * Catalog
5
- */
6
- catalog: Catalog;
7
- }