@esri/hub-common 14.98.1 → 14.99.0

package/dist/node/surveys/utils/get-source-feature-service-model-from-fieldworker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-source-feature-service-model-from-fieldworker.js","sourceRoot":"","sources":["../../../../src/surveys/utils/get-source-feature-service-model-from-fieldworker.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAGhB,iEAA2D;AAG3D;;;;;;GAMG;AACU,QAAA,2CAA2C,GAAG,CACzD,aAAqB,EACrB,cAA+B,EACd,EAAE;IACnB,OAAO,oCAAe,iBACpB,EAAE,EAAE,aAAa,EACjB,gBAAgB,EAAE,cAAc,EAChC,SAAS,EAAE,SAAS,IACjB,cAAc,EACjB,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE;QAC7C,IAAI,KAAK,CAAC;QACV,IAAI,cAAc,EAAE;YAClB,KAAK,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;SAClC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/node/surveys/utils/get-stakeholder-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-stakeholder-model.js","sourceRoot":"","sources":["../../../../src/surveys/utils/get-stakeholder-model.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAGhB,iEAA2D;AAG3D;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,CACjC,MAAc,EACd,cAA+B,EACd,EAAE;IACnB,OAAO,oCAAe,iBACpB,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,aAAa,EAC/B,SAAS,EAAE,SAAS,IACjB,cAAc,EACjB,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE;QAC9C,IAAI,KAAK,CAAC;QACV,IAAI,eAAe,EAAE;YACnB,KAAK,GAAG,EAAE,IAAI,EAAE,eAAe,EAAY,CAAC;SAC7C;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/node/surveys/utils/get-survey-models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-survey-models.js","sourceRoot":"","sources":["../../../../src/surveys/utils/get-survey-models.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAGhB,iEAA0D;AAE1D,uFAAgF;AAChF,2HAAkH;AAClH,mEAA8D;AAC9D,+DAA0D;AAE1D;;;;;GAKG;AACU,QAAA,eAAe,GAAG,CAC7B,YAA4B,EAC5B,cAA+B,EACI,EAAE;IACrC,IAAI,WAAmB,CAAC;IACxB,IAAI,WAAmB,CAAC;IAExB,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,OAAO,YAAY,KAAK,QAAQ;QAC9B,CAAC,CAAC,4BAAO,CAAC,YAAY,EAAE,cAAc,CAAC;QACvC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAEpC,OAAO,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,MAAM,QAAQ,GAA2B;YACvC,sEAAsE;YACtE,8BAA8B;YAC9B,6DAA2B,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC;YACpD,2CAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC;SAC7C,CAAC;QAEF,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;aACzB,IAAI,CAAC,CAAC,CAAC,sCAAsC,EAAE,iBAAiB,CAAC,EAAE,EAAE;YACpE,WAAW,GAAG,iBAAiB,CAAC;YAEhC,IACE,sCAAsC;gBACtC,uCAAiB,CAAC,sCAAsC,CAAC,IAAI,CAAC,EAC9D;gBACA,WAAW,GAAG,sCAAsC,CAAC;gBACrD,iDAAiD;gBACjD,6BAA6B;gBAC7B,OAAO,+FAA2C,CAChD,WAAW,CAAC,IAAI,CAAC,EAAE,EACnB,cAAc,CACf,CAAC;aACH;iBAAM;gBACL,OAAO,sCAAsC,CAAC;aAC/C;QACH,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;YACvB,OAAO;gBACL,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;gBACpB,cAAc;gBACd,WAAW;gBACX,WAAW;aACZ,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/node/surveys/utils/has-map-question.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasMapQuestion = void 0;
+const get_map_question_1 = require("./get-map-question");
+/**
+ * Determines if the given Array of questions contains
+ * a map question
+ * @param {Array} questions An array of questions
+ * @returns {boolean}
+ */
+exports.hasMapQuestion = (questions) => {
+    return Boolean(get_map_question_1.getMapQuestion(questions));
+};
+//# sourceMappingURL=has-map-question.js.map

