@esri/hub-common 14.30.1 → 14.32.0

package/dist/types/utils/internal/userAppResources.d.ts

@@ -0,0 +1,130 @@
+/**
+ * @private
+ * Defines the access for the resource. The access level can be one of the following:
+ * - `userappprivate` Resource is available only to the user through the app from which resource was uploaded.
+ * - `userprivateallapps`  Resource is available only to the user that uploaded the resource through any app.
+ * - `allorgusersprivateapp` Resource is available to all members of the org as that of the resource owner and through the app that uploaded. We allow adding resource with level only if the user's access is either public or org.
+ * - `public`  Resource is available to anyone (including anonymous access) through any app. We allow adding a resource at public level only if the user's access is public and the canSharePublic flag of the org is set to true.
+ */
+export declare type UserResourceAccess = 
+/**
+ * Resource is available only to the user through the app from which resource was uploaded.
+ */
+"userappprivate" | "userprivateallapps" | "allorgusersprivateapp" | "public";
+/**
+ * @private
+ * Add an User-App Resource
+ */
+export interface IAddUserResource {
+    /**
+     * The filename of the resource
+     */
+    key: string;
+    /**
+     * The json object to store; will be stringified
+     */
+    data: Record<string, any>;
+    /**
+     * The access level for the resource
+     */
+    access: UserResourceAccess;
+}
+/**
+ * @private
+ * Information about a user app resource
+ */
+export interface IUserResourceInfo {
+    /**
+     * The filename of the resource
+     */
+    key: string;
+    /**
+     * The clientId of the app that created the resource
+     */
+    clientId: string;
+    /**
+     * The date the resource was created
+     */
+    created: string;
+    /**
+     * The size of the resource in bytes
+     */
+    size: number;
+    /**
+     * The access level for the resource
+     */
+    access: UserResourceAccess;
+}
+/**
+ * @private
+ * Returned when we get a list of resources for a user
+ */
+export interface IUserResourceListResponse {
+    /**
+     * The total number of resources
+     */
+    total: number;
+    /**
+     * The index of the first resource in the list
+     */
+    start: number;
+    /**
+     * The number of resources returned
+     */
+    num: number;
+    /**
+     * The next index to use to get the next set of resources
+     */
+    nextStart: number;
+    /**
+     * The list of resources
+     */
+    userResources: IUserResourceInfo[];
+}
+/**
+ * @private
+ * Set a User-App-Resource
+ * By default this will fetch and merge with an existing resource.
+ * Passing `true` as the last parameter,
+ * @param resource
+ * @param username
+ * @param portalUrl
+ * @param token
+ * @param replace
+ * @returns
+ */
+export declare function setUserResource(resource: IAddUserResource, username: string, portalUrl: string, token: string, replace?: boolean): Promise<void>;
+/**
+ * @private
+ * Gets a user app resource
+ * If the resource does not exist, this will throw. This can be wrapped in `failSafe`
+ * configured to return an empty object.
+ * @param username
+ * @param key
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+export declare function getUserResource(username: string, key: string, portalUrl: string, token: string): Promise<Record<string, any>>;
+/**
+ * @private
+ * Remove a resource
+ * Used primarily in tests, but can be useful if you need to clean up
+ * settings that are no longer used
+ * @param username
+ * @param key
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+export declare function removeUserResource(username: string, key: string, portalUrl: string, token: string): Promise<Record<string, any>>;
+/**
+ * @private
+ * List user resources associated with the user/token.
+ * Defaults to listing only resources associated with the app the token is associated with
+ * @param username
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+export declare function listUserResources(username: string, portalUrl: string, token: string, returnAllApps?: boolean): Promise<IUserResourceListResponse>;

package/dist/types/utils/poll.d.ts

@@ -1,6 +1,12 @@
 /**
  * Function to poll a provided request until a validation
  * state or timeout is reached
+ *
+ * NOTE: we expose this as a public util, but should use this
+ * functionality sparingly when dealing with the Portal API.
+ * Best practice is to leverage this polling functionality
+ * internally on functions that we know incur a Portal delay.
+ *
  * @param requestFn
  * @param validationFn
  * @param opts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.30.1",
+  "version": "14.32.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",