@esri/hub-common 11.0.0-beta.4 → 11.1.0

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

@@ -1,153 +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";
-/**
- * @private
- * 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>;
-}