package/dist/node/surveys/utils/has-map-question.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-map-question.js","sourceRoot":"","sources":["../../../../src/surveys/utils/has-map-question.ts"],"names":[],"mappings":";;;AACA,yDAAoD;AAEpD;;;;;GAKG;AACU,QAAA,cAAc,GAAG,CAAC,SAA0B,EAAE,EAAE;IAC3D,OAAO,OAAO,CAAC,iCAAc,CAAC,SAAS,CAAC,CAAC,CAAC;AAC5C,CAAC,CAAC"}

package/dist/node/surveys/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./decode-form"), exports);
+tslib_1.__exportStar(require("./get-form-info-json"), exports);
+tslib_1.__exportStar(require("./get-form-json"), exports);
+tslib_1.__exportStar(require("./get-input-feature-service-model"), exports);
+tslib_1.__exportStar(require("./get-map-question"), exports);
+tslib_1.__exportStar(require("./get-source-feature-service-model-from-fieldworker"), exports);
+tslib_1.__exportStar(require("./get-stakeholder-model"), exports);
+tslib_1.__exportStar(require("./get-survey-models"), exports);
+tslib_1.__exportStar(require("./has-map-question"), exports);
+tslib_1.__exportStar(require("./is-fieldworker-view"), exports);
+tslib_1.__exportStar(require("./is-map-question"), exports);
+tslib_1.__exportStar(require("./is-page-question"), exports);
+tslib_1.__exportStar(require("./is-survey123-connect"), exports);
+tslib_1.__exportStar(require("./set-display-map-keyword"), exports);
+tslib_1.__exportStar(require("./should-display-map"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/surveys/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/surveys/utils/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,+DAAqC;AACrC,0DAAgC;AAChC,4EAAkD;AAClD,6DAAmC;AACnC,8FAAoE;AACpE,kEAAwC;AACxC,8DAAoC;AACpC,6DAAmC;AACnC,gEAAsC;AACtC,4DAAkC;AAClC,6DAAmC;AACnC,iEAAuC;AACvC,oEAA0C;AAC1C,+DAAqC"}

package/dist/node/surveys/utils/is-fieldworker-view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-fieldworker-view.js","sourceRoot":"","sources":["../../../../src/surveys/utils/is-fieldworker-view.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,kBAAyB;IACzD,MAAM,cAAc,GAAG,CAAC,WAAmB,EAAW,EAAE,CACtD,kBAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAE5D,kEAAkE;IAClE,IAAI,aAAa,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAEtD,wDAAwD;IACxD,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,uBAAuB,GAAG;YAC9B,WAAW;YACX,iBAAiB;YACjB,cAAc;SACf,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACxB,aAAa;YACX,uBAAuB,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;KACjE;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,8CAmBC"}

package/dist/node/surveys/utils/is-map-question.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMapQuestion = void 0;
+/**
+ * Determines if the given question is a map question
+ * @param {Object} question A question object
+ * @returns {boolean}
+ */
+exports.isMapQuestion = (question) => {
+    const { type, maps = [], defaultMap } = question;
+    const types = [
+        "esriQuestionTypeGeoPoint",
+        "esriQuestionTypePolyline",
+        "esriQuestionTypePolygon",
+    ];
+    const isType = types.includes(type);
+    return isType && (maps.length > 0 || defaultMap);
+};
+//# sourceMappingURL=is-map-question.js.map

package/dist/node/surveys/utils/is-map-question.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-map-question.js","sourceRoot":"","sources":["../../../../src/surveys/utils/is-map-question.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACU,QAAA,aAAa,GAAG,CAAC,QAAuB,EAAE,EAAE;IACvD,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACjD,MAAM,KAAK,GAAG;QACZ,0BAA0B;QAC1B,0BAA0B;QAC1B,yBAAyB;KAC1B,CAAC;IACF,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC;AACnD,CAAC,CAAC"}

package/dist/node/surveys/utils/is-page-question.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPageQuestion = void 0;
+/**
+ * Determines if the given question is actually a page of questions
+ * @param {Object} question A question object
+ * @returns {boolean}
+ */
+exports.isPageQuestion = (question) => {
+    return question.type === "esriQuestionTypePage";
+};
+//# sourceMappingURL=is-page-question.js.map

package/dist/node/surveys/utils/is-page-question.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-page-question.js","sourceRoot":"","sources":["../../../../src/surveys/utils/is-page-question.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACU,QAAA,cAAc,GAAG,CAAC,QAAuB,EAAE,EAAE;IACxD,OAAO,QAAQ,CAAC,IAAI,KAAK,sBAAsB,CAAC;AAClD,CAAC,CAAC"}

package/dist/node/surveys/utils/is-survey123-connect.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSurvey123Connect = void 0;
+/**
+ * Returns true if the given Form item is a Survey123 Connect
+ * survey
+ * @param {IItem} formItem The Form item
+ * @returns {boolean}
+ */
+exports.isSurvey123Connect = (formItem) => {
+    var _a;
+    const results = false;
+    if (formItem) {
+        const typeKeywords = (_a = formItem.typeKeywords) !== null && _a !== void 0 ? _a : [];
+        return typeKeywords.includes("Survey123 Connect");
+    }
+    return results;
+};
+//# sourceMappingURL=is-survey123-connect.js.map

package/dist/node/surveys/utils/is-survey123-connect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-survey123-connect.js","sourceRoot":"","sources":["../../../../src/surveys/utils/is-survey123-connect.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACU,QAAA,kBAAkB,GAAG,CAAC,QAAe,EAAE,EAAE;;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC;IACtB,IAAI,QAAQ,EAAE;QACZ,MAAM,YAAY,SAAG,QAAQ,CAAC,YAAY,mCAAI,EAAE,CAAC;QACjD,OAAO,YAAY,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;KACnD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}

package/dist/node/surveys/utils/set-display-map-keyword.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDisplayMapKeyword = void 0;
+const constants_1 = require("../constants");
+/**
+ * Adds or removes MAP_SURVEY_TYPEKEYWORD type keyword and returns the updated list
+ * @param {IGroup|IHubContent|IHubItemEntity} subject
+ * @param {boolean} displayMap
+ * @returns {string[]} updated list of type keywords
+ */
+function setDisplayMapKeyword(typeKeywords, displayMap) {
+    const updatedTypeKeywords = (typeKeywords || []).filter((typeKeyword) => typeKeyword !== constants_1.MAP_SURVEY_TYPEKEYWORD);
+    if (displayMap) {
+        updatedTypeKeywords.push(constants_1.MAP_SURVEY_TYPEKEYWORD);
+    }
+    return updatedTypeKeywords;
+}
+exports.setDisplayMapKeyword = setDisplayMapKeyword;
+//# sourceMappingURL=set-display-map-keyword.js.map

package/dist/node/surveys/utils/set-display-map-keyword.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-display-map-keyword.js","sourceRoot":"","sources":["../../../../src/surveys/utils/set-display-map-keyword.ts"],"names":[],"mappings":";;;AAAA,4CAAsD;AAEtD;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,YAAsB,EACtB,UAAmB;IAEnB,MAAM,mBAAmB,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,MAAM,CACrD,CAAC,WAAmB,EAAE,EAAE,CAAC,WAAW,KAAK,kCAAsB,CAChE,CAAC;IACF,IAAI,UAAU,EAAE;QACd,mBAAmB,CAAC,IAAI,CAAC,kCAAsB,CAAC,CAAC;KAClD;IACD,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAXD,oDAWC"}

package/dist/node/surveys/utils/should-display-map.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldDisplayMap = void 0;
+const constants_1 = require("../constants");
+/**
+ * Determines the display mode of the given survey
+ * @param {Object} formItem A Form item
+ * @returns {boolean}
+ */
+exports.shouldDisplayMap = (item) => {
+    return (item.type === "Form" && item.typeKeywords.includes(constants_1.MAP_SURVEY_TYPEKEYWORD));
+};
+//# sourceMappingURL=should-display-map.js.map

package/dist/node/surveys/utils/should-display-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"should-display-map.js","sourceRoot":"","sources":["../../../../src/surveys/utils/should-display-map.ts"],"names":[],"mappings":";;;AACA,4CAAsD;AAEtD;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,CAAC,IAAW,EAAE,EAAE;IAC9C,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,kCAAsB,CAAC,CAC3E,CAAC;AACJ,CAAC,CAAC"}

