@esri/hub-common 11.0.0-beta.2 → 11.0.0-beta.5

package/dist/node/sites/HubSiteManager.js

@@ -1,159 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HubSiteManager = void 0;
-const HubError_1 = require("../HubError");
-// Node has issues if this is not directly imported
-const ArcGISContextManager_1 = require("../ArcGISContextManager");
-const HubSites_1 = require("./HubSites");
-const setItemThumbnail_1 = require("../items/setItemThumbnail");
-class HubSiteManager {
-    /**
-     * Private so we can employ a factory function should we need
-     * async work during creation
-     * @param contextOrManager
-     */
-    constructor(contextOrManager) {
-        if (contextOrManager instanceof ArcGISContextManager_1.ArcGISContextManager) {
-            this._contextManager = contextOrManager;
-        }
-        else {
-            this._context = contextOrManager;
-        }
-    }
-    /**
-     * Factory function to construct a new HubProjectManager instance.
-     *
-     * Note: Used so that we could do async actions in the ctor.
-     * @param contextOrManager
-     * @returns
-     */
-    static init(contextOrManager) {
-        return new HubSiteManager(contextOrManager);
-    }
-    /**
-     * Getter to abstract how we store the context
-     */
-    get context() {
-        if (this._contextManager) {
-            return this._contextManager.context;
-        }
-        else {
-            return this._context;
-        }
-    }
-    /**
-     * Create and store a new Site
-     *
-     * This also registers the item for oAuth and
-     * registers domain names with the hub Domain system
-     *
-     * Sites are stored as Items in the Sharing API
-     * @param site
-     * @param requestOptions
-     * @returns
-     */
-    async create(site, requestOptions) {
-        if (requestOptions || this.context.isAuthenticated) {
-            // ammend in the orgUrlKey
-            if (!site.orgUrlKey) {
-                site.orgUrlKey = this.context.portal.urlKey;
-            }
-            return HubSites_1.createSite(site, requestOptions || this.context.hubRequestOptions);
-        }
-        else {
-            throw new HubError_1.default("Create Site", "Creating Hub Sites requires authentication.");
-        }
-    }
-    /**
-     * Update a Site
-     * @param site
-     * @param requestOptions
-     * @returns
-     */
-    async update(site, requestOptions) {
-        if (requestOptions || this.context.isAuthenticated) {
-            return HubSites_1.updateSite(site, requestOptions || this.context.hubRequestOptions);
-        }
-        else {
-            throw new HubError_1.default("Update Site", "Updating a Hub Site requires authentication.");
-        }
-    }
-    /**
-     * Destroy a Site
-     * This permanently removes the backing Item,
-     * and clears the domain entries for it.
-     * @param id
-     * @param requestOptions
-     * @returns
-     */
-    async delete(id, requestOptions) {
-        if (requestOptions || this.context.isAuthenticated) {
-            return HubSites_1.destroySite(id, requestOptions || this.context.hubRequestOptions);
-        }
-        else {
-            throw new HubError_1.default("Destroy Site", "Destroying Hub Sites requires authentication.");
-        }
-    }
-    /**
-     * Fetch a Site via Id, slug or domain
-     *
-     * This function does not require a user to be
-     * authenticated, but it does require an `IRequestOptions`
-     * which contains the portal instance to communicate with
-     * @param identifier
-     * @param requestOptions
-     * @returns
-     */
-    async fetch(identifier, requestOptions) {
-        try {
-            if (requestOptions || this.context.hubRequestOptions) {
-                return HubSites_1._fetchSite(identifier, requestOptions || this.context.hubRequestOptions);
-            }
-            else {
-                throw new HubError_1.default("Fetch Site", "Can not retrieve context.hubRequestOptions from Context Manager. HubSiteManager is configured incorrectly.");
-            }
-        }
-        catch (ex) {
-            throw new HubError_1.default("Fetch Site", "Can not retrieve context.hubRequestOptions from Context Manager. HubSiteManager is configured incorrectly.", ex);
-        }
-    }
-    /**
-     * Search for Sites
-     *
-     * @param filter
-     * @param opts
-     */
-    async search(query, options) {
-        // if we were not passed auth, and we have a session, use it
-        if (!options.authentication && this.context.session) {
-            options.authentication = this.context.session;
-        }
-        return HubSites_1.searchSites(query, options);
-    }
-    /**
-     * Set the thumbnail for the Site
-     * @param id
-     * @param file
-     * @param filename
-     * @param requestOptions
-     * @returns
-     */
-    async updateThumbnail(site, file, filename, requestOptions) {
-        const ro = requestOptions || this.context.userRequestOptions;
-        await setItemThumbnail_1.setItemThumbnail(site.id, file, filename, ro);
-        // get the item so we have updated props and timestamps
-        return this.fetch(site.id, requestOptions);
-    }
-    /**
-     * Convert a Hub Project Item to a IHubProject
-     * @param item
-     * @param requestOptions
-     * @returns
-     */
-    async fromItem(item, requestOptions) {
-        const ro = requestOptions || this.context.userRequestOptions;
-        return HubSites_1.convertItemToSite(item, ro);
-    }
-}
-exports.HubSiteManager = HubSiteManager;
-//# sourceMappingURL=HubSiteManager.js.map

