@esri/hub-common 9.14.1 → 9.17.1

package/dist/node/projects/HubProjectManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubProjectManager.js","sourceRoot":"","sources":["../../../src/projects/HubProjectManager.ts"],"names":[],"mappings":";;;AAEA,+CAKuB;AACvB,mDAAmD;AACnD,kEAA+D;AAC/D,0BAA8C;AAG9C;;;;;;GAMG;AACH,MAAa,iBAAiB;IAgB5B;;;;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,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IACjD,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;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAA6B,EAC7B,cAAoC;QAEpC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,0BAA0B;YAC1B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBACtB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;aAChD;YACD,OAAO,2BAAa,CAClB,OAAO,EACP,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAClD,CAAC;SACH;aAAM;YACL,MAAM,IAAI,YAAQ,CAChB,gBAAgB,EAChB,gDAAgD,CACjD,CAAC;SACH;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAoB,EACpB,cAAoC;QAEpC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,OAAO,2BAAa,CAClB,OAAO,EACP,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAClD,CAAC;SACH;aAAM;YACL,MAAM,IAAI,YAAQ,CAChB,gBAAgB,EAChB,gDAAgD,CACjD,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,cAAoC;QAEpC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YAClD,OAAO,4BAAc,CACnB,EAAE,EACF,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAClD,CAAC;SACH;aAAM;YACL,MAAM,IAAI,YAAQ,CAChB,iBAAiB,EACjB,kDAAkD,CACnD,CAAC;SACH;IACH,CAAC;IACD;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACT,UAAkB,EAClB,cAAgC;QAEhC,IAAI,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YACjD,OAAO,wBAAU,CACf,UAAU,EACV,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAC9C,CAAC;SACH;aAAM;YACL,MAAM,IAAI,YAAQ,CAChB,aAAa,EACb,4GAA4G,CAC7G,CAAC;SACH;IACH,CAAC;CAgBF;AAzKD,8CAyKC"}

