@esri/hub-common 28.5.0 → 28.6.0

package/dist/node/layouts/updateLayout.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateLayout = updateLayout;
-const util_js_1 = require("../util.js");
-const upsertLayoutResource_js_1 = require("./upsertLayoutResource.js");
-async function updateLayout(entity, layout, requestOptions) {
-    if (!layout) {
-        return layout;
-    }
-    const updatedLayout = (0, util_js_1.cloneObject)(layout);
-    // check the variables and for each one that is of type image and... has a source, a blob?
-    // we need to upload the image as a resource and update the variable.value to point to the resource and remove all other properties except type
-    await Promise.all(Object.entries(updatedLayout.variables || {}).map(async ([key, _variable]) => {
-        const variable = _variable;
-        if (variable.type === "image") {
-            if (variable.source === "upload" && !!variable.blob) {
-                const newVariable = {
-                    type: variable.type,
-                };
-                const resourceUrl = await (0, upsertLayoutResource_js_1.upsertLayoutResource)(entity.id, entity.owner, variable.blob, key, // this is something like <nodeId>-image-card
-                variable.format, requestOptions);
-                // set the value to the resource name
-                newVariable.value = { $ref: resourceUrl };
-                updatedLayout.variables[key] = newVariable;
-            }
-        }
-    }));
-    /*
-      TODO: we will also need to clean up any old resources that are no longer referenced
-            - make sure when we delete it in the ui, we get rid of the variable
-            - then when we save, we delete any resources for which there is no variable
-            - when an image card is changed from an upload to a url, we will handle it similarly
-    */
-    return updatedLayout;
-}
-//# sourceMappingURL=updateLayout.js.map

package/dist/node/layouts/updateLayout.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateLayout.js","sourceRoot":"","sources":["../../../src/layouts/updateLayout.ts"],"names":[],"mappings":";;AAMA,oCAgDC;AApDD,wCAAyC;AAEzC,uEAAiE;AAE1D,KAAK,UAAU,YAAY,CAChC,MAAsB,EACtB,MAAe,EACf,cAAmC;IAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,aAAa,GAAG,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC;IAE1C,0FAA0F;IAC1F,+IAA+I;IAC/I,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/C,KAAK,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAG,SAAoC,CAAC;QACtD,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACpD,MAAM,WAAW,GAA4B;oBAC3C,IAAI,EAAE,QAAQ,CAAC,IAAI;iBACpB,CAAC;gBAEF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAC5C,MAAM,CAAC,EAAE,EACT,MAAM,CAAC,KAAK,EACZ,QAAQ,CAAC,IAAI,EACb,GAAG,EAAE,6CAA6C;gBAClD,QAAQ,CAAC,MAAgB,EACzB,cAAc,CACf,CAAC;gBACF,qCAAqC;gBACrC,WAAW,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;gBAC1C,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC,CACF,CACF,CAAC;IAEF;;;;;MAKE;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/node/layouts/upsertLayoutResource.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.upsertLayoutResource = upsertLayoutResource;
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const HubError_1 = require("../HubError");
-const object_to_json_blob_1 = require("../resources/object-to-json-blob");
-const string_to_blob_1 = require("../resources/string-to-blob");
-const removeResource_1 = require("../resources/removeResource");
-/**
- * Given an item, and owner, Search for if the resource exists
- * and if does, update it, otherwise add it. Returns a url for the item.
- *
- * Note that layout resources are typically stored with
- * - a "layout/" prefix (so we can find them)
- * - a name that starts with the cardId
- * - and a -{timestamp} suffix (to bust the cache)
- * thus 'update' is not really an update, it is:
- * - upload the new one
- * - then find the old one (which has a different suffix) and delete it.
- *
- * this is why we cannot simply use upsertResource
- 
- *
- * @export
- * @param {string} id
- * @param {string} owner
- * @param {*} resource
- * @param {string} name
- * @param {string} extension
- * @param {IUserRequestOptions} ro
- * @return {*}  {Promise<string>}
- */
-async function upsertLayoutResource(id, owner, resource, name, extension, ro) {
-    try {
-        const prefix = "layout";
-        // construct resource name
-        // the key is of the form <nodeId>-image-card
-        // we also append a unique timestamp to avoid caching issues
-        const resourceName = `${name}-${Date.now()}.${extension}`;
-        // JSON and text resources have....odd things happen
-        // to them when they are added as resources and NOT
-        // converted to blobs. Thus we convert them to blobs
-        let resourceToUpload = resource;
-        if (extension === "json") {
-            resourceToUpload = (0, object_to_json_blob_1.objectToJsonBlob)(resource);
-        }
-        if (extension === "txt") {
-            resourceToUpload = (0, string_to_blob_1.stringToBlob)(resource);
-        }
-        // Add item resource
-        // we do not check for existence first, because
-        // our resource names are unique (timestamped)
-        const response = await (0, arcgis_rest_portal_1.addItemResource)(Object.assign({ id,
-            owner, resource: resourceToUpload, name: resourceName, prefix }, ro));
-        // if err throw
-        if (!response.success) {
-            throw new HubError_1.default("Add Item Resource", `Error adding resource ${name} to item ${id}.`);
-        }
-        // then delete the old one if it exists
-        const resources = await (0, arcgis_rest_portal_1.getItemResources)(id, ro);
-        const foundResource = resources.resources.find((res) => {
-            return (res.resource.startsWith(`${prefix}/${name}`) &&
-                res.resource !== `${prefix}/${resourceName}`);
-        });
-        if (foundResource) {
-            await (0, removeResource_1.removeResource)(id, foundResource.resource, owner, ro);
-        }
-        // return url
-        // resourceUrl://:id/:prefix/:filename
-        return `resourceUrl://${id}/${prefix}/${resourceName}`;
-    }
-    catch (err) {
-        if (err instanceof Error) {
-            throw new HubError_1.default("Add Item Resource", err.message, err);
-        }
-        else {
-            throw new HubError_1.default("Add Item Resource", `Error adding resource ${name} to item ${id}.`);
-        }
-    }
-}
-//# sourceMappingURL=upsertLayoutResource.js.map

