autculpa 1.0.0

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

@@ -0,0 +1,239 @@
+/* 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-service";
+ * ```
+ */
+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-service-admin";
+ * import { ISpatialReference } from "@esri/arcgis-rest-feature-service";
+ * ```
+ */
+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-service";
+ * ```
+ */
+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;
+}
+
+/**
+ * A polyline geometry.
+ * 
+ * `IPolyLine` can also be imported from the following packages:
+ * 
+ * ```
+ * import { IPolyLine } from "@esri/arcgis-rest-routing";
+ * ```
+ */
+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];
+
+/**
+ * `Position2D` can also be imported from the following packages:
+ * 
+ * ```
+ * import { Position2D } from "@esri/arcgis-rest-routing";
+ * ```
+ */
+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;
+
+/**
+ * `GeometryType` can also be imported from the following packages:
+ *
+ * ```js
+ * import { GeometryType } from "@esri/arcgis-rest-feature-service";
+ * ```
+ */
+export type GeometryType =
+  | "esriGeometryPoint"
+  | "esriGeometryMultipoint"
+  | "esriGeometryPolyline"
+  | "esriGeometryPolygon"
+  | "esriGeometryEnvelope";
+
+/**
+ * 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-demographics";
+ * import { IExtent } from "@esri/arcgis-rest-feature-service";
+ * import { IExtent } from "@esri/arcgis-rest-geocoding";
+ * import { IExtent } from "@esri/arcgis-rest-service-admin";
+ * ```
+ */
+export interface IExtent {
+  xmin: number;
+  ymin: number;
+  zmin?: number;
+  xmax: number;
+  ymax: number;
+  zmax?: number;
+  spatialReference?: ISpatialReference;
+}
+
+/**
+ *
+ */
+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-service";
+ * ```
+ */
+export type Units =
+  | "esriSRUnit_Meter"
+  | "esriSRUnit_StatuteMile"
+  | "esriSRUnit_Foot"
+  | "esriSRUnit_Kilometer"
+  | "esriSRUnit_NauticalMile"
+  | "esriSRUnit_USNauticalMile";

package/packages/arcgis-rest-request/src/types/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-request/src/types/service.ts

@@ -0,0 +1,87 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+
+
+/**
+ * Field type.
+ */
+ export type FieldType =
+ | "esriFieldTypeBlob"
+ | "esriFieldTypeDate"
+ | "esriFieldTypeDouble"
+ | "esriFieldTypeGeometry"
+ | "esriFieldTypeGlobalID"
+ | "esriFieldTypeGUID"
+ | "esriFieldTypeInteger"
+ | "esriFieldTypeOID"
+ | "esriFieldTypeRaster"
+ | "esriFieldTypeSingle"
+ | "esriFieldTypeSmallInteger"
+ | "esriFieldTypeString"
+ | "esriFieldTypeXML";
+
+/**
+* Domain types
+*/
+export type DomainType = "range" | "codedValue" | "inherited";
+
+/**
+* CodedValue type
+*/
+export type ICodedValue = {
+ /**  User-friendly name for what the code means. */
+ name: string;
+ /**  The value stored in the feature attribute. */
+ code: string | number;
+};
+
+/**
+* Information for a field with a domain
+*/
+export type IDomain = {
+ /** A string defining the domain type. */
+ type: DomainType;
+ /** A string defining the field name. */
+ name?: string;
+ /** A 2 element array defining the range of possible values. */
+ range?: [number, number];
+ /** An array of CodedValues for domains of type codedValue. */
+ codedValues?: ICodedValue[];
+ /** Description of the domain */
+ description?: string;
+ /** Merge policy */
+ mergePolicy?: string;
+ /** Split Policy */
+ splitPolicy?: string;
+};
+
+/**
+ * Contains information about an attribute field.
+ *
+ * `IField` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IField } from "@esri/arcgis-rest-feature-service";
+ * ```
+ */
+ export interface IField {
+  /** A string defining the field name. */
+  name: string;
+  /** A string defining the field type. */
+  type: FieldType;
+  /** A string defining the field alias. */
+  alias?: string;
+  /** The domain objects if applicable. */
+  domain?: IDomain;
+  /** A Boolean defining whether this field is editable. */
+  editable?: boolean;
+  /** A Boolean defining whether or not the field is an exact match. */
+  exactMatch?: boolean;
+  /** A number defining how many characters are allowed in a string. field. */
+  length?: number;
+  /** A Boolean defining whether this field can have a null value. */
+  nullable?: boolean;
+  /** The value written in for new records by default. */
+  defaultValue?: any;
+}