package/dist/types/core/schemas/types.d.ts

@@ -12,7 +12,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -36,7 +36,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat", "hub:card:
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:card:stat", "hub:card:follow"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:card:stat", "hub:card:follow"];
 /**
  * An editor's module when dynamically imported depending on the EditorType. This
  * will always have a buildUiSchema function, and sometimes it will have a
@@ -174,3 +174,18 @@ export interface IUiSchemaCondition {
     scope?: string;
     schema: IConfigurationSchema;
 }
+export interface IUiSchemaMessage {
+    type: UiSchemaMessageTypes;
+    display?: "message" | "notice";
+    keyword?: string;
+    title?: string;
+    titleKey?: string;
+    label?: string;
+    labelKey?: string;
+    icon?: boolean | string;
+    kind?: "brand" | "danger" | "info" | "success" | "warning";
+    hidden?: boolean;
+    condition?: IUiSchemaCondition;
+    allowShowBeforeInteract?: boolean;
+    alwaysShow?: boolean;
+}

package/dist/types/core/types/HubEntity.d.ts

@@ -5,4 +5,5 @@ import { IHubSite } from "./IHubSite";
 import { IHubDiscussion } from "./IHubDiscussion";
 import { IHubGroup } from "./IHubGroup";
 import { IHubTemplate } from "./IHubTemplate";
-export declare type HubEntity = IHubSite | IHubProject | IHubDiscussion | IHubInitiative | IHubPage | IHubGroup | IHubTemplate;
+import { IHubSurvey } from "./IHubSurvey";
+export declare type HubEntity = IHubSite | IHubProject | IHubDiscussion | IHubInitiative | IHubPage | IHubGroup | IHubTemplate | IHubSurvey;

package/dist/types/core/types/HubEntityType.d.ts

@@ -1,2 +1,2 @@
-export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "initiativeTemplate", "page", "discussion", "content", "org", "group", "template"];
+export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "initiativeTemplate", "page", "discussion", "content", "org", "group", "template", "survey"];
 export declare type HubEntityType = (typeof HUB_ENTITY_TYPES)[number];

package/dist/types/core/types/IHubSurvey.d.ts

@@ -0,0 +1,11 @@
+import { IWithPermissions } from "../traits";
+import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
+/**
+ * Defines properties of Hub Survey object
+ * @internal
+ */
+export interface IHubSurvey extends IHubItemEntity, IWithPermissions {
+    hasMapQuestion: boolean;
+    displayMap: boolean;
+}
+export declare type IHubSurveyEditor = IHubItemEntityEditor<IHubSurvey> & {};

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