package/dist/node/layouts/upsertLayoutResource.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"upsertLayoutResource.js","sourceRoot":"","sources":["../../../src/layouts/upsertLayoutResource.ts"],"names":[],"mappings":";;AA+BA,oDAuEC;AArGD,iEAA6E;AAC7E,0CAAmC;AACnC,0EAAoE;AACpE,gEAA2D;AAC3D,gEAA6D;AAE7D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,oBAAoB,CACxC,EAAU,EACV,KAAa,EACb,QAAiB,EACjB,IAAY,EACZ,SAAiB,EACjB,EAAuB;IAEvB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,0BAA0B;QAC1B,6CAA6C;QAC7C,4DAA4D;QAC5D,MAAM,YAAY,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,SAAS,EAAE,CAAC;QAC1D,oDAAoD;QACpD,mDAAmD;QACnD,oDAAoD;QACpD,IAAI,gBAAgB,GAAG,QAAQ,CAAC;QAChC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACzB,gBAAgB,GAAG,IAAA,sCAAgB,EAAC,QAAQ,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,gBAAgB,GAAG,IAAA,6BAAY,EAAC,QAAkB,CAAC,CAAC;QACtD,CAAC;QACD,oBAAoB;QACpB,+CAA+C;QAC/C,8CAA8C;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAA,oCAAe,kBACpC,EAAE;YACF,KAAK,EACL,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,EAAE,YAAY,EAClB,MAAM,IACH,EAAE,EACL,CAAC;QACH,eAAe;QACf,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,kBAAQ,CAChB,mBAAmB,EACnB,yBAAyB,IAAI,YAAY,EAAE,GAAG,CAC/C,CAAC;QACJ,CAAC;QAED,uCAAuC;QACvC,MAAM,SAAS,GAAG,MAAM,IAAA,qCAAgB,EAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAC5C,CAAC,GAAyB,EAAE,EAAE;YAC5B,OAAO,CACL,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;gBAC5C,GAAG,CAAC,QAAQ,KAAK,GAAG,MAAM,IAAI,YAAY,EAAE,CAC7C,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,IAAA,+BAAc,EAAC,EAAE,EAAE,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,aAAa;QACb,sCAAsC;QACtC,OAAO,iBAAiB,EAAE,IAAI,MAAM,IAAI,YAAY,EAAE,CAAC;IACzD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,kBAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,kBAAQ,CAChB,mBAAmB,EACnB,yBAAyB,IAAI,YAAY,EAAE,GAAG,CAC/C,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/types/layouts/updateLayout.d.ts

@@ -1,4 +0,0 @@
-import { IUserRequestOptions } from "@esri/arcgis-rest-request";
-import { IHubItemEntity } from "../core/types/IHubItemEntity.js";
-import { ILayout } from "./types.js";
-export declare function updateLayout(entity: IHubItemEntity, layout: ILayout, requestOptions: IUserRequestOptions): Promise<ILayout>;

package/dist/types/layouts/upsertLayoutResource.d.ts

@@ -1,26 +0,0 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
-/**
- * Given an item, and owner, Search for if the resource exists
- * and if does, update it, otherwise add it. Returns a url for the item.
- *
- * Note that layout resources are typically stored with
- * - a "layout/" prefix (so we can find them)
- * - a name that starts with the cardId
- * - and a -{timestamp} suffix (to bust the cache)
- * thus 'update' is not really an update, it is:
- * - upload the new one
- * - then find the old one (which has a different suffix) and delete it.
- *
- * this is why we cannot simply use upsertResource
- 
- *
- * @export
- * @param {string} id
- * @param {string} owner
- * @param {*} resource
- * @param {string} name
- * @param {string} extension
- * @param {IUserRequestOptions} ro
- * @return {*}  {Promise<string>}
- */
-export declare function upsertLayoutResource(id: string, owner: string, resource: unknown, name: string, extension: string, ro: IUserRequestOptions): Promise<string>;