package/packages/arcgis-rest-request/src/types/symbol.ts

@@ -0,0 +1,21 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ *
+ */
+ export interface ISymbol {
+  type: SymbolType;
+  style?: string;
+}
+
+/**
+ *
+ */
+export type SymbolType =
+  | "esriSLS"
+  | "esriSMS"
+  | "esriSFS"
+  | "esriPMS"
+  | "esriPFS"
+  | "esriTS";

package/packages/arcgis-rest-request/src/types/user.ts

@@ -0,0 +1,49 @@
+/* Copyright (c) 2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IGroup } from "./group.js";
+
+/**
+ * An ArcGIS Online or Enterprise user
+ *
+ * `IUser` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IUser } from "@esri/arcgis-rest-auth";
+ * import { IUser } from "@esri/arcgis-rest-portal";
+ * ```
+ */
+export interface IUser {
+  username?: string;
+  fullName?: string;
+  availableCredits?: number;
+  assignedCredits?: number;
+  firstName?: string;
+  lastName?: string;
+  preferredView?: any;
+  description?: string;
+  email?: string;
+  idpUsername?: string;
+  favGroupId?: string;
+  lastLogin?: number;
+  mfaEnabled?: boolean;
+  access?: string;
+  storageUsage?: number;
+  storageQuota?: number;
+  orgId?: string;
+  cOrgId?: string;
+  role?: "org_admin" | "org_publisher" | "org_user";
+  privileges?: string[];
+  roleId?: string;
+  level?: string;
+  disabled?: boolean;
+  units?: string;
+  tags?: string[];
+  culture?: string;
+  region?: string;
+  thumbnail?: string;
+  created?: number;
+  modified?: number;
+  groups?: IGroup[];
+  provider?: "arcgis" | "enterprise" | "facebook" | "google";
+}

package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts

@@ -0,0 +1,82 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "./IRequestOptions.js";
+
+// TypeScript 2.1 no longer allows you to extend built in types. See https://github.com/Microsoft/TypeScript/issues/12790#issuecomment-265981442
+// and https://github.com/Microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
+//
+// This code is from MDN https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Custom_Error_Types.
+export class ArcGISRequestError extends Error {
+  /**
+   * The name of this error. Will always be `"ArcGISRequestError"` to conform with the [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) class.
+   */
+  public name: string;
+
+  /**
+   * Formatted error message. See the [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) class for more details.
+   */
+  public message: string;
+
+  /**
+   * The errror message return from the request.
+   */
+  public originalMessage: string;
+
+  /**
+   * The error code returned from the request.
+   */
+  public code: string | number;
+
+  /**
+   * The original JSON response the caused the error.
+   */
+  public response: any;
+
+  /**
+   * The URL of the original request that caused the error
+   */
+  public url: string;
+
+  /**
+   * The options of the original request that caused the error
+   */
+  public options: IRequestOptions;
+
+  /**
+   * Create a new `ArcGISRequestError`  object.
+   *
+   * @param message - The error message from the API
+   * @param code - The error code from the API
+   * @param response - The original response from the API that caused the error
+   * @param url - The original url of the request
+   * @param options - The original options and parameters of the request
+   */
+  constructor(
+    message?: string,
+    code?: string | number,
+    response?: any,
+    url?: string,
+    options?: IRequestOptions
+  ) {
+    // 'Error' breaks prototype chain here
+    super(message);
+
+    // restore prototype chain, see https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+    // we don't need to check for Object.setPrototypeOf as in the answers becasue we are ES2017 now
+    const actualProto = new.target.prototype;
+    Object.setPrototypeOf(this, actualProto);
+
+    message = message || "UNKNOWN_ERROR";
+    code = code || "UNKNOWN_ERROR_CODE";
+
+    this.name = "ArcGISRequestError";
+    this.message =
+      code === "UNKNOWN_ERROR_CODE" ? message : `${code}: ${message}`;
+    this.originalMessage = message;
+    this.code = code;
+    this.response = response;
+    this.url = url;
+    this.options = options;
+  }
+}