@@ -9,6 +9,7 @@ export * from "./IHubDiscussion";
 export * from "./IHubEditableContent";
 export * from "./IHubEntityBase";
 export * from "./IHubEvent";
+export * from "./IHubSurvey";
 export * from "./IHubGroup";
 export * from "./IHubImage";
 export * from "./IHubInitiative";

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from "./i18n";
 export * from "./initiatives";
 export * from "./initiative-templates";
 export * from "./discussions";
+export * from "./surveys";
 export * from "./items";
 export * from "./models";
 export * from "./objects";
@@ -25,7 +26,6 @@ export * from "./request";
 export * from "./resources";
 export * from "./search";
 export * from "./sites";
-export * from "./surveys";
 export * from "./templates";
 export * from "./types";
 export * from "./urls";

package/dist/types/permissions/types/Permission.d.ts

@@ -8,6 +8,7 @@ import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
 import { PlatformPermissions } from "../PlatformPermissionPolicies";
 import { InitiativeTemplatePermissions } from "../../initiative-templates/_internal/InitiativeTemplateBusinessRules";
 import { TemplatePermissions } from "../../templates/_internal/TemplateBusinessRules";
+import { SurveyPermissions } from "../../surveys/_internal/SurveyBusinessRules";
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -18,7 +19,7 @@ declare const SystemPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number];
+export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number] | (typeof SurveyPermissions)[number];
 /**
  * Validate a Permission
  * @param permission

package/dist/types/surveys/HubSurvey.d.ts

@@ -0,0 +1,50 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubItemEntity } from "../core/HubItemEntity";
+import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { IEditorConfig } from "../core/schemas/types";
+import { HubEntityEditor, IEntityEditorContext } from "../core/types/HubEntityEditor";
+import { IHubSurvey } from "../core/types/IHubSurvey";
+import { SurveyEditorType } from "./_internal/SurveySchema";
+/**
+ * Hub Survey Class
+ */
+export declare class HubSurvey extends HubItemEntity<IHubSurvey> implements IWithEditorBehavior {
+    /**
+     * Create an instance from a HubSurvey object
+     * @param json - JSON object to create a HubSurvey from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json: Partial<IHubSurvey>, context: IArcGISContext): HubSurvey;
+    private static applyDefaults;
+    /**
+     * Apply a new state to the instance
+     * @param changes A partial IHubSurvey
+     */
+    update(changes: Partial<IHubSurvey>): void;
+    /**
+     * Save the class instance
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubSurvey object from the store
+     * set a flag to indicate that it is destroyed
+     * @returns a promise
+     */
+    delete(): Promise<void>;
+    getEditorConfig(i18nScope: string, type: SurveyEditorType): Promise<IEditorConfig>;
+    /**
+     * Return the Survey object as an editor object
+     * @param editorContext
+     * @param include
+     * @returns
+     */
+    toEditor(editorContext?: IEntityEditorContext, include?: string[]): Promise<HubEntityEditor>;
+    /**
+     * Load the Survey object from the editor object
+     * @param editor
+     * @param editorContext
+     * @returns IHubSurvey
+     */
+    fromEditor(editor: HubEntityEditor, editorContext?: IEntityEditorContext): Promise<IHubSurvey>;
+}