package/dist/node/projects/HubProjects.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destroyProject = exports.getProject = exports.updateProject = exports.createProject = exports.HUB_PROJECT_ITEM_TYPE = void 0;
+// Note - we separate these imports so we can cleanly spy on things in tests
+const models_1 = require("../models");
+const slugs_1 = require("../items/slugs");
+const __1 = require("..");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const PropertyMapper_1 = require("../core/helpers/PropertyMapper");
+exports.HUB_PROJECT_ITEM_TYPE = "Web Mapping Application";
+/**
+ * Default values of a IHubProject
+ */
+const DEFAULT_PROJECT = {
+    name: "No title provided",
+    tags: [],
+    typeKeywords: ["IHubProject", "HubProject"],
+};
+/**
+ * Default values for a new HubProject Model
+ */
+const DEFAULT_PROJECT_MODEL = {
+    item: {
+        type: exports.HUB_PROJECT_ITEM_TYPE,
+        title: "No Title Provided",
+        description: "No Description Provided",
+        snippet: "",
+        tags: [],
+        typeKeywords: [],
+        properties: {
+            slug: "",
+        },
+    },
+    data: {
+        display: "about",
+        timeline: {},
+        org: {},
+        status: "inactive",
+        contacts: [],
+        schemaVersion: 1,
+    },
+};
+/**
+ * Returns an Array of IPropertyMap objects
+ * We could define these directly, but since the
+ * properties of IHubProject map directly to properties
+ * on item or data, it's slightly less verbose to
+ * generate the structure.
+ * @returns
+ */
+function getProjectPropertyMap() {
+    const itemProps = [
+        "created",
+        "culture",
+        "description",
+        "extent",
+        "id",
+        "modified",
+        "owner",
+        "snippet",
+        "tags",
+        "typeKeywords",
+        "url",
+        "type",
+    ];
+    const dataProps = [
+        "contacts",
+        "display",
+        "geometry",
+        "headerImage",
+        "layout",
+        "location",
+        "status",
+    ];
+    const map = [];
+    itemProps.forEach((entry) => {
+        map.push({ objectKey: entry, modelKey: `item.${entry}` });
+    });
+    dataProps.forEach((entry) => {
+        map.push({ objectKey: entry, modelKey: `data.${entry}` });
+    });
+    // Deeper mappings
+    map.push({
+        objectKey: "slug",
+        modelKey: "item.properties.slug",
+    });
+    map.push({
+        objectKey: "orgUrlKey",
+        modelKey: "item.properties.orgUrlKey",
+    });
+    map.push({
+        objectKey: "name",
+        modelKey: "item.title",
+    });
+    return map;
+}
+/**
+ * Create a new Hub Project item
+ *
+ * Minimal properties are name and org
+ *
+ * @param project
+ * @param requestOptions
+ */
+async function createProject(partialProject, requestOptions) {
+    // merge incoming with the default
+    // this expansion solves the typing somehow
+    const project = Object.assign(Object.assign({}, DEFAULT_PROJECT), partialProject);
+    // Create a slug from the title if one is not passed in
+    if (!project.slug) {
+        project.slug = slugs_1.constructSlug(project.name, project.orgUrlKey);
+    }
+    // Ensure slug is  unique
+    project.slug = await slugs_1.getUniqueSlug(project.slug, requestOptions);
+    // add slug to keywords
+    project.typeKeywords = slugs_1.setSlugKeyword(project.typeKeywords, project.slug);
+    // Map project object onto a default project Model
+    const mapper = new PropertyMapper_1.PropertyMapper(getProjectPropertyMap());
+    // create model from object, using the default model as a starting point
+    let model = mapper.objectToModel(project, __1.cloneObject(DEFAULT_PROJECT_MODEL));
+    // create the item
+    model = await models_1.createModel(model, requestOptions);
+    // map the model back into a IHubProject
+    const newProject = mapper.modelToObject(model, {});
+    // and return it
+    return newProject;
+}
+exports.createProject = createProject;
+/**
+ * Update a Hub Project
+ * @param project
+ * @param requestOptions
+ */
+async function updateProject(project, requestOptions) {
+    // verify that the slug is unique
+    // TODO: if the slug has not changed, we don't want to do this because
+    // the existing item will cause this to increment
+    project.slug = await slugs_1.getUniqueSlug(project.slug, requestOptions);
+    // get the backing item & data
+    const model = await models_1.getModel(project.id, requestOptions);
+    // create the PropertyMapper
+    const mapper = new PropertyMapper_1.PropertyMapper(getProjectPropertyMap());
+    // Note: Although we are fetching the model, and applying changes onto it,
+    // we are not attempting to handle "concurrent edit" conflict resolution
+    // but this is where we would apply that sort of logic
+    const modelToUpdate = mapper.objectToModel(project, model);
+    // update the backing item
+    const updatedModel = await models_1.updateModel(modelToUpdate, requestOptions);
+    // now map back into a project and return that
+    const updatedProject = mapper.modelToObject(updatedModel, project);
+    // the casting is needed because modelToObject returns a `Partial<T>`
+    // where as this function returns a `T`
+    return updatedProject;
+}
+exports.updateProject = updateProject;
+/**
+ * Get a Hub Project by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions
+ */
+function getProject(identifier, requestOptions) {
+    let getPrms;
+    if (__1.isGuid(identifier)) {
+        // get item by id
+        getPrms = models_1.getModel(identifier, requestOptions);
+    }
+    else {
+        // search for item using filter=typekeywords:slug|identifier
+        getPrms = models_1.getModelBySlug(identifier, requestOptions);
+    }
+    return getPrms.then((model) => {
+        // transform the model into a HubProject
+        const mapper = new PropertyMapper_1.PropertyMapper(getProjectPropertyMap());
+        const project = mapper.modelToObject(model, {});
+        return project;
+    });
+}
+exports.getProject = getProject;
+/**
+ * Remove a Hub Project
+ * @param id
+ * @param requestOptions
+ */
+async function destroyProject(id, requestOptions) {
+    const ro = Object.assign(Object.assign({}, requestOptions), { id });
+    await arcgis_rest_portal_1.removeItem(ro);
+    return;
+}
+exports.destroyProject = destroyProject;
+// WIP: Need to resolve how best to execute this
+// i.e. delegate to searchContent or just do an item search
+// and convert to IHubProject objects.
+//
+// export async function searchProjects(
+//   filter: Filter<"content">,
+//   opts: IHubSearchOptions
+// ): Promise<ISearchResponse<IHubProject>> {
+//   return _searchContent(filter, opts).then((results) => {
+//   })
+// }
+//# sourceMappingURL=HubProjects.js.map