package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts

@@ -0,0 +1,29 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * Enum describing the different errors that might be thrown by a request.
+ *
+ * ```ts
+ * import { request, ErrorTypes } from '@esri/arcgis-rest-request';
+ *
+ * request("...").catch((e) => {
+ *   switch(e.name) {
+ *     case ErrorType.ArcGISRequestError:
+ *     // handle a general error from the API
+ *     break;
+ *
+ *     case ErrorType.ArcGISAuthError:
+ *     // handle an authentication error
+ *     break;
+ *
+ *     default:
+ *     // handle some other error (usually a network error)
+ *   }
+ * });
+ * ```
+ */
+export enum ErrorTypes {
+  ArcGISRequestError = "ArcGISRequestError",
+  ArcGISAuthError = "ArcGISAuthError"
+}

package/packages/arcgis-rest-request/src/utils/GrantTypes.ts

@@ -0,0 +1,5 @@
+export type GrantTypes =
+  | "authorization_code"
+  | "refresh_token"
+  | "client_credentials"
+  | "exchange_refresh_token";

package/packages/arcgis-rest-request/src/utils/HTTPMethods.ts

@@ -0,0 +1,6 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+/**
+ * HTTP methods used by the ArcGIS REST API.
+ */
+export type HTTPMethods = "GET" | "POST";

package/packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts

@@ -0,0 +1,22 @@
+import { ITokenRequestOptions } from "./ITokenRequestOptions.js";
+/**
+ * Authentication can be supplied to `request` via [`ArcGISIdentityManager`](../../auth/ArcGISIdentityManager/) or [`ApplicationSession`](../../auth/ApplicationSession/). Both classes extend `IAuthenticationManager`.
+ * ```js
+ * const session = new ArcGISIdentityManager({
+ *   username: "jsmith",
+ *   password: "123456",
+ *   // optional
+ *   portal: "https://[yourserver]/arcgis/sharing/rest"
+ * })
+ *
+ * request(url, { authentication: session })
+ * ```
+ */
+export interface IAuthenticationManager {
+  /**
+   * Defaults to 'https://www.arcgis.com/sharing/rest'.
+   */
+  portal: string;
+  getToken(url: string, requestOptions?: ITokenRequestOptions): Promise<string>;
+  getDomainCredentials?(url: string): RequestCredentials;
+}

package/packages/arcgis-rest-request/src/utils/IFetchTokenParams.ts

@@ -0,0 +1,11 @@
+import { GrantTypes } from "./GrantTypes.js";
+import { IParams } from "./IParams.js";
+
+export interface IFetchTokenParams extends IParams {
+  client_id: string;
+  client_secret?: string;
+  grant_type: GrantTypes;
+  redirect_uri?: string;
+  refresh_token?: string;
+  code?: string;
+}

package/packages/arcgis-rest-request/src/utils/IGenerateTokenParams.ts

@@ -0,0 +1,9 @@
+import { IParams } from "./IParams.js";
+
+export interface IGenerateTokenParams extends IParams {
+  username?: string;
+  password?: string;
+  expiration?: number;
+  token?: string;
+  serverUrl?: string;
+}

package/packages/arcgis-rest-request/src/utils/IParamBuilder.ts

@@ -0,0 +1,3 @@
+export interface IParamBuilder {
+  toParam(): any;
+}

package/packages/arcgis-rest-request/src/utils/IParams.ts

@@ -0,0 +1,6 @@
+import { ResponseFormats } from "./ResponseFormats.js";
+
+export interface IParams {
+  f?: ResponseFormats;
+  [key: string]: any;
+}

package/packages/arcgis-rest-request/src/utils/IParamsBuilder.ts

@@ -0,0 +1,5 @@
+import { IParams } from "./IParams.js";
+
+export interface IParamsBuilder {
+  toParams(additionalParams?: IParams): IParams;
+}