package/dist/types/surveys/_internal/SurveyBusinessRules.d.ts

@@ -0,0 +1,12 @@
+import { IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
+/**
+ * survey Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const SurveyPermissions: readonly ["hub:survey", "hub:survey:create", "hub:survey:delete", "hub:survey:edit", "hub:survey:view", "hub:survey:workspace", "hub:survey:workspace:dashboard", "hub:survey:workspace:details", "hub:survey:workspace:settings", "hub:survey:manage"];
+/**
+ * Survey permission policies
+ * @private
+ */
+export declare const SurveyPermissionPolicies: IPermissionPolicy[];

package/dist/types/surveys/_internal/SurveySchema.d.ts

@@ -0,0 +1,7 @@
+import { IConfigurationSchema } from "../../core/schemas/types";
+export declare type SurveyEditorType = (typeof SurveyEditorTypes)[number];
+export declare const SurveyEditorTypes: readonly ["hub:survey:edit", "hub:survey:settings"];
+/**
+ * defines the JSON schema for a Survey entity's editable fields
+ */
+export declare const SurveySchema: IConfigurationSchema;

package/dist/types/surveys/_internal/SurveyUiSchemaEdit.d.ts

@@ -0,0 +1,10 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+import { IHubSurvey } from "../../core/types/IHubSurvey";
+/**
+ * @private
+ * constructs the complete edit uiSchema for Hub Survey.
+ * This defines how the schema properties should be
+ * rendered in the survey editing experience
+ */
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubSurvey>, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/surveys/_internal/SurveyUiSchemaSettings.d.ts

@@ -0,0 +1,10 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @private
+ * settings uiSchema for Hub Survey - this
+ * defines how the schema properties should be
+ * rendered in the Survey settings experience
+ */
+export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/surveys/_internal/computeProps.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubSurvey } from "../../core/types/IHubSurvey";
+import { IModel } from "../../types";
+/**
+ * Given a model and a Survey object, set various computed properties that can't be directly mapped
+ * @private
+ * @param model
+ * @param survey
+ * @param requestOptions
+ * @returns an IHubSurvey object
+ */
+export declare function computeProps(model: IModel, survey: Partial<IHubSurvey>, requestOptions: IRequestOptions): IHubSurvey;

package/dist/types/surveys/_internal/getPropertyMap.d.ts