package/dist/node/sites/HubSiteManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HubSiteManager.js","sourceRoot":"","sources":["../../../src/sites/HubSiteManager.ts"],"names":[],"mappings":";;;AAEA,0CAAmC;AAOnC,mDAAmD;AACnD,kEAA+D;AAC/D,yCAOoB;AAGpB,gEAAoF;AAKpF,MAAa,cAAc;IAkBzB;;;;OAIG;IACH,YAAoB,gBAAuD;QACzE,IAAI,gBAAgB,YAAY,2CAAoB,EAAE;YACpD,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC;SACzC;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;SAClC;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CACT,gBAAuD;QAEvD,OAAO,IAAI,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAY,OAAO;QACjB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;SACrC;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CACV,IAAuB,EACvB,cAAmC;QAEnC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,0BAA0B;YAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;aAC7C;YACD,OAAO,qBAAU,CAAC,IAAI,EAAE,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC3E;aAAM;YACL,MAAM,IAAI,kBAAQ,CAChB,aAAa,EACb,6CAA6C,CAC9C,CAAC;SACH;IACH,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,IAAc,EACd,cAAmC;QAEnC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,OAAO,qBAAU,CAAC,IAAI,EAAE,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC3E;aAAM;YACL,MAAM,IAAI,kBAAQ,CAChB,aAAa,EACb,8CAA8C,CAC/C,CAAC;SACH;IACH,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,cAAmC;QAC1D,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,OAAO,sBAAW,CAAC,EAAE,EAAE,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SAC1E;aAAM;YACL,MAAM,IAAI,kBAAQ,CAChB,cAAc,EACd,+CAA+C,CAChD,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACT,UAAkB,EAClB,cAAmC;QAEnC,IAAI;YACF,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE;gBACpD,OAAO,qBAAU,CACf,UAAU,EACV,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CACjD,CAAC;aACH;iBAAM;gBACL,MAAM,IAAI,kBAAQ,CAChB,YAAY,EACZ,4GAA4G,CAC7G,CAAC;aACH;SACF;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,IAAI,kBAAQ,CAChB,YAAY,EACZ,4GAA4G,EAC5G,EAAsB,CACvB,CAAC;SACH;IACH,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,KAAsB,EACtB,OAA0B;QAE1B,4DAA4D;QAC5D,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACnD,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAC/C;QACD,OAAO,sBAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CACnB,IAAc,EACd,IAAS,EACT,QAAgB,EAChB,cAAoC;QAEpC,MAAM,EAAE,GAAG,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC7D,MAAM,mCAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACvD,uDAAuD;QACvD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,IAAW,EACX,cAAgC;QAEhC,MAAM,EAAE,GAAG,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC7D,OAAO,4BAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;CACF;AA5MD,wCA4MC"}

package/dist/types/projects/HubProjectManager.d.ts