package/dist/node/projects/HubProjects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubProjects.js","sourceRoot":"","sources":["../../../src/projects/HubProjects.ts"],"names":[],"mappings":";;;AAEA,4EAA4E;AAC5E,sCAA+E;AAC/E,0CAA8E;AAC9E,0BAQY;AACZ,iEAAwE;AAGxE,mEAA8E;AAGjE,QAAA,qBAAqB,GAAG,yBAAyB,CAAC;AAE/D;;GAEG;AACH,MAAM,eAAe,GAAyB;IAC5C,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,EAAE;IACR,YAAY,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC;CAG5C,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG;IAC5B,IAAI,EAAE;QACJ,IAAI,EAAE,6BAAqB;QAC3B,KAAK,EAAE,mBAAmB;QAC1B,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;QACR,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE;YACV,IAAI,EAAE,EAAE;SACT;KACF;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,EAAE;QACZ,GAAG,EAAE,EAAE;QACP,MAAM,EAAE,UAAU;QAClB,QAAQ,EAAE,EAAE;QACZ,aAAa,EAAE,CAAC;KACjB;CACmB,CAAC;AAEvB;;;;;;;GAOG;AACH,SAAS,qBAAqB;IAC5B,MAAM,SAAS,GAAG;QAChB,SAAS;QACT,SAAS;QACT,aAAa;QACb,QAAQ;QACR,IAAI;QACJ,UAAU;QACV,OAAO;QACP,SAAS;QACT,MAAM;QACN,cAAc;QACd,KAAK;QACL,MAAM;KACP,CAAC;IACF,MAAM,SAAS,GAAG;QAChB,UAAU;QACV,SAAS;QACT,UAAU;QACV,aAAa;QACb,QAAQ;QACR,UAAU;QACV,QAAQ;KACT,CAAC;IACF,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,kBAAkB;IAClB,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,sBAAsB;KACjC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,WAAW;QACtB,QAAQ,EAAE,2BAA2B;KACtC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,aAAa,CACjC,cAAoC,EACpC,cAAmC;IAEnC,kCAAkC;IAClC,2CAA2C;IAC3C,MAAM,OAAO,mCAAQ,eAAe,GAAK,cAAc,CAAE,CAAC;IAE1D,uDAAuD;IACvD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;KAC/D;IACD,yBAAyB;IACzB,OAAO,CAAC,IAAI,GAAG,MAAM,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjE,uBAAuB;IACvB,OAAO,CAAC,YAAY,GAAG,sBAAc,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,kDAAkD;IAClD,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,qBAAqB,EAAE,CACxB,CAAC;IACF,wEAAwE;IACxE,IAAI,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,eAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAC9E,kBAAkB;IAClB,KAAK,GAAG,MAAM,oBAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACjD,wCAAwC;IACxC,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACnD,gBAAgB;IAChB,OAAO,UAAyB,CAAC;AACnC,CAAC;AA5BD,sCA4BC;AAED;;;;GAIG;AACI,KAAK,UAAU,aAAa,CACjC,OAAoB,EACpB,cAAmC;IAEnC,iCAAiC;IACjC,sEAAsE;IACtE,iDAAiD;IACjD,OAAO,CAAC,IAAI,GAAG,MAAM,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjE,8BAA8B;IAC9B,MAAM,KAAK,GAAG,MAAM,iBAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACzD,4BAA4B;IAC5B,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,qBAAqB,EAAE,CACxB,CAAC;IACF,0EAA0E;IAC1E,wEAAwE;IACxE,sDAAsD;IACtD,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,0BAA0B;IAC1B,MAAM,YAAY,GAAG,MAAM,oBAAW,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IACtE,8CAA8C;IAC9C,MAAM,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,qEAAqE;IACrE,uCAAuC;IACvC,OAAO,cAA6B,CAAC;AACvC,CAAC;AAzBD,sCAyBC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CACxB,UAAkB,EAClB,cAA+B;IAE/B,IAAI,OAAO,CAAC;IACZ,IAAI,UAAM,CAAC,UAAU,CAAC,EAAE;QACtB,iBAAiB;QACjB,OAAO,GAAG,iBAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KAChD;SAAM;QACL,4DAA4D;QAC5D,OAAO,GAAG,uBAAc,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KACtD;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,wCAAwC;QACxC,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,qBAAqB,EAAE,CACxB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAgB,CAAC;QAC/D,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;AACL,CAAC;AApBD,gCAoBC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAClC,EAAU,EACV,cAAmC;IAEnC,MAAM,EAAE,GAAG,gCAAK,cAAc,GAAK,EAAE,EAAE,EAAE,CAAsB,CAAC;IAChE,MAAM,+BAAU,CAAC,EAAE,CAAC,CAAC;IACrB,OAAO;AACT,CAAC;AAPD,wCAOC;AAED,gDAAgD;AAChD,2DAA2D;AAC3D,sCAAsC;AACtC,EAAE;AACF,wCAAwC;AACxC,+BAA+B;AAC/B,4BAA4B;AAC5B,6CAA6C;AAC7C,4DAA4D;AAE5D,OAAO;AACP,IAAI"}

