@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.
- package/dist/esm/Hub.js +0 -26
- package/dist/esm/Hub.js.map +1 -1
- package/dist/esm/core/PermissionManager.js +60 -0
- package/dist/esm/core/PermissionManager.js.map +1 -0
- package/dist/esm/core/_internal/PropertyMapper.js +1 -0
- package/dist/esm/core/_internal/PropertyMapper.js.map +1 -1
- package/dist/esm/core/_internal/sharedWith.js +14 -0
- package/dist/esm/core/_internal/sharedWith.js.map +1 -0
- package/dist/esm/core/behaviors/IWithCatalogBehavior.js +1 -0
- package/dist/esm/core/behaviors/IWithCatalogBehavior.js.map +1 -0
- package/dist/esm/core/behaviors/IWithPermissionBehavior.js +69 -0
- package/dist/esm/core/behaviors/IWithPermissionBehavior.js.map +1 -0
- package/dist/esm/core/behaviors/IWithSharingBehavior.js +1 -0
- package/dist/esm/core/behaviors/IWithSharingBehavior.js.map +1 -0
- package/dist/esm/core/behaviors/IWithStoreBehavior.js +1 -0
- package/dist/esm/core/behaviors/IWithStoreBehavior.js.map +1 -0
- package/dist/esm/core/behaviors/index.js +5 -0
- package/dist/esm/core/behaviors/index.js.map +1 -0
- package/dist/esm/core/index.js +2 -0
- package/dist/esm/core/index.js.map +1 -1
- package/dist/esm/core/traits/IWithBannerImage.js +1 -0
- package/dist/esm/core/traits/IWithBannerImage.js.map +1 -0
- package/dist/esm/core/traits/IWithCatalogDefinition.js +1 -0
- package/dist/esm/core/traits/IWithCatalogDefinition.js.map +1 -0
- package/dist/esm/core/traits/IWithLayout.js +1 -0
- package/dist/esm/core/traits/IWithLayout.js.map +1 -0
- package/dist/esm/core/traits/IWithPermissions.js +1 -0
- package/dist/esm/core/traits/IWithPermissions.js.map +1 -0
- package/dist/esm/core/traits/IWithSlug.js +1 -0
- package/dist/esm/core/traits/IWithSlug.js.map +1 -0
- package/dist/esm/core/traits/index.js +4 -3
- package/dist/esm/core/traits/index.js.map +1 -1
- package/dist/esm/core/types/IHubPermission.js +1 -0
- package/dist/esm/core/types/IHubPermission.js.map +1 -0
- package/dist/esm/core/types/index.js +1 -0
- package/dist/esm/core/types/index.js.map +1 -1
- package/dist/esm/index.js +2 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/items/slugs.js +1 -1
- package/dist/esm/models/index.js +15 -10
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/projects/HubProject.js +369 -0
- package/dist/esm/projects/HubProject.js.map +1 -0
- package/dist/esm/projects/HubProjectManager.js +4 -4
- package/dist/esm/projects/HubProjectManager.js.map +1 -1
- package/dist/esm/projects/HubProjects.js +37 -39
- package/dist/esm/projects/HubProjects.js.map +1 -1
- package/dist/esm/projects/defaults.js +36 -0
- package/dist/esm/projects/defaults.js.map +1 -0
- package/dist/esm/projects/index.js +1 -1
- package/dist/esm/projects/index.js.map +1 -1
- package/dist/esm/search/Catalog.js +22 -5
- package/dist/esm/search/Catalog.js.map +1 -1
- package/dist/esm/sites/HubSiteManager.js +1 -1
- package/dist/esm/sites/HubSiteManager.js.map +1 -1
- package/dist/esm/sites/index.js +0 -1
- package/dist/esm/sites/index.js.map +1 -1
- package/dist/node/Hub.js +0 -26
- package/dist/node/Hub.js.map +1 -1
- package/dist/node/core/PermissionManager.js +64 -0
- package/dist/node/core/PermissionManager.js.map +1 -0
- package/dist/node/core/_internal/PropertyMapper.js +1 -0
- package/dist/node/core/_internal/PropertyMapper.js.map +1 -1
- package/dist/node/core/_internal/sharedWith.js +18 -0
- package/dist/node/core/_internal/sharedWith.js.map +1 -0
- package/dist/node/core/behaviors/IWithCatalogBehavior.js +3 -0
- package/dist/node/core/behaviors/IWithCatalogBehavior.js.map +1 -0
- package/dist/node/core/behaviors/IWithPermissionBehavior.js +76 -0
- package/dist/node/core/behaviors/IWithPermissionBehavior.js.map +1 -0
- package/dist/node/core/behaviors/IWithSharingBehavior.js +3 -0
- package/dist/node/core/behaviors/IWithSharingBehavior.js.map +1 -0
- package/dist/node/core/behaviors/IWithStoreBehavior.js +3 -0
- package/dist/node/core/behaviors/IWithStoreBehavior.js.map +1 -0
- package/dist/node/core/behaviors/index.js +8 -0
- package/dist/node/core/behaviors/index.js.map +1 -0
- package/dist/node/core/index.js +2 -0
- package/dist/node/core/index.js.map +1 -1
- package/dist/node/core/traits/{WithBannerImage.js → IWithBannerImage.js} +1 -1
- package/dist/node/core/traits/IWithBannerImage.js.map +1 -0
- package/dist/node/core/traits/IWithCatalogDefinition.js +3 -0
- package/dist/node/core/traits/IWithCatalogDefinition.js.map +1 -0
- package/dist/node/core/traits/{WithCatalog.js → IWithLayout.js} +1 -1
- package/dist/node/core/traits/IWithLayout.js.map +1 -0
- package/dist/node/core/traits/IWithPermissions.js +3 -0
- package/dist/node/core/traits/IWithPermissions.js.map +1 -0
- package/dist/node/core/traits/{WithSlug.js → IWithSlug.js} +1 -1
- package/dist/node/core/traits/IWithSlug.js.map +1 -0
- package/dist/node/core/traits/index.js +4 -3
- package/dist/node/core/traits/index.js.map +1 -1
- package/dist/node/core/{traits/WithLayout.js → types/IHubPermission.js} +1 -1
- package/dist/node/core/types/IHubPermission.js.map +1 -0
- package/dist/node/core/types/index.js +1 -0
- package/dist/node/core/types/index.js.map +1 -1
- package/dist/node/index.js +2 -1
- package/dist/node/index.js.map +1 -1
- package/dist/node/items/slugs.js +1 -1
- package/dist/node/models/index.js +15 -10
- package/dist/node/models/index.js.map +1 -1
- package/dist/node/projects/HubProject.js +373 -0
- package/dist/node/projects/HubProject.js.map +1 -0
- package/dist/node/projects/HubProjectManager.js +3 -3
- package/dist/node/projects/HubProjectManager.js.map +1 -1
- package/dist/node/projects/HubProjects.js +42 -44
- package/dist/node/projects/HubProjects.js.map +1 -1
- package/dist/node/projects/defaults.js +39 -0
- package/dist/node/projects/defaults.js.map +1 -0
- package/dist/node/projects/index.js +1 -1
- package/dist/node/projects/index.js.map +1 -1
- package/dist/node/search/Catalog.js +22 -5
- package/dist/node/search/Catalog.js.map +1 -1
- package/dist/node/sites/HubSiteManager.js +1 -1
- package/dist/node/sites/HubSiteManager.js.map +1 -1
- package/dist/node/sites/index.js +0 -1
- package/dist/node/sites/index.js.map +1 -1
- package/dist/types/Hub.d.ts +0 -18
- package/dist/types/core/PermissionManager.d.ts +43 -0
- package/dist/types/core/_internal/PropertyMapper.d.ts +1 -0
- package/dist/types/core/_internal/sharedWith.d.ts +10 -0
- package/dist/types/core/behaviors/IWithCatalogBehavior.d.ts +4 -0
- package/dist/types/core/behaviors/IWithPermissionBehavior.d.ts +40 -0
- package/dist/types/core/behaviors/IWithSharingBehavior.d.ts +27 -0
- package/dist/types/core/behaviors/IWithStoreBehavior.d.ts +22 -0
- package/dist/types/core/behaviors/index.d.ts +4 -0
- package/dist/types/core/index.d.ts +2 -0
- package/dist/types/core/traits/{WithBannerImage.d.ts → IWithBannerImage.d.ts} +0 -0
- package/dist/types/core/traits/IWithCatalogDefinition.d.ts +7 -0
- package/dist/types/core/traits/{WithLayout.d.ts → IWithLayout.d.ts} +0 -0
- package/dist/types/core/traits/IWithPermissions.d.ts +10 -0
- package/dist/types/core/traits/{WithSlug.d.ts → IWithSlug.d.ts} +0 -0
- package/dist/types/core/traits/index.d.ts +4 -3
- package/dist/types/core/types/IHubEntityManager.d.ts +1 -1
- package/dist/types/core/types/IHubInitiative.d.ts +1 -1
- package/dist/types/core/types/IHubPage.d.ts +1 -1
- package/dist/types/core/types/IHubPermission.d.ts +23 -0
- package/dist/types/core/types/IHubProject.d.ts +4 -3
- package/dist/types/core/types/IHubSite.d.ts +2 -2
- package/dist/types/core/types/index.d.ts +1 -0
- package/dist/types/core/types/types.d.ts +5 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/projects/HubProject.d.ts +92 -0
- package/dist/types/projects/HubProjectManager.d.ts +1 -1
- package/dist/types/projects/HubProjects.d.ts +7 -2
- package/dist/types/projects/defaults.d.ts +11 -0
- package/dist/types/projects/index.d.ts +1 -1
- package/dist/types/search/Catalog.d.ts +4 -3
- package/dist/types/sites/HubSiteManager.d.ts +1 -1
- package/dist/types/sites/index.d.ts +0 -1
- package/package.json +1 -1
- package/dist/esm/core/traits/WithBannerImage.js +0 -1
- package/dist/esm/core/traits/WithBannerImage.js.map +0 -1
- package/dist/esm/core/traits/WithCatalog.js +0 -1
- package/dist/esm/core/traits/WithCatalog.js.map +0 -1
- package/dist/esm/core/traits/WithLayout.js +0 -1
- package/dist/esm/core/traits/WithLayout.js.map +0 -1
- package/dist/esm/core/traits/WithSlug.js +0 -1
- package/dist/esm/core/traits/WithSlug.js.map +0 -1
- package/dist/node/core/traits/WithBannerImage.js.map +0 -1
- package/dist/node/core/traits/WithCatalog.js.map +0 -1
- package/dist/node/core/traits/WithLayout.js.map +0 -1
- package/dist/node/core/traits/WithSlug.js.map +0 -1
- 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
|
-
|
|
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
|
|
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;
|
|
@@ -21,7 +21,7 @@ export declare class Catalog implements IHubCatalog {
|
|
|
21
21
|
private _catalog;
|
|
22
22
|
private constructor();
|
|
23
23
|
/**
|
|
24
|
-
* Create a
|
|
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:
|
|
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
|
-
|
|
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 +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":""}
|