@esri/solution-common 3.0.0 → 3.1.0

package/dist/umd/src/resources/addMetadataFromBlob.d.ts

@@ -1,25 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "../interfaces";
-/**
- * Adds metadata to an AGO item.
- *
- * @param blob Blob containing metadata
- * @param itemId Item to receive metadata
- * @param authentication Credentials for the request
- * @returns Promise resolving to JSON containing success boolean
- */
-export declare function addMetadataFromBlob(blob: Blob, itemId: string, authentication: UserSession): Promise<any>;

package/dist/umd/src/resources/convert-item-resource-to-storage-resource.d.ts

@@ -1,32 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { SolutionResourceType } from "./solution-resource";
-/**
- * Generates a folder and filename for storing a copy of an item's resource in a storage item.
- *
- * @param prefix Base prefix for resource
- * @param sourceResourceFilename Either filename or folder/filename to resource
- * @param storageVersion Version of the Solution template
- * @param storageFileType Optional argument that when supplied will control the how the prefix is created
- * @returns Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
- * exists plus ("_" + part of sourceResourceFilename before "/" if that separator exists);
- * file is sourceResourceFilename
- * @see convertStorageResourceToItemResource
- */
-export declare function convertItemResourceToStorageResource(prefix: string, sourceResourceFilename: string, storageVersion?: number, storageFileType?: SolutionResourceType): {
-    folder: string;
-    filename: string;
-};

package/dist/umd/src/resources/convert-storage-resource-to-item-resource.d.ts

@@ -1,29 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IDeployFilename } from "../interfaces";
-/**
- * Extracts an item's resource folder and filename from the filename used to store a copy in a storage item.
- *
- * @param storageResourceFilename Filename used to store the resource, metadata, or thumbnail of an item
- * @param storageVersion Version of the Solution template
- * @returns Folder and filename for storing information in an item, as well as the type (resource, metadata,
- * or thumbnail) of the information; the folder property is only meaningful for the resource type
- * @see generateResourceStorageFilename
- * @see generateMetadataStorageFilename
- * @see generateThumbnailStorageFilename
- * @see convertItemResourceToStorageResource
- */
-export declare function convertStorageResourceToItemResource(storageResourceFilename: string, storageVersion?: number): IDeployFilename;

package/dist/umd/src/resources/copyAssociatedFiles.d.ts

@@ -1,52 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Provides functions for sending resources to AGO.
- */
-import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo, UserSession } from "../interfaces";
-/**
- * Copies the files for storing the resources, metadata, and thumbnail of an item or group to a storage item
- * with a specified path by collecting files into zip files.
- *
- * @param files List of item files' URLs and folder/filenames for storing the files
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @param filesPerZip Number of files to include per zip file; AGO limits zips to 50 files
- * @returns A promise which resolves to a list of the result of the copies
- */
-export declare function copyFilesAsResources(files: ISourceFile[], destinationItemId: string, destinationAuthentication: UserSession, filesPerZip?: number): Promise<IAssociatedFileCopyResults[]>;
-/**
- * Copies the files described by a list of full URLs and storage folder/filename combinations for storing
- * the resources, metadata, and thumbnail of an item or group to a storage item with different
- * handling based on the type of file.
- *
- * @param fileInfos List of item files' URLs and folder/filenames for storing the files
- * @param sourceAuthentication Credentials for the request to the source
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to a list of the result of the copies
- */
-export declare function copyAssociatedFilesByType(fileInfos: IAssociatedFileInfo[], sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;
-/**
- * Copies one or more zipfiles to a storage item.
- *
- * @param zipInfos List of zip files containing files to store
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to a list of the result of the copies
- * @private
- */
-export declare function _copyAssociatedFileZips(zipInfos: IZipInfo[], destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;

package/dist/umd/src/resources/copyDataIntoItem.d.ts

@@ -1,33 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IAssociatedFileCopyResults, IAssociatedFileInfo, IFileMimeTyped, UserSession } from "../interfaces";
-/**
- * Copies data into an AGO item.
- *
- * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
- * @param sourceAuthentication Credentials for the request to the source
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to the result of the copy
- */
-export declare function copyDataIntoItem(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults>;
-/**
- * Creates a file with a specified mime type.
- *
- * @param fileDescription Structure containing a file and the desired mime type
- * @returns Created file
- */
-export declare function createMimeTypedFile(fileDescription: IFileMimeTyped): File;

package/dist/umd/src/resources/copyMetadataIntoItem.d.ts

@@ -1,26 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IAssociatedFileCopyResults, IAssociatedFileInfo, UserSession } from "../interfaces";
-/**
- * Copies metadata into an AGO item.
- *
- * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
- * @param sourceAuthentication Credentials for the request to the source
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to the result of the copy
- */
-export declare function copyMetadataIntoItem(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults>;

package/dist/umd/src/resources/copyResourceIntoZip.d.ts

@@ -1,33 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo, UserSession } from "../interfaces";
-/**
- * Copies a resource into a zipfile.
- *
- * @param file Information about the source and destination of the file such as its URL, folder, filename
- * @param zipInfo Information about a zipfile such as its name and its zip object
- * @returns The result of the copy
- */
-export declare function copyResourceIntoZip(file: ISourceFile, zipInfo: IZipInfo): IAssociatedFileCopyResults;
-/**
- * Copies a resource into a zipfile.
- *
- * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
- * @param sourceAuthentication Credentials for the request to the source
- * @param zipInfo Information about a zipfile such as its name and its zip object
- * @returns A promise which resolves to the result of the copy
- */
-export declare function copyResourceIntoZipFromInfo(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, zipInfo: IZipInfo): Promise<IAssociatedFileCopyResults>;

package/dist/umd/src/resources/copyZipIntoItem.d.ts

@@ -1,25 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IZipCopyResults, IZipInfo, UserSession } from "../interfaces";
-/**
- * Copies a zipfile into an AGO item.
- *
- * @param zipInfo Information about a zipfile such as its name and its zip object
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to the result of the copy
- */
-export declare function copyZipIntoItem(zipInfo: IZipInfo, destinationItemId: string, destinationAuthentication: UserSession): Promise<IZipCopyResults>;