package/dist/node/projects/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./HubProjectManager"), exports);
+tslib_1.__exportStar(require("./HubProjects"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/projects/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/projects/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,wDAA8B"}

package/dist/node/utils/dasherize.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dasherize = void 0;
+/**
+ *   Dasherize a string
+ *
+ *  ```javascript
+ *  import { dasherize } from '@esri/hub-common';
+ *  dasherize('innerHTML');                // 'inner-html'
+ *  dasherize('action_name');              // 'action-name'
+ *  dasherize('css-class-name');           // 'css-class-name'
+ *  dasherize('my favorite items');        // 'my-favorite-items'
+ *  dasherize('privateDocs/ownerInvoice';  // 'private-docs/owner-invoice'
+ *  ```
+ *
+ *  Extracted and modified from Ember.js source code - MIT license
+ *  @param value
+ *  @returns
+ */
+function dasherize(value) {
+    const DECAMELIZE_REGEXP = /([a-z\d])([A-Z])/g;
+    const DASHERIZE_REGEXP = /[ _]/g;
+    return value
+        .replace(DECAMELIZE_REGEXP, "$1_$2")
+        .toLowerCase()
+        .replace(DASHERIZE_REGEXP, "-");
+}
+exports.dasherize = dasherize;
+//# sourceMappingURL=dasherize.js.map

package/dist/node/utils/dasherize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dasherize.js","sourceRoot":"","sources":["../../../src/utils/dasherize.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;IAC9C,MAAM,gBAAgB,GAAG,OAAO,CAAC;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,WAAW,EAAE;SACb,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAPD,8BAOC"}

package/dist/node/utils/index.js

@@ -19,4 +19,5 @@ tslib_1.__exportStar(require("./logger"), exports);
 tslib_1.__exportStar(require("./is-update-group"), exports);
 tslib_1.__exportStar(require("./revertable-tasks"), exports);
 tslib_1.__exportStar(require("./sessionLocalStorage"), exports);
+tslib_1.__exportStar(require("./dasherize"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC;AACtC,sDAA4B"}

package/dist/types/ArcGISContext.d.ts

@@ -125,6 +125,10 @@ export interface IArcGISContext {
      * Returns the portal object
      */
     portal: IPortal;
+    /**
+     * Additional app-specific context
+     */
+    properties: Record<string, any>;
 }
 /**
  * Options for the ArcGISContext constructor
@@ -146,7 +150,7 @@ export interface IArcGISContextOptions {
     /**
      * Hub Url that corresponds to the portal url is appropritate
      */
-    hubUrl: string;
+    hubUrl?: string;
     /**
      * The current UserSession
      */
@@ -165,6 +169,10 @@ export interface IArcGISContextOptions {
      * ArcGISContextManager handles this internally
      */
     currentUser?: IUser;
+    /**
+     * Optional hash of additional context
+     */
+    properties?: Record<string, any>;
 }
 /**
  * Abstraction that holds a `UserSession`, along with
@@ -190,6 +198,7 @@ export declare class ArcGISContext implements IArcGISContext {
     private _hubUrl;
     private _portalSelf;
     private _currentUser;
+    private _properties;
     /**
      * Create a new instance of `ArcGISContext`.
      *
@@ -302,4 +311,10 @@ export declare class ArcGISContext implements IArcGISContext {
      * Returns the portal object as IPortal
      */
     get portal(): IPortal;
+    /**
+     * Return the properties hash that was passed in.
+     * Useful for app-specific context such as the active
+     * Site for ArcGIS Hub
+     */
+    get properties(): Record<string, any>;
 }

package/dist/types/ArcGISContextManager.d.ts

@@ -32,6 +32,14 @@ export interface IArcGISContextManagerOptions {
      * it will be fetched.
      */
     currentUser?: IUser;
+    /**
+     * Any additional properties to expose on the context. This allows
+     * an application to send additional context into the system.
+     * For example, in ArcGIS Hub, many times we want to pass in the
+     * active "Hub Site" as additional context, so we will send that in
+     * as a node on a properties object.
+     */
+    properties?: Record<string, any>;
     /**
      * Logging level
      * off > error > warn > info > debug > all
@@ -63,6 +71,7 @@ export declare class ArcGISContextManager {
     private _context;
     private _authentication;
     private _portalUrl;
+    private _properties;
     private _hubUrl;
     private _portalSelf;
     private _currentUser;
@@ -91,6 +100,11 @@ export declare class ArcGISContextManager {
      * @param auth
      */
     setAuthentication(auth: UserSession): Promise<void>;
+    /**
+     * Set the properties hash and re-create the context
+     * @param properties
+     */
+    setProperties(properties: Record<string, any>): void;
     /**
      * Clear the Authentication (UserSession). This should be
      * called when a user signs out of an application, but

package/dist/types/Hub.d.ts

@@ -0,0 +1,72 @@
+import { ArcGISContextManager, IArcGISContextManagerOptions } from "./ArcGISContextManager";
+import { HubProjectManager } from "./projects/HubProjectManager";
+/**
+ * Options for instantiating a Hub instance
+ */
+export interface IHubOptions {
+    contextManager?: ArcGISContextManager;
+    managerOptions?: IArcGISContextManagerOptions;
+    authOptions?: {
+        usename: string;
+        password: string;
+        portalUrl?: string;
+    };
+}
+/**
+ * Hub class can be used as an entry point to managing
+ * content, teams, sites, projects etc, in an organization's Hub.
+ *
+ * ```js
+ * import {Hub} from '@esri/hub-common';
+ * // create a Hub instance, authenticating as a specific user
+ * // working against arcgis online
+ * const myHub = await Hub.create({authOptions: {username: "casey", password: "jones"}});
+ *
+ * myHub.context.currentUser //=> {username: "casey", ...} as IUser
+ *
+ * const projectStore = await myHub.getProjectStore();
+ *
+ * const pavingProject = await projectStore.create({name: "12th Street Paving"});
+ * pavingProject.summary = "This is the 2024 planned paving of 12th Street, between 8th and 11th Ave";
+ * await projectStore.update(pavingProject);
+ * ```
+ *
+ * This is a convenience class. Hub Stores can be created
+ * directly, or the underlying functions can be imported an used
+ * as need for scenarios where these class structures introduce
+ * unwanted complexity
+ */
+export declare class Hub {
+    /**
+     * 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;
+    private _projectManager;
+    /**
+     * Private so we can employ a factory function should we need
+     * async work during creation
+     * @param contextManager
+     */
+    private constructor();
+    /**
+     * Factory function to construct a new HubProjectStore instance.
+     *
+     * Note: Used so that we could do async actions in the ctor.
+     * @param contextManager
+     * @returns
+     */
+    static create(options: IHubOptions): Promise<Hub>;
+    /**
+     * Getter to abstract the context manager
+     */
+    get context(): import("./ArcGISContext").IArcGISContext;
+    /**
+     * Create a Project Store connected to the current Hub
+     * @returns
+     */
+    get projects(): HubProjectManager;
+}

package/dist/types/HubError.d.ts

@@ -0,0 +1,17 @@
+import OperationError from "./OperationError";
+/**
+ * Generic Hub Error with an Error stack as well
+ * as an optional serialized OperationStack.
+ *
+ * Also accepts a `rootCause` Error object
+ */
+export default class HubError extends OperationError {
+    /**
+     * Creates an instance of HubError.
+     * @param {string} operation
+     * @param {string} [message]
+     * @param {Error} [rootCause]
+     * @memberof HubError
+     */
+    constructor(operation: string, message?: string, rootCause?: Error);
+}

package/dist/types/collections.d.ts

@@ -1,3 +1,15 @@
+/**
+ * ```js
+ * import { getCollection } from "@esri/hub-common";
+ * //
+ * getCollection('Feature Layer')
+ * > 'dataset'
+ * ```
+ * Get the Hub collection for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the Hub collection of a given item type.
+ */
+export declare const getCollection: (type?: string) => string;
 export declare const collections: {
     [key: string]: string[];
 };

package/dist/types/content/_internal.d.ts

@@ -8,7 +8,8 @@
  * It's probably a good pattern to add functions here first and then
  * move them to index.ts only when they are needed by a consumer.
  */
-import { BBox, IHubContent, IHubGeography, GeographyProvenance } from "../types";
+import { IItem } from "@esri/arcgis-rest-types/dist/types/item";
+import { BBox, IHubContent, IHubGeography, GeographyProvenance, IHubRequestOptions } from "..";
 /**
  * Create a new content with updated boundary properties
  * @param content original content
@@ -17,70 +18,89 @@ import { BBox, IHubContent, IHubGeography, GeographyProvenance } from "../types"
  */
 export declare const setContentBoundary: (content: IHubContent, boundary: GeographyProvenance) => {
     boundary: IHubGeography;
-    item: any;
+    item: {
+        properties: any;
+        id: string;
+        owner: string;
+        tags: string[];
+        created: number;
+        modified: number;
+        numViews: number;
+        size: number;
+        protected?: boolean;
+        title: string;
+        type: string;
+        typeKeywords?: string[];
+        description?: string;
+        snippet?: string;
+        documentation?: string;
+        extent?: number[][];
+        categories?: string[];
+        spatialReference?: import("@esri/arcgis-rest-types").ISpatialReference;
+        culture?: string;
+        url?: string;
+    };
+    slug?: string;
     hubId?: string;
+    identifier: string;
     permissions: {
         visibility: "private" | "public" | "org";
-        control?: import("../types").AccessControl;
+        control?: import("..").AccessControl;
         groups?: import("@esri/arcgis-rest-types").IGroup[];
     };
-    family?: import("../types").HubFamily;
-    itemCategories?: string[];
-    normalizedType?: string;
+    family?: import("..").HubFamily;
+    categories?: string[];
+    isDownloadable: boolean;
+    structuredLicense?: import("..").IStructuredLicense;
     publishedDate: Date;
     publishedDateSource?: string;
     updateFrequency?: string;
-    actionLinks?: import("../types").IActionLink[];
-    hubActions?: object;
-    metrics?: {
-        visibility: "private" | "public" | "org" | "updateGroups";
-    };
-    slug?: string;
+    portalHomeUrl?: string;
+    portalApiUrl?: string;
     portalDataUrl?: string;
-    groupIds?: string[];
-    errors?: import("../types").IEnrichmentErrorInfo[];
-    data?: {
-        [propName: string]: any;
-    };
-    server?: Partial<import("@esri/arcgis-rest-types").IFeatureServiceDefinition>;
-    layers?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>[];
+    actionLinks?: import("..").IActionLink[];
+    hubActions?: object;
     layer?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>;
-    recordCount?: number;
+    itemCategories?: string[];
+    normalizedType?: string;
     orgId?: string;
-    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
-    isDownloadable: boolean;
-    structuredLicense?: import("..").IStructuredLicense;
+    thumbnailUrl?: string;
+    owner: string;
+    description?: string;
+    culture?: string;
+    tags: string[];
+    typeKeywords?: string[];
+    url?: string;
+    id: string;
     name: string;
     summary?: string;
-    hubType: import("../types").HubType;
     createdDate: Date;
-    createdDateSource?: string;
+    createdDateSource: string;
     updatedDate: Date;
-    updatedDateSource?: string;
-    portalHomeUrl?: string;
-    portalApiUrl?: string;
-    thumbnailUrl?: string;
+    updatedDateSource: string;
+    type: string;
+    server?: Partial<import("@esri/arcgis-rest-types").IFeatureServiceDefinition>;
+    layers?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>[];
+    recordCount?: number;
+    data?: {
+        [propName: string]: any;
+    };
     metadata?: any;
-    id: string;
-    owner: string;
-    tags: string[];
+    groupIds?: string[];
+    ownerUser?: import("@esri/arcgis-rest-types").IUser;
+    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
+    errors?: import("..").IEnrichmentErrorInfo[];
     created: number;
     modified: number;
     numViews: number;
     size: number;
     protected?: boolean;
     title: string;
-    type: string;
-    typeKeywords?: string[];
-    description?: string;
     snippet?: string;
     documentation?: string;
     extent?: number[][];
-    categories?: string[];
     spatialReference?: import("@esri/arcgis-rest-types").ISpatialReference;
-    culture?: string;
     properties?: any;
-    url?: string;
 };
 /**
  * Create a new content with updated extent and derived properties like boundary
@@ -89,3 +109,11 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
  * @returns a new content with the updated extent and boundary
  */
 export declare const setContentExtent: (content: IHubContent, extent: BBox) => IHubContent;
+/**
+ * Returns whether or not an item is a proxied csv
+ *
+ * @param item
+ * @param requestOptions Hub Request Options (including whether we're in portal)
+ * @returns
+ */
+export declare const isProxiedCSV: (item: IItem, requestOptions: IHubRequestOptions) => boolean;

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

@@ -1,7 +1,7 @@
 import { ResourceObject } from "jsonapi-typescript";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { HubType, HubFamily } from "../types";
-import { IHubContent, IModel } from "../types";
+import { HubType, HubFamily, IModel, IHubRequestOptions } from "../types";
+import { IHubContent } from "..";
 /**
  * JSONAPI dataset resource returned by the Hub API
  */
@@ -204,25 +204,25 @@ export declare function datasetToContent(dataset: DatasetResource): IHubContent;
 export declare function datasetToItem(dataset: DatasetResource): IItem;
 /**
  * returns a new content that has the specified type and
- * and updated related properties like normalizedType, family, etc
+ * and updated related properties like, family, etc
  * @param content orignal content
  * @param type new type
  * @returns new content
  */
 export declare const setContentType: (content: IHubContent, type: string) => IHubContent;
 /**
- * Compute the content type icon based on the normalizedType
- * @param normalizedType
+ * Compute the content type icon based on the content type
+ * @param content type
  * @returns content type icon
  */
-export declare const getContentTypeIcon: (normalizedType: string) => any;
+export declare const getContentTypeIcon: (contentType: string) => any;
 /**
  * Compute the content type label
- * @param normalizedType
+ * @param contentType
  * @param isProxied
  * @returns content type label
  */
-export declare const getContentTypeLabel: (normalizedType: string, isProxied: boolean) => string;
+export declare const getContentTypeLabel: (contentType: string, isProxied: boolean) => string;
 /**
  * returns a new content that has the specified hubId and updated identifier
  * @param content orignal content
@@ -249,3 +249,12 @@ export declare const getContentSiteUrls: (content: IHubContent, siteModel: IMode
  * @returns
  */
 export declare const setContentSiteUrls: (content: IHubContent, siteModel: IModel) => IHubContent;
+/**
+ * If an item is a proxied csv, returns the url for the proxying feature layer.
+ * If the item is not a proxied csv, returns undefined.
+ *
+ * @param item
+ * @param requestOptions Hub Request Options (including whether we're in portal)
+ * @returns
+ */
+export declare const getProxyUrl: (item: IItem, requestOptions: IHubRequestOptions) => string;