sintfacilis 1.0.0

package/packages/arcgis-rest-service-admin/README.md

@@ -0,0 +1,73 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-image]][npm-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-service-admin.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-service-admin
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-service-admin/dist/umd/feature-service-admin.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-service-admin
+
+> A module for administering ArcGIS feature services that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-auth
+npm install @esri/arcgis-rest-portal
+npm install @esri/arcgis-rest-service-admin
+```
+
+```js
+import { createFeatureService } from '@esri/arcgis-rest-service-admin';
+
+createFeatureService({
+  authentication,
+  item: { name: "GreenField" }
+})
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/service-admin/)
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2018-2019 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.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/packages/arcgis-rest-service-admin/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@esri/arcgis-rest-service-admin",
+  "version": "3.3.0",
+  "description": "Service administration helpers for @esri/arcgis-rest-js",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/service-admin.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "@esri/arcgis-rest-types": "^3.3.0",
+    "tslib": "^1.13.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^3.3.0",
+    "@esri/arcgis-rest-portal": "^3.3.0",
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^3.0.0",
+    "@esri/arcgis-rest-portal": "^3.0.0",
+    "@esri/arcgis-rest-request": "^3.0.0"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc --module commonjs --outDir ./dist/node",
+    "dev:esm": "tsc -w --module es2015 --outDir ./dist/esm --declaration",
+    "dev:umd": "rollup -w -c ../../umd-base-profile.js",
+    "dev:node": "tsc -w --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-service-admin"
+  },
+  "contributors": [
+    {
+      "name": "Mike Tschudi",
+      "email": "mtschudi@esri.com"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "keywords": [
+    "typescript",
+    "promise",
+    "fetch",
+    "arcgis",
+    "esri",
+    "ES6"
+  ]
+}

package/packages/arcgis-rest-service-admin/src/addTo.ts

@@ -0,0 +1,70 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { ILayer, ILayerDefinition, ITable } from "@esri/arcgis-rest-types";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+
+export interface IAddToServiceDefinitionOptions extends IUserRequestOptions {
+  /**
+   * Layers to add
+   */
+  layers?: ILayer[] | ILayerDefinition[];
+  /**
+   * Tables to add
+   */
+  tables?: ITable[];
+}
+
+export interface IAddToServiceDefinitionItemSummary {
+  name: string;
+  id: any;
+}
+
+export interface IAddToServiceDefinitionResult {
+  layers?: IAddToServiceDefinitionItemSummary[];
+  tables?: IAddToServiceDefinitionItemSummary[];
+  success: boolean;
+}
+
+/**
+ * ```js
+ * import { addToServiceDefinition } from '@esri/arcgis-rest-service-admin';
+ * //
+ * addToServiceDefinition(serviceurl, {
+ *   authentication: userSession,
+ *   layers: [],
+ *   tables: []
+ * });
+ * ```
+ * Add layer(s) and/or table(s) to a hosted feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-to-definition-feature-service-.htm) for more information.
+ *
+ * @param url - URL of feature service
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with service layer and/or table details once the definition
+ * has been updated
+ */
+export function addToServiceDefinition(
+  url: string,
+  requestOptions: IAddToServiceDefinitionOptions
+): Promise<IAddToServiceDefinitionResult> {
+  const adminUrl = `${cleanUrl(url).replace(
+    `/rest/services`,
+    `/rest/admin/services`
+  )}/addToDefinition`;
+
+  requestOptions.params = {
+    addToDefinition: {},
+    ...requestOptions.params
+  };
+
+  if (requestOptions.layers && requestOptions.layers.length > 0) {
+    requestOptions.params.addToDefinition.layers = requestOptions.layers;
+  }
+
+  if (requestOptions.tables && requestOptions.tables.length > 0) {
+    requestOptions.params.addToDefinition.tables = requestOptions.tables;
+  }
+
+  return request(adminUrl, requestOptions);
+}

package/packages/arcgis-rest-service-admin/src/create.ts

@@ -0,0 +1,189 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+import { IExtent, ISpatialReference } from "@esri/arcgis-rest-types";
+
+import {
+  moveItem,
+  ICreateUpdateItemOptions,
+  determineOwner,
+  getPortalUrl
+} from "@esri/arcgis-rest-portal";
+
+/**
+ * A [`createParameters` JSON object for a new
+ * service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm).
+ */
+export interface ICreateServiceParams {
+  /**
+   * Name of the service to be created. This name must be unique. If the name already exists, the operation will fail. ArcGIS Enterprise does not allow spaces or special characters other than underscores in a service name.
+   */
+  name: string;
+  /**
+   * Description given to the service.
+   */
+  serviceDescription?: string;
+  /**
+   * Indicates whether the data changes.
+   */
+  hasStaticData?: boolean;
+  /**
+   * A double value indicating any constraints enforced on query operations.
+   */
+  maxRecordCount?: number;
+  /**
+   * The formats in which query results are returned.
+   */
+  supportedQueryFormats?: string;
+  /**
+   * Specify feature service editing capabilities for Create, Delete, Query, Update, and Sync.
+   */
+  capabilities?: string;
+  /**
+   * A user-friendly description for the published dataset.
+   */
+  description?: string;
+  /**
+   * Copyright information associated with the dataset.
+   */
+  copyrightText?: string;
+  /**
+   * All layers added to a hosted feature service need to have the same spatial reference defined for
+   * the feature service. When creating a new empty service without specifying its spatial reference,
+   * the spatial reference of the hosted feature service is set to the first layer added to that
+   * feature service.
+   */
+  spatialReference?: ISpatialReference;
+  /**
+   * The initial extent set for the service.
+   */
+  initialExtent?: IExtent;
+  /**
+   * Indicates if updating the geometry of the service is permitted.
+   */
+  allowGeometryUpdates?: boolean;
+  /**
+   * Units used by the feature service
+   */
+  units?: string;
+  /**
+   * A JSON object specifying the properties of cross-site scripting prevention.
+   */
+  xssPreventionInfo?: any;
+  /**
+   * Editor tracking info.
+   */
+  editorTrackingInfo?: {
+    enableEditorTracking?: boolean;
+    enableOwnershipAccessControl?: boolean;
+    allowOthersToUpdate?: boolean;
+    allowOthersToDelete?: boolean;
+    allowOthersToQuery?: boolean;
+    allowAnonymousToUpdate?: boolean;
+    allowAnonymousToDelete?: boolean;
+  };
+}
+
+export interface ICreateServiceOptions extends ICreateUpdateItemOptions {
+  /**
+   * A JSON object specifying the properties of the newly-created service. See the [REST
+   * Documentation](https://developers.arcgis.com/rest/users-groups-and-items/working-with-users-groups-and-items.htm)
+   * for more information.
+   */
+  item: ICreateServiceParams;
+  /**
+   * Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the
+   * root folder.
+   */
+  folderId?: string;
+}
+
+export interface ICreateServiceResult {
+  /**
+   * The encoded URL to the hosted service.
+   */
+  encodedServiceURL: string;
+
+  /**
+   * Indicates if this feature service represents a view.
+   */
+  isView: boolean;
+
+  /**
+   * The unique ID for this item.
+   */
+  itemId: string;
+
+  /**
+   * Name of the service item.
+   */
+  name: string;
+
+  /**
+   * The ID of the new service item.
+   */
+  serviceItemId: string;
+
+  /**
+   * The URL to the hosted service.
+   */
+  serviceurl: string;
+
+  /**
+   * The size of the item.
+   */
+  size: number;
+
+  /**
+   * Indicates if the operation was successful.
+   */
+  success: boolean;
+
+  /**
+   * The type of service created.
+   */
+  type: string;
+}
+
+/**
+ * ```js
+ * import {
+ *   createFeatureService,
+ *   addToServiceDefinition
+ * } from '@esri/arcgis-rest-service-admin';
+ * //
+ * createFeatureService({
+ *   authentication: userSession,
+ *   item: {
+ *     "name": "NewEmptyService",
+ *     "capabilities": "Create,Delete,Query,Update,Editing"
+ *   }
+ * });
+ * ```
+ * Create a new [hosted feature service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm). After the service has been created, call [`addToServiceDefinition()`](../addToServiceDefinition/) if you'd like to update it's schema.
+ * @param requestOptions - Options for the request. NOTE: `rawResponse` is not supported by this operation.
+ * @returns A Promise that resolves with service details once the service has been created
+ */
+export function createFeatureService(
+  requestOptions: ICreateServiceOptions
+): Promise<ICreateServiceResult> {
+  return determineOwner(requestOptions).then(owner => {
+    const options: ICreateServiceOptions = {
+      ...requestOptions,
+      rawResponse: false
+    };
+    const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+    const folder = (!options.folderId || options.folderId === "/") ? "" : "/" + options.folderId;
+    const url = `${baseUrl}${folder}/createService`;
+
+    // Create the service
+    options.params = {
+      createParameters: options.item,
+      outputType: "featureService",
+      ...options.params
+    };
+
+    return request(url, options);
+  });
+}

package/packages/arcgis-rest-service-admin/src/get-service-admin-info.ts

@@ -0,0 +1,34 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { IServiceInfo } from "@esri/arcgis-rest-types";
+
+/**
+ * Given a Feature Service url, fetch the service admin information.
+ *
+ * The response from this call includes all the detailed information
+ * for each layer/table in the service as well as some admin properties
+ *
+ * @export
+ * @param {string} serviceUrl
+ * @param {UserSession} session
+ * @return {*}  {Promise<IServiceInfo>}
+ */
+export function getServiceAdminInfo(
+  serviceUrl: string,
+  session: UserSession
+): Promise<IServiceInfo> {
+  const serviceAdminUrl = serviceUrl.replace(
+    "/rest/services",
+    "/rest/admin/services"
+  );
+
+  return request(serviceAdminUrl, {
+    authentication: session,
+    params: {
+      f: "json",
+    },
+  });
+}

package/packages/arcgis-rest-service-admin/src/get-view-sources.ts

@@ -0,0 +1,20 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { request } from "@esri/arcgis-rest-request";
+import { IViewServiceSources } from "@esri/arcgis-rest-types";
+
+/**
+ * Return the sources response for a view service item
+ *
+ * @param {string} viewServiceUrl
+ * @param {UserSession} session
+ * @return {*}  {Promise<Record<string, unknown>>}
+ */
+export function getViewSources(
+  viewServiceUrl: string,
+  session: UserSession
+): Promise<IViewServiceSources> {
+  return request(`${viewServiceUrl}/sources`, { authentication: session });
+}

package/packages/arcgis-rest-service-admin/src/index.ts

@@ -0,0 +1,14 @@
+export * from "./create";
+export * from "./addTo";
+export * from "./update";
+export * from "./get-service-admin-info";
+export * from "./get-view-sources";
+
+export {
+  IFeatureServiceDefinition,
+  IExtent,
+  ISpatialReference,
+  ILayer,
+  ILayerDefinition,
+  ITable,
+} from "@esri/arcgis-rest-types";

package/packages/arcgis-rest-service-admin/src/update.ts

@@ -0,0 +1,50 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { IFeatureServiceDefinition } from "@esri/arcgis-rest-types";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+
+export interface IUpdateServiceDefinitionOptions extends IUserRequestOptions {
+  updateDefinition?: Partial<IFeatureServiceDefinition>;
+}
+
+export interface IUpdateServiceDefinitionResult {
+  success: boolean;
+}
+
+/**
+ * ```js
+ * import { updateServiceDefinition } from '@esri/arcgis-rest-service-admin';
+ * //
+ * updateServiceDefinition(serviceurl, {
+ *   authentication: userSession,
+ *   updateDefinition: serviceDefinition
+ * });
+ * ```
+ * Update a definition property in a hosted feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-definition-feature-service-.htm) for more information.
+ *
+ * @param url - URL of feature service
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with success or error
+ */
+export function updateServiceDefinition(
+  url: string,
+  requestOptions: IUpdateServiceDefinitionOptions
+): Promise<IUpdateServiceDefinitionResult> {
+  const adminUrl = `${cleanUrl(url).replace(
+    `/rest/services`,
+    `/rest/admin/services`
+  )}/updateDefinition`;
+
+  requestOptions.params = {
+    updateDefinition: {},
+    ...requestOptions.params
+  };
+
+  if (requestOptions.updateDefinition) {
+    requestOptions.params.updateDefinition = requestOptions.updateDefinition;
+  }
+
+  return request(adminUrl, requestOptions);
+}