culparepellendus 1.0.0

package/packages/arcgis-rest-types/src/geometry.ts

@@ -0,0 +1,272 @@
+/* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * `IHasZM` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IHasZM } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export interface IHasZM {
+  hasZ?: boolean;
+  hasM?: boolean;
+}
+
+/**
+ * Spatial reference systems define mathematical transformations and coordinate systems for displaying spatial information in 2D and 3D.
+ *
+ * `ISpatialReference` can also be imported from the following packages:
+ *
+ * ```js
+ * import { ISpatialReference } from "@esri/arcgis-rest-geocoding";
+ * import { ISpatialReference } from "@esri/arcgis-rest-routing";
+ * import { ISpatialReference } from "@esri/arcgis-rest-service-admin";
+ * import { ISpatialReference } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export interface ISpatialReference {
+  wkid?: number;
+  latestWkid?: number;
+  vcsWkid?: number;
+  latestVcsWkid?: number;
+  wkt?: string;
+  latestWkt?: string;
+}
+
+/**
+ * a building block for discrete geometries
+ *
+ * `IGeometry` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IGeometry } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export interface IGeometry {
+  spatialReference?: ISpatialReference;
+}
+
+/**
+ * A simple point geometry, with spatial reference defined.
+ *
+ * `IPoint` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IPoint } from "@esri/arcgis-rest-routing";
+ * import { IPoint } from "@esri/arcgis-rest-geocoding";
+ * ```
+ */
+export interface IPoint extends IHasZM, IGeometry {
+  x: number;
+  y: number;
+  z?: number;
+}
+
+/**
+ * `ILocation` can also be imported from the following packages:
+ *
+ * ```js
+ * import { ILocation } from "@esri/arcgis-rest-routing";
+ * import { ILocation } from "@esri/arcgis-rest-geocoding";
+ * ```
+ */
+export interface ILocation {
+  latitude?: number;
+  longitude?: number;
+  lat?: number;
+  long?: number;
+  z?: number;
+}
+
+/**
+ *
+ */
+export interface IPolyline extends IHasZM, IGeometry {
+  paths: Position[][];
+}
+
+/**
+ *
+ */
+export interface IPolylineWithCurves extends IHasZM, IGeometry {
+  curvePaths: Array<Array<Position | JsonCurve>>;
+}
+
+/**
+ *
+ */
+export interface IPolygon extends IHasZM, IGeometry {
+  rings: Position[][];
+}
+
+/**
+ *
+ */
+export interface IPolygonWithCurves extends IHasZM, IGeometry {
+  curveRings: Array<Array<Position | JsonCurve>>;
+}
+
+/**
+ *
+ */
+export type Position =
+  | Position2D
+  | [number, number, number]
+  | [number, number, number, number];
+
+/**
+ *
+ */
+export type Position2D = [number, number];
+
+/**
+ * an arc can be represented as a JSON curve object
+ */
+export interface IArc {
+  a: [
+    Position, // End point: x, y, <z>, <m>
+    Position2D, // Center point: center_x, center_y
+    number, // minor
+    number, // clockwise
+    number, // rotation
+    number, // axis
+    number // ratio
+  ];
+}
+
+/**
+ * a bezier curve can be represented as a JSON curve object
+ */
+export interface IBezierCurve {
+  b: [Position, Position2D, Position2D];
+}
+
+/**
+ * a circular arc can be represented as a JSON curve object
+ */
+export interface ICircularArc {
+  c: [Position, Position2D];
+}
+
+/**
+ *
+ */
+export type ElipticArc = IArc;
+
+/**
+ * An envelope is a rectangle defined by a range of values for each coordinate and attribute.
+ */
+export interface IEnvelope extends IGeometry {
+  xmin: number;
+  xmax: number;
+  ymin: number;
+  ymax: number;
+
+  zmin?: number;
+  zmax?: number;
+
+  mmin?: number;
+  mmax?: number;
+}
+
+/**
+ * `GeometryType` can also be imported from the following packages:
+ *
+ * ```js
+ * import { GeometryType } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export type GeometryType =
+  | "esriGeometryPoint"
+  | "esriGeometryMultipoint"
+  | "esriGeometryPolyline"
+  | "esriGeometryPolygon"
+  | "esriGeometryEnvelope";
+
+/**
+ * The spatial relationship used to compare input geometries
+ *
+ * `SpatialRelationship` can also be imported from the following packages:
+ *
+ * ```js
+ * import { SpatialRelationship } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export type SpatialRelationship =
+  | "esriSpatialRelIntersects"
+  | "esriSpatialRelContains"
+  | "esriSpatialRelCrosses"
+  | "esriSpatialRelEnvelopeIntersects"
+  | "esriSpatialRelIndexIntersects"
+  | "esriSpatialRelOverlaps"
+  | "esriSpatialRelTouches"
+  | "esriSpatialRelWithin";
+
+/**
+ * Extents are used to define rectangles and bounding boxes.
+ *
+ * `IExtent` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IExtent } from "@esri/arcgis-rest-geocoding";
+ * import { IExtent } from "@esri/arcgis-rest-service-admin";
+ * import { IExtent } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export interface IExtent {
+  xmin: number;
+  ymin: number;
+  zmin?: number;
+  xmax: number;
+  ymax: number;
+  zmax?: number;
+  spatialReference?: ISpatialReference;
+}
+
+/**
+ *
+ */
+export interface IHasZM {
+  hasZ?: boolean;
+  hasM?: boolean;
+}
+
+/**
+ *
+ */
+export type JsonCurve = ICircularArc | IArc | IOldCircularArc | IBezierCurve;
+
+/**
+ *
+ */
+export interface IOldCircularArc {
+  a: [
+    Position, // End point: x, y, <z>, <m>
+    Position2D, // Center point: center_x, center_y
+    number, // minor
+    number // clockwise
+  ];
+}
+
+/**
+ * A multipoint contains an array of points.
+ */
+export interface IMultipoint extends IHasZM, IGeometry {
+  points: Position[];
+}
+
+/**
+ * `Units` can also be imported from the following packages:
+ *
+ * ```js
+ * import { Units } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export type Units =
+  | "esriSRUnit_Meter"
+  | "esriSRUnit_StatuteMile"
+  | "esriSRUnit_Foot"
+  | "esriSRUnit_Kilometer"
+  | "esriSRUnit_NauticalMile"
+  | "esriSRUnit_USNauticalMile";

package/packages/arcgis-rest-types/src/group.ts

@@ -0,0 +1,72 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * `GroupMembership` can also be imported from the following packages:
+ *
+ * ```js
+ * import { GroupMembership } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export type GroupMembership = "owner" | "admin" | "member" | "none";
+
+/**
+ * A [Group](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) that has not been created yet.
+ *
+ * `IGroupAdd` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IGroupAdd } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IGroupAdd {
+  title: string;
+  access: "private" | "org" | "public";
+  owner?: string;
+  tags?: string[];
+  description?: string;
+  phone?: string;
+  sortField?:
+    | "title"
+    | "owner"
+    | "avgrating"
+    | "numviews"
+    | "created"
+    | "modified";
+  sortOrder?: "asc" | "desc";
+  isViewOnly?: boolean;
+  isInvitationOnly?: boolean;
+  thumbnail?: string;
+  autoJoin?: boolean;
+  snippet?: string;
+  [key: string]: any;
+}
+
+/**
+ * Existing Portal [Group](https://developers.arcgis.com/rest/users-groups-and-items/group.htm).
+ *
+ * `IGroup` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IGroup } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IGroup extends IGroupAdd {
+  id: string;
+  owner: string;
+  tags: string[];
+  created: number;
+  modified: number;
+  protected: boolean;
+  isInvitationOnly: boolean;
+  isViewOnly: boolean;
+  isOpenData?: boolean;
+  isFav: boolean;
+  autoJoin: boolean;
+  userMembership?: {
+    username?: string;
+    memberType?: GroupMembership;
+    applications?: number;
+  };
+  hasCategorySchema?: boolean;
+}

package/packages/arcgis-rest-types/src/index.ts

@@ -0,0 +1,9 @@
+export * from "./feature";
+export * from "./geometry";
+export * from "./group";
+export * from "./item";
+export * from "./service";
+export * from "./symbol";
+export * from "./user";
+export * from "./webmap";
+export * from "./statisticDefinition";

package/packages/arcgis-rest-types/src/item.ts

@@ -0,0 +1,81 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { ISpatialReference } from "./geometry";
+
+/**
+ * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) that has not been created yet.
+ *
+ * `IItemAdd` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IItemAdd } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IItemAdd {
+  title: string;
+  type: string;
+  owner?: string;
+  typeKeywords?: string[];
+  description?: string;
+  snippet?: string;
+  documentation?: string;
+  extent?: number[][];
+  categories?: string[];
+  spatialReference?: ISpatialReference;
+  culture?: string;
+  properties?: any;
+  url?: string;
+  tags?: string[];
+  [key: string]: any;
+}
+
+/**
+ * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) to be updated.
+ *
+ * `IItemUpdate` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IItemUpdate } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IItemUpdate {
+  id: string;
+  [key: string]: any;
+}
+
+/**
+ * Existing Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/item.htm).
+ *
+ * `IItem` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IItem } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IItem extends IItemAdd {
+  id: string;
+  owner: string;
+  tags: string[];
+  created: number;
+  modified: number;
+  numViews: number;
+  size: number;
+  protected?: boolean; // not present in search results
+}
+
+/**
+ * Used for organizing content. See [Create Folder](https://developers.arcgis.com/rest/users-groups-and-items/create-folder.htm) for more details.
+ * 
+ * `IFolder` can also be imported from the following packages:
+ * 
+ * ```js
+ * import { IFolder } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IFolder {
+  username: string;
+  id: string;
+  title: string;
+  created?: number;
+}

package/packages/arcgis-rest-types/src/service.ts

@@ -0,0 +1,156 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { ISpatialReference, IExtent } from "./geometry";
+import { ILayerDefinition, ITable } from "./webmap";
+
+/**
+ * `IFeatureServiceDefinition` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IFeatureServiceDefinition } from "@esri/arcgis-rest-service-admin";
+ * import { IFeatureServiceDefinition } from "@esri/arcgis-rest-feature-layer";
+ * ```
+ */
+export interface IFeatureServiceDefinition {
+  currentVersion?: number;
+  serviceDescription: string;
+  hasVersionedData: boolean;
+  supportsDisconnectedEditing: boolean;
+  supportsReturnDeleteResults: boolean;
+  /** Boolean value indicating whether data changes. True if it does not. */
+  hasStaticData?: boolean;
+  /** Numeric value indicating tbe maximum number of records that will be returned at once for a query. */
+  maxRecordCount: number;
+  /** String value indicating the output formats that are supported in a query. */
+  supportedQueryFormats: string;
+  supportsRelationshipsResource: boolean;
+  /** A comma separated list of supported capabilities, e.g. Query,Editing. */
+  capabilities: string;
+  /** String value of the layer as defined in the map service. */
+  description: string;
+  /** String value for the copyright text information for the layer. */
+  copyrightText: string;
+  advancedEditingCapabilities: { [key: string]: boolean };
+  /** An object containing the WKID or WKT identifying the spatial reference of the layer's geometry. */
+  spatialReference: ISpatialReference;
+  initialExtent: IExtent;
+  fullExtent: IExtent;
+  /** Boolean value indicating whether the geometry of the features in the layer can be edited. */
+  allowGeometryUpdates: boolean;
+  units: string;
+  syncEnabled: boolean;
+  returnServiceEditsHaveSR?: boolean;
+  validationSystemLayers: {
+    validationPointErrorlayerId: number;
+    validationLineErrorlayerId: number;
+    validationPolygonErrorlayerId: number;
+    validationObjectErrortableId: number;
+  };
+  extractChangesCapabilities: {
+    supportsReturnIdsOnly: boolean;
+    supportsReturnExtentOnly: boolean;
+    supportsReturnAttachments: boolean;
+    supportsLayerQueries: boolean;
+    supportsSpatialFilter: boolean;
+    supportsReturnFeature: boolean;
+  };
+  syncCapabilities: {
+    supportsASync: boolean;
+    supportsRegisteringExistingData: boolean;
+    supportsSyncDirectionControl: boolean;
+    supportsPerLayerSync: boolean;
+    supportsPerReplicaSync: boolean;
+    supportsRollbackOnFailure: boolean;
+    supportedSyncDataOptions: number;
+  };
+  editorTrackingInfo: {
+    enableEditorTracking: boolean;
+    enableOwnershipAccessControl: boolean;
+    allowOthersToUpdate: boolean;
+    allowOthersToDelete: boolean;
+  };
+  documentInfo?: { [key: string]: string };
+  // the feature layers published by this service
+  layers: ILayerDefinition[];
+  // the non-spatial tables published by this service
+  tables: ITable[];
+  relationships: [
+    {
+      id: number;
+      name: string;
+      backwardPathLabel: string;
+      originLayerId: number;
+      originPrimaryKey: string;
+      forwardPathLabel: string;
+      destinationLayerId: number;
+      originForeignKey: string;
+      relationshipTableId: number;
+      destinationPrimaryKey: string;
+      destinationForeignKey: string;
+      rules: [
+        {
+          ruleID: number;
+          originSubtypeCode: number;
+          originMinimumCardinality: number;
+          originMaximumCardinality: number;
+          destinationSubtypeCode: number;
+          destinationMinimumCardinality: number;
+          destinationMaximumCardinality: number;
+        }
+      ];
+      cardinality:
+        | "esriRelCardinalityOneToOne"
+        | "esriRelCardinalityOneToMany"
+        | "esriRelCardinalityManyToMany";
+      attributed: boolean;
+      composite: boolean;
+    }
+  ];
+  enableZDefaults?: boolean;
+  isLocationTrackingService: boolean;
+  isLocationTrackingView: boolean;
+  zDefault?: number;
+}
+/**
+ * Very generic structure representing the return value from the
+ * /arcgis/rest/admin/services/<service-name>/FeatureServer?f=json response
+ */
+export interface IServiceInfo extends Record<string, unknown> {
+  adminServiceInfo: {
+    name: string;
+    type: string;
+    status: string;
+    database: {
+      datasource: {
+        name: string;
+      };
+    };
+  };
+  layers: Record<string, unknown>[];
+}
+
+/**
+ * Individual View Source entry
+ */
+
+export interface IViewServiceSource {
+  name: string;
+  type: string;
+  url: string;
+  serviceItemId: string;
+}
+/**
+ * Response from the /sources end-point of a view service
+ */
+export interface IViewServiceSources {
+  currentVersion: number;
+  services: IViewServiceSource[];
+}
+
+/**
+ * Response from the portals/Self/isServiceNameAvailable request
+ */
+export interface IServiceNameAvailable {
+  available: boolean;
+}

package/packages/arcgis-rest-types/src/statisticDefinition.ts

@@ -0,0 +1,33 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export interface IStatisticDefinition {
+  /**
+   * Statistical operation to perform (count, sum, min, max, avg, stddev, var, percentile_cont, percentile_disc).
+   */
+  statisticType:
+    | "count"
+    | "sum"
+    | "min"
+    | "max"
+    | "avg"
+    | "stddev"
+    | "var"
+    | "percentile_cont"
+    | "percentile_disc";
+  /**
+   * Parameters to be used along with statisticType. Currently, only applicable for percentile_cont (continuous percentile) and percentile_disc (discrete percentile).
+   */
+  statisticParameters?: {
+    value: number;
+    orderBy?: "asc" | "desc";
+  };
+  /**
+   * Field on which to perform the statistical operation.
+   */
+  onStatisticField: string;
+  /**
+   * Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
+   */
+  outStatisticFieldName?: string;
+}