package/dist/umd/src/resources/createCopyResults.d.ts

@@ -1,25 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IAssociatedFileCopyResults, IZipCopyResults } from "../interfaces";
-/**
- * Generates IAssociatedFileCopyResults object.
- *
- * @param fileInfo Info about item that was to be copied
- * @param fetchedFromSource Status of fetching item from source
- * @param copiedToDestination Status of copying item to destination
- * @returns IAssociatedFileCopyResults object
- */
-export declare function createCopyResults(fileInfo: any, fetchedFromSource: boolean, copiedToDestination?: boolean): IAssociatedFileCopyResults | IZipCopyResults;

package/dist/umd/src/resources/get-blob.d.ts

@@ -1,26 +0,0 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "../interfaces";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-/**
- * Gets a Blob from a web site.
- *
- * @param url Address of Blob
- * @param authentication Credentials for the request
- * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
- * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
- */
-export declare function getBlob(url: string, authentication: UserSession, requestOptions?: IRequestOptions): Promise<Blob>;

package/dist/umd/src/resources/getItemResourcesFilesFromPaths.d.ts

@@ -1,24 +0,0 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { ISourceFile, ISourceFileCopyPath, UserSession } from "../interfaces";
-/**
- * Fetches a set of resources defined by paths.
- *
- * @param resourceItemFilePaths Paths to resources in source
- * @param authentication Credentials for the request to the source
- * @returns A promise which resolves with an array of resource files
- */
-export declare function getItemResourcesFilesFromPaths(resourceItemFilePaths: ISourceFileCopyPath[], authentication: UserSession): Promise<ISourceFile[]>;

package/dist/umd/src/resources/getItemResourcesPaths.d.ts

@@ -1,26 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IItemTemplate, ISourceFileCopyPath, UserSession } from "../interfaces";
-/**
- * Updates the solution item with resources from the itemTemplate
- *
- * @param itemTemplate Template for AGOL item
- * @param solutionItemId item id for the solution
- * @param authentication Credentials for the request to the storage
- * @param storageVersion Version of the Solution template
- * @returns A promise which resolves with an array of paths to resources for the item
- */
-export declare function getItemResourcesPaths(itemTemplate: IItemTemplate, solutionItemId: string, authentication: UserSession, storageVersion?: number): Promise<ISourceFileCopyPath[]>;

package/dist/umd/src/resources/index.d.ts

@@ -1,29 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export * from "./addMetadataFromBlob";
-export * from "./add-resource-from-blob";
-export * from "./convert-item-resource-to-storage-resource";
-export * from "./convert-storage-resource-to-item-resource";
-export * from "./copyAssociatedFiles";
-export * from "./copyDataIntoItem";
-export * from "./copyMetadataIntoItem";
-export * from "./copyResourceIntoZip";
-export * from "./copyZipIntoItem";
-export * from "./createCopyResults";
-export * from "./get-blob";
-export * from "./getItemResourcesFilesFromPaths";
-export * from "./getItemResourcesPaths";
-export * from "./solution-resource";

package/dist/umd/src/resources/solution-resource.d.ts

@@ -1,35 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Denotes type information for a SolutionResource
- */
-export declare enum SolutionResourceType {
-    thumbnail = 0,
-    metadata = 1,
-    resource = 2,
-    data = 3,
-    fakezip = 4,
-    info = 5
-}
-/**
- * Solution Resource information
- */
-export interface ISolutionResource {
-    filename: string;
-    type: SolutionResourceType;
-    path: string;
-    sourceUrl?: string;
-}

package/dist/umd/src/resources/transform-resource-paths-to-solution-resources.d.ts

@@ -1,56 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { ISolutionResource, SolutionResourceType } from "./solution-resource";
-/**
- * Convert an array of resource strings into an array of ISolutionResources
- *
- * Used to migrate Solutions to a more extensible resource schema
- *
- * @param resourceStrings Array of resource paths
- */
-export declare function transformResourcePathsToSolutionResources(resourceStrings?: string[]): ISolutionResource[];
-/**
- * Convert a resource path to a ISolutionResource
- *
- * @param resourcePath String
- */
-export declare function transformResourcePathToSolutionResource(resourcePath: string): ISolutionResource;
-/**
- * Convert a resource path to a SolutionResourceType
- *
- * @param resourcePath String
- * @private
- */
-export declare function _getSolutionResourceTypeFromResourcePath(resourcePath: string): SolutionResourceType;
-/**
- * Extract the filename from a path
- *
- * @param path String that is a path
- * @private
- */
-export declare function _extractFilenameFromResourcePath(path: string): string;
-/**
- * Convert the resource path into the correct output path
- * (aka resource prefix)
- *
- * Original resource paths encoded information in the path
- * including actual sub-folders. The logic is kinda complex
- * thus this function has extensive tests
- *
- * @param path
- * @private
- */
-export declare function _extractPathFromResourcePath(resourcePath: string): string;