@@ -0,0 +1,8 @@
+import { IPropertyMap } from "../../core/_internal/PropertyMapper";
+/**
+ * Returns an Array of IPropertyMap objects
+ * that define the projection of properties from a IModel to an IHubSurvey object
+ * @returns an IPropertyMap array
+ * @private
+ */
+export declare function getPropertyMap(): IPropertyMap[];

package/dist/types/surveys/constants.d.ts

@@ -0,0 +1 @@
+export declare const MAP_SURVEY_TYPEKEYWORD = "hubMapSurvey";

package/dist/types/surveys/defaults.d.ts

@@ -0,0 +1,3 @@
+import { IHubSurvey } from "../core/types/IHubSurvey";
+/** Default values for a new IHubSurvey */
+export declare const DEFAULT_SURVEY: Partial<IHubSurvey>;

package/dist/types/surveys/edit.d.ts

@@ -0,0 +1,17 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IHubSurvey } from "../core/types/IHubSurvey";
+/**
+ * @private
+ * Update a Hub Survey obejct
+ * @param survey the survey to update
+ * @param requestOptions user request options
+ * @returns promise that resolves a IHubSurvey
+ */
+export declare function updateSurvey(survey: IHubSurvey, requestOptions: IUserRequestOptions): Promise<IHubSurvey>;
+/**
+ * @private
+ * Remove a Hub Survey object
+ * @param id
+ * @param requestOptions
+ */
+export declare function deleteSurvey(id: string, requestOptions: IUserRequestOptions): Promise<void>;

package/dist/types/surveys/fetch.d.ts

@@ -0,0 +1,20 @@
+import { IItem } from "@esri/arcgis-rest-types";
+import { IHubSurvey } from "../core/types/IHubSurvey";
+import { IHubRequestOptions } from "../types";
+/**
+ * @private
+ * Get a Survey entity by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions request options
+ * @returns a promise that resolves a IHubSurvey object
+ */
+export declare function fetchSurvey(identifier: string, requestOptions: IHubRequestOptions): Promise<IHubSurvey>;
+/**
+ * @private
+ * Convert a Hub Survey Item into a Hub Survey entity, fetching any additional
+ * information that may be required
+ * @param item the Survey item
+ * @param auth request options
+ * @returns a promise that resolves a IHubSurvey object
+ */
+export declare function convertItemToSurvey(item: IItem, requestOptions: IHubRequestOptions): Promise<IHubSurvey>;

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

@@ -1,5 +1,6 @@
-export * from "./get-input-feature-service-model";
-export * from "./get-source-feature-service-model-from-fieldworker";
-export * from "./get-stakeholder-model";
-export * from "./get-survey-models";
-export * from "./is-fieldworker-view";
+export * from "./HubSurvey";
+export * from "./edit";
+export * from "./fetch";
+export * from "./constants";
+export * from "./types";
+export * from "./utils";

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

@@ -0,0 +1,15 @@
+export interface IS123Question {
+    id: string;
+    type: string;
+    maps?: Array<{
+        type: string;
+        itemId: string;
+        name: string;
+    }>;
+    questions?: IS123Question[];
+    [key: string]: any;
+}
+export interface IS123FormJSON {
+    questions: IS123Question[];
+    [key: string]: any;
+}

package/dist/types/surveys/utils/decode-form.d.ts

@@ -0,0 +1,8 @@
+import { IS123FormJSON, IS123Question } from "../types";
+/**
+ * Decodes certain properties of the Survey Form json into html
+ * @param {IS123FormJSON} form
+ */
+export declare const decodeForm: (form: IS123FormJSON) => {
+    questions: IS123Question[];
+};

package/dist/types/surveys/utils/get-form-info-json.d.ts

@@ -0,0 +1,9 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * This returns the /info/forminfo.json which simply has the form name and type.
+ * We need the name so we can make the getFormInfo call
+ * @param {string} id
+ * @param {IRequestOptions} requestOptions
+ * @returns {Promise}
+ */
+export declare const getFormInfoJson: (id: string, requestOptions: IRequestOptions) => Promise<any>;

package/dist/types/surveys/utils/get-form-json.d.ts

