@esri/hub-common 14.104.0 → 14.106.0

package/dist/types/newsletters/api/orval/api/orval-newsletters.d.ts

@@ -0,0 +1,215 @@
+import { Awaited } from "../awaited-type";
+/**
+ * Generated by orval v6.24.0 🍺
+ * Do not edit manually.
+ * Hub Newsletters Service
+ * OpenAPI spec version: 0.0.1
+ */
+import { customClient } from "../custom-client";
+export declare type GetSubscriptionsParams = {
+    /**
+     * Optional array of matching notification spec names to filter by
+     */
+    names?: string[];
+    /**
+     * Optional cadence to filter by
+     */
+    cadence?: Cadence;
+    /**
+     * Optional user id to filter by. Note this gets extracted/overridden from AGO token if provided
+     */
+    userId?: string;
+    /**
+     * Optional flag for filtering active subscriptions
+     */
+    active?: boolean;
+};
+export interface IUpdateNotificationSpec {
+    /** Description of the notification spec */
+    description?: string;
+    /** Name identifier for the notification spec */
+    name?: string;
+}
+export interface ICreateNotificationSpec {
+    /** Description of the notification spec */
+    description?: string;
+    /** Name identifier for the notification spec */
+    name: string;
+}
+export interface IUpdateUser {
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+export interface ICreateUser {
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    agoId?: string;
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+/**
+ * Metadata for the subscription
+ */
+export declare type ISubscribeMetadata = ICreateEventMetadata | ICreateTelemetryReportMetadata;
+export declare type ISubscriptionMetadata = {
+    [key: string]: any;
+};
+export interface IUser {
+    agoId: string;
+    createdAt: string;
+    deleted: boolean;
+    email: string;
+    firstName: string;
+    lastName: string;
+    optedOut: boolean;
+    updatedAt: string;
+    username: string;
+}
+export interface INotificationSpec {
+    createdAt: string;
+    createdById: string;
+    description: string;
+    id: number;
+    name: string;
+    updatedAt: string;
+}
+/**
+ * Metadata for the subscription
+ */
+export declare type ICreateSubscriptionMetadata = ICreateEventMetadata | ICreateTelemetryReportMetadata;
+export declare enum DeliveryMethod {
+    EMAIL = "EMAIL"
+}
+export declare enum Cadence {
+    ON_EVENT = "ON_EVENT",
+    DAILY = "DAILY",
+    WEEKLY = "WEEKLY",
+    MONTHLY = "MONTHLY"
+}
+export interface IUpdateSubscription {
+    /** Flag to opt user in or out of subscription */
+    active?: boolean;
+    /** Frequency of the subscription */
+    cadence?: Cadence;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod?: DeliveryMethod;
+    /** Last delivered datetime string of the subscription in ISO 8601 format */
+    lastDelivery?: string;
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    userId?: string;
+}
+export interface ISubscription {
+    active: boolean;
+    cadence: Cadence;
+    createdAt: string;
+    deliveryMethod: DeliveryMethod;
+    id: number;
+    lastDelivery: string;
+    metadata: ISubscriptionMetadata;
+    notificationSpec?: INotificationSpec;
+    notificationSpecId: number;
+    updatedAt: string;
+    user?: IUser;
+    userId: string;
+}
+export declare enum SystemNotificationSpecNames {
+    TELEMETRY_REPORT = "TELEMETRY_REPORT",
+    EVENT = "EVENT"
+}
+export interface ISubscribe {
+    /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
+    agoId?: string;
+    /** Frequency of the subscription */
+    cadence: Cadence;
+    /** Flag for deleted user */
+    deleted?: boolean;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod: DeliveryMethod;
+    /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
+    email?: string;
+    /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
+    firstName?: string;
+    /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
+    lastName?: string;
+    /** Metadata for the subscription */
+    metadata: ISubscribeMetadata;
+    /** Notification spec name for the subscription */
+    notificationSpecName: SystemNotificationSpecNames;
+    /** Flag for unsubscribed user */
+    optedOut?: boolean;
+    /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
+    username?: string;
+}
+export interface ICreateSubscription {
+    /** Frequency of the subscription */
+    cadence: Cadence;
+    /** Delivery method for subscription, ie email or text */
+    deliveryMethod: DeliveryMethod;
+    /** Metadata for the subscription */
+    metadata: ICreateSubscriptionMetadata;
+    /** Notification spec name for the subscription */
+    notificationSpecName: SystemNotificationSpecNames;
+    /** AGO id for user which subscription belongs to */
+    userId: string;
+}
+export interface ICreateEventMetadata {
+    /** Event id for the subscription */
+    eventId: string;
+}
+export interface ICreateTelemetryReportMetadata {
+    /** Hostname for telemetry report. */
+    hostname: string;
+}
+declare type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+export declare const createSubscription: (iCreateSubscription: ICreateSubscription, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const getSubscriptions: (params?: GetSubscriptionsParams, options?: SecondParameter<typeof customClient>) => Promise<ISubscription[]>;
+export declare const subscribe: (iSubscribe: ISubscribe, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const getSubscription: (id: number, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const updateSubscription: (id: number, iUpdateSubscription: IUpdateSubscription, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const deleteSubscription: (id: number, options?: SecondParameter<typeof customClient>) => Promise<ISubscription>;
+export declare const createUser: (iCreateUser: ICreateUser, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const getUsers: (options?: SecondParameter<typeof customClient>) => Promise<IUser[]>;
+export declare const getUser: (userId: string, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const updateUser: (userId: string, iUpdateUser: IUpdateUser, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const deleteUser: (userId: string, options?: SecondParameter<typeof customClient>) => Promise<IUser>;
+export declare const createNotificationSpec: (iCreateNotificationSpec: ICreateNotificationSpec, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const getNotificationSpecs: (options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec[]>;
+export declare const getNotificationSpec: (id: number, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const updateNotificationSpec: (id: number, iUpdateNotificationSpec: IUpdateNotificationSpec, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare const deleteNotificationSpec: (id: number, options?: SecondParameter<typeof customClient>) => Promise<INotificationSpec>;
+export declare type CreateSubscriptionResult = NonNullable<Awaited<ReturnType<typeof createSubscription>>>;
+export declare type GetSubscriptionsResult = NonNullable<Awaited<ReturnType<typeof getSubscriptions>>>;
+export declare type SubscribeResult = NonNullable<Awaited<ReturnType<typeof subscribe>>>;
+export declare type GetSubscriptionResult = NonNullable<Awaited<ReturnType<typeof getSubscription>>>;
+export declare type UpdateSubscriptionResult = NonNullable<Awaited<ReturnType<typeof updateSubscription>>>;
+export declare type DeleteSubscriptionResult = NonNullable<Awaited<ReturnType<typeof deleteSubscription>>>;
+export declare type CreateUserResult = NonNullable<Awaited<ReturnType<typeof createUser>>>;
+export declare type GetUsersResult = NonNullable<Awaited<ReturnType<typeof getUsers>>>;
+export declare type GetUserResult = NonNullable<Awaited<ReturnType<typeof getUser>>>;
+export declare type UpdateUserResult = NonNullable<Awaited<ReturnType<typeof updateUser>>>;
+export declare type DeleteUserResult = NonNullable<Awaited<ReturnType<typeof deleteUser>>>;
+export declare type CreateNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof createNotificationSpec>>>;
+export declare type GetNotificationSpecsResult = NonNullable<Awaited<ReturnType<typeof getNotificationSpecs>>>;
+export declare type GetNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof getNotificationSpec>>>;
+export declare type UpdateNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof updateNotificationSpec>>>;
+export declare type DeleteNotificationSpecResult = NonNullable<Awaited<ReturnType<typeof deleteNotificationSpec>>>;
+export {};

package/dist/types/newsletters/api/orval/awaited-type.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Orval generates return types for functions using utility type Awaited
+ * This was introduced in Typescript 4.5, but hub.js is using Typescript 3
+ */
+export declare type Awaited<T> = T extends PromiseLike<infer U> ? U : T;

package/dist/types/newsletters/api/orval/custom-client.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated and copied from the [hub engagement repo](https://github.com/ArcGIS/hub-newsletters/blob/master/orval/custom-client.ts)
+ * Do not edit manually
+ */
+export interface IOrvalParams {
+    url: string;
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    headers?: HeadersInit;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
+}
+export interface ICustomParams {
+    hubApiUrl?: string;
+    token?: string;
+    headers?: HeadersInit;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
+    mode?: RequestMode;
+    cache?: RequestCache;
+    credentials?: RequestCredentials;
+}
+export declare function customClient<T>(orvalParams: IOrvalParams, customParams: ICustomParams): Promise<T>;

package/dist/types/newsletters/api/subscriptions.d.ts

@@ -0,0 +1,36 @@
+import { ISubscribeParams, ISubscription, ICreateSubscriptionParams, IGetSubscriptionsParams, IGetSubscriptionParams, IUpdateSubscriptionParams } from "./types";
+/**
+ * create a subscription for user (existing or not) to a newsletter
+ *
+ * @param {ISubscribeParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function subscribe(options: ISubscribeParams): Promise<ISubscription>;
+/**
+ * create a subscription for user (existing) to a newsletter
+ *
+ * @param {ICreateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function createSubscription(options: ICreateSubscriptionParams): Promise<ISubscription>;
+/**
+ * get subscriptions
+ *
+ * @param {IGetSubscriptionsParams} options
+ * @return {Promise<ISubscription[]>}
+ */
+export declare function getSubscriptions(options: IGetSubscriptionsParams): Promise<ISubscription[]>;
+/**
+ * get a subscription
+ *
+ * @param {IGetSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function getSubscription(options: IGetSubscriptionParams): Promise<ISubscription>;
+/**
+ * update a subscription
+ *
+ * @param {IUpdateSubscriptionParams} options
+ * @return {Promise<ISubscription>}
+ */
+export declare function updateSubscription(options: IUpdateSubscriptionParams): Promise<ISubscription>;

package/dist/types/newsletters/api/types.d.ts

@@ -0,0 +1,47 @@
+export { Cadence, DeliveryMethod, ICreateEventMetadata, ICreateTelemetryReportMetadata, INotificationSpec, ISubscribeMetadata, ISubscription, ISubscriptionMetadata, IUser, SystemNotificationSpecNames, } from "./orval/api/orval-newsletters";
+import { IHubRequestOptions } from "../../types";
+import { GetSubscriptionsParams, ICreateSubscription, ICreateUser, ISubscribe, IUpdateSubscription, IUpdateUser } from "./orval/api/orval-newsletters";
+/**
+ * options for making requests against the Newsletters API
+ *
+ * @export
+ * @interface INewslettersRequestOptions
+ * @extends IHubRequestOptions
+ */
+export interface INewslettersRequestOptions extends Omit<IHubRequestOptions, "httpMethod" | "isPortal">, Pick<RequestInit, "mode" | "cache" | "credentials"> {
+    httpMethod?: "GET" | "POST" | "PATCH" | "DELETE";
+    isPortal?: boolean;
+    token?: string;
+    data?: {
+        [key: string]: any;
+    };
+}
+export interface ICreateUserParams extends INewslettersRequestOptions {
+    data: ICreateUser;
+}
+export interface IGetUserParams extends INewslettersRequestOptions {
+    userId: string;
+}
+export interface IUpdateUserParams extends INewslettersRequestOptions {
+    userId: string;
+    data: IUpdateUser;
+}
+export interface IDeleteUserParams extends INewslettersRequestOptions {
+    userId: string;
+}
+export interface ISubscribeParams extends INewslettersRequestOptions {
+    data: ISubscribe;
+}
+export interface ICreateSubscriptionParams extends INewslettersRequestOptions {
+    data: ICreateSubscription;
+}
+export interface IGetSubscriptionsParams extends INewslettersRequestOptions {
+    data: GetSubscriptionsParams;
+}
+export interface IGetSubscriptionParams extends INewslettersRequestOptions {
+    subscriptionId: number;
+}
+export interface IUpdateSubscriptionParams extends INewslettersRequestOptions {
+    subscriptionId: number;
+    data: IUpdateSubscription;
+}

package/dist/types/newsletters/api/users.d.ts

@@ -0,0 +1,29 @@
+import { ICreateUserParams, IDeleteUserParams, IGetUserParams, IUpdateUserParams, IUser } from "./types";
+/**
+ * create a user
+ *
+ * @param {ICreateUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function createUser(options: ICreateUserParams): Promise<IUser>;
+/**
+ * get a user
+ *
+ * @param {IGetUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function getUser(options: IGetUserParams): Promise<IUser>;
+/**
+ * update a user
+ *
+ * @param {IUpdateUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function updateUser(options: IUpdateUserParams): Promise<IUser>;
+/**
+ * delete a user
+ *
+ * @param {IDeleteUserParams} options
+ * @return {Promise<IUser>}
+ */
+export declare function deleteUser(options: IDeleteUserParams): Promise<IUser>;

package/dist/types/newsletters/api/utils/authenticate-request.d.ts

@@ -0,0 +1,9 @@
+import { INewslettersRequestOptions } from "../types";
+/**
+ * return a token created using options.authentication or set on options.token
+ *
+ * @export
+ * @param {INewslettersRequestOptions} options
+ * @return {*}  {Promise<string>}
+ */
+export declare function authenticateRequest(options: INewslettersRequestOptions): Promise<string>;

package/dist/types/newsletters/index.d.ts

@@ -0,0 +1 @@
+export * from "./api";

package/dist/types/surveys/utils/get-s123-edit-url.d.ts

@@ -0,0 +1,2 @@
+import { IArcGISContext } from "../../ArcGISContext";
+export declare function getS123EditUrl(id: string, context: IArcGISContext): string;

package/dist/types/surveys/utils/index.d.ts

@@ -3,6 +3,7 @@ export * from "./get-form-info-json";
 export * from "./get-form-json";
 export * from "./get-input-feature-service-model";
 export * from "./get-map-question";
+export * from "./get-s123-edit-url";
 export * from "./get-s123-share-url";
 export * from "./get-source-feature-service-model-from-fieldworker";
 export * from "./get-stakeholder-model";

package/package.json

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