@@ -1,152 +0,0 @@
-import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { ArcGISContextManager } from "../ArcGISContextManager";
-import { IArcGISContext, IHubSearchOptions, IHubSearchResponse, IQuery } from "..";
-import { IHubEntityManager, IHubProject } from "../core/types";
-import { IHubItemEntityManager } from "../core/types/IHubItemEntityManager";
-import { IGroup, IItem } from "@esri/arcgis-rest-types";
-import { ISharingResponse } from "@esri/arcgis-rest-portal";
-/**
- * Centralized functions used to manage IHubProject instances
- *
- * This class is a convenience wrapper over util functions which
- * are also directly accessible for use in scenarios where
- * classes are inconvenient.
- */
-export declare class HubProjectManager implements IHubEntityManager<IHubProject>, IHubItemEntityManager<IHubProject> {
-    /**
-     * Hold a context manager, which should be a single instance for
-     * an application. When authentication changes, the .context
-     * property on the context manager will be replaced. As long as
-     * all the fns in this class leverage properties on .context
-     * everything be kept in sync.
-     */
-    private _contextManager;
-    /**
-     * Hold context directly. Allows the class to be used in places
-     * where an `ArcGISContextManager` is not directly available, but
-     * an `IArcGISContext` is
-     */
-    private _context;
-    /**
-     * Private so we can employ a factory function should we need
-     * async work during creation
-     * @param contextOrManager
-     */
-    private constructor();
-    /**
-     * Factory function to construct a new HubProjectManager instance.
-     *
-     * Note: Used so that we could do async actions in the ctor.
-     * @param contextOrManager
-     * @returns
-     */
-    static init(contextOrManager: ArcGISContextManager | IArcGISContext): HubProjectManager;
-    /**
-     * Getter to abstract how we store the context
-     */
-    private get context();
-    /**
-     * Create and store new project.
-     *
-     * Projects are stored as Items in the Sharing API
-     * @param project
-     * @param requestOptions
-     * @returns
-     */
-    create(project: Partial<IHubProject>, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
-    /**
-     * Update a project
-     * @param project
-     * @param requestOptions
-     * @returns
-     */
-    update(project: IHubProject, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
-    /**
-     * Destroy a project.
-     * This permanently removes the backing Item
-     * @param id
-     * @param requestOptions
-     * @returns
-     */
-    delete(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
-    /**
-     * Fetch a Project via id or it's slug
-     *
-     * This function does not require a user to be
-     * authenticated, but it does require an `IRequestOptions`
-     * which contains the portal instance to communicate with
-     * @param identifier
-     * @param requestOptions
-     * @returns
-     */
-    fetch(identifier: string, requestOptions?: IRequestOptions): Promise<IHubProject>;
-    /**
-     * Search for Projects
-     *
-     * @param query
-     * @param options
-     */
-    search(query: string | IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubProject>>;
-    /**
-     * Set the thumbnail for the Project
-     * @param id
-     * @param file
-     * @param filename
-     * @param requestOptions
-     * @returns
-     */
-    updateThumbnail(project: IHubProject, file: any, filename: string, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
-    /**
-     * Convert a Hub Project Item to a IHubProject
-     * @param item
-     * @param requestOptions
-     * @returns
-     */
-    fromItem(item: IItem, requestOptions?: IRequestOptions): Promise<IHubProject>;
-    /**
-     * Sets the access level of a Hub Project
-     *
-     * @param {IHubProject} project
-     * @param {("public" | "org" | "private")} accessLevel
-     * @param {IUserRequestOptions} [requestOptions]
-     * @returns
-     */
-    setAccess(project: IHubProject, accessLevel: "public" | "org" | "private", requestOptions?: IUserRequestOptions): Promise<ISharingResponse>;
-    /**
-     * Shares a Hub Project to a group
-     *
-     * @param {IHubProject} project
-     * @param {IGroup} group
-     * @param {IUserRequestOptions} [requestOptions]
-     * @returns
-     */
-    shareToGroup(project: IHubProject, group: IGroup, requestOptions?: IUserRequestOptions): Promise<ISharingResponse>;
-    /**
-     * Shares a Hub Project to N Groups.
-     *
-     * @param {IHubProject} project
-     * @param {IGroup[]} groups
-     * @param {IUserRequestOptions} [requestOptions]
-     * @returns
-     */
-    shareToGroups(project: IHubProject, groups: IGroup[], requestOptions?: IUserRequestOptions): Promise<ISharingResponse[]>;
-    /**
-     * Unshares a Hub Project from a group
-     *
-     * @param {IHubProject} project
-     * @param {IGroup} group
-     * @param {IUserRequestOptions} [requestOptions]
-     * @returns
-     */
-    unshareFromGroup(project: IHubProject, group: IGroup, requestOptions?: IUserRequestOptions): Promise<ISharingResponse>;
-    /**
-     * Unshares a Hub Project from N groups.
-     *
-     * @param {IHubProject} project
-     * @param {IGroup[]} groups
-     * @param {IUserRequestOptions} [requestOptions]
-     * @returns
-     */
-    unshareFromGroups(project: IHubProject, groups: IGroup[], requestOptions?: IUserRequestOptions): Promise<ISharingResponse[]>;
-}

package/dist/types/search/_internal/createQueryFromString.d.ts

@@ -1,10 +0,0 @@
-import { EntityType, IQuery } from "../types";
-/**
- * @private
- * Construct a query from a string
- * @param value
- * @param predicateKey
- * @param targetEntity
- * @returns
- */
-export declare function createQueryFromString(value: string, predicateKey: string, targetEntity: EntityType): IQuery;

package/dist/types/search/_internal/searchEntities.d.ts

@@ -1,23 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-types";
-import { IHubSearchOptions, IHubSearchResponse, IQuery } from "../types";
-/**
- * @private
- */
-export declare type ConversionFunction<T> = (i: IItem, ro?: IRequestOptions) => Promise<T>;
-/**
- * @private
- * Execute a search and convert to a specific entity
- * @param query
- * @param convertFn
- * @param options
- * @returns
- */
-export declare function searchEntities<T>(query: IQuery, convertFn: ConversionFunction<T>, options: IHubSearchOptions): Promise<IHubSearchResponse<T>>;
-/**
- * @private
- * @param convertFn
- * @returns
- */
-export declare function createEntitySearchFn<T>(convertFn: ConversionFunction<T>): (v: ISearchOptions) => Promise<IHubSearchResponse<T>>;

package/dist/types/sites/HubSiteManager.d.ts

@@ -1,104 +0,0 @@
-import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-import { IArcGISContext } from "../ArcGISContext";
-import { IHubEntityManager, IHubItemEntityManager, IHubSite } from "../core/types";
-import { ArcGISContextManager } from "../ArcGISContextManager";
-import { IHubSearchOptions, IQuery } from "../search";
-import { IHubRequestOptions, ISearchResponse } from "../types";
-import { IItem } from "@esri/arcgis-rest-types";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHubItemEntityManager<IHubSite> {
-    /**
-     * Hold a context manager, which should be a single instance for
-     * an application. When authentication changes, the .context
-     * property on the context manager will be replaced. As long as
-     * all the fns in this class leverage properties on .context
-     * everything be kept in sync.
-     */
-    private _contextManager;
-    /**
-     * Hold context directly. Allows the class to be used in places
-     * where an `ArcGISContextManager` is not directly available, but
-     * an `IArcGISContext` is
-     */
-    private _context;
-    /**
-     * Private so we can employ a factory function should we need
-     * async work during creation
-     * @param contextOrManager
-     */
-    private constructor();
-    /**
-     * Factory function to construct a new HubProjectManager instance.
-     *
-     * Note: Used so that we could do async actions in the ctor.
-     * @param contextOrManager
-     * @returns
-     */
-    static init(contextOrManager: ArcGISContextManager | IArcGISContext): HubSiteManager;
-    /**
-     * Getter to abstract how we store the context
-     */
-    private get context();
-    /**
-     * Create and store a new Site
-     *
-     * This also registers the item for oAuth and
-     * registers domain names with the hub Domain system
-     *
-     * Sites are stored as Items in the Sharing API
-     * @param site
-     * @param requestOptions
-     * @returns
-     */
-    create(site: Partial<IHubSite>, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
-    /**
-     * Update a Site
-     * @param site
-     * @param requestOptions
-     * @returns
-     */
-    update(site: IHubSite, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
-    /**
-     * Destroy a Site
-     * This permanently removes the backing Item,
-     * and clears the domain entries for it.
-     * @param id
-     * @param requestOptions
-     * @returns
-     */
-    delete(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
-    /**
-     * Fetch a Site via Id, slug or domain
-     *
-     * This function does not require a user to be
-     * authenticated, but it does require an `IRequestOptions`
-     * which contains the portal instance to communicate with
-     * @param identifier
-     * @param requestOptions
-     * @returns
-     */
-    fetch(identifier: string, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
-    /**
-     * Search for Sites
-     *
-     * @param filter
-     * @param opts
-     */
-    search(query: string | IQuery, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
-    /**
-     * Set the thumbnail for the Site
-     * @param id
-     * @param file
-     * @param filename
-     * @param requestOptions
-     * @returns
-     */
-    updateThumbnail(site: IHubSite, file: any, filename: string, requestOptions?: IUserRequestOptions): Promise<IHubSite>;
-    /**
-     * Convert a Hub Project Item to a IHubProject
-     * @param item
-     * @param requestOptions
-     * @returns
-     */
-    fromItem(item: IItem, requestOptions?: IRequestOptions): Promise<IHubSite>;
-}