@@ -0,0 +1,8 @@
+import { IGetItemInfoOptions, IItem } from "@esri/arcgis-rest-portal";
+/**
+ * Given a Survey Item, return the form json, if it exists.
+ * @param {IItem} the survey item
+ * @param {IGetItemInfoOptions} requestOptions
+ * @returns {Promise}
+ */
+export declare const getFormJson: (item: IItem, requestOptions: IGetItemInfoOptions) => Promise<any>;

package/dist/types/surveys/{get-input-feature-service-model.d.ts → utils/get-input-feature-service-model.d.ts}

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
+import { IModel } from "../../types";
 /**
  * Gets the primary input Feature Service for the given
  * Form ID. This will be the Fieldworker view, if it exists,

package/dist/types/surveys/utils/get-map-question.d.ts

@@ -0,0 +1,7 @@
+import { IS123Question } from "../types";
+/**
+ * Gets the map question from an Array of questions
+ * @param {Array} questions An array of questions
+ * @returns {Object}
+ */
+export declare const getMapQuestion: (questions: IS123Question[]) => IS123Question;

package/dist/types/surveys/{get-source-feature-service-model-from-fieldworker.d.ts → utils/get-source-feature-service-model-from-fieldworker.d.ts}

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
+import { IModel } from "../../types";
 /**
  * Fetches a Survey's source Feature Service from a given
  * Fieldworker View ID

package/dist/types/surveys/{get-stakeholder-model.d.ts → utils/get-stakeholder-model.d.ts}

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
+import { IModel } from "../../types";
 /**
  * Fetches a Survey's Stakeholder View for a given
  * Form ID

package/dist/types/surveys/{get-survey-models.d.ts → utils/get-survey-models.d.ts}

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { IGetSurveyModelsResponse } from "../types";
+import { IGetSurveyModelsResponse } from "../../types";
 /**
  * Builds a dictionary of Survey items for the given Form model
  * @param {string} formId The Form ID of the survey

package/dist/types/surveys/utils/has-map-question.d.ts

@@ -0,0 +1,8 @@
+import { IS123Question } from "../types";
+/**
+ * Determines if the given Array of questions contains
+ * a map question
+ * @param {Array} questions An array of questions
+ * @returns {boolean}
+ */
+export declare const hasMapQuestion: (questions: IS123Question[]) => boolean;

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

@@ -0,0 +1,15 @@
+export * from "./decode-form";
+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-source-feature-service-model-from-fieldworker";
+export * from "./get-stakeholder-model";
+export * from "./get-survey-models";
+export * from "./has-map-question";
+export * from "./is-fieldworker-view";
+export * from "./is-map-question";
+export * from "./is-page-question";
+export * from "./is-survey123-connect";
+export * from "./set-display-map-keyword";
+export * from "./should-display-map";

package/dist/types/surveys/utils/is-map-question.d.ts

@@ -0,0 +1,7 @@
+import { IS123Question } from "../types";
+/**
+ * Determines if the given question is a map question
+ * @param {Object} question A question object
+ * @returns {boolean}
+ */
+export declare const isMapQuestion: (question: IS123Question) => any;

package/dist/types/surveys/utils/is-page-question.d.ts

@@ -0,0 +1,7 @@
+import { IS123Question } from "../types";
+/**
+ * Determines if the given question is actually a page of questions
+ * @param {Object} question A question object
+ * @returns {boolean}
+ */
+export declare const isPageQuestion: (question: IS123Question) => boolean;

package/dist/types/surveys/utils/is-survey123-connect.d.ts

@@ -0,0 +1,8 @@
+import { IItem } from "@esri/arcgis-rest-types";
+/**
+ * Returns true if the given Form item is a Survey123 Connect
+ * survey
+ * @param {IItem} formItem The Form item
+ * @returns {boolean}
+ */
+export declare const isSurvey123Connect: (formItem: IItem) => boolean;

package/dist/types/surveys/utils/set-display-map-keyword.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Adds or removes MAP_SURVEY_TYPEKEYWORD type keyword and returns the updated list
+ * @param {IGroup|IHubContent|IHubItemEntity} subject
+ * @param {boolean} displayMap
+ * @returns {string[]} updated list of type keywords
+ */
+export declare function setDisplayMapKeyword(typeKeywords: string[], displayMap: